Skip to main content
GET
Get a subscription

Authorizations

Authorization
string
header
required

Your account's secret key: Authorization: Bearer sk_test_… or sk_live_…. Server-side only.

Path Parameters

subscriptionID
string
required

Subscription ID.

Pattern: ^sub_[0-9A-Za-z]{22}$
Example:

"sub_2Kp7rWqT0aLm4XcVb8NzJe"

Response

Success.

id
string
required
Pattern: ^sub_[0-9A-Za-z]{22}$
Example:

"sub_2Kp7rWqT0aLm4XcVb8NzJe"

customerId
string<uuid>
required

Enrollment ID.

productVersionId
string<uuid>
required

The product version subscribed to. It sets the price billed, even if the product changes later.

status
enum<string>
required
Available options:
trialing,
active,
past_due,
paused,
canceled
billingCycle
enum<string>
required
Available options:
weekly,
monthly,
annual
billingMode
enum<string>
required

advance bills at the start of the period; arrears, at the end.

Available options:
arrears,
advance
anchor
string<date-time>
required

Reference date the billing periods are counted from.

startedAt
string<date-time>
required
collectionMethod
enum<string>

charge_automatically charges on its own; send_invoice sends the invoice for the customer to pay.

Available options:
charge_automatically,
send_invoice
nextBillingDate
string<date-time> | null

Next billing date.

canceledAt
string<date-time> | null
cancelReason
object
items
object[]

What the subscription bills or grants.