Subscription
A Subscription is a collection of Products bounded together.
GET /v1/accounts/{accountId}/subscriptions
Query Parameters:
| Parameter | Required | Type | Description |
|---|---|---|---|
accountId |
required | UUID | Account UUID |
orderId |
optional | UUID | Order UUID used to fetch a specific order |
Response:
[
{
"account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"contract_free_at": "yyyy-MM-dd",
"orders": [
{
"delivered_at": "yyyy-MM-dd'T'HH:mm:ssXXX",
"order_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"order_status": "string",
"order_type": "string",
"ordered_at": "yyyy-MM-dd'T'HH:mm:ssXXX",
"ordered_by_user": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reference": "string",
"wish_date": "yyyy-MM-dd"
}
],
"reference": "string",
"subscription_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
]
Properties
| Option | Type | Description |
|---|---|---|
contract_free_at |
date(yyyy-MM-dd) | Date when the subscription can be terminated |
orders |
array | Collection of orders that formed the Subscription |
reference |
string | Reference for the Subscription |
subscription_id |
UUID | UUID of the Subscription |
Properties of order items
| Option | Type | Description |
|---|---|---|
delivered_at |
datetime | Date when the order is delivered |
order_id |
UUID | UUID of the Order |
order_status |
string | |
order_type |
string | |
ordered_at |
date(yyyy-MM-dd) | |
ordered_by_user |
UUID | UUID of the user that sent the Order request |
reference |
string | Reference for the Order |
wish_date |
date(yyyy-MM-dd) | Date when the subscription should start |