List subscriptions
GET {{baseUrl}}/subscriptions
Returns a paginated list of subscriptions. Use the query parameters to page through results.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
address_id | string | Return entities related to the specified address. Use a comma-separated list to specify multiple address IDs. | |
after | string | Return entities after the specified Paddle ID when working with paginated endpoints. Used in the meta.pagination.next URL in responses for list operations. | |
collection_mode | string | Return entities that match the specified collection mode. | |
customer_id | string | Return entities related to the specified customer. Use a comma-separated list to specify multiple customer IDs. | |
id | string | Return only the IDs specified. Use a comma-separated list to get multiple entities. | |
order_by | string | Order returned entities by the specified field and direction ([ASC] or [DESC]). For example, ?order_by=id[ASC]. |
Valid fields for ordering: id. |
| per_page | number | | Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is requested. Check meta.pagination.per_page in the response to see how many were returned.
Default: 50; Maximum: 200. |
| price_id | string | | Return entities related to the specified price. Use a comma-separated list to specify multiple price IDs. |
| scheduled_change_action | string | | Return subscriptions that have a scheduled change. Use a comma-separated list to specify multiple scheduled change actions. |
| status | string | | Return entities that match the specified status. Use a comma-separated list to specify multiple status values. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |