Get a list of pricing plan subscriptions
Requires the PRICING_PLAN_SUBSCRIPTION.VIEW or QUOTE.PRICING_PLAN_SUBSCRIPTION.VIEW permission.
Authentication
X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
version
version
Headers
x-platform-id
Platform ID.
Query parameters
expand[]
The id fields of the resources that are going to be expanded.
customer_id
The resource id of the customer.
pricing_plan_subscription_group_id
The resource id of the pricing plan subscription group.
reference
The reference by which the resource will be filtered. To use this filter, the customer_id must also be present.
type
The type of the pricing plan subscription.
variant
The variant of the pricing plan subscription.
status
The status of the pricing plan subscription.
statuses[]
The status(es) of the pricing plan subscription.
custom_field
Filter the response by a custom field value.
start_at
Range filter for the start_at of the first schedule in the pricing plan subscription (ISO-8601).
created_at
Range filter for the created_at in the pricing plan subscription (ISO-8601).
page
The page which is going to be shown
limit
The amount of records shown in the list
order_by
The parameter by which the response is ordered.
order_direction
The order direction by which the response is ordered.
Response
OK
data
links
page
limit
total_number_of_pagesDeprecated
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error