List 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
Bearer authentication header of the form Bearer <token>, where <token> is your access token.
payments/ subscriptions. readonlyOAuthPrivate IntegrationSub-Account TokenRequest
Headers
API Version
v3Query Parameters
AltId is the unique identifier e.g: location id.
3SwdhCu3svxI8AKsPJt6AltType is the type of identifier.
locationlocationEntity id for filtering of subscriptions.
61dd0fe9c077f73e67f78803Mode of payment.
liveStarting interval of subscriptions.
2024-02-01Closing interval of subscriptions.
2024-02-13Source of the subscriptions.
funnelThe name of the subscription for searching.
Awesome subscriptionContact ID for the subscription
AmuzcoPBpgKeccNsFlibSubscription id for filtering of subscriptions.
64bf78af39118e4011926cbaThe maximum number of items to be included in a single page of results
1020The starting index of the page, indicating the position from which the results should be retrieved.
00Get the total payments collected for the subscription.
trueResponse
Successful response
An array of subscriptions
total subscriptions count