Subscriptions

Cancel a payer subscription using your commerce cancel policy (immediate or at period end). Use the id field from LIST_MERCHANT_SUBSCRIPTIONS — not stripe_subscription_id.

Apply a plan change for a payer subscription to another catalog product in the same plan family. Preview first. Use Clearway subscription id as subscriptionId. Sandbox-mode API keys return a simulated success via EXECUTE_API_SANDBOX_CALL (no live charge).

List payer subscriptions to your catalog products. Each row includes an id (Clearway UUID) — use that value in Cancel subscriptions, not stripe_subscription_id. Response includes totalCount, offset, limit, and capped when more rows exist than returned.

Preview proration / timing for moving a payer subscription to another catalog product in the same plan family. Use the Clearway subscription id from list subscriptions as subscriptionId.