Overview
Manage recurring subscription lifecycle actions across supported providers.
Subscriptions are recurring product purchases. What you can change depends on the payment provider, the subscription's current state, and whether the action belongs to the seller or customer. Read capabilities immediately before showing or using pause, resume, cancellation, payment-method, plan, or renewal-date controls.
Lifecycle writes accept Idempotency-Key or JSON idempotency_key; the header
takes precedence. Save one key per intended change and reuse it only with
identical input. A successful response can mean the provider is still processing
the action, not that the change has finished.
The lifecycle endpoints use the SellApp subscription record ID in
productSubscription. The compatibility cancel route can also resolve
supported order IDs. Operation schemas define the current provider-neutral
request and response fields.
Endpoints
- Cancel a subscription
- Cancel immediately with a refund
- View capabilities
- Cancel at period end
- Cancel immediately
- Pause
- Resume
- Update payment method
- Preview a plan change
- Confirm a plan change
- Preview a renewal date change
- Confirm a renewal date change
See Handle subscriptions.