{
"message": "Attempted to perform an unauthorized operation."
}
{
"message": "Unable to find an entity with the provided data."
}
Subscriptions
Delete Subscription Billing Plan
Deletes a subscription billing plan that is no longer needed.
This operation is allowed only if the plan is not currently associated with any active subscriptions.
It’s typically used during cleanup, testing, or deprecation of old pricing tiers.
Attempting to delete a plan that is still in use will result in an error.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Introduction \u0026 Quick Start","colors":{"primary":"#0070e0","light":"#0070e0","dark":"#0070e0"},"logo":{"light":"https://mintcdn.com/revolv3/Zevkr_Aqagg8mPcq/logo/normallogo.png?fit=max\u0026auto=format\u0026n=Zevkr_Aqagg8mPcq\u0026q=85\u0026s=fd4c62503540a031e3c6c968fad23f13","dark":"https://mintcdn.com/revolv3/dVOZNq0ooDKRts06/logo/darklogo.png?fit=max\u0026auto=format\u0026n=dVOZNq0ooDKRts06\u0026q=85\u0026s=fcf27915d3b41117f9ebeabfe6198322"},"favicon":"https://mintcdn.com/revolv3/UvfMtv_6fKeEgTof/e9ea213-favicon.svg?fit=max\u0026auto=format\u0026n=UvfMtv_6fKeEgTof\u0026q=85\u0026s=a6a23b31eb7fe0a95654625f1d3461b7","api":{"playground":{"display":"interactive"}},"seo":{"metatags":{"canonical":"https://docs.revolv3.com"}},"integrations":{"telemetry":{"enabled":true}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"revolv3","hasAudioNarration":false,"actualSubdomain":"revolv3","customDomains":["docs.revolv3.com"],"gitSource":{"type":"github","owner":"revolv3-dev","repo":"mintlify-revolv3-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae37d43bf26c43eb731973f","collectionId":"8de06812-a1bb-43f6-8c11-51e69eb972f5","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae37d43bf26c43eb731973f"},"feedback":{"edits":true,"issues":true,"thumbs":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae37d43bf26c43eb731973f","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"Guides","count":46},{"language":"default","tag":"API Reference","count":43},{"language":"default","tag":"Core Concepts \u0026 Data Models","count":14},{"language":"default","tag":"Integration Flows","count":10},{"language":"default","tag":"Customers","count":10},{"language":"default","tag":"Subscriptions","count":10},{"language":"default","tag":"Payment Method","count":6},{"language":"default","tag":"PaymentMethod","count":6},{"language":"default","tag":"Payments","count":6},{"language":"default","tag":"Invoice","count":5}]},"assistantConfig":{"enableAskAiButton":true,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/subscriptions/delete-subscription-billing-plan","slug":"/api-reference/subscriptions/delete-subscription-billing-plan","pageMetadata":{"title":"Delete Subscription Billing Plan","description":"Deletes a **subscription billing plan** that is no longer needed.\r\nThis operation is allowed only if the plan is **not currently associated with any active subscriptions**.\r\n\r\nIt’s typically used during cleanup, testing, or deprecation of old pricing tiers.\r\nAttempting to delete a plan that is still in use will result in an error.","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json delete /api/Subscriptions/{subscriptionId}/billing-plans/{subscriptionBillingPlanId}","href":"/api-reference/subscriptions/delete-subscription-billing-plan","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Deletes a \", _jsx(_components.strong, {\n children: \"subscription billing plan\"\n }), \" that is no longer needed.\\r\\nThis operation is allowed only if the plan is \", _jsx(_components.strong, {\n children: \"not currently associated with any active subscriptions\"\n }), \".\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"It’s typically used during cleanup, testing, or deprecation of old pricing tiers.\\r\\nAttempting to delete a plan that is still in use will result in an error.\"\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Delete Subscription Billing Plan","description":"Deletes a **subscription billing plan** that is no longer needed.\r\nThis operation is allowed only if the plan is **not currently associated with any active subscriptions**.\r\n\r\nIt’s typically used during cleanup, testing, or deprecation of old pricing tiers.\r\nAttempting to delete a plan that is still in use will result in an error.","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json delete /api/Subscriptions/{subscriptionId}/billing-plans/{subscriptionBillingPlanId}","href":"/api-reference/subscriptions/delete-subscription-billing-plan","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/revolv3/b2e6669526e8a41b/scripts/fix-swagger-auth.js"],"openApiReferenceData":{"operation":{"tags":["Subscriptions"],"summary":"Delete Subscription Billing Plan","description":"Deletes a **subscription billing plan** that is no longer needed.\r\nThis operation is allowed only if the plan is **not currently associated with any active subscriptions**.\r\n\r\nIt’s typically used during cleanup, testing, or deprecation of old pricing tiers.\r\nAttempting to delete a plan that is still in use will result in an error.","parameters":["1328663d-1bb6-47bc-96fa-6def34d0a251","a5127eb1-95d0-4841-a2a8-d216ee983feb"],"responses":{"200":"b392fadc-e191-4215-8f5d-45901ab86228","401":"fb676b44-3bab-4b8c-bd8e-66457162427d","404":"f35d1bc6-5f43-4366-aa53-bc3434b2beae"},"security":["bb9cb12a-8e0d-4c8d-99bc-04c77aff5298"],"method":"delete","type":"path","servers":["334e6eb5-634d-46b6-90d2-b0f4797cf87a"],"path":"/api/Subscriptions/{subscriptionId}/billing-plans/{subscriptionBillingPlanId}","baseUrlOptions":["https://api-sandbox.revolv3.com"],"title":"Delete Subscription Billing Plan","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"1328663d-1bb6-47bc-96fa-6def34d0a251":{"name":"subscriptionId","in":"path","required":true,"schema":{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64","isRequired":true,"uniqueKey":"","typeLabel":"integer\u003cint64>"}},"a5127eb1-95d0-4841-a2a8-d216ee983feb":{"name":"subscriptionBillingPlanId","in":"path","required":true,"schema":{"maximum":1000000000,"minimum":1,"type":"integer","format":"int32","isRequired":true,"uniqueKey":"","typeLabel":"integer\u003cint32>"}}},"responses":{"b392fadc-e191-4215-8f5d-45901ab86228":{"description":"OK","content":{"text/plain":{"schema":{"type":"object","properties":{"subscriptionId":{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64","uniqueKey":"subscriptionId","typeLabel":"integer\u003cint64>"},"customerId":{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64","uniqueKey":"customerId","typeLabel":"integer\u003cint64>"},"merchantSubscriptionRefId":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"merchantSubscriptionRefId.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"merchantSubscriptionRefId.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchantSubscriptionRefId","typeLabel":"string | null"},"networkTransactionId":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"networkTransactionId.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"networkTransactionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"networkTransactionId","typeLabel":"string | null"},"billingIntervalType":{"oneOf":[{"maxLength":50,"minLength":0,"type":"string","uniqueKey":"billingIntervalType.oneOf.0","typeLabel":"string"},{"maxLength":50,"minLength":0,"type":"null","uniqueKey":"billingIntervalType.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingIntervalType","typeLabel":"string | null"},"billingIntervalCount":{"maximum":1000000000,"minimum":1,"type":"integer","format":"int32","uniqueKey":"billingIntervalCount","typeLabel":"integer\u003cint32>"},"subscriptionStatusType":{"oneOf":[{"maxLength":50,"minLength":0,"type":"string","uniqueKey":"subscriptionStatusType.oneOf.0","typeLabel":"string"},{"maxLength":50,"minLength":0,"type":"null","uniqueKey":"subscriptionStatusType.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptionStatusType","typeLabel":"string | null"},"subscriptionCancelType":{"oneOf":[{"maxLength":50,"minLength":0,"type":"string","uniqueKey":"subscriptionCancelType.oneOf.0","typeLabel":"string"},{"maxLength":50,"minLength":0,"type":"null","uniqueKey":"subscriptionCancelType.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptionCancelType","typeLabel":"string | null"},"initialBillDate":{"oneOf":[{"maxLength":20,"minLength":0,"type":"string","uniqueKey":"initialBillDate.oneOf.0","typeLabel":"string"},{"maxLength":20,"minLength":0,"type":"null","uniqueKey":"initialBillDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"initialBillDate","typeLabel":"string | null"},"nextBillDate":{"oneOf":[{"maxLength":20,"minLength":0,"type":"string","uniqueKey":"nextBillDate.oneOf.0","typeLabel":"string"},{"maxLength":20,"minLength":0,"type":"null","uniqueKey":"nextBillDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"nextBillDate","typeLabel":"string | null"},"taxAddress":{"type":"object","properties":{"addressId":{"type":"integer","description":"The unique identifier of the address.","format":"int64","uniqueKey":"taxAddress.addressId","typeLabel":"integer\u003cint64>"},"addressLine1":{"oneOf":[{"maxLength":40,"minLength":2,"type":"string","description":"Address.","uniqueKey":"taxAddress.addressLine1.oneOf.0","typeLabel":"string"},{"maxLength":40,"minLength":2,"type":"null","description":"Address.","uniqueKey":"taxAddress.addressLine1.oneOf.1","typeLabel":"null"}],"uniqueKey":"taxAddress.addressLine1","typeLabel":"string | null"},"addressLine2":{"maxLength":40,"minLength":0,"type":"string","description":"Supplemental information for the address.","uniqueKey":"taxAddress.addressLine2","typeLabel":"string"},"city":{"oneOf":[{"maxLength":25,"minLength":2,"type":"string","description":"City.","uniqueKey":"taxAddress.city.oneOf.0","typeLabel":"string"},{"maxLength":25,"minLength":2,"type":"null","description":"City.","uniqueKey":"taxAddress.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"taxAddress.city","typeLabel":"string | null"},"state":{"oneOf":[{"maxLength":2,"minLength":2,"type":"string","description":"Two-letter state abbreviation.","uniqueKey":"taxAddress.state.oneOf.0","typeLabel":"string"},{"maxLength":2,"minLength":2,"type":"null","description":"Two-letter state abbreviation.","uniqueKey":"taxAddress.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"taxAddress.state","typeLabel":"string | null"},"postalCode":{"oneOf":[{"maxLength":20,"minLength":2,"type":"string","description":"Postal Code.","uniqueKey":"taxAddress.postalCode.oneOf.0","typeLabel":"string"},{"maxLength":20,"minLength":2,"type":"null","description":"Postal Code.","uniqueKey":"taxAddress.postalCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"taxAddress.postalCode","typeLabel":"string | null"},"phoneNumber":{"maxLength":20,"minLength":0,"type":"string","description":"The phone number associated with a payment method that is used for billing purposes.","uniqueKey":"taxAddress.phoneNumber","typeLabel":"string"},"email":{"maxLength":100,"minLength":0,"type":"string","description":"The email associated with a billing address.","format":"email","uniqueKey":"taxAddress.email","typeLabel":"string\u003cemail>"},"country":{"oneOf":[{"maxLength":2,"minLength":2,"type":"string","description":"Country.","uniqueKey":"taxAddress.country.oneOf.0","typeLabel":"string"},{"maxLength":2,"minLength":2,"type":"null","description":"Country.","uniqueKey":"taxAddress.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"taxAddress.country","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"taxAddress","typeLabel":"object"},"paymentMethodIds":{"oneOf":[{"type":"array","items":{"type":"integer","format":"int64","uniqueKey":"paymentMethodIds.oneOf.0.items.[INDEX]","typeLabel":"integer\u003cint64>"},"uniqueKey":"paymentMethodIds.oneOf.0","typeLabel":"integer\u003cint64>[]"},{"type":"null","items":{"type":"integer","format":"int64"},"uniqueKey":"paymentMethodIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethodIds","typeLabel":"integer\u003cint64>[] | null"},"cancelledAt":{"oneOf":[{"maxLength":40,"type":"string","format":"date-time","uniqueKey":"cancelledAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"maxLength":40,"type":"null","format":"date-time","uniqueKey":"cancelledAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"cancelledAt","typeLabel":"string\u003cdate-time> | null"},"billingPlans":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"subscriptionBillingPlanId":{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64","uniqueKey":"billingPlans.oneOf.0.items.[INDEX].subscriptionBillingPlanId","typeLabel":"integer\u003cint64>"},"subscriptionId":{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64","uniqueKey":"billingPlans.oneOf.0.items.[INDEX].subscriptionId","typeLabel":"integer\u003cint64>"},"name":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"billingPlans.oneOf.0.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"billingPlans.oneOf.0.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingPlans.oneOf.0.items.[INDEX].name","typeLabel":"string | null"},"value":{"maximum":10000000,"minimum":0,"type":"number","format":"double","uniqueKey":"billingPlans.oneOf.0.items.[INDEX].value","typeLabel":"number\u003cdouble>"},"startDate":{"oneOf":[{"maxLength":20,"minLength":0,"type":"string","uniqueKey":"billingPlans.oneOf.0.items.[INDEX].startDate.oneOf.0","typeLabel":"string"},{"maxLength":20,"minLength":0,"type":"null","uniqueKey":"billingPlans.oneOf.0.items.[INDEX].startDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingPlans.oneOf.0.items.[INDEX].startDate","typeLabel":"string | null"},"cyclesRemaining":{"maximum":1000000000,"minimum":0,"type":"integer","format":"int32","uniqueKey":"billingPlans.oneOf.0.items.[INDEX].cyclesRemaining","typeLabel":"integer\u003cint32>"},"cycleCount":{"maximum":100,"minimum":-1,"type":"integer","format":"int32","uniqueKey":"billingPlans.oneOf.0.items.[INDEX].cycleCount","typeLabel":"integer\u003cint32>"},"valueType":{"oneOf":[{"maxLength":50,"minLength":0,"type":"string","uniqueKey":"billingPlans.oneOf.0.items.[INDEX].valueType.oneOf.0","typeLabel":"string"},{"maxLength":50,"minLength":0,"type":"null","uniqueKey":"billingPlans.oneOf.0.items.[INDEX].valueType.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingPlans.oneOf.0.items.[INDEX].valueType","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"billingPlans.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"billingPlans.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"subscriptionBillingPlanId":{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64"},"subscriptionId":{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64"},"name":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string"},{"maxLength":100,"minLength":0,"type":"null"}]},"value":{"maximum":10000000,"minimum":0,"type":"number","format":"double"},"startDate":{"oneOf":[{"maxLength":20,"minLength":0,"type":"string"},{"maxLength":20,"minLength":0,"type":"null"}]},"cyclesRemaining":{"maximum":1000000000,"minimum":0,"type":"integer","format":"int32"},"cycleCount":{"maximum":100,"minimum":-1,"type":"integer","format":"int32"},"valueType":{"oneOf":[{"maxLength":50,"minLength":0,"type":"string"},{"maxLength":50,"minLength":0,"type":"null"}]}},"additionalProperties":false},"uniqueKey":"billingPlans.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingPlans","typeLabel":"object[] | null"},"message":{"oneOf":[{"maxLength":500,"minLength":0,"type":"string","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"maxLength":500,"minLength":0,"type":"null","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"paymentProcessor":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"paymentProcessor.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"paymentProcessor.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentProcessor","typeLabel":"string | null"},"processorMerchantId":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"processorMerchantId.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"processorMerchantId.oneOf.1","typeLabel":"null"}],"uniqueKey":"processorMerchantId","typeLabel":"string | null"},"processorRawResponse":{"oneOf":[{"maxLength":10000,"minLength":0,"type":"string","uniqueKey":"processorRawResponse.oneOf.0","typeLabel":"string"},{"maxLength":10000,"minLength":0,"type":"null","uniqueKey":"processorRawResponse.oneOf.1","typeLabel":"null"}],"uniqueKey":"processorRawResponse","typeLabel":"string | null"},"currency":{"oneOf":[{"maxLength":3,"minLength":0,"type":"string","uniqueKey":"currency.oneOf.0","typeLabel":"string"},{"maxLength":3,"minLength":0,"type":"null","uniqueKey":"currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"currency","typeLabel":"string | null"},"responseMessage":{"oneOf":[{"maxLength":500,"minLength":0,"type":"string","uniqueKey":"responseMessage.oneOf.0","typeLabel":"string"},{"maxLength":500,"minLength":0,"type":"null","uniqueKey":"responseMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"responseMessage","typeLabel":"string | null"},"responseCode":{"oneOf":[{"maxLength":10,"minLength":0,"type":"string","uniqueKey":"responseCode.oneOf.0","typeLabel":"string"},{"maxLength":10,"minLength":0,"type":"null","uniqueKey":"responseCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"responseCode","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"subscriptionId":1,"customerId":1,"merchantSubscriptionRefId":"1234-5678-9101","networkTransactionId":null,"billingIntervalType":"Months","billingIntervalCount":1,"subscriptionStatusType":"Current","subscriptionCancelType":"Immediate","initialBillDate":"10/12/2026","nextBillDate":"11/12/2026","taxAddress":null,"paymentMethodIds":[1,2],"cancelledAt":null,"billingPlans":[{"subscriptionBillingPlanId":1,"subscriptionId":0,"name":"Billing Plan 1","value":10.99,"startDate":"10/12/2026","cyclesRemaining":-1,"cycleCount":0,"valueType":"Standard"},{"subscriptionBillingPlanId":2,"subscriptionId":0,"name":"Billing Plan 2","value":14.99,"startDate":"11/12/2026","cyclesRemaining":12,"cycleCount":0,"valueType":"Standard"}],"message":null,"paymentProcessor":null,"processorMerchantId":null,"processorRawResponse":null,"currency":null,"responseMessage":null,"responseCode":null},"examples":{"Example":{"title":"Example","value":{"subscriptionId":1,"customerId":1,"merchantSubscriptionRefId":"1234-5678-9101","networkTransactionId":null,"billingIntervalType":"Months","billingIntervalCount":1,"subscriptionStatusType":"Current","subscriptionCancelType":"Immediate","initialBillDate":"10/12/2026","nextBillDate":"11/12/2026","taxAddress":null,"paymentMethodIds":[1,2],"cancelledAt":null,"billingPlans":[{"subscriptionBillingPlanId":1,"subscriptionId":0,"name":"Billing Plan 1","value":10.99,"startDate":"10/12/2026","cyclesRemaining":-1,"cycleCount":0,"valueType":"Standard"},{"subscriptionBillingPlanId":2,"subscriptionId":0,"name":"Billing Plan 2","value":14.99,"startDate":"11/12/2026","cyclesRemaining":12,"cycleCount":0,"valueType":"Standard"}],"message":null,"paymentProcessor":null,"processorMerchantId":null,"processorRawResponse":null,"currency":null,"responseMessage":null,"responseCode":null}}},"exampleType":"examples"},"application/json":{"schema":{"type":"object","properties":{"subscriptionId":{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64","uniqueKey":"subscriptionId","typeLabel":"integer\u003cint64>"},"customerId":{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64","uniqueKey":"customerId","typeLabel":"integer\u003cint64>"},"merchantSubscriptionRefId":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"merchantSubscriptionRefId.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"merchantSubscriptionRefId.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchantSubscriptionRefId","typeLabel":"string | null"},"networkTransactionId":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"networkTransactionId.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"networkTransactionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"networkTransactionId","typeLabel":"string | null"},"billingIntervalType":{"oneOf":[{"maxLength":50,"minLength":0,"type":"string","uniqueKey":"billingIntervalType.oneOf.0","typeLabel":"string"},{"maxLength":50,"minLength":0,"type":"null","uniqueKey":"billingIntervalType.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingIntervalType","typeLabel":"string | null"},"billingIntervalCount":{"maximum":1000000000,"minimum":1,"type":"integer","format":"int32","uniqueKey":"billingIntervalCount","typeLabel":"integer\u003cint32>"},"subscriptionStatusType":{"oneOf":[{"maxLength":50,"minLength":0,"type":"string","uniqueKey":"subscriptionStatusType.oneOf.0","typeLabel":"string"},{"maxLength":50,"minLength":0,"type":"null","uniqueKey":"subscriptionStatusType.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptionStatusType","typeLabel":"string | null"},"subscriptionCancelType":{"oneOf":[{"maxLength":50,"minLength":0,"type":"string","uniqueKey":"subscriptionCancelType.oneOf.0","typeLabel":"string"},{"maxLength":50,"minLength":0,"type":"null","uniqueKey":"subscriptionCancelType.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptionCancelType","typeLabel":"string | null"},"initialBillDate":{"oneOf":[{"maxLength":20,"minLength":0,"type":"string","uniqueKey":"initialBillDate.oneOf.0","typeLabel":"string"},{"maxLength":20,"minLength":0,"type":"null","uniqueKey":"initialBillDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"initialBillDate","typeLabel":"string | null"},"nextBillDate":{"oneOf":[{"maxLength":20,"minLength":0,"type":"string","uniqueKey":"nextBillDate.oneOf.0","typeLabel":"string"},{"maxLength":20,"minLength":0,"type":"null","uniqueKey":"nextBillDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"nextBillDate","typeLabel":"string | null"},"taxAddress":{"type":"object","properties":{"addressId":{"type":"integer","description":"The unique identifier of the address.","format":"int64","uniqueKey":"taxAddress.addressId","typeLabel":"integer\u003cint64>"},"addressLine1":{"oneOf":[{"maxLength":40,"minLength":2,"type":"string","description":"Address.","uniqueKey":"taxAddress.addressLine1.oneOf.0","typeLabel":"string"},{"maxLength":40,"minLength":2,"type":"null","description":"Address.","uniqueKey":"taxAddress.addressLine1.oneOf.1","typeLabel":"null"}],"uniqueKey":"taxAddress.addressLine1","typeLabel":"string | null"},"addressLine2":{"maxLength":40,"minLength":0,"type":"string","description":"Supplemental information for the address.","uniqueKey":"taxAddress.addressLine2","typeLabel":"string"},"city":{"oneOf":[{"maxLength":25,"minLength":2,"type":"string","description":"City.","uniqueKey":"taxAddress.city.oneOf.0","typeLabel":"string"},{"maxLength":25,"minLength":2,"type":"null","description":"City.","uniqueKey":"taxAddress.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"taxAddress.city","typeLabel":"string | null"},"state":{"oneOf":[{"maxLength":2,"minLength":2,"type":"string","description":"Two-letter state abbreviation.","uniqueKey":"taxAddress.state.oneOf.0","typeLabel":"string"},{"maxLength":2,"minLength":2,"type":"null","description":"Two-letter state abbreviation.","uniqueKey":"taxAddress.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"taxAddress.state","typeLabel":"string | null"},"postalCode":{"oneOf":[{"maxLength":20,"minLength":2,"type":"string","description":"Postal Code.","uniqueKey":"taxAddress.postalCode.oneOf.0","typeLabel":"string"},{"maxLength":20,"minLength":2,"type":"null","description":"Postal Code.","uniqueKey":"taxAddress.postalCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"taxAddress.postalCode","typeLabel":"string | null"},"phoneNumber":{"maxLength":20,"minLength":0,"type":"string","description":"The phone number associated with a payment method that is used for billing purposes.","uniqueKey":"taxAddress.phoneNumber","typeLabel":"string"},"email":{"maxLength":100,"minLength":0,"type":"string","description":"The email associated with a billing address.","format":"email","uniqueKey":"taxAddress.email","typeLabel":"string\u003cemail>"},"country":{"oneOf":[{"maxLength":2,"minLength":2,"type":"string","description":"Country.","uniqueKey":"taxAddress.country.oneOf.0","typeLabel":"string"},{"maxLength":2,"minLength":2,"type":"null","description":"Country.","uniqueKey":"taxAddress.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"taxAddress.country","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"taxAddress","typeLabel":"object"},"paymentMethodIds":{"oneOf":[{"type":"array","items":{"type":"integer","format":"int64","uniqueKey":"paymentMethodIds.oneOf.0.items.[INDEX]","typeLabel":"integer\u003cint64>"},"uniqueKey":"paymentMethodIds.oneOf.0","typeLabel":"integer\u003cint64>[]"},{"type":"null","items":{"type":"integer","format":"int64"},"uniqueKey":"paymentMethodIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethodIds","typeLabel":"integer\u003cint64>[] | null"},"cancelledAt":{"oneOf":[{"maxLength":40,"type":"string","format":"date-time","uniqueKey":"cancelledAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"maxLength":40,"type":"null","format":"date-time","uniqueKey":"cancelledAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"cancelledAt","typeLabel":"string\u003cdate-time> | null"},"billingPlans":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"subscriptionBillingPlanId":{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64","uniqueKey":"billingPlans.oneOf.0.items.[INDEX].subscriptionBillingPlanId","typeLabel":"integer\u003cint64>"},"subscriptionId":{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64","uniqueKey":"billingPlans.oneOf.0.items.[INDEX].subscriptionId","typeLabel":"integer\u003cint64>"},"name":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"billingPlans.oneOf.0.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"billingPlans.oneOf.0.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingPlans.oneOf.0.items.[INDEX].name","typeLabel":"string | null"},"value":{"maximum":10000000,"minimum":0,"type":"number","format":"double","uniqueKey":"billingPlans.oneOf.0.items.[INDEX].value","typeLabel":"number\u003cdouble>"},"startDate":{"oneOf":[{"maxLength":20,"minLength":0,"type":"string","uniqueKey":"billingPlans.oneOf.0.items.[INDEX].startDate.oneOf.0","typeLabel":"string"},{"maxLength":20,"minLength":0,"type":"null","uniqueKey":"billingPlans.oneOf.0.items.[INDEX].startDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingPlans.oneOf.0.items.[INDEX].startDate","typeLabel":"string | null"},"cyclesRemaining":{"maximum":1000000000,"minimum":0,"type":"integer","format":"int32","uniqueKey":"billingPlans.oneOf.0.items.[INDEX].cyclesRemaining","typeLabel":"integer\u003cint32>"},"cycleCount":{"maximum":100,"minimum":-1,"type":"integer","format":"int32","uniqueKey":"billingPlans.oneOf.0.items.[INDEX].cycleCount","typeLabel":"integer\u003cint32>"},"valueType":{"oneOf":[{"maxLength":50,"minLength":0,"type":"string","uniqueKey":"billingPlans.oneOf.0.items.[INDEX].valueType.oneOf.0","typeLabel":"string"},{"maxLength":50,"minLength":0,"type":"null","uniqueKey":"billingPlans.oneOf.0.items.[INDEX].valueType.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingPlans.oneOf.0.items.[INDEX].valueType","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"billingPlans.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"billingPlans.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"subscriptionBillingPlanId":{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64"},"subscriptionId":{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64"},"name":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string"},{"maxLength":100,"minLength":0,"type":"null"}]},"value":{"maximum":10000000,"minimum":0,"type":"number","format":"double"},"startDate":{"oneOf":[{"maxLength":20,"minLength":0,"type":"string"},{"maxLength":20,"minLength":0,"type":"null"}]},"cyclesRemaining":{"maximum":1000000000,"minimum":0,"type":"integer","format":"int32"},"cycleCount":{"maximum":100,"minimum":-1,"type":"integer","format":"int32"},"valueType":{"oneOf":[{"maxLength":50,"minLength":0,"type":"string"},{"maxLength":50,"minLength":0,"type":"null"}]}},"additionalProperties":false},"uniqueKey":"billingPlans.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingPlans","typeLabel":"object[] | null"},"message":{"oneOf":[{"maxLength":500,"minLength":0,"type":"string","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"maxLength":500,"minLength":0,"type":"null","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"paymentProcessor":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"paymentProcessor.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"paymentProcessor.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentProcessor","typeLabel":"string | null"},"processorMerchantId":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"processorMerchantId.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"processorMerchantId.oneOf.1","typeLabel":"null"}],"uniqueKey":"processorMerchantId","typeLabel":"string | null"},"processorRawResponse":{"oneOf":[{"maxLength":10000,"minLength":0,"type":"string","uniqueKey":"processorRawResponse.oneOf.0","typeLabel":"string"},{"maxLength":10000,"minLength":0,"type":"null","uniqueKey":"processorRawResponse.oneOf.1","typeLabel":"null"}],"uniqueKey":"processorRawResponse","typeLabel":"string | null"},"currency":{"oneOf":[{"maxLength":3,"minLength":0,"type":"string","uniqueKey":"currency.oneOf.0","typeLabel":"string"},{"maxLength":3,"minLength":0,"type":"null","uniqueKey":"currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"currency","typeLabel":"string | null"},"responseMessage":{"oneOf":[{"maxLength":500,"minLength":0,"type":"string","uniqueKey":"responseMessage.oneOf.0","typeLabel":"string"},{"maxLength":500,"minLength":0,"type":"null","uniqueKey":"responseMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"responseMessage","typeLabel":"string | null"},"responseCode":{"oneOf":[{"maxLength":10,"minLength":0,"type":"string","uniqueKey":"responseCode.oneOf.0","typeLabel":"string"},{"maxLength":10,"minLength":0,"type":"null","uniqueKey":"responseCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"responseCode","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"subscriptionId":1,"customerId":1,"merchantSubscriptionRefId":"1234-5678-9101","networkTransactionId":null,"billingIntervalType":"Months","billingIntervalCount":1,"subscriptionStatusType":"Current","subscriptionCancelType":"Immediate","initialBillDate":"10/12/2026","nextBillDate":"11/12/2026","taxAddress":null,"paymentMethodIds":[1,2],"cancelledAt":null,"billingPlans":[{"subscriptionBillingPlanId":1,"subscriptionId":0,"name":"Billing Plan 1","value":10.99,"startDate":"10/12/2026","cyclesRemaining":-1,"cycleCount":0,"valueType":"Standard"},{"subscriptionBillingPlanId":2,"subscriptionId":0,"name":"Billing Plan 2","value":14.99,"startDate":"11/12/2026","cyclesRemaining":12,"cycleCount":0,"valueType":"Standard"}],"message":null,"paymentProcessor":null,"processorMerchantId":null,"processorRawResponse":null,"currency":null,"responseMessage":null,"responseCode":null},"examples":{"Example":{"title":"Example","value":{"subscriptionId":1,"customerId":1,"merchantSubscriptionRefId":"1234-5678-9101","networkTransactionId":null,"billingIntervalType":"Months","billingIntervalCount":1,"subscriptionStatusType":"Current","subscriptionCancelType":"Immediate","initialBillDate":"10/12/2026","nextBillDate":"11/12/2026","taxAddress":null,"paymentMethodIds":[1,2],"cancelledAt":null,"billingPlans":[{"subscriptionBillingPlanId":1,"subscriptionId":0,"name":"Billing Plan 1","value":10.99,"startDate":"10/12/2026","cyclesRemaining":-1,"cycleCount":0,"valueType":"Standard"},{"subscriptionBillingPlanId":2,"subscriptionId":0,"name":"Billing Plan 2","value":14.99,"startDate":"11/12/2026","cyclesRemaining":12,"cycleCount":0,"valueType":"Standard"}],"message":null,"paymentProcessor":null,"processorMerchantId":null,"processorRawResponse":null,"currency":null,"responseMessage":null,"responseCode":null}}},"exampleType":"examples"},"text/json":{"schema":{"type":"object","properties":{"subscriptionId":{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64","uniqueKey":"subscriptionId","typeLabel":"integer\u003cint64>"},"customerId":{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64","uniqueKey":"customerId","typeLabel":"integer\u003cint64>"},"merchantSubscriptionRefId":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"merchantSubscriptionRefId.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"merchantSubscriptionRefId.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchantSubscriptionRefId","typeLabel":"string | null"},"networkTransactionId":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"networkTransactionId.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"networkTransactionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"networkTransactionId","typeLabel":"string | null"},"billingIntervalType":{"oneOf":[{"maxLength":50,"minLength":0,"type":"string","uniqueKey":"billingIntervalType.oneOf.0","typeLabel":"string"},{"maxLength":50,"minLength":0,"type":"null","uniqueKey":"billingIntervalType.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingIntervalType","typeLabel":"string | null"},"billingIntervalCount":{"maximum":1000000000,"minimum":1,"type":"integer","format":"int32","uniqueKey":"billingIntervalCount","typeLabel":"integer\u003cint32>"},"subscriptionStatusType":{"oneOf":[{"maxLength":50,"minLength":0,"type":"string","uniqueKey":"subscriptionStatusType.oneOf.0","typeLabel":"string"},{"maxLength":50,"minLength":0,"type":"null","uniqueKey":"subscriptionStatusType.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptionStatusType","typeLabel":"string | null"},"subscriptionCancelType":{"oneOf":[{"maxLength":50,"minLength":0,"type":"string","uniqueKey":"subscriptionCancelType.oneOf.0","typeLabel":"string"},{"maxLength":50,"minLength":0,"type":"null","uniqueKey":"subscriptionCancelType.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptionCancelType","typeLabel":"string | null"},"initialBillDate":{"oneOf":[{"maxLength":20,"minLength":0,"type":"string","uniqueKey":"initialBillDate.oneOf.0","typeLabel":"string"},{"maxLength":20,"minLength":0,"type":"null","uniqueKey":"initialBillDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"initialBillDate","typeLabel":"string | null"},"nextBillDate":{"oneOf":[{"maxLength":20,"minLength":0,"type":"string","uniqueKey":"nextBillDate.oneOf.0","typeLabel":"string"},{"maxLength":20,"minLength":0,"type":"null","uniqueKey":"nextBillDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"nextBillDate","typeLabel":"string | null"},"taxAddress":{"type":"object","properties":{"addressId":{"type":"integer","description":"The unique identifier of the address.","format":"int64","uniqueKey":"taxAddress.addressId","typeLabel":"integer\u003cint64>"},"addressLine1":{"oneOf":[{"maxLength":40,"minLength":2,"type":"string","description":"Address.","uniqueKey":"taxAddress.addressLine1.oneOf.0","typeLabel":"string"},{"maxLength":40,"minLength":2,"type":"null","description":"Address.","uniqueKey":"taxAddress.addressLine1.oneOf.1","typeLabel":"null"}],"uniqueKey":"taxAddress.addressLine1","typeLabel":"string | null"},"addressLine2":{"maxLength":40,"minLength":0,"type":"string","description":"Supplemental information for the address.","uniqueKey":"taxAddress.addressLine2","typeLabel":"string"},"city":{"oneOf":[{"maxLength":25,"minLength":2,"type":"string","description":"City.","uniqueKey":"taxAddress.city.oneOf.0","typeLabel":"string"},{"maxLength":25,"minLength":2,"type":"null","description":"City.","uniqueKey":"taxAddress.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"taxAddress.city","typeLabel":"string | null"},"state":{"oneOf":[{"maxLength":2,"minLength":2,"type":"string","description":"Two-letter state abbreviation.","uniqueKey":"taxAddress.state.oneOf.0","typeLabel":"string"},{"maxLength":2,"minLength":2,"type":"null","description":"Two-letter state abbreviation.","uniqueKey":"taxAddress.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"taxAddress.state","typeLabel":"string | null"},"postalCode":{"oneOf":[{"maxLength":20,"minLength":2,"type":"string","description":"Postal Code.","uniqueKey":"taxAddress.postalCode.oneOf.0","typeLabel":"string"},{"maxLength":20,"minLength":2,"type":"null","description":"Postal Code.","uniqueKey":"taxAddress.postalCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"taxAddress.postalCode","typeLabel":"string | null"},"phoneNumber":{"maxLength":20,"minLength":0,"type":"string","description":"The phone number associated with a payment method that is used for billing purposes.","uniqueKey":"taxAddress.phoneNumber","typeLabel":"string"},"email":{"maxLength":100,"minLength":0,"type":"string","description":"The email associated with a billing address.","format":"email","uniqueKey":"taxAddress.email","typeLabel":"string\u003cemail>"},"country":{"oneOf":[{"maxLength":2,"minLength":2,"type":"string","description":"Country.","uniqueKey":"taxAddress.country.oneOf.0","typeLabel":"string"},{"maxLength":2,"minLength":2,"type":"null","description":"Country.","uniqueKey":"taxAddress.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"taxAddress.country","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"taxAddress","typeLabel":"object"},"paymentMethodIds":{"oneOf":[{"type":"array","items":{"type":"integer","format":"int64","uniqueKey":"paymentMethodIds.oneOf.0.items.[INDEX]","typeLabel":"integer\u003cint64>"},"uniqueKey":"paymentMethodIds.oneOf.0","typeLabel":"integer\u003cint64>[]"},{"type":"null","items":{"type":"integer","format":"int64"},"uniqueKey":"paymentMethodIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethodIds","typeLabel":"integer\u003cint64>[] | null"},"cancelledAt":{"oneOf":[{"maxLength":40,"type":"string","format":"date-time","uniqueKey":"cancelledAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"maxLength":40,"type":"null","format":"date-time","uniqueKey":"cancelledAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"cancelledAt","typeLabel":"string\u003cdate-time> | null"},"billingPlans":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"subscriptionBillingPlanId":{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64","uniqueKey":"billingPlans.oneOf.0.items.[INDEX].subscriptionBillingPlanId","typeLabel":"integer\u003cint64>"},"subscriptionId":{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64","uniqueKey":"billingPlans.oneOf.0.items.[INDEX].subscriptionId","typeLabel":"integer\u003cint64>"},"name":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"billingPlans.oneOf.0.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"billingPlans.oneOf.0.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingPlans.oneOf.0.items.[INDEX].name","typeLabel":"string | null"},"value":{"maximum":10000000,"minimum":0,"type":"number","format":"double","uniqueKey":"billingPlans.oneOf.0.items.[INDEX].value","typeLabel":"number\u003cdouble>"},"startDate":{"oneOf":[{"maxLength":20,"minLength":0,"type":"string","uniqueKey":"billingPlans.oneOf.0.items.[INDEX].startDate.oneOf.0","typeLabel":"string"},{"maxLength":20,"minLength":0,"type":"null","uniqueKey":"billingPlans.oneOf.0.items.[INDEX].startDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingPlans.oneOf.0.items.[INDEX].startDate","typeLabel":"string | null"},"cyclesRemaining":{"maximum":1000000000,"minimum":0,"type":"integer","format":"int32","uniqueKey":"billingPlans.oneOf.0.items.[INDEX].cyclesRemaining","typeLabel":"integer\u003cint32>"},"cycleCount":{"maximum":100,"minimum":-1,"type":"integer","format":"int32","uniqueKey":"billingPlans.oneOf.0.items.[INDEX].cycleCount","typeLabel":"integer\u003cint32>"},"valueType":{"oneOf":[{"maxLength":50,"minLength":0,"type":"string","uniqueKey":"billingPlans.oneOf.0.items.[INDEX].valueType.oneOf.0","typeLabel":"string"},{"maxLength":50,"minLength":0,"type":"null","uniqueKey":"billingPlans.oneOf.0.items.[INDEX].valueType.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingPlans.oneOf.0.items.[INDEX].valueType","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"billingPlans.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"billingPlans.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"subscriptionBillingPlanId":{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64"},"subscriptionId":{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64"},"name":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string"},{"maxLength":100,"minLength":0,"type":"null"}]},"value":{"maximum":10000000,"minimum":0,"type":"number","format":"double"},"startDate":{"oneOf":[{"maxLength":20,"minLength":0,"type":"string"},{"maxLength":20,"minLength":0,"type":"null"}]},"cyclesRemaining":{"maximum":1000000000,"minimum":0,"type":"integer","format":"int32"},"cycleCount":{"maximum":100,"minimum":-1,"type":"integer","format":"int32"},"valueType":{"oneOf":[{"maxLength":50,"minLength":0,"type":"string"},{"maxLength":50,"minLength":0,"type":"null"}]}},"additionalProperties":false},"uniqueKey":"billingPlans.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingPlans","typeLabel":"object[] | null"},"message":{"oneOf":[{"maxLength":500,"minLength":0,"type":"string","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"maxLength":500,"minLength":0,"type":"null","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"paymentProcessor":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"paymentProcessor.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"paymentProcessor.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentProcessor","typeLabel":"string | null"},"processorMerchantId":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"processorMerchantId.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"processorMerchantId.oneOf.1","typeLabel":"null"}],"uniqueKey":"processorMerchantId","typeLabel":"string | null"},"processorRawResponse":{"oneOf":[{"maxLength":10000,"minLength":0,"type":"string","uniqueKey":"processorRawResponse.oneOf.0","typeLabel":"string"},{"maxLength":10000,"minLength":0,"type":"null","uniqueKey":"processorRawResponse.oneOf.1","typeLabel":"null"}],"uniqueKey":"processorRawResponse","typeLabel":"string | null"},"currency":{"oneOf":[{"maxLength":3,"minLength":0,"type":"string","uniqueKey":"currency.oneOf.0","typeLabel":"string"},{"maxLength":3,"minLength":0,"type":"null","uniqueKey":"currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"currency","typeLabel":"string | null"},"responseMessage":{"oneOf":[{"maxLength":500,"minLength":0,"type":"string","uniqueKey":"responseMessage.oneOf.0","typeLabel":"string"},{"maxLength":500,"minLength":0,"type":"null","uniqueKey":"responseMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"responseMessage","typeLabel":"string | null"},"responseCode":{"oneOf":[{"maxLength":10,"minLength":0,"type":"string","uniqueKey":"responseCode.oneOf.0","typeLabel":"string"},{"maxLength":10,"minLength":0,"type":"null","uniqueKey":"responseCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"responseCode","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"subscriptionId":1,"customerId":1,"merchantSubscriptionRefId":"1234-5678-9101","networkTransactionId":null,"billingIntervalType":"Months","billingIntervalCount":1,"subscriptionStatusType":"Current","subscriptionCancelType":"Immediate","initialBillDate":"10/12/2026","nextBillDate":"11/12/2026","taxAddress":null,"paymentMethodIds":[1,2],"cancelledAt":null,"billingPlans":[{"subscriptionBillingPlanId":1,"subscriptionId":0,"name":"Billing Plan 1","value":10.99,"startDate":"10/12/2026","cyclesRemaining":-1,"cycleCount":0,"valueType":"Standard"},{"subscriptionBillingPlanId":2,"subscriptionId":0,"name":"Billing Plan 2","value":14.99,"startDate":"11/12/2026","cyclesRemaining":12,"cycleCount":0,"valueType":"Standard"}],"message":null,"paymentProcessor":null,"processorMerchantId":null,"processorRawResponse":null,"currency":null,"responseMessage":null,"responseCode":null},"examples":{"Example":{"title":"Example","value":{"subscriptionId":1,"customerId":1,"merchantSubscriptionRefId":"1234-5678-9101","networkTransactionId":null,"billingIntervalType":"Months","billingIntervalCount":1,"subscriptionStatusType":"Current","subscriptionCancelType":"Immediate","initialBillDate":"10/12/2026","nextBillDate":"11/12/2026","taxAddress":null,"paymentMethodIds":[1,2],"cancelledAt":null,"billingPlans":[{"subscriptionBillingPlanId":1,"subscriptionId":0,"name":"Billing Plan 1","value":10.99,"startDate":"10/12/2026","cyclesRemaining":-1,"cycleCount":0,"valueType":"Standard"},{"subscriptionBillingPlanId":2,"subscriptionId":0,"name":"Billing Plan 2","value":14.99,"startDate":"11/12/2026","cyclesRemaining":12,"cycleCount":0,"valueType":"Standard"}],"message":null,"paymentProcessor":null,"processorMerchantId":null,"processorRawResponse":null,"currency":null,"responseMessage":null,"responseCode":null}}},"exampleType":"examples"}},"exampleType":"examples"},"fb676b44-3bab-4b8c-bd8e-66457162427d":{"description":"Unauthorized","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"errors":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"string[] | null"},"fluentValidatorErrors":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"propertyName":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName","typeLabel":"string | null"},"errorMessage":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage","typeLabel":"string | null"},"attemptedValue":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].attemptedValue.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].attemptedValue","typeLabel":"null"},"customState":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].customState.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].customState","typeLabel":"null"},"severity":{"enum":["Error","Warning","Info"],"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"errorCode":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode","typeLabel":"string | null"},"formattedMessagePlaceholderValues":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0.additionalProperties","typeLabel":"null"},"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1.additionalProperties","typeLabel":"null"},"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"fluentValidatorErrors.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"propertyName":{"oneOf":[{"type":"string"},{"type":"null"}]},"errorMessage":{"oneOf":[{"type":"string"},{"type":"null"}]},"attemptedValue":{"oneOf":[{},{"type":"null"}]},"customState":{"oneOf":[{},{"type":"null"}]},"severity":{"enum":["Error","Warning","Info"],"type":"string"},"errorCode":{"oneOf":[{"type":"string"},{"type":"null"}]},"formattedMessagePlaceholderValues":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null"}]}},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null"}]}}]}},"additionalProperties":false},"uniqueKey":"fluentValidatorErrors.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors","typeLabel":"object[] | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"message":"Attempted to perform an unauthorized operation."},"examples":{"Example":{"title":"Example","value":{"message":"Attempted to perform an unauthorized operation."}}},"exampleType":"examples"},"application/json":{"schema":{"type":"object","properties":{"message":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"errors":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"string[] | null"},"fluentValidatorErrors":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"propertyName":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName","typeLabel":"string | null"},"errorMessage":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage","typeLabel":"string | null"},"attemptedValue":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].attemptedValue.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].attemptedValue","typeLabel":"null"},"customState":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].customState.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].customState","typeLabel":"null"},"severity":{"enum":["Error","Warning","Info"],"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"errorCode":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode","typeLabel":"string | null"},"formattedMessagePlaceholderValues":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0.additionalProperties","typeLabel":"null"},"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1.additionalProperties","typeLabel":"null"},"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"fluentValidatorErrors.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"propertyName":{"oneOf":[{"type":"string"},{"type":"null"}]},"errorMessage":{"oneOf":[{"type":"string"},{"type":"null"}]},"attemptedValue":{"oneOf":[{},{"type":"null"}]},"customState":{"oneOf":[{},{"type":"null"}]},"severity":{"enum":["Error","Warning","Info"],"type":"string"},"errorCode":{"oneOf":[{"type":"string"},{"type":"null"}]},"formattedMessagePlaceholderValues":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null"}]}},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null"}]}}]}},"additionalProperties":false},"uniqueKey":"fluentValidatorErrors.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors","typeLabel":"object[] | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"message":"Attempted to perform an unauthorized operation."},"examples":{"Example":{"title":"Example","value":{"message":"Attempted to perform an unauthorized operation."}}},"exampleType":"examples"},"text/json":{"schema":{"type":"object","properties":{"message":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"errors":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"string[] | null"},"fluentValidatorErrors":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"propertyName":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName","typeLabel":"string | null"},"errorMessage":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage","typeLabel":"string | null"},"attemptedValue":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].attemptedValue.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].attemptedValue","typeLabel":"null"},"customState":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].customState.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].customState","typeLabel":"null"},"severity":{"enum":["Error","Warning","Info"],"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"errorCode":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode","typeLabel":"string | null"},"formattedMessagePlaceholderValues":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0.additionalProperties","typeLabel":"null"},"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1.additionalProperties","typeLabel":"null"},"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"fluentValidatorErrors.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"propertyName":{"oneOf":[{"type":"string"},{"type":"null"}]},"errorMessage":{"oneOf":[{"type":"string"},{"type":"null"}]},"attemptedValue":{"oneOf":[{},{"type":"null"}]},"customState":{"oneOf":[{},{"type":"null"}]},"severity":{"enum":["Error","Warning","Info"],"type":"string"},"errorCode":{"oneOf":[{"type":"string"},{"type":"null"}]},"formattedMessagePlaceholderValues":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null"}]}},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null"}]}}]}},"additionalProperties":false},"uniqueKey":"fluentValidatorErrors.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors","typeLabel":"object[] | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"message":"Attempted to perform an unauthorized operation."},"examples":{"Example":{"title":"Example","value":{"message":"Attempted to perform an unauthorized operation."}}},"exampleType":"examples"}},"exampleType":"examples"},"f35d1bc6-5f43-4366-aa53-bc3434b2beae":{"description":"Not Found","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"errors":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"string[] | null"},"fluentValidatorErrors":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"propertyName":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName","typeLabel":"string | null"},"errorMessage":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage","typeLabel":"string | null"},"attemptedValue":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].attemptedValue.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].attemptedValue","typeLabel":"null"},"customState":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].customState.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].customState","typeLabel":"null"},"severity":{"enum":["Error","Warning","Info"],"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"errorCode":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode","typeLabel":"string | null"},"formattedMessagePlaceholderValues":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0.additionalProperties","typeLabel":"null"},"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1.additionalProperties","typeLabel":"null"},"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"fluentValidatorErrors.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"propertyName":{"oneOf":[{"type":"string"},{"type":"null"}]},"errorMessage":{"oneOf":[{"type":"string"},{"type":"null"}]},"attemptedValue":{"oneOf":[{},{"type":"null"}]},"customState":{"oneOf":[{},{"type":"null"}]},"severity":{"enum":["Error","Warning","Info"],"type":"string"},"errorCode":{"oneOf":[{"type":"string"},{"type":"null"}]},"formattedMessagePlaceholderValues":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null"}]}},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null"}]}}]}},"additionalProperties":false},"uniqueKey":"fluentValidatorErrors.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors","typeLabel":"object[] | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"message":"Unable to find an entity with the provided data."},"examples":{"Example":{"title":"Example","value":{"message":"Unable to find an entity with the provided data."}}},"exampleType":"examples"},"application/json":{"schema":{"type":"object","properties":{"message":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"errors":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"string[] | null"},"fluentValidatorErrors":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"propertyName":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName","typeLabel":"string | null"},"errorMessage":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage","typeLabel":"string | null"},"attemptedValue":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].attemptedValue.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].attemptedValue","typeLabel":"null"},"customState":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].customState.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].customState","typeLabel":"null"},"severity":{"enum":["Error","Warning","Info"],"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"errorCode":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode","typeLabel":"string | null"},"formattedMessagePlaceholderValues":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0.additionalProperties","typeLabel":"null"},"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1.additionalProperties","typeLabel":"null"},"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"fluentValidatorErrors.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"propertyName":{"oneOf":[{"type":"string"},{"type":"null"}]},"errorMessage":{"oneOf":[{"type":"string"},{"type":"null"}]},"attemptedValue":{"oneOf":[{},{"type":"null"}]},"customState":{"oneOf":[{},{"type":"null"}]},"severity":{"enum":["Error","Warning","Info"],"type":"string"},"errorCode":{"oneOf":[{"type":"string"},{"type":"null"}]},"formattedMessagePlaceholderValues":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null"}]}},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null"}]}}]}},"additionalProperties":false},"uniqueKey":"fluentValidatorErrors.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors","typeLabel":"object[] | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"message":"Unable to find an entity with the provided data."},"examples":{"Example":{"title":"Example","value":{"message":"Unable to find an entity with the provided data."}}},"exampleType":"examples"},"text/json":{"schema":{"type":"object","properties":{"message":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"errors":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"string[] | null"},"fluentValidatorErrors":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"propertyName":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName","typeLabel":"string | null"},"errorMessage":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage","typeLabel":"string | null"},"attemptedValue":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].attemptedValue.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].attemptedValue","typeLabel":"null"},"customState":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].customState.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].customState","typeLabel":"null"},"severity":{"enum":["Error","Warning","Info"],"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"errorCode":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode","typeLabel":"string | null"},"formattedMessagePlaceholderValues":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0.additionalProperties","typeLabel":"null"},"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1.additionalProperties","typeLabel":"null"},"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"fluentValidatorErrors.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"propertyName":{"oneOf":[{"type":"string"},{"type":"null"}]},"errorMessage":{"oneOf":[{"type":"string"},{"type":"null"}]},"attemptedValue":{"oneOf":[{},{"type":"null"}]},"customState":{"oneOf":[{},{"type":"null"}]},"severity":{"enum":["Error","Warning","Info"],"type":"string"},"errorCode":{"oneOf":[{"type":"string"},{"type":"null"}]},"formattedMessagePlaceholderValues":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null"}]}},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null"}]}}]}},"additionalProperties":false},"uniqueKey":"fluentValidatorErrors.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors","typeLabel":"object[] | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"message":"Unable to find an entity with the provided data."},"examples":{"Example":{"title":"Example","value":{"message":"Unable to find an entity with the provided data."}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"bb9cb12a-8e0d-4c8d-99bc-04c77aff5298":{"XRevolv3Token":{"type":"apiKey","in":"header","name":"x-revolv3-token","scopes":[],"schemeName":"XRevolv3Token"}}},"servers":{"334e6eb5-634d-46b6-90d2-b0f4797cf87a":{"url":"https://api-sandbox.revolv3.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-revolv3-token","scopes":[],"schemeName":"XRevolv3Token"},"schema":{"title":"x-revolv3-token","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"XRevolv3Token","name":"x-revolv3-token"}],"title":"XRevolv3Token"}]},"originalFileLocation":"api-reference/swagger.json"},"subdomain":"revolv3","siteName":"Introduction \u0026 Quick Start","title":"Delete Subscription Billing Plan - Introduction \u0026 Quick Start","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-13T22:34:18.121Z","originalFileLocation":"api-reference/subscriptions/delete-subscription-billing-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=\"Deletes a subscription billing plan that is no longer needed. This operation is allowed only if the plan is not currently associated with any active subscriptions. It’s typically used during cleanup, testing, or deprecation of old pricing tiers. Attempting to delete a plan that is still in use will result in an error.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Introduction \u0026amp; Quick Start\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/revolv3/SEFZpst3yZfiH2vQ/_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/revolv3/SEFZpst3yZfiH2vQ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/revolv3/SEFZpst3yZfiH2vQ/_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/revolv3/SEFZpst3yZfiH2vQ/_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/revolv3/SEFZpst3yZfiH2vQ/_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/revolv3/SEFZpst3yZfiH2vQ/_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/revolv3/SEFZpst3yZfiH2vQ/_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/revolv3/SEFZpst3yZfiH2vQ/_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/revolv3/SEFZpst3yZfiH2vQ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Delete Subscription Billing Plan - Introduction \u0026amp; Quick Start\">\u003cmeta data-mint-head property=\"og:description\" content=\"Deletes a subscription billing plan that is no longer needed. This operation is allowed only if the plan is not currently associated with any active subscriptions. It’s typically used during cleanup, testing, or deprecation of old pricing tiers. Attempting to delete a plan that is still in use will result in an error.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Introduction \u0026amp; Quick Start\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.revolv3.com/api-reference/subscriptions/delete-subscription-billing-plan\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://revolv3.mintlify.app/_mintlify/api/og/v2?division=Subscriptions\u0026amp;title=Delete+Subscription+Billing+Plan\u0026amp;description=Deletes+a+**subscription+billing+plan**+that+is+no+longer+needed.%0D%0AThis+operation+is+allowed+only+if+the+plan+is+**not+currently+associated+with+any+active+subs\u0026amp;theme=44ecc26a32f1a478fe3476c2\u0026amp;signature=baa0d9e62719cc4209162c40cb04d33cea99c341c2881b08bc16a609041d6918\">\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=\"Delete Subscription Billing Plan - Introduction \u0026amp; Quick Start\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Deletes a subscription billing plan that is no longer needed. This operation is allowed only if the plan is not currently associated with any active subscriptions. It’s typically used during cleanup, testing, or deprecation of old pricing tiers. Attempting to delete a plan that is still in use will result in an error.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://revolv3.mintlify.app/_mintlify/api/og/v2?division=Subscriptions\u0026amp;title=Delete+Subscription+Billing+Plan\u0026amp;description=Deletes+a+**subscription+billing+plan**+that+is+no+longer+needed.%0D%0AThis+operation+is+allowed+only+if+the+plan+is+**not+currently+associated+with+any+active+subs\u0026amp;theme=44ecc26a32f1a478fe3476c2\u0026amp;signature=baa0d9e62719cc4209162c40cb04d33cea99c341c2881b08bc16a609041d6918\">\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/revolv3/SEFZpst3yZfiH2vQ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Introduction \u0026amp; Quick Start\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0070e0\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.revolv3.com/api-reference/subscriptions/delete-subscription-billing-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/subscriptions/delete-subscription-billing-plan.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.revolv3.com/#organization\",\"name\":\"Introduction \u0026 Quick Start\",\"url\":\"https://docs.revolv3.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/revolv3/Zevkr_Aqagg8mPcq/logo/normallogo.png?fit=max\u0026auto=format\u0026n=Zevkr_Aqagg8mPcq\u0026q=85\u0026s=fd4c62503540a031e3c6c968fad23f13\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.revolv3.com#website\",\"name\":\"Introduction \u0026 Quick Start\",\"url\":\"https://docs.revolv3.com\",\"publisher\":{\"@id\":\"https://docs.revolv3.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.revolv3.com/api-reference/subscriptions/delete-subscription-billing-plan#webpage\",\"url\":\"https://docs.revolv3.com/api-reference/subscriptions/delete-subscription-billing-plan\",\"name\":\"Delete Subscription Billing Plan\",\"description\":\"Deletes a subscription billing plan that is no longer needed. This operation is allowed only if the plan is not currently associated with any active subscriptions. It’s typically used during cleanup, testing, or deprecation of old pricing tiers. Attempting to delete a plan that is still in use will result in an error.\",\"dateModified\":\"2026-10-13T22:34:18.121Z\",\"isPartOf\":{\"@id\":\"https://docs.revolv3.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.revolv3.com/api-reference/subscriptions/delete-subscription-billing-plan#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.revolv3.com/api-reference/subscriptions/delete-subscription-billing-plan#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Subscriptions\",\"item\":\"https://docs.revolv3.com/api-reference/subscriptions/get-subscriptions\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Delete Subscription Billing Plan\",\"item\":\"https://docs.revolv3.com/api-reference/subscriptions/delete-subscription-billing-plan\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.revolv3.com/api-reference/subscriptions/delete-subscription-billing-plan#apireference\",\"headline\":\"Delete Subscription Billing Plan\",\"name\":\"Delete Subscription Billing Plan\",\"description\":\"Deletes a subscription billing plan that is no longer needed. This operation is allowed only if the plan is not currently associated with any active subscriptions. It’s typically used during cleanup, testing, or deprecation of old pricing tiers. Attempting to delete a plan that is still in use will result in an error.\",\"url\":\"https://docs.revolv3.com/api-reference/subscriptions/delete-subscription-billing-plan\",\"mainEntityOfPage\":{\"@id\":\"https://docs.revolv3.com/api-reference/subscriptions/delete-subscription-billing-plan#webpage\"},\"dateModified\":\"2026-10-13T22:34:18.121Z\",\"publisher\":{\"@id\":\"https://docs.revolv3.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.revolv3.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Introduction \u0026 Quick Start\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Introduction \u0026 Quick Start","nav":{"global":null,"tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/docs/getting-started/getting-started"}]},{"tab":"API Reference","groups":[{"group":"AccountVerification","pages":[{"title":"Validate personal ACH account","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/account-verification/ach/person","href":"/api-reference/accountverification/validate-personal-ach-account"},{"title":"Validate corporate ACH account","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/account-verification/ach/corporate","href":"/api-reference/accountverification/validate-corporate-ach-account"}]},{"group":"Authentication","pages":[{"title":"Get Merchant Access Token","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/Authentication/token","href":"/api-reference/authentication/get-merchant-access-token"}]},{"group":"Checkout","pages":[{"title":"Create Checkout Link","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/Checkout","href":"/api-reference/checkout/create-checkout-link"},{"title":"Get Complete Checkout Information","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json get /api/Checkout/{checkoutUid}","href":"/api-reference/checkout/get-complete-checkout-information"}]},{"group":"Customers","pages":[{"title":"Get Customers","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json get /api/Customers","href":"/api-reference/customers/get-customers"},{"title":"Create Customer","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/Customers","href":"/api-reference/customers/create-customer"},{"title":"Get Customer","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json get /api/Customers/{customerId}","href":"/api-reference/customers/get-customer"},{"title":"Delete Customer","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json delete /api/Customers/{customerId}","href":"/api-reference/customers/delete-customer"},{"title":"Update Customer","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json patch /api/Customers/{customerId}","href":"/api-reference/customers/update-customer"},{"title":"Get Subscriptions by Customer","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json get /api/Customers/{customerId}/subscriptions","href":"/api-reference/customers/get-subscriptions-by-customer"},{"title":"Delete Customer Address","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json delete /api/Customers/{customerId}/address/{addressId}","href":"/api-reference/customers/delete-customer-address"},{"title":"Update Address","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json patch /api/Customers/{customerId}/address/{addressId}","href":"/api-reference/customers/update-address"},{"title":"Add Customer Address","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/Customers/{customerId}/address","href":"/api-reference/customers/add-customer-address"},{"title":"Search Invoices for Customer","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json get /api/Customers/{customerId}/invoices","href":"/api-reference/customers/search-invoices-for-customer"}]},{"group":"Invoices","pages":[{"title":"Get Invoices","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json get /api/Invoices","href":"/api-reference/invoices/get-invoices"},{"title":"Get Invoices V1","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json get /api/Invoices/v{version}","href":"/api-reference/invoices/get-invoices-v1"},{"title":"Get Invoice","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json get /api/Invoices/{invoiceId}","href":"/api-reference/invoices/get-invoice"},{"title":"Refund Invoice","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/Invoices/{invoiceId}/refund","href":"/api-reference/invoices/refund-invoice"},{"title":"One Time Payment Without Subscription","deprecated":true,"version":null,"openapi":"/api-reference/swagger.json post /api/Invoices/payment","href":"/api-reference/invoices/one-time-payment-without-subscription"}]},{"group":"PaymentMethod","pages":[{"title":"Create Payment Method","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/PaymentMethod","href":"/api-reference/paymentmethod/create-payment-method"},{"title":"Get Payment Method","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json get /api/PaymentMethod/{paymentMethodId}","href":"/api-reference/paymentmethod/get-payment-method"},{"title":"Delete Payment Method","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json delete /api/PaymentMethod/{paymentMethodId}","href":"/api-reference/paymentmethod/delete-payment-method"},{"title":"Update Payment Method","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json patch /api/PaymentMethod/{paymentMethodId}","href":"/api-reference/paymentmethod/update-payment-method"},{"title":"Authorize Payment Method","deprecated":true,"version":null,"openapi":"/api-reference/swagger.json post /api/PaymentMethod/authorize","href":"/api-reference/paymentmethod/authorize-payment-method"},{"title":"Reverse Authorization","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/PaymentMethod/reverse-auth","href":"/api-reference/paymentmethod/reverse-authorization"}]},{"group":"Payments","pages":[{"title":"Sale With Payment Method Details","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/Payments/sale","href":"/api-reference/payments/sale-with-payment-method-details"},{"title":"Sale With Payment Method Id","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/Payments/sale/{paymentMethodId}","href":"/api-reference/payments/sale-with-payment-method-id"},{"title":"Capture","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/Payments/capture/{paymentMethodAuthorizationId}","href":"/api-reference/payments/capture"},{"title":"Authorize With Payment Method Details","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/Payments/authorization","href":"/api-reference/payments/authorize-with-payment-method-details"},{"title":"Authorize With Payment Method Id","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/Payments/authorization/{paymentMethodId}","href":"/api-reference/payments/authorize-with-payment-method-id"},{"title":"Void","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/Payments/void/{invoiceId}","href":"/api-reference/payments/void"}]},{"group":"Subscriptions","pages":[{"title":"Get Subscriptions","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json get /api/Subscriptions","href":"/api-reference/subscriptions/get-subscriptions"},{"title":"Create Subscription","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/Subscriptions","href":"/api-reference/subscriptions/create-subscription"},{"title":"Get Subscription","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json get /api/Subscriptions/{subscriptionId}","href":"/api-reference/subscriptions/get-subscription"},{"title":"Update Subscription","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json patch /api/Subscriptions/{subscriptionId}","href":"/api-reference/subscriptions/update-subscription"},{"title":"Get Subscriptions By PAN","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/Subscriptions/pan-lookup","href":"/api-reference/subscriptions/get-subscriptions-by-pan"},{"title":"Replace Subscription Primary Payment Method","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json put /api/Subscriptions/{subscriptionId}/payment-method","href":"/api-reference/subscriptions/replace-subscription-primary-payment-method"},{"title":"Create Subscription Billing Plan","description":"Creates a **new subscription billing plan** that defines the terms for recurring charges — including amount, frequency, and optional trial configuration.\r\n\r\nYou must provide details such as plan name and amount. Optional fields include billing plan CycleCount, billing plan ValueType, and billing plan StartCycleDelay.\r\n\r\nThis endpoint is typically used by admins when configuring product offerings, tiered plans, or specific billing options.","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/Subscriptions/{subscriptionId}/billing-plans","href":"/api-reference/subscriptions/create-subscription-billing-plan"},{"title":"Delete Subscription Billing Plan","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json delete /api/Subscriptions/{subscriptionId}/billing-plans/{subscriptionBillingPlanId}","href":"/api-reference/subscriptions/delete-subscription-billing-plan"},{"title":"Create One Time Payment","description":"Creates and processes a **one-time payment under an existing subscription context**, outside of the regular billing schedule.\r\nThis is useful for charging a subscriber for additional services, setup fees, usage overages, or one-off adjustments without altering the subscription plan itself.\r\n\r\nYou must provide the `subscriptionId`, the amount and billing details.\r\nThe payment is **immediately authorized and captured**, and the transaction is linked to the subscription for reporting and tracking purposes.\r\n\r\nThis endpoint ensures flexibility in billing scenarios where extra charges are needed beyond the standard recurring invoice.\r\n\r\n⚠️ **Deprecated:** This endpoint is still supported but is no longer recommended for new integrations.\r\nPlease use the newer endpoints \u003ca href=\"/api-reference/payments/sale-with-payment-method-details\">Sale With Payment Method Details\u003c/a>, \u003ca href=\"/api-reference/payments/sale-with-payment-method-id\">Sale With Payment Method Id\u003c/a> or \u003ca href=\"/api-reference/payments/capture\">Capture\u003c/a> instead, which provides extended functionality and improved error handling.","deprecated":true,"version":null,"openapi":"/api-reference/swagger.json post /api/Subscriptions/{subscriptionId}/payment","href":"/api-reference/subscriptions/create-one-time-payment"},{"title":"Cancel Subscription","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/Subscriptions/{subscriptionId}/cancel","href":"/api-reference/subscriptions/cancel-subscription"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"title":"Delete Subscription Billing Plan - Introduction \u0026 Quick Start","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}