Create immutable pricing terms for customer usage, scoped to the authenticated merchant API key and its live/test mode. Monthly price uses currency precision; credits and overage rate allow six fractional digits. Reusing a code with identical terms returns the plan; changed terms conflict.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"OrsunPay","description":"Guides, API contracts and workspace walkthroughs for merchants integrating OrsunPay.","colors":{"primary":"#826300","light":"#FFCC00","dark":"#705600"},"logo":{"light":"https://mintcdn.com/orsunpay/9giosiM-mO_kwig_/brand/logo-light.svg?fit=max\u0026auto=format\u0026n=9giosiM-mO_kwig_\u0026q=85\u0026s=993e4b5b338d8309f92a9295890ce0b8","dark":"https://mintcdn.com/orsunpay/9giosiM-mO_kwig_/brand/logo-dark.svg?fit=max\u0026auto=format\u0026n=9giosiM-mO_kwig_\u0026q=85\u0026s=3f7a25249f226fc3db217801c714262c"},"favicon":"https://mintcdn.com/orsunpay/9giosiM-mO_kwig_/brand/favicon.svg?fit=max\u0026auto=format\u0026n=9giosiM-mO_kwig_\u0026q=85\u0026s=2ad7f5317a7cd3fc82e1751839429c8f","api":{"playground":{"display":"simple"}},"navbar":{"links":[{"href":"https://orsunpay.com/contact","label":"Support"}],"primary":{"type":"button","label":"Merchant cabinet","href":"https://r1-cabinet.orsunpay.com"}},"fonts":{"family":"Onest"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"orsunpay","hasAudioNarration":false,"actualSubdomain":"orsunpay","customDomains":["docs.orsunpay.com"],"gitSource":{"type":"github","owner":"orsuntech","repo":"orsunpay-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":"","_id":"6aed3b9f94899c7f5d7debb7"},"entitlements":{},"buildId":"6aed7a978edba1c7664b50a7","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"API Reference","count":54},{"language":"default","tag":"Endpoints","count":53},{"language":"default","tag":"Guides","count":33},{"language":"default","tag":"Cashier player","count":18},{"language":"default","tag":"Usage billing","count":15},{"language":"default","tag":"Server SDKs","count":9},{"language":"default","tag":"Payment methods","count":8},{"language":"default","tag":"Integration essentials","count":6},{"language":"default","tag":"Accept a payment","count":6},{"language":"default","tag":"Manage payments","count":6}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"api-reference/usage-billing/create-a-usage-plan","slug":"/api-reference/usage-billing/create-a-usage-plan","pageMetadata":{"title":"Create a usage plan","description":"Create immutable pricing terms for customer usage, scoped to the authenticated merchant API key and its live/test mode. Monthly price uses currency precision; credits and overage rate allow six fractional digits. Reusing a code with identical terms returns the plan; changed terms conflict.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/usage-billing/plans","href":"/api-reference/usage-billing/create-a-usage-plan","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Create immutable pricing terms for customer usage, scoped to the authenticated merchant API key and its live/test mode. Monthly price uses currency precision; credits and overage rate allow six fractional digits. Reusing a code with identical terms returns the plan; changed terms conflict.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a usage plan","description":"Create immutable pricing terms for customer usage, scoped to the authenticated merchant API key and its live/test mode. Monthly price uses currency precision; credits and overage rate allow six fractional digits. Reusing a code with identical terms returns the plan; changed terms conflict.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/usage-billing/plans","href":"/api-reference/usage-billing/create-a-usage-plan","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Create immutable pricing terms for customer usage, scoped to the authenticated merchant API key and its live/test mode. Monthly price uses currency precision; credits and overage rate allow six fractional digits. Reusing a code with identical terms returns the plan; changed terms conflict.","operationId":"createUsagePlan","parameters":["b2ad918f-2722-480b-89ce-78cd271caf0e"],"requestBody":"31b486a6-2f93-4d78-9ae3-ba57ec5aee12","responses":{"200":"389e342b-a82a-4396-a20b-6544817f2215","400":"b20622a9-51fc-403a-8ccb-9c03b970c914","401":"53f2e4ee-4624-45c4-b1b7-7387e9d32fa1","403":"9a2b2b6e-0a09-403d-a384-57124a7834c5","404":"ec44b714-3003-4e2d-a216-2b6bcc44fb0d","409":"bc3ce3a5-4b11-4bae-80af-7f7bf03d9ea5","422":"69151920-fe0c-459b-b015-a547897dd806","429":"a6572560-05a7-449b-aaf5-a4db2ad08027","502":"23a6bca1-a586-4429-8701-21d625b5634d","503":"2952c3a8-a360-41ef-b1a6-029201730051","504":"db5662f4-6788-433b-ad00-43992d3232f1"},"security":["6cb11ea9-5c07-435a-b9e8-9bd81bddd3ba"],"summary":"Create a usage plan","tags":["Usage billing"],"method":"post","type":"path","servers":[],"path":"/v1/usage-billing/plans","baseUrlOptions":[],"title":"Create a usage plan","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"b2ad918f-2722-480b-89ce-78cd271caf0e":{"description":"Optional request key. Plan code is the durable duplicate-prevention key within the shop and mode; changed terms for the same code conflict.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string","isRequired":false,"description":"Optional request key. Plan code is the durable duplicate-prevention key within the shop and mode; changed terms for the same code conflict.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"currency":{"type":"string","isRequired":true,"uniqueKey":"currency","typeLabel":"string"},"includedCredits":{"type":"string","isRequired":true,"uniqueKey":"includedCredits","typeLabel":"string"},"monthlyPrice":{"pattern":"^(0|[1-9]\\d{0,19})(\\.\\d{1,18})?$","type":"string","isRequired":true,"uniqueKey":"monthlyPrice","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"overageUnitPrice":{"pattern":"^(0|[1-9]\\d{0,19})(\\.\\d{1,18})?$","type":"string","isRequired":true,"uniqueKey":"overageUnitPrice","typeLabel":"string"},"unit":{"type":"string","isRequired":true,"uniqueKey":"unit","typeLabel":"string"}},"required":["code","name","unit","currency","monthlyPrice","includedCredits","overageUnitPrice"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","currency":"\u003cstring>","includedCredits":"\u003cstring>","monthlyPrice":"\u003cstring>","name":"\u003cstring>","overageUnitPrice":"\u003cstring>","unit":"\u003cstring>"}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"389e342b-a82a-4396-a20b-6544817f2215":{"content":{"application/json":{"example":{"data":{"code":"starter","currency":"EUR","id":"11111111-1111-4111-8111-111111111111","includedCredits":"1000","monthlyPrice":"20.00","name":"Starter","overageUnitPrice":"0.01","unit":"request"}},"schema":{"properties":{"data":{"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"data.code","typeLabel":"string"},"currency":{"type":"string","isRequired":true,"uniqueKey":"data.currency","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"includedCredits":{"type":"string","isRequired":true,"uniqueKey":"data.includedCredits","typeLabel":"string"},"monthlyPrice":{"pattern":"^(0|[1-9]\\d{0,19})(\\.\\d{1,18})?$","type":"string","isRequired":true,"uniqueKey":"data.monthlyPrice","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"data.name","typeLabel":"string"},"overageUnitPrice":{"pattern":"^(0|[1-9]\\d{0,19})(\\.\\d{1,18})?$","type":"string","isRequired":true,"uniqueKey":"data.overageUnitPrice","typeLabel":"string"},"unit":{"type":"string","isRequired":true,"uniqueKey":"data.unit","typeLabel":"string"}},"required":["id","code","name","unit","currency","monthlyPrice","includedCredits","overageUnitPrice"],"type":"object","isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["data"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"code":"starter","currency":"EUR","id":"11111111-1111-4111-8111-111111111111","includedCredits":"1000","monthlyPrice":"20.00","name":"Starter","overageUnitPrice":"0.01","unit":"request"}}}},"exampleType":"examples"}},"description":"The scoped resource. Duplicate creates return the original resource.","headers":{"RateLimit":{"description":"Remaining requests (r) and seconds to reset/full refill (t), per evaluated policy. Absent when disabled; merchant quota is omitted during Redis outages, while IP/auth protection uses replica memory.","schema":{"example":"\"merchant\";r=37;t=4","type":"string"}},"RateLimit-Policy":{"description":"Evaluated policies (draft-ietf-httpapi-ratelimit-headers-11). q is burst quota; w is the full refill window in seconds.","schema":{"example":"\"merchant\";q=100;w=5","type":"string"}}},"exampleType":"examples"},"b20622a9-51fc-403a-8ccb-9c03b970c914":{"content":{"application/json":{"example":{"errorCode":"USAGE_INPUT_INVALID","message":"USAGE_INPUT_INVALID","statusCode":400},"schema":{"oneOf":[{"type":"object","required":["status","statusCode","errorCode","error","message"],"properties":{"error":{"description":"Same as errorCode","example":"DUPLICATE_ORDER_ID","type":"string","isRequired":true,"uniqueKey":"oneOf.0.error","typeLabel":"string"},"errorCode":{"description":"Machine-readable, extensible code. Known values: ADYEN_REFUSED, CARD_DATA_NOT_ACCEPTED, RATE_LIMITED, PAYMENT_LINK_INVALID_AMOUNT, PAYMENT_LINK_UNSUPPORTED_CURRENCY, PAYMENT_LINK_INVALID_EXPIRY, PAYMENT_LINK_INVALID_MAX_USES, PAYMENT_LINK_REDIRECT_URL_NOT_ALLOWED, PAYMENT_LINK_METADATA_TOO_LARGE, PAYMENT_LINK_INVALID_TEXT, PAYMENT_LINK_NOT_FOUND, PAYMENT_LINK_INVALID_LIMIT, PAYMENT_LINK_INVALID_CURSOR, API_KEY_ROTATION_REQUIRED, ORDER_ID_RESERVED, NO_CREDENTIALS_FOR_MODE, LIVEMODE_MISMATCH, PSP_OUTCOME_UNKNOWN, PAYMENT_METHOD_REQUIRED, PAYMENT_METHOD_INPUT_WITHOUT_METHOD, NO_PAYMENT_METHODS, IDEMPOTENCY_KEY_INVALID, DUPLICATE_ORDER_ID, IDEMPOTENCY_IN_PROGRESS, IDEMPOTENCY_KEY_REUSED, UPSTREAM_ERROR, UPSTREAM_UNAVAILABLE, UPSTREAM_TIMEOUT, REFUND_INVALID_AMOUNT, REFUND_INVALID_REASON, REFUND_INVALID_METADATA, REFUND_INPUT_INVALID, REFUND_EXCEEDS_AMOUNT, TRANSACTION_NOT_REFUNDABLE, REFUND_NOT_FOUND, REFUND_NOT_SUPPORTED, IDEMPOTENCY_LEASE_LOST, REFUND_SERVICE_UNAVAILABLE. New codes may be added; clients must handle unknown values.","example":"DUPLICATE_ORDER_ID","type":"string","isRequired":true,"uniqueKey":"oneOf.0.errorCode","typeLabel":"string"},"message":{"example":"A transaction with orderId \"A-1001\" already exists for this merchant","type":"string","isRequired":true,"uniqueKey":"oneOf.0.message","typeLabel":"string"},"status":{"example":false,"type":"boolean","isRequired":true,"uniqueKey":"oneOf.0.status","typeLabel":"boolean"},"statusCode":{"example":409,"type":"number","isRequired":true,"uniqueKey":"oneOf.0.statusCode","typeLabel":"number"},"existingTransactionId":{"description":"DUPLICATE_ORDER_ID only: the transaction that already uses this orderId","example":"tr_x8k2p0q5scocndpejk0nud75q","type":"string","uniqueKey":"oneOf.0.existingTransactionId","typeLabel":"string"},"fields":{"description":"Invalid or missing buyer contact fields for CUSTOMER_CONTACT_REQUIRED","example":["customer.email","customer.country"],"items":{"type":"string","uniqueKey":"oneOf.0.fields.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"oneOf.0.fields","typeLabel":"string[]"},"idempotencyKey":{"description":"IDEMPOTENCY_* errors only","example":"0b6f2c1e-4c7a-4a43-9a51-6a4b1d7e9f10","type":"string","uniqueKey":"oneOf.0.idempotencyKey","typeLabel":"string"},"orderId":{"description":"DUPLICATE_ORDER_ID only","example":"A-1001","type":"string","uniqueKey":"oneOf.0.orderId","typeLabel":"string"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["statusCode","error","message"],"properties":{"error":{"example":"Bad Request","type":"string","isRequired":true,"uniqueKey":"oneOf.1.error","typeLabel":"string"},"message":{"example":["amount must be a decimal string in major units, e.g. \"12.30\"; JSON numbers are not accepted for money (got 12.3)"],"items":{"type":"string","uniqueKey":"oneOf.1.message.items.[INDEX]","typeLabel":"string"},"type":"array","isRequired":true,"uniqueKey":"oneOf.1.message","typeLabel":"string[]"},"statusCode":{"example":400,"type":"number","isRequired":true,"uniqueKey":"oneOf.1.statusCode","typeLabel":"number"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorCode":"USAGE_INPUT_INVALID","message":"USAGE_INPUT_INVALID","statusCode":400}}},"exampleType":"examples"}},"description":"Invalid fields, decimal precision or missing idempotency key. USAGE_INPUT_INVALID / USAGE_AMOUNT_INVALID / USAGE_CREDITS_INVALID / USAGE_IDEMPOTENCY_KEY_REQUIRED.","exampleType":"examples"},"53f2e4ee-4624-45c4-b1b7-7387e9d32fa1":{"content":{"application/json":{"example":{"error":"Unauthorized","message":"Invalid API key","statusCode":401},"schema":{"properties":{"message":{"example":"Invalid API key","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"example":"Unauthorized","type":"string","uniqueKey":"error","typeLabel":"string"},"errorCode":{"description":"Stable authentication error code when available","example":"API_KEY_ROTATION_REQUIRED","type":"string","uniqueKey":"errorCode","typeLabel":"string"},"statusCode":{"description":"HTTP status when included by the error handler","example":401,"type":"number","uniqueKey":"statusCode","typeLabel":"number"}},"required":["message"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Unauthorized","message":"Invalid API key","statusCode":401}}},"exampleType":"examples"}},"description":"Missing or invalid merchant API key.","exampleType":"examples"},"9a2b2b6e-0a09-403d-a384-57124a7834c5":{"content":{"application/json":{"example":{"errorCode":"USAGE_SCOPE_INACTIVE","statusCode":403},"schema":{"properties":{"error":{"description":"Same as errorCode","example":"DUPLICATE_ORDER_ID","type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"errorCode":{"description":"Machine-readable, extensible code. Known values: ADYEN_REFUSED, CARD_DATA_NOT_ACCEPTED, RATE_LIMITED, PAYMENT_LINK_INVALID_AMOUNT, PAYMENT_LINK_UNSUPPORTED_CURRENCY, PAYMENT_LINK_INVALID_EXPIRY, PAYMENT_LINK_INVALID_MAX_USES, PAYMENT_LINK_REDIRECT_URL_NOT_ALLOWED, PAYMENT_LINK_METADATA_TOO_LARGE, PAYMENT_LINK_INVALID_TEXT, PAYMENT_LINK_NOT_FOUND, PAYMENT_LINK_INVALID_LIMIT, PAYMENT_LINK_INVALID_CURSOR, API_KEY_ROTATION_REQUIRED, ORDER_ID_RESERVED, NO_CREDENTIALS_FOR_MODE, LIVEMODE_MISMATCH, PSP_OUTCOME_UNKNOWN, PAYMENT_METHOD_REQUIRED, PAYMENT_METHOD_INPUT_WITHOUT_METHOD, NO_PAYMENT_METHODS, IDEMPOTENCY_KEY_INVALID, DUPLICATE_ORDER_ID, IDEMPOTENCY_IN_PROGRESS, IDEMPOTENCY_KEY_REUSED, UPSTREAM_ERROR, UPSTREAM_UNAVAILABLE, UPSTREAM_TIMEOUT, REFUND_INVALID_AMOUNT, REFUND_INVALID_REASON, REFUND_INVALID_METADATA, REFUND_INPUT_INVALID, REFUND_EXCEEDS_AMOUNT, TRANSACTION_NOT_REFUNDABLE, REFUND_NOT_FOUND, REFUND_NOT_SUPPORTED, IDEMPOTENCY_LEASE_LOST, REFUND_SERVICE_UNAVAILABLE. New codes may be added; clients must handle unknown values.","example":"DUPLICATE_ORDER_ID","type":"string","isRequired":true,"uniqueKey":"errorCode","typeLabel":"string"},"message":{"example":"A transaction with orderId \"A-1001\" already exists for this merchant","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"status":{"example":false,"type":"boolean","isRequired":true,"uniqueKey":"status","typeLabel":"boolean"},"statusCode":{"example":409,"type":"number","isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"existingTransactionId":{"description":"DUPLICATE_ORDER_ID only: the transaction that already uses this orderId","example":"tr_x8k2p0q5scocndpejk0nud75q","type":"string","uniqueKey":"existingTransactionId","typeLabel":"string"},"fields":{"description":"Invalid or missing buyer contact fields for CUSTOMER_CONTACT_REQUIRED","example":["customer.email","customer.country"],"items":{"type":"string","uniqueKey":"fields.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"fields","typeLabel":"string[]"},"idempotencyKey":{"description":"IDEMPOTENCY_* errors only","example":"0b6f2c1e-4c7a-4a43-9a51-6a4b1d7e9f10","type":"string","uniqueKey":"idempotencyKey","typeLabel":"string"},"orderId":{"description":"DUPLICATE_ORDER_ID only","example":"A-1001","type":"string","uniqueKey":"orderId","typeLabel":"string"}},"required":["status","statusCode","errorCode","error","message"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorCode":"USAGE_SCOPE_INACTIVE","statusCode":403}}},"exampleType":"examples"}},"description":"USAGE_SCOPE_INACTIVE: the authenticated merchant or company is inactive.","exampleType":"examples"},"ec44b714-3003-4e2d-a216-2b6bcc44fb0d":{"content":{"application/json":{"example":{"errorCode":"USAGE_SUBSCRIPTION_NOT_FOUND","statusCode":404},"schema":{"properties":{"error":{"description":"Same as errorCode","example":"DUPLICATE_ORDER_ID","type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"errorCode":{"description":"Machine-readable, extensible code. Known values: ADYEN_REFUSED, CARD_DATA_NOT_ACCEPTED, RATE_LIMITED, PAYMENT_LINK_INVALID_AMOUNT, PAYMENT_LINK_UNSUPPORTED_CURRENCY, PAYMENT_LINK_INVALID_EXPIRY, PAYMENT_LINK_INVALID_MAX_USES, PAYMENT_LINK_REDIRECT_URL_NOT_ALLOWED, PAYMENT_LINK_METADATA_TOO_LARGE, PAYMENT_LINK_INVALID_TEXT, PAYMENT_LINK_NOT_FOUND, PAYMENT_LINK_INVALID_LIMIT, PAYMENT_LINK_INVALID_CURSOR, API_KEY_ROTATION_REQUIRED, ORDER_ID_RESERVED, NO_CREDENTIALS_FOR_MODE, LIVEMODE_MISMATCH, PSP_OUTCOME_UNKNOWN, PAYMENT_METHOD_REQUIRED, PAYMENT_METHOD_INPUT_WITHOUT_METHOD, NO_PAYMENT_METHODS, IDEMPOTENCY_KEY_INVALID, DUPLICATE_ORDER_ID, IDEMPOTENCY_IN_PROGRESS, IDEMPOTENCY_KEY_REUSED, UPSTREAM_ERROR, UPSTREAM_UNAVAILABLE, UPSTREAM_TIMEOUT, REFUND_INVALID_AMOUNT, REFUND_INVALID_REASON, REFUND_INVALID_METADATA, REFUND_INPUT_INVALID, REFUND_EXCEEDS_AMOUNT, TRANSACTION_NOT_REFUNDABLE, REFUND_NOT_FOUND, REFUND_NOT_SUPPORTED, IDEMPOTENCY_LEASE_LOST, REFUND_SERVICE_UNAVAILABLE. New codes may be added; clients must handle unknown values.","example":"DUPLICATE_ORDER_ID","type":"string","isRequired":true,"uniqueKey":"errorCode","typeLabel":"string"},"message":{"example":"A transaction with orderId \"A-1001\" already exists for this merchant","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"status":{"example":false,"type":"boolean","isRequired":true,"uniqueKey":"status","typeLabel":"boolean"},"statusCode":{"example":409,"type":"number","isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"existingTransactionId":{"description":"DUPLICATE_ORDER_ID only: the transaction that already uses this orderId","example":"tr_x8k2p0q5scocndpejk0nud75q","type":"string","uniqueKey":"existingTransactionId","typeLabel":"string"},"fields":{"description":"Invalid or missing buyer contact fields for CUSTOMER_CONTACT_REQUIRED","example":["customer.email","customer.country"],"items":{"type":"string","uniqueKey":"fields.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"fields","typeLabel":"string[]"},"idempotencyKey":{"description":"IDEMPOTENCY_* errors only","example":"0b6f2c1e-4c7a-4a43-9a51-6a4b1d7e9f10","type":"string","uniqueKey":"idempotencyKey","typeLabel":"string"},"orderId":{"description":"DUPLICATE_ORDER_ID only","example":"A-1001","type":"string","uniqueKey":"orderId","typeLabel":"string"}},"required":["status","statusCode","errorCode","error","message"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorCode":"USAGE_SUBSCRIPTION_NOT_FOUND","statusCode":404}}},"exampleType":"examples"}},"description":"USAGE_PLAN_NOT_FOUND / USAGE_SUBSCRIPTION_NOT_FOUND; unknown or another shop/mode.","exampleType":"examples"},"bc3ce3a5-4b11-4bae-80af-7f7bf03d9ea5":{"content":{"application/json":{"example":{"errorCode":"USAGE_EVENT_CONFLICT","statusCode":409},"schema":{"properties":{"error":{"description":"Same as errorCode","example":"DUPLICATE_ORDER_ID","type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"errorCode":{"description":"Machine-readable, extensible code. Known values: ADYEN_REFUSED, CARD_DATA_NOT_ACCEPTED, RATE_LIMITED, PAYMENT_LINK_INVALID_AMOUNT, PAYMENT_LINK_UNSUPPORTED_CURRENCY, PAYMENT_LINK_INVALID_EXPIRY, PAYMENT_LINK_INVALID_MAX_USES, PAYMENT_LINK_REDIRECT_URL_NOT_ALLOWED, PAYMENT_LINK_METADATA_TOO_LARGE, PAYMENT_LINK_INVALID_TEXT, PAYMENT_LINK_NOT_FOUND, PAYMENT_LINK_INVALID_LIMIT, PAYMENT_LINK_INVALID_CURSOR, API_KEY_ROTATION_REQUIRED, ORDER_ID_RESERVED, NO_CREDENTIALS_FOR_MODE, LIVEMODE_MISMATCH, PSP_OUTCOME_UNKNOWN, PAYMENT_METHOD_REQUIRED, PAYMENT_METHOD_INPUT_WITHOUT_METHOD, NO_PAYMENT_METHODS, IDEMPOTENCY_KEY_INVALID, DUPLICATE_ORDER_ID, IDEMPOTENCY_IN_PROGRESS, IDEMPOTENCY_KEY_REUSED, UPSTREAM_ERROR, UPSTREAM_UNAVAILABLE, UPSTREAM_TIMEOUT, REFUND_INVALID_AMOUNT, REFUND_INVALID_REASON, REFUND_INVALID_METADATA, REFUND_INPUT_INVALID, REFUND_EXCEEDS_AMOUNT, TRANSACTION_NOT_REFUNDABLE, REFUND_NOT_FOUND, REFUND_NOT_SUPPORTED, IDEMPOTENCY_LEASE_LOST, REFUND_SERVICE_UNAVAILABLE. New codes may be added; clients must handle unknown values.","example":"DUPLICATE_ORDER_ID","type":"string","isRequired":true,"uniqueKey":"errorCode","typeLabel":"string"},"message":{"example":"A transaction with orderId \"A-1001\" already exists for this merchant","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"status":{"example":false,"type":"boolean","isRequired":true,"uniqueKey":"status","typeLabel":"boolean"},"statusCode":{"example":409,"type":"number","isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"existingTransactionId":{"description":"DUPLICATE_ORDER_ID only: the transaction that already uses this orderId","example":"tr_x8k2p0q5scocndpejk0nud75q","type":"string","uniqueKey":"existingTransactionId","typeLabel":"string"},"fields":{"description":"Invalid or missing buyer contact fields for CUSTOMER_CONTACT_REQUIRED","example":["customer.email","customer.country"],"items":{"type":"string","uniqueKey":"fields.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"fields","typeLabel":"string[]"},"idempotencyKey":{"description":"IDEMPOTENCY_* errors only","example":"0b6f2c1e-4c7a-4a43-9a51-6a4b1d7e9f10","type":"string","uniqueKey":"idempotencyKey","typeLabel":"string"},"orderId":{"description":"DUPLICATE_ORDER_ID only","example":"A-1001","type":"string","uniqueKey":"orderId","typeLabel":"string"}},"required":["status","statusCode","errorCode","error","message"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorCode":"USAGE_EVENT_CONFLICT","statusCode":409}}},"exampleType":"examples"}},"description":"USAGE_PLAN_CONFLICT / USAGE_EVENT_CONFLICT / USAGE_IDEMPOTENCY_CONFLICT / USAGE_SUBSCRIPTION_INACTIVE / USAGE_PERIOD_ENDED / USAGE_OVERAGE_LIMIT_EXCEEDED / USAGE_BUSY.","exampleType":"examples"},"69151920-fe0c-459b-b015-a547897dd806":{"content":{"application/json":{"example":{"errorCode":"IDEMPOTENCY_KEY_REUSED","statusCode":422},"schema":{"properties":{"error":{"description":"Same as errorCode","example":"DUPLICATE_ORDER_ID","type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"errorCode":{"description":"Machine-readable, extensible code. Known values: ADYEN_REFUSED, CARD_DATA_NOT_ACCEPTED, RATE_LIMITED, PAYMENT_LINK_INVALID_AMOUNT, PAYMENT_LINK_UNSUPPORTED_CURRENCY, PAYMENT_LINK_INVALID_EXPIRY, PAYMENT_LINK_INVALID_MAX_USES, PAYMENT_LINK_REDIRECT_URL_NOT_ALLOWED, PAYMENT_LINK_METADATA_TOO_LARGE, PAYMENT_LINK_INVALID_TEXT, PAYMENT_LINK_NOT_FOUND, PAYMENT_LINK_INVALID_LIMIT, PAYMENT_LINK_INVALID_CURSOR, API_KEY_ROTATION_REQUIRED, ORDER_ID_RESERVED, NO_CREDENTIALS_FOR_MODE, LIVEMODE_MISMATCH, PSP_OUTCOME_UNKNOWN, PAYMENT_METHOD_REQUIRED, PAYMENT_METHOD_INPUT_WITHOUT_METHOD, NO_PAYMENT_METHODS, IDEMPOTENCY_KEY_INVALID, DUPLICATE_ORDER_ID, IDEMPOTENCY_IN_PROGRESS, IDEMPOTENCY_KEY_REUSED, UPSTREAM_ERROR, UPSTREAM_UNAVAILABLE, UPSTREAM_TIMEOUT, REFUND_INVALID_AMOUNT, REFUND_INVALID_REASON, REFUND_INVALID_METADATA, REFUND_INPUT_INVALID, REFUND_EXCEEDS_AMOUNT, TRANSACTION_NOT_REFUNDABLE, REFUND_NOT_FOUND, REFUND_NOT_SUPPORTED, IDEMPOTENCY_LEASE_LOST, REFUND_SERVICE_UNAVAILABLE. New codes may be added; clients must handle unknown values.","example":"DUPLICATE_ORDER_ID","type":"string","isRequired":true,"uniqueKey":"errorCode","typeLabel":"string"},"message":{"example":"A transaction with orderId \"A-1001\" already exists for this merchant","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"status":{"example":false,"type":"boolean","isRequired":true,"uniqueKey":"status","typeLabel":"boolean"},"statusCode":{"example":409,"type":"number","isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"existingTransactionId":{"description":"DUPLICATE_ORDER_ID only: the transaction that already uses this orderId","example":"tr_x8k2p0q5scocndpejk0nud75q","type":"string","uniqueKey":"existingTransactionId","typeLabel":"string"},"fields":{"description":"Invalid or missing buyer contact fields for CUSTOMER_CONTACT_REQUIRED","example":["customer.email","customer.country"],"items":{"type":"string","uniqueKey":"fields.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"fields","typeLabel":"string[]"},"idempotencyKey":{"description":"IDEMPOTENCY_* errors only","example":"0b6f2c1e-4c7a-4a43-9a51-6a4b1d7e9f10","type":"string","uniqueKey":"idempotencyKey","typeLabel":"string"},"orderId":{"description":"DUPLICATE_ORDER_ID only","example":"A-1001","type":"string","uniqueKey":"orderId","typeLabel":"string"}},"required":["status","statusCode","errorCode","error","message"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorCode":"IDEMPOTENCY_KEY_REUSED","statusCode":422}}},"exampleType":"examples"}},"description":"The request conflicts with a previously recorded idempotency key.","exampleType":"examples"},"a6572560-05a7-449b-aaf5-a4db2ad08027":{"content":{"application/json":{"example":{"error":"RATE_LIMITED","errorCode":"RATE_LIMITED","message":"Too many requests. Retry after the indicated delay.","status":false,"statusCode":429},"schema":{"properties":{"error":{"description":"Same as errorCode","example":"DUPLICATE_ORDER_ID","type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"errorCode":{"description":"Machine-readable, extensible code. Known values: ADYEN_REFUSED, CARD_DATA_NOT_ACCEPTED, RATE_LIMITED, PAYMENT_LINK_INVALID_AMOUNT, PAYMENT_LINK_UNSUPPORTED_CURRENCY, PAYMENT_LINK_INVALID_EXPIRY, PAYMENT_LINK_INVALID_MAX_USES, PAYMENT_LINK_REDIRECT_URL_NOT_ALLOWED, PAYMENT_LINK_METADATA_TOO_LARGE, PAYMENT_LINK_INVALID_TEXT, PAYMENT_LINK_NOT_FOUND, PAYMENT_LINK_INVALID_LIMIT, PAYMENT_LINK_INVALID_CURSOR, API_KEY_ROTATION_REQUIRED, ORDER_ID_RESERVED, NO_CREDENTIALS_FOR_MODE, LIVEMODE_MISMATCH, PSP_OUTCOME_UNKNOWN, PAYMENT_METHOD_REQUIRED, PAYMENT_METHOD_INPUT_WITHOUT_METHOD, NO_PAYMENT_METHODS, IDEMPOTENCY_KEY_INVALID, DUPLICATE_ORDER_ID, IDEMPOTENCY_IN_PROGRESS, IDEMPOTENCY_KEY_REUSED, UPSTREAM_ERROR, UPSTREAM_UNAVAILABLE, UPSTREAM_TIMEOUT, REFUND_INVALID_AMOUNT, REFUND_INVALID_REASON, REFUND_INVALID_METADATA, REFUND_INPUT_INVALID, REFUND_EXCEEDS_AMOUNT, TRANSACTION_NOT_REFUNDABLE, REFUND_NOT_FOUND, REFUND_NOT_SUPPORTED, IDEMPOTENCY_LEASE_LOST, REFUND_SERVICE_UNAVAILABLE. New codes may be added; clients must handle unknown values.","example":"DUPLICATE_ORDER_ID","type":"string","isRequired":true,"uniqueKey":"errorCode","typeLabel":"string"},"message":{"example":"A transaction with orderId \"A-1001\" already exists for this merchant","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"status":{"example":false,"type":"boolean","isRequired":true,"uniqueKey":"status","typeLabel":"boolean"},"statusCode":{"example":409,"type":"number","isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"existingTransactionId":{"description":"DUPLICATE_ORDER_ID only: the transaction that already uses this orderId","example":"tr_x8k2p0q5scocndpejk0nud75q","type":"string","uniqueKey":"existingTransactionId","typeLabel":"string"},"fields":{"description":"Invalid or missing buyer contact fields for CUSTOMER_CONTACT_REQUIRED","example":["customer.email","customer.country"],"items":{"type":"string","uniqueKey":"fields.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"fields","typeLabel":"string[]"},"idempotencyKey":{"description":"IDEMPOTENCY_* errors only","example":"0b6f2c1e-4c7a-4a43-9a51-6a4b1d7e9f10","type":"string","uniqueKey":"idempotencyKey","typeLabel":"string"},"orderId":{"description":"DUPLICATE_ORDER_ID only","example":"A-1001","type":"string","uniqueKey":"orderId","typeLabel":"string"}},"required":["status","statusCode","errorCode","error","message"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"RATE_LIMITED","errorCode":"RATE_LIMITED","message":"Too many requests. Retry after the indicated delay.","status":false,"statusCode":429}}},"exampleType":"examples"}},"description":"RATE_LIMITED: IP, merchant or failed-auth quota exhausted, or auth-in-flight concurrency pressure (Retry-After: 1). Wait Retry-After seconds and retry with the same Idempotency-Key.","headers":{"RateLimit":{"description":"Remaining requests (r) and seconds to reset/full refill (t), per evaluated policy. Absent when disabled; merchant quota is omitted during Redis outages, while IP/auth protection uses replica memory.","schema":{"example":"\"merchant\";r=37;t=4","type":"string"}},"RateLimit-Policy":{"description":"Evaluated policies (draft-ietf-httpapi-ratelimit-headers-11). q is burst quota; w is the full refill window in seconds.","schema":{"example":"\"merchant\";q=100;w=5","type":"string"}},"Retry-After":{"description":"Minimum delay in whole seconds before retrying.","schema":{"example":1,"minimum":1,"type":"integer"}}},"exampleType":"examples"},"23a6bca1-a586-4429-8701-21d625b5634d":{"content":{"application/json":{"example":{"errorCode":"UPSTREAM_UNAVAILABLE","statusCode":502},"schema":{"properties":{"error":{"description":"Same as errorCode","example":"DUPLICATE_ORDER_ID","type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"errorCode":{"description":"Machine-readable, extensible code. Known values: ADYEN_REFUSED, CARD_DATA_NOT_ACCEPTED, RATE_LIMITED, PAYMENT_LINK_INVALID_AMOUNT, PAYMENT_LINK_UNSUPPORTED_CURRENCY, PAYMENT_LINK_INVALID_EXPIRY, PAYMENT_LINK_INVALID_MAX_USES, PAYMENT_LINK_REDIRECT_URL_NOT_ALLOWED, PAYMENT_LINK_METADATA_TOO_LARGE, PAYMENT_LINK_INVALID_TEXT, PAYMENT_LINK_NOT_FOUND, PAYMENT_LINK_INVALID_LIMIT, PAYMENT_LINK_INVALID_CURSOR, API_KEY_ROTATION_REQUIRED, ORDER_ID_RESERVED, NO_CREDENTIALS_FOR_MODE, LIVEMODE_MISMATCH, PSP_OUTCOME_UNKNOWN, PAYMENT_METHOD_REQUIRED, PAYMENT_METHOD_INPUT_WITHOUT_METHOD, NO_PAYMENT_METHODS, IDEMPOTENCY_KEY_INVALID, DUPLICATE_ORDER_ID, IDEMPOTENCY_IN_PROGRESS, IDEMPOTENCY_KEY_REUSED, UPSTREAM_ERROR, UPSTREAM_UNAVAILABLE, UPSTREAM_TIMEOUT, REFUND_INVALID_AMOUNT, REFUND_INVALID_REASON, REFUND_INVALID_METADATA, REFUND_INPUT_INVALID, REFUND_EXCEEDS_AMOUNT, TRANSACTION_NOT_REFUNDABLE, REFUND_NOT_FOUND, REFUND_NOT_SUPPORTED, IDEMPOTENCY_LEASE_LOST, REFUND_SERVICE_UNAVAILABLE. New codes may be added; clients must handle unknown values.","example":"DUPLICATE_ORDER_ID","type":"string","isRequired":true,"uniqueKey":"errorCode","typeLabel":"string"},"message":{"example":"A transaction with orderId \"A-1001\" already exists for this merchant","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"status":{"example":false,"type":"boolean","isRequired":true,"uniqueKey":"status","typeLabel":"boolean"},"statusCode":{"example":409,"type":"number","isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"existingTransactionId":{"description":"DUPLICATE_ORDER_ID only: the transaction that already uses this orderId","example":"tr_x8k2p0q5scocndpejk0nud75q","type":"string","uniqueKey":"existingTransactionId","typeLabel":"string"},"fields":{"description":"Invalid or missing buyer contact fields for CUSTOMER_CONTACT_REQUIRED","example":["customer.email","customer.country"],"items":{"type":"string","uniqueKey":"fields.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"fields","typeLabel":"string[]"},"idempotencyKey":{"description":"IDEMPOTENCY_* errors only","example":"0b6f2c1e-4c7a-4a43-9a51-6a4b1d7e9f10","type":"string","uniqueKey":"idempotencyKey","typeLabel":"string"},"orderId":{"description":"DUPLICATE_ORDER_ID only","example":"A-1001","type":"string","uniqueKey":"orderId","typeLabel":"string"}},"required":["status","statusCode","errorCode","error","message"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorCode":"UPSTREAM_UNAVAILABLE","statusCode":502}}},"exampleType":"examples"}},"description":"UPSTREAM_UNAVAILABLE: retry the same intent.","exampleType":"examples"},"2952c3a8-a360-41ef-b1a6-029201730051":{"content":{"application/json":{"example":{"error":"Service Unavailable","message":"API_KEY_VALIDATION_UNAVAILABLE","statusCode":503},"schema":{"properties":{"error":{"example":"Service Unavailable","type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"example":"API_KEY_VALIDATION_UNAVAILABLE","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"statusCode":{"example":503,"type":"number","isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"}},"required":["statusCode","error","message"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Service Unavailable","message":"API_KEY_VALIDATION_UNAVAILABLE","statusCode":503}}},"exampleType":"examples"}},"description":"API key validation unavailable.","exampleType":"examples"},"db5662f4-6788-433b-ad00-43992d3232f1":{"content":{"application/json":{"example":{"errorCode":"UPSTREAM_TIMEOUT","statusCode":504},"schema":{"properties":{"error":{"description":"Same as errorCode","example":"DUPLICATE_ORDER_ID","type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"errorCode":{"description":"Machine-readable, extensible code. Known values: ADYEN_REFUSED, CARD_DATA_NOT_ACCEPTED, RATE_LIMITED, PAYMENT_LINK_INVALID_AMOUNT, PAYMENT_LINK_UNSUPPORTED_CURRENCY, PAYMENT_LINK_INVALID_EXPIRY, PAYMENT_LINK_INVALID_MAX_USES, PAYMENT_LINK_REDIRECT_URL_NOT_ALLOWED, PAYMENT_LINK_METADATA_TOO_LARGE, PAYMENT_LINK_INVALID_TEXT, PAYMENT_LINK_NOT_FOUND, PAYMENT_LINK_INVALID_LIMIT, PAYMENT_LINK_INVALID_CURSOR, API_KEY_ROTATION_REQUIRED, ORDER_ID_RESERVED, NO_CREDENTIALS_FOR_MODE, LIVEMODE_MISMATCH, PSP_OUTCOME_UNKNOWN, PAYMENT_METHOD_REQUIRED, PAYMENT_METHOD_INPUT_WITHOUT_METHOD, NO_PAYMENT_METHODS, IDEMPOTENCY_KEY_INVALID, DUPLICATE_ORDER_ID, IDEMPOTENCY_IN_PROGRESS, IDEMPOTENCY_KEY_REUSED, UPSTREAM_ERROR, UPSTREAM_UNAVAILABLE, UPSTREAM_TIMEOUT, REFUND_INVALID_AMOUNT, REFUND_INVALID_REASON, REFUND_INVALID_METADATA, REFUND_INPUT_INVALID, REFUND_EXCEEDS_AMOUNT, TRANSACTION_NOT_REFUNDABLE, REFUND_NOT_FOUND, REFUND_NOT_SUPPORTED, IDEMPOTENCY_LEASE_LOST, REFUND_SERVICE_UNAVAILABLE. New codes may be added; clients must handle unknown values.","example":"DUPLICATE_ORDER_ID","type":"string","isRequired":true,"uniqueKey":"errorCode","typeLabel":"string"},"message":{"example":"A transaction with orderId \"A-1001\" already exists for this merchant","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"status":{"example":false,"type":"boolean","isRequired":true,"uniqueKey":"status","typeLabel":"boolean"},"statusCode":{"example":409,"type":"number","isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"existingTransactionId":{"description":"DUPLICATE_ORDER_ID only: the transaction that already uses this orderId","example":"tr_x8k2p0q5scocndpejk0nud75q","type":"string","uniqueKey":"existingTransactionId","typeLabel":"string"},"fields":{"description":"Invalid or missing buyer contact fields for CUSTOMER_CONTACT_REQUIRED","example":["customer.email","customer.country"],"items":{"type":"string","uniqueKey":"fields.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"fields","typeLabel":"string[]"},"idempotencyKey":{"description":"IDEMPOTENCY_* errors only","example":"0b6f2c1e-4c7a-4a43-9a51-6a4b1d7e9f10","type":"string","uniqueKey":"idempotencyKey","typeLabel":"string"},"orderId":{"description":"DUPLICATE_ORDER_ID only","example":"A-1001","type":"string","uniqueKey":"orderId","typeLabel":"string"}},"required":["status","statusCode","errorCode","error","message"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorCode":"UPSTREAM_TIMEOUT","statusCode":504}}},"exampleType":"examples"}},"description":"UPSTREAM_TIMEOUT: the operation may still complete; retry the same intent.","exampleType":"examples"}},"security":{"6cb11ea9-5c07-435a-b9e8-9bd81bddd3ba":{"X-API-Key":{"in":"header","name":"x-api-key","type":"apiKey","scopes":[],"schemeName":"X-API-Key"}}},"servers":{},"processedSecurityOptions":[{"schemes":[{"scheme":{"in":"header","name":"x-api-key","type":"apiKey","scopes":[],"schemeName":"X-API-Key"},"schema":{"title":"x-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"X-API-Key","name":"x-api-key"}],"title":"X-API-Key"}]},"originalFileLocation":"openapi.json"},"subdomain":"orsunpay","siteName":"OrsunPay","title":"Create a usage plan - OrsunPay","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-06T02:29:57.134Z","originalFileLocation":"api-reference/usage-billing/create-a-usage-plan.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Create immutable pricing terms for customer usage, scoped to the authenticated merchant API key and its live/test mode. Monthly price uses currency precision; credits and overage rate allow six fractional digits. Reusing a code with identical terms returns the plan; changed terms conflict.\">\u003cmeta data-mint-head name=\"application-name\" content=\"OrsunPay\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/orsunpay/XvMZZnN-BopedfX_/_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/orsunpay/XvMZZnN-BopedfX_/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/orsunpay/XvMZZnN-BopedfX_/_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/orsunpay/XvMZZnN-BopedfX_/_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/orsunpay/XvMZZnN-BopedfX_/_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/orsunpay/XvMZZnN-BopedfX_/_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/orsunpay/XvMZZnN-BopedfX_/_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/orsunpay/XvMZZnN-BopedfX_/_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/orsunpay/XvMZZnN-BopedfX_/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a usage plan - OrsunPay\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create immutable pricing terms for customer usage, scoped to the authenticated merchant API key and its live/test mode. Monthly price uses currency precision; credits and overage rate allow six fractional digits. Reusing a code with identical terms returns the plan; changed terms conflict.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"OrsunPay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.orsunpay.com/api-reference/usage-billing/create-a-usage-plan\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://orsunpay.mintlify.site/_mintlify/api/og/v2?division=Usage+billing\u0026amp;title=Create+a+usage+plan\u0026amp;description=Create+immutable+pricing+terms+for+customer+usage%2C+scoped+to+the+authenticated+merchant+API+key+and+its+live%2Ftest+mode.+Monthly+price+uses+currency+precision%3B+c\u0026amp;theme=29e3bf99624baacd33338dc6\u0026amp;signature=1613375dc874ec78bcbfc021e561ee7f69bd0ccac99700be077471b0fb51a903\">\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=\"Create a usage plan - OrsunPay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create immutable pricing terms for customer usage, scoped to the authenticated merchant API key and its live/test mode. Monthly price uses currency precision; credits and overage rate allow six fractional digits. Reusing a code with identical terms returns the plan; changed terms conflict.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://orsunpay.mintlify.site/_mintlify/api/og/v2?division=Usage+billing\u0026amp;title=Create+a+usage+plan\u0026amp;description=Create+immutable+pricing+terms+for+customer+usage%2C+scoped+to+the+authenticated+merchant+API+key+and+its+live%2Ftest+mode.+Monthly+price+uses+currency+precision%3B+c\u0026amp;theme=29e3bf99624baacd33338dc6\u0026amp;signature=1613375dc874ec78bcbfc021e561ee7f69bd0ccac99700be077471b0fb51a903\">\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/orsunpay/XvMZZnN-BopedfX_/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"OrsunPay\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#826300\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.orsunpay.com/api-reference/usage-billing/create-a-usage-plan\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/usage-billing/create-a-usage-plan.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.orsunpay.com/#organization\",\"name\":\"OrsunPay\",\"url\":\"https://docs.orsunpay.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/orsunpay/9giosiM-mO_kwig_/brand/logo-light.svg?fit=max\u0026auto=format\u0026n=9giosiM-mO_kwig_\u0026q=85\u0026s=993e4b5b338d8309f92a9295890ce0b8\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.orsunpay.com#website\",\"name\":\"OrsunPay\",\"url\":\"https://docs.orsunpay.com\",\"publisher\":{\"@id\":\"https://docs.orsunpay.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.orsunpay.com/api-reference/usage-billing/create-a-usage-plan#webpage\",\"url\":\"https://docs.orsunpay.com/api-reference/usage-billing/create-a-usage-plan\",\"name\":\"Create a usage plan\",\"description\":\"Create immutable pricing terms for customer usage, scoped to the authenticated merchant API key and its live/test mode. Monthly price uses currency precision; credits and overage rate allow six fractional digits. Reusing a code with identical terms returns the plan; changed terms conflict.\",\"dateModified\":\"2026-11-06T02:29:57.134Z\",\"isPartOf\":{\"@id\":\"https://docs.orsunpay.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.orsunpay.com/api-reference/usage-billing/create-a-usage-plan#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.orsunpay.com/api-reference/usage-billing/create-a-usage-plan#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.orsunpay.com/api-reference/cashier-player/create-a-crypto-invoice\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Usage billing\",\"item\":\"https://docs.orsunpay.com/api-reference/usage-billing/record-a-usage-event\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create a usage plan\",\"item\":\"https://docs.orsunpay.com/api-reference/usage-billing/create-a-usage-plan\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.orsunpay.com/api-reference/usage-billing/create-a-usage-plan#apireference\",\"headline\":\"Create a usage plan\",\"name\":\"Create a usage plan\",\"description\":\"Create immutable pricing terms for customer usage, scoped to the authenticated merchant API key and its live/test mode. Monthly price uses currency precision; credits and overage rate allow six fractional digits. Reusing a code with identical terms returns the plan; changed terms conflict.\",\"url\":\"https://docs.orsunpay.com/api-reference/usage-billing/create-a-usage-plan\",\"mainEntityOfPage\":{\"@id\":\"https://docs.orsunpay.com/api-reference/usage-billing/create-a-usage-plan#webpage\"},\"dateModified\":\"2026-11-06T02:29:57.134Z\",\"publisher\":{\"@id\":\"https://docs.orsunpay.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.orsunpay.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"OrsunPay\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"OrsunPay","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"Using the API","pages":[{"title":"Merchant API reference","sidebarTitle":"API overview","href":"/api-overview"}]},{"group":"Endpoints","pages":[{"group":"Cashier player","pages":[{"title":"Create a crypto invoice","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/cashier-ui/crypto/invoices","href":"/api-reference/cashier-player/create-a-crypto-invoice"},{"title":"Retrieve a crypto invoice","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/cashier-ui/crypto/invoices/{id}","href":"/api-reference/cashier-player/retrieve-a-crypto-invoice"},{"title":"Quote a crypto deposit","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/cashier-ui/crypto/quote","href":"/api-reference/cashier-player/quote-a-crypto-deposit"},{"title":"List eligible deposit methods","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/cashier-ui/methods","href":"/api-reference/cashier-player/list-eligible-deposit-methods"},{"title":"List cashier operations","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/cashier-ui/operations","href":"/api-reference/cashier-player/list-cashier-operations"},{"title":"Submit a deposit","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/cashier-ui/operations","href":"/api-reference/cashier-player/submit-a-deposit"},{"title":"Retrieve a cashier operation","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/cashier-ui/operations/{id}","href":"/api-reference/cashier-player/retrieve-a-cashier-operation"},{"title":"Quote a deposit","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/cashier-ui/quote","href":"/api-reference/cashier-player/quote-a-deposit"},{"title":"Refresh cashier authorization","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/cashier-ui/reauthorize","href":"/api-reference/cashier-player/refresh-cashier-authorization"},{"title":"Read the authenticated player cashier and its currency","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/cashier-ui/session","href":"/api-reference/cashier-player/read-the-authenticated-player-cashier-and-its-currency"},{"title":"Read the immutable presentation pinned when the player session was created","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/cashier-ui/template","href":"/api-reference/cashier-player/read-the-immutable-presentation-pinned-when-the-player-session-was-created"},{"title":"List withdrawals","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/cashier-ui/withdrawals","href":"/api-reference/cashier-player/list-withdrawals"},{"title":"Request a withdrawal","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/cashier-ui/withdrawals","href":"/api-reference/cashier-player/request-a-withdrawal"},{"title":"List eligible withdrawal methods","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/cashier-ui/withdrawals/choices","href":"/api-reference/cashier-player/list-eligible-withdrawal-methods"},{"title":"Quote a withdrawal","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/cashier-ui/withdrawals/quote","href":"/api-reference/cashier-player/quote-a-withdrawal"},{"title":"Retrieve a withdrawal","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/cashier-ui/withdrawals/{id}","href":"/api-reference/cashier-player/retrieve-a-withdrawal"},{"title":"Cancel a withdrawal","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/cashier-ui/withdrawals/{id}/cancel","href":"/api-reference/cashier-player/cancel-a-withdrawal"},{"title":"Reconcile a withdrawal reservation","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/cashier-ui/withdrawals/{id}/reconcile-reserve","href":"/api-reference/cashier-player/reconcile-a-withdrawal-reservation"}]},{"group":"Cashier embedding policy","pages":[{"title":"Read the stored merchant frame origin; does not authorize a session","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/cashier-ui/frame-policy/{id}","href":"/api-reference/cashier-embedding-policy/read-the-stored-merchant-frame-origin;-does-not-authorize-a-session"}]},{"group":"Cashier sessions (merchant S2S)","pages":[{"title":"Authorize a player cashier from the merchant backend","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/cashier/sessions","href":"/api-reference/cashier-sessions-merchant-s2s/authorize-a-player-cashier-from-the-merchant-backend"},{"title":"Renew player access for the same bound instance","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/cashier/sessions/{id}/access-grants","href":"/api-reference/cashier-sessions-merchant-s2s/renew-player-access-for-the-same-bound-instance"},{"title":"Revoke this player cashier immediately","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/cashier/sessions/{id}/revoke","href":"/api-reference/cashier-sessions-merchant-s2s/revoke-this-player-cashier-immediately"},{"title":"Acknowledge a wallet effect","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/cashier/wallet/receipts","href":"/api-reference/cashier-sessions-merchant-s2s/acknowledge-a-wallet-effect"}]},{"group":"Payments","pages":[{"title":"List payments or find by order ID","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/payment","href":"/api-reference/payments/list-payments-or-find-by-order-id"},{"title":"Create withdrawal transaction (Payout)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/payment/payout","href":"/api-reference/payments/create-withdrawal-transaction-payout"},{"title":"Create deposit transaction (Sale)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/payment/sale","href":"/api-reference/payments/create-deposit-transaction-sale"},{"title":"Get a payment by ID","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/payment/{id}","href":"/api-reference/payments/get-a-payment-by-id"}]},{"group":"Payment links","pages":[{"title":"List the authenticated merchant’s links, newest first","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/payment-links","href":"/api-reference/payment-links/list-the-authenticated-merchant’s-links-newest-first"},{"title":"Create a merchant-scoped payment link","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/payment-links","href":"/api-reference/payment-links/create-a-merchant-scoped-payment-link"},{"title":"Get a link owned by the authenticated merchant","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/payment-links/{id}","href":"/api-reference/payment-links/get-a-link-owned-by-the-authenticated-merchant"},{"title":"Permanently deactivate a link; repeated requests are safe","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/payment-links/{id}/deactivate","href":"/api-reference/payment-links/permanently-deactivate-a-link;-repeated-requests-are-safe"}]},{"group":"Refunds","pages":[{"title":"List refunds for a payment","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/payment/{id}/refunds","href":"/api-reference/refunds/list-refunds-for-a-payment"},{"title":"Request a full or partial refund","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/payment/{id}/refunds","href":"/api-reference/refunds/request-a-full-or-partial-refund"},{"title":"Get a refund","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/refunds/{id}","href":"/api-reference/refunds/get-a-refund"}]},{"group":"Transactions","pages":[{"title":"Poll a merchant transaction","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/transactions/{id}","href":"/api-reference/transactions/poll-a-merchant-transaction"}]},{"group":"Usage billing","pages":[{"title":"Record a usage event","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/usage-billing/events","href":"/api-reference/usage-billing/record-a-usage-event"},{"title":"List usage invoices","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/usage-billing/invoices","href":"/api-reference/usage-billing/list-usage-invoices"},{"title":"List usage plans","description":"List the latest 100 pricing plans in the authenticated merchant and API-key mode. Decimal values are strings.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/usage-billing/plans","href":"/api-reference/usage-billing/list-usage-plans"},{"title":"Create a usage plan","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/usage-billing/plans","href":"/api-reference/usage-billing/create-a-usage-plan"},{"title":"List usage subscriptions","description":"List the latest 100 subscriptions in the authenticated merchant and API-key mode. Decimal values are strings.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/usage-billing/subscriptions","href":"/api-reference/usage-billing/list-usage-subscriptions"},{"title":"Create a usage subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/usage-billing/subscriptions","href":"/api-reference/usage-billing/create-a-usage-subscription"},{"title":"Get a usage subscription","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/usage-billing/subscriptions/{id}","href":"/api-reference/usage-billing/get-a-usage-subscription"},{"title":"confirmAutoRenew for a usage subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/usage-billing/subscriptions/{id}/auto-renew/confirm","href":"/api-reference/usage-billing/confirmautorenew-for-a-usage-subscription"},{"title":"disableAutoRenew for a usage subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/usage-billing/subscriptions/{id}/auto-renew/disable","href":"/api-reference/usage-billing/disableautorenew-for-a-usage-subscription"},{"title":"setupAutoRenew for a usage subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/usage-billing/subscriptions/{id}/auto-renew/setup","href":"/api-reference/usage-billing/setupautorenew-for-a-usage-subscription"},{"title":"Cancel a usage subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/usage-billing/subscriptions/{id}/cancel","href":"/api-reference/usage-billing/cancel-a-usage-subscription"},{"title":"notifications for a usage subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/usage-billing/subscriptions/{id}/notifications","href":"/api-reference/usage-billing/notifications-for-a-usage-subscription"},{"title":"paymentHistory for a usage subscription","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/usage-billing/subscriptions/{id}/payments/history","href":"/api-reference/usage-billing/paymenthistory-for-a-usage-subscription"},{"title":"recoverPayment for a usage subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/usage-billing/subscriptions/{id}/payments/recover","href":"/api-reference/usage-billing/recoverpayment-for-a-usage-subscription"},{"title":"Reconcile a usage subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/usage-billing/subscriptions/{id}/sync","href":"/api-reference/usage-billing/reconcile-a-usage-subscription"}]},{"group":"Webhooks","pages":[{"title":"Refund failed event","version":null,"deprecated":null,"openapi":"/openapi.json webhook refundFailed","href":"/api-reference/webhooks/refund-failed-event"},{"title":"Refund succeeded event","version":null,"deprecated":null,"openapi":"/openapi.json webhook refundSucceeded","href":"/api-reference/webhooks/refund-succeeded-event"},{"title":"Transaction status event","version":null,"deprecated":null,"openapi":"/openapi.json webhook transactionUpdated","href":"/api-reference/webhooks/transaction-status-event"}]}]}]},{"tab":"Payment methods","pages":[{"title":"Payment methods","href":"/payment-methods"}]},{"tab":"Workspaces","pages":[{"title":"Workspaces","href":"/merchant-cabinet"}]}]},"basePath":"","title":"Create a usage plan - OrsunPay","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-5FCzAcfS.js","utils-SLtAG4EZ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-2DZi8ZMu.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D7J3nkzE.js","snippetPresets-D0Alv0AH.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BI4qNJ2c.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BD3uyr8j.js","shallow-D8iEBr5z.js","getApiPlaygroundDisplay-CgNP4lzR.js","CodeSnippet-CX-QHuMs.js","CodeSnippets-VlXE-ZUf.js","Page-D9ithiIZ.js","getPastedJson-DYNQkZ1M.js","icon-CzacdwOi.js","MethodPill-2JVqoYKi.js","DuplicateIcon-_xVXs-U8.js","createIcon-BRHrweLo.js","DynamicMarkdown-mQG_iQiE.js","SectionHeading-DMpJzv8f.js","axios-vUo_bRtp.js","Markdown-5FGIym-8.js","clsx-D-TRO5q5.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CdrJecqK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CHlcWBLM.js"]}