{
"message": "A grace period can't be longer than 30 days",
"data": null
}
{
"message": "Invalid API key",
"data": null
}
{
"message": "Plan not found",
"data": null
}
Move a subscriber onto the plan’s current price and cadence.Subscriptions bill from the terms captured when they started, so repricing a
plan never moves an existing subscriber. This is the only way a repricing
reaches someone already subscribed, and it is always deliberate.The new terms take effect from the next period. The period they have
already paid for is left alone.
If the cadence changed, the billing cycle re-anchors at the current period end.
A subscriber moved from monthly to annual bills a year after their current
period ends.
Request authentication
This endpoint requires a Secret Key (sk_...).
Authorizations
x-api-key
string
header
required
Path Parameters
subscriptionId
string
required
Response
The subscription on the plan's current terms, effective from the next period.
A single subscription.
message
string
data
object
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Creptapay","colors":{"primary":"#3FC3DD","light":"#7FE4F6","dark":"#3FC3DD"},"logo":{"light":"https://mintcdn.com/creptapay/AH8V32c1FARYLJ8W/logo/light.svg?fit=max\u0026auto=format\u0026n=AH8V32c1FARYLJ8W\u0026q=85\u0026s=cc91572e5f51656b67ae65191454ba45","dark":"https://mintcdn.com/creptapay/AH8V32c1FARYLJ8W/logo/dark.svg?fit=max\u0026auto=format\u0026n=AH8V32c1FARYLJ8W\u0026q=85\u0026s=41a8af28730d2e3074b429bd29a51b74"},"favicon":"https://mintcdn.com/creptapay/AH8V32c1FARYLJ8W/favicon.svg?fit=max\u0026auto=format\u0026n=AH8V32c1FARYLJ8W\u0026q=85\u0026s=2307f50dc05a4ca188f8de2856665a55","appearance":{"default":"dark","strict":true},"background":{"decoration":"grid","color":{"light":"#0D0F1A","dark":"#0D0F1A"}},"navbar":{"links":[{"href":"mailto:support@creptapay.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.creptapay.com"}},"footer":{"socials":{"x":"https://x.com/creptapay","github":"https://github.com/CreptapayHq","linkedin":"https://linkedin.com/company/creptapay"}},"fonts":{"family":"DM Sans"},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"creptapay","hasAudioNarration":false,"actualSubdomain":"creptapay","customDomains":["docs.creptapay.com"],"gitSource":{"type":"github","owner":"creptapayhq","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6aed5c2f9b58911ecf79c549","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"API reference","count":22},{"language":"default","tag":"Subscriptions","count":8},{"language":"default","tag":"Guides","count":8},{"language":"default","tag":"Customers","count":5},{"language":"default","tag":"Plans","count":5},{"language":"default","tag":"Payments","count":4},{"language":"default","tag":"Getting Started","count":3},{"language":"default","tag":"Plugins \u0026 SDKs","count":3},{"language":"default","tag":"Webhooks","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"api-reference/subscription/apply-plan-terms","slug":"/api-reference/subscription/apply-plan-terms","pageMetadata":{"title":"Apply Current Plan Terms","openapi":"POST /subscriptions/{subscriptionId}/apply-plan-terms","description":"Moves a subscriber onto the plan's current price and cadence, from the next period. The period they have already paid for is left alone.","href":"/api-reference/subscription/apply-plan-terms"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Moves a subscriber onto the plan’s current price and cadence, from the next period. The period they have already paid for is left alone.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Heading,Note}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Move a subscriber onto the plan’s current price and cadence.`}),`\n`,_jsx(_components.p,{children:`Subscriptions bill from the terms captured when they started, so repricing a\nplan never moves an existing subscriber. This is the only way a repricing\nreaches someone already subscribed, and it is always deliberate.`}),`\n`,_jsxs(_components.p,{children:[`The new terms take effect `,_jsx(_components.strong,{children:`from the next period`}),`. The period they have\nalready paid for is left alone.`]}),`\n`,_jsx(Note,{children:_jsx(_components.p,{children:`If the cadence changed, the billing cycle re-anchors at the current period end.\nA subscriber moved from monthly to annual bills a year after their current\nperiod ends.`})}),`\n`,_jsx(Heading,{level:`2`,id:`request-authentication`,children:`Request authentication`}),`\n`,_jsxs(_components.p,{children:[`This endpoint requires a `,_jsx(_components.strong,{children:`Secret Key`}),` (`,_jsx(_components.code,{children:`sk_...`}),`).`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Apply Current Plan Terms","openapi":"POST /subscriptions/{subscriptionId}/apply-plan-terms","description":"Moves a subscriber onto the plan's current price and cadence, from the next period. The period they have already paid for is left alone.","href":"/api-reference/subscription/apply-plan-terms"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Request authentication","slug":"request-authentication","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Apply Current Plan Terms","description":"Moves a subscriber onto the plan's current price and cadence, from the next period. The period they have already paid for is left alone.","security":["ee77cae7-48a0-4e6a-b29a-3d90aa5a73c2"],"parameters":["07ae480b-c1eb-4bb1-87f8-66be78d098d8"],"responses":{"200":"361e73c3-41db-457b-a000-046ec2342511","400":"5ecd5a91-4641-43fe-964b-0b2a70fb66b0","401":"5cc53f61-944a-404a-bcbe-970799466c5e","404":"edf1708b-5827-4cd1-967f-940fcdfb1dae"},"method":"post","type":"path","servers":["c5832537-a186-427e-b059-0212e7763ab2"],"path":"/subscriptions/{subscriptionId}/apply-plan-terms","baseUrlOptions":["https://api.creptapay.com/v1"],"title":"Apply Current Plan Terms","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"07ae480b-c1eb-4bb1-87f8-66be78d098d8":{"in":"path","name":"subscriptionId","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"361e73c3-41db-457b-a000-046ec2342511":{"description":"The subscription on the plan's current terms, effective from the next period.","content":{"application/json":{"schema":{"type":"object","description":"A single subscription.","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"data":{"type":"object","properties":{"id":{"type":"string","example":"6712f0a1b9c4e2d3f4a5b6c8","uniqueKey":"data.id","typeLabel":"string"},"reference":{"type":"string","example":"SUB-K3F9A2QP","uniqueKey":"data.reference","typeLabel":"string"},"status":{"type":"string","enum":["trialing","active","past_due","paused","canceled","expired"],"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"checkout_url":{"type":"string","description":"Permanent pay link. Resolves to whichever cycle is currently due, so the same URL takes the first payment and every renewal after it.","example":"https://pay.creptapay.com/SUB-K3F9A2QP","uniqueKey":"data.checkout_url","typeLabel":"string"},"amount_due":{"oneOf":[{"type":"object","description":"What this subscriber owes for the cycle now due, from their own terms.","properties":{"amount":{"type":"number","example":49,"uniqueKey":"data.amount_due.oneOf.0.amount","typeLabel":"number"},"currency":{"type":"string","example":"USD","uniqueKey":"data.amount_due.oneOf.0.currency","typeLabel":"string"}},"uniqueKey":"data.amount_due.oneOf.0","typeLabel":"object"},{"type":"null","description":"What this subscriber owes for the cycle now due, from their own terms.","properties":{"amount":{"type":"number","example":49},"currency":{"type":"string","example":"USD"}},"uniqueKey":"data.amount_due.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.amount_due","typeLabel":"object | null"},"collection_mode":{"type":"string","enum":["invoice","auto_debit"],"default":"invoice","description":"Always `invoice` on new subscriptions. `auto_debit` is coming soon.","uniqueKey":"data.collection_mode","typeLabel":"enum\u003cstring>"},"terms":{"type":"object","description":"The plan's terms copied onto the subscription when it started. Billing reads these, not the plan.","properties":{"amount":{"type":"number","example":49,"uniqueKey":"data.terms.amount","typeLabel":"number"},"currency":{"type":"string","example":"USD","uniqueKey":"data.terms.currency","typeLabel":"string"},"interval":{"type":"string","enum":["day","week","month","year"],"uniqueKey":"data.terms.interval","typeLabel":"enum\u003cstring>"},"interval_count":{"type":"integer","example":1,"uniqueKey":"data.terms.interval_count","typeLabel":"integer"},"grace_days":{"type":"integer","example":7,"uniqueKey":"data.terms.grace_days","typeLabel":"integer"},"allowed_currencies":{"type":"array","items":{"type":"string","uniqueKey":"data.terms.allowed_currencies.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.terms.allowed_currencies","typeLabel":"string[]"},"captured_at":{"type":"string","format":"date-time","uniqueKey":"data.terms.captured_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"data.terms","typeLabel":"object"},"on_legacy_terms":{"type":"boolean","description":"True when the plan has since been repriced and this subscription has not moved.","uniqueKey":"data.on_legacy_terms","typeLabel":"boolean"},"plan":{"type":"object","uniqueKey":"data.plan","typeLabel":"object"},"customer":{"type":"object","uniqueKey":"data.customer","typeLabel":"object"},"current_period_start":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"data.current_period_start.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"data.current_period_start.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.current_period_start","typeLabel":"string\u003cdate-time> | null"},"current_period_end":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"data.current_period_end.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"data.current_period_end.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.current_period_end","typeLabel":"string\u003cdate-time> | null"},"next_billing_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"data.next_billing_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"data.next_billing_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.next_billing_at","typeLabel":"string\u003cdate-time> | null"},"grace_ends_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"data.grace_ends_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"data.grace_ends_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.grace_ends_at","typeLabel":"string\u003cdate-time> | null"},"trial_ends_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"data.trial_ends_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"data.trial_ends_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.trial_ends_at","typeLabel":"string\u003cdate-time> | null"},"cancel_at_period_end":{"type":"boolean","uniqueKey":"data.cancel_at_period_end","typeLabel":"boolean"},"canceled_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"data.canceled_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"data.canceled_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.canceled_at","typeLabel":"string\u003cdate-time> | null"},"cancel_reason":{"oneOf":[{"type":"string","uniqueKey":"data.cancel_reason.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.cancel_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.cancel_reason","typeLabel":"string | null"},"payments_count":{"type":"integer","uniqueKey":"data.payments_count","typeLabel":"integer"},"failed_attempts":{"type":"integer","uniqueKey":"data.failed_attempts","typeLabel":"integer"},"createdAt":{"type":"string","format":"date-time","uniqueKey":"data.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","uniqueKey":"data.updatedAt","typeLabel":"string\u003cdate-time>"},"latest_payment":{"oneOf":[{"type":"object","description":"The cycle this subscriber last paid for. A string id when not expanded, null before the first payment.","properties":{"id":{"type":"string","uniqueKey":"data.latest_payment.oneOf.0.id","typeLabel":"string"},"reference":{"type":"string","example":"TX-482910","uniqueKey":"data.latest_payment.oneOf.0.reference","typeLabel":"string"},"status":{"type":"string","example":"paid","uniqueKey":"data.latest_payment.oneOf.0.status","typeLabel":"string"},"amount":{"type":"number","example":49,"uniqueKey":"data.latest_payment.oneOf.0.amount","typeLabel":"number"},"currency":{"type":"string","example":"USD","uniqueKey":"data.latest_payment.oneOf.0.currency","typeLabel":"string"},"crypto_currency":{"oneOf":[{"type":"string","example":"USDC","uniqueKey":"data.latest_payment.oneOf.0.crypto_currency.oneOf.0","typeLabel":"string"},{"type":"null","example":"USDC","uniqueKey":"data.latest_payment.oneOf.0.crypto_currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.latest_payment.oneOf.0.crypto_currency","typeLabel":"string | null"},"network":{"oneOf":[{"type":"string","example":"BASE","uniqueKey":"data.latest_payment.oneOf.0.network.oneOf.0","typeLabel":"string"},{"type":"null","example":"BASE","uniqueKey":"data.latest_payment.oneOf.0.network.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.latest_payment.oneOf.0.network","typeLabel":"string | null"},"tx_hash":{"oneOf":[{"type":"string","uniqueKey":"data.latest_payment.oneOf.0.tx_hash.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.latest_payment.oneOf.0.tx_hash.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.latest_payment.oneOf.0.tx_hash","typeLabel":"string | null"},"billing_period_start":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"data.latest_payment.oneOf.0.billing_period_start.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"data.latest_payment.oneOf.0.billing_period_start.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.latest_payment.oneOf.0.billing_period_start","typeLabel":"string\u003cdate-time> | null"},"billing_period_end":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"data.latest_payment.oneOf.0.billing_period_end.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"data.latest_payment.oneOf.0.billing_period_end.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.latest_payment.oneOf.0.billing_period_end","typeLabel":"string\u003cdate-time> | null"},"createdAt":{"type":"string","format":"date-time","uniqueKey":"data.latest_payment.oneOf.0.createdAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"data.latest_payment.oneOf.0","typeLabel":"object"},{"type":"null","description":"The cycle this subscriber last paid for. A string id when not expanded, null before the first payment.","properties":{"id":{"type":"string"},"reference":{"type":"string","example":"TX-482910"},"status":{"type":"string","example":"paid"},"amount":{"type":"number","example":49},"currency":{"type":"string","example":"USD"},"crypto_currency":{"oneOf":[{"type":"string","example":"USDC"},{"type":"null","example":"USDC"}]},"network":{"oneOf":[{"type":"string","example":"BASE"},{"type":"null","example":"BASE"}]},"tx_hash":{"oneOf":[{"type":"string"},{"type":"null"}]},"billing_period_start":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"billing_period_end":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"createdAt":{"type":"string","format":"date-time"}},"uniqueKey":"data.latest_payment.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.latest_payment","typeLabel":"object | null"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"The plan's current terms apply from the next period","data":{"id":"6713a2b4c8d5e3f2a1b9c4e2","reference":"SUB-K3F9A2QP","status":"active","collection_mode":"invoice","checkout_url":"https://pay.creptapay.com/SUB-K3F9A2QP","amount_due":{"amount":49,"currency":"USD"},"terms":{"amount":49,"currency":"USD","interval":"month","interval_count":1,"grace_days":7,"allowed_currencies":["USDC"],"captured_at":"2026-01-15T09:22:11.000Z"},"on_legacy_terms":false,"plan":{"id":"6712f0a1b9c4e2d3f4a5b6c7","name":"Pro monthly","amount":49,"currency":"USD","interval":"month","interval_count":1,"grace_days":7},"customer":{"id":"60d0fe4f5311236168a109c9","name":"Chidera Okonkwo","email":"chidera@example.com"},"current_period_start":"2026-02-15T09:22:11.000Z","current_period_end":"2026-03-15T09:22:11.000Z","next_billing_at":"2026-03-15T09:22:11.000Z","grace_ends_at":"2026-03-22T09:22:11.000Z","trial_ends_at":null,"cancel_at_period_end":false,"canceled_at":null,"cancel_reason":null,"latest_payment":{"id":"60d0fe4f5311236168a109cb","reference":"CP-B2C3D4E5F6","status":"paid","amount":49,"currency":"USD","crypto_currency":"USDC","network":"BASE","tx_hash":"0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890","billing_period_start":"2026-02-15T09:22:11.000Z","billing_period_end":"2026-03-15T09:22:11.000Z","createdAt":"2026-02-15T09:20:02.000Z"},"payments_count":2,"failed_attempts":0,"last_failure_reason":null,"metadata":null,"createdAt":"2026-01-15T09:22:11.000Z","updatedAt":"2026-02-15T09:22:14.000Z"}},"examples":{"Example":{"title":"Example","value":{"message":"The plan's current terms apply from the next period","data":{"id":"6713a2b4c8d5e3f2a1b9c4e2","reference":"SUB-K3F9A2QP","status":"active","collection_mode":"invoice","checkout_url":"https://pay.creptapay.com/SUB-K3F9A2QP","amount_due":{"amount":49,"currency":"USD"},"terms":{"amount":49,"currency":"USD","interval":"month","interval_count":1,"grace_days":7,"allowed_currencies":["USDC"],"captured_at":"2026-01-15T09:22:11.000Z"},"on_legacy_terms":false,"plan":{"id":"6712f0a1b9c4e2d3f4a5b6c7","name":"Pro monthly","amount":49,"currency":"USD","interval":"month","interval_count":1,"grace_days":7},"customer":{"id":"60d0fe4f5311236168a109c9","name":"Chidera Okonkwo","email":"chidera@example.com"},"current_period_start":"2026-02-15T09:22:11.000Z","current_period_end":"2026-03-15T09:22:11.000Z","next_billing_at":"2026-03-15T09:22:11.000Z","grace_ends_at":"2026-03-22T09:22:11.000Z","trial_ends_at":null,"cancel_at_period_end":false,"canceled_at":null,"cancel_reason":null,"latest_payment":{"id":"60d0fe4f5311236168a109cb","reference":"CP-B2C3D4E5F6","status":"paid","amount":49,"currency":"USD","crypto_currency":"USDC","network":"BASE","tx_hash":"0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890","billing_period_start":"2026-02-15T09:22:11.000Z","billing_period_end":"2026-03-15T09:22:11.000Z","createdAt":"2026-02-15T09:20:02.000Z"},"payments_count":2,"failed_attempts":0,"last_failure_reason":null,"metadata":null,"createdAt":"2026-01-15T09:22:11.000Z","updatedAt":"2026-02-15T09:22:14.000Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"5ecd5a91-4641-43fe-964b-0b2a70fb66b0":{"description":"The request was rejected — a missing field, a value out of range, or an operation that isn't valid for the object's current state.","content":{"application/json":{"schema":{"type":"object","description":"Every failure comes back in this shape. `data` is always null.","properties":{"message":{"type":"string","description":"What went wrong, in plain words — safe to log, not to show a customer verbatim.","uniqueKey":"message","typeLabel":"string"},"data":{"oneOf":[{"example":null},{"example":null,"type":"null","uniqueKey":"data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data","typeLabel":"null"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"A grace period can't be longer than 30 days","data":null},"examples":{"Example":{"title":"Example","value":{"message":"A grace period can't be longer than 30 days","data":null}}},"exampleType":"examples"}},"exampleType":"examples"},"5cc53f61-944a-404a-bcbe-970799466c5e":{"description":"The API key is missing, malformed, or not valid for this environment.","content":{"application/json":{"schema":{"type":"object","description":"Every failure comes back in this shape. `data` is always null.","properties":{"message":{"type":"string","description":"What went wrong, in plain words — safe to log, not to show a customer verbatim.","uniqueKey":"message","typeLabel":"string"},"data":{"oneOf":[{"example":null},{"example":null,"type":"null","uniqueKey":"data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data","typeLabel":"null"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"Invalid API key","data":null},"examples":{"Example":{"title":"Example","value":{"message":"Invalid API key","data":null}}},"exampleType":"examples"}},"exampleType":"examples"},"edf1708b-5827-4cd1-967f-940fcdfb1dae":{"description":"No such object for this business and environment. A live key never sees sandbox objects, and vice versa.","content":{"application/json":{"schema":{"type":"object","description":"Every failure comes back in this shape. `data` is always null.","properties":{"message":{"type":"string","description":"What went wrong, in plain words — safe to log, not to show a customer verbatim.","uniqueKey":"message","typeLabel":"string"},"data":{"oneOf":[{"example":null},{"example":null,"type":"null","uniqueKey":"data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data","typeLabel":"null"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"Plan not found","data":null},"examples":{"Example":{"title":"Example","value":{"message":"Plan not found","data":null}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"ee77cae7-48a0-4e6a-b29a-3d90aa5a73c2":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"c5832537-a186-427e-b059-0212e7763ab2":{"url":"https://api.creptapay.com/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"x-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-api-key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"creptapay","siteName":"Creptapay","title":"Apply Current Plan Terms - Creptapay","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-26T17:27:13.672Z","originalFileLocation":"api-reference/subscription/apply-plan-terms.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"dark\";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=\"dark\"}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=\"Moves a subscriber onto the plan\u0026#x27;s current price and cadence, from the next period. The period they have already paid for is left alone.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Creptapay\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/creptapay/WHxmGYdKleXbjfba/_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/creptapay/WHxmGYdKleXbjfba/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/creptapay/WHxmGYdKleXbjfba/_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/creptapay/WHxmGYdKleXbjfba/_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/creptapay/WHxmGYdKleXbjfba/_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/creptapay/WHxmGYdKleXbjfba/_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/creptapay/WHxmGYdKleXbjfba/_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/creptapay/WHxmGYdKleXbjfba/_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/creptapay/WHxmGYdKleXbjfba/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Apply Current Plan Terms - Creptapay\">\u003cmeta data-mint-head property=\"og:description\" content=\"Moves a subscriber onto the plan\u0026#x27;s current price and cadence, from the next period. The period they have already paid for is left alone.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Creptapay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.creptapay.com/api-reference/subscription/apply-plan-terms\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://creptapay.mintlify.site/_mintlify/api/og/v2?division=Subscriptions\u0026amp;title=Apply+Current+Plan+Terms\u0026amp;description=Moves+a+subscriber+onto+the+plan%27s+current+price+and+cadence%2C+from+the+next+period.+The+period+they+have+already+paid+for+is+left+alone.\u0026amp;theme=d2763859ebcd93245fd3c4ef\u0026amp;signature=af659c261643bdaf1b1f1dd4f184541f219094787747f149043fdb14f753b2a6\">\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=\"Apply Current Plan Terms - Creptapay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Moves a subscriber onto the plan\u0026#x27;s current price and cadence, from the next period. The period they have already paid for is left alone.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://creptapay.mintlify.site/_mintlify/api/og/v2?division=Subscriptions\u0026amp;title=Apply+Current+Plan+Terms\u0026amp;description=Moves+a+subscriber+onto+the+plan%27s+current+price+and+cadence%2C+from+the+next+period.+The+period+they+have+already+paid+for+is+left+alone.\u0026amp;theme=d2763859ebcd93245fd3c4ef\u0026amp;signature=af659c261643bdaf1b1f1dd4f184541f219094787747f149043fdb14f753b2a6\">\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/creptapay/WHxmGYdKleXbjfba/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Creptapay\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3FC3DD\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.creptapay.com/api-reference/subscription/apply-plan-terms\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/subscription/apply-plan-terms.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.creptapay.com/#organization\",\"name\":\"Creptapay\",\"url\":\"https://docs.creptapay.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/creptapay/AH8V32c1FARYLJ8W/logo/light.svg?fit=max\u0026auto=format\u0026n=AH8V32c1FARYLJ8W\u0026q=85\u0026s=cc91572e5f51656b67ae65191454ba45\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.creptapay.com#website\",\"name\":\"Creptapay\",\"url\":\"https://docs.creptapay.com\",\"publisher\":{\"@id\":\"https://docs.creptapay.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.creptapay.com/api-reference/subscription/apply-plan-terms#webpage\",\"url\":\"https://docs.creptapay.com/api-reference/subscription/apply-plan-terms\",\"name\":\"Apply Current Plan Terms\",\"description\":\"Moves a subscriber onto the plan's current price and cadence, from the next period. The period they have already paid for is left alone.\",\"dateModified\":\"2026-09-26T17:27:13.672Z\",\"isPartOf\":{\"@id\":\"https://docs.creptapay.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.creptapay.com/api-reference/subscription/apply-plan-terms#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.creptapay.com/api-reference/subscription/apply-plan-terms#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Subscriptions\",\"item\":\"https://docs.creptapay.com/api-reference/subscription/create-subscription\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Apply Current Plan Terms\",\"item\":\"https://docs.creptapay.com/api-reference/subscription/apply-plan-terms\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.creptapay.com/api-reference/subscription/apply-plan-terms#apireference\",\"headline\":\"Apply Current Plan Terms\",\"name\":\"Apply Current Plan Terms\",\"description\":\"Moves a subscriber onto the plan's current price and cadence, from the next period. The period they have already paid for is left alone.\",\"url\":\"https://docs.creptapay.com/api-reference/subscription/apply-plan-terms\",\"mainEntityOfPage\":{\"@id\":\"https://docs.creptapay.com/api-reference/subscription/apply-plan-terms#webpage\"},\"dateModified\":\"2026-09-26T17:27:13.672Z\",\"publisher\":{\"@id\":\"https://docs.creptapay.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.creptapay.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Creptapay\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Creptapay\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/subscription/apply-plan-terms.md","siteName":"Creptapay","nav":{"global":{"anchors":[]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/introduction"}]},{"tab":"API reference","groups":[{"group":"Payments","pages":[{"title":"Create Payment","openapi":"POST /payment","href":"/api-reference/payment/create-payment"},{"title":"List Payments","openapi":"GET /payment","href":"/api-reference/payment/list-payments"},{"title":"Get Payment","openapi":"GET /payment/{id}","href":"/api-reference/payment/get-payment"},{"title":"Get Payment by Reference","openapi":"GET /payment/reference/{reference}","href":"/api-reference/payment/get-payment-by-reference"}]},{"group":"Customers","pages":[{"title":"Create Customer","openapi":"POST /customer","href":"/api-reference/customer/create-customer"},{"title":"List Customers","openapi":"GET /customer","href":"/api-reference/customer/list-customers"},{"title":"Get Customer","openapi":"GET /customer/{id}","href":"/api-reference/customer/get-customer"},{"title":"Update Customer","openapi":"PUT /customer/{id}","href":"/api-reference/customer/update-customer"},{"title":"Delete Customer","openapi":"DELETE /customer/{id}","href":"/api-reference/customer/delete-customer"}]},{"group":"Plans","pages":[{"title":"Create Plan","openapi":"POST /plans","href":"/api-reference/plan/create-plan"},{"title":"List Plans","openapi":"GET /plans","href":"/api-reference/plan/list-plans"},{"title":"Get Plan","openapi":"GET /plans/{planId}","href":"/api-reference/plan/get-plan"},{"title":"Update Plan","openapi":"PATCH /plans/{planId}","href":"/api-reference/plan/update-plan"},{"title":"Archive Plan","openapi":"DELETE /plans/{planId}","href":"/api-reference/plan/archive-plan"}]},{"group":"Subscriptions","pages":[{"title":"Create Subscription","openapi":"POST /subscriptions","href":"/api-reference/subscription/create-subscription"},{"title":"List Subscriptions","openapi":"GET /subscriptions","href":"/api-reference/subscription/list-subscriptions"},{"title":"Subscription Metrics","openapi":"GET /subscriptions/summary","href":"/api-reference/subscription/subscription-metrics"},{"title":"Get Subscription","openapi":"GET /subscriptions/{subscriptionId}","href":"/api-reference/subscription/get-subscription"},{"title":"Cancel Subscription","openapi":"POST /subscriptions/{subscriptionId}/cancel","href":"/api-reference/subscription/cancel-subscription"},{"title":"Pause Subscription","openapi":"POST /subscriptions/{subscriptionId}/pause","href":"/api-reference/subscription/pause-subscription"},{"title":"Resume Subscription","openapi":"POST /subscriptions/{subscriptionId}/resume","description":"Restarts billing, with the next period running from today.","href":"/api-reference/subscription/resume-subscription"},{"title":"Apply Current Plan Terms","openapi":"POST /subscriptions/{subscriptionId}/apply-plan-terms","href":"/api-reference/subscription/apply-plan-terms"}]}]}]},"basePath":"","title":"Apply Current Plan Terms - Creptapay","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","Page-BIYvYBgk.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}