Skip to main content
GET
Get Subscription

Authorizations

Authorization
string
header
required

Use a Bearer token to access this API.

Path Parameters

id
string
required
Example:

"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

Query Parameters

expand_customer
boolean | null

If true, expands the customer object in the response.

Example:

false

expand
string
default:""

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

Supported keys: customer; latest_invoice (alias invoice); payment_method; price (alias product); and discounts. Combine discounts with coupons (expand=discounts,coupons) to hydrate each discount's nested source.coupon into a full object instead of a bare ID.

Unrecognized keys are ignored rather than rejected: a misspelled or guessed key (e.g. coupon) returns the same response as no expand at all, with no error.

Response

An envelope wrapping a single subscription object.

An envelope wrapping a single subscription object.

subscription
object
required

The subscription payload carried by the request or response.

Example: