Skip to main content
GET
/
subscriptions
/
{subscription_id}
/
orders
List all subscription orders
curl --request GET \
  --url https://api.salesbricks.com/api/v2/subscriptions/{subscription_id}/orders \
  --header 'X-SALESBRICKS-KEY: <api-key>'
{
  "count": 123,
  "results": [
    {
      "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "contract_value": "<string>",
      "pdf_url": "<string>",
      "starts_at": "2023-12-25",
      "ends_at": "2023-12-25"
    }
  ],
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Authorizations

​
X-SALESBRICKS-KEY
string
header
required

API key for authentication

Path Parameters

​
subscription_id
string
required
Pattern: ^([a-zA-Z\d\-]+)$

Query Parameters

​
limit
integer

Number of results to return per page.

​
offset
integer

The initial index from which to return the results.

​
ordering
string

Which field to use when ordering the results.

Response

200 - application/json
​
count
integer
required
Example:

123

​
results
object[]
required
​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=400&limit=100"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=200&limit=100"