v1

latestOpenAPI 3.1.02026-07-24233206489.1 KB

Retrieve List of Subscriptions

Use secret API key to retrieve the list of all Subscriptions created.

get/v1/subscriptions

Query parameters

afterstring

A cursor for use in pagination. after is a resource ID that defines your place in the list. For example, if you make a list request and receive 10 resources, ending with some_resource_id, your subsequent call can include after=some_resource_id in order to fetch the next page of the list.

beforestring

A cursor for use in pagination. before is a resource ID that defines your place in the list. For example, if you make a request and receive 10 resources, starting with some_resource_id, your subsequent call can include before=some_resource_id in order to fetch the previous page of the list.

customer_idstring

ID of the customer. You can use this to filter the subscriptions by Customer.

limitinteger

Number of resources to return. The default value is 10.min:1 max:100 <br/> Example: 10

plan_idstring

ID of the plan. You can use this to filter the subscriptions by Plan.

sort_bystring

Sort by Subscription Attribute

orderstring

Sort transaction record by order. Examples: asc or desc

Response

200

object required