Get subscription

GET /subscriptions/{subscriptionId}

Get subscription

cURL

curl --request GET \
  --url https://api.example.com/subscriptions/{subscriptionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-environment: <x-environment>'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "handle": "<string>",
  "currency": "USD",
  "term": {
    "start": "2023-12-25",
    "end": "2023-12-25"
  },
  "autoRenewal": true,
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "billAt": "2023-11-07T05:31:56Z",
      "period": {
        "start": "2023-12-25",
        "end": "2023-12-25"
      },
      "quantity": 123,
      "product": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "price": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z"
}

Headers

x-environment · string<uuid> · required

Configure which environment the request will handle. If the provided credentials do not allow access to this specified environment, a 403 Forbidden response is returned.

Path Parameters

subscriptionId · string<uuid> · required

Id of subscription.

Response

200

application/json

OK

id · string<uuid>

Id of subscription.

handle · string | null

A unique handle of the subscription.

currency · string<currency>

Currency of the subscription.

Example:

"USD"

term · object

Show child attributes

autoRenewal · boolean

For termed subscription, auto renewal is optional and will automatically renew the subscription.

items · object[] | null

Items of the subscription.

Show child attributes

createdAt · string<date-time>