Skip to main content
SubscriptionsVersion: v3

List Subscriptions

GET/payments/subscriptions

The "List Subscriptions" API allows to retrieve a paginated list of subscriptions. Customize your results by filtering subscriptions based on name, alt type, subscription status, payment mode, date range, type of source, contact, subscription id, entity id, contact or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve subscription information.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:payments/subscriptions.readonly
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Query Parameters

altIdstringrequired

AltId is the unique identifier e.g: location id.

Example:3SwdhCu3svxI8AKsPJt6
altTypestringrequired

AltType is the type of identifier.

Available optionslocation
Example:location
entityIdstring

Entity id for filtering of subscriptions.

Example:61dd0fe9c077f73e67f78803
paymentModestring

Mode of payment.

Example:live
startAtstring

Starting interval of subscriptions.

Example:2024-02-01
endAtstring

Closing interval of subscriptions.

Example:2024-02-13
entitySourceTypestring

Source of the subscriptions.

Example:funnel
searchstring

The name of the subscription for searching.

Example:Awesome subscription
contactIdstring

Contact ID for the subscription

Example:AmuzcoPBpgKeccNsFlib
idstring

Subscription id for filtering of subscriptions.

Example:64bf78af39118e4011926cba
limitnumber

The maximum number of items to be included in a single page of results

Default:10
Example:20
offsetnumber

The starting index of the page, indicating the position from which the results should be retrieved.

Default:0
Example:0
getPaymentsCollectedCountboolean

Get the total payments collected for the subscription.

Example:true

Response

Successful response

dataobject[]required

An array of subscriptions

totalCountnumberrequired

total subscriptions count