List subscriptions
Returns a list of subscriptions, optionally filtered by a related resource (customer or payment method), currency, or status.
Headers
string The Bearer token for authentication.
string The user agent of the request. Must contain at least two identifiers separated by a space.
string The content type of the request.
Parameters
string The ID of the resource you want to filter based on. (e.g. Customer or Payment method ID's)
string The currency you want to filter based on.
string The status you want to filter based on.
pendingexpiredtrialactivesuspendedcancellednumber The number of results to return.
string The start date to filter based on.
string The end date to filter based on.
Response Body
application/jsonboolean Indicates that the request was successful.
object The subscriptions data.
array The list of subscriptions.
string The ID of the subscription.
object The customer details.
string The ID of the customer.
string The name of the customer.
string The email of the customer.
object Customer billing details.
string Address line 1.
string Address line 2.
string City.
string State.
string Zip code.
string Country code in ISO 3166-1 alpha-2 format.
object Customer shipping details schema.
string Full name of the customer.
string Phone number of the customer. (e.g. +597-8123456)
string Address line 1.
string Address line 2.
string City.
string State.
string Zip code.
string Country code in ISO 3166-1 alpha-2 format.
object The payment method details.
string The ID of the payment method.
string The type of the payment method.
creditswalletstring The payment method provider name.
string Status of the subscription.
pendingexpiredtrialactivesuspendedcancelledstring The currency of the subscription.
boolean Whether the subscription should auto-renew.
number The billing interval in days.
date-time The start date of the billing period.
date-time The end date of the billing period.
date-time The date of the last renewal.
date-time The date of the next renewal.
date-time The date and time the subscription was created.