Sign in

v1

latestOpenAPI 3.1.02026-07-2684271522.2 KB
Subscriptions

Get Subscription

Retrieves the subscription with the given ID. Use expand (or expand_customer) to inline related objects such as the customer, latest invoice, default payment method, or item prices.

get/v1/subscriptions/{id}

Path parameters

idstring required
Example:fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Query parameters

expand_customerboolean nullable

If true, expands the customer object in the response.

If true, expands the customer object in the response.

expandstring

Comma-separated list of related objects to expand in the response.

Comma-separated list of related objects to expand in the response.

Response

An envelope wrapping a single subscription object.

Example response

{
  "subscription": {
    "subscription_id": "fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
    "created_at": "2026-06-15T14:30:00Z",
    "items": [
      {}
    ],
    "status": "incomplete",
    "cancel_at_period_end": false,
    "current_period_end": "string",
    "current_period_start": "string",
    "metadata": {
      "order_id": "8842",
      "channel": "shopify"
    },
    "test_mode": false,
    "client_secret": {},
    "proration_behavior": "always_invoice",
    "trial_start": "string",
    "trial_end": "string",
    "cancel_at": "2026-06-15T14:30:00Z",
    "canceled_at": "2026-06-15T14:30:00Z"
  }
}