List subscriptions
GET/v2/subscriptions/subscriptions
Retrieves a list of all subscriptions.
Filtering
This endpoint supports filtering. For the general syntax, see Filtering.
The following attributes and operators are supported.
| Operator | Attribute | Description |
|---|---|---|
eq | account_id, name, email, external_ref | Equals. Checks if the values of two operands are equal. If they are, the condition is true. |
in | account_id, name, email, external_ref | In. Checks if the value is in the specified list. If it is, the condition is true. |
Including Resources
You can use the include parameter to include the following resources with this endpoint.
| Resource | Required | Description |
|---|---|---|
pricing_options, plans | Optional | Retrieves all pricing options and plans associated with a subscription. |
plans | Optional | Retrieves all plans associated with a subscription. |
pricing_options | Optional | Retrieves all pricing options associated with a subscription. |
See Characteristics of Include Parameter.
Request
Responses
- 200
- 400
- 500
Success. A list of subscriptions is returned.
Bad request. The request failed validation.
Internal server error. There was a system failure in the platform.