{
"message": "The requested resource was not found",
"error": "not_found"
}
{
"message": "The requested resource was not found",
"error": "not_found"
}
{
"message": "The requested resource was not found",
"error": "not_found"
}
{
"message": "The requested resource was not found",
"error": "not_found"
}
{
"message": "The requested resource was not found",
"error": "not_found"
}
{
"message": "The requested resource was not found",
"error": "not_found"
}
Authorizations
Authorization
string
header
required
API key authentication
Path Parameters
id
string
required
The unique identifier of the plan
Unique identifier for a plan
Pattern: ^plan_[a-zA-Z0-9]+$
Body
application/json
billingCadence
enum<string>
ISO 8601 duration for the billing period. Takes precedence over billingInterval when both are provided.
Available options:
P1M,
P3M,
P1Y
billingInterval
enum<string>
Recurring billing period frequency. Sample values: 'monthly' for monthly billing, 'quarterly' for quarterly billing, 'yearly' for annual billing
Available options:
monthly,
quarterly,
yearly,
annual
defaultTaxCode
string
Default tax code for plan line items. Common values: 'eservice' (electronically supplied services), 'saas' (software as a service), 'consulting', 'ebook', 'standard', 'reduced', 'exempt'. Full list available via GET /tax/codes endpoint.
defaultTaxRate
number
Fallback tax rate (as percentage) if automatic tax calculation is unavailable
description
string
Plan details explaining included features and limits. Sample values: 'Claude API access with 500K tokens monthly allowance', 'Unlimited cloud storage plus real-time analytics tools', 'Complete machine learning infrastructure with GPU access', 'Flexible usage-based pricing with no monthly commitment'
invoiceDisplayName
string
Plan name shown on billing statements. Sample values: 'LLM API Basic Plan', 'Data Warehouse Business', 'ML Platform Enterprise', 'Pay-Per-Use Model'
name
string
Plan identifier visible to customers. Sample values: 'Basic Tier', 'Business Package', 'Enterprise Solution', 'Metered Billing', 'Free Tier', 'Premium Access'
prices
string[]
Array of price IDs to associate with this plan
Unique identifier for a price
Pattern: ^price_[a-zA-Z0-9]+$
taxBehavior
enum<string>
Whether tax is added on top of the price (exclusive) or included in the price (inclusive)
Available options:
exclusive,
inclusive
renewalReminderEnabled
boolean
Whether to send renewal reminder emails to customers before their subscription renews
renewalReminderDays
integer
Number of days before renewal to send the reminder email
Required range: 1 <= x <= 30
billingAnchor
string<date-time> | null
ISO 8601 datetime reference point for billing period alignment. Must be in the past or present. Set to null to clear the anchor and revert to start-time-based anchoring.
creditAllocations
object[]
Credit-pool funding declarations for this plan. Each entry funds a distinct pricing unit's credit pool when a subscription to this plan activates: the allocated amount is minted as a credit grant on the customer's pool for that pricing unit, once at activation, or on a recurring basis only when that allocation explicitly sets recurrencePeriod. A plan may declare zero or more allocations; no two allocations on the same plan may target the same pricingUnitId.
Show child attributes
stablePriceIds
boolean
Governs price identity when a price is replaced by minting a new plan version and making it default. When true (default), replacing a price at make-default keeps the original price id live (its value changes) and the superseded value is preserved under a new id. When false, the replacement price's id goes live instead and the superseded value stays under the original id. Has no effect on this request's own prices field: prices carried over keep their ids, but swapping one price for another there moves the plan to the new price's id rather than keeping the original live.
versionTransition
object
When a move to a new plan version takes effect for this plan's subscriptions. end_of_current_period (the default) moves everything at the end of the current billing period. immediate changes entitlements at the move, in-arrears prices for the whole current period, and in-advance prices from the next period. Neither prorates.
Show child attributes
Response
Plan updated successfully
id
string
required
Unique identifier for a plan
Pattern: ^plan_[a-zA-Z0-9]+$
object
enum<string>
required
Available options:
plan
billingCadence
enum<string>
default:P1M
required
ISO 8601 duration for the billing period.
Available options:
P1M,
P3M,
P1Y
billingInterval
string
required
deprecated
Deprecated. Human-readable billing period derived from billingCadence. Use billingCadence instead.
createdAt
string<date-time>
required
currency
string
required
merchantId
string
required
The merchant organization that owns this plan
Pattern: ^org_[a-zA-Z0-9]+$
name
string
required
productId
string
required
The product this plan belongs to
Pattern: ^prod_[a-zA-Z0-9]+$
updatedAt
string<date-time>
required
versionTransition
object
required
When a move to a new plan version takes effect for this plan's subscriptions. end_of_current_period (the default) moves everything at the end of the current billing period. immediate changes entitlements at the move, in-arrears prices for the whole current period, and in-advance prices from the next period. Neither prorates.
Show child attributes
defaultTaxCode
string
Default tax code for plan line items. Common values: 'eservice' (electronically supplied services), 'saas' (software as a service), 'consulting', 'ebook', 'standard', 'reduced', 'exempt'. Full list available via GET /tax/codes endpoint.
defaultTaxRate
number
Fallback tax rate (as percentage) if automatic tax calculation is unavailable
deletedAt
string<date-time>
description
string
invoiceDisplayName
string
paymentTerm
object
Show child attributes
prices
object[]
Show child attributes
taxBehavior
enum<string>
Whether tax is added on top of the price (exclusive) or included in the price (inclusive)
Available options:
exclusive,
inclusive
walletNamespaceId
string
Unique identifier for a wallet namespace
renewalReminderEnabled
boolean
Whether renewal reminder emails are enabled for subscriptions using this plan
renewalReminderDays
integer
Number of days before renewal to send the reminder email
billingVersion
integer
Billing engine version. Managed by Paygentic support.
billingAnchor
string<date-time> | null
ISO 8601 datetime reference point for billing period alignment. Must be in the past or present at the time of creation or update. When set, subscriptions created under this plan align their first billing period to the next recurrence of this anchor, unless the create names its own billingAnchor. Null means each subscription uses its own start time (hour-rounded) as the anchor, unless the create names one.
creditAllocations
object[]
Credit-pool funding declarations for this plan. Each entry funds a distinct pricing unit's credit pool when a subscription to this plan activates: the allocated amount is minted as a credit grant on the customer's pool for that pricing unit, once at activation, or on a recurring basis only when that allocation explicitly sets recurrencePeriod. A plan may declare zero or more allocations; no two allocations on the same plan target the same pricingUnitId.
Show child attributes
defaultVersionId
string
The plan version currently served as the plan's live definition. New subscriptions pin to this version. Absent for plans that have never been versioned.
Pattern: ^pver_[a-zA-Z0-9]+$
stablePriceIds
boolean
default:true
Governs price identity when a price on this plan's default version is replaced. When true (default), replacing a price at make-default keeps the original price id live (its value changes) and the superseded value is preserved under a new id. When false, the replacement price's id goes live instead and the superseded value stays under the original id.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/schema.json","name":"Paygentic","colors":{"primary":"#013F70","light":"#E0B1F7","dark":"#FF6F57"},"logo":{"light":"https://mintcdn.com/paygentic/uUKYt4gDqyfhF9Y7/logo/paygentic-logo-light.svg?fit=max\u0026auto=format\u0026n=uUKYt4gDqyfhF9Y7\u0026q=85\u0026s=cb1fd6b59a3c44e357ecdc522849ab37","dark":"https://mintcdn.com/paygentic/uUKYt4gDqyfhF9Y7/logo/paygentic-logo-dark.svg?fit=max\u0026auto=format\u0026n=uUKYt4gDqyfhF9Y7\u0026q=85\u0026s=e472e905a55866be14a5e51b15f16db6"},"favicon":"https://mintcdn.com/paygentic/uUKYt4gDqyfhF9Y7/favicon.svg?fit=max\u0026auto=format\u0026n=uUKYt4gDqyfhF9Y7\u0026q=85\u0026s=a93d7819e80f48ee401156e695125f09","navbar":{"links":[{"href":"mailto:support@paygentic.io","label":"Support"}]},"fonts":{"heading":{"family":"Funnel Display"},"body":{"family":"Host Grotesk"}},"integrations":{"posthog":{"apiKey":"phc_DYYQW9UMuySBrmREkYbwieAfTzyvSpOJVFm1v9DQzyh","apiHost":"https://us.i.posthog.com"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"paygentic","hasAudioNarration":false,"actualSubdomain":"paygentic","customDomains":["docs.paygentic.io"],"gitSource":{"type":"github","owner":"paygentic","repo":"paygentic","deployBranch":"main","contentDirectory":"projects/docs","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6b027ed334aba046b8ae3628","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":161},{"language":"default","tag":"Documentation","count":42},{"language":"default","tag":"Platform","count":29},{"language":"default","tag":"Subscriptions","count":15},{"language":"default","tag":"Sources","count":14},{"language":"default","tag":"Invoices V2","count":12},{"language":"default","tag":"Billing","count":10},{"language":"default","tag":"Pricing","count":10},{"language":"default","tag":"Billing Schedules","count":9},{"language":"default","tag":"Orders","count":9}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[]}
{"page":{"pagePath":"api-reference/plans/update","slug":"/api-reference/plans/update","pageMetadata":{"title":"Update","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/plans/{id}","href":"/api-reference/plans/update","autogeneratedByOpenApi":true},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Update","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/plans/{id}","href":"/api-reference/plans/update","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Plans"],"summary":"Update","operationId":"updatePlan","requestBody":"bf86ce7b-22be-42c9-9bd9-68c99ddd5493","responses":{"200":"cd4ee7de-c199-4fac-ad35-c758bfd1556b","400":"1b02a1d9-430b-4fbe-847e-ca42fcd82f86","401":"1575c0ff-4e57-443e-81b2-d3783cae6463","403":"1b20ac1d-fe1d-479c-9dd8-00eca90f49bb","404":"2e9dd9db-7778-43f0-9e65-8e0f805a025f","409":"47024ca7-a7dc-4c79-8b97-2da9c8e9e9a7","500":"4c97d1cc-961a-4565-8ab3-d504481d5af1"},"x-permission":"plans:write","method":"patch","type":"path","servers":["7498f67e-c06f-4d11-9a4e-7c43f0f53b26","d0f74462-aeec-4209-82f4-dbb60498c1a2"],"security":["341ede1c-db03-4e32-b951-0c478552f430"],"path":"/v0/plans/{id}","baseUrlOptions":["https://api.paygentic.io","https://api.sandbox.paygentic.io"],"title":"Update","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"fb7dd810-a3e7-420e-b761-a6d76c7b4a69":{"name":"id","in":"path","required":true,"description":"The unique identifier of the plan","schema":{"type":"string","pattern":"^plan_[a-zA-Z0-9]+$","description":"The unique identifier of the plan\nUnique identifier for a plan","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"billingCadence":{"type":"string","enum":["P1M","P3M","P1Y"],"description":"ISO 8601 duration for the billing period. Takes precedence over billingInterval when both are provided.","uniqueKey":"billingCadence","typeLabel":"enum\u003cstring>"},"billingInterval":{"type":"string","enum":["monthly","quarterly","yearly","annual"],"description":"Recurring billing period frequency. Sample values: 'monthly' for monthly billing, 'quarterly' for quarterly billing, 'yearly' for annual billing","uniqueKey":"billingInterval","typeLabel":"enum\u003cstring>"},"defaultTaxCode":{"type":"string","description":"Default tax code for plan line items. Common values: 'eservice' (electronically supplied services), 'saas' (software as a service), 'consulting', 'ebook', 'standard', 'reduced', 'exempt'. Full list available via GET /tax/codes endpoint.","uniqueKey":"defaultTaxCode","typeLabel":"string"},"defaultTaxRate":{"type":"number","description":"Fallback tax rate (as percentage) if automatic tax calculation is unavailable","uniqueKey":"defaultTaxRate","typeLabel":"number"},"description":{"type":"string","description":"Plan details explaining included features and limits. Sample values: 'Claude API access with 500K tokens monthly allowance', 'Unlimited cloud storage plus real-time analytics tools', 'Complete machine learning infrastructure with GPU access', 'Flexible usage-based pricing with no monthly commitment'","uniqueKey":"description","typeLabel":"string"},"invoiceDisplayName":{"type":"string","description":"Plan name shown on billing statements. Sample values: 'LLM API Basic Plan', 'Data Warehouse Business', 'ML Platform Enterprise', 'Pay-Per-Use Model'","uniqueKey":"invoiceDisplayName","typeLabel":"string"},"name":{"type":"string","description":"Plan identifier visible to customers. Sample values: 'Basic Tier', 'Business Package', 'Enterprise Solution', 'Metered Billing', 'Free Tier', 'Premium Access'","uniqueKey":"name","typeLabel":"string"},"prices":{"type":"array","items":{"type":"string","pattern":"^price_[a-zA-Z0-9]+$","description":"Unique identifier for a price","uniqueKey":"prices.items.[INDEX]","typeLabel":"string"},"description":"Array of price IDs to associate with this plan","uniqueKey":"prices","typeLabel":"string[]"},"taxBehavior":{"type":"string","enum":["exclusive","inclusive"],"description":"Whether tax is added on top of the price (exclusive) or included in the price (inclusive)","uniqueKey":"taxBehavior","typeLabel":"enum\u003cstring>"},"renewalReminderEnabled":{"type":"boolean","description":"Whether to send renewal reminder emails to customers before their subscription renews","uniqueKey":"renewalReminderEnabled","typeLabel":"boolean"},"renewalReminderDays":{"type":"integer","description":"Number of days before renewal to send the reminder email","minimum":1,"maximum":30,"uniqueKey":"renewalReminderDays","typeLabel":"integer"},"billingAnchor":{"oneOf":[{"type":"string","format":"date-time","description":"ISO 8601 datetime reference point for billing period alignment. Must be in the past or present. Set to null to clear the anchor and revert to start-time-based anchoring.","uniqueKey":"billingAnchor.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"ISO 8601 datetime reference point for billing period alignment. Must be in the past or present. Set to null to clear the anchor and revert to start-time-based anchoring.","uniqueKey":"billingAnchor.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingAnchor","typeLabel":"string\u003cdate-time> | null"},"creditAllocations":{"type":"array","items":{"type":"object","required":["pricingUnitId","amount"],"properties":{"pricingUnitId":{"type":"string","pattern":"^pu_[a-zA-Z0-9]+$","description":"The pricing unit whose credit pool this allocation funds. Must belong to the plan's own merchant.","isRequired":true,"uniqueKey":"creditAllocations.items.[INDEX].pricingUnitId","typeLabel":"string"},"amount":{"type":"number","exclusiveMinimum":0,"description":"Number of credits minted into the customer's pool for this pricing unit each time the allocation is provisioned. Must be a positive number.","isRequired":true,"uniqueKey":"creditAllocations.items.[INDEX].amount","typeLabel":"number"},"recurrencePeriod":{"type":"string","description":"ISO 8601 duration (e.g. 'P1M') controlling how often the allocation's credits are re-minted on the customer's pool. Recurrence is opt-in: when omitted, the allocation is minted once at subscription activation and never refills — even on a recurring plan. Set this field explicitly for credits that should replenish each period.","uniqueKey":"creditAllocations.items.[INDEX].recurrencePeriod","typeLabel":"string"}},"uniqueKey":"creditAllocations.items.[INDEX]","typeLabel":"object"},"description":"Credit-pool funding declarations for this plan. Each entry funds a distinct pricing unit's credit pool when a subscription to this plan activates: the allocated amount is minted as a credit grant on the customer's pool for that pricing unit, once at activation, or on a recurring basis only when that allocation explicitly sets recurrencePeriod. A plan may declare zero or more allocations; no two allocations on the same plan may target the same pricingUnitId.","uniqueKey":"creditAllocations","typeLabel":"object[]"},"stablePriceIds":{"type":"boolean","description":"Governs price identity when a price is replaced by minting a new plan version and making it default. When true (default), replacing a price at make-default keeps the original price id live (its value changes) and the superseded value is preserved under a new id. When false, the replacement price's id goes live instead and the superseded value stays under the original id. Has no effect on this request's own prices field: prices carried over keep their ids, but swapping one price for another there moves the plan to the new price's id rather than keeping the original live.","uniqueKey":"stablePriceIds","typeLabel":"boolean"},"versionTransition":{"type":"object","required":["effectiveDate","proration"],"description":"When a move to a new plan version takes effect for this plan's subscriptions. `end_of_current_period` (the default) moves everything at the end of the current billing period. `immediate` changes entitlements at the move, in-arrears prices for the whole current period, and in-advance prices from the next period. Neither prorates.","properties":{"effectiveDate":{"type":"string","enum":["end_of_current_period","immediate"],"description":"When the move takes effect.","isRequired":true,"uniqueKey":"versionTransition.effectiveDate","typeLabel":"enum\u003cstring>"},"proration":{"type":"string","enum":["none"],"description":"How the current period is split. Only `none` is supported.","isRequired":true,"uniqueKey":"versionTransition.proration","typeLabel":"enum\u003cstring>"}},"uniqueKey":"versionTransition","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"defaultTaxCode":"\u003cstring>","defaultTaxRate":123,"description":"\u003cstring>","invoiceDisplayName":"\u003cstring>","name":"\u003cstring>","prices":["\u003cstring>"],"renewalReminderEnabled":true,"renewalReminderDays":15,"billingAnchor":"2023-11-07T05:31:56Z","creditAllocations":[{"pricingUnitId":"\u003cstring>","amount":123,"recurrencePeriod":"\u003cstring>"}],"stablePriceIds":true}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"cd4ee7de-c199-4fac-ad35-c758bfd1556b":{"description":"Plan updated successfully","content":{"application/json":{"schema":{"type":"object","required":["id","object","name","billingCadence","billingInterval","currency","merchantId","productId","createdAt","updatedAt","versionTransition"],"properties":{"id":{"type":"string","pattern":"^plan_[a-zA-Z0-9]+$","description":"Unique identifier for a plan","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"object":{"type":"string","enum":["plan"],"isRequired":true,"uniqueKey":"object","typeLabel":"enum\u003cstring>"},"billingCadence":{"type":"string","enum":["P1M","P3M","P1Y"],"description":"ISO 8601 duration for the billing period.","default":"P1M","isRequired":true,"uniqueKey":"billingCadence","typeLabel":"enum\u003cstring>"},"billingInterval":{"type":"string","deprecated":true,"x-speakeasy-deprecation-message":"Use billingCadence (ISO 8601 duration: P1M, P3M, P1Y) instead.","description":"Deprecated. Human-readable billing period derived from billingCadence. Use billingCadence instead.","isRequired":true,"uniqueKey":"billingInterval","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"currency":{"type":"string","isRequired":true,"uniqueKey":"currency","typeLabel":"string"},"merchantId":{"type":"string","pattern":"^org_[a-zA-Z0-9]+$","description":"The merchant organization that owns this plan","isRequired":true,"uniqueKey":"merchantId","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"productId":{"type":"string","pattern":"^prod_[a-zA-Z0-9]+$","description":"The product this plan belongs to","isRequired":true,"uniqueKey":"productId","typeLabel":"string"},"updatedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"versionTransition":{"type":"object","required":["effectiveDate","proration"],"description":"When a move to a new plan version takes effect for this plan's subscriptions. `end_of_current_period` (the default) moves everything at the end of the current billing period. `immediate` changes entitlements at the move, in-arrears prices for the whole current period, and in-advance prices from the next period. Neither prorates.","properties":{"effectiveDate":{"type":"string","enum":["end_of_current_period","immediate"],"description":"When the move takes effect.","isRequired":true,"uniqueKey":"versionTransition.effectiveDate","typeLabel":"enum\u003cstring>"},"proration":{"type":"string","enum":["none"],"description":"How the current period is split. Only `none` is supported.","isRequired":true,"uniqueKey":"versionTransition.proration","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"versionTransition","typeLabel":"object"},"defaultTaxCode":{"type":"string","description":"Default tax code for plan line items. Common values: 'eservice' (electronically supplied services), 'saas' (software as a service), 'consulting', 'ebook', 'standard', 'reduced', 'exempt'. Full list available via GET /tax/codes endpoint.","uniqueKey":"defaultTaxCode","typeLabel":"string"},"defaultTaxRate":{"type":"number","description":"Fallback tax rate (as percentage) if automatic tax calculation is unavailable","uniqueKey":"defaultTaxRate","typeLabel":"number"},"deletedAt":{"type":"string","format":"date-time","uniqueKey":"deletedAt","typeLabel":"string\u003cdate-time>"},"description":{"type":"string","uniqueKey":"description","typeLabel":"string"},"invoiceDisplayName":{"type":"string","uniqueKey":"invoiceDisplayName","typeLabel":"string"},"paymentTerm":{"type":"object","properties":{"in_arrears":{"type":"boolean","uniqueKey":"paymentTerm.in_arrears","typeLabel":"boolean"},"in_advance":{"type":"boolean","uniqueKey":"paymentTerm.in_advance","typeLabel":"boolean"}},"uniqueKey":"paymentTerm","typeLabel":"object"},"prices":{"type":"array","items":{"type":"object","required":["id","object","merchantId","model","paymentTerm","invoiceDisplayName","properties","createdAt","updatedAt","quantity","tax"],"properties":{"id":{"type":"string","pattern":"^price_[a-zA-Z0-9]+$","description":"Unique identifier for a price","isRequired":true,"uniqueKey":"prices.items.[INDEX].id","typeLabel":"string"},"object":{"type":"string","enum":["price"],"default":"price","isRequired":true,"uniqueKey":"prices.items.[INDEX].object","typeLabel":"enum\u003cstring>"},"merchantId":{"type":"string","pattern":"^org_[a-zA-Z0-9]+$","description":"The merchant organization that owns this price, derived from the associated fee or billable metric.","isRequired":true,"uniqueKey":"prices.items.[INDEX].merchantId","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"prices.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"invoiceDisplayName":{"type":"string","isRequired":true,"uniqueKey":"prices.items.[INDEX].invoiceDisplayName","typeLabel":"string"},"model":{"type":"string","enum":["standard","dynamic","volume","percentage"],"isRequired":true,"uniqueKey":"prices.items.[INDEX].model","typeLabel":"enum\u003cstring>"},"paymentTerm":{"type":"string","enum":["in_arrears","in_advance"],"isRequired":true,"uniqueKey":"prices.items.[INDEX].paymentTerm","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"prices.items.[INDEX].properties","typeLabel":"object"},"updatedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"prices.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"},"tax":{"type":"object","description":"A price's tax declaration. Optional on write — a price that declares nothing is `IN_SCOPE`, and is billed and taxed exactly as it was before this object existed. Always present on read. Replaced as a whole on update: send the object to change it, omit it to leave it alone.","required":["supplyScope"],"properties":{"supplyScope":{"type":"string","enum":["IN_SCOPE","OUTSIDE_SCOPE"],"description":"Whether this price's money is consideration for a supply — the one tax fact only you can state, because it is settled when you agree the deal rather than derived from what was sold. `IN_SCOPE` (the default) is consideration: it enters the taxable amount, positive as a charge or negative as a reduction in the price of the supply it applies to. `OUTSIDE_SCOPE` money is not consideration for anything, so it does not change the taxable amount, carries no tax, does not appear on the tax document, and nets into the amount payable after tax. This means \"not consideration for a supply\" — it does NOT mean \"a supply outside this jurisdiction\": exports and place-of-supply answers are worked out from the addresses on the sale by the tax provider, and are never declared on a price. How a supply is then classified — standard, zero-rated, exempt — is the tax provider's determination and is not set here either. Omit the whole `tax` object to leave a price in scope; there is deliberately no schema default on this property, so that a misspelt key is refused rather than silently defaulted.","isRequired":true,"uniqueKey":"prices.items.[INDEX].tax.supplyScope","typeLabel":"enum\u003cstring>"},"outsideScopeLabel":{"oneOf":[{"type":"string","enum":["CASHBACK",null],"description":"What an `OUTSIDE_SCOPE` amount is called in the invoice totals, so the wording follows the declaration rather than being retyped per price. Required when `supplyScope` is `OUTSIDE_SCOPE`, and rejected otherwise. `CASHBACK` is the only value today, and a price declaring it must use the `standard` model and must not carry a positive `unitPrice` — a cashback is money paid back, not charged.","uniqueKey":"prices.items.[INDEX].tax.outsideScopeLabel.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["CASHBACK",null],"description":"What an `OUTSIDE_SCOPE` amount is called in the invoice totals, so the wording follows the declaration rather than being retyped per price. Required when `supplyScope` is `OUTSIDE_SCOPE`, and rejected otherwise. `CASHBACK` is the only value today, and a price declaring it must use the `standard` model and must not carry a positive `unitPrice` — a cashback is money paid back, not charged.","uniqueKey":"prices.items.[INDEX].tax.outsideScopeLabel.oneOf.1","typeLabel":"null"}],"uniqueKey":"prices.items.[INDEX].tax.outsideScopeLabel","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"prices.items.[INDEX].tax","typeLabel":"object"},"quantity":{"type":"integer","minimum":1,"maximum":1000000,"default":1,"description":"Quantity used when generating invoice line items for this price. Total per period = quantity × unitPrice. Only supported for fee prices; metered prices derive quantity from usage. Defaults to 1.","isRequired":true,"uniqueKey":"prices.items.[INDEX].quantity","typeLabel":"integer"},"billableMetricId":{"type":"string","uniqueKey":"prices.items.[INDEX].billableMetricId","typeLabel":"string"},"feeId":{"type":"string","pattern":"^fee_[a-zA-Z0-9]+$","description":"The unique identifier for the fee referred to by this price","uniqueKey":"prices.items.[INDEX].feeId","typeLabel":"string"},"billingCadence":{"oneOf":[{"type":"string","description":"ISO 8601 duration for billing frequency (e.g., P1M for monthly)","uniqueKey":"prices.items.[INDEX].billingCadence.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO 8601 duration for billing frequency (e.g., P1M for monthly)","uniqueKey":"prices.items.[INDEX].billingCadence.oneOf.1","typeLabel":"null"}],"uniqueKey":"prices.items.[INDEX].billingCadence","typeLabel":"string | null"},"currency":{"type":"string","uniqueKey":"prices.items.[INDEX].currency","typeLabel":"string"},"description":{"type":"string","uniqueKey":"prices.items.[INDEX].description","typeLabel":"string"},"unitAmount":{"type":"string","uniqueKey":"prices.items.[INDEX].unitAmount","typeLabel":"string"},"features":{"type":"array","items":{"type":"object","required":["id","featureId","entitlementTemplate"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"prices.items.[INDEX].features.items.[INDEX].id","typeLabel":"string"},"featureId":{"type":"string","isRequired":true,"uniqueKey":"prices.items.[INDEX].features.items.[INDEX].featureId","typeLabel":"string"},"entitlementTemplate":{"type":"object","additionalProperties":true,"description":"The allowance this price declares for the feature. An empty object where the price attaches the feature without declaring one.","isRequired":true,"uniqueKey":"prices.items.[INDEX].features.items.[INDEX].entitlementTemplate","typeLabel":"object"},"feature":{"type":"object","properties":{"key":{"type":"string","uniqueKey":"prices.items.[INDEX].features.items.[INDEX].feature.key","typeLabel":"string"},"name":{"type":"string","uniqueKey":"prices.items.[INDEX].features.items.[INDEX].feature.name","typeLabel":"string"},"type":{"type":"string","enum":["metered","static","boolean"],"uniqueKey":"prices.items.[INDEX].features.items.[INDEX].feature.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"prices.items.[INDEX].features.items.[INDEX].feature","typeLabel":"object"}},"uniqueKey":"prices.items.[INDEX].features.items.[INDEX]","typeLabel":"object"},"description":"Features associated with this price","uniqueKey":"prices.items.[INDEX].features","typeLabel":"object[]"},"grantDiscountEnabled":{"type":"boolean","default":false,"description":"When true, grants applied to a subscription will discount usage charged by this price. Only supported for standard metered prices.","uniqueKey":"prices.items.[INDEX].grantDiscountEnabled","typeLabel":"boolean"},"isObligation":{"type":"boolean","default":false,"description":"A fixed amount owed whole rather than a per-period rate. An obligation is not prorated over a partial first period: when a subscription starts before its billing anchor, no truncated stub is billed and the first charge is the full amount at the next anchor. An obligation also refuses an interval boundary that falls strictly inside one of its own billing periods, since part of an amount owed whole is not a thing to bill. Defaults to false, which is a rate and is today's behaviour for every price. Not supported on a metered price, whose amount resolves from usage at close.","uniqueKey":"prices.items.[INDEX].isObligation","typeLabel":"boolean"},"rateType":{"type":"string","enum":["amount","proportion"],"default":"amount","description":"What properties.unitPrice is denominated in. 'amount' (the default) is an amount of the invoice currency for each unit metered, so the quantity is the multiplier. 'proportion' is the reverse: a dimensionless share of a currency-denominated quantity, so '0.02' is 2% and the invoice prints '2.00%'. Presentation only. Requires a standard metered price in real currency.","uniqueKey":"prices.items.[INDEX].rateType","typeLabel":"enum\u003cstring>"},"invoiceDisplayGroup":{"oneOf":[{"type":"string","description":"Presentation only. Prices sharing this value, within one billing period, print as a single row on the rendered invoice PDF and are described by this string. Every member still bills its own line item on the ledger, this API and the compliance document. The combined row's rate is derived from the members' own rates. Requires the 'standard' pricing model. Sample values: 'Cross Border Fees', 'FX Fees'","uniqueKey":"prices.items.[INDEX].invoiceDisplayGroup.oneOf.0","typeLabel":"string"},{"type":"null","description":"Presentation only. Prices sharing this value, within one billing period, print as a single row on the rendered invoice PDF and are described by this string. Every member still bills its own line item on the ledger, this API and the compliance document. The combined row's rate is derived from the members' own rates. Requires the 'standard' pricing model. Sample values: 'Cross Border Fees', 'FX Fees'","uniqueKey":"prices.items.[INDEX].invoiceDisplayGroup.oneOf.1","typeLabel":"null"}],"uniqueKey":"prices.items.[INDEX].invoiceDisplayGroup","typeLabel":"string | null"},"pricingUnitId":{"type":"string","pattern":"^pu_[a-zA-Z0-9]+$","description":"The pricing unit this price is denominated in (credits). Present when the price draws down a credit pool instead of charging real currency.","uniqueKey":"prices.items.[INDEX].pricingUnitId","typeLabel":"string"}},"uniqueKey":"prices.items.[INDEX]","typeLabel":"object"},"uniqueKey":"prices","typeLabel":"object[]"},"taxBehavior":{"type":"string","enum":["exclusive","inclusive"],"description":"Whether tax is added on top of the price (exclusive) or included in the price (inclusive)","uniqueKey":"taxBehavior","typeLabel":"enum\u003cstring>"},"walletNamespaceId":{"type":"string","description":"Unique identifier for a wallet namespace","uniqueKey":"walletNamespaceId","typeLabel":"string"},"renewalReminderEnabled":{"type":"boolean","description":"Whether renewal reminder emails are enabled for subscriptions using this plan","uniqueKey":"renewalReminderEnabled","typeLabel":"boolean"},"renewalReminderDays":{"type":"integer","description":"Number of days before renewal to send the reminder email","uniqueKey":"renewalReminderDays","typeLabel":"integer"},"billingVersion":{"type":"integer","description":"Billing engine version. Managed by Paygentic support.","uniqueKey":"billingVersion","typeLabel":"integer"},"billingAnchor":{"oneOf":[{"type":"string","format":"date-time","description":"ISO 8601 datetime reference point for billing period alignment. Must be in the past or present at the time of creation or update. When set, subscriptions created under this plan align their first billing period to the next recurrence of this anchor, unless the create names its own `billingAnchor`. Null means each subscription uses its own start time (hour-rounded) as the anchor, unless the create names one.","uniqueKey":"billingAnchor.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"ISO 8601 datetime reference point for billing period alignment. Must be in the past or present at the time of creation or update. When set, subscriptions created under this plan align their first billing period to the next recurrence of this anchor, unless the create names its own `billingAnchor`. Null means each subscription uses its own start time (hour-rounded) as the anchor, unless the create names one.","uniqueKey":"billingAnchor.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingAnchor","typeLabel":"string\u003cdate-time> | null"},"creditAllocations":{"type":"array","items":{"type":"object","required":["pricingUnitId","amount"],"properties":{"pricingUnitId":{"type":"string","pattern":"^pu_[a-zA-Z0-9]+$","description":"The pricing unit whose credit pool this allocation funds. Must belong to the plan's own merchant.","isRequired":true,"uniqueKey":"creditAllocations.items.[INDEX].pricingUnitId","typeLabel":"string"},"amount":{"type":"number","exclusiveMinimum":0,"description":"Number of credits minted into the customer's pool for this pricing unit each time the allocation is provisioned. Must be a positive number.","isRequired":true,"uniqueKey":"creditAllocations.items.[INDEX].amount","typeLabel":"number"},"recurrencePeriod":{"type":"string","description":"ISO 8601 duration (e.g. 'P1M') controlling how often the allocation's credits are re-minted on the customer's pool. Recurrence is opt-in: when omitted, the allocation is minted once at subscription activation and never refills — even on a recurring plan. Set this field explicitly for credits that should replenish each period.","uniqueKey":"creditAllocations.items.[INDEX].recurrencePeriod","typeLabel":"string"}},"uniqueKey":"creditAllocations.items.[INDEX]","typeLabel":"object"},"description":"Credit-pool funding declarations for this plan. Each entry funds a distinct pricing unit's credit pool when a subscription to this plan activates: the allocated amount is minted as a credit grant on the customer's pool for that pricing unit, once at activation, or on a recurring basis only when that allocation explicitly sets recurrencePeriod. A plan may declare zero or more allocations; no two allocations on the same plan target the same pricingUnitId.","uniqueKey":"creditAllocations","typeLabel":"object[]"},"defaultVersionId":{"type":"string","pattern":"^pver_[a-zA-Z0-9]+$","description":"The plan version currently served as the plan's live definition. New subscriptions pin to this version. Absent for plans that have never been versioned.","uniqueKey":"defaultVersionId","typeLabel":"string"},"stablePriceIds":{"type":"boolean","default":true,"description":"Governs price identity when a price on this plan's default version is replaced. When true (default), replacing a price at make-default keeps the original price id live (its value changes) and the superseded value is preserved under a new id. When false, the replacement price's id goes live instead and the superseded value stays under the original id.","uniqueKey":"stablePriceIds","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"example":{"id":"plan_f3g4h5i6j7k8l9m0","object":"plan","billingCadence":"P1Y","billingInterval":"yearly","createdAt":"2024-01-20T09:00:00Z","currency":"USD","defaultTaxCode":"eservice","defaultTaxRate":8.5,"description":"Complete machine learning infrastructure with GPU access","invoiceDisplayName":"ML Platform Enterprise","merchantId":"org_n1o2p3q4r5s6t7u8","name":"Enterprise Solution","prices":["price_d7e8f9g0h1i2j3k4"],"productId":"prod_v9w0x1y2z3a4b5c6","taxBehavior":"exclusive","updatedAt":"2024-03-01T15:30:00Z"},"examples":{"Example":{"title":"Example","value":{"id":"plan_f3g4h5i6j7k8l9m0","object":"plan","billingCadence":"P1Y","billingInterval":"yearly","createdAt":"2024-01-20T09:00:00Z","currency":"USD","defaultTaxCode":"eservice","defaultTaxRate":8.5,"description":"Complete machine learning infrastructure with GPU access","invoiceDisplayName":"ML Platform Enterprise","merchantId":"org_n1o2p3q4r5s6t7u8","name":"Enterprise Solution","prices":["price_d7e8f9g0h1i2j3k4"],"productId":"prod_v9w0x1y2z3a4b5c6","taxBehavior":"exclusive","updatedAt":"2024-03-01T15:30:00Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"1b02a1d9-430b-4fbe-847e-ca42fcd82f86":{"description":"Bad Request - The request could not be understood or was missing required parameters","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["message"],"example":{"message":"The requested resource was not found","error":"not_found"},"properties":{"message":{"type":"string","description":"Human-readable error message. Clients must not parse this field programmatically.","isRequired":true,"uniqueKey":"oneOf.0.message","typeLabel":"string"},"error":{"type":"string","description":"Coarse HTTP error category (e.g. 'bad_request', 'forbidden'). Maps to the HTTP status code.","uniqueKey":"oneOf.0.error","typeLabel":"string"},"code":{"type":"string","examples":["TAX_NOT_ENABLED","PAYMENT_SESSION_EXPIRED"],"description":"Optional semantic business error code for machine-readable discrimination (e.g. 'TAX_NOT_ENABLED'). UPPER_SNAKE_CASE. Clients should check this field, not message.","uniqueKey":"oneOf.0.code","typeLabel":"string"},"details":{"type":"object","description":"Additional error details","additionalProperties":true,"uniqueKey":"oneOf.0.details","typeLabel":"object"},"reason":{"type":"string","enum":["no_permission","insufficient_scope","not_member"],"description":"Present on a 403 from the authorization check. Says why access was refused: the caller has no role that grants the permission, the OAuth token lacks the scope, or the caller is not a member of the organization.","uniqueKey":"oneOf.0.reason","typeLabel":"enum\u003cstring>"},"requiredPermissions":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.requiredPermissions.items.[INDEX]","typeLabel":"string"},"description":"Present on a 403 from the authorization check. The permissions the caller needs for this request.","uniqueKey":"oneOf.0.requiredPermissions","typeLabel":"string[]"},"requestId":{"type":"string","description":"Identifies this request in our logs. Include it when you contact support. Also sent in the `request-id` response header.","examples":["105445aa7843bc8bf206b12000100000"],"uniqueKey":"oneOf.0.requestId","typeLabel":"string"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["message","errors"],"example":{"message":"Validation failed","error":"validation_error","errors":[{"field":"email","message":"Invalid email format","code":"invalid_format"}]},"properties":{"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"oneOf.1.message","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"The field that failed validation","isRequired":true,"uniqueKey":"oneOf.1.errors.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","description":"Validation error message for this field","isRequired":true,"uniqueKey":"oneOf.1.errors.items.[INDEX].message","typeLabel":"string"},"code":{"type":"string","description":"Validation error code","uniqueKey":"oneOf.1.errors.items.[INDEX].code","typeLabel":"string"}},"required":["field","message"],"uniqueKey":"oneOf.1.errors.items.[INDEX]","typeLabel":"object"},"description":"Array of field-specific validation errors","isRequired":true,"uniqueKey":"oneOf.1.errors","typeLabel":"object[]"},"error":{"type":"string","enum":["validation_error"],"default":"validation_error","description":"Error type indicating validation failure","uniqueKey":"oneOf.1.error","typeLabel":"enum\u003cstring>"},"requestId":{"type":"string","description":"Identifies this request in our logs. Include it when you contact support. Also sent in the `request-id` response header.","examples":["105445aa7843bc8bf206b12000100000"],"uniqueKey":"oneOf.1.requestId","typeLabel":"string"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"The requested resource was not found","error":"not_found"}}},"exampleType":"generated"}},"exampleType":"generated"},"1575c0ff-4e57-443e-81b2-d3783cae6463":{"description":"Unauthorized - Authentication failed or user does not have permissions","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Human-readable error message. Clients must not parse this field programmatically.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","description":"Coarse HTTP error category (e.g. 'bad_request', 'forbidden'). Maps to the HTTP status code.","uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","examples":["TAX_NOT_ENABLED","PAYMENT_SESSION_EXPIRED"],"description":"Optional semantic business error code for machine-readable discrimination (e.g. 'TAX_NOT_ENABLED'). UPPER_SNAKE_CASE. Clients should check this field, not message.","uniqueKey":"code","typeLabel":"string"},"details":{"type":"object","description":"Additional error details","additionalProperties":true,"uniqueKey":"details","typeLabel":"object"},"reason":{"type":"string","enum":["no_permission","insufficient_scope","not_member"],"description":"Present on a 403 from the authorization check. Says why access was refused: the caller has no role that grants the permission, the OAuth token lacks the scope, or the caller is not a member of the organization.","uniqueKey":"reason","typeLabel":"enum\u003cstring>"},"requiredPermissions":{"type":"array","items":{"type":"string","uniqueKey":"requiredPermissions.items.[INDEX]","typeLabel":"string"},"description":"Present on a 403 from the authorization check. The permissions the caller needs for this request.","uniqueKey":"requiredPermissions","typeLabel":"string[]"},"requestId":{"type":"string","description":"Identifies this request in our logs. Include it when you contact support. Also sent in the `request-id` response header.","examples":["105445aa7843bc8bf206b12000100000"],"uniqueKey":"requestId","typeLabel":"string"}},"example":{"message":"The requested resource was not found","error":"not_found"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"The requested resource was not found","error":"not_found"}}},"exampleType":"generated"}},"exampleType":"generated"},"1b20ac1d-fe1d-479c-9dd8-00eca90f49bb":{"description":"Forbidden - Request is understood but refused","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Human-readable error message. Clients must not parse this field programmatically.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","description":"Coarse HTTP error category (e.g. 'bad_request', 'forbidden'). Maps to the HTTP status code.","uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","examples":["TAX_NOT_ENABLED","PAYMENT_SESSION_EXPIRED"],"description":"Optional semantic business error code for machine-readable discrimination (e.g. 'TAX_NOT_ENABLED'). UPPER_SNAKE_CASE. Clients should check this field, not message.","uniqueKey":"code","typeLabel":"string"},"details":{"type":"object","description":"Additional error details","additionalProperties":true,"uniqueKey":"details","typeLabel":"object"},"reason":{"type":"string","enum":["no_permission","insufficient_scope","not_member"],"description":"Present on a 403 from the authorization check. Says why access was refused: the caller has no role that grants the permission, the OAuth token lacks the scope, or the caller is not a member of the organization.","uniqueKey":"reason","typeLabel":"enum\u003cstring>"},"requiredPermissions":{"type":"array","items":{"type":"string","uniqueKey":"requiredPermissions.items.[INDEX]","typeLabel":"string"},"description":"Present on a 403 from the authorization check. The permissions the caller needs for this request.","uniqueKey":"requiredPermissions","typeLabel":"string[]"},"requestId":{"type":"string","description":"Identifies this request in our logs. Include it when you contact support. Also sent in the `request-id` response header.","examples":["105445aa7843bc8bf206b12000100000"],"uniqueKey":"requestId","typeLabel":"string"}},"example":{"message":"The requested resource was not found","error":"not_found"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"The requested resource was not found","error":"not_found"}}},"exampleType":"generated"}},"exampleType":"generated"},"2e9dd9db-7778-43f0-9e65-8e0f805a025f":{"description":"Not Found - The requested resource could not be found","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Human-readable error message. Clients must not parse this field programmatically.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","description":"Coarse HTTP error category (e.g. 'bad_request', 'forbidden'). Maps to the HTTP status code.","uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","examples":["TAX_NOT_ENABLED","PAYMENT_SESSION_EXPIRED"],"description":"Optional semantic business error code for machine-readable discrimination (e.g. 'TAX_NOT_ENABLED'). UPPER_SNAKE_CASE. Clients should check this field, not message.","uniqueKey":"code","typeLabel":"string"},"details":{"type":"object","description":"Additional error details","additionalProperties":true,"uniqueKey":"details","typeLabel":"object"},"reason":{"type":"string","enum":["no_permission","insufficient_scope","not_member"],"description":"Present on a 403 from the authorization check. Says why access was refused: the caller has no role that grants the permission, the OAuth token lacks the scope, or the caller is not a member of the organization.","uniqueKey":"reason","typeLabel":"enum\u003cstring>"},"requiredPermissions":{"type":"array","items":{"type":"string","uniqueKey":"requiredPermissions.items.[INDEX]","typeLabel":"string"},"description":"Present on a 403 from the authorization check. The permissions the caller needs for this request.","uniqueKey":"requiredPermissions","typeLabel":"string[]"},"requestId":{"type":"string","description":"Identifies this request in our logs. Include it when you contact support. Also sent in the `request-id` response header.","examples":["105445aa7843bc8bf206b12000100000"],"uniqueKey":"requestId","typeLabel":"string"}},"example":{"message":"The requested resource was not found","error":"not_found"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"The requested resource was not found","error":"not_found"}}},"exampleType":"generated"}},"exampleType":"generated"},"47024ca7-a7dc-4c79-8b97-2da9c8e9e9a7":{"description":"Conflict - The request conflicts with the current state of the resource","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Human-readable error message. Clients must not parse this field programmatically.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","description":"Coarse HTTP error category (e.g. 'bad_request', 'forbidden'). Maps to the HTTP status code.","uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","examples":["TAX_NOT_ENABLED","PAYMENT_SESSION_EXPIRED"],"description":"Optional semantic business error code for machine-readable discrimination (e.g. 'TAX_NOT_ENABLED'). UPPER_SNAKE_CASE. Clients should check this field, not message.","uniqueKey":"code","typeLabel":"string"},"details":{"type":"object","description":"Additional error details","additionalProperties":true,"uniqueKey":"details","typeLabel":"object"},"reason":{"type":"string","enum":["no_permission","insufficient_scope","not_member"],"description":"Present on a 403 from the authorization check. Says why access was refused: the caller has no role that grants the permission, the OAuth token lacks the scope, or the caller is not a member of the organization.","uniqueKey":"reason","typeLabel":"enum\u003cstring>"},"requiredPermissions":{"type":"array","items":{"type":"string","uniqueKey":"requiredPermissions.items.[INDEX]","typeLabel":"string"},"description":"Present on a 403 from the authorization check. The permissions the caller needs for this request.","uniqueKey":"requiredPermissions","typeLabel":"string[]"},"requestId":{"type":"string","description":"Identifies this request in our logs. Include it when you contact support. Also sent in the `request-id` response header.","examples":["105445aa7843bc8bf206b12000100000"],"uniqueKey":"requestId","typeLabel":"string"}},"example":{"message":"The requested resource was not found","error":"not_found"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"The requested resource was not found","error":"not_found"}}},"exampleType":"generated"}},"exampleType":"generated"},"4c97d1cc-961a-4565-8ab3-d504481d5af1":{"description":"Internal Server Error - Something went wrong on the server side","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Human-readable error message. Clients must not parse this field programmatically.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","description":"Coarse HTTP error category (e.g. 'bad_request', 'forbidden'). Maps to the HTTP status code.","uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","examples":["TAX_NOT_ENABLED","PAYMENT_SESSION_EXPIRED"],"description":"Optional semantic business error code for machine-readable discrimination (e.g. 'TAX_NOT_ENABLED'). UPPER_SNAKE_CASE. Clients should check this field, not message.","uniqueKey":"code","typeLabel":"string"},"details":{"type":"object","description":"Additional error details","additionalProperties":true,"uniqueKey":"details","typeLabel":"object"},"reason":{"type":"string","enum":["no_permission","insufficient_scope","not_member"],"description":"Present on a 403 from the authorization check. Says why access was refused: the caller has no role that grants the permission, the OAuth token lacks the scope, or the caller is not a member of the organization.","uniqueKey":"reason","typeLabel":"enum\u003cstring>"},"requiredPermissions":{"type":"array","items":{"type":"string","uniqueKey":"requiredPermissions.items.[INDEX]","typeLabel":"string"},"description":"Present on a 403 from the authorization check. The permissions the caller needs for this request.","uniqueKey":"requiredPermissions","typeLabel":"string[]"},"requestId":{"type":"string","description":"Identifies this request in our logs. Include it when you contact support. Also sent in the `request-id` response header.","examples":["105445aa7843bc8bf206b12000100000"],"uniqueKey":"requestId","typeLabel":"string"}},"example":{"message":"The requested resource was not found","error":"not_found"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"The requested resource was not found","error":"not_found"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"341ede1c-db03-4e32-b951-0c478552f430":{"BearerAuth":{"type":"http","scheme":"bearer","description":"API key authentication","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"7498f67e-c06f-4d11-9a4e-7c43f0f53b26":{"url":"https://api.paygentic.io","description":"Production API"},"d0f74462-aeec-4209-82f4-dbb60498c1a2":{"url":"https://api.sandbox.paygentic.io","description":"Sandbox API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"API key authentication","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"API key authentication","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"paygentic","siteName":"Paygentic","title":"Update - Paygentic","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-22T01:05:01.682Z","originalFileLocation":"api-reference/plans/update.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=\"application-name\" content=\"Paygentic\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/paygentic/u-_iNQrPo4YcRgQd/_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/paygentic/u-_iNQrPo4YcRgQd/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/paygentic/u-_iNQrPo4YcRgQd/_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/paygentic/u-_iNQrPo4YcRgQd/_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/paygentic/u-_iNQrPo4YcRgQd/_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/paygentic/u-_iNQrPo4YcRgQd/_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/paygentic/u-_iNQrPo4YcRgQd/_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/paygentic/u-_iNQrPo4YcRgQd/_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/paygentic/u-_iNQrPo4YcRgQd/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update - Paygentic\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Paygentic\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.paygentic.io/api-reference/plans/update\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://paygentic.mintlify.site/_mintlify/api/og/v2?division=Plans\u0026amp;title=Update\u0026amp;theme=6ad1713123e6dfef0529ce98\u0026amp;signature=071799329afc8c66b33b757e4b3ece18d1925442127030bc7b090492895ad24f\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update - Paygentic\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://paygentic.mintlify.site/_mintlify/api/og/v2?division=Plans\u0026amp;title=Update\u0026amp;theme=6ad1713123e6dfef0529ce98\u0026amp;signature=071799329afc8c66b33b757e4b3ece18d1925442127030bc7b090492895ad24f\">\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/paygentic/u-_iNQrPo4YcRgQd/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Paygentic\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#013F70\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.paygentic.io/api-reference/plans/update\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/plans/update.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.paygentic.io/#organization\",\"name\":\"Paygentic\",\"url\":\"https://docs.paygentic.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/paygentic/uUKYt4gDqyfhF9Y7/logo/paygentic-logo-light.svg?fit=max\u0026auto=format\u0026n=uUKYt4gDqyfhF9Y7\u0026q=85\u0026s=cb1fd6b59a3c44e357ecdc522849ab37\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.paygentic.io#website\",\"name\":\"Paygentic\",\"url\":\"https://docs.paygentic.io\",\"publisher\":{\"@id\":\"https://docs.paygentic.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.paygentic.io/api-reference/plans/update#webpage\",\"url\":\"https://docs.paygentic.io/api-reference/plans/update\",\"name\":\"Update\",\"dateModified\":\"2026-11-22T01:05:01.682Z\",\"isPartOf\":{\"@id\":\"https://docs.paygentic.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.paygentic.io/api-reference/plans/update#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.paygentic.io/api-reference/plans/update#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Plans\",\"item\":\"https://docs.paygentic.io/api-reference/plans/list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update\",\"item\":\"https://docs.paygentic.io/api-reference/plans/update\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.paygentic.io/api-reference/plans/update#apireference\",\"headline\":\"Update\",\"name\":\"Update\",\"url\":\"https://docs.paygentic.io/api-reference/plans/update\",\"mainEntityOfPage\":{\"@id\":\"https://docs.paygentic.io/api-reference/plans/update#webpage\"},\"dateModified\":\"2026-11-22T01:05:01.682Z\",\"publisher\":{\"@id\":\"https://docs.paygentic.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.paygentic.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Paygentic\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Paygentic\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/plans/update.md","siteName":"Paygentic","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/getting-started/introduction"}]},{"tab":"API Reference","groups":[{"group":"Me","pages":[{"title":"Get the caller","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/me","href":"/api-reference/me/get-the-caller"}]},{"group":"Billable Metrics","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/billableMetrics","href":"/api-reference/billable-metrics/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/billableMetrics","href":"/api-reference/billable-metrics/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/billableMetrics/{id}","href":"/api-reference/billable-metrics/get"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/billableMetrics/{id}","href":"/api-reference/billable-metrics/update"},{"title":"Query Meter Usage","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/billableMetrics/{id}/meter","href":"/api-reference/billable-metrics/query-meter-usage"},{"title":"List Meter Events","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/billableMetrics/{id}/events","href":"/api-reference/billable-metrics/list-meter-events"}]},{"group":"Customers","pages":[{"title":"List by Merchant","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/customers","href":"/api-reference/customers/list-by-merchant"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/customers","href":"/api-reference/customers/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/customers/{id}","href":"/api-reference/customers/get"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/customers/{id}","href":"/api-reference/customers/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/customers/{id}","href":"/api-reference/customers/update"},{"title":"List payment methods","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/customers/{id}/paymentMethods","href":"/api-reference/customers/list-payment-methods"},{"title":"Set up a payment method","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/customers/{id}/paymentMethods","href":"/api-reference/customers/set-up-a-payment-method"}]},{"group":"Entitlements","pages":[{"title":"List Entitlements","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/entitlements","href":"/api-reference/entitlements/list-entitlements"},{"title":"Issue Entitlement","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/entitlements","href":"/api-reference/entitlements/issue-entitlement"},{"title":"Get Entitlement","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/entitlements/{entitlementId}","href":"/api-reference/entitlements/get-entitlement"}]},{"group":"Grants","pages":[{"title":"List Grants","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/entitlements/{entitlementId}/grants","href":"/api-reference/grants/list-grants"},{"title":"Create Grant","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/entitlements/{entitlementId}/grants","href":"/api-reference/grants/create-grant"},{"title":"Purchase Grant","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/entitlements/{entitlementId}/grants/purchase","href":"/api-reference/grants/purchase-grant"},{"title":"Get Grant","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/entitlements/{entitlementId}/grants/{grantId}","href":"/api-reference/grants/get-grant"},{"title":"Void Grant","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/entitlements/{entitlementId}/grants/{grantId}","href":"/api-reference/grants/void-grant"}]},{"group":"Features","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/features","href":"/api-reference/features/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/features","href":"/api-reference/features/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/features/{id}","href":"/api-reference/features/get"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/features/{id}","href":"/api-reference/features/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/features/{id}","href":"/api-reference/features/update"}]},{"group":"Fees","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/fees","href":"/api-reference/fees/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/fees","href":"/api-reference/fees/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/fees/{id}","href":"/api-reference/fees/get"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/fees/{id}","href":"/api-reference/fees/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/fees/{id}","href":"/api-reference/fees/update"}]},{"group":"Plans","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/plans","href":"/api-reference/plans/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/plans","href":"/api-reference/plans/create"},{"title":"List Available Plans","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/plans/available","href":"/api-reference/plans/list-available-plans"},{"title":"Get","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json get /v0/plans/{id}","href":"/api-reference/plans/get"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/plans/{id}","href":"/api-reference/plans/update"},{"title":"List versions","description":"List the versions of a plan, newest first. Only accounts that can manage this plan may list its versions; versions can expose in-progress pricing, so read-only access is not sufficient.","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/plans/{id}/versions","href":"/api-reference/plans/list-versions"},{"title":"Mint a plan version","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/plans/{id}/versions","href":"/api-reference/plans/mint-a-plan-version"},{"title":"Get a version","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/plans/{id}/versions/{versionNumber}","href":"/api-reference/plans/get-a-version"},{"title":"Set the default version","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/plans/{id}/versions/{versionNumber}","href":"/api-reference/plans/set-the-default-version"}]},{"group":"Prices","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/prices","href":"/api-reference/prices/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/prices","href":"/api-reference/prices/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/prices/{id}","href":"/api-reference/prices/get"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/prices/{id}","href":"/api-reference/prices/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/prices/{id}","href":"/api-reference/prices/update"}]},{"group":"Products","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/products","href":"/api-reference/products/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/products","href":"/api-reference/products/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/products/{id}","href":"/api-reference/products/get"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/products/{id}","href":"/api-reference/products/update"}]},{"group":"Sources","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/sources","href":"/api-reference/sources/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/sources","href":"/api-reference/sources/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/sources/{id}","href":"/api-reference/sources/get"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/sources/{id}","href":"/api-reference/sources/update"},{"title":"List Events","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/sources/{id}/events","href":"/api-reference/sources/list-events"},{"title":"Approve","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/sources/{id}/events/{eventId}/approve","href":"/api-reference/sources/approve"},{"title":"Reject","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/sources/{id}/events/{eventId}/reject","href":"/api-reference/sources/reject"},{"title":"Bulk Approve","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/sources/{id}/events/bulk-approve","href":"/api-reference/sources/bulk-approve"},{"title":"Bulk Reject","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/sources/{id}/events/bulk-reject","href":"/api-reference/sources/bulk-reject"},{"title":"List Rules","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/sourceRules","href":"/api-reference/sources/list-rules"},{"title":"Create Rule","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/sourceRules","href":"/api-reference/sources/create-rule"},{"title":"Get Rule","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/sourceRules/{ruleId}","href":"/api-reference/sources/get-rule"},{"title":"Delete Rule","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/sourceRules/{ruleId}","href":"/api-reference/sources/delete-rule"},{"title":"Update Rule","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/sourceRules/{ruleId}","href":"/api-reference/sources/update-rule"}]},{"group":"Subscriptions","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/subscriptions","href":"/api-reference/subscriptions/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/subscriptions","href":"/api-reference/subscriptions/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/subscriptions/{id}","href":"/api-reference/subscriptions/get"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/subscriptions/{id}","href":"/api-reference/subscriptions/update"},{"title":"Get Price Intervals","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/subscriptions/{id}/intervals","href":"/api-reference/subscriptions/get-price-intervals"},{"title":"Edit Price Intervals","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/subscriptions/{id}/intervals","href":"/api-reference/subscriptions/edit-price-intervals"},{"title":"Migrate To A Plan Version","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/subscriptions/{id}/versionMigration","href":"/api-reference/subscriptions/migrate-to-a-plan-version"},{"title":"List Interval Changes","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/subscriptions/{id}/intervalChanges","href":"/api-reference/subscriptions/list-interval-changes"},{"title":"List Merchant Interval Changes","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/intervalChanges","href":"/api-reference/subscriptions/list-merchant-interval-changes"},{"title":"Generate Portal Link","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/subscriptions/{id}/portal","href":"/api-reference/subscriptions/generate-portal-link"},{"title":"Terminate","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/subscriptions/{id}/termination","href":"/api-reference/subscriptions/terminate"},{"title":"Reconcile Features","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/subscriptions/{id}/reconciliations","href":"/api-reference/subscriptions/reconcile-features"},{"title":"List Adjustments","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/subscriptions/{id}/adjustments","href":"/api-reference/subscriptions/list-adjustments"},{"title":"Create Adjustment","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/subscriptions/{id}/adjustments","href":"/api-reference/subscriptions/create-adjustment"},{"title":"Delete Adjustment","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/subscriptions/{id}/adjustments/{adjustmentId}","href":"/api-reference/subscriptions/delete-adjustment"}]},{"group":"Subscription Proposals","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/subscriptionProposals","href":"/api-reference/subscription-proposals/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/subscriptionProposals","href":"/api-reference/subscription-proposals/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/subscriptionProposals/{id}","href":"/api-reference/subscription-proposals/get"},{"title":"Amend","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/subscriptionProposals/{id}","href":"/api-reference/subscription-proposals/amend"},{"title":"Approve or reject","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/subscriptionProposals/{id}/decision","href":"/api-reference/subscription-proposals/approve-or-reject"},{"title":"List projected","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/subscriptionProposals/{id}/projected","href":"/api-reference/subscription-proposals/list-projected"}]},{"group":"Users","pages":[{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/users/{id}","href":"/api-reference/users/get"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/users/{id}","href":"/api-reference/users/update"}]},{"group":"Invoices V2","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/invoices","href":"/api-reference/invoices-v2/list"},{"title":"List Line Items","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/invoices/lineItems","href":"/api-reference/invoices-v2/list-line-items"},{"title":"Create Manual Line Item","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/invoices/lineItems","href":"/api-reference/invoices-v2/create-manual-line-item"},{"title":"List projected","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/invoices/projected","href":"/api-reference/invoices-v2/list-projected"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/invoices/{id}","href":"/api-reference/invoices-v2/get"},{"title":"Get Line Items","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/invoices/{id}/lineItems","href":"/api-reference/invoices-v2/get-line-items"},{"title":"Download Invoice PDF","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/invoices/{id}/pdf","href":"/api-reference/invoices-v2/download-invoice-pdf"},{"title":"Settle Invoice Payment","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/invoices/{id}/payment","href":"/api-reference/invoices-v2/settle-invoice-payment"},{"title":"List Invoice Refunds","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/invoices/{id}/refunds","href":"/api-reference/invoices-v2/list-invoice-refunds"},{"title":"Refund Invoice","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/invoices/{id}/refunds","href":"/api-reference/invoices-v2/refund-invoice"},{"title":"Void Invoice Refund","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/invoices/{id}/refunds/{refundId}/void","href":"/api-reference/invoices-v2/void-invoice-refund"},{"title":"Retry Payment","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/invoices/{id}/retryPayment","href":"/api-reference/invoices-v2/retry-payment"}]},{"group":"Payments","pages":[{"title":"List Payments","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/payments","href":"/api-reference/payments/list-payments"},{"title":"Create Payment","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/payments","href":"/api-reference/payments/create-payment"},{"title":"Get Payment","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/payments/{id}","href":"/api-reference/payments/get-payment"}]},{"group":"Payment Sessions","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/paymentSessions","href":"/api-reference/payment-sessions/list"}]},{"group":"Events","pages":[{"title":"Ingest Event","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/events","href":"/api-reference/events/ingest-event"}]},{"group":"Costs","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/costs","href":"/api-reference/costs/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/costs","href":"/api-reference/costs/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/costs/{id}","href":"/api-reference/costs/get"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/costs/{id}","href":"/api-reference/costs/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/costs/{id}","href":"/api-reference/costs/update"},{"title":"Query Summary","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/costs/{id}/summary","href":"/api-reference/costs/query-summary"},{"title":"Report","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/costs/report","href":"/api-reference/costs/report"}]},{"group":"Revenue","pages":[{"title":"Get revenue summary","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/revenue","href":"/api-reference/revenue/get-revenue-summary"},{"title":"List customer accounts","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/revenue/accounts","href":"/api-reference/revenue/list-customer-accounts"}]},{"group":"Profitability","pages":[{"title":"Get profitability summary","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/profitability","href":"/api-reference/profitability/get-profitability-summary"}]},{"group":"Test Clocks","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/testClocks","href":"/api-reference/test-clocks/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/testClocks","href":"/api-reference/test-clocks/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/testClocks/{id}","href":"/api-reference/test-clocks/get"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/testClocks/{id}","href":"/api-reference/test-clocks/delete"},{"title":"Advance","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/testClocks/{id}","href":"/api-reference/test-clocks/advance"}]},{"group":"Merchant Data","pages":[{"title":"Reset a merchant's data","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/merchants/{merchantId}/reset","href":"/api-reference/merchant-data/reset-a-merchants-data"}]},{"group":"ExternalReferences","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/externalReferences","href":"/api-reference/externalreferences/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/externalReferences","href":"/api-reference/externalreferences/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/externalReferences/{id}","href":"/api-reference/externalreferences/get"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/externalReferences/{id}","href":"/api-reference/externalreferences/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/externalReferences/{id}","href":"/api-reference/externalreferences/update"}]},{"group":"Items","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/items","href":"/api-reference/items/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/items","href":"/api-reference/items/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/items/{id}","href":"/api-reference/items/get"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/items/{id}","href":"/api-reference/items/update"}]},{"group":"Orders","pages":[{"title":"List orders","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/orders","href":"/api-reference/orders/list-orders"},{"title":"Create an order","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/orders","href":"/api-reference/orders/create-an-order"},{"title":"Get an order","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/orders/{id}","href":"/api-reference/orders/get-an-order"},{"title":"Delete an order","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/orders/{id}","href":"/api-reference/orders/delete-an-order"},{"title":"Update an order","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/orders/{id}","href":"/api-reference/orders/update-an-order"},{"title":"Add a line item","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/orders/{orderId}/lineItems","href":"/api-reference/orders/add-a-line-item"},{"title":"Delete a line item","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/orders/{orderId}/lineItems/{id}","href":"/api-reference/orders/delete-a-line-item"},{"title":"Update a line item","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/orders/{orderId}/lineItems/{id}","href":"/api-reference/orders/update-a-line-item"},{"title":"Create an approval for the order","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/orders/{orderId}/approvals","href":"/api-reference/orders/create-an-approval-for-the-order"}]},{"group":"Billing Schedules","pages":[{"title":"List billing schedules","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/billingSchedules","href":"/api-reference/billing-schedules/list-billing-schedules"},{"title":"Create a billing schedule","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/billingSchedules","href":"/api-reference/billing-schedules/create-a-billing-schedule"},{"title":"Get a billing schedule","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/billingSchedules/{id}","href":"/api-reference/billing-schedules/get-a-billing-schedule"},{"title":"Delete a billing schedule","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/billingSchedules/{id}","href":"/api-reference/billing-schedules/delete-a-billing-schedule"},{"title":"Update a billing schedule","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/billingSchedules/{id}","href":"/api-reference/billing-schedules/update-a-billing-schedule"},{"title":"List schedule intervals","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/billingSchedules/{id}/intervals","href":"/api-reference/billing-schedules/list-schedule-intervals"},{"title":"Replace schedule intervals","deprecated":null,"version":null,"openapi":"/openapi.json put /v0/billingSchedules/{id}/intervals","href":"/api-reference/billing-schedules/replace-schedule-intervals"},{"title":"List staged invoices","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/billingSchedules/{id}/invoices","href":"/api-reference/billing-schedules/list-staged-invoices"},{"title":"Generate staged invoices","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/billingSchedules/{id}/invoices","href":"/api-reference/billing-schedules/generate-staged-invoices"}]},{"group":"Salesforce","pages":[{"title":"List Salesforce accounts","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/integrations/salesforce/accounts","href":"/api-reference/salesforce/list-salesforce-accounts"}]},{"group":"MerchantIntegrations","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/merchantIntegrations","href":"/api-reference/merchantintegrations/list"},{"title":"Upsert","deprecated":null,"version":null,"openapi":"/openapi.json put /v0/merchantIntegrations","href":"/api-reference/merchantintegrations/upsert"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/merchantIntegrations/{id}","href":"/api-reference/merchantintegrations/get"},{"title":"Disconnect","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/merchantIntegrations/{id}/disconnect","href":"/api-reference/merchantintegrations/disconnect"}]},{"group":"Approvals","pages":[{"title":"List approvals","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/approvals","href":"/api-reference/approvals/list-approvals"},{"title":"Submit a resource for approval","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/approvals","href":"/api-reference/approvals/submit-a-resource-for-approval"},{"title":"Get an approval","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/approvals/{id}","href":"/api-reference/approvals/get-an-approval"},{"title":"Update an approval (approve, reject, or cancel)","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/approvals/{id}","href":"/api-reference/approvals/update-an-approval-approve-reject-or-cancel"}]},{"group":"Webhooks","pages":[{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/webhooks","href":"/api-reference/webhooks/get"},{"title":"Enable","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/webhooks","href":"/api-reference/webhooks/enable"},{"title":"Disable","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/webhooks","href":"/api-reference/webhooks/disable"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/webhooks","href":"/api-reference/webhooks/update"},{"title":"Get Portal Access","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/webhooks/portal","href":"/api-reference/webhooks/get-portal-access"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Update - Paygentic","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}