Get subscription

Retrieve a single subscription by its ID and the ID of its parent customer.

get/v2/customers/{customerId}/subscriptions/{subscriptionId}

Query parameters

testmodeboolean

Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the testmode query parameter to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

Headers

idempotency-keystring

Example:123e4567-e89b-12d3-a456-426

A unique key to ensure idempotent requests. This key should be a UUID v4 string.

Response

The subscription object.

Changes

Changed in 4 of the 92 revisions of this API.17

Jun 15, 202600fb770ca93410See the full diff
- ○
  the response property //// became required for the status
  response-property-became-required
- ○
  the response property //// became required for the status
  response-property-became-required
- ○
  the response property //// became required for the status
  response-property-became-required
- ○
  the response property //// became required for the status
  response-property-became-required
- ○
  the response property //// became required for the status
  response-property-became-required
- ○
  the response property //// became required for the status
  response-property-became-required
- ○
  the response property //// became required for the status
  response-property-became-required
- ○
  the response property //// became required for the status
  response-property-became-required
- ○
  the response property //// became required for the status
  response-property-became-required
- ○
  the response property //// became required for the status
  response-property-became-required
Jun 9, 2026327472893a894See the full diff
- ○
  the response property ////// became required for the status
  response-property-became-required
- ○
  the response property ////// became required for the status
  response-property-became-required
- ○
  the response property ////// became required for the status
  response-property-became-required
- ○
  the response property ////// became required for the status
  response-property-became-required
May 19, 20267cab62b218301See the full diff
- ○
  added the non-success response with the status
  response-non-success-status-added
May 12, 2026ef4b5a97b56a2See the full diff
- ○
  the endpoint scheme security advancedAccessToken was added to the API
  api-security-added
- ○
  the endpoint scheme security organizationAccessToken was removed from the API
  api-security-removed
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 92 revisions, 9 have no diff computed.

Full history