Subscription

Get subscription

Get the subscription with the given ID.

get/subscription/{id}

Path parameters

idstring required

ID of the subscription to get.

Example:sub_XXXXXXXXXXXXXXXXXXXXXXXXX

Response

Subscription information.

Example response

{
  "data": {
    "id": "sub_XXXXXXXXXXXXXXXXXXXXXXXXX",
    "productVariantID": "var_XXXXXXXXXXXXXXXXXXXXXXXXX",
    "price": 2200,
    "quantity": 1,
    "addressID": "shp_XXXXXXXXXXXXXXXXXXXXXXXXX",
    "cardID": "crd_XXXXXXXXXXXXXXXXXXXXXXXXX",
    "schedule": {
      "type": "weekly",
      "interval": 3
    },
    "next": "2025-02-01T19:36:19.000Z",
    "created": "2024-06-29T19:36:19.000Z"
  }
}

Changes

Changed in 4 of the 41 revisions of this API.427

Apr 23, 2025bf623569cd3c1See the full diff
- ○
  added the required property data/allOf[Subscription]/price to the response with the 200 status
  response-required-property-added
Apr 14, 202558fa4af8e3251See the full diff
- ○
  added the required property data/allOf[Subscription]/created to the response with the 200 status
  response-required-property-added
Mar 19, 20251c6726b12e29424See the full diff
- ▲
  the response's body type/format changed from / to object/ for status 401
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 404
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 429
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 500
  response-body-type-changed
- ○
  removed ErrorResponse from the response body allOf list for the response status 401
  response-body-all-of-removed
- ○
  removed ErrorResponse from the response body allOf list for the response status 404
  response-body-all-of-removed
- ○
  removed ErrorResponse from the response body allOf list for the response status 429
  response-body-all-of-removed
- ○
  removed ErrorResponse from the response body allOf list for the response status 500
  response-body-all-of-removed
- ○
  added the optional property details to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 429 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 500 status
  response-optional-property-added
- ○
  added the optional property param to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property param to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property param to the response with the 429 status
  response-optional-property-added
- ○
  added the optional property param to the response with the 500 status
  response-optional-property-added
- ○
  added the required property code to the response with the 401 status
  response-required-property-added
- ○
  added the required property code to the response with the 404 status
  response-required-property-added
- ○
  added the required property code to the response with the 429 status
  response-required-property-added
- ○
  added the required property code to the response with the 500 status
  response-required-property-added
- ○
  added the required property message to the response with the 401 status
  response-required-property-added
- ○
  added the required property message to the response with the 404 status
  response-required-property-added
- ○
  added the required property message to the response with the 429 status
  response-required-property-added
- ○
  added the required property message to the response with the 500 status
  response-required-property-added
- ○
  added the required property type to the response with the 401 status
  response-required-property-added
- ○
  added the required property type to the response with the 404 status
  response-required-property-added
- ○
  added the required property type to the response with the 429 status
  response-required-property-added
- ○
  added the required property type to the response with the 500 status
  response-required-property-added
Mar 7, 2025979a6c40552c1See the full diff
- ○
  endpoint added
  endpoint-added

Full history