v41

latestOpenAPI 3.1.0raw.githubusercontent.com2025-08-053715199.1 KB
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"
  }
}