Metadata for the subscription in the form of key-value pairs.
Example:
{ "userId": "user_123", "plan": "pro" }
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Creem","colors":{"primary":"#FFBE98","light":"#FFBE98","dark":"#B09CFB"},"logo":{"light":"https://mintcdn.com/creem/-AIVGXbrCJu_8i70/logo/light.svg?fit=max\u0026auto=format\u0026n=-AIVGXbrCJu_8i70\u0026q=85\u0026s=686f06f43a3d7e4c0456e22de64c8bae","dark":"https://mintcdn.com/creem/-AIVGXbrCJu_8i70/logo/dark.svg?fit=max\u0026auto=format\u0026n=-AIVGXbrCJu_8i70\u0026q=85\u0026s=7c9135ca8b2365d6ec3728dc087f694d"},"favicon":"https://mintcdn.com/creem/-AIVGXbrCJu_8i70/favicon.svg?fit=max\u0026auto=format\u0026n=-AIVGXbrCJu_8i70\u0026q=85\u0026s=92df9cacbac6c8f17dbeb2d8b6befb93","navbar":{"links":[{"href":"https://creem.io/contact","label":"Support"},{"href":"https://docs.creem.io/llms.txt","label":"llms.txt"},{"href":"https://docs.creem.io/llms-full.txt","label":"llms-full.txt"}],"primary":{"type":"button","label":"Creem","href":"https://creem.io"}},"footer":{"socials":{"x":"https://x.com/creem_io","linkedin":"https://www.linkedin.com/company/creemio"}},"seo":{"metatags":{"twitter:site":"@creem_io","og:site_name":"Creem Documentation","keywords":"merchant of record, payment api, saas billing, subscription management, global payments, MoR, affiliate program, affiliate marketing, referral program"},"indexing":"all"},"integrations":{"posthog":{"apiKey":"phc_placeholder_gabriel_will_provide","apiHost":"https://us.posthog.com"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Community","icon":"discord","href":"https://discord.gg/q3GKZs92Av"},{"anchor":"Blog","icon":"newspaper","href":"https://creem.io/blog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"creem","hasAudioNarration":false,"actualSubdomain":"creem","customDomains":["docs.creem.io"],"gitSource":{"type":"github","owner":"armitage-labs","repo":"creem","deployBranch":"main","contentDirectory":"packages/docs","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae49bdec2f3f73890237b03","collectionId":"8669b068-8078-4c3a-946f-d1d1a151d999","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae49bdec2f3f73890237b03"},"entitlements":{},"buildId":"6ae49bdec2f3f73890237b03","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"Documentation","count":100},{"language":"default","tag":"API Reference","count":65},{"language":"default","tag":"Features","count":44},{"language":"default","tag":"Code","count":21},{"language":"default","tag":"Customer Credits","count":19},{"language":"default","tag":"SDKs","count":19},{"language":"default","tag":"Guides","count":18},{"language":"default","tag":"Meters","count":9},{"language":"default","tag":"Get Started","count":9},{"language":"default","tag":"Webhooks","count":8}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","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":"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":"llms-txt-v2","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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":"#topbar-cta-button{color:#000}"}],"page":{"pagePath":"api-reference/endpoint/upgrade-subscription","slug":"/api-reference/endpoint/upgrade-subscription","pageMetadata":{"title":"Upgrade a subscription to a different product","description":"Upgrade a subscription to a different product or plan. Handle proration and plan changes seamlessly.","openapi":"post /v1/subscriptions/{id}/upgrade","href":"/api-reference/endpoint/upgrade-subscription"},"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: \"Upgrade a subscription to a different product or plan. Handle proration and plan changes seamlessly.\"\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":"Upgrade a subscription to a different product","description":"Upgrade a subscription to a different product or plan. Handle proration and plan changes seamlessly.","openapi":"post /v1/subscriptions/{id}/upgrade","href":"/api-reference/endpoint/upgrade-subscription"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/creem/c0258fabb625b4ba/scripts/generate-api-docs.js"],"openApiReferenceData":{"operation":{"operationId":"upgradeSubscription","x-speakeasy-name-override":"upgrade","summary":"Upgrade a subscription to a different product","description":"Upgrade a subscription to a different product or plan. Handle proration and plan changes seamlessly.","parameters":["ccce6d0c-6613-4b76-87e6-54f6d23007a1"],"requestBody":"991b0e64-197d-493c-b05e-9e412044fb96","responses":{"200":"b36f59e8-e9d4-4260-a2c3-b2d3ee171d72","400":"aa101340-764c-4de0-92fa-638bab2f4083","401":"814bd788-fe26-473a-97e3-a9680e0d7214","404":"e923e22e-5ae4-4762-860f-e1151ccc6d4f"},"tags":["Subscriptions"],"security":["2c398e21-5e69-4f87-9253-345968cda0a8"],"method":"post","type":"path","servers":["ce73d8da-bcf3-4183-ac11-826f6188634a","a3b3db05-e3f5-4845-baed-eca093fbbcd7"],"path":"/v1/subscriptions/{id}/upgrade","baseUrlOptions":["https://api.creem.io","https://test-api.creem.io"],"title":"Upgrade a subscription to a different product","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"ccce6d0c-6613-4b76-87e6-54f6d23007a1":{"name":"id","required":true,"in":"path","description":"The unique identifier of the subscription","schema":{"type":"string","isRequired":true,"description":"The unique identifier of the subscription","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"description":"Subscription upgrade payload","content":{"application/json":{"schema":{"type":"object","properties":{"product_id":{"type":"string","description":"The ID of the product to upgrade to","example":"prod_123","isRequired":true,"uniqueKey":"product_id","typeLabel":"string"},"update_behavior":{"type":"string","description":"The update behavior for the subscription (defaults to proration-charge-immediately)","enum":["proration-charge-immediately","proration-charge","proration-none"],"default":"proration-charge-immediately","uniqueKey":"update_behavior","typeLabel":"enum\u003cstring>"}},"required":["product_id"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"product_id":"prod_123","update_behavior":"proration-charge-immediately"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"b36f59e8-e9d4-4260-a2c3-b2d3ee171d72":{"description":"Successfully upgraded the subscription","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the object.","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"mode":{"type":"string","description":"String representing the environment.","enum":["test","prod","sandbox"],"isRequired":true,"uniqueKey":"mode","typeLabel":"enum\u003cstring>"},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value.","example":"subscription","isRequired":true,"uniqueKey":"object","typeLabel":"string"},"product":{"oneOf":[{"type":"object","description":"The product associated with the subscription.","required":["id","mode","object","name","description","price","currency","billing_type","billing_period","status","tax_mode","tax_category","created_at","updated_at"],"properties":{"id":{"type":"string","description":"Unique identifier for the object.","isRequired":true,"uniqueKey":"product.oneOf.0.id","typeLabel":"string"},"mode":{"type":"string","description":"String representing the environment.","enum":["test","prod","sandbox"],"isRequired":true,"uniqueKey":"product.oneOf.0.mode","typeLabel":"enum\u003cstring>"},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value.","isRequired":true,"uniqueKey":"product.oneOf.0.object","typeLabel":"string"},"name":{"type":"string","description":"The name of the product","isRequired":true,"uniqueKey":"product.oneOf.0.name","typeLabel":"string"},"description":{"type":"string","description":"A brief description of the product","example":"This is a sample product description.","isRequired":true,"uniqueKey":"product.oneOf.0.description","typeLabel":"string"},"price":{"type":"number","description":"The price of the product in cents. 1000 = $10.00","example":400,"isRequired":true,"uniqueKey":"product.oneOf.0.price","typeLabel":"number"},"currency":{"type":"string","description":"Three-letter ISO currency code, in uppercase. Must be a supported currency.","example":"USD","isRequired":true,"uniqueKey":"product.oneOf.0.currency","typeLabel":"string"},"billing_type":{"type":"string","description":"Indicates the billing method for the customer. It can either be a `recurring` billing cycle or a `onetime` payment.","enum":["recurring","onetime"],"example":"recurring","isRequired":true,"uniqueKey":"product.oneOf.0.billing_type","typeLabel":"enum\u003cstring>"},"billing_period":{"type":"string","description":"Billing period","enum":["every-month","every-three-months","every-six-months","every-year","every-day","once","custom"],"example":"every-month","isRequired":true,"uniqueKey":"product.oneOf.0.billing_period","typeLabel":"enum\u003cstring>"},"status":{"type":"string","description":"Lifecycle status of the product: `active` or `archived`.","enum":["active","archived"],"example":"active","isRequired":true,"uniqueKey":"product.oneOf.0.status","typeLabel":"enum\u003cstring>"},"tax_mode":{"type":"string","description":"Specifies the tax calculation mode for the transaction. If set to \"inclusive,\" the tax is included in the price. If set to \"exclusive,\" the tax is added on top of the price.","enum":["inclusive","exclusive"],"example":"inclusive","isRequired":true,"uniqueKey":"product.oneOf.0.tax_mode","typeLabel":"enum\u003cstring>"},"tax_category":{"type":"string","description":"Categorizes the type of product or service for tax purposes. This helps determine the applicable tax rules based on the nature of the item or service.","enum":["saas","digital-goods-service","ebooks"],"example":"saas","isRequired":true,"uniqueKey":"product.oneOf.0.tax_category","typeLabel":"enum\u003cstring>"},"created_at":{"format":"date-time","type":"string","description":"Creation date of the product","example":"2023-01-01T00:00:00Z","isRequired":true,"uniqueKey":"product.oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"format":"date-time","type":"string","description":"Last updated date of the product","example":"2023-01-01T00:00:00Z","isRequired":true,"uniqueKey":"product.oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"},"image_url":{"type":"string","description":"URL of the product image. Only png as jpg are supported","example":"https://example.com/image.jpg","uniqueKey":"product.oneOf.0.image_url","typeLabel":"string"},"image_urls":{"description":"Ordered list of product image URLs. The first entry is the cover image (mirrored in image_url).","example":["https://example.com/image.jpg"],"type":"array","items":{"type":"string","uniqueKey":"product.oneOf.0.image_urls.items.[INDEX]","typeLabel":"string"},"uniqueKey":"product.oneOf.0.image_urls","typeLabel":"string[]"},"features":{"description":"Features of the product.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the feature.","example":"feat_abc123","isRequired":true,"uniqueKey":"product.oneOf.0.features.items.[INDEX].id","typeLabel":"string"},"type":{"type":"string","description":"The type of the feature: `custom` (private note), `file` (downloadable files), `licenseKey` (license key), or `customerCredits` (customer credit grant).","enum":["custom","file","licenseKey","customerCredits"],"example":"licenseKey","isRequired":true,"uniqueKey":"product.oneOf.0.features.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"A brief description of the feature.","example":"Access to premium course materials.","isRequired":true,"uniqueKey":"product.oneOf.0.features.items.[INDEX].description","typeLabel":"string"},"customer_credits":{"oneOf":[{"type":"object","description":"The credit grant behind a `customerCredits` feature. Absent for other feature types.","required":["amount"],"properties":{"amount":{"type":"string","description":"The number of credits to grant. String to preserve BigInt precision.","example":"100","isRequired":true,"uniqueKey":"product.oneOf.0.features.items.[INDEX].customer_credits.oneOf.0.amount","typeLabel":"string"},"unit_label":{"oneOf":[{"type":"string","description":"Optional label for the credit unit (e.g. \"tokens\", \"credits\").","example":"tokens","uniqueKey":"product.oneOf.0.features.items.[INDEX].customer_credits.oneOf.0.unit_label.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional label for the credit unit (e.g. \"tokens\", \"credits\").","example":"tokens","uniqueKey":"product.oneOf.0.features.items.[INDEX].customer_credits.oneOf.0.unit_label.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.features.items.[INDEX].customer_credits.oneOf.0.unit_label","typeLabel":"string | null"},"bucket_name":{"oneOf":[{"type":"string","description":"The customer-credit bucket this grant funds — the `name` of the customer's credit account. Set it to a meter bucket (e.g. \"images\") so the credits fund a per-unit metered price; otherwise they land in `default` and metered usage cannot spend them. Distinct from `unit_label`, which is only a display label. On UPDATE the field is tri-state: OMIT it to leave the stored bucket unchanged, send `null` to clear it to the shared `default` wallet, or send a name to set it. On CREATE, omitted or null both mean `default`. A present-but-blank value is rejected.","example":"images","uniqueKey":"product.oneOf.0.features.items.[INDEX].customer_credits.oneOf.0.bucket_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer-credit bucket this grant funds — the `name` of the customer's credit account. Set it to a meter bucket (e.g. \"images\") so the credits fund a per-unit metered price; otherwise they land in `default` and metered usage cannot spend them. Distinct from `unit_label`, which is only a display label. On UPDATE the field is tri-state: OMIT it to leave the stored bucket unchanged, send `null` to clear it to the shared `default` wallet, or send a name to set it. On CREATE, omitted or null both mean `default`. A present-but-blank value is rejected.","example":"images","uniqueKey":"product.oneOf.0.features.items.[INDEX].customer_credits.oneOf.0.bucket_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.features.items.[INDEX].customer_credits.oneOf.0.bucket_name","typeLabel":"string | null"}},"uniqueKey":"product.oneOf.0.features.items.[INDEX].customer_credits.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"product.oneOf.0.features.items.[INDEX].customer_credits.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.features.items.[INDEX].customer_credits","typeLabel":"object | null"}},"required":["id","type","description"],"uniqueKey":"product.oneOf.0.features.items.[INDEX]","typeLabel":"object"},"uniqueKey":"product.oneOf.0.features","typeLabel":"object[]"},"usage_prices":{"description":"Metered charges billed on top of the base price, one per meter. Present on recurring products that meter usage.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the usage price.","example":"price_abc123","isRequired":true,"uniqueKey":"product.oneOf.0.usage_prices.items.[INDEX].id","typeLabel":"string"},"meter_id":{"type":"string","description":"The meter this charge bills.","example":"mtr_abc123","isRequired":true,"uniqueKey":"product.oneOf.0.usage_prices.items.[INDEX].meter_id","typeLabel":"string"},"unit_price":{"type":"number","description":"Tax-exclusive price per SINGLE meter unit, in minor units of the product currency. \"$20 per 1,000,000 tokens\" is 0.002 (2000 cents / 1,000,000). Fractional values are allowed.","example":0.002,"isRequired":true,"uniqueKey":"product.oneOf.0.usage_prices.items.[INDEX].unit_price","typeLabel":"number"},"free_allowance":{"type":"integer","description":"Meter units free per billing period, per customer, before the charge applies.","example":1000,"isRequired":true,"uniqueKey":"product.oneOf.0.usage_prices.items.[INDEX].free_allowance","typeLabel":"integer"},"settlement_mode":{"type":"string","description":"How the charge settles: `prepaid` debits the customer credit account as usage aggregates; `postpaid` bills at renewal where the store supports it.","enum":["prepaid","postpaid"],"example":"prepaid","isRequired":true,"uniqueKey":"product.oneOf.0.usage_prices.items.[INDEX].settlement_mode","typeLabel":"enum\u003cstring>"},"target_account":{"type":"string","description":"Credit bucket a prepaid charge debits: `shared` (the customer default wallet) or `per_unit` (a bucket named after the meter unit label, or `target_account_name`). Defaults to `shared`.","enum":["shared","per_unit"],"example":"per_unit","isRequired":true,"uniqueKey":"product.oneOf.0.usage_prices.items.[INDEX].target_account","typeLabel":"enum\u003cstring>"},"trial_usage_mode":{"type":"string","description":"Usage metered during a free trial: `free` is not charged, `accrue` is charged when the trial converts. Defaults to `free`.","enum":["free","accrue"],"example":"free","isRequired":true,"uniqueKey":"product.oneOf.0.usage_prices.items.[INDEX].trial_usage_mode","typeLabel":"enum\u003cstring>"},"cap":{"oneOf":[{"type":"integer","description":"Optional ceiling on the charge per billing period, in minor units. Null means uncapped.","example":50000,"uniqueKey":"product.oneOf.0.usage_prices.items.[INDEX].cap.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Optional ceiling on the charge per billing period, in minor units. Null means uncapped.","example":50000,"uniqueKey":"product.oneOf.0.usage_prices.items.[INDEX].cap.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.usage_prices.items.[INDEX].cap","typeLabel":"integer | null"},"target_account_name":{"oneOf":[{"type":"string","description":"The per-unit bucket this charge debits: the name given on write, or the meter unit label when none was. Null for a `shared` charge.","example":"images","uniqueKey":"product.oneOf.0.usage_prices.items.[INDEX].target_account_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The per-unit bucket this charge debits: the name given on write, or the meter unit label when none was. Null for a `shared` charge.","example":"images","uniqueKey":"product.oneOf.0.usage_prices.items.[INDEX].target_account_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.usage_prices.items.[INDEX].target_account_name","typeLabel":"string | null"}},"required":["id","meter_id","unit_price","free_allowance","settlement_mode","target_account","trial_usage_mode"],"uniqueKey":"product.oneOf.0.usage_prices.items.[INDEX]","typeLabel":"object"},"uniqueKey":"product.oneOf.0.usage_prices","typeLabel":"object[]"},"recurring_interval":{"oneOf":[{"type":"string","description":"The unit of the recurring billing interval (`day`, `week`, `month`, or `year`). Together with `recurring_interval_count` this is authoritative for renewal timing — a `billing_period` of `custom` cannot be interpreted without it. For presets it is derived from the cadence (e.g. `every-three-months` → `month`). `null` for one-time products.","example":"month","uniqueKey":"product.oneOf.0.recurring_interval.oneOf.0","typeLabel":"string"},{"type":"null","description":"The unit of the recurring billing interval (`day`, `week`, `month`, or `year`). Together with `recurring_interval_count` this is authoritative for renewal timing — a `billing_period` of `custom` cannot be interpreted without it. For presets it is derived from the cadence (e.g. `every-three-months` → `month`). `null` for one-time products.","example":"month","uniqueKey":"product.oneOf.0.recurring_interval.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.recurring_interval","typeLabel":"string | null"},"recurring_interval_count":{"oneOf":[{"type":"integer","description":"The number of `recurring_interval` units per billing cycle (e.g. `3` with a `month` interval bills every three months). Together with `recurring_interval` this is authoritative for renewal timing. For presets it is derived from the cadence. `null` for one-time products.","example":3,"uniqueKey":"product.oneOf.0.recurring_interval_count.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of `recurring_interval` units per billing cycle (e.g. `3` with a `month` interval bills every three months). Together with `recurring_interval` this is authoritative for renewal timing. For presets it is derived from the cadence. `null` for one-time products.","example":3,"uniqueKey":"product.oneOf.0.recurring_interval_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.recurring_interval_count","typeLabel":"integer | null"},"trial_period_days":{"oneOf":[{"type":"integer","description":"Length of the trial period in days. A whole number of days, at least 1. Only supported for recurring products. `null` when the product has no trial.","example":7,"uniqueKey":"product.oneOf.0.trial_period_days.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Length of the trial period in days. A whole number of days, at least 1. Only supported for recurring products. `null` when the product has no trial.","example":7,"uniqueKey":"product.oneOf.0.trial_period_days.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.trial_period_days","typeLabel":"integer | null"},"trial_price":{"oneOf":[{"type":"integer","description":"Amount charged at checkout to start the trial, instead of a free card verification. In cents (100 = $1.00). Requires a trial period and must be at least 100 and lower than `price`; only supported on standard-priced recurring products without pay-what-you-want. `null` for a free trial and for products without a trial.","example":100,"uniqueKey":"product.oneOf.0.trial_price.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Amount charged at checkout to start the trial, instead of a free card verification. In cents (100 = $1.00). Requires a trial period and must be at least 100 and lower than `price`; only supported on standard-priced recurring products without pay-what-you-want. `null` for a free trial and for products without a trial.","example":100,"uniqueKey":"product.oneOf.0.trial_price.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.trial_price","typeLabel":"integer | null"},"business_net_pricing":{"type":"boolean","description":"When true, business customers whose valid VAT ID triggers reverse charge pay the price excluding VAT instead of the tax-inclusive price. Only supported for tax-inclusive one-time products; the merchant gives up the VAT portion on those sales. Defaults to false.","example":false,"uniqueKey":"product.oneOf.0.business_net_pricing","typeLabel":"boolean"},"product_url":{"type":"string","description":"The product page you can redirect your customers to for express checkout.","example":"https://creem.io/product/prod_123123123123","uniqueKey":"product.oneOf.0.product_url","typeLabel":"string"},"default_success_url":{"oneOf":[{"type":"string","description":"The URL to which the user will be redirected after successfull payment.","example":"https://example.com/?status=successful","uniqueKey":"product.oneOf.0.default_success_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL to which the user will be redirected after successfull payment.","example":"https://example.com/?status=successful","uniqueKey":"product.oneOf.0.default_success_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.default_success_url","typeLabel":"string | null"},"custom_fields":{"oneOf":[{"description":"Custom fields configured for the product. Collect additional information from your customer during checkout.","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of the field.","enum":["text","checkbox"],"isRequired":true,"uniqueKey":"product.oneOf.0.custom_fields.oneOf.0.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"Unique key for custom field. Must be unique to this field, alphanumeric, and up to 200 characters.","maxLength":200,"isRequired":true,"uniqueKey":"product.oneOf.0.custom_fields.oneOf.0.items.[INDEX].key","typeLabel":"string"},"label":{"type":"string","description":"The label for the field, displayed to the customer, up to 50 characters","maxLength":200,"isRequired":true,"uniqueKey":"product.oneOf.0.custom_fields.oneOf.0.items.[INDEX].label","typeLabel":"string"},"optional":{"oneOf":[{"type":"boolean","description":"Whether the customer is required to complete the field. Defaults to `false`.","uniqueKey":"product.oneOf.0.custom_fields.oneOf.0.items.[INDEX].optional.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the customer is required to complete the field. Defaults to `false`.","uniqueKey":"product.oneOf.0.custom_fields.oneOf.0.items.[INDEX].optional.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.custom_fields.oneOf.0.items.[INDEX].optional","typeLabel":"boolean | null"},"text":{"oneOf":[{"type":"object","description":"Configuration for text field type.","properties":{"max_length":{"oneOf":[{"type":"number","description":"Maximum character length constraint for the input.","uniqueKey":"product.oneOf.0.custom_fields.oneOf.0.items.[INDEX].text.oneOf.0.max_length.oneOf.0","typeLabel":"number"},{"type":"null","description":"Maximum character length constraint for the input.","uniqueKey":"product.oneOf.0.custom_fields.oneOf.0.items.[INDEX].text.oneOf.0.max_length.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.custom_fields.oneOf.0.items.[INDEX].text.oneOf.0.max_length","typeLabel":"number | null"},"minimum_length":{"oneOf":[{"type":"number","description":"Minimum character length requirement for the input.","uniqueKey":"product.oneOf.0.custom_fields.oneOf.0.items.[INDEX].text.oneOf.0.minimum_length.oneOf.0","typeLabel":"number"},{"type":"null","description":"Minimum character length requirement for the input.","uniqueKey":"product.oneOf.0.custom_fields.oneOf.0.items.[INDEX].text.oneOf.0.minimum_length.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.custom_fields.oneOf.0.items.[INDEX].text.oneOf.0.minimum_length","typeLabel":"number | null"},"value":{"oneOf":[{"type":"string","description":"The value of the input.","uniqueKey":"product.oneOf.0.custom_fields.oneOf.0.items.[INDEX].text.oneOf.0.value.oneOf.0","typeLabel":"string"},{"type":"null","description":"The value of the input.","uniqueKey":"product.oneOf.0.custom_fields.oneOf.0.items.[INDEX].text.oneOf.0.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.custom_fields.oneOf.0.items.[INDEX].text.oneOf.0.value","typeLabel":"string | null"}},"uniqueKey":"product.oneOf.0.custom_fields.oneOf.0.items.[INDEX].text.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"product.oneOf.0.custom_fields.oneOf.0.items.[INDEX].text.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.custom_fields.oneOf.0.items.[INDEX].text","typeLabel":"object | null"},"checkbox":{"oneOf":[{"type":"object","description":"Configuration for checkbox field type.","properties":{"label":{"oneOf":[{"type":"string","description":"The markdown text to display for the checkbox.","uniqueKey":"product.oneOf.0.custom_fields.oneOf.0.items.[INDEX].checkbox.oneOf.0.label.oneOf.0","typeLabel":"string"},{"type":"null","description":"The markdown text to display for the checkbox.","uniqueKey":"product.oneOf.0.custom_fields.oneOf.0.items.[INDEX].checkbox.oneOf.0.label.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.custom_fields.oneOf.0.items.[INDEX].checkbox.oneOf.0.label","typeLabel":"string | null"},"value":{"oneOf":[{"type":"boolean","description":"The value of the checkbox (checked or not).","uniqueKey":"product.oneOf.0.custom_fields.oneOf.0.items.[INDEX].checkbox.oneOf.0.value.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"The value of the checkbox (checked or not).","uniqueKey":"product.oneOf.0.custom_fields.oneOf.0.items.[INDEX].checkbox.oneOf.0.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.custom_fields.oneOf.0.items.[INDEX].checkbox.oneOf.0.value","typeLabel":"boolean | null"}},"uniqueKey":"product.oneOf.0.custom_fields.oneOf.0.items.[INDEX].checkbox.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"product.oneOf.0.custom_fields.oneOf.0.items.[INDEX].checkbox.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.custom_fields.oneOf.0.items.[INDEX].checkbox","typeLabel":"object | null"}},"required":["type","key","label"],"uniqueKey":"product.oneOf.0.custom_fields.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"product.oneOf.0.custom_fields.oneOf.0","typeLabel":"object[]"},{"description":"Custom fields configured for the product. Collect additional information from your customer during checkout.","type":"null","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of the field.","enum":["text","checkbox"]},"key":{"type":"string","description":"Unique key for custom field. Must be unique to this field, alphanumeric, and up to 200 characters.","maxLength":200},"label":{"type":"string","description":"The label for the field, displayed to the customer, up to 50 characters","maxLength":200},"optional":{"oneOf":[{"type":"boolean","description":"Whether the customer is required to complete the field. Defaults to `false`."},{"type":"null","description":"Whether the customer is required to complete the field. Defaults to `false`."}]},"text":{"oneOf":[{"type":"object","description":"Configuration for text field type.","properties":{"max_length":{"oneOf":[{"type":"number","description":"Maximum character length constraint for the input."},{"type":"null","description":"Maximum character length constraint for the input."}]},"minimum_length":{"oneOf":[{"type":"number","description":"Minimum character length requirement for the input."},{"type":"null","description":"Minimum character length requirement for the input."}]},"value":{"oneOf":[{"type":"string","description":"The value of the input."},{"type":"null","description":"The value of the input."}]}}},{"type":"null"}]},"checkbox":{"oneOf":[{"type":"object","description":"Configuration for checkbox field type.","properties":{"label":{"oneOf":[{"type":"string","description":"The markdown text to display for the checkbox."},{"type":"null","description":"The markdown text to display for the checkbox."}]},"value":{"oneOf":[{"type":"boolean","description":"The value of the checkbox (checked or not)."},{"type":"null","description":"The value of the checkbox (checked or not)."}]}}},{"type":"null"}]}},"required":["type","key","label"]},"uniqueKey":"product.oneOf.0.custom_fields.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.custom_fields","typeLabel":"object[] | null"}},"isRequired":true,"uniqueKey":"product.oneOf.0","typeLabel":"object"},{"type":"string","description":"The product associated with the subscription.","isRequired":true,"uniqueKey":"product.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"product","typeLabel":"object | string"},"customer":{"oneOf":[{"type":"object","description":"The customer who owns the subscription.","required":["id","mode","object","email","country","created_at","updated_at"],"properties":{"id":{"type":"string","description":"Unique identifier for the object.","isRequired":true,"uniqueKey":"customer.oneOf.0.id","typeLabel":"string"},"mode":{"type":"string","description":"String representing the environment.","enum":["test","prod","sandbox"],"isRequired":true,"uniqueKey":"customer.oneOf.0.mode","typeLabel":"enum\u003cstring>"},"object":{"type":"string","description":"String representing the object’s type. Objects of the same type share the same value.","isRequired":true,"uniqueKey":"customer.oneOf.0.object","typeLabel":"string"},"email":{"type":"string","description":"Customer email address.","example":"user@example.com","isRequired":true,"uniqueKey":"customer.oneOf.0.email","typeLabel":"string"},"country":{"oneOf":[{"type":"string","description":"The ISO 3166-1 alpha-2 country code for the customer.","example":"US","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"customer.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ISO 3166-1 alpha-2 country code for the customer.","example":"US","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"customer.oneOf.0.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"customer.oneOf.0.country","typeLabel":"string | null"},"created_at":{"format":"date-time","type":"string","description":"Creation date of the customer","example":"2023-01-01T00:00:00Z","isRequired":true,"uniqueKey":"customer.oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"format":"date-time","type":"string","description":"Last updated date of the customer","example":"2023-01-01T00:00:00Z","isRequired":true,"uniqueKey":"customer.oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"},"name":{"oneOf":[{"type":"string","description":"Customer name.","example":"John Doe","uniqueKey":"customer.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Customer name.","example":"John Doe","uniqueKey":"customer.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.oneOf.0.name","typeLabel":"string | null"},"metadata":{"oneOf":[{"type":"object","description":"Additional metadata associated with the customer.","example":{"key":"value"},"additionalProperties":true,"uniqueKey":"customer.oneOf.0.metadata.oneOf.0","typeLabel":"object"},{"type":"null","description":"Additional metadata associated with the customer.","example":{"key":"value"},"additionalProperties":true,"uniqueKey":"customer.oneOf.0.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.oneOf.0.metadata","typeLabel":"object | null"},"external_id":{"oneOf":[{"type":"string","description":"Your own id for this customer, when you have set one — usage ingestion resolves `external_customer_id` against it.","example":"user-42","uniqueKey":"customer.oneOf.0.external_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Your own id for this customer, when you have set one — usage ingestion resolves `external_customer_id` against it.","example":"user-42","uniqueKey":"customer.oneOf.0.external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.oneOf.0.external_id","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"customer.oneOf.0","typeLabel":"object"},{"type":"string","description":"The customer who owns the subscription.","isRequired":true,"uniqueKey":"customer.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"customer","typeLabel":"object | string"},"collection_method":{"type":"string","description":"The method used for collecting payments for the subscription.","enum":["charge_automatically"],"example":"charge_automatically","isRequired":true,"uniqueKey":"collection_method","typeLabel":"enum\u003cstring>"},"status":{"type":"string","description":"The current status of the subscription.","enum":["active","canceled","unpaid","paused","trialing","scheduled_cancel","past_due"],"example":"active","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"created_at":{"format":"date-time","type":"string","description":"The date and time when the subscription was created.","example":"2024-01-01T00:00:00Z","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","description":"The date and time when the subscription was last updated.","example":"2024-09-12T12:34:56Z","format":"date-time","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"items":{"description":"Subscription items.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].id","typeLabel":"string"},"mode":{"type":"string","description":"String representing the environment.","enum":["test","prod","sandbox"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].mode","typeLabel":"enum\u003cstring>"},"object":{"type":"string","description":"String representing the object’s type. Objects of the same type share the same value.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].object","typeLabel":"string"},"product_id":{"type":"string","description":"The ID of the product associated with the subscription item.","uniqueKey":"\\items.items.[INDEX].product_id","typeLabel":"string"},"price_id":{"type":"string","description":"The ID of the price associated with the subscription item.","uniqueKey":"\\items.items.[INDEX].price_id","typeLabel":"string"},"units":{"oneOf":[{"type":"number","description":"The number of units for the subscription item.","uniqueKey":"\\items.items.[INDEX].units.oneOf.0","typeLabel":"number"},{"type":"null","description":"The number of units for the subscription item.","uniqueKey":"\\items.items.[INDEX].units.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].units","typeLabel":"number | null"}},"required":["id","mode","object"],"uniqueKey":"\\items.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items","typeLabel":"object[]"},"last_transaction_id":{"type":"string","description":"The ID of the last paid transaction.","example":"tran_3e6Z6TzvHKdsjEgXnGDEp0","uniqueKey":"last_transaction_id","typeLabel":"string"},"last_transaction":{"type":"object","description":"The last paid transaction.","required":["id","mode","object","amount","currency","type","status","created_at"],"properties":{"id":{"type":"string","description":"Unique identifier for the object.","isRequired":true,"uniqueKey":"last_transaction.id","typeLabel":"string"},"mode":{"type":"string","description":"String representing the environment.","enum":["test","prod","sandbox"],"isRequired":true,"uniqueKey":"last_transaction.mode","typeLabel":"enum\u003cstring>"},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value.","example":"transaction","isRequired":true,"uniqueKey":"last_transaction.object","typeLabel":"string"},"amount":{"type":"number","description":"The transaction amount in cents. 1000 = $10.00","example":2000,"isRequired":true,"uniqueKey":"last_transaction.amount","typeLabel":"number"},"currency":{"type":"string","description":"Three-letter ISO currency code, in uppercase. Must be a supported currency.","example":"USD","isRequired":true,"uniqueKey":"last_transaction.currency","typeLabel":"string"},"type":{"type":"string","description":"The type of transaction. payment(one time payments) and invoice(subscription)","enum":["payment","invoice"],"isRequired":true,"uniqueKey":"last_transaction.type","typeLabel":"enum\u003cstring>"},"status":{"type":"string","description":"Status of the transaction.","enum":["pending","paid","refunded","partialRefund","chargedBack","uncollectible","declined","canceled","void"],"isRequired":true,"uniqueKey":"last_transaction.status","typeLabel":"enum\u003cstring>"},"created_at":{"type":"number","description":"Creation date of the order as timestamp","isRequired":true,"uniqueKey":"last_transaction.created_at","typeLabel":"number"},"amount_paid":{"oneOf":[{"type":"number","description":"The amount the customer paid in cents. 1000 = $10.00","example":2000,"uniqueKey":"last_transaction.amount_paid.oneOf.0","typeLabel":"number"},{"type":"null","description":"The amount the customer paid in cents. 1000 = $10.00","example":2000,"uniqueKey":"last_transaction.amount_paid.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_transaction.amount_paid","typeLabel":"number | null"},"discount_amount":{"oneOf":[{"type":"number","description":"The discount amount in cents. 1000 = $10.00","example":2000,"uniqueKey":"last_transaction.discount_amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"The discount amount in cents. 1000 = $10.00","example":2000,"uniqueKey":"last_transaction.discount_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_transaction.discount_amount","typeLabel":"number | null"},"tax_country":{"oneOf":[{"type":"string","description":"The ISO alpha-2 country code where tax is collected.","example":"US","pattern":"^[A-Z]{2}$","uniqueKey":"last_transaction.tax_country.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ISO alpha-2 country code where tax is collected.","example":"US","pattern":"^[A-Z]{2}$","uniqueKey":"last_transaction.tax_country.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_transaction.tax_country","typeLabel":"string | null"},"tax_amount":{"oneOf":[{"type":"number","description":"The sale tax amount in cents. 1000 = $10.00","example":2000,"uniqueKey":"last_transaction.tax_amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"The sale tax amount in cents. 1000 = $10.00","example":2000,"uniqueKey":"last_transaction.tax_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_transaction.tax_amount","typeLabel":"number | null"},"refunded_amount":{"oneOf":[{"type":"number","description":"The amount that has been refunded in cents. 1000 = $10.00","example":2000,"uniqueKey":"last_transaction.refunded_amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"The amount that has been refunded in cents. 1000 = $10.00","example":2000,"uniqueKey":"last_transaction.refunded_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_transaction.refunded_amount","typeLabel":"number | null"},"order":{"oneOf":[{"type":"string","description":"The order associated with the transaction.","uniqueKey":"last_transaction.order.oneOf.0","typeLabel":"string"},{"type":"null","description":"The order associated with the transaction.","uniqueKey":"last_transaction.order.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_transaction.order","typeLabel":"string | null"},"subscription":{"oneOf":[{"type":"string","description":"The subscription associated with the transaction.","uniqueKey":"last_transaction.subscription.oneOf.0","typeLabel":"string"},{"type":"null","description":"The subscription associated with the transaction.","uniqueKey":"last_transaction.subscription.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_transaction.subscription","typeLabel":"string | null"},"customer":{"oneOf":[{"type":"string","description":"The customer associated with the transaction.","uniqueKey":"last_transaction.customer.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer associated with the transaction.","uniqueKey":"last_transaction.customer.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_transaction.customer","typeLabel":"string | null"},"description":{"type":"string","description":"The description of the transaction.","uniqueKey":"last_transaction.description","typeLabel":"string"},"period_start":{"type":"number","description":"Start period for the invoice as timestamp","uniqueKey":"last_transaction.period_start","typeLabel":"number"},"period_end":{"type":"number","description":"End period for the invoice as timestamp","uniqueKey":"last_transaction.period_end","typeLabel":"number"}},"uniqueKey":"last_transaction","typeLabel":"object"},"last_transaction_date":{"format":"date-time","type":"string","description":"The date of the last paid transaction.","example":"2024-09-12T12:34:56Z","uniqueKey":"last_transaction_date","typeLabel":"string\u003cdate-time>"},"next_transaction_date":{"format":"date-time","type":"string","description":"The date when the next subscription transaction will be charged.","example":"2024-09-12T12:34:56Z","uniqueKey":"next_transaction_date","typeLabel":"string\u003cdate-time>"},"current_period_start_date":{"format":"date-time","type":"string","description":"The start date of the current subscription period.","example":"2024-09-12T12:34:56Z","uniqueKey":"current_period_start_date","typeLabel":"string\u003cdate-time>"},"current_period_end_date":{"format":"date-time","type":"string","description":"The end date of the current subscription period.","example":"2024-09-12T12:34:56Z","uniqueKey":"current_period_end_date","typeLabel":"string\u003cdate-time>"},"canceled_at":{"oneOf":[{"type":"string","description":"The date and time when the subscription was canceled, if applicable.","example":"2024-09-12T12:34:56Z","format":"date-time","uniqueKey":"canceled_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date and time when the subscription was canceled, if applicable.","example":"2024-09-12T12:34:56Z","format":"date-time","uniqueKey":"canceled_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"canceled_at","typeLabel":"string\u003cdate-time> | null"},"discount":{"type":"object","description":"The discount applied to the subscription, if any.","properties":{"id":{"type":"string","description":"The unique identifier of the discount (e.g. dis_...).","example":"dis_3e6Z6TzvHKdsjEgXnGDEp0","uniqueKey":"discount.id","typeLabel":"string"},"discountCode":{"type":"string","description":"The discount code applied to the subscription.","example":"HOLIDAY2024","uniqueKey":"discount.discountCode","typeLabel":"string"},"name":{"type":"string","uniqueKey":"discount.name","typeLabel":"string"},"type":{"type":"string","enum":["percentage","fixed"],"uniqueKey":"discount.type","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","uniqueKey":"discount.amount","typeLabel":"number"},"duration":{"type":"string","enum":["forever","once","repeating"],"uniqueKey":"discount.duration","typeLabel":"enum\u003cstring>"},"durationInMonths":{"type":"number","uniqueKey":"discount.durationInMonths","typeLabel":"number"}},"uniqueKey":"discount","typeLabel":"object"},"metadata":{"type":"object","description":"Metadata for the subscription in the form of key-value pairs.","example":{"userId":"user_123","plan":"pro"},"additionalProperties":true,"uniqueKey":"metadata","typeLabel":"object"}},"required":["id","mode","object","product","customer","collection_method","status","created_at","updated_at"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","mode":"test","object":"subscription","product":{"id":"\u003cstring>","mode":"test","object":"\u003cstring>","name":"\u003cstring>","description":"This is a sample product description.","price":400,"currency":"USD","billing_type":"recurring","billing_period":"every-month","status":"active","tax_mode":"inclusive","tax_category":"saas","created_at":"2023-01-01T00:00:00Z","updated_at":"2023-01-01T00:00:00Z","image_url":"https://example.com/image.jpg","image_urls":["https://example.com/image.jpg"],"features":[{"id":"feat_abc123","type":"licenseKey","description":"Access to premium course materials.","customer_credits":{"amount":"100","unit_label":"tokens","bucket_name":"images"}}],"usage_prices":[{"id":"price_abc123","meter_id":"mtr_abc123","unit_price":0.002,"free_allowance":1000,"settlement_mode":"prepaid","target_account":"per_unit","trial_usage_mode":"free","cap":50000,"target_account_name":"images"}],"recurring_interval":"month","recurring_interval_count":3,"trial_period_days":7,"trial_price":100,"business_net_pricing":false,"product_url":"https://creem.io/product/prod_123123123123","default_success_url":"https://example.com/?status=successful","custom_fields":[{"type":"text","key":"\u003cstring>","label":"\u003cstring>","optional":true,"text":{"max_length":123,"minimum_length":123,"value":"\u003cstring>"},"checkbox":{"label":"\u003cstring>","value":true}}]},"customer":{"id":"\u003cstring>","mode":"test","object":"\u003cstring>","email":"user@example.com","country":"US","created_at":"2023-01-01T00:00:00Z","updated_at":"2023-01-01T00:00:00Z","name":"John Doe","metadata":{"key":"value"},"external_id":"user-42"},"collection_method":"charge_automatically","status":"active","created_at":"2024-01-01T00:00:00Z","updated_at":"2024-09-12T12:34:56Z","items":[{"id":"\u003cstring>","mode":"test","object":"\u003cstring>","product_id":"\u003cstring>","price_id":"\u003cstring>","units":123}],"last_transaction_id":"tran_3e6Z6TzvHKdsjEgXnGDEp0","last_transaction":{"id":"\u003cstring>","mode":"test","object":"transaction","amount":2000,"currency":"USD","type":"payment","status":"pending","created_at":123,"amount_paid":2000,"discount_amount":2000,"tax_country":"US","tax_amount":2000,"refunded_amount":2000,"order":"\u003cstring>","subscription":"\u003cstring>","customer":"\u003cstring>","description":"\u003cstring>","period_start":123,"period_end":123},"last_transaction_date":"2024-09-12T12:34:56Z","next_transaction_date":"2024-09-12T12:34:56Z","current_period_start_date":"2024-09-12T12:34:56Z","current_period_end_date":"2024-09-12T12:34:56Z","canceled_at":"2024-09-12T12:34:56Z","discount":{"id":"dis_3e6Z6TzvHKdsjEgXnGDEp0","discountCode":"HOLIDAY2024","name":"\u003cstring>","type":"percentage","amount":123,"duration":"forever","durationInMonths":123},"metadata":{"userId":"user_123","plan":"pro"}}}},"exampleType":"generated"}},"exampleType":"generated"},"aa101340-764c-4de0-92fa-638bab2f4083":{"description":"Bad Request - Invalid input parameters","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"814bd788-fe26-473a-97e3-a9680e0d7214":{"description":"Unauthorized - Invalid or missing API key","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"e923e22e-5ae4-4762-860f-e1151ccc6d4f":{"description":"Not Found - Resource does not exist","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"2c398e21-5e69-4f87-9253-345968cda0a8":{"ApiKey":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication. You can find your API key in the Creem dashboard under Settings > API Keys.","scopes":[]}}},"servers":{"ce73d8da-bcf3-4183-ac11-826f6188634a":{"url":"https://api.creem.io","description":"Production — live API for processing real transactions and data.","x-speakeasy-server-id":"prod"},"a3b3db05-e3f5-4845-baed-eca093fbbcd7":{"url":"https://test-api.creem.io","description":"Test — sandbox API for development and testing with no real charges.","x-speakeasy-server-id":"test"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication. You can find your API key in the Creem dashboard under Settings > API Keys.","scopes":[]},"schema":{"title":"x-api-key","type":"string","description":"API key for authentication. You can find your API key in the Creem dashboard under Settings > API Keys.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKey","name":"x-api-key"}],"title":"ApiKey"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"creem","siteName":"Creem","title":"Upgrade a subscription to a different product - Creem","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-23T08:23:03.693Z","originalFileLocation":"api-reference/endpoint/upgrade-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=\"Upgrade a subscription to a different product or plan. Handle proration and plan changes seamlessly.\">\u003cmeta data-mint-head name=\"keywords\" content=\"merchant of record, payment api, saas billing, subscription management, global payments, MoR, affiliate program, affiliate marketing, referral program\">\u003cmeta data-mint-head name=\"application-name\" content=\"Creem\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/creem/nizlPYWnvgrMkN5E/_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/creem/nizlPYWnvgrMkN5E/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/creem/nizlPYWnvgrMkN5E/_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/creem/nizlPYWnvgrMkN5E/_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/creem/nizlPYWnvgrMkN5E/_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/creem/nizlPYWnvgrMkN5E/_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/creem/nizlPYWnvgrMkN5E/_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/creem/nizlPYWnvgrMkN5E/_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/creem/nizlPYWnvgrMkN5E/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Upgrade a subscription to a different product - Creem\">\u003cmeta data-mint-head property=\"og:description\" content=\"Upgrade a subscription to a different product or plan. Handle proration and plan changes seamlessly.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Creem Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.creem.io/api-reference/endpoint/upgrade-subscription\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://creem.mintlify.app/_mintlify/api/og/v2?division=Subscription\u0026amp;title=Upgrade+a+subscription+to+a+different+product\u0026amp;description=Upgrade+a+subscription+to+a+different+product+or+plan.+Handle+proration+and+plan+changes+seamlessly.\u0026amp;theme=cafe6ce3ebe1df8d45ed0a88\u0026amp;signature=49f447c72694acb8214d20eede7229ffbee7ae34292b2d461195706855ea4a76\">\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=\"Upgrade a subscription to a different product - Creem\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Upgrade a subscription to a different product or plan. Handle proration and plan changes seamlessly.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://creem.mintlify.app/_mintlify/api/og/v2?division=Subscription\u0026amp;title=Upgrade+a+subscription+to+a+different+product\u0026amp;description=Upgrade+a+subscription+to+a+different+product+or+plan.+Handle+proration+and+plan+changes+seamlessly.\u0026amp;theme=cafe6ce3ebe1df8d45ed0a88\u0026amp;signature=49f447c72694acb8214d20eede7229ffbee7ae34292b2d461195706855ea4a76\">\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/creem/nizlPYWnvgrMkN5E/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Creem\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FFBE98\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.creem.io/api-reference/endpoint/upgrade-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/endpoint/upgrade-subscription.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.creem.io/#organization\",\"name\":\"Creem\",\"url\":\"https://docs.creem.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/creem/-AIVGXbrCJu_8i70/logo/light.svg?fit=max\u0026auto=format\u0026n=-AIVGXbrCJu_8i70\u0026q=85\u0026s=686f06f43a3d7e4c0456e22de64c8bae\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.creem.io#website\",\"name\":\"Creem\",\"url\":\"https://docs.creem.io\",\"publisher\":{\"@id\":\"https://docs.creem.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.creem.io/api-reference/endpoint/upgrade-subscription#webpage\",\"url\":\"https://docs.creem.io/api-reference/endpoint/upgrade-subscription\",\"name\":\"Upgrade a subscription to a different product\",\"description\":\"Upgrade a subscription to a different product or plan. Handle proration and plan changes seamlessly.\",\"dateModified\":\"2026-01-23T08:23:03.693Z\",\"isPartOf\":{\"@id\":\"https://docs.creem.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.creem.io/api-reference/endpoint/upgrade-subscription#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.creem.io/api-reference/endpoint/upgrade-subscription#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Subscription\",\"item\":\"https://docs.creem.io/api-reference/endpoint/get-subscription\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Upgrade a subscription to a different product\",\"item\":\"https://docs.creem.io/api-reference/endpoint/upgrade-subscription\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.creem.io/api-reference/endpoint/upgrade-subscription#apireference\",\"headline\":\"Upgrade a subscription to a different product\",\"name\":\"Upgrade a subscription to a different product\",\"description\":\"Upgrade a subscription to a different product or plan. Handle proration and plan changes seamlessly.\",\"url\":\"https://docs.creem.io/api-reference/endpoint/upgrade-subscription\",\"mainEntityOfPage\":{\"@id\":\"https://docs.creem.io/api-reference/endpoint/upgrade-subscription#webpage\"},\"dateModified\":\"2026-01-23T08:23:03.693Z\",\"publisher\":{\"@id\":\"https://docs.creem.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.creem.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Creem\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Creem","nav":{"global":{"anchors":[{"anchor":"Community","icon":"discord","href":"https://discord.gg/q3GKZs92Av"},{"anchor":"Blog","icon":"newspaper","href":"https://creem.io/blog"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/getting-started/introduction"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","icon":"book","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Error Handling","href":"/api-reference/error-codes"}]},{"group":"Checkout","icon":"shopping-cart","pages":[{"title":"Creates a new checkout session","openapi":"post /v1/checkouts","href":"/api-reference/endpoint/create-checkout"},{"title":"Retrieve a checkout session","openapi":"get /v1/checkouts","href":"/api-reference/endpoint/get-checkout"}]},{"group":"Product","icon":"box","pages":[{"title":"Creates a new product","openapi":"post /v1/products","href":"/api-reference/endpoint/create-product"},{"title":"Get a product by ID","openapi":"get /v1/products/{id}","href":"/api-reference/endpoint/get-product"},{"title":"List all products","openapi":"get /v1/products/search","href":"/api-reference/endpoint/search-products"},{"title":"Update a product","openapi":"patch /v1/products/{id}","href":"/api-reference/endpoint/update-product"},{"title":"Archive a product","openapi":"delete /v1/products/{id}","href":"/api-reference/endpoint/archive-product"}]},{"group":"Customer","icon":"users","pages":[{"title":"Retrieve a customer","openapi":"get /v1/customers","href":"/api-reference/endpoint/get-customer"},{"title":"Update a customer","openapi":"patch /v1/customers","href":"/api-reference/endpoint/update-customer"},{"title":"List all customers","openapi":"get /v1/customers/list","href":"/api-reference/endpoint/list-customers"},{"title":"Generate Customer Links","openapi":"post /v1/customers/billing","href":"/api-reference/endpoint/create-customer-billing"}]},{"group":"Transactions","icon":"receipt","pages":[{"title":"Get a transaction by ID","openapi":"get /v1/transactions","href":"/api-reference/endpoint/get-transaction"},{"title":"List all transactions","openapi":"get /v1/transactions/search","href":"/api-reference/endpoint/get-transactions"},{"title":"Refund a payment","openapi":"post /v1/refunds","href":"/api-reference/endpoint/refund-payment"}]},{"group":"Affiliate","icon":"users","pages":[{"title":"List all affiliates","openapi":"get /v1/affiliates","href":"/api-reference/endpoint/list-affiliates"},{"title":"Retrieve an affiliate","openapi":"get /v1/affiliates/{id}","href":"/api-reference/endpoint/retrieve-affiliate"},{"title":"List affiliate commissions","openapi":"get /v1/affiliates/{id}/commissions","href":"/api-reference/endpoint/list-affiliate-commissions"},{"title":"Create an affiliate invitation","openapi":"post /v1/affiliates/invites","href":"/api-reference/endpoint/create-affiliate-invite"},{"title":"List affiliate invitations","openapi":"get /v1/affiliates/invites","href":"/api-reference/endpoint/list-affiliate-invites"}]},{"group":"License","icon":"key","pages":[{"title":"Validates a license key or instance","openapi":"post /v1/licenses/validate","href":"/api-reference/endpoint/validate-license"},{"title":"Activates a license key","openapi":"post /v1/licenses/activate","href":"/api-reference/endpoint/activate-license"},{"title":"Deactivate a license key instance","openapi":"post /v1/licenses/deactivate","href":"/api-reference/endpoint/deactivate-license"},{"title":"List license instances","openapi":"get /v1/licenses/{id}/instances","href":"/api-reference/endpoint/list-license-instances"}]},{"group":"Discount Code","icon":"tag","pages":[{"title":"Create a discount","openapi":"post /v1/discounts","href":"/api-reference/endpoint/create-discount-code"},{"title":"Delete a discount","openapi":"delete /v1/discounts/{id}/delete","href":"/api-reference/endpoint/delete-discount-code"},{"title":"Retrieve discount","openapi":"get /v1/discounts","href":"/api-reference/endpoint/get-discount-code"},{"title":"Search discounts","openapi":"get /v1/discounts/search","href":"/api-reference/endpoint/search-discounts"}]},{"group":"Subscription","icon":"repeat","pages":[{"title":"Retrieve a subscription","openapi":"get /v1/subscriptions","href":"/api-reference/endpoint/get-subscription"},{"title":"List all subscriptions","openapi":"get /v1/subscriptions/search","href":"/api-reference/endpoint/search-subscriptions"},{"title":"Update a subscription","description":"Modify subscription details like units, seats, or add-ons. Support proration and immediate billing options.","openapi":"post /v1/subscriptions/{id}","href":"/api-reference/endpoint/update-subscription"},{"title":"Upgrade a subscription to a different product","openapi":"post /v1/subscriptions/{id}/upgrade","href":"/api-reference/endpoint/upgrade-subscription"},{"title":"Pause a subscription","description":"Temporarily pause a subscription. Stop billing while retaining the subscription for later resumption.","openapi":"post /v1/subscriptions/{id}/pause","href":"/api-reference/endpoint/pause-subscription"},{"title":"Resume a subscription","openapi":"post /v1/subscriptions/{id}/resume","href":"/api-reference/endpoint/resume-subscription"},{"title":"Cancel a subscription","openapi":"post /v1/subscriptions/{id}/cancel","href":"/api-reference/endpoint/cancel-subscription"}]},{"group":"Splits","icon":"arrows-split-up-and-left","pages":[{"title":"Create a split","openapi":"post /v1/splits","href":"/api-reference/endpoint/create-split"},{"title":"List all splits","openapi":"get /v1/splits","href":"/api-reference/endpoint/list-splits"},{"title":"Retrieve a split","openapi":"get /v1/splits/{id}","href":"/api-reference/endpoint/retrieve-split"},{"title":"Delete a split","openapi":"delete /v1/splits/{id}","href":"/api-reference/endpoint/delete-split"}]},{"group":"Stats","icon":"chart-line","pages":[{"title":"Get store metrics summary","openapi":"get /v1/stats/summary","href":"/api-reference/endpoint/get-stats-summary"}]},{"group":"Customer Credits","icon":"coins","pages":[{"title":"Create a customer credits account","openapi":"post /v1/customer-credits/accounts","href":"/api-reference/endpoint/create-credits-account"},{"title":"List customer credits accounts","openapi":"get /v1/customer-credits/accounts","href":"/api-reference/endpoint/list-credits-accounts"},{"title":"Retrieve a customer credits account","openapi":"get /v1/customer-credits/accounts/{id}","href":"/api-reference/endpoint/get-credits-account"},{"title":"Get account balance","openapi":"get /v1/customer-credits/accounts/{id}/balance","href":"/api-reference/endpoint/get-credits-account-balance"},{"title":"List account entries","openapi":"get /v1/customer-credits/accounts/{id}/entries","href":"/api-reference/endpoint/list-credits-entries"},{"title":"Credit an account","openapi":"post /v1/customer-credits/accounts/{id}/credit","href":"/api-reference/endpoint/credit-account"},{"title":"Debit an account","openapi":"post /v1/customer-credits/accounts/{id}/debit","href":"/api-reference/endpoint/debit-account"},{"title":"Reverse a transaction","openapi":"post /v1/customer-credits/accounts/{id}/reverse","href":"/api-reference/endpoint/reverse-credits-transaction"},{"title":"Freeze an account","openapi":"post /v1/customer-credits/accounts/{id}/freeze","href":"/api-reference/endpoint/freeze-credits-account"},{"title":"Unfreeze an account","openapi":"post /v1/customer-credits/accounts/{id}/unfreeze","href":"/api-reference/endpoint/unfreeze-credits-account"},{"title":"Close an account","openapi":"post /v1/customer-credits/accounts/{id}/close","href":"/api-reference/endpoint/close-credits-account"},{"title":"Post a transaction","openapi":"post /v1/customer-credits/transactions","href":"/api-reference/endpoint/post-credits-transaction"},{"title":"Retrieve a transaction","openapi":"get /v1/customer-credits/transactions/{id}","href":"/api-reference/endpoint/get-credits-transaction"},{"title":"Reverse a transaction","openapi":"post /v1/customer-credits/transactions/{id}/reverse","href":"/api-reference/endpoint/reverse-credits-transaction-by-id"},{"title":"List transactions by reference","openapi":"get /v1/customer-credits/transactions","href":"/api-reference/endpoint/list-credits-transactions"}]},{"group":"Moderation","icon":"shield-check","pages":[{"title":"Screen a prompt","openapi":"post /v1/moderation/prompt","href":"/api-reference/endpoint/screen-prompt"}]},{"group":"Webhooks","icon":"webhook","pages":[{"title":"List webhook endpoints","openapi":"get /v1/webhooks","href":"/api-reference/endpoint/list-webhooks"},{"title":"Create a webhook endpoint","openapi":"post /v1/webhooks","href":"/api-reference/endpoint/create-webhook"},{"title":"Retrieve a webhook endpoint","openapi":"get /v1/webhooks/{id}","href":"/api-reference/endpoint/get-webhook"},{"title":"Update a webhook endpoint","openapi":"patch /v1/webhooks/{id}","href":"/api-reference/endpoint/update-webhook"},{"title":"Delete a webhook endpoint","openapi":"delete /v1/webhooks/{id}","href":"/api-reference/endpoint/delete-webhook"},{"title":"Retrieve a webhook signing secret","openapi":"get /v1/webhooks/{id}/secret","href":"/api-reference/endpoint/get-webhook-secret"},{"title":"List pending events for a CLI webhook endpoint","openapi":"get /v1/webhooks/{id}/events/pending","href":"/api-reference/endpoint/list-pending-webhook-events"},{"title":"Acknowledge a CLI webhook event","openapi":"post /v1/webhooks/{id}/events/{event_id}/ack","href":"/api-reference/endpoint/acknowledge-webhook-event"}]}]}]},"basePath":"","title":"Upgrade a subscription to a different product - Creem","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}