List subscriptions

get

https://api.purchasely.io/management/v1/applications/{application_id}/purchasely_subscriptions

List subscriptions for an application (or across every application you can access).

Required scope: lookups.subscriptions:view

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

application_id

string

required

Public ID of the resource.

Query Params

countries[]

array of strings

Filter by store country ISO codes.

countries[]

period_types[]

array of strings

Filter by plan period type (e.g. WEEK, MONTH, YEAR).

period_types[]

plans[]

array of strings

Filter by plan public_id.

plans[]

platform[]

array of strings

Filter by platform name, case-insensitive (IOS, ANDROID, AMAZON, HUAWEI, STRIPE).

platform[]

status[]

array of strings

Filter by subscription status.

status[]

ab_test_variant

string

Filter by ab_test_variant public_id.

audience

string

Filter by audience public_id.

placement

string

Filter by placement public_id.

fields[]

array of strings

Field selection for token economy: an explicit list of field names to include in the response, or ["*"] for every field. Omit for this endpoint's own default field set.

fields[]

page

integer

Page number (1-indexed). Defaults to 1.

per_page

integer

Results per page. Defaults to 25, capped at 100.

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success.

403FORBIDDEN (missing/insufficient scope, wrong tenant) or, for feature-gated operations, FEATURE_NOT_ENABLED.

422VALIDATION_FAILED — one or more parameters were missing or invalid.

429RATE_LIMITED — the coarse per-key, per-write, per-heavy-read, or per-moderate-read rate limit tier was exceeded.

504QUERY_TIMEOUT — a database query took too long and was cancelled. Retry with narrower filters, for example a shorter date_range.