Get Subscriptions
Returns the subscriptions related with an organization
Request
URI
GET
https://{api_host}/v1/subscriptions
COPY
Query Parameters
string
order_field
Optional
Constraints: default: CREATED_AT
Name of the field to order the subscription requests: CREATED_AT (default), ID, ORGANIZATION_NAME, ORGANIZATION_ID, PRODUCT_ID, SUBSCRIPTION_STATUS, ACTIVE_AT, STARTS_AT, ENDS_AT
order_field example
CREATED_ATstring
order_direction
Optional
Constraints: default: DESC
Order to sort by the selected field: ASC or DESC (default)
integer
page
Optional
Constraints: minimum: 1 default: 1
An integer that identifies the page number for a paged response
integer
page_size
Optional
Constraints: minimum: 1 maximum: 100 default: 20
An integer that identifies the maximum page size for a paged response
Responses
200
Paginated list of subscriptions
Returns SubscriptionsPage of type(s) application/json
This response body class contains all of the following: InlineSubscriptionsPage0 , InlineSubscriptionsPage1
"SubscriptionsPage Object"
403
The requesting user is not authorized to get subscriptions
Returns Error403 of type(s) application/problem+json
This response body class contains all of the following: InlineError4030
"Error403 Object"
500
An internal server error object
Returns Error500 of type(s) application/problem+json
This response body class contains all of the following: InlineError5000
"Error500 Object"
503
The server is temporarily unavailable
Returns Error503 of type(s) application/problem+json
This response body class contains all of the following: InlineError5030
"Error503 Object"
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/v1/subscriptions