Updates are never prorated: an item or price change creates no credit for unused time and no prorated charge. Within the same billing interval, the new price applies from the next renewal.
When an item change moves the subscription to a different billing interval, longer or shorter (for example monthly to every 3 months, or back), a new period starts at the change and the new price is charged in full immediately, with no credit for time already paid. Discounts already on the subscription apply to that charge, and a once discount sent in the same request lands on it. A trialing subscription, or a request that sets trial_end, starts no new period, so the change does not end the trial. An interval change on a paused subscription is a 400; resume it first.
After a change, a subscription can hold at most one item, because every subscription item is a recurring price. Create a separate subscription for each recurring product.
/v0.1 of this operation is deprecated and stops working on 2027-01-17.
Service (M2M) access token issued by POST /auth/token using the client_credentials grant. Required scopes, where known, are listed on each operation below.
Path Parameters
provider_subscription_id
string
required
Provider subscription ID (e.g. test_subscription_id).
Body
application/json
discounts
object[]
Replaces the subscription-level discounts with the ones you send. An empty array removes all of them. Discounts on individual items are not affected; use items[].discounts for those. To keep a discount while changing the others, resend it as { "discount": "<its provider_discount_id>" }. Each entry must specify exactly one of coupon, promotion_code or discount. A blank or non-string member is ignored rather than rejected, so {"coupon": "", "promotion_code": "test_promotion_code_id"} is accepted as a promotion-code discount. Ids are trimmed before use. Changed: an empty array used to change nothing; it now removes every subscription-level discount, so omit the field to leave the discounts alone.
Show child attributes
default_payment_method
string
Provider payment-method id (e.g. pm_...). Non-empty.
items
object[]
Non-empty. Each entry needs at least one of provider_item_id or provider_price_id; optional quantity (non-negative integer), deleted (boolean, used with provider_item_id to remove the item) and discounts (this item's discounts). After the change the subscription may hold at most one item: the count is the current items, minus entries with provider_item_id and deleted: true, plus entries without provider_item_id and without deleted: true. quantity: 0 does not remove an item. Checked only when items is sent, so a subscription that already holds several items can still change its other fields.
Show child attributes
metadata
object
Free-form string key/value pairs. Merged, not replaced — keys you omit are preserved; send a key with an empty-string value to unset just that key. An empty {} clears nothing and does not count as an update, so metadata: {} on its own is a 400.
Show child attributes
trial_end
integer
Unix timestamp in seconds; must be an integer in the future. Starts a trial ending at that instant and moves the subscription's billing anchor to it, so the next charge lands on that date instead of the original schedule — the way to push out a renewal when, say, a shipment was delayed. Valid on its own. Three consequences to know before calling it: (1) nothing is charged, though the provider does record a $0 invoice with a single “Trial period” line that will appear in GET /subscriptions/{provider_subscription_id}/invoices. (2) The subscription reports status: "trialing" until the date passes, so GET /subscriptions?status=active will not return it during that window — query status=trialing or status=all. (3) The anchor move is permanent: every later cycle bills on the new date, the original schedule does not resume. Combining it with items or discounts is allowed.
cancel_at
stringinteger
Moves or removes a scheduled cancel. A future unix timestamp in integer seconds, no later than the end of the current billing period, cancels at that instant (cancel_at_period_end: false); "period_end" cancels at the end of the current period (cancel_at_period_end: true); null removes any scheduled cancel, and is safe to send when nothing is scheduled. null counts as an update. Moving or removing a cancel creates no invoice and charges nothing. A timestamp after the current billing period ends is a 400: a cancel date in a later period would renew the subscription into a partial final period, which the payment provider always bills prorated. A date exactly at the period end is accepted and bills like "period_end", but reports cancel_at_period_end: false. A timestamp sent to a subscription with no upcoming renewal is a 400. When the same request changes the billing interval, a timestamp is checked against the end of the new period. A timestamp cannot be combined with trial_end (send trial_end first, then cancel_at in a separate request); "period_end" and null can. "now" is a 400: use DELETE /subscriptions/{provider_subscription_id} to cancel immediately. Needs the payment-subscriptions:update permission, not :cancel.
Response
Success.
data
object
required
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Partners API Documentation","colors":{"primary":"#e34376","light":"#e55484","dark":"#e3235f"},"logo":{"light":"https://mintcdn.com/openloop/uFqnU7STc2L-iY-j/logo/openloop_light.png?fit=max\u0026auto=format\u0026n=uFqnU7STc2L-iY-j\u0026q=85\u0026s=36c08284ca501fdefe4311339c563474","dark":"https://mintcdn.com/openloop/uFqnU7STc2L-iY-j/logo/openloop_dark.png?fit=max\u0026auto=format\u0026n=uFqnU7STc2L-iY-j\u0026q=85\u0026s=81c334cb0ffc5f63a9595a1d611595ce"},"favicon":"https://mintcdn.com/openloop/uFqnU7STc2L-iY-j/favicon.ico?fit=max\u0026auto=format\u0026n=uFqnU7STc2L-iY-j\u0026q=85\u0026s=7be86b4f76e18b47229f3b8646ba3fa2","api":{"playground":{"display":"interactive"}},"navbar":{"links":[{"href":"https://openloophealth.com","label":"OpenLoop Health"}],"primary":{"type":"button","label":"Get Started","href":"https://openloophealth.com/contact"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/openloophealth"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"OpenLoop Health","icon":"globe","href":"https://openloophealth.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"openloop","hasAudioNarration":false,"actualSubdomain":"openloop","customDomains":[],"gitSource":{"type":"github","owner":"openloophealth","repo":"patient-zero-openloop-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6aff28baca43cd0248039897","clientVersion":"0.0.4205","searchFilterCounts":[{"language":"default","tag":"API Reference","count":130},{"language":"default","tag":"Partner Cookbook","count":24},{"language":"default","tag":"Scheduling","count":9},{"language":"default","tag":"Guides","count":8},{"language":"default","tag":"Subscriptions","count":8},{"language":"default","tag":"Auth","count":7},{"language":"default","tag":"Billing Customers","count":7},{"language":"default","tag":"Eligibility","count":7},{"language":"default","tag":"When things go wrong","count":6},{"language":"default","tag":"Users","count":6}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/subscriptions/update-subscription","slug":"/api-reference/subscriptions/update-subscription","pageMetadata":{"title":"Update Subscription","description":"Partially updates an existing subscription. Immediate cancels, pauses and resumes are not accepted on this endpoint — use [`DELETE /subscriptions/{provider_subscription_id}`](./cancel-subscription.md) (cancel), [`POST /subscriptions/{provider_subscription_id}/pauses`](./pause-subscription.md) (pause), or [`DELETE /subscriptions/{provider_subscription_id}/pauses`](./resume-subscription.md) (resume) instead. To move or remove a cancel that is already scheduled, send `cancel_at`. Returns the updated subscription in the same shape as `GET /subscriptions/{provider_subscription_id}`.\n\nUpdates are never prorated: an item or price change creates no credit for unused time and no prorated charge. Within the same billing interval, the new price applies from the next renewal.\n\nWhen an item change moves the subscription to a different billing interval, longer or shorter (for example monthly to every 3 months, or back), a new period starts at the change and the new price is charged in full immediately, with no credit for time already paid. Discounts already on the subscription apply to that charge, and a `once` discount sent in the same request lands on it. A trialing subscription, or a request that sets `trial_end`, starts no new period, so the change does not end the trial. An interval change on a paused subscription is a `400`; resume it first.\n\nAfter a change, a subscription can hold at most one item, because every subscription item is a recurring price. Create a separate subscription for each recurring product.\n\n`/v0.1` of this operation is deprecated and stops working on 2027-01-17.","deprecated":null,"version":null,"openapi":"/openapi.json put /subscriptions/{provider_subscription_id}","href":"/api-reference/subscriptions/update-subscription","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Partially updates an existing subscription. Immediate cancels, pauses and resumes are not accepted on this endpoint — use \", _jsx(_components.a, {\n href: \"./cancel-subscription.md\",\n children: _jsx(_components.code, {\n children: \"DELETE /subscriptions/{provider_subscription_id}\"\n })\n }), \" (cancel), \", _jsx(_components.a, {\n href: \"./pause-subscription.md\",\n children: _jsx(_components.code, {\n children: \"POST /subscriptions/{provider_subscription_id}/pauses\"\n })\n }), \" (pause), or \", _jsx(_components.a, {\n href: \"./resume-subscription.md\",\n children: _jsx(_components.code, {\n children: \"DELETE /subscriptions/{provider_subscription_id}/pauses\"\n })\n }), \" (resume) instead. To move or remove a cancel that is already scheduled, send \", _jsx(_components.code, {\n children: \"cancel_at\"\n }), \". Returns the updated subscription in the same shape as \", _jsx(_components.code, {\n children: \"GET /subscriptions/{provider_subscription_id}\"\n }), \".\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Updates are never prorated: an item or price change creates no credit for unused time and no prorated charge. Within the same billing interval, the new price applies from the next renewal.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"When an item change moves the subscription to a different billing interval, longer or shorter (for example monthly to every 3 months, or back), a new period starts at the change and the new price is charged in full immediately, with no credit for time already paid. Discounts already on the subscription apply to that charge, and a \", _jsx(_components.code, {\n children: \"once\"\n }), \" discount sent in the same request lands on it. A trialing subscription, or a request that sets \", _jsx(_components.code, {\n children: \"trial_end\"\n }), \", starts no new period, so the change does not end the trial. An interval change on a paused subscription is a \", _jsx(_components.code, {\n children: \"400\"\n }), \"; resume it first.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"After a change, a subscription can hold at most one item, because every subscription item is a recurring price. Create a separate subscription for each recurring product.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"/v0.1\"\n }), \" of this operation is deprecated and stops working on 2027-01-17.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Update Subscription","description":"Partially updates an existing subscription. Immediate cancels, pauses and resumes are not accepted on this endpoint — use [`DELETE /subscriptions/{provider_subscription_id}`](./cancel-subscription.md) (cancel), [`POST /subscriptions/{provider_subscription_id}/pauses`](./pause-subscription.md) (pause), or [`DELETE /subscriptions/{provider_subscription_id}/pauses`](./resume-subscription.md) (resume) instead. To move or remove a cancel that is already scheduled, send `cancel_at`. Returns the updated subscription in the same shape as `GET /subscriptions/{provider_subscription_id}`.\n\nUpdates are never prorated: an item or price change creates no credit for unused time and no prorated charge. Within the same billing interval, the new price applies from the next renewal.\n\nWhen an item change moves the subscription to a different billing interval, longer or shorter (for example monthly to every 3 months, or back), a new period starts at the change and the new price is charged in full immediately, with no credit for time already paid. Discounts already on the subscription apply to that charge, and a `once` discount sent in the same request lands on it. A trialing subscription, or a request that sets `trial_end`, starts no new period, so the change does not end the trial. An interval change on a paused subscription is a `400`; resume it first.\n\nAfter a change, a subscription can hold at most one item, because every subscription item is a recurring price. Create a separate subscription for each recurring product.\n\n`/v0.1` of this operation is deprecated and stops working on 2027-01-17.","deprecated":null,"version":null,"openapi":"/openapi.json put /subscriptions/{provider_subscription_id}","href":"/api-reference/subscriptions/update-subscription","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Update Subscription","tags":["Subscriptions"],"security":["0bf5362e-cd1e-48a0-b768-36d165f4273f","f54a8c99-0f6a-44ab-9cfb-a01b465d8cb7"],"description":"Partially updates an existing subscription. Immediate cancels, pauses and resumes are not accepted on this endpoint — use [`DELETE /subscriptions/{provider_subscription_id}`](./cancel-subscription.md) (cancel), [`POST /subscriptions/{provider_subscription_id}/pauses`](./pause-subscription.md) (pause), or [`DELETE /subscriptions/{provider_subscription_id}/pauses`](./resume-subscription.md) (resume) instead. To move or remove a cancel that is already scheduled, send `cancel_at`. Returns the updated subscription in the same shape as `GET /subscriptions/{provider_subscription_id}`.\n\nUpdates are never prorated: an item or price change creates no credit for unused time and no prorated charge. Within the same billing interval, the new price applies from the next renewal.\n\nWhen an item change moves the subscription to a different billing interval, longer or shorter (for example monthly to every 3 months, or back), a new period starts at the change and the new price is charged in full immediately, with no credit for time already paid. Discounts already on the subscription apply to that charge, and a `once` discount sent in the same request lands on it. A trialing subscription, or a request that sets `trial_end`, starts no new period, so the change does not end the trial. An interval change on a paused subscription is a `400`; resume it first.\n\nAfter a change, a subscription can hold at most one item, because every subscription item is a recurring price. Create a separate subscription for each recurring product.\n\n`/v0.1` of this operation is deprecated and stops working on 2027-01-17.","servers":["ade1cd8e-addd-48fa-84f1-0977ca5c5238","351ca2c1-07e2-456d-902c-64b8ca779332"],"parameters":["f1343a17-25c5-4d2e-b70b-3fc77505e69a"],"requestBody":"2f2af5d1-e6f5-41a5-9f3d-e14710958033","responses":{"200":"fb492f8a-0da4-46f7-8a1a-398aa25be26f","400":"3fc9743d-72e2-4cf0-a566-2aec10a036c4","401":"e69efe70-fe60-4a61-8546-1492282eab02","403":"627781ec-14a0-442f-a2c1-bb1ce771cedc","404":"2e0284f3-685e-483f-a7a4-fd26cec67459","500":"9ee849b7-aca5-4141-855f-13f8225e4092"},"method":"put","type":"path","path":"/subscriptions/{provider_subscription_id}","baseUrlOptions":["https://api.openloophealth.com/v0.2","https://api-staging.openloophealth.com/v0.2"],"title":"Update Subscription","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"f1343a17-25c5-4d2e-b70b-3fc77505e69a":{"in":"path","name":"provider_subscription_id","required":true,"schema":{"type":"string","isRequired":true,"description":"Provider subscription ID (e.g. `test_subscription_id`).","uniqueKey":"","typeLabel":"string"},"description":"Provider subscription ID (e.g. `test_subscription_id`)."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"discounts":{"type":"array","items":{"type":"object","properties":{"coupon":{"type":"string","description":"Provider coupon id. Exactly one of `coupon`, `promotion_code` or `discount` per entry.","uniqueKey":"discounts.items.[INDEX].coupon","typeLabel":"string"},"promotion_code":{"type":"string","description":"Provider promotion-code id. Exactly one of `coupon`, `promotion_code` or `discount` per entry.","uniqueKey":"discounts.items.[INDEX].promotion_code","typeLabel":"string"},"discount":{"type":"string","description":"Provider id of an **existing** discount (`di_...`) on this subscription or its billing customer, to reuse it rather than create a new one. Exactly one of `coupon`, `promotion_code` or `discount` per entry.","uniqueKey":"discounts.items.[INDEX].discount","typeLabel":"string"}},"uniqueKey":"discounts.items.[INDEX]","typeLabel":"object"},"description":"Replaces the subscription-level discounts with the ones you send. **An empty array removes all of them.** Discounts on individual items are not affected; use `items[].discounts` for those. To keep a discount while changing the others, resend it as `{ \"discount\": \"\u003cits provider_discount_id>\" }`. Each entry must specify **exactly one** of `coupon`, `promotion_code` or `discount`. A blank or non-string member is ignored rather than rejected, so `{\"coupon\": \"\", \"promotion_code\": \"test_promotion_code_id\"}` is accepted as a promotion-code discount. Ids are trimmed before use. **Changed:** an empty array used to change nothing; it now removes every subscription-level discount, so omit the field to leave the discounts alone.","uniqueKey":"discounts","typeLabel":"object[]"},"default_payment_method":{"type":"string","description":"Provider payment-method id (e.g. `pm_...`). Non-empty.","uniqueKey":"default_payment_method","typeLabel":"string"},"items":{"type":"array","items":{"type":"object","properties":{"provider_item_id":{"type":"string","description":"Existing provider subscription-item id to update or remove.","uniqueKey":"\\items.items.[INDEX].provider_item_id","typeLabel":"string"},"provider_price_id":{"type":"string","description":"Provider price id to add a new item.","uniqueKey":"\\items.items.[INDEX].provider_price_id","typeLabel":"string"},"quantity":{"type":"number","description":"Item quantity.","uniqueKey":"\\items.items.[INDEX].quantity","typeLabel":"number"},"deleted":{"type":"boolean","description":"Set with `id` to remove the item.","uniqueKey":"\\items.items.[INDEX].deleted","typeLabel":"boolean"},"discounts":{"type":"array","items":{"type":"object","properties":{"coupon":{"type":"string","description":"Provider coupon id. Exactly one of `coupon`, `promotion_code` or `discount` per entry.","uniqueKey":"\\items.items.[INDEX].discounts.items.[INDEX].coupon","typeLabel":"string"},"promotion_code":{"type":"string","description":"Provider promotion-code id. Exactly one of `coupon`, `promotion_code` or `discount` per entry.","uniqueKey":"\\items.items.[INDEX].discounts.items.[INDEX].promotion_code","typeLabel":"string"},"discount":{"type":"string","description":"Provider id of an **existing** discount (`di_...`) on this subscription or its billing customer, to reuse it rather than create a new one. Exactly one of `coupon`, `promotion_code` or `discount` per entry.","uniqueKey":"\\items.items.[INDEX].discounts.items.[INDEX].discount","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].discounts.items.[INDEX]","typeLabel":"object"},"description":"Replaces **this item's** discounts with the ones you send; an empty array removes them. Same entry shape as the top-level `discounts`. Omit it to leave the item's discounts unchanged. Only the item named by `provider_item_id` is affected: other items and the subscription-level discounts keep theirs. A new item added with `provider_price_id` is created with these discounts. On an item removed with `deleted: true` they are accepted and ignored.","uniqueKey":"\\items.items.[INDEX].discounts","typeLabel":"object[]"}},"uniqueKey":"\\items.items.[INDEX]","typeLabel":"object"},"description":"Non-empty. Each entry needs at least one of `provider_item_id` or `provider_price_id`; optional `quantity` (non-negative integer), `deleted` (boolean, used with `provider_item_id` to remove the item) and `discounts` (this item's discounts). After the change the subscription may hold at most one item: the count is the current items, minus entries with `provider_item_id` and `deleted: true`, plus entries without `provider_item_id` and without `deleted: true`. `quantity: 0` does not remove an item. Checked only when `items` is sent, so a subscription that already holds several items can still change its other fields.","uniqueKey":"\\items","typeLabel":"object[]"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"metadata.additionalProperties","typeLabel":"string"},"description":"Free-form string key/value pairs. Merged, not replaced — keys you omit are preserved; send a key with an empty-string value to unset just that key. An empty `{}` clears nothing and does not count as an update, so `metadata: {}` on its own is a `400`.","uniqueKey":"metadata","typeLabel":"object"},"trial_end":{"type":"integer","description":"Unix timestamp in **seconds**; must be an integer in the future. Starts a trial ending at that instant and moves the subscription's billing anchor to it, so the next charge lands on that date instead of the original schedule — the way to push out a renewal when, say, a shipment was delayed. Valid on its own. Three consequences to know before calling it: **(1)** nothing is charged, though the provider does record a **$0 invoice** with a single “Trial period” line that will appear in `GET /subscriptions/{provider_subscription_id}/invoices`. **(2)** The subscription reports `status: \"trialing\"` until the date passes, so `GET /subscriptions?status=active` will not return it during that window — query `status=trialing` or `status=all`. **(3)** The anchor move is **permanent**: every later cycle bills on the new date, the original schedule does not resume. Combining it with `items` or `discounts` is allowed.","uniqueKey":"trial_end","typeLabel":"integer"},"cancel_at":{"oneOf":[{"type":"string","description":"Moves or removes a scheduled cancel. A **future** unix timestamp in integer seconds, no later than the end of the current billing period, cancels at that instant (`cancel_at_period_end: false`); `\"period_end\"` cancels at the end of the current period (`cancel_at_period_end: true`); `null` removes any scheduled cancel, and is safe to send when nothing is scheduled. `null` counts as an update. Moving or removing a cancel creates no invoice and charges nothing. A timestamp after the current billing period ends is a `400`: a cancel date in a later period would renew the subscription into a partial final period, which the payment provider always bills prorated. A date exactly at the period end is accepted and bills like `\"period_end\"`, but reports `cancel_at_period_end: false`. A timestamp sent to a subscription with no upcoming renewal is a `400`. When the same request changes the billing interval, a timestamp is checked against the end of the new period. A timestamp cannot be combined with `trial_end` (send `trial_end` first, then `cancel_at` in a separate request); `\"period_end\"` and `null` can. `\"now\"` is a `400`: use `DELETE /subscriptions/{provider_subscription_id}` to cancel immediately. Needs the `payment-subscriptions:update` permission, not `:cancel`.","uniqueKey":"cancel_at.oneOf.0","typeLabel":"string"},{"type":"integer","description":"Moves or removes a scheduled cancel. A **future** unix timestamp in integer seconds, no later than the end of the current billing period, cancels at that instant (`cancel_at_period_end: false`); `\"period_end\"` cancels at the end of the current period (`cancel_at_period_end: true`); `null` removes any scheduled cancel, and is safe to send when nothing is scheduled. `null` counts as an update. Moving or removing a cancel creates no invoice and charges nothing. A timestamp after the current billing period ends is a `400`: a cancel date in a later period would renew the subscription into a partial final period, which the payment provider always bills prorated. A date exactly at the period end is accepted and bills like `\"period_end\"`, but reports `cancel_at_period_end: false`. A timestamp sent to a subscription with no upcoming renewal is a `400`. When the same request changes the billing interval, a timestamp is checked against the end of the new period. A timestamp cannot be combined with `trial_end` (send `trial_end` first, then `cancel_at` in a separate request); `\"period_end\"` and `null` can. `\"now\"` is a `400`: use `DELETE /subscriptions/{provider_subscription_id}` to cancel immediately. Needs the `payment-subscriptions:update` permission, not `:cancel`.","uniqueKey":"cancel_at.oneOf.1","typeLabel":"integer"},{"type":"null","description":"Moves or removes a scheduled cancel. A **future** unix timestamp in integer seconds, no later than the end of the current billing period, cancels at that instant (`cancel_at_period_end: false`); `\"period_end\"` cancels at the end of the current period (`cancel_at_period_end: true`); `null` removes any scheduled cancel, and is safe to send when nothing is scheduled. `null` counts as an update. Moving or removing a cancel creates no invoice and charges nothing. A timestamp after the current billing period ends is a `400`: a cancel date in a later period would renew the subscription into a partial final period, which the payment provider always bills prorated. A date exactly at the period end is accepted and bills like `\"period_end\"`, but reports `cancel_at_period_end: false`. A timestamp sent to a subscription with no upcoming renewal is a `400`. When the same request changes the billing interval, a timestamp is checked against the end of the new period. A timestamp cannot be combined with `trial_end` (send `trial_end` first, then `cancel_at` in a separate request); `\"period_end\"` and `null` can. `\"now\"` is a `400`: use `DELETE /subscriptions/{provider_subscription_id}` to cancel immediately. Needs the `payment-subscriptions:update` permission, not `:cancel`.","uniqueKey":"cancel_at.oneOf.2","typeLabel":"null"}],"uniqueKey":"cancel_at","typeLabel":"string | integer | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"default_payment_method":"test_payment_method_id"},"examples":{"Example":{"title":"Example","value":{"default_payment_method":"test_payment_method_id"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"fb492f8a-0da4-46f7-8a1a-398aa25be26f":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"config_id":{"type":"string","description":"Configuration ID.","uniqueKey":"data.config_id","typeLabel":"string"},"provider_account_id":{"oneOf":[{"type":"string","description":"Provider account ID.","uniqueKey":"data.provider_account_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Provider account ID.","uniqueKey":"data.provider_account_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.provider_account_id","typeLabel":"string | null"},"payment_provider":{"type":"string","description":"Provider enum (e.g. `\"stripe\"`).","uniqueKey":"data.payment_provider","typeLabel":"string"},"subscription":{"type":"object","properties":{"provider_customer_id":{"type":"string","description":"Provider customer ID owning the subscription.","uniqueKey":"data.subscription.provider_customer_id","typeLabel":"string"},"provider_subscription_id":{"type":"string","description":"Provider subscription ID.","uniqueKey":"data.subscription.provider_subscription_id","typeLabel":"string"},"status":{"type":"string","description":"Provider subscription status.","uniqueKey":"data.subscription.status","typeLabel":"string"},"description":{"oneOf":[{"type":"string","description":"Subscription description.","uniqueKey":"data.subscription.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Subscription description.","uniqueKey":"data.subscription.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.description","typeLabel":"string | null"},"items":{"type":"array","items":{"type":"object","properties":{"provider_item_id":{"type":"string","description":"Provider subscription-item ID.","uniqueKey":"data.subscription.\\items.items.[INDEX].provider_item_id","typeLabel":"string"},"quantity":{"type":"number","description":"Item quantity.","uniqueKey":"data.subscription.\\items.items.[INDEX].quantity","typeLabel":"number"},"metadata":{"oneOf":[{"type":"object","description":"Custom metadata (string key/value pairs) or `null`.","uniqueKey":"data.subscription.\\items.items.[INDEX].metadata.oneOf.0","typeLabel":"object"},{"type":"null","description":"Custom metadata (string key/value pairs) or `null`.","uniqueKey":"data.subscription.\\items.items.[INDEX].metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.\\items.items.[INDEX].metadata","typeLabel":"object | null"},"price":{"oneOf":[{"type":"object","properties":{"provider_price_id":{"type":"string","description":"Provider price ID.","uniqueKey":"data.subscription.\\items.items.[INDEX].price.oneOf.0.provider_price_id","typeLabel":"string"},"provider_product_id":{"type":"string","description":"Provider product ID.","uniqueKey":"data.subscription.\\items.items.[INDEX].price.oneOf.0.provider_product_id","typeLabel":"string"},"currency":{"type":"string","description":"ISO 4217 currency code.","uniqueKey":"data.subscription.\\items.items.[INDEX].price.oneOf.0.currency","typeLabel":"string"},"amount_cents":{"type":"number","description":"Unit amount in cents.","uniqueKey":"data.subscription.\\items.items.[INDEX].price.oneOf.0.amount_cents","typeLabel":"number"},"active":{"oneOf":[{"type":"boolean","description":"Whether the price is currently active.","uniqueKey":"data.subscription.\\items.items.[INDEX].price.oneOf.0.active.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the price is currently active.","uniqueKey":"data.subscription.\\items.items.[INDEX].price.oneOf.0.active.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.\\items.items.[INDEX].price.oneOf.0.active","typeLabel":"boolean | null"},"billing_scheme":{"oneOf":[{"type":"string","description":"Provider billing scheme (e.g. `\"per_unit\"`).","uniqueKey":"data.subscription.\\items.items.[INDEX].price.oneOf.0.billing_scheme.oneOf.0","typeLabel":"string"},{"type":"null","description":"Provider billing scheme (e.g. `\"per_unit\"`).","uniqueKey":"data.subscription.\\items.items.[INDEX].price.oneOf.0.billing_scheme.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.\\items.items.[INDEX].price.oneOf.0.billing_scheme","typeLabel":"string | null"},"created":{"oneOf":[{"type":"number","description":"Unix timestamp the price was created.","uniqueKey":"data.subscription.\\items.items.[INDEX].price.oneOf.0.created.oneOf.0","typeLabel":"number"},{"type":"null","description":"Unix timestamp the price was created.","uniqueKey":"data.subscription.\\items.items.[INDEX].price.oneOf.0.created.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.\\items.items.[INDEX].price.oneOf.0.created","typeLabel":"number | null"},"recurring":{"oneOf":[{"type":"object","properties":{"interval":{"type":"string","description":"Billing interval (e.g. `\"month\"`).","uniqueKey":"data.subscription.\\items.items.[INDEX].price.oneOf.0.recurring.oneOf.0.interval","typeLabel":"string"},"interval_count":{"type":"number","description":"Number of intervals per billing cycle.","uniqueKey":"data.subscription.\\items.items.[INDEX].price.oneOf.0.recurring.oneOf.0.interval_count","typeLabel":"number"}},"description":"Recurring interval details or `null` for one-time prices.","uniqueKey":"data.subscription.\\items.items.[INDEX].price.oneOf.0.recurring.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"interval":{"type":"string","description":"Billing interval (e.g. `\"month\"`)."},"interval_count":{"type":"number","description":"Number of intervals per billing cycle."}},"description":"Recurring interval details or `null` for one-time prices.","uniqueKey":"data.subscription.\\items.items.[INDEX].price.oneOf.0.recurring.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.\\items.items.[INDEX].price.oneOf.0.recurring","typeLabel":"object | null"}},"description":"Price details or `null`.","uniqueKey":"data.subscription.\\items.items.[INDEX].price.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"provider_price_id":{"type":"string","description":"Provider price ID."},"provider_product_id":{"type":"string","description":"Provider product ID."},"currency":{"type":"string","description":"ISO 4217 currency code."},"amount_cents":{"type":"number","description":"Unit amount in cents."},"active":{"oneOf":[{"type":"boolean","description":"Whether the price is currently active."},{"type":"null","description":"Whether the price is currently active."}]},"billing_scheme":{"oneOf":[{"type":"string","description":"Provider billing scheme (e.g. `\"per_unit\"`)."},{"type":"null","description":"Provider billing scheme (e.g. `\"per_unit\"`)."}]},"created":{"oneOf":[{"type":"number","description":"Unix timestamp the price was created."},{"type":"null","description":"Unix timestamp the price was created."}]},"recurring":{"oneOf":[{"type":"object","properties":{"interval":{"type":"string","description":"Billing interval (e.g. `\"month\"`)."},"interval_count":{"type":"number","description":"Number of intervals per billing cycle."}},"description":"Recurring interval details or `null` for one-time prices."},{"type":"null","properties":{"interval":{"type":"string","description":"Billing interval (e.g. `\"month\"`)."},"interval_count":{"type":"number","description":"Number of intervals per billing cycle."}},"description":"Recurring interval details or `null` for one-time prices."}]}},"description":"Price details or `null`.","uniqueKey":"data.subscription.\\items.items.[INDEX].price.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.\\items.items.[INDEX].price","typeLabel":"object | null"},"product":{"oneOf":[{"type":"object","properties":{"name":{"type":"string","description":"Product name.","uniqueKey":"data.subscription.\\items.items.[INDEX].product.oneOf.0.name","typeLabel":"string"},"description":{"oneOf":[{"type":"string","description":"Product description.","uniqueKey":"data.subscription.\\items.items.[INDEX].product.oneOf.0.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Product description.","uniqueKey":"data.subscription.\\items.items.[INDEX].product.oneOf.0.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.\\items.items.[INDEX].product.oneOf.0.description","typeLabel":"string | null"},"metadata":{"type":"object","description":"Custom metadata (string key/value pairs).","uniqueKey":"data.subscription.\\items.items.[INDEX].product.oneOf.0.metadata","typeLabel":"object"}},"description":"Product details or `null`.","uniqueKey":"data.subscription.\\items.items.[INDEX].product.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"name":{"type":"string","description":"Product name."},"description":{"oneOf":[{"type":"string","description":"Product description."},{"type":"null","description":"Product description."}]},"metadata":{"type":"object","description":"Custom metadata (string key/value pairs)."}},"description":"Product details or `null`.","uniqueKey":"data.subscription.\\items.items.[INDEX].product.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.\\items.items.[INDEX].product","typeLabel":"object | null"},"current_period_start":{"oneOf":[{"type":"number","description":"Unix timestamp of the current period start.","uniqueKey":"data.subscription.\\items.items.[INDEX].current_period_start.oneOf.0","typeLabel":"number"},{"type":"null","description":"Unix timestamp of the current period start.","uniqueKey":"data.subscription.\\items.items.[INDEX].current_period_start.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.\\items.items.[INDEX].current_period_start","typeLabel":"number | null"},"current_period_end":{"oneOf":[{"type":"number","description":"Unix timestamp of the current period end.","uniqueKey":"data.subscription.\\items.items.[INDEX].current_period_end.oneOf.0","typeLabel":"number"},{"type":"null","description":"Unix timestamp of the current period end.","uniqueKey":"data.subscription.\\items.items.[INDEX].current_period_end.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.\\items.items.[INDEX].current_period_end","typeLabel":"number | null"},"created":{"oneOf":[{"type":"number","description":"Unix timestamp the item was created.","uniqueKey":"data.subscription.\\items.items.[INDEX].created.oneOf.0","typeLabel":"number"},{"type":"null","description":"Unix timestamp the item was created.","uniqueKey":"data.subscription.\\items.items.[INDEX].created.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.\\items.items.[INDEX].created","typeLabel":"number | null"},"discounts":{"type":"array","items":{"type":"object","properties":{"provider_discount_id":{"type":"string","description":"Provider discount ID.","uniqueKey":"data.subscription.\\items.items.[INDEX].discounts.items.[INDEX].provider_discount_id","typeLabel":"string"},"provider_coupon_id":{"oneOf":[{"type":"string","description":"Provider coupon ID backing this discount, or `null`.","uniqueKey":"data.subscription.\\items.items.[INDEX].discounts.items.[INDEX].provider_coupon_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Provider coupon ID backing this discount, or `null`.","uniqueKey":"data.subscription.\\items.items.[INDEX].discounts.items.[INDEX].provider_coupon_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.\\items.items.[INDEX].discounts.items.[INDEX].provider_coupon_id","typeLabel":"string | null"},"provider_promotion_code_id":{"oneOf":[{"type":"string","description":"Provider promotion code ID that created this discount, or `null` when a coupon was applied directly.","uniqueKey":"data.subscription.\\items.items.[INDEX].discounts.items.[INDEX].provider_promotion_code_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Provider promotion code ID that created this discount, or `null` when a coupon was applied directly.","uniqueKey":"data.subscription.\\items.items.[INDEX].discounts.items.[INDEX].provider_promotion_code_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.\\items.items.[INDEX].discounts.items.[INDEX].provider_promotion_code_id","typeLabel":"string | null"},"start":{"oneOf":[{"type":"number","description":"Unix timestamp the discount started.","uniqueKey":"data.subscription.\\items.items.[INDEX].discounts.items.[INDEX].start.oneOf.0","typeLabel":"number"},{"type":"null","description":"Unix timestamp the discount started.","uniqueKey":"data.subscription.\\items.items.[INDEX].discounts.items.[INDEX].start.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.\\items.items.[INDEX].discounts.items.[INDEX].start","typeLabel":"number | null"},"end":{"oneOf":[{"type":"number","description":"Unix timestamp the discount ends, or `null` if open-ended.","uniqueKey":"data.subscription.\\items.items.[INDEX].discounts.items.[INDEX].end.oneOf.0","typeLabel":"number"},{"type":"null","description":"Unix timestamp the discount ends, or `null` if open-ended.","uniqueKey":"data.subscription.\\items.items.[INDEX].discounts.items.[INDEX].end.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.\\items.items.[INDEX].discounts.items.[INDEX].end","typeLabel":"number | null"}},"uniqueKey":"data.subscription.\\items.items.[INDEX].discounts.items.[INDEX]","typeLabel":"object"},"description":"Discounts applied to this item only, separate from the subscription-level `discounts`. Empty array when none.","uniqueKey":"data.subscription.\\items.items.[INDEX].discounts","typeLabel":"object[]"}},"uniqueKey":"data.subscription.\\items.items.[INDEX]","typeLabel":"object"},"description":"Subscription items.","uniqueKey":"data.subscription.\\items","typeLabel":"object[]"},"cancellation_details":{"oneOf":[{"type":"object","properties":{"comment":{"oneOf":[{"type":"string","description":"Cancellation comment.","uniqueKey":"data.subscription.cancellation_details.oneOf.0.comment.oneOf.0","typeLabel":"string"},{"type":"null","description":"Cancellation comment.","uniqueKey":"data.subscription.cancellation_details.oneOf.0.comment.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.cancellation_details.oneOf.0.comment","typeLabel":"string | null"},"feedback":{"oneOf":[{"type":"string","description":"Cancellation feedback code.","uniqueKey":"data.subscription.cancellation_details.oneOf.0.feedback.oneOf.0","typeLabel":"string"},{"type":"null","description":"Cancellation feedback code.","uniqueKey":"data.subscription.cancellation_details.oneOf.0.feedback.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.cancellation_details.oneOf.0.feedback","typeLabel":"string | null"},"reason":{"oneOf":[{"type":"string","description":"Cancellation reason.","uniqueKey":"data.subscription.cancellation_details.oneOf.0.reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Cancellation reason.","uniqueKey":"data.subscription.cancellation_details.oneOf.0.reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.cancellation_details.oneOf.0.reason","typeLabel":"string | null"}},"description":"Cancellation metadata or `null`.","uniqueKey":"data.subscription.cancellation_details.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"comment":{"oneOf":[{"type":"string","description":"Cancellation comment."},{"type":"null","description":"Cancellation comment."}]},"feedback":{"oneOf":[{"type":"string","description":"Cancellation feedback code."},{"type":"null","description":"Cancellation feedback code."}]},"reason":{"oneOf":[{"type":"string","description":"Cancellation reason."},{"type":"null","description":"Cancellation reason."}]}},"description":"Cancellation metadata or `null`.","uniqueKey":"data.subscription.cancellation_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.cancellation_details","typeLabel":"object | null"},"discounts":{"type":"array","items":{"type":"object","properties":{"provider_discount_id":{"type":"string","description":"Provider discount ID.","uniqueKey":"data.subscription.discounts.items.[INDEX].provider_discount_id","typeLabel":"string"},"provider_coupon_id":{"oneOf":[{"type":"string","description":"Provider coupon ID backing this discount, or `null`.","uniqueKey":"data.subscription.discounts.items.[INDEX].provider_coupon_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Provider coupon ID backing this discount, or `null`.","uniqueKey":"data.subscription.discounts.items.[INDEX].provider_coupon_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.discounts.items.[INDEX].provider_coupon_id","typeLabel":"string | null"},"provider_promotion_code_id":{"oneOf":[{"type":"string","description":"Provider promotion code ID that created this discount, or `null` when a coupon was applied directly.","uniqueKey":"data.subscription.discounts.items.[INDEX].provider_promotion_code_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Provider promotion code ID that created this discount, or `null` when a coupon was applied directly.","uniqueKey":"data.subscription.discounts.items.[INDEX].provider_promotion_code_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.discounts.items.[INDEX].provider_promotion_code_id","typeLabel":"string | null"},"start":{"oneOf":[{"type":"number","description":"Unix timestamp the discount started.","uniqueKey":"data.subscription.discounts.items.[INDEX].start.oneOf.0","typeLabel":"number"},{"type":"null","description":"Unix timestamp the discount started.","uniqueKey":"data.subscription.discounts.items.[INDEX].start.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.discounts.items.[INDEX].start","typeLabel":"number | null"},"end":{"oneOf":[{"type":"number","description":"Unix timestamp the discount ends, or `null` if open-ended.","uniqueKey":"data.subscription.discounts.items.[INDEX].end.oneOf.0","typeLabel":"number"},{"type":"null","description":"Unix timestamp the discount ends, or `null` if open-ended.","uniqueKey":"data.subscription.discounts.items.[INDEX].end.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.discounts.items.[INDEX].end","typeLabel":"number | null"}},"uniqueKey":"data.subscription.discounts.items.[INDEX]","typeLabel":"object"},"description":"Discounts currently applied to the subscription. Empty array when none.","uniqueKey":"data.subscription.discounts","typeLabel":"object[]"},"cancel_at_period_end":{"type":"boolean","description":"Whether the subscription cancels at period end.","uniqueKey":"data.subscription.cancel_at_period_end","typeLabel":"boolean"},"cancel_at":{"oneOf":[{"type":"number","description":"Unix timestamp the subscription is scheduled to cancel.","uniqueKey":"data.subscription.cancel_at.oneOf.0","typeLabel":"number"},{"type":"null","description":"Unix timestamp the subscription is scheduled to cancel.","uniqueKey":"data.subscription.cancel_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.cancel_at","typeLabel":"number | null"},"canceled_at":{"oneOf":[{"type":"number","description":"Unix timestamp the subscription was canceled.","uniqueKey":"data.subscription.canceled_at.oneOf.0","typeLabel":"number"},{"type":"null","description":"Unix timestamp the subscription was canceled.","uniqueKey":"data.subscription.canceled_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.canceled_at","typeLabel":"number | null"},"ended_at":{"oneOf":[{"type":"number","description":"Unix timestamp the subscription ended.","uniqueKey":"data.subscription.ended_at.oneOf.0","typeLabel":"number"},{"type":"null","description":"Unix timestamp the subscription ended.","uniqueKey":"data.subscription.ended_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.ended_at","typeLabel":"number | null"},"paused":{"type":"boolean","description":"Whether the subscription is currently paused.","uniqueKey":"data.subscription.paused","typeLabel":"boolean"},"resumes_at":{"oneOf":[{"type":"number","description":"Unix timestamp the subscription is scheduled to resume, or `null`.","uniqueKey":"data.subscription.resumes_at.oneOf.0","typeLabel":"number"},{"type":"null","description":"Unix timestamp the subscription is scheduled to resume, or `null`.","uniqueKey":"data.subscription.resumes_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.resumes_at","typeLabel":"number | null"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"data.subscription.metadata.additionalProperties","typeLabel":"string"},"description":"Free-form string key/value pairs attached to the subscription.","uniqueKey":"data.subscription.metadata","typeLabel":"object"},"start_date":{"type":"number","description":"Unix timestamp the subscription started.","uniqueKey":"data.subscription.start_date","typeLabel":"number"},"trial_start":{"oneOf":[{"type":"number","description":"Unix timestamp the trial started.","uniqueKey":"data.subscription.trial_start.oneOf.0","typeLabel":"number"},{"type":"null","description":"Unix timestamp the trial started.","uniqueKey":"data.subscription.trial_start.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.trial_start","typeLabel":"number | null"},"trial_end":{"oneOf":[{"type":"number","description":"Unix timestamp the trial ends/ended.","uniqueKey":"data.subscription.trial_end.oneOf.0","typeLabel":"number"},{"type":"null","description":"Unix timestamp the trial ends/ended.","uniqueKey":"data.subscription.trial_end.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.trial_end","typeLabel":"number | null"},"collection_method":{"type":"string","description":"`charge_automatically` or `send_invoice`.","uniqueKey":"data.subscription.collection_method","typeLabel":"string"},"created":{"oneOf":[{"type":"number","description":"Unix timestamp.","uniqueKey":"data.subscription.created.oneOf.0","typeLabel":"number"},{"type":"null","description":"Unix timestamp.","uniqueKey":"data.subscription.created.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.created","typeLabel":"number | null"},"last_invoice":{"oneOf":[{"type":"object","properties":{"provider_invoice_id":{"type":"string","description":"Provider invoice ID.","uniqueKey":"data.subscription.last_invoice.oneOf.0.provider_invoice_id","typeLabel":"string"},"created":{"oneOf":[{"type":"number","description":"Unix timestamp the invoice was created.","uniqueKey":"data.subscription.last_invoice.oneOf.0.created.oneOf.0","typeLabel":"number"},{"type":"null","description":"Unix timestamp the invoice was created.","uniqueKey":"data.subscription.last_invoice.oneOf.0.created.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.last_invoice.oneOf.0.created","typeLabel":"number | null"}},"description":"Last invoice reference or `null`.","uniqueKey":"data.subscription.last_invoice.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"provider_invoice_id":{"type":"string","description":"Provider invoice ID."},"created":{"oneOf":[{"type":"number","description":"Unix timestamp the invoice was created."},{"type":"null","description":"Unix timestamp the invoice was created."}]}},"description":"Last invoice reference or `null`.","uniqueKey":"data.subscription.last_invoice.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.last_invoice","typeLabel":"object | null"},"provider_payment_method_id":{"oneOf":[{"type":"string","description":"Payment-method id that paid the latest invoice. When no payment method paid it (for example during a trial, or when the invoice was settled from credit balance), the payment method the payment provider will charge next: the subscription's default, otherwise the billing customer's invoice default. `null` when none is set.","uniqueKey":"data.subscription.provider_payment_method_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Payment-method id that paid the latest invoice. When no payment method paid it (for example during a trial, or when the invoice was settled from credit balance), the payment method the payment provider will charge next: the subscription's default, otherwise the billing customer's invoice default. `null` when none is set.","uniqueKey":"data.subscription.provider_payment_method_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.provider_payment_method_id","typeLabel":"string | null"},"billing_cycle_anchor":{"type":"number","description":"Unix timestamp the subscription's billing cycles are anchored to.","uniqueKey":"data.subscription.billing_cycle_anchor","typeLabel":"number"}},"description":"The subscription.","uniqueKey":"data.subscription","typeLabel":"object"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"example":{"data":{"config_id":"test_config_id","provider_account_id":"test_account_id","payment_provider":"stripe","subscription":{"provider_customer_id":"test_customer_id","provider_subscription_id":"test_subscription_id","status":"active","description":null,"items":[{"provider_item_id":"test_subscription_item_id","quantity":2,"metadata":null,"price":null,"product":null,"current_period_end":1700,"current_period_start":1300,"created":1300,"discounts":[]}],"cancellation_details":null,"discounts":[],"cancel_at_period_end":false,"cancel_at":null,"canceled_at":null,"ended_at":null,"paused":false,"resumes_at":null,"metadata":{},"start_date":1300,"trial_start":null,"trial_end":null,"collection_method":"charge_automatically","created":1300,"last_invoice":{"provider_invoice_id":"test_invoice_id","created":1300},"provider_payment_method_id":"test_payment_method_id","billing_cycle_anchor":1300}}},"examples":{"Example":{"title":"Example","value":{"data":{"config_id":"test_config_id","provider_account_id":"test_account_id","payment_provider":"stripe","subscription":{"provider_customer_id":"test_customer_id","provider_subscription_id":"test_subscription_id","status":"active","description":null,"items":[{"provider_item_id":"test_subscription_item_id","quantity":2,"metadata":null,"price":null,"product":null,"current_period_end":1700,"current_period_start":1300,"created":1300,"discounts":[]}],"cancellation_details":null,"discounts":[],"cancel_at_period_end":false,"cancel_at":null,"canceled_at":null,"ended_at":null,"paused":false,"resumes_at":null,"metadata":{},"start_date":1300,"trial_start":null,"trial_end":null,"collection_method":"charge_automatically","created":1300,"last_invoice":{"provider_invoice_id":"test_invoice_id","created":1300},"provider_payment_method_id":"test_payment_method_id","billing_cycle_anchor":1300}}}}},"exampleType":"examples"}},"exampleType":"examples"},"3fc9743d-72e2-4cf0-a566-2aec10a036c4":{"description":"ValidationError: Missing/empty `provider_subscription_id`; no updatable field provided; a discount entry carrying two or more of `coupon`, `promotion_code` and `discount`, or none of them (**changed:** an entry sending `discount` alongside `coupon` or `promotion_code` used to be accepted with `discount` ignored, and is now rejected); a `discounts` value, top-level or on an item, that is not an array or has an entry that is not an object; an items entry with neither an item id nor a price id; invalid `quantity`/`deleted`; an `items` change that would leave more than one item on the subscription (`A subscription can have only one recurring price. Create a separate subscription for each recurring product.`, checked before anything is changed); `proration_behavior` sent with any value other than `\"none\"` (`proration_behavior must be 'none' or omitted: updates are never prorated`); `metadata` not an object, or any `metadata` value not a string; `trial_end` not an integer, or not in the future; `cancel_at` not `\"period_end\"`, `null` or an integer, or not in the future, or after the current billing period ends (`cancel_at must not be after the current billing period ends; use 'period_end' to cancel at the end of the period`), or sent as a timestamp to a subscription with no upcoming renewal, or as a timestamp together with `trial_end`; a `cancel_at` timestamp on a canceled or expired subscription (`Cannot change the cancel schedule of a terminal subscription`); an `items` change that moves a paused subscription to a different billing interval (`Resume the subscription before changing its billing interval`). An empty `metadata: {}` does not count as an updatable field, so on its own it yields “no updatable field provided”; the same holds for `proration_behavior: \"none\"` on its own. ProviderError: the payment provider rejected the request, including its refusal of the billing-period lookup used to check a `cancel_at` timestamp.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"e69efe70-fe60-4a61-8546-1492282eab02":{"description":"Missing or invalid bearer token.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"627781ec-14a0-442f-a2c1-bb1ce771cedc":{"description":"No configuration exists for your account, or provider access has been disabled for it.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"2e0284f3-685e-483f-a7a4-fd26cec67459":{"description":"NotFoundError: Subscription not found (the payment provider `resource_missing` or 404), or config not found. Also an `items` entry whose `provider_price_id` the payment provider does not have (`items price not found: \u003cid>`).","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"9ee849b7-aca5-4141-855f-13f8225e4092":{"description":"An upstream payment-provider error with no client-error status. The payment provider's own rejections keep its status instead: a `400`, or a `404` when the provider reports something missing (see the `404` response).","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"0bf5362e-cd1e-48a0-b768-36d165f4273f":{"serviceToken":{"type":"oauth2","description":"Service (M2M) access token issued by POST /auth/token using the client_credentials grant. Required scopes, where known, are listed on each operation below.","flows":{"clientCredentials":{"tokenUrl":"https://api.openloophealth.com/v0.1/auth/token","scopes":{}}},"scopes":[],"schemeName":"serviceToken"}},"f54a8c99-0f6a-44ab-9cfb-a01b465d8cb7":{"userToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User access token issued by POST /auth/token via the verification-code grant (after Verify a one-time code) or the refresh_token grant.","scopes":[],"schemeName":"userToken"}}},"servers":{"ade1cd8e-addd-48fa-84f1-0977ca5c5238":{"url":"https://api.openloophealth.com/v0.2","description":"Production partner edge"},"351ca2c1-07e2-456d-902c-64b8ca779332":{"url":"https://api-staging.openloophealth.com/v0.2","description":"Staging partner edge (sandbox credentials)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"oauth2","description":"Service (M2M) access token issued by POST /auth/token using the client_credentials grant. Required scopes, where known, are listed on each operation below.","flows":{"clientCredentials":{"tokenUrl":"https://api.openloophealth.com/v0.1/auth/token","scopes":{}}},"scopes":[],"schemeName":"serviceToken"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"Service (M2M) access token issued by POST /auth/token using the client_credentials grant. Required scopes, where known, are listed on each operation below.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"serviceToken","name":"Authorization"}],"title":"serviceToken"},{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User access token issued by POST /auth/token via the verification-code grant (after Verify a one-time code) or the refresh_token grant.","scopes":[],"schemeName":"userToken"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"User access token issued by POST /auth/token via the verification-code grant (after Verify a one-time code) or the refresh_token grant.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"userToken","name":"Authorization"}],"title":"userToken"}]},"originalFileLocation":"openapi.json"},"subdomain":"openloop","siteName":"Partners API Documentation","title":"Update Subscription - Partners API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-19T16:50:11.171Z","originalFileLocation":"api-reference/subscriptions/update-subscription.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Partially updates an existing subscription. Immediate cancels, pauses and resumes are not accepted on this endpoint — use DELETE /subscriptions/{provider_subscription_id} (cancel), POST /subscriptions/{provider_subscription_id}/pauses (pause), or DELETE /subscriptions/{provider_subscription_id}/pauses (resume) instead. To move or remove a cancel that is already scheduled, send cancel_at. Returns the updated subscription in the same shape as GET /subscriptions/{provider_subscription_id}. Updates are never prorated: an item or price change creates no credit for unused time and no prorated charge. Within the same billing interval, the new price applies from the next renewal. When an item change moves the subscription to a different billing interval, longer or shorter (for example monthly to every 3 months, or back), a new period starts at the change and the new price is charged in full immediately, with no credit for time already paid. Discounts already on the subscription apply to that charge, and a once discount sent in the same request lands on it. A trialing subscription, or a request that sets trial_end, starts no new period, so the change does not end the trial. An interval change on a paused subscription is a 400; resume it first. After a change, a subscription can hold at most one item, because every subscription item is a recurring price. Create a separate subscription for each recurring product. /v0.1 of this operation is deprecated and stops working on 2027-01-17.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Partners API Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/openloop/LIC2QTmC6gcwcygU/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/openloop/LIC2QTmC6gcwcygU/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/openloop/LIC2QTmC6gcwcygU/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/openloop/LIC2QTmC6gcwcygU/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/openloop/LIC2QTmC6gcwcygU/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/openloop/LIC2QTmC6gcwcygU/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/openloop/LIC2QTmC6gcwcygU/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/openloop/LIC2QTmC6gcwcygU/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/openloop/LIC2QTmC6gcwcygU/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update Subscription - Partners API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Partially updates an existing subscription. Immediate cancels, pauses and resumes are not accepted on this endpoint — use DELETE /subscriptions/{provider_subscription_id} (cancel), POST /subscriptions/{provider_subscription_id}/pauses (pause), or DELETE /subscriptions/{provider_subscription_id}/pauses (resume) instead. To move or remove a cancel that is already scheduled, send cancel_at. Returns the updated subscription in the same shape as GET /subscriptions/{provider_subscription_id}. Updates are never prorated: an item or price change creates no credit for unused time and no prorated charge. Within the same billing interval, the new price applies from the next renewal. When an item change moves the subscription to a different billing interval, longer or shorter (for example monthly to every 3 months, or back), a new period starts at the change and the new price is charged in full immediately, with no credit for time already paid. Discounts already on the subscription apply to that charge, and a once discount sent in the same request lands on it. A trialing subscription, or a request that sets trial_end, starts no new period, so the change does not end the trial. An interval change on a paused subscription is a 400; resume it first. After a change, a subscription can hold at most one item, because every subscription item is a recurring price. Create a separate subscription for each recurring product. /v0.1 of this operation is deprecated and stops working on 2027-01-17.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Partners API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://openloop.mintlify.app/api-reference/subscriptions/update-subscription\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://openloop.mintlify.site/_mintlify/api/og/v2?division=Subscriptions\u0026amp;title=Update+Subscription\u0026amp;description=Partially+updates+an+existing+subscription.+Immediate+cancels%2C+pauses+and+resumes+are+not+accepted+on+this+endpoint+%E2%80%94+use+%5B%60DELETE+%2Fsubscriptions%2F%7Bprovider_subs\u0026amp;theme=c3eb8a84b98e9b697f555ff9\u0026amp;signature=85dc401b70a72739e7395f51f0161ffffbf0929229fbd21f642d07f6ef151b0b\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update Subscription - Partners API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Partially updates an existing subscription. Immediate cancels, pauses and resumes are not accepted on this endpoint — use DELETE /subscriptions/{provider_subscription_id} (cancel), POST /subscriptions/{provider_subscription_id}/pauses (pause), or DELETE /subscriptions/{provider_subscription_id}/pauses (resume) instead. To move or remove a cancel that is already scheduled, send cancel_at. Returns the updated subscription in the same shape as GET /subscriptions/{provider_subscription_id}. Updates are never prorated: an item or price change creates no credit for unused time and no prorated charge. Within the same billing interval, the new price applies from the next renewal. When an item change moves the subscription to a different billing interval, longer or shorter (for example monthly to every 3 months, or back), a new period starts at the change and the new price is charged in full immediately, with no credit for time already paid. Discounts already on the subscription apply to that charge, and a once discount sent in the same request lands on it. A trialing subscription, or a request that sets trial_end, starts no new period, so the change does not end the trial. An interval change on a paused subscription is a 400; resume it first. After a change, a subscription can hold at most one item, because every subscription item is a recurring price. Create a separate subscription for each recurring product. /v0.1 of this operation is deprecated and stops working on 2027-01-17.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://openloop.mintlify.site/_mintlify/api/og/v2?division=Subscriptions\u0026amp;title=Update+Subscription\u0026amp;description=Partially+updates+an+existing+subscription.+Immediate+cancels%2C+pauses+and+resumes+are+not+accepted+on+this+endpoint+%E2%80%94+use+%5B%60DELETE+%2Fsubscriptions%2F%7Bprovider_subs\u0026amp;theme=c3eb8a84b98e9b697f555ff9\u0026amp;signature=85dc401b70a72739e7395f51f0161ffffbf0929229fbd21f642d07f6ef151b0b\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/openloop/LIC2QTmC6gcwcygU/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Partners API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#e34376\">\u003clink data-mint-head rel=\"canonical\" href=\"https://openloop.mintlify.app/api-reference/subscriptions/update-subscription\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/subscriptions/update-subscription.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://openloop.mintlify.app/#organization\",\"name\":\"Partners API Documentation\",\"url\":\"https://openloop.mintlify.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/openloop/uFqnU7STc2L-iY-j/logo/openloop_light.png?fit=max\u0026auto=format\u0026n=uFqnU7STc2L-iY-j\u0026q=85\u0026s=36c08284ca501fdefe4311339c563474\"}},{\"@type\":\"WebSite\",\"@id\":\"https://openloop.mintlify.app#website\",\"name\":\"Partners API Documentation\",\"url\":\"https://openloop.mintlify.app\",\"publisher\":{\"@id\":\"https://openloop.mintlify.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://openloop.mintlify.app/api-reference/subscriptions/update-subscription#webpage\",\"url\":\"https://openloop.mintlify.app/api-reference/subscriptions/update-subscription\",\"name\":\"Update Subscription\",\"description\":\"Partially updates an existing subscription. Immediate cancels, pauses and resumes are not accepted on this endpoint — use DELETE /subscriptions/{provider_subscription_id} (cancel), POST /subscriptions/{provider_subscription_id}/pauses (pause), or DELETE /subscriptions/{provider_subscription_id}/pauses (resume) instead. To move or remove a cancel that is already scheduled, send cancel_at. Returns the updated subscription in the same shape as GET /subscriptions/{provider_subscription_id}. Updates are never prorated: an item or price change creates no credit for unused time and no prorated charge. Within the same billing interval, the new price applies from the next renewal. When an item change moves the subscription to a different billing interval, longer or shorter (for example monthly to every 3 months, or back), a new period starts at the change and the new price is charged in full immediately, with no credit for time already paid. Discounts already on the subscription apply to that charge, and a once discount sent in the same request lands on it. A trialing subscription, or a request that sets trial_end, starts no new period, so the change does not end the trial. An interval change on a paused subscription is a 400; resume it first. After a change, a subscription can hold at most one item, because every subscription item is a recurring price. Create a separate subscription for each recurring product. /v0.1 of this operation is deprecated and stops working on 2027-01-17.\",\"dateModified\":\"2026-11-19T16:50:11.171Z\",\"isPartOf\":{\"@id\":\"https://openloop.mintlify.app#website\"},\"breadcrumb\":{\"@id\":\"https://openloop.mintlify.app/api-reference/subscriptions/update-subscription#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://openloop.mintlify.app/api-reference/subscriptions/update-subscription#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Subscriptions\",\"item\":\"https://openloop.mintlify.app/api-reference/subscriptions/get-subscriptions\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update Subscription\",\"item\":\"https://openloop.mintlify.app/api-reference/subscriptions/update-subscription\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://openloop.mintlify.app/api-reference/subscriptions/update-subscription#apireference\",\"headline\":\"Update Subscription\",\"name\":\"Update Subscription\",\"description\":\"Partially updates an existing subscription. Immediate cancels, pauses and resumes are not accepted on this endpoint — use DELETE /subscriptions/{provider_subscription_id} (cancel), POST /subscriptions/{provider_subscription_id}/pauses (pause), or DELETE /subscriptions/{provider_subscription_id}/pauses (resume) instead. To move or remove a cancel that is already scheduled, send cancel_at. Returns the updated subscription in the same shape as GET /subscriptions/{provider_subscription_id}. Updates are never prorated: an item or price change creates no credit for unused time and no prorated charge. Within the same billing interval, the new price applies from the next renewal. When an item change moves the subscription to a different billing interval, longer or shorter (for example monthly to every 3 months, or back), a new period starts at the change and the new price is charged in full immediately, with no credit for time already paid. Discounts already on the subscription apply to that charge, and a once discount sent in the same request lands on it. A trialing subscription, or a request that sets trial_end, starts no new period, so the change does not end the trial. An interval change on a paused subscription is a 400; resume it first. After a change, a subscription can hold at most one item, because every subscription item is a recurring price. Create a separate subscription for each recurring product. /v0.1 of this operation is deprecated and stops working on 2027-01-17.\",\"url\":\"https://openloop.mintlify.app/api-reference/subscriptions/update-subscription\",\"mainEntityOfPage\":{\"@id\":\"https://openloop.mintlify.app/api-reference/subscriptions/update-subscription#webpage\"},\"dateModified\":\"2026-11-19T16:50:11.171Z\",\"publisher\":{\"@id\":\"https://openloop.mintlify.app/#organization\"},\"isPartOf\":{\"@id\":\"https://openloop.mintlify.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Partners API Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Partners API Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/subscriptions/update-subscription.md","siteName":"Partners API Documentation","nav":{"global":{"anchors":[{"anchor":"OpenLoop Health","icon":"globe","href":"https://openloophealth.com"}]},"tabs":[{"tab":"Getting Started","pages":[{"title":"Getting Started","href":""}]},{"tab":"Partner Cookbook","pages":[{"title":"Partner Cookbook","href":"/cookbook"}]},{"tab":"API Reference","groups":[{"group":"Guides","pages":[{"title":"API Overview","href":"/api-reference/introduction"},{"title":"Data Standards","mode":"wide","href":"/api-reference/data-standards"},{"title":"Best Practices","href":"/best-practices"},{"title":"Product \u0026 Price IDs","href":"/api-reference/product-and-price-ids"},{"title":"Scheduling","href":"/api-reference/scheduling-guide"},{"title":"Eligibility","href":"/api-reference/eligibility-guide"},{"title":"User Registration","href":"/api-reference/user-registration-guide"},{"title":"How orders are created","href":"/orders/order-model"}]},{"group":"Events","pages":[{"title":"Events","href":"/events"}]},{"group":"Auth","pages":[{"title":"Obtain a service token","openapi":"POST /auth/token","href":"/auth/obtain-token"},{"title":"Register a user","openapi":"post /auth/register","href":"/auth/register"},{"title":"Send a one-time code","openapi":"post /auth/send-otp","href":"/auth/send-otp"},{"title":"Verify a one-time code","openapi":"post /auth/verify-otp","href":"/auth/verify-otp"},{"title":"Exchange a verification code","openapi":"POST /auth/token","href":"/auth/exchange-verification-code"},{"title":"Refresh a token","openapi":"POST /auth/token","href":"/auth/refresh-token"},{"title":"Revoke a session","openapi":"post /auth/revoke","href":"/auth/revoke"}]},{"group":"Users","pages":[{"openapi":"get /iam/users/find","title":"Find a user by email","href":"/users/find-user"},{"title":"Read a user's patient link","openapi":"get /iam/users/links","href":"/users/get-user-link"},{"title":"Delete the current user","openapi":"delete /iam/users/me","href":"/users/delete-user"}]},{"group":"Allergy Intolerances","pages":[{"title":"List allergy intolerances","deprecated":null,"version":null,"openapi":"/openapi.json get /allergy-intolerances","href":"/api-reference/allergy-intolerances/list-allergy-intolerances"},{"title":"Create allergy intolerance","deprecated":null,"version":null,"openapi":"/openapi.json post /allergy-intolerances","href":"/api-reference/allergy-intolerances/create-allergy-intolerance"},{"title":"Get allergy intolerance","deprecated":null,"version":null,"openapi":"/openapi.json get /allergy-intolerances/{id}","href":"/api-reference/allergy-intolerances/get-allergy-intolerance"},{"title":"Update allergy intolerance","deprecated":null,"version":null,"openapi":"/openapi.json put /allergy-intolerances/{id}","href":"/api-reference/allergy-intolerances/update-allergy-intolerance"}]},{"group":"Consents","pages":[{"title":"List consents","deprecated":null,"version":null,"openapi":"/openapi.json get /consents","href":"/api-reference/consents/list-consents"},{"title":"Create consent","deprecated":null,"version":null,"openapi":"/openapi.json post /consents","href":"/api-reference/consents/create-consent"},{"title":"Get consent","deprecated":null,"version":null,"openapi":"/openapi.json get /consents/{id}","href":"/api-reference/consents/get-consent"},{"title":"Update consent","deprecated":null,"version":null,"openapi":"/openapi.json put /consents/{id}","href":"/api-reference/consents/update-consent"}]},{"group":"Document References","pages":[{"title":"List document references","deprecated":null,"version":null,"openapi":"/openapi.json get /document-references","href":"/api-reference/document-references/list-document-references"},{"title":"Create document reference","deprecated":null,"version":null,"openapi":"/openapi.json post /document-references","href":"/api-reference/document-references/create-document-reference"},{"title":"Upload document content","deprecated":null,"version":null,"openapi":"/openapi.json post /document-references/content","href":"/api-reference/document-references/upload-document-content"},{"title":"Get document reference","deprecated":null,"version":null,"openapi":"/openapi.json get /document-references/{id}","href":"/api-reference/document-references/get-document-reference"},{"title":"Update document reference","deprecated":null,"version":null,"openapi":"/openapi.json put /document-references/{id}","href":"/api-reference/document-references/update-document-reference"},{"title":"Get document reference content","deprecated":null,"version":null,"openapi":"/openapi.json get /document-references/{id}/content","href":"/api-reference/document-references/get-document-reference-content"}]},{"group":"Laboratories","pages":[{"title":"Create lab requisition","deprecated":null,"version":null,"openapi":"/openapi.json post /laboratories","href":"/api-reference/laboratories/create-lab-requisition"}]},{"group":"Medication Statements","pages":[{"title":"List medication statements","deprecated":null,"version":null,"openapi":"/openapi.json get /medication-statements","href":"/api-reference/medication-statements/list-medication-statements"},{"title":"Create medication statement","deprecated":null,"version":null,"openapi":"/openapi.json post /medication-statements","href":"/api-reference/medication-statements/create-medication-statement"},{"title":"Get medication statement","deprecated":null,"version":null,"openapi":"/openapi.json get /medication-statements/{id}","href":"/api-reference/medication-statements/get-medication-statement"}]},{"group":"Observations","pages":[{"title":"List observations","deprecated":null,"version":null,"openapi":"/openapi.json get /observations","href":"/api-reference/observations/list-observations"},{"title":"Create observation","deprecated":null,"version":null,"openapi":"/openapi.json post /observations","href":"/api-reference/observations/create-observation"},{"title":"Get observation","deprecated":null,"version":null,"openapi":"/openapi.json get /observations/{id}","href":"/api-reference/observations/get-observation"}]},{"group":"Organizations","pages":[{"title":"Get organization","deprecated":null,"version":null,"openapi":"/openapi.json get /organizations/{id}","href":"/api-reference/organizations/get-organization"}]},{"group":"Patients","pages":[{"title":"List patients","deprecated":null,"version":null,"openapi":"/openapi.json get /patients","href":"/api-reference/patients/list-patients"},{"title":"Create patient","deprecated":null,"version":null,"openapi":"/openapi.json post /patients","href":"/api-reference/patients/create-patient"},{"title":"Get patient","deprecated":null,"version":null,"openapi":"/openapi.json get /patients/{id}","href":"/api-reference/patients/get-patient"},{"title":"Update patient","deprecated":null,"version":null,"openapi":"/openapi.json put /patients/{id}","href":"/api-reference/patients/update-patient"}]},{"group":"Users","pages":[{"title":"Delete your account","deprecated":null,"version":null,"openapi":"/openapi.json delete /iam/users/me","href":"/api-reference/users/delete-your-account"},{"title":"Get a user's linked record","deprecated":null,"version":null,"openapi":"/openapi.json get /iam/users/links","href":"/api-reference/users/get-a-users-linked-record"},{"title":"Find a user by email","deprecated":null,"version":null,"openapi":"/openapi.json get /iam/users/find","href":"/api-reference/users/find-a-user-by-email"}]},{"group":"Questionnaire Responses","pages":[{"title":"List questionnaire responses","deprecated":null,"version":null,"openapi":"/openapi.json get /questionnaire-responses","href":"/api-reference/questionnaire-responses/list-questionnaire-responses"},{"title":"Create questionnaire response","deprecated":null,"version":null,"openapi":"/openapi.json post /questionnaire-responses","href":"/api-reference/questionnaire-responses/create-questionnaire-response"},{"title":"Get questionnaire response","deprecated":null,"version":null,"openapi":"/openapi.json get /questionnaire-responses/{id}","href":"/api-reference/questionnaire-responses/get-questionnaire-response"},{"title":"Update questionnaire response","deprecated":null,"version":null,"openapi":"/openapi.json put /questionnaire-responses/{id}","href":"/api-reference/questionnaire-responses/update-questionnaire-response"}]},{"group":"Questionnaires","pages":[{"title":"List questionnaires","deprecated":null,"version":null,"openapi":"/openapi.json get /questionnaires","href":"/api-reference/questionnaires/list-questionnaires"},{"title":"Get questionnaire","deprecated":null,"version":null,"openapi":"/openapi.json get /questionnaires/{id}","href":"/api-reference/questionnaires/get-questionnaire"}]},{"group":"Related Persons","pages":[{"title":"List related persons","deprecated":null,"version":null,"openapi":"/openapi.json get /related-persons","href":"/api-reference/related-persons/list-related-persons"},{"title":"Create related person","deprecated":null,"version":null,"openapi":"/openapi.json post /related-persons","href":"/api-reference/related-persons/create-related-person"},{"title":"Get related person","deprecated":null,"version":null,"openapi":"/openapi.json get /related-persons/{id}","href":"/api-reference/related-persons/get-related-person"},{"title":"Update related person","deprecated":null,"version":null,"openapi":"/openapi.json put /related-persons/{id}","href":"/api-reference/related-persons/update-related-person"}]},{"group":"Sites","pages":[{"title":"List sites","deprecated":null,"version":null,"openapi":"/openapi.json get /sites","href":"/api-reference/sites/list-sites"},{"title":"Create site","deprecated":null,"version":null,"openapi":"/openapi.json post /sites","href":"/api-reference/sites/create-site"},{"title":"Get site","deprecated":null,"version":null,"openapi":"/openapi.json get /sites/{key}","href":"/api-reference/sites/get-site"},{"title":"Delete site","deprecated":null,"version":null,"openapi":"/openapi.json delete /sites/{key}","href":"/api-reference/sites/delete-site"},{"title":"Update site","deprecated":null,"version":null,"openapi":"/openapi.json patch /sites/{key}","href":"/api-reference/sites/update-site"}]},{"group":"Tasks","pages":[{"title":"List tasks","deprecated":null,"version":null,"openapi":"/openapi.json get /tasks","href":"/api-reference/tasks/list-tasks"},{"title":"Create task","deprecated":null,"version":null,"openapi":"/openapi.json post /tasks","href":"/api-reference/tasks/create-task"},{"title":"Get task","deprecated":null,"version":null,"openapi":"/openapi.json get /tasks/{id}","href":"/api-reference/tasks/get-task"},{"title":"Update task","deprecated":null,"version":null,"openapi":"/openapi.json put /tasks/{id}","href":"/api-reference/tasks/update-task"},{"title":"Delete task","deprecated":null,"version":null,"openapi":"/openapi.json delete /tasks/{id}","href":"/api-reference/tasks/delete-task"}]},{"group":"Scheduling","pages":[{"title":"List bookable appointment types","deprecated":null,"version":null,"openapi":"/openapi.json get /appointment-types","href":"/api-reference/scheduling/list-bookable-appointment-types"},{"title":"Retrieve an appointment type","deprecated":null,"version":null,"openapi":"/openapi.json get /appointment-types/{id}","href":"/api-reference/scheduling/retrieve-an-appointment-type"},{"title":"Search available slots","deprecated":null,"version":null,"openapi":"/openapi.json get /slots","href":"/api-reference/scheduling/search-available-slots"},{"title":"Reserve a slot","deprecated":null,"version":null,"openapi":"/openapi.json post /reservations","href":"/api-reference/scheduling/reserve-a-slot"},{"title":"Release a slot reservation","deprecated":null,"version":null,"openapi":"/openapi.json delete /reservations/{id}","href":"/api-reference/scheduling/release-a-slot-reservation"},{"title":"List appointments","deprecated":null,"version":null,"openapi":"/openapi.json get /appointments","href":"/api-reference/scheduling/list-appointments"},{"title":"Book an appointment","deprecated":null,"version":null,"openapi":"/openapi.json post /appointments","href":"/api-reference/scheduling/book-an-appointment"},{"title":"Retrieve an appointment","deprecated":null,"version":null,"openapi":"/openapi.json get /appointments/{id}","href":"/api-reference/scheduling/retrieve-an-appointment"},{"title":"Update an appointment","deprecated":null,"version":null,"openapi":"/openapi.json patch /appointments/{id}","href":"/api-reference/scheduling/update-an-appointment"}]},{"group":"Prices","pages":[{"title":"Get Price","deprecated":null,"version":null,"openapi":"/openapi.json get /prices/{price_id}","href":"/api-reference/prices/get-price"}]},{"group":"Products","pages":[{"title":"List Products","deprecated":null,"version":null,"openapi":"/openapi.json get /products","href":"/api-reference/products/list-products"},{"title":"Get Product By Id","deprecated":null,"version":null,"openapi":"/openapi.json get /products/{product_id}","href":"/api-reference/products/get-product-by-id"},{"title":"List Product Prices","deprecated":null,"version":null,"openapi":"/openapi.json get /products/{product_id}/prices","href":"/api-reference/products/list-product-prices"}]},{"group":"Checkout","pages":[{"title":"Create Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json post /checkouts/sessions","href":"/api-reference/checkout/create-checkout-session"}]},{"group":"Coupons","pages":[{"title":"List Coupons","deprecated":null,"version":null,"openapi":"/openapi.json get /coupons","href":"/api-reference/coupons/list-coupons"},{"title":"Create Coupons","deprecated":null,"version":null,"openapi":"/openapi.json post /coupons","href":"/api-reference/coupons/create-coupons"},{"title":"Get Coupon","deprecated":null,"version":null,"openapi":"/openapi.json get /coupons/{provider_coupon_id}","href":"/api-reference/coupons/get-coupon"},{"title":"Delete Coupon","deprecated":null,"version":null,"openapi":"/openapi.json delete /coupons/{provider_coupon_id}","href":"/api-reference/coupons/delete-coupon"}]},{"group":"Intents","pages":[{"title":"Get Payment Intent","deprecated":null,"version":null,"openapi":"/openapi.json get /intents/payments/{provider_payment_intent_id}","href":"/api-reference/intents/get-payment-intent"},{"title":"Get Setup Intent","deprecated":null,"version":null,"openapi":"/openapi.json get /intents/setups/{provider_setup_intent_id}","href":"/api-reference/intents/get-setup-intent"},{"title":"Create Setup Intent","deprecated":null,"version":null,"openapi":"/openapi.json post /intents/setups","href":"/api-reference/intents/create-setup-intent"}]},{"group":"Invoices","pages":[{"title":"Get Invoices","deprecated":null,"version":null,"openapi":"/openapi.json get /invoices","href":"/api-reference/invoices/get-invoices"},{"title":"Create Invoice Preview","deprecated":null,"version":null,"openapi":"/openapi.json post /invoices/previews","href":"/api-reference/invoices/create-invoice-preview"},{"title":"Pay Invoice","deprecated":null,"version":null,"openapi":"/openapi.json post /invoices/{provider_invoice_id}/payments","href":"/api-reference/invoices/pay-invoice"},{"title":"Create Refund","deprecated":null,"version":null,"openapi":"/openapi.json post /invoices/{provider_invoice_id}/refunds","href":"/api-reference/invoices/create-refund"}]},{"group":"Payment Methods","pages":[{"title":"Get Payment Methods","deprecated":null,"version":null,"openapi":"/openapi.json get /payment-methods","href":"/api-reference/payment-methods/get-payment-methods"}]},{"group":"Promotion Codes","pages":[{"title":"List Promotion Codes","deprecated":null,"version":null,"openapi":"/openapi.json get /promotion-codes","href":"/api-reference/promotion-codes/list-promotion-codes"},{"title":"Create Promotion Code","deprecated":null,"version":null,"openapi":"/openapi.json post /promotion-codes","href":"/api-reference/promotion-codes/create-promotion-code"},{"title":"Deactivate Promotion Code","deprecated":null,"version":null,"openapi":"/openapi.json delete /promotion-codes/{provider_promotion_code_id}","href":"/api-reference/promotion-codes/deactivate-promotion-code"}]},{"group":"Subscriptions","pages":[{"title":"Get Subscriptions","deprecated":null,"version":null,"openapi":"/openapi.json get /subscriptions","href":"/api-reference/subscriptions/get-subscriptions"},{"title":"Create Subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /subscriptions","href":"/api-reference/subscriptions/create-subscription"},{"title":"Get Subscription","description":"Retrieves a single subscription by `provider_subscription_id` within your configuration, in the same shape as each item returned by `GET /subscriptions`.","deprecated":null,"version":null,"openapi":"/openapi.json get /subscriptions/{provider_subscription_id}","href":"/api-reference/subscriptions/get-subscription"},{"title":"Update Subscription","deprecated":null,"version":null,"openapi":"/openapi.json put /subscriptions/{provider_subscription_id}","href":"/api-reference/subscriptions/update-subscription"},{"title":"Cancel Subscription","description":"Cancels a subscription. Supports three cancellation timing modes selected by the request body's `cancel_at` field: immediate (`\"now\"`), at the end of the current billing period (`\"period_end\"`), or at a specific future timestamp (`\u003cunix-seconds>`). The body is optional: without one, or without `cancel_at`, the subscription cancels at the end of the current billing period. Returns the resulting subscription in the same shape as [`GET /subscriptions/{provider_subscription_id}`](./get-subscription.md).\n\nCancellations are never prorated: no credit for unused time is created, whichever `cancel_at` you send.\n\n`/v0.1` of this operation is deprecated and stops working on 2027-01-17.","deprecated":null,"version":null,"openapi":"/openapi.json delete /subscriptions/{provider_subscription_id}","href":"/api-reference/subscriptions/cancel-subscription"},{"title":"List Subscription Invoices","deprecated":null,"version":null,"openapi":"/openapi.json get /subscriptions/{provider_subscription_id}/invoices","href":"/api-reference/subscriptions/list-subscription-invoices"},{"title":"Pause Subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /subscriptions/{provider_subscription_id}/pauses","href":"/api-reference/subscriptions/pause-subscription"},{"title":"Resume Subscription","deprecated":null,"version":null,"openapi":"/openapi.json delete /subscriptions/{provider_subscription_id}/pauses","href":"/api-reference/subscriptions/resume-subscription"}]},{"group":"Configs","pages":[{"title":"Get Config","deprecated":null,"version":null,"openapi":"/openapi.json get /configs","href":"/api-reference/configs/get-config"}]},{"group":"Billing Portals","pages":[{"title":"List Billing Portals","deprecated":null,"version":null,"openapi":"/openapi.json get /billing-portals","href":"/api-reference/billing-portals/list-billing-portals"},{"title":"Create Retention Portal Session","deprecated":null,"version":null,"openapi":"/openapi.json post /billing-portals/retention-sessions","href":"/api-reference/billing-portals/create-retention-portal-session"},{"title":"Create Portal Session","deprecated":null,"version":null,"openapi":"/openapi.json post /billing-portals/{provider_billing_portal_id}/sessions","href":"/api-reference/billing-portals/create-portal-session"}]},{"group":"Auth","pages":[]},{"group":"Billing Customers","pages":[{"title":"Get Customers","deprecated":null,"version":null,"openapi":"/openapi.json get /billing-customers","href":"/api-reference/billing-customers/get-customers"},{"title":"Create Customer","deprecated":null,"version":null,"openapi":"/openapi.json post /billing-customers","href":"/api-reference/billing-customers/create-customer"},{"title":"Get Customer","deprecated":null,"version":null,"openapi":"/openapi.json get /billing-customers/{provider_customer_id}","href":"/api-reference/billing-customers/get-customer"},{"title":"Update Customer","deprecated":null,"version":null,"openapi":"/openapi.json put /billing-customers/{provider_customer_id}","href":"/api-reference/billing-customers/update-customer"},{"title":"List Billing Customer Subscriptions","deprecated":null,"version":null,"openapi":"/openapi.json get /billing-customers/{provider_customer_id}/subscriptions","href":"/api-reference/billing-customers/list-billing-customer-subscriptions"},{"title":"List Balance Transactions","deprecated":null,"version":null,"openapi":"/openapi.json get /billing-customers/{provider_customer_id}/balance-transactions","href":"/api-reference/billing-customers/list-balance-transactions"},{"title":"Create Balance Transaction","deprecated":null,"version":null,"openapi":"/openapi.json post /billing-customers/{provider_customer_id}/balance-transactions","href":"/api-reference/billing-customers/create-balance-transaction"}]},{"group":"Eligibility","pages":[{"title":"Submit an eligibility verification","deprecated":null,"version":null,"openapi":"/openapi.json post /eligibility-verifications","href":"/api-reference/eligibility/submit-an-eligibility-verification"},{"title":"Retrieve an eligibility verification","deprecated":null,"version":null,"openapi":"/openapi.json get /eligibility-verifications/{id}","href":"/api-reference/eligibility/retrieve-an-eligibility-verification"},{"title":"Submit an insurance discovery","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance-discoveries","href":"/api-reference/eligibility/submit-an-insurance-discovery"},{"title":"Retrieve an insurance discovery","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance-discoveries/{id}","href":"/api-reference/eligibility/retrieve-an-insurance-discovery"},{"title":"Coordinate benefits across payers","deprecated":null,"version":null,"openapi":"/openapi.json post /benefit-coordinations","href":"/api-reference/eligibility/coordinate-benefits-across-payers"},{"title":"Resolve a Medicare Beneficiary Identifier","deprecated":null,"version":null,"openapi":"/openapi.json post /medicare-id-lookups","href":"/api-reference/eligibility/resolve-a-medicare-beneficiary-identifier"},{"title":"Check network status for a payer in a state","deprecated":null,"version":null,"openapi":"/openapi.json post /network-status","href":"/api-reference/eligibility/check-network-status-for-a-payer-in-a-state"}]},{"group":"Payer Directory","pages":[{"title":"List or search payers","deprecated":null,"version":null,"openapi":"/openapi.json get /payers","href":"/api-reference/payer-directory/list-or-search-payers"},{"title":"Retrieve a payer","deprecated":null,"version":null,"openapi":"/openapi.json get /payers/{payer_id}","href":"/api-reference/payer-directory/retrieve-a-payer"}]},{"group":"Patient Passport","pages":[{"title":"Get a patient's Passport profile","deprecated":null,"version":null,"openapi":"/openapi.json get /passport/profile","href":"/api-reference/patient-passport/get-a-patients-passport-profile"},{"title":"List a patient's Passport appointments","deprecated":null,"version":null,"openapi":"/openapi.json get /passport/appointments","href":"/api-reference/patient-passport/list-a-patients-passport-appointments"},{"title":"List a patient's Passport orders","deprecated":null,"version":null,"openapi":"/openapi.json get /passport/orders","href":"/api-reference/patient-passport/list-a-patients-passport-orders"},{"title":"List a patient's Passport subscriptions","deprecated":null,"version":null,"openapi":"/openapi.json get /passport/subscriptions","href":"/api-reference/patient-passport/list-a-patients-passport-subscriptions"},{"title":"Get a patient's Passport journey","deprecated":null,"version":null,"openapi":"/openapi.json get /passport/journey","href":"/api-reference/patient-passport/get-a-patients-passport-journey"}]}]}]},"basePath":"","title":"Update Subscription - Partners API Documentation","deploymentId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","buildId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B6WFFOBL.js","utils-BN5um1KA.js","cloneDeep-C3md22mN.js","_Uint8Array-DLlL8L26.js","isObject-FP1Yky1u.js","utils-BSmbkXJR.js","addUniqueKeysToSchema-2tqcVnUE.js","snippetPresets-CtWfvr2J.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DkKHBy30.js","isEqual-O3q7y6pq.js","usePlaygroundInputsStore-Brc5H9UJ.js","shallow-C4L4xvbs.js","getApiPlaygroundDisplay-2bxyq_aI.js","CodeSnippet-BJu8ddd5.js","CodeSnippets-dazWmoqB.js","Page-CnLhKuUV.js","getPastedJson-Chy3Qa1S.js","icon-CyO7h3jh.js","MethodPill-Dle0_91v.js","DuplicateIcon-CVvWAf4a.js","createIcon-Di07A27B.js","DynamicMarkdown-C4w9kavL.js","SectionHeading-XiBebVYC.js","axios-vUo_bRtp.js","Markdown-DTeL0SpS.js","dist-OCScizqf.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-KcneGfMY.js"]}