Skip to main content
A subscription (sub_*) charges a payer’s card on a schedule they agree to once in checkout: with no end, or in 2 to 4 installments. Each payment it owes is a subscription payment. To learn more, see Charge on a schedule.

Example

GET /subscriptions/{subscriptionId}
The object is everything inside data. The field names below are relative to it: attributes.status is data.attributes.status in the response.

Fields

string
required
Subscription ID (sub_*).
string
required
Resource type. Always subscription.
object
required
The subscription’s details.
object
required
Objects linked to the subscription.

Statuses

Events

  • subscription.activated: Early access (subscriptions). The payer paid payment 1 in checkout, so the subscription is active.
  • subscription.updated: Early access (subscriptions). A subscription’s status changed without starting or ending it, for example from active to past_due or needs_attention. data.previousStatus has the status it left.
  • subscription.canceled: Early access (subscriptions). A subscription was canceled. Natural starts no new charges, though a charge already under way can still go through. It also fires when a pending subscription’s checkout ends without payment 1, so it can follow no subscription.activated.
  • subscription.completed: Early access (subscriptions). Every payment of a subscription in installments is paid or marked paid.

Errors

See the error codes these endpoints return.

Sandbox simulations

  • Card fixtures: Test successful payments, declines, 3-D Secure, subscriptions, settlement, cancels, and refunds in Sandbox