Update subscription
update_subscriptionModify a subscription by ID to pause, cancel, change variant, set trial end, billing anchor, prorations, or invoice immediately.
Instructions
Updates the subscription with the given ID and provided attributes.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Exact opaque native resource ID; no traversal or URL. | |
| pause | No | ||
| account | No | Exact private profile label. Does not prove store ownership; mode applies to the main API key only. | |
| confirm | No | Set true only when the user asked for exactly this action. | |
| payload | No | Complete native JSON object body. JSON:API uses data/type/id/attributes/relationships. No mixing with body flags or payload_file. License credential is private configuration, never body input. | |
| cancelled | No | ||
| variant_id | No | ||
| payload_file | No | Absolute regular non-symlink native JSON body file at most 1 MiB; cannot mix with payload or body flags. | |
| trial_ends_at | No | ||
| billing_anchor | No | ||
| disable_prorations | No | ||
| invoice_immediately | No |