List All Subscriptions

get

https://testapi.payarc.net/v1/subscriptions

This API returns a list of subscriptions.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

limit

integer

Number of subscription records to return per page.

page

integer

Page number of the result set to return, starting at.

orderBy

string

Column name to sort the results by (for example, created_at). Pair with sortedBy to set the sort direction. Multiple fields are separated by a semicolon (;)

sortedBy

string

enum

Direction that orderBy is sorted by.
Possible Values: asc, desc

Allowed:

include

string

enum

Embeds the related customer or discount object in each subscription.
Possible Values: customer, discount

Allowed:

status[in]

string

enum

Filter subscriptions by multiple statuses (multi-value, comma separated).
Possible Values: trial, active, pending, passed_due, paused, canceled, unpaid

Allowed:

status[eq]

string

enum

Filters subscriptions by an exact status. Unlike status[in], it can only take 1 value, and contains an additional valid value.
Possible Values: trial, active, pending, passed_due, paused, canceled, unpaid, any

created_at[intl]

integer

Returns subscriptions created within the last N days.

created_at[eq]

string

Returns subscriptions created on the specified date. Recommended format YYYY/MM/DD.

created_at[gte]

string

Returns subscriptions created on or after the specified date. Recommended format YYYY/MM/DD.

created_at[lte]

string

Returns subscriptions created on or before the specified date. Recommended format YYYY/MM/DD.

created_at[gt]

string

Returns subscriptions created after the specified date. Recommended format YYYY/MM/DD.

created_at[lt]

string

Returns subscriptions created before the specified date. Recommended format YYYY/MM/DD.

created_at[range]

object

Returns subscriptions whose creation date falls between a start and end date (inclusive). Supplied as created_at[range][from] and created_at[range][to], each in the recommended format YYYY/MM/DD.

payment_type[eq]

string

enum

Filters subscriptions by payment method.
Possible Values: card, ach

Allowed:

plan

string

Filters subscriptions by plan, using the plan's code.

customer_id

string

Filters subscriptions belonging to a specific customer, using the customer ID.

excel

boolean

If true, exports all matching results without pagination.
Possible Values: 0, 1

Responses

200200

401401