/api/v1/subscriptions

get

https://subs.api.recurlycommerce.com/api/v1/subscriptions

Retrieve a list of subscriptions

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

number

required

Defaults to 1

Page number

limit

number

required

Defaults to 10

Items per page. Limit must be between 1 and 250.

sort

string

Sort order. If not set, default is createdAt.

desc

boolean

Sort direction. If not set, default is ASC.

minCreatedAt

date-time

Defaults to 2023-01-01T00:00:00.000Z

The min date of createdAt

maxCreatedAt

date-time

Defaults to 2023-01-01T00:00:00.000Z

The max date of createdAt

minUpdatedAt

date-time

Defaults to 2023-01-01T00:00:00.000Z

The min date of updatedAt

maxUpdatedAt

date-time

Defaults to 2023-01-01T00:00:00.000Z

The min date of updatedAt

includeDeleted

boolean

Defaults to false

If true, include deleted lines

subscriptionId

string

The subscription ID

variantIds

array of strings

variantIds

subscriberId

string

subscriberEmail

string

subscriberExternalId

string

The shopify ID of the subscriber

subscriptionExternalId

string

The shopify ID of the subscription

friendlyId

string

The friendly ID of the subscription

minNextBillingDate

date-time

The min date of nextBillingDate

maxNextBillingDate

date-time

The max date of nextBillingDate

status

string

enum

The subscription status

Allowed:

statuses

array

The subscription statuses

statuses

includeDunningInstances

boolean

If true, attach list of dunning instances for the contract

Response

Language

Credentials

Bearer

JWT

Loading…

Response

Choose an example:

application/json

200Successfully retrieved subscriptions