Subscriptions

Subscriptions allow you to charge a customer on a recurring basis.

Related guide: Creating subscriptions

Endpoints

Create a subscription

• POST /v1/subscriptions

Update a subscription

• POST /v1/subscriptions/:id

Retrieve a subscription

• GET /v1/subscriptions/:id

List subscriptions

• GET /v1/subscriptions

Cancel a subscription

• DELETE /v1/subscriptions/:id

Migrate a subscription

• POST /v1/subscriptions/:id/migrate

Resume a subscription

• POST /v1/subscriptions/:id/resume

Search subscriptions

• GET /v1/subscriptions/search

Events

• customer.subscription.created Occurs whenever a customer is signed up for a new plan.

• customer.subscription.deleted Occurs whenever a customer’s subscription ends.

• customer.subscription.paused Occurs whenever a customer’s subscription is paused. Only applies when subscriptions enter status=paused, not when payment collection is paused.

• customer.subscription.pending_update_applied Occurs whenever a customer’s subscription’s pending update is applied, and the subscription is updated.

• customer.subscription.pending_update_expired Occurs whenever a customer’s subscription’s pending update expires before the related invoice is paid.

• customer.subscription.resumed Occurs whenever a customer’s subscription is no longer paused. Only applies when a status=paused subscription is resumed, not when payment collection is resumed.

• customer.subscription.trial_will_end Occurs three days before a subscription’s trial period is scheduled to end, or when a trial is ended immediately (using trial_end=now).

• customer.subscription.updated Occurs whenever a subscription changes (e.g., switching from one plan to another, or changing the status from trial to active).