List all order subscriptions
How to fetch a collection of order subscriptions via API
To fetch a collection of order subscriptions, send a GET
request to the /api/order_subscriptions
endpoint.
Request
GET https://yourdomain.commercelayer.io/api/order_subscriptions
Example
The following request fetches a collection of order subscriptions:
curl -g -X GET \
'https://yourdomain.commercelayer.io/api/order_subscriptions/' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token'
Remember that when you fetch a list of resources you get paginated result.
Sortable fields
The list of order subscriptions can be sorted by the following fields:
Attributes
number
status
frequency
starts_at
expires_at
last_run_at
next_run_at
occurrencies
errors_count
succeeded_on_last_run
id
created_at
updated_at
reference
reference_origin
Relationships
market
subscription_model
customer
customer_payment_source
Filterable fields
The list of order subscriptions can be filtered by the following fields:
Attributes
number
status
frequency
customer_email
starts_at
expires_at
last_run_at
next_run_at
occurrencies
errors_count
succeeded_on_last_run
id
created_at
updated_at
reference
reference_origin
metadata
Relationships
market
subscription_model
source_order
customer
customer_payment_source
events
tags
Last updated