{
"message": "Unable to perform the request action with provided data."
}
{
"message": "Attempted to perform an unauthorized operation."
}
{
"message": "Unable to find an entity with the provided data."
}
Subscriptions
Replace Subscription Primary Payment Method
Replaces the primary payment method associated with an active subscription.
This operation is typically used when a customer updates their card, bank account, or switches to a different saved method for ongoing billing.
You must provide the subscriptionId and the new payment method details.
The new method will be used for all future charges, starting with the next billing cycle (or immediately, if a payment is due).
This endpoint helps ensure billing continuity in case of expired cards, failed payments, or customer-initiated updates.
{"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/replace-subscription-primary-payment-method","slug":"/api-reference/subscriptions/replace-subscription-primary-payment-method","pageMetadata":{"title":"Replace Subscription Primary Payment Method","description":"Replaces the **primary payment method** associated with an active subscription.\r\nThis operation is typically used when a customer updates their card, bank account, or switches to a different saved method for ongoing billing.\r\n\r\nYou must provide the `subscriptionId` and the new payment method details.\r\nThe new method will be used for all **future charges**, starting with the next billing cycle (or immediately, if a payment is due).\r\n\r\nThis endpoint helps ensure billing continuity in case of expired cards, failed payments, or customer-initiated updates.","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json put /api/Subscriptions/{subscriptionId}/payment-method","href":"/api-reference/subscriptions/replace-subscription-primary-payment-method","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 code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Replaces the \", _jsx(_components.strong, {\n children: \"primary payment method\"\n }), \" associated with an active subscription.\\r\\nThis operation is typically used when a customer updates their card, bank account, or switches to a different saved method for ongoing billing.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"You must provide the \", _jsx(_components.code, {\n children: \"subscriptionId\"\n }), \" and the new payment method details.\\r\\nThe new method will be used for all \", _jsx(_components.strong, {\n children: \"future charges\"\n }), \", starting with the next billing cycle (or immediately, if a payment is due).\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"This endpoint helps ensure billing continuity in case of expired cards, failed payments, or customer-initiated updates.\"\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":"Replace Subscription Primary Payment Method","description":"Replaces the **primary payment method** associated with an active subscription.\r\nThis operation is typically used when a customer updates their card, bank account, or switches to a different saved method for ongoing billing.\r\n\r\nYou must provide the `subscriptionId` and the new payment method details.\r\nThe new method will be used for all **future charges**, starting with the next billing cycle (or immediately, if a payment is due).\r\n\r\nThis endpoint helps ensure billing continuity in case of expired cards, failed payments, or customer-initiated updates.","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json put /api/Subscriptions/{subscriptionId}/payment-method","href":"/api-reference/subscriptions/replace-subscription-primary-payment-method","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/revolv3/b2e6669526e8a41b/scripts/fix-swagger-auth.js"],"openApiReferenceData":{"operation":{"tags":["Subscriptions"],"summary":"Replace Subscription Primary Payment Method","description":"Replaces the **primary payment method** associated with an active subscription.\r\nThis operation is typically used when a customer updates their card, bank account, or switches to a different saved method for ongoing billing.\r\n\r\nYou must provide the `subscriptionId` and the new payment method details.\r\nThe new method will be used for all **future charges**, starting with the next billing cycle (or immediately, if a payment is due).\r\n\r\nThis endpoint helps ensure billing continuity in case of expired cards, failed payments, or customer-initiated updates.","parameters":["d187fec3-820b-41b1-868f-05f9747ffd8b"],"requestBody":"44f27fc9-d172-42bc-8384-8db4ccf72a2b","responses":{"200":"8b639b2b-bcf3-4f20-831e-d3c1ab4ce921","400":"ca69dfba-648c-4b87-8c9e-edb47be3ac70","401":"afb50a5f-fd04-4d0e-8420-1d058ab93f76","404":"78729dfd-f32e-4786-bb44-fc8152137866"},"security":["4569059f-e1af-4692-b686-1ad6db63198a"],"method":"put","type":"path","servers":["334e6eb5-634d-46b6-90d2-b0f4797cf87a"],"path":"/api/Subscriptions/{subscriptionId}/payment-method","baseUrlOptions":["https://api-sandbox.revolv3.com"],"title":"Replace Subscription Primary Payment Method","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"d187fec3-820b-41b1-868f-05f9747ffd8b":{"name":"subscriptionId","in":"path","required":true,"schema":{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64","isRequired":true,"uniqueKey":"","typeLabel":"integer\u003cint64>"}}},"requestBody":{"content":{"application/json-patch+json":{"schema":{"type":"object","properties":{"existingPaymentMethod":{"type":"object","properties":{"paymentMethodAuthorizationId":{"oneOf":[{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64","uniqueKey":"existingPaymentMethod.paymentMethodAuthorizationId.oneOf.0","typeLabel":"integer\u003cint64>"},{"maximum":1000000000,"minimum":1,"type":"null","format":"int64","uniqueKey":"existingPaymentMethod.paymentMethodAuthorizationId.oneOf.1","typeLabel":"null"}],"uniqueKey":"existingPaymentMethod.paymentMethodAuthorizationId","typeLabel":"integer\u003cint64> | null"},"paymentMethodId":{"oneOf":[{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64","uniqueKey":"existingPaymentMethod.paymentMethodId.oneOf.0","typeLabel":"integer\u003cint64>"},{"maximum":1000000000,"minimum":1,"type":"null","format":"int64","uniqueKey":"existingPaymentMethod.paymentMethodId.oneOf.1","typeLabel":"null"}],"uniqueKey":"existingPaymentMethod.paymentMethodId","typeLabel":"integer\u003cint64> | null"},"taxAmount":{"oneOf":[{"maximum":10000000,"minimum":0,"type":"number","format":"double","uniqueKey":"existingPaymentMethod.taxAmount.oneOf.0","typeLabel":"number\u003cdouble>"},{"maximum":10000000,"minimum":0,"type":"null","format":"double","uniqueKey":"existingPaymentMethod.taxAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"existingPaymentMethod.taxAmount","typeLabel":"number\u003cdouble> | null"},"originalNetworkTransactionId":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"existingPaymentMethod.originalNetworkTransactionId.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"existingPaymentMethod.originalNetworkTransactionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"existingPaymentMethod.originalNetworkTransactionId","typeLabel":"string | null"},"onlinePaymentCryptogram":{"maxLength":512,"minLength":0,"type":"string","description":"Decrypted package online payment cryptogram for a digital wallet.","uniqueKey":"existingPaymentMethod.onlinePaymentCryptogram","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"existingPaymentMethod","typeLabel":"object"},"paymentMethod":{"type":"object","properties":{"billingFirstName":{"maxLength":100,"minLength":0,"type":"string","description":"**Conditional**: either both BillingFirstName and BillingLastName or BillingFullName must be provided.\r\n\r\nThe customer’s first name associated with a payment method that is used for billing purposes.","uniqueKey":"paymentMethod.billingFirstName","typeLabel":"string"},"billingLastName":{"maxLength":100,"minLength":0,"type":"string","description":"**Conditional**: either both BillingFirstName and BillingLastName or BillingFullName must be provided.\r\n\r\nThe customer’s last name associated with a payment method that is used for billing purposes.","uniqueKey":"paymentMethod.billingLastName","typeLabel":"string"},"billingFullName":{"maxLength":200,"minLength":0,"type":"string","description":"**Conditional**: either BillingFullName or both BillingFirstName and BillingLastName must be provided.\r\n\r\nThe customer’s full name associated with a payment method that is used for billing purposes. ","uniqueKey":"paymentMethod.billingFullName","typeLabel":"string"},"billingAddress":{"type":"object","description":"The address associated with a payment method that is used for billing purposes. Either an Address ID or detailed address information can be provided.","properties":{"addressLine1":{"oneOf":[{"maxLength":3000,"minLength":0,"type":"string","description":"Address.","uniqueKey":"paymentMethod.billingAddress.addressLine1.oneOf.0","typeLabel":"string"},{"maxLength":3000,"minLength":0,"type":"null","description":"Address.","uniqueKey":"paymentMethod.billingAddress.addressLine1.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingAddress.addressLine1","typeLabel":"string | null"},"addressLine2":{"maxLength":3000,"minLength":0,"type":"string","description":"Supplemental information for the address.","uniqueKey":"paymentMethod.billingAddress.addressLine2","typeLabel":"string"},"city":{"oneOf":[{"maxLength":3000,"minLength":0,"type":"string","description":"City.","uniqueKey":"paymentMethod.billingAddress.city.oneOf.0","typeLabel":"string"},{"maxLength":3000,"minLength":0,"type":"null","description":"City.","uniqueKey":"paymentMethod.billingAddress.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingAddress.city","typeLabel":"string | null"},"state":{"oneOf":[{"maxLength":2,"minLength":0,"type":"string","description":"State.","uniqueKey":"paymentMethod.billingAddress.state.oneOf.0","typeLabel":"string"},{"maxLength":2,"minLength":0,"type":"null","description":"State.","uniqueKey":"paymentMethod.billingAddress.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingAddress.state","typeLabel":"string | null"},"postalCode":{"oneOf":[{"maxLength":20,"minLength":2,"type":"string","description":"Postal Code.","uniqueKey":"paymentMethod.billingAddress.postalCode.oneOf.0","typeLabel":"string"},{"maxLength":20,"minLength":2,"type":"null","description":"Postal Code.","uniqueKey":"paymentMethod.billingAddress.postalCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingAddress.postalCode","typeLabel":"string | null"},"phoneNumber":{"maxLength":20,"minLength":7,"pattern":"^(?=.*\\d)\\+?[0-9\\s\\-\\(\\)\\.]{7,20}$","type":"string","description":"The phone number associated with a payment method that is used for billing purposes.","uniqueKey":"paymentMethod.billingAddress.phoneNumber","typeLabel":"string"},"email":{"maxLength":3000,"minLength":0,"type":"string","description":"The email associated with a billing address.","format":"email","uniqueKey":"paymentMethod.billingAddress.email","typeLabel":"string\u003cemail>"},"country":{"maxLength":2,"minLength":0,"type":"string","description":"The input must be a valid Alpha2 code, Alpha3 code, UN code, or full country name.","uniqueKey":"paymentMethod.billingAddress.country","typeLabel":"string"},"addressId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"The unique identifier of the address.","format":"int64","uniqueKey":"paymentMethod.billingAddress.addressId","typeLabel":"integer\u003cint64>"}},"additionalProperties":false,"uniqueKey":"paymentMethod.billingAddress","typeLabel":"object"},"creditCard":{"type":"object","description":"**Conditional**: one payment method type is required.\r\n\r\nPayment card information.","properties":{"paymentAccountNumber":{"maxLength":19,"minLength":8,"type":"string","description":"**Conditional**: the PAN is required if the credit card payment method type is supplied in the request.\r\nThe number must be a valid credit card number and will be verified using the Luhn algorithm. Minimum length of 8 characters. Maximum length of 25 characters.\r\n\r\nPayment Account Number (PAN).","uniqueKey":"paymentMethod.creditCard.paymentAccountNumber","typeLabel":"string"},"expirationDate":{"maxLength":7,"minLength":0,"type":"string","description":"**Conditional**: the expiration date is required if the credit card payment method type is supplied in the request.\r\n\r\nThe card expiration date.","format":"MMYY, MM/YY, MMYYYY, or MM/YYYY","uniqueKey":"paymentMethod.creditCard.expirationDate","typeLabel":"string\u003cMMYY, MM/YY, MMYYYY, or MM/YYYY>"},"securityCode":{"maxLength":4,"minLength":3,"type":"string","description":"The card verification code. It is considered best practice to always include this value for card-not-present transactions.\r\n\r\nFailure to do so may lead to higher rates of declines, an increase in chargeback cases, and/or transaction downgrades.","uniqueKey":"paymentMethod.creditCard.securityCode","typeLabel":"string"},"networkToken":{"type":"object","description":"External Network Token information.","properties":{"token":{"maxLength":19,"type":"string","description":"Network token issued by a card network for a card.","uniqueKey":"paymentMethod.creditCard.networkToken.token","typeLabel":"string"},"cryptogram":{"maxLength":40,"type":"string","description":"One-time digital “stamp” of payment. Needed for all CIT (customer-initiated transactions), and the cryptogram will have to be generated by the same TR-TSP that provisioned the token.","uniqueKey":"paymentMethod.creditCard.networkToken.cryptogram","typeLabel":"string"},"electronicCommerceIndicator":{"maxLength":2,"type":"string","description":"An online payment security label indicating whether additional protection (such as 3-D Secure) was applied.","uniqueKey":"paymentMethod.creditCard.networkToken.electronicCommerceIndicator","typeLabel":"string"},"paymentAccountReference":{"maxLength":100,"type":"string","description":"A permanent unique identifier of a payment account that a payment system assigns to a card and uses instead of a real PAN within network tokens.","uniqueKey":"paymentMethod.creditCard.networkToken.paymentAccountReference","typeLabel":"string"},"expirationDate":{"oneOf":[{"maxLength":7,"minLength":0,"type":"string","description":"Expiration date of the network token.","format":"MMYY, MM/YY, MMYYYY, or MM/YYYY","uniqueKey":"paymentMethod.creditCard.networkToken.expirationDate.oneOf.0","typeLabel":"string\u003cMMYY, MM/YY, MMYYYY, or MM/YYYY>"},{"maxLength":7,"minLength":0,"type":"null","description":"Expiration date of the network token.","format":"MMYY, MM/YY, MMYYYY, or MM/YYYY","uniqueKey":"paymentMethod.creditCard.networkToken.expirationDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.creditCard.networkToken.expirationDate","typeLabel":"string\u003cMMYY, MM/YY, MMYYYY, or MM/YYYY> | null"}},"additionalProperties":false,"uniqueKey":"paymentMethod.creditCard.networkToken","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"paymentMethod.creditCard","typeLabel":"object"},"ach":{"type":"object","description":"**Conditional**: one payment method type is required.\r\n\r\nACH account information.","required":["accountNumber","routingNumber"],"properties":{"routingNumber":{"maxLength":9,"minLength":9,"pattern":"^[0-9]{9}$","type":"string","description":"**Conditional**: the routing number is required if the ACH payment method type is supplied in the request.\r\n\r\nThe 9-digit ACH routing number of the account.","isRequired":true,"uniqueKey":"paymentMethod.ach.routingNumber","typeLabel":"string"},"accountNumber":{"maxLength":17,"minLength":4,"pattern":"^[0-9]{4,17}$","type":"string","description":"**Conditional**: the account number is required if the ACH payment method type is supplied in the request.\r\nThe length should be between 4 and 17 characters.\r\n\r\nThe US bank account number from which the payment will be debited.","isRequired":true,"uniqueKey":"paymentMethod.ach.accountNumber","typeLabel":"string"},"accountType":{"maxLength":20,"type":"string","description":"**Conditional**: the account type is required if the ACH payment method type is supplied in the request.\r\n\r\nBank account type. Allowed values: Checking, Savings. Case-insensitive.","uniqueKey":"paymentMethod.ach.accountType","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"paymentMethod.ach","typeLabel":"object"},"googlePay":{"type":"object","description":"**Conditional**: one payment method type is required.\r\n\r\nGoogle Pay information.","properties":{"googlePayPaymentDataResponse":{"type":"string","description":"**Conditional**: the GooglePayPaymentDataResponse is required if the Google Pay payment method type is supplied in the request.\r\nMust contain the valid serialized JSON object.\r\n\r\nThe data returned by Google Pay.","uniqueKey":"paymentMethod.googlePay.googlePayPaymentDataResponse","typeLabel":"string"},"googlePayDecryptedPackage":{"type":"object","description":"The Google Pay token decrypted payment data.","properties":{"applicationPrimaryAccountNumber":{"maxLength":25,"minLength":13,"pattern":"^\\d+$","type":"string","description":"Device-specific account number of the card that funds this transaction.","uniqueKey":"paymentMethod.googlePay.googlePayDecryptedPackage.applicationPrimaryAccountNumber","typeLabel":"string"},"applicationExpirationDate":{"maxLength":7,"minLength":0,"type":"string","description":"The card expiration date.","format":"MMYY, MM/YY, MMYYYY, or MM/YYYY","uniqueKey":"paymentMethod.googlePay.googlePayDecryptedPackage.applicationExpirationDate","typeLabel":"string\u003cMMYY, MM/YY, MMYYYY, or MM/YYYY>"},"electronicCommerceIndicator":{"maxLength":2,"minLength":0,"type":"string","description":"An online payment security label indicating whether additional protection (such as 3-D Secure) was applied.","uniqueKey":"paymentMethod.googlePay.googlePayDecryptedPackage.electronicCommerceIndicator","typeLabel":"string"},"onlinePaymentCryptogram":{"maxLength":512,"minLength":0,"type":"string","description":"Decrypted package online payment cryptogram for a digital wallet.","uniqueKey":"paymentMethod.googlePay.googlePayDecryptedPackage.onlinePaymentCryptogram","typeLabel":"string"},"cardBrand":{"type":"string","description":"Specifies the payment method's card brand.\r\n\r\nPossible values: Visa, Mastercard, Amex, Discover, JCB, Diners.","enum":["Visa","Mastercard","Amex","Discover","JCB","Diners"],"uniqueKey":"paymentMethod.googlePay.googlePayDecryptedPackage.cardBrand","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"paymentMethod.googlePay.googlePayDecryptedPackage","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"paymentMethod.googlePay","typeLabel":"object"},"applePay":{"type":"object","description":"**Conditional**: one payment method type is required.\r\n\r\nApple Pay information. If you have encrypted Apple Pay token data use ApplePayToken for further payments. If you have Decrypted Apple Pay token data use ApplePayDecryptedPackage.","properties":{"applePayToken":{"oneOf":[{"type":"string","uniqueKey":"paymentMethod.applePay.applePayToken.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"paymentMethod.applePay.applePayToken.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.applePay.applePayToken","typeLabel":"string | null"},"applePayDecryptedPackage":{"type":"object","description":"The Apple Pay token decrypted payment data.","properties":{"applicationPrimaryAccountNumber":{"maxLength":25,"minLength":13,"pattern":"^\\d+$","type":"string","description":"Device-specific account number of the card that funds this transaction.","uniqueKey":"paymentMethod.applePay.applePayDecryptedPackage.applicationPrimaryAccountNumber","typeLabel":"string"},"applicationExpirationDate":{"maxLength":7,"minLength":0,"type":"string","description":"The card expiration date.","format":"MMYY, MM/YY, MMYYYY, or MM/YYYY","uniqueKey":"paymentMethod.applePay.applePayDecryptedPackage.applicationExpirationDate","typeLabel":"string\u003cMMYY, MM/YY, MMYYYY, or MM/YYYY>"},"electronicCommerceIndicator":{"maxLength":2,"minLength":0,"type":"string","description":"An online payment security label indicating whether additional protection (such as 3-D Secure) was applied.","uniqueKey":"paymentMethod.applePay.applePayDecryptedPackage.electronicCommerceIndicator","typeLabel":"string"},"onlinePaymentCryptogram":{"maxLength":512,"minLength":1,"type":"string","description":"Decrypted package online payment cryptogram for a digital wallet.","uniqueKey":"paymentMethod.applePay.applePayDecryptedPackage.onlinePaymentCryptogram","typeLabel":"string"},"deviceManufacturerIdentifier":{"maxLength":20,"minLength":1,"type":"string","description":"Hex-encoded device manufacturer identifier.","uniqueKey":"paymentMethod.applePay.applePayDecryptedPackage.deviceManufacturerIdentifier","typeLabel":"string"},"cardBrand":{"type":"string","description":"Specifies the payment method's card brand.\r\n\r\nPossible values: Visa, Mastercard, Amex, Discover, JCB, Diners.","enum":["Visa","Mastercard","Amex","Discover","JCB","Diners"],"uniqueKey":"paymentMethod.applePay.applePayDecryptedPackage.cardBrand","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"paymentMethod.applePay.applePayDecryptedPackage","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"paymentMethod.applePay","typeLabel":"object"},"merchantPaymentMethodRefId":{"maxLength":100,"type":"string","description":"Merchant's unique identifier for the payment method.","uniqueKey":"paymentMethod.merchantPaymentMethodRefId","typeLabel":"string"},"taxAmount":{"oneOf":[{"maximum":10000000,"minimum":0,"type":"number","format":"double","uniqueKey":"paymentMethod.taxAmount.oneOf.0","typeLabel":"number\u003cdouble>"},{"maximum":10000000,"minimum":0,"type":"null","format":"double","uniqueKey":"paymentMethod.taxAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.taxAmount","typeLabel":"number\u003cdouble> | null"},"originalNetworkTransactionId":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"paymentMethod.originalNetworkTransactionId.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"paymentMethod.originalNetworkTransactionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.originalNetworkTransactionId","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"paymentMethod","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"existingPaymentMethod":null,"paymentMethod":{"taxAmount":2.57,"originalNetworkTransactionId":"test-transaction-id","billingAddress":{"addressId":null,"addressLine1":"100 Main Street","addressLine2":null,"city":"Irvine","state":"CA","postalCode":"92602","phoneNumber":null,"email":null,"country":"US"},"creditCard":{"paymentAccountNumber":"4111111111111111","expirationDate":"1025","securityCode":null,"networkToken":null},"ach":null,"googlePay":null,"applePay":null,"merchantPaymentMethodRefId":null,"billingFirstName":"John","billingLastName":"Doe","billingFullName":null}},"examples":{"Example":{"title":"Example","value":{"existingPaymentMethod":null,"paymentMethod":{"taxAmount":2.57,"originalNetworkTransactionId":"test-transaction-id","billingAddress":{"addressId":null,"addressLine1":"100 Main Street","addressLine2":null,"city":"Irvine","state":"CA","postalCode":"92602","phoneNumber":null,"email":null,"country":"US"},"creditCard":{"paymentAccountNumber":"4111111111111111","expirationDate":"1025","securityCode":null,"networkToken":null},"ach":null,"googlePay":null,"applePay":null,"merchantPaymentMethodRefId":null,"billingFirstName":"John","billingLastName":"Doe","billingFullName":null}}}},"exampleType":"examples"},"application/json":{"schema":{"type":"object","properties":{"existingPaymentMethod":{"type":"object","properties":{"paymentMethodAuthorizationId":{"oneOf":[{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64","uniqueKey":"existingPaymentMethod.paymentMethodAuthorizationId.oneOf.0","typeLabel":"integer\u003cint64>"},{"maximum":1000000000,"minimum":1,"type":"null","format":"int64","uniqueKey":"existingPaymentMethod.paymentMethodAuthorizationId.oneOf.1","typeLabel":"null"}],"uniqueKey":"existingPaymentMethod.paymentMethodAuthorizationId","typeLabel":"integer\u003cint64> | null"},"paymentMethodId":{"oneOf":[{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64","uniqueKey":"existingPaymentMethod.paymentMethodId.oneOf.0","typeLabel":"integer\u003cint64>"},{"maximum":1000000000,"minimum":1,"type":"null","format":"int64","uniqueKey":"existingPaymentMethod.paymentMethodId.oneOf.1","typeLabel":"null"}],"uniqueKey":"existingPaymentMethod.paymentMethodId","typeLabel":"integer\u003cint64> | null"},"taxAmount":{"oneOf":[{"maximum":10000000,"minimum":0,"type":"number","format":"double","uniqueKey":"existingPaymentMethod.taxAmount.oneOf.0","typeLabel":"number\u003cdouble>"},{"maximum":10000000,"minimum":0,"type":"null","format":"double","uniqueKey":"existingPaymentMethod.taxAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"existingPaymentMethod.taxAmount","typeLabel":"number\u003cdouble> | null"},"originalNetworkTransactionId":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"existingPaymentMethod.originalNetworkTransactionId.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"existingPaymentMethod.originalNetworkTransactionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"existingPaymentMethod.originalNetworkTransactionId","typeLabel":"string | null"},"onlinePaymentCryptogram":{"maxLength":512,"minLength":0,"type":"string","description":"Decrypted package online payment cryptogram for a digital wallet.","uniqueKey":"existingPaymentMethod.onlinePaymentCryptogram","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"existingPaymentMethod","typeLabel":"object"},"paymentMethod":{"type":"object","properties":{"billingFirstName":{"maxLength":100,"minLength":0,"type":"string","description":"**Conditional**: either both BillingFirstName and BillingLastName or BillingFullName must be provided.\r\n\r\nThe customer’s first name associated with a payment method that is used for billing purposes.","uniqueKey":"paymentMethod.billingFirstName","typeLabel":"string"},"billingLastName":{"maxLength":100,"minLength":0,"type":"string","description":"**Conditional**: either both BillingFirstName and BillingLastName or BillingFullName must be provided.\r\n\r\nThe customer’s last name associated with a payment method that is used for billing purposes.","uniqueKey":"paymentMethod.billingLastName","typeLabel":"string"},"billingFullName":{"maxLength":200,"minLength":0,"type":"string","description":"**Conditional**: either BillingFullName or both BillingFirstName and BillingLastName must be provided.\r\n\r\nThe customer’s full name associated with a payment method that is used for billing purposes. ","uniqueKey":"paymentMethod.billingFullName","typeLabel":"string"},"billingAddress":{"type":"object","description":"The address associated with a payment method that is used for billing purposes. Either an Address ID or detailed address information can be provided.","properties":{"addressLine1":{"oneOf":[{"maxLength":3000,"minLength":0,"type":"string","description":"Address.","uniqueKey":"paymentMethod.billingAddress.addressLine1.oneOf.0","typeLabel":"string"},{"maxLength":3000,"minLength":0,"type":"null","description":"Address.","uniqueKey":"paymentMethod.billingAddress.addressLine1.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingAddress.addressLine1","typeLabel":"string | null"},"addressLine2":{"maxLength":3000,"minLength":0,"type":"string","description":"Supplemental information for the address.","uniqueKey":"paymentMethod.billingAddress.addressLine2","typeLabel":"string"},"city":{"oneOf":[{"maxLength":3000,"minLength":0,"type":"string","description":"City.","uniqueKey":"paymentMethod.billingAddress.city.oneOf.0","typeLabel":"string"},{"maxLength":3000,"minLength":0,"type":"null","description":"City.","uniqueKey":"paymentMethod.billingAddress.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingAddress.city","typeLabel":"string | null"},"state":{"oneOf":[{"maxLength":2,"minLength":0,"type":"string","description":"State.","uniqueKey":"paymentMethod.billingAddress.state.oneOf.0","typeLabel":"string"},{"maxLength":2,"minLength":0,"type":"null","description":"State.","uniqueKey":"paymentMethod.billingAddress.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingAddress.state","typeLabel":"string | null"},"postalCode":{"oneOf":[{"maxLength":20,"minLength":2,"type":"string","description":"Postal Code.","uniqueKey":"paymentMethod.billingAddress.postalCode.oneOf.0","typeLabel":"string"},{"maxLength":20,"minLength":2,"type":"null","description":"Postal Code.","uniqueKey":"paymentMethod.billingAddress.postalCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingAddress.postalCode","typeLabel":"string | null"},"phoneNumber":{"maxLength":20,"minLength":7,"pattern":"^(?=.*\\d)\\+?[0-9\\s\\-\\(\\)\\.]{7,20}$","type":"string","description":"The phone number associated with a payment method that is used for billing purposes.","uniqueKey":"paymentMethod.billingAddress.phoneNumber","typeLabel":"string"},"email":{"maxLength":3000,"minLength":0,"type":"string","description":"The email associated with a billing address.","format":"email","uniqueKey":"paymentMethod.billingAddress.email","typeLabel":"string\u003cemail>"},"country":{"maxLength":2,"minLength":0,"type":"string","description":"The input must be a valid Alpha2 code, Alpha3 code, UN code, or full country name.","uniqueKey":"paymentMethod.billingAddress.country","typeLabel":"string"},"addressId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"The unique identifier of the address.","format":"int64","uniqueKey":"paymentMethod.billingAddress.addressId","typeLabel":"integer\u003cint64>"}},"additionalProperties":false,"uniqueKey":"paymentMethod.billingAddress","typeLabel":"object"},"creditCard":{"type":"object","description":"**Conditional**: one payment method type is required.\r\n\r\nPayment card information.","properties":{"paymentAccountNumber":{"maxLength":19,"minLength":8,"type":"string","description":"**Conditional**: the PAN is required if the credit card payment method type is supplied in the request.\r\nThe number must be a valid credit card number and will be verified using the Luhn algorithm. Minimum length of 8 characters. Maximum length of 25 characters.\r\n\r\nPayment Account Number (PAN).","uniqueKey":"paymentMethod.creditCard.paymentAccountNumber","typeLabel":"string"},"expirationDate":{"maxLength":7,"minLength":0,"type":"string","description":"**Conditional**: the expiration date is required if the credit card payment method type is supplied in the request.\r\n\r\nThe card expiration date.","format":"MMYY, MM/YY, MMYYYY, or MM/YYYY","uniqueKey":"paymentMethod.creditCard.expirationDate","typeLabel":"string\u003cMMYY, MM/YY, MMYYYY, or MM/YYYY>"},"securityCode":{"maxLength":4,"minLength":3,"type":"string","description":"The card verification code. It is considered best practice to always include this value for card-not-present transactions.\r\n\r\nFailure to do so may lead to higher rates of declines, an increase in chargeback cases, and/or transaction downgrades.","uniqueKey":"paymentMethod.creditCard.securityCode","typeLabel":"string"},"networkToken":{"type":"object","description":"External Network Token information.","properties":{"token":{"maxLength":19,"type":"string","description":"Network token issued by a card network for a card.","uniqueKey":"paymentMethod.creditCard.networkToken.token","typeLabel":"string"},"cryptogram":{"maxLength":40,"type":"string","description":"One-time digital “stamp” of payment. Needed for all CIT (customer-initiated transactions), and the cryptogram will have to be generated by the same TR-TSP that provisioned the token.","uniqueKey":"paymentMethod.creditCard.networkToken.cryptogram","typeLabel":"string"},"electronicCommerceIndicator":{"maxLength":2,"type":"string","description":"An online payment security label indicating whether additional protection (such as 3-D Secure) was applied.","uniqueKey":"paymentMethod.creditCard.networkToken.electronicCommerceIndicator","typeLabel":"string"},"paymentAccountReference":{"maxLength":100,"type":"string","description":"A permanent unique identifier of a payment account that a payment system assigns to a card and uses instead of a real PAN within network tokens.","uniqueKey":"paymentMethod.creditCard.networkToken.paymentAccountReference","typeLabel":"string"},"expirationDate":{"oneOf":[{"maxLength":7,"minLength":0,"type":"string","description":"Expiration date of the network token.","format":"MMYY, MM/YY, MMYYYY, or MM/YYYY","uniqueKey":"paymentMethod.creditCard.networkToken.expirationDate.oneOf.0","typeLabel":"string\u003cMMYY, MM/YY, MMYYYY, or MM/YYYY>"},{"maxLength":7,"minLength":0,"type":"null","description":"Expiration date of the network token.","format":"MMYY, MM/YY, MMYYYY, or MM/YYYY","uniqueKey":"paymentMethod.creditCard.networkToken.expirationDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.creditCard.networkToken.expirationDate","typeLabel":"string\u003cMMYY, MM/YY, MMYYYY, or MM/YYYY> | null"}},"additionalProperties":false,"uniqueKey":"paymentMethod.creditCard.networkToken","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"paymentMethod.creditCard","typeLabel":"object"},"ach":{"type":"object","description":"**Conditional**: one payment method type is required.\r\n\r\nACH account information.","required":["accountNumber","routingNumber"],"properties":{"routingNumber":{"maxLength":9,"minLength":9,"pattern":"^[0-9]{9}$","type":"string","description":"**Conditional**: the routing number is required if the ACH payment method type is supplied in the request.\r\n\r\nThe 9-digit ACH routing number of the account.","isRequired":true,"uniqueKey":"paymentMethod.ach.routingNumber","typeLabel":"string"},"accountNumber":{"maxLength":17,"minLength":4,"pattern":"^[0-9]{4,17}$","type":"string","description":"**Conditional**: the account number is required if the ACH payment method type is supplied in the request.\r\nThe length should be between 4 and 17 characters.\r\n\r\nThe US bank account number from which the payment will be debited.","isRequired":true,"uniqueKey":"paymentMethod.ach.accountNumber","typeLabel":"string"},"accountType":{"maxLength":20,"type":"string","description":"**Conditional**: the account type is required if the ACH payment method type is supplied in the request.\r\n\r\nBank account type. Allowed values: Checking, Savings. Case-insensitive.","uniqueKey":"paymentMethod.ach.accountType","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"paymentMethod.ach","typeLabel":"object"},"googlePay":{"type":"object","description":"**Conditional**: one payment method type is required.\r\n\r\nGoogle Pay information.","properties":{"googlePayPaymentDataResponse":{"type":"string","description":"**Conditional**: the GooglePayPaymentDataResponse is required if the Google Pay payment method type is supplied in the request.\r\nMust contain the valid serialized JSON object.\r\n\r\nThe data returned by Google Pay.","uniqueKey":"paymentMethod.googlePay.googlePayPaymentDataResponse","typeLabel":"string"},"googlePayDecryptedPackage":{"type":"object","description":"The Google Pay token decrypted payment data.","properties":{"applicationPrimaryAccountNumber":{"maxLength":25,"minLength":13,"pattern":"^\\d+$","type":"string","description":"Device-specific account number of the card that funds this transaction.","uniqueKey":"paymentMethod.googlePay.googlePayDecryptedPackage.applicationPrimaryAccountNumber","typeLabel":"string"},"applicationExpirationDate":{"maxLength":7,"minLength":0,"type":"string","description":"The card expiration date.","format":"MMYY, MM/YY, MMYYYY, or MM/YYYY","uniqueKey":"paymentMethod.googlePay.googlePayDecryptedPackage.applicationExpirationDate","typeLabel":"string\u003cMMYY, MM/YY, MMYYYY, or MM/YYYY>"},"electronicCommerceIndicator":{"maxLength":2,"minLength":0,"type":"string","description":"An online payment security label indicating whether additional protection (such as 3-D Secure) was applied.","uniqueKey":"paymentMethod.googlePay.googlePayDecryptedPackage.electronicCommerceIndicator","typeLabel":"string"},"onlinePaymentCryptogram":{"maxLength":512,"minLength":0,"type":"string","description":"Decrypted package online payment cryptogram for a digital wallet.","uniqueKey":"paymentMethod.googlePay.googlePayDecryptedPackage.onlinePaymentCryptogram","typeLabel":"string"},"cardBrand":{"type":"string","description":"Specifies the payment method's card brand.\r\n\r\nPossible values: Visa, Mastercard, Amex, Discover, JCB, Diners.","enum":["Visa","Mastercard","Amex","Discover","JCB","Diners"],"uniqueKey":"paymentMethod.googlePay.googlePayDecryptedPackage.cardBrand","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"paymentMethod.googlePay.googlePayDecryptedPackage","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"paymentMethod.googlePay","typeLabel":"object"},"applePay":{"type":"object","description":"**Conditional**: one payment method type is required.\r\n\r\nApple Pay information. If you have encrypted Apple Pay token data use ApplePayToken for further payments. If you have Decrypted Apple Pay token data use ApplePayDecryptedPackage.","properties":{"applePayToken":{"oneOf":[{"type":"string","uniqueKey":"paymentMethod.applePay.applePayToken.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"paymentMethod.applePay.applePayToken.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.applePay.applePayToken","typeLabel":"string | null"},"applePayDecryptedPackage":{"type":"object","description":"The Apple Pay token decrypted payment data.","properties":{"applicationPrimaryAccountNumber":{"maxLength":25,"minLength":13,"pattern":"^\\d+$","type":"string","description":"Device-specific account number of the card that funds this transaction.","uniqueKey":"paymentMethod.applePay.applePayDecryptedPackage.applicationPrimaryAccountNumber","typeLabel":"string"},"applicationExpirationDate":{"maxLength":7,"minLength":0,"type":"string","description":"The card expiration date.","format":"MMYY, MM/YY, MMYYYY, or MM/YYYY","uniqueKey":"paymentMethod.applePay.applePayDecryptedPackage.applicationExpirationDate","typeLabel":"string\u003cMMYY, MM/YY, MMYYYY, or MM/YYYY>"},"electronicCommerceIndicator":{"maxLength":2,"minLength":0,"type":"string","description":"An online payment security label indicating whether additional protection (such as 3-D Secure) was applied.","uniqueKey":"paymentMethod.applePay.applePayDecryptedPackage.electronicCommerceIndicator","typeLabel":"string"},"onlinePaymentCryptogram":{"maxLength":512,"minLength":1,"type":"string","description":"Decrypted package online payment cryptogram for a digital wallet.","uniqueKey":"paymentMethod.applePay.applePayDecryptedPackage.onlinePaymentCryptogram","typeLabel":"string"},"deviceManufacturerIdentifier":{"maxLength":20,"minLength":1,"type":"string","description":"Hex-encoded device manufacturer identifier.","uniqueKey":"paymentMethod.applePay.applePayDecryptedPackage.deviceManufacturerIdentifier","typeLabel":"string"},"cardBrand":{"type":"string","description":"Specifies the payment method's card brand.\r\n\r\nPossible values: Visa, Mastercard, Amex, Discover, JCB, Diners.","enum":["Visa","Mastercard","Amex","Discover","JCB","Diners"],"uniqueKey":"paymentMethod.applePay.applePayDecryptedPackage.cardBrand","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"paymentMethod.applePay.applePayDecryptedPackage","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"paymentMethod.applePay","typeLabel":"object"},"merchantPaymentMethodRefId":{"maxLength":100,"type":"string","description":"Merchant's unique identifier for the payment method.","uniqueKey":"paymentMethod.merchantPaymentMethodRefId","typeLabel":"string"},"taxAmount":{"oneOf":[{"maximum":10000000,"minimum":0,"type":"number","format":"double","uniqueKey":"paymentMethod.taxAmount.oneOf.0","typeLabel":"number\u003cdouble>"},{"maximum":10000000,"minimum":0,"type":"null","format":"double","uniqueKey":"paymentMethod.taxAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.taxAmount","typeLabel":"number\u003cdouble> | null"},"originalNetworkTransactionId":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"paymentMethod.originalNetworkTransactionId.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"paymentMethod.originalNetworkTransactionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.originalNetworkTransactionId","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"paymentMethod","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"existingPaymentMethod":null,"paymentMethod":{"taxAmount":2.57,"originalNetworkTransactionId":"test-transaction-id","billingAddress":{"addressId":null,"addressLine1":"100 Main Street","addressLine2":null,"city":"Irvine","state":"CA","postalCode":"92602","phoneNumber":null,"email":null,"country":"US"},"creditCard":{"paymentAccountNumber":"4111111111111111","expirationDate":"1025","securityCode":null,"networkToken":null},"ach":null,"googlePay":null,"applePay":null,"merchantPaymentMethodRefId":null,"billingFirstName":"John","billingLastName":"Doe","billingFullName":null}},"examples":{"Example":{"title":"Example","value":{"existingPaymentMethod":null,"paymentMethod":{"taxAmount":2.57,"originalNetworkTransactionId":"test-transaction-id","billingAddress":{"addressId":null,"addressLine1":"100 Main Street","addressLine2":null,"city":"Irvine","state":"CA","postalCode":"92602","phoneNumber":null,"email":null,"country":"US"},"creditCard":{"paymentAccountNumber":"4111111111111111","expirationDate":"1025","securityCode":null,"networkToken":null},"ach":null,"googlePay":null,"applePay":null,"merchantPaymentMethodRefId":null,"billingFirstName":"John","billingLastName":"Doe","billingFullName":null}}}},"exampleType":"examples"},"text/json":{"schema":{"type":"object","properties":{"existingPaymentMethod":{"type":"object","properties":{"paymentMethodAuthorizationId":{"oneOf":[{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64","uniqueKey":"existingPaymentMethod.paymentMethodAuthorizationId.oneOf.0","typeLabel":"integer\u003cint64>"},{"maximum":1000000000,"minimum":1,"type":"null","format":"int64","uniqueKey":"existingPaymentMethod.paymentMethodAuthorizationId.oneOf.1","typeLabel":"null"}],"uniqueKey":"existingPaymentMethod.paymentMethodAuthorizationId","typeLabel":"integer\u003cint64> | null"},"paymentMethodId":{"oneOf":[{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64","uniqueKey":"existingPaymentMethod.paymentMethodId.oneOf.0","typeLabel":"integer\u003cint64>"},{"maximum":1000000000,"minimum":1,"type":"null","format":"int64","uniqueKey":"existingPaymentMethod.paymentMethodId.oneOf.1","typeLabel":"null"}],"uniqueKey":"existingPaymentMethod.paymentMethodId","typeLabel":"integer\u003cint64> | null"},"taxAmount":{"oneOf":[{"maximum":10000000,"minimum":0,"type":"number","format":"double","uniqueKey":"existingPaymentMethod.taxAmount.oneOf.0","typeLabel":"number\u003cdouble>"},{"maximum":10000000,"minimum":0,"type":"null","format":"double","uniqueKey":"existingPaymentMethod.taxAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"existingPaymentMethod.taxAmount","typeLabel":"number\u003cdouble> | null"},"originalNetworkTransactionId":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"existingPaymentMethod.originalNetworkTransactionId.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"existingPaymentMethod.originalNetworkTransactionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"existingPaymentMethod.originalNetworkTransactionId","typeLabel":"string | null"},"onlinePaymentCryptogram":{"maxLength":512,"minLength":0,"type":"string","description":"Decrypted package online payment cryptogram for a digital wallet.","uniqueKey":"existingPaymentMethod.onlinePaymentCryptogram","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"existingPaymentMethod","typeLabel":"object"},"paymentMethod":{"type":"object","properties":{"billingFirstName":{"maxLength":100,"minLength":0,"type":"string","description":"**Conditional**: either both BillingFirstName and BillingLastName or BillingFullName must be provided.\r\n\r\nThe customer’s first name associated with a payment method that is used for billing purposes.","uniqueKey":"paymentMethod.billingFirstName","typeLabel":"string"},"billingLastName":{"maxLength":100,"minLength":0,"type":"string","description":"**Conditional**: either both BillingFirstName and BillingLastName or BillingFullName must be provided.\r\n\r\nThe customer’s last name associated with a payment method that is used for billing purposes.","uniqueKey":"paymentMethod.billingLastName","typeLabel":"string"},"billingFullName":{"maxLength":200,"minLength":0,"type":"string","description":"**Conditional**: either BillingFullName or both BillingFirstName and BillingLastName must be provided.\r\n\r\nThe customer’s full name associated with a payment method that is used for billing purposes. ","uniqueKey":"paymentMethod.billingFullName","typeLabel":"string"},"billingAddress":{"type":"object","description":"The address associated with a payment method that is used for billing purposes. Either an Address ID or detailed address information can be provided.","properties":{"addressLine1":{"oneOf":[{"maxLength":3000,"minLength":0,"type":"string","description":"Address.","uniqueKey":"paymentMethod.billingAddress.addressLine1.oneOf.0","typeLabel":"string"},{"maxLength":3000,"minLength":0,"type":"null","description":"Address.","uniqueKey":"paymentMethod.billingAddress.addressLine1.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingAddress.addressLine1","typeLabel":"string | null"},"addressLine2":{"maxLength":3000,"minLength":0,"type":"string","description":"Supplemental information for the address.","uniqueKey":"paymentMethod.billingAddress.addressLine2","typeLabel":"string"},"city":{"oneOf":[{"maxLength":3000,"minLength":0,"type":"string","description":"City.","uniqueKey":"paymentMethod.billingAddress.city.oneOf.0","typeLabel":"string"},{"maxLength":3000,"minLength":0,"type":"null","description":"City.","uniqueKey":"paymentMethod.billingAddress.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingAddress.city","typeLabel":"string | null"},"state":{"oneOf":[{"maxLength":2,"minLength":0,"type":"string","description":"State.","uniqueKey":"paymentMethod.billingAddress.state.oneOf.0","typeLabel":"string"},{"maxLength":2,"minLength":0,"type":"null","description":"State.","uniqueKey":"paymentMethod.billingAddress.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingAddress.state","typeLabel":"string | null"},"postalCode":{"oneOf":[{"maxLength":20,"minLength":2,"type":"string","description":"Postal Code.","uniqueKey":"paymentMethod.billingAddress.postalCode.oneOf.0","typeLabel":"string"},{"maxLength":20,"minLength":2,"type":"null","description":"Postal Code.","uniqueKey":"paymentMethod.billingAddress.postalCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingAddress.postalCode","typeLabel":"string | null"},"phoneNumber":{"maxLength":20,"minLength":7,"pattern":"^(?=.*\\d)\\+?[0-9\\s\\-\\(\\)\\.]{7,20}$","type":"string","description":"The phone number associated with a payment method that is used for billing purposes.","uniqueKey":"paymentMethod.billingAddress.phoneNumber","typeLabel":"string"},"email":{"maxLength":3000,"minLength":0,"type":"string","description":"The email associated with a billing address.","format":"email","uniqueKey":"paymentMethod.billingAddress.email","typeLabel":"string\u003cemail>"},"country":{"maxLength":2,"minLength":0,"type":"string","description":"The input must be a valid Alpha2 code, Alpha3 code, UN code, or full country name.","uniqueKey":"paymentMethod.billingAddress.country","typeLabel":"string"},"addressId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"The unique identifier of the address.","format":"int64","uniqueKey":"paymentMethod.billingAddress.addressId","typeLabel":"integer\u003cint64>"}},"additionalProperties":false,"uniqueKey":"paymentMethod.billingAddress","typeLabel":"object"},"creditCard":{"type":"object","description":"**Conditional**: one payment method type is required.\r\n\r\nPayment card information.","properties":{"paymentAccountNumber":{"maxLength":19,"minLength":8,"type":"string","description":"**Conditional**: the PAN is required if the credit card payment method type is supplied in the request.\r\nThe number must be a valid credit card number and will be verified using the Luhn algorithm. Minimum length of 8 characters. Maximum length of 25 characters.\r\n\r\nPayment Account Number (PAN).","uniqueKey":"paymentMethod.creditCard.paymentAccountNumber","typeLabel":"string"},"expirationDate":{"maxLength":7,"minLength":0,"type":"string","description":"**Conditional**: the expiration date is required if the credit card payment method type is supplied in the request.\r\n\r\nThe card expiration date.","format":"MMYY, MM/YY, MMYYYY, or MM/YYYY","uniqueKey":"paymentMethod.creditCard.expirationDate","typeLabel":"string\u003cMMYY, MM/YY, MMYYYY, or MM/YYYY>"},"securityCode":{"maxLength":4,"minLength":3,"type":"string","description":"The card verification code. It is considered best practice to always include this value for card-not-present transactions.\r\n\r\nFailure to do so may lead to higher rates of declines, an increase in chargeback cases, and/or transaction downgrades.","uniqueKey":"paymentMethod.creditCard.securityCode","typeLabel":"string"},"networkToken":{"type":"object","description":"External Network Token information.","properties":{"token":{"maxLength":19,"type":"string","description":"Network token issued by a card network for a card.","uniqueKey":"paymentMethod.creditCard.networkToken.token","typeLabel":"string"},"cryptogram":{"maxLength":40,"type":"string","description":"One-time digital “stamp” of payment. Needed for all CIT (customer-initiated transactions), and the cryptogram will have to be generated by the same TR-TSP that provisioned the token.","uniqueKey":"paymentMethod.creditCard.networkToken.cryptogram","typeLabel":"string"},"electronicCommerceIndicator":{"maxLength":2,"type":"string","description":"An online payment security label indicating whether additional protection (such as 3-D Secure) was applied.","uniqueKey":"paymentMethod.creditCard.networkToken.electronicCommerceIndicator","typeLabel":"string"},"paymentAccountReference":{"maxLength":100,"type":"string","description":"A permanent unique identifier of a payment account that a payment system assigns to a card and uses instead of a real PAN within network tokens.","uniqueKey":"paymentMethod.creditCard.networkToken.paymentAccountReference","typeLabel":"string"},"expirationDate":{"oneOf":[{"maxLength":7,"minLength":0,"type":"string","description":"Expiration date of the network token.","format":"MMYY, MM/YY, MMYYYY, or MM/YYYY","uniqueKey":"paymentMethod.creditCard.networkToken.expirationDate.oneOf.0","typeLabel":"string\u003cMMYY, MM/YY, MMYYYY, or MM/YYYY>"},{"maxLength":7,"minLength":0,"type":"null","description":"Expiration date of the network token.","format":"MMYY, MM/YY, MMYYYY, or MM/YYYY","uniqueKey":"paymentMethod.creditCard.networkToken.expirationDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.creditCard.networkToken.expirationDate","typeLabel":"string\u003cMMYY, MM/YY, MMYYYY, or MM/YYYY> | null"}},"additionalProperties":false,"uniqueKey":"paymentMethod.creditCard.networkToken","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"paymentMethod.creditCard","typeLabel":"object"},"ach":{"type":"object","description":"**Conditional**: one payment method type is required.\r\n\r\nACH account information.","required":["accountNumber","routingNumber"],"properties":{"routingNumber":{"maxLength":9,"minLength":9,"pattern":"^[0-9]{9}$","type":"string","description":"**Conditional**: the routing number is required if the ACH payment method type is supplied in the request.\r\n\r\nThe 9-digit ACH routing number of the account.","isRequired":true,"uniqueKey":"paymentMethod.ach.routingNumber","typeLabel":"string"},"accountNumber":{"maxLength":17,"minLength":4,"pattern":"^[0-9]{4,17}$","type":"string","description":"**Conditional**: the account number is required if the ACH payment method type is supplied in the request.\r\nThe length should be between 4 and 17 characters.\r\n\r\nThe US bank account number from which the payment will be debited.","isRequired":true,"uniqueKey":"paymentMethod.ach.accountNumber","typeLabel":"string"},"accountType":{"maxLength":20,"type":"string","description":"**Conditional**: the account type is required if the ACH payment method type is supplied in the request.\r\n\r\nBank account type. Allowed values: Checking, Savings. Case-insensitive.","uniqueKey":"paymentMethod.ach.accountType","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"paymentMethod.ach","typeLabel":"object"},"googlePay":{"type":"object","description":"**Conditional**: one payment method type is required.\r\n\r\nGoogle Pay information.","properties":{"googlePayPaymentDataResponse":{"type":"string","description":"**Conditional**: the GooglePayPaymentDataResponse is required if the Google Pay payment method type is supplied in the request.\r\nMust contain the valid serialized JSON object.\r\n\r\nThe data returned by Google Pay.","uniqueKey":"paymentMethod.googlePay.googlePayPaymentDataResponse","typeLabel":"string"},"googlePayDecryptedPackage":{"type":"object","description":"The Google Pay token decrypted payment data.","properties":{"applicationPrimaryAccountNumber":{"maxLength":25,"minLength":13,"pattern":"^\\d+$","type":"string","description":"Device-specific account number of the card that funds this transaction.","uniqueKey":"paymentMethod.googlePay.googlePayDecryptedPackage.applicationPrimaryAccountNumber","typeLabel":"string"},"applicationExpirationDate":{"maxLength":7,"minLength":0,"type":"string","description":"The card expiration date.","format":"MMYY, MM/YY, MMYYYY, or MM/YYYY","uniqueKey":"paymentMethod.googlePay.googlePayDecryptedPackage.applicationExpirationDate","typeLabel":"string\u003cMMYY, MM/YY, MMYYYY, or MM/YYYY>"},"electronicCommerceIndicator":{"maxLength":2,"minLength":0,"type":"string","description":"An online payment security label indicating whether additional protection (such as 3-D Secure) was applied.","uniqueKey":"paymentMethod.googlePay.googlePayDecryptedPackage.electronicCommerceIndicator","typeLabel":"string"},"onlinePaymentCryptogram":{"maxLength":512,"minLength":0,"type":"string","description":"Decrypted package online payment cryptogram for a digital wallet.","uniqueKey":"paymentMethod.googlePay.googlePayDecryptedPackage.onlinePaymentCryptogram","typeLabel":"string"},"cardBrand":{"type":"string","description":"Specifies the payment method's card brand.\r\n\r\nPossible values: Visa, Mastercard, Amex, Discover, JCB, Diners.","enum":["Visa","Mastercard","Amex","Discover","JCB","Diners"],"uniqueKey":"paymentMethod.googlePay.googlePayDecryptedPackage.cardBrand","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"paymentMethod.googlePay.googlePayDecryptedPackage","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"paymentMethod.googlePay","typeLabel":"object"},"applePay":{"type":"object","description":"**Conditional**: one payment method type is required.\r\n\r\nApple Pay information. If you have encrypted Apple Pay token data use ApplePayToken for further payments. If you have Decrypted Apple Pay token data use ApplePayDecryptedPackage.","properties":{"applePayToken":{"oneOf":[{"type":"string","uniqueKey":"paymentMethod.applePay.applePayToken.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"paymentMethod.applePay.applePayToken.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.applePay.applePayToken","typeLabel":"string | null"},"applePayDecryptedPackage":{"type":"object","description":"The Apple Pay token decrypted payment data.","properties":{"applicationPrimaryAccountNumber":{"maxLength":25,"minLength":13,"pattern":"^\\d+$","type":"string","description":"Device-specific account number of the card that funds this transaction.","uniqueKey":"paymentMethod.applePay.applePayDecryptedPackage.applicationPrimaryAccountNumber","typeLabel":"string"},"applicationExpirationDate":{"maxLength":7,"minLength":0,"type":"string","description":"The card expiration date.","format":"MMYY, MM/YY, MMYYYY, or MM/YYYY","uniqueKey":"paymentMethod.applePay.applePayDecryptedPackage.applicationExpirationDate","typeLabel":"string\u003cMMYY, MM/YY, MMYYYY, or MM/YYYY>"},"electronicCommerceIndicator":{"maxLength":2,"minLength":0,"type":"string","description":"An online payment security label indicating whether additional protection (such as 3-D Secure) was applied.","uniqueKey":"paymentMethod.applePay.applePayDecryptedPackage.electronicCommerceIndicator","typeLabel":"string"},"onlinePaymentCryptogram":{"maxLength":512,"minLength":1,"type":"string","description":"Decrypted package online payment cryptogram for a digital wallet.","uniqueKey":"paymentMethod.applePay.applePayDecryptedPackage.onlinePaymentCryptogram","typeLabel":"string"},"deviceManufacturerIdentifier":{"maxLength":20,"minLength":1,"type":"string","description":"Hex-encoded device manufacturer identifier.","uniqueKey":"paymentMethod.applePay.applePayDecryptedPackage.deviceManufacturerIdentifier","typeLabel":"string"},"cardBrand":{"type":"string","description":"Specifies the payment method's card brand.\r\n\r\nPossible values: Visa, Mastercard, Amex, Discover, JCB, Diners.","enum":["Visa","Mastercard","Amex","Discover","JCB","Diners"],"uniqueKey":"paymentMethod.applePay.applePayDecryptedPackage.cardBrand","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"paymentMethod.applePay.applePayDecryptedPackage","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"paymentMethod.applePay","typeLabel":"object"},"merchantPaymentMethodRefId":{"maxLength":100,"type":"string","description":"Merchant's unique identifier for the payment method.","uniqueKey":"paymentMethod.merchantPaymentMethodRefId","typeLabel":"string"},"taxAmount":{"oneOf":[{"maximum":10000000,"minimum":0,"type":"number","format":"double","uniqueKey":"paymentMethod.taxAmount.oneOf.0","typeLabel":"number\u003cdouble>"},{"maximum":10000000,"minimum":0,"type":"null","format":"double","uniqueKey":"paymentMethod.taxAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.taxAmount","typeLabel":"number\u003cdouble> | null"},"originalNetworkTransactionId":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"paymentMethod.originalNetworkTransactionId.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"paymentMethod.originalNetworkTransactionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.originalNetworkTransactionId","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"paymentMethod","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"existingPaymentMethod":null,"paymentMethod":{"taxAmount":2.57,"originalNetworkTransactionId":"test-transaction-id","billingAddress":{"addressId":null,"addressLine1":"100 Main Street","addressLine2":null,"city":"Irvine","state":"CA","postalCode":"92602","phoneNumber":null,"email":null,"country":"US"},"creditCard":{"paymentAccountNumber":"4111111111111111","expirationDate":"1025","securityCode":null,"networkToken":null},"ach":null,"googlePay":null,"applePay":null,"merchantPaymentMethodRefId":null,"billingFirstName":"John","billingLastName":"Doe","billingFullName":null}},"examples":{"Example":{"title":"Example","value":{"existingPaymentMethod":null,"paymentMethod":{"taxAmount":2.57,"originalNetworkTransactionId":"test-transaction-id","billingAddress":{"addressId":null,"addressLine1":"100 Main Street","addressLine2":null,"city":"Irvine","state":"CA","postalCode":"92602","phoneNumber":null,"email":null,"country":"US"},"creditCard":{"paymentAccountNumber":"4111111111111111","expirationDate":"1025","securityCode":null,"networkToken":null},"ach":null,"googlePay":null,"applePay":null,"merchantPaymentMethodRefId":null,"billingFirstName":"John","billingLastName":"Doe","billingFullName":null}}}},"exampleType":"examples"},"application/*+json":{"schema":{"type":"object","properties":{"existingPaymentMethod":{"type":"object","properties":{"paymentMethodAuthorizationId":{"oneOf":[{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64","uniqueKey":"existingPaymentMethod.paymentMethodAuthorizationId.oneOf.0","typeLabel":"integer\u003cint64>"},{"maximum":1000000000,"minimum":1,"type":"null","format":"int64","uniqueKey":"existingPaymentMethod.paymentMethodAuthorizationId.oneOf.1","typeLabel":"null"}],"uniqueKey":"existingPaymentMethod.paymentMethodAuthorizationId","typeLabel":"integer\u003cint64> | null"},"paymentMethodId":{"oneOf":[{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64","uniqueKey":"existingPaymentMethod.paymentMethodId.oneOf.0","typeLabel":"integer\u003cint64>"},{"maximum":1000000000,"minimum":1,"type":"null","format":"int64","uniqueKey":"existingPaymentMethod.paymentMethodId.oneOf.1","typeLabel":"null"}],"uniqueKey":"existingPaymentMethod.paymentMethodId","typeLabel":"integer\u003cint64> | null"},"taxAmount":{"oneOf":[{"maximum":10000000,"minimum":0,"type":"number","format":"double","uniqueKey":"existingPaymentMethod.taxAmount.oneOf.0","typeLabel":"number\u003cdouble>"},{"maximum":10000000,"minimum":0,"type":"null","format":"double","uniqueKey":"existingPaymentMethod.taxAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"existingPaymentMethod.taxAmount","typeLabel":"number\u003cdouble> | null"},"originalNetworkTransactionId":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"existingPaymentMethod.originalNetworkTransactionId.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"existingPaymentMethod.originalNetworkTransactionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"existingPaymentMethod.originalNetworkTransactionId","typeLabel":"string | null"},"onlinePaymentCryptogram":{"maxLength":512,"minLength":0,"type":"string","description":"Decrypted package online payment cryptogram for a digital wallet.","uniqueKey":"existingPaymentMethod.onlinePaymentCryptogram","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"existingPaymentMethod","typeLabel":"object"},"paymentMethod":{"type":"object","properties":{"billingFirstName":{"maxLength":100,"minLength":0,"type":"string","description":"**Conditional**: either both BillingFirstName and BillingLastName or BillingFullName must be provided.\r\n\r\nThe customer’s first name associated with a payment method that is used for billing purposes.","uniqueKey":"paymentMethod.billingFirstName","typeLabel":"string"},"billingLastName":{"maxLength":100,"minLength":0,"type":"string","description":"**Conditional**: either both BillingFirstName and BillingLastName or BillingFullName must be provided.\r\n\r\nThe customer’s last name associated with a payment method that is used for billing purposes.","uniqueKey":"paymentMethod.billingLastName","typeLabel":"string"},"billingFullName":{"maxLength":200,"minLength":0,"type":"string","description":"**Conditional**: either BillingFullName or both BillingFirstName and BillingLastName must be provided.\r\n\r\nThe customer’s full name associated with a payment method that is used for billing purposes. ","uniqueKey":"paymentMethod.billingFullName","typeLabel":"string"},"billingAddress":{"type":"object","description":"The address associated with a payment method that is used for billing purposes. Either an Address ID or detailed address information can be provided.","properties":{"addressLine1":{"oneOf":[{"maxLength":3000,"minLength":0,"type":"string","description":"Address.","uniqueKey":"paymentMethod.billingAddress.addressLine1.oneOf.0","typeLabel":"string"},{"maxLength":3000,"minLength":0,"type":"null","description":"Address.","uniqueKey":"paymentMethod.billingAddress.addressLine1.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingAddress.addressLine1","typeLabel":"string | null"},"addressLine2":{"maxLength":3000,"minLength":0,"type":"string","description":"Supplemental information for the address.","uniqueKey":"paymentMethod.billingAddress.addressLine2","typeLabel":"string"},"city":{"oneOf":[{"maxLength":3000,"minLength":0,"type":"string","description":"City.","uniqueKey":"paymentMethod.billingAddress.city.oneOf.0","typeLabel":"string"},{"maxLength":3000,"minLength":0,"type":"null","description":"City.","uniqueKey":"paymentMethod.billingAddress.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingAddress.city","typeLabel":"string | null"},"state":{"oneOf":[{"maxLength":2,"minLength":0,"type":"string","description":"State.","uniqueKey":"paymentMethod.billingAddress.state.oneOf.0","typeLabel":"string"},{"maxLength":2,"minLength":0,"type":"null","description":"State.","uniqueKey":"paymentMethod.billingAddress.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingAddress.state","typeLabel":"string | null"},"postalCode":{"oneOf":[{"maxLength":20,"minLength":2,"type":"string","description":"Postal Code.","uniqueKey":"paymentMethod.billingAddress.postalCode.oneOf.0","typeLabel":"string"},{"maxLength":20,"minLength":2,"type":"null","description":"Postal Code.","uniqueKey":"paymentMethod.billingAddress.postalCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingAddress.postalCode","typeLabel":"string | null"},"phoneNumber":{"maxLength":20,"minLength":7,"pattern":"^(?=.*\\d)\\+?[0-9\\s\\-\\(\\)\\.]{7,20}$","type":"string","description":"The phone number associated with a payment method that is used for billing purposes.","uniqueKey":"paymentMethod.billingAddress.phoneNumber","typeLabel":"string"},"email":{"maxLength":3000,"minLength":0,"type":"string","description":"The email associated with a billing address.","format":"email","uniqueKey":"paymentMethod.billingAddress.email","typeLabel":"string\u003cemail>"},"country":{"maxLength":2,"minLength":0,"type":"string","description":"The input must be a valid Alpha2 code, Alpha3 code, UN code, or full country name.","uniqueKey":"paymentMethod.billingAddress.country","typeLabel":"string"},"addressId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"The unique identifier of the address.","format":"int64","uniqueKey":"paymentMethod.billingAddress.addressId","typeLabel":"integer\u003cint64>"}},"additionalProperties":false,"uniqueKey":"paymentMethod.billingAddress","typeLabel":"object"},"creditCard":{"type":"object","description":"**Conditional**: one payment method type is required.\r\n\r\nPayment card information.","properties":{"paymentAccountNumber":{"maxLength":19,"minLength":8,"type":"string","description":"**Conditional**: the PAN is required if the credit card payment method type is supplied in the request.\r\nThe number must be a valid credit card number and will be verified using the Luhn algorithm. Minimum length of 8 characters. Maximum length of 25 characters.\r\n\r\nPayment Account Number (PAN).","uniqueKey":"paymentMethod.creditCard.paymentAccountNumber","typeLabel":"string"},"expirationDate":{"maxLength":7,"minLength":0,"type":"string","description":"**Conditional**: the expiration date is required if the credit card payment method type is supplied in the request.\r\n\r\nThe card expiration date.","format":"MMYY, MM/YY, MMYYYY, or MM/YYYY","uniqueKey":"paymentMethod.creditCard.expirationDate","typeLabel":"string\u003cMMYY, MM/YY, MMYYYY, or MM/YYYY>"},"securityCode":{"maxLength":4,"minLength":3,"type":"string","description":"The card verification code. It is considered best practice to always include this value for card-not-present transactions.\r\n\r\nFailure to do so may lead to higher rates of declines, an increase in chargeback cases, and/or transaction downgrades.","uniqueKey":"paymentMethod.creditCard.securityCode","typeLabel":"string"},"networkToken":{"type":"object","description":"External Network Token information.","properties":{"token":{"maxLength":19,"type":"string","description":"Network token issued by a card network for a card.","uniqueKey":"paymentMethod.creditCard.networkToken.token","typeLabel":"string"},"cryptogram":{"maxLength":40,"type":"string","description":"One-time digital “stamp” of payment. Needed for all CIT (customer-initiated transactions), and the cryptogram will have to be generated by the same TR-TSP that provisioned the token.","uniqueKey":"paymentMethod.creditCard.networkToken.cryptogram","typeLabel":"string"},"electronicCommerceIndicator":{"maxLength":2,"type":"string","description":"An online payment security label indicating whether additional protection (such as 3-D Secure) was applied.","uniqueKey":"paymentMethod.creditCard.networkToken.electronicCommerceIndicator","typeLabel":"string"},"paymentAccountReference":{"maxLength":100,"type":"string","description":"A permanent unique identifier of a payment account that a payment system assigns to a card and uses instead of a real PAN within network tokens.","uniqueKey":"paymentMethod.creditCard.networkToken.paymentAccountReference","typeLabel":"string"},"expirationDate":{"oneOf":[{"maxLength":7,"minLength":0,"type":"string","description":"Expiration date of the network token.","format":"MMYY, MM/YY, MMYYYY, or MM/YYYY","uniqueKey":"paymentMethod.creditCard.networkToken.expirationDate.oneOf.0","typeLabel":"string\u003cMMYY, MM/YY, MMYYYY, or MM/YYYY>"},{"maxLength":7,"minLength":0,"type":"null","description":"Expiration date of the network token.","format":"MMYY, MM/YY, MMYYYY, or MM/YYYY","uniqueKey":"paymentMethod.creditCard.networkToken.expirationDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.creditCard.networkToken.expirationDate","typeLabel":"string\u003cMMYY, MM/YY, MMYYYY, or MM/YYYY> | null"}},"additionalProperties":false,"uniqueKey":"paymentMethod.creditCard.networkToken","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"paymentMethod.creditCard","typeLabel":"object"},"ach":{"type":"object","description":"**Conditional**: one payment method type is required.\r\n\r\nACH account information.","required":["accountNumber","routingNumber"],"properties":{"routingNumber":{"maxLength":9,"minLength":9,"pattern":"^[0-9]{9}$","type":"string","description":"**Conditional**: the routing number is required if the ACH payment method type is supplied in the request.\r\n\r\nThe 9-digit ACH routing number of the account.","isRequired":true,"uniqueKey":"paymentMethod.ach.routingNumber","typeLabel":"string"},"accountNumber":{"maxLength":17,"minLength":4,"pattern":"^[0-9]{4,17}$","type":"string","description":"**Conditional**: the account number is required if the ACH payment method type is supplied in the request.\r\nThe length should be between 4 and 17 characters.\r\n\r\nThe US bank account number from which the payment will be debited.","isRequired":true,"uniqueKey":"paymentMethod.ach.accountNumber","typeLabel":"string"},"accountType":{"maxLength":20,"type":"string","description":"**Conditional**: the account type is required if the ACH payment method type is supplied in the request.\r\n\r\nBank account type. Allowed values: Checking, Savings. Case-insensitive.","uniqueKey":"paymentMethod.ach.accountType","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"paymentMethod.ach","typeLabel":"object"},"googlePay":{"type":"object","description":"**Conditional**: one payment method type is required.\r\n\r\nGoogle Pay information.","properties":{"googlePayPaymentDataResponse":{"type":"string","description":"**Conditional**: the GooglePayPaymentDataResponse is required if the Google Pay payment method type is supplied in the request.\r\nMust contain the valid serialized JSON object.\r\n\r\nThe data returned by Google Pay.","uniqueKey":"paymentMethod.googlePay.googlePayPaymentDataResponse","typeLabel":"string"},"googlePayDecryptedPackage":{"type":"object","description":"The Google Pay token decrypted payment data.","properties":{"applicationPrimaryAccountNumber":{"maxLength":25,"minLength":13,"pattern":"^\\d+$","type":"string","description":"Device-specific account number of the card that funds this transaction.","uniqueKey":"paymentMethod.googlePay.googlePayDecryptedPackage.applicationPrimaryAccountNumber","typeLabel":"string"},"applicationExpirationDate":{"maxLength":7,"minLength":0,"type":"string","description":"The card expiration date.","format":"MMYY, MM/YY, MMYYYY, or MM/YYYY","uniqueKey":"paymentMethod.googlePay.googlePayDecryptedPackage.applicationExpirationDate","typeLabel":"string\u003cMMYY, MM/YY, MMYYYY, or MM/YYYY>"},"electronicCommerceIndicator":{"maxLength":2,"minLength":0,"type":"string","description":"An online payment security label indicating whether additional protection (such as 3-D Secure) was applied.","uniqueKey":"paymentMethod.googlePay.googlePayDecryptedPackage.electronicCommerceIndicator","typeLabel":"string"},"onlinePaymentCryptogram":{"maxLength":512,"minLength":0,"type":"string","description":"Decrypted package online payment cryptogram for a digital wallet.","uniqueKey":"paymentMethod.googlePay.googlePayDecryptedPackage.onlinePaymentCryptogram","typeLabel":"string"},"cardBrand":{"type":"string","description":"Specifies the payment method's card brand.\r\n\r\nPossible values: Visa, Mastercard, Amex, Discover, JCB, Diners.","enum":["Visa","Mastercard","Amex","Discover","JCB","Diners"],"uniqueKey":"paymentMethod.googlePay.googlePayDecryptedPackage.cardBrand","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"paymentMethod.googlePay.googlePayDecryptedPackage","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"paymentMethod.googlePay","typeLabel":"object"},"applePay":{"type":"object","description":"**Conditional**: one payment method type is required.\r\n\r\nApple Pay information. If you have encrypted Apple Pay token data use ApplePayToken for further payments. If you have Decrypted Apple Pay token data use ApplePayDecryptedPackage.","properties":{"applePayToken":{"oneOf":[{"type":"string","uniqueKey":"paymentMethod.applePay.applePayToken.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"paymentMethod.applePay.applePayToken.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.applePay.applePayToken","typeLabel":"string | null"},"applePayDecryptedPackage":{"type":"object","description":"The Apple Pay token decrypted payment data.","properties":{"applicationPrimaryAccountNumber":{"maxLength":25,"minLength":13,"pattern":"^\\d+$","type":"string","description":"Device-specific account number of the card that funds this transaction.","uniqueKey":"paymentMethod.applePay.applePayDecryptedPackage.applicationPrimaryAccountNumber","typeLabel":"string"},"applicationExpirationDate":{"maxLength":7,"minLength":0,"type":"string","description":"The card expiration date.","format":"MMYY, MM/YY, MMYYYY, or MM/YYYY","uniqueKey":"paymentMethod.applePay.applePayDecryptedPackage.applicationExpirationDate","typeLabel":"string\u003cMMYY, MM/YY, MMYYYY, or MM/YYYY>"},"electronicCommerceIndicator":{"maxLength":2,"minLength":0,"type":"string","description":"An online payment security label indicating whether additional protection (such as 3-D Secure) was applied.","uniqueKey":"paymentMethod.applePay.applePayDecryptedPackage.electronicCommerceIndicator","typeLabel":"string"},"onlinePaymentCryptogram":{"maxLength":512,"minLength":1,"type":"string","description":"Decrypted package online payment cryptogram for a digital wallet.","uniqueKey":"paymentMethod.applePay.applePayDecryptedPackage.onlinePaymentCryptogram","typeLabel":"string"},"deviceManufacturerIdentifier":{"maxLength":20,"minLength":1,"type":"string","description":"Hex-encoded device manufacturer identifier.","uniqueKey":"paymentMethod.applePay.applePayDecryptedPackage.deviceManufacturerIdentifier","typeLabel":"string"},"cardBrand":{"type":"string","description":"Specifies the payment method's card brand.\r\n\r\nPossible values: Visa, Mastercard, Amex, Discover, JCB, Diners.","enum":["Visa","Mastercard","Amex","Discover","JCB","Diners"],"uniqueKey":"paymentMethod.applePay.applePayDecryptedPackage.cardBrand","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"paymentMethod.applePay.applePayDecryptedPackage","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"paymentMethod.applePay","typeLabel":"object"},"merchantPaymentMethodRefId":{"maxLength":100,"type":"string","description":"Merchant's unique identifier for the payment method.","uniqueKey":"paymentMethod.merchantPaymentMethodRefId","typeLabel":"string"},"taxAmount":{"oneOf":[{"maximum":10000000,"minimum":0,"type":"number","format":"double","uniqueKey":"paymentMethod.taxAmount.oneOf.0","typeLabel":"number\u003cdouble>"},{"maximum":10000000,"minimum":0,"type":"null","format":"double","uniqueKey":"paymentMethod.taxAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.taxAmount","typeLabel":"number\u003cdouble> | null"},"originalNetworkTransactionId":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"paymentMethod.originalNetworkTransactionId.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"paymentMethod.originalNetworkTransactionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.originalNetworkTransactionId","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"paymentMethod","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"existingPaymentMethod":null,"paymentMethod":{"taxAmount":2.57,"originalNetworkTransactionId":"test-transaction-id","billingAddress":{"addressId":null,"addressLine1":"100 Main Street","addressLine2":null,"city":"Irvine","state":"CA","postalCode":"92602","phoneNumber":null,"email":null,"country":"US"},"creditCard":{"paymentAccountNumber":"4111111111111111","expirationDate":"1025","securityCode":null,"networkToken":null},"ach":null,"googlePay":null,"applePay":null,"merchantPaymentMethodRefId":null,"billingFirstName":"John","billingLastName":"Doe","billingFullName":null}},"examples":{"Example":{"title":"Example","value":{"existingPaymentMethod":null,"paymentMethod":{"taxAmount":2.57,"originalNetworkTransactionId":"test-transaction-id","billingAddress":{"addressId":null,"addressLine1":"100 Main Street","addressLine2":null,"city":"Irvine","state":"CA","postalCode":"92602","phoneNumber":null,"email":null,"country":"US"},"creditCard":{"paymentAccountNumber":"4111111111111111","expirationDate":"1025","securityCode":null,"networkToken":null},"ach":null,"googlePay":null,"applePay":null,"merchantPaymentMethodRefId":null,"billingFirstName":"John","billingLastName":"Doe","billingFullName":null}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"8b639b2b-bcf3-4f20-831e-d3c1ab4ce921":{"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"},"ca69dfba-648c-4b87-8c9e-edb47be3ac70":{"description":"Bad Request","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 perform the request action with provided data."},"examples":{"Example":{"title":"Example","value":{"message":"Unable to perform the request action with 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 perform the request action with provided data."},"examples":{"Example":{"title":"Example","value":{"message":"Unable to perform the request action with 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 perform the request action with provided data."},"examples":{"Example":{"title":"Example","value":{"message":"Unable to perform the request action with provided data."}}},"exampleType":"examples"}},"exampleType":"examples"},"afb50a5f-fd04-4d0e-8420-1d058ab93f76":{"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"},"78729dfd-f32e-4786-bb44-fc8152137866":{"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":{"4569059f-e1af-4692-b686-1ad6db63198a":{"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":"Replace Subscription Primary Payment Method - Introduction \u0026 Quick Start","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-13T22:34:18.101Z","originalFileLocation":"api-reference/subscriptions/replace-subscription-primary-payment-method.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=\"Replaces the primary payment method associated with an active subscription. This operation is typically used when a customer updates their card, bank account, or switches to a different saved method for ongoing billing. You must provide the subscriptionId and the new payment method details. The new method will be used for all future charges, starting with the next billing cycle (or immediately, if a payment is due). This endpoint helps ensure billing continuity in case of expired cards, failed payments, or customer-initiated updates.\">\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=\"Replace Subscription Primary Payment Method - Introduction \u0026amp; Quick Start\">\u003cmeta data-mint-head property=\"og:description\" content=\"Replaces the primary payment method associated with an active subscription. This operation is typically used when a customer updates their card, bank account, or switches to a different saved method for ongoing billing. You must provide the subscriptionId and the new payment method details. The new method will be used for all future charges, starting with the next billing cycle (or immediately, if a payment is due). This endpoint helps ensure billing continuity in case of expired cards, failed payments, or customer-initiated updates.\">\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/replace-subscription-primary-payment-method\">\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=Replace+Subscription+Primary+Payment+Method\u0026amp;description=Replaces+the+**primary+payment+method**+associated+with+an+active+subscription.%0D%0AThis+operation+is+typically+used+when+a+customer+updates+their+card%2C+bank+accou\u0026amp;theme=44ecc26a32f1a478fe3476c2\u0026amp;signature=1ce90f3690b1599605770f257de297bfebb3df4cde48ad6afdacfd3da986c274\">\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=\"Replace Subscription Primary Payment Method - Introduction \u0026amp; Quick Start\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Replaces the primary payment method associated with an active subscription. This operation is typically used when a customer updates their card, bank account, or switches to a different saved method for ongoing billing. You must provide the subscriptionId and the new payment method details. The new method will be used for all future charges, starting with the next billing cycle (or immediately, if a payment is due). This endpoint helps ensure billing continuity in case of expired cards, failed payments, or customer-initiated updates.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://revolv3.mintlify.app/_mintlify/api/og/v2?division=Subscriptions\u0026amp;title=Replace+Subscription+Primary+Payment+Method\u0026amp;description=Replaces+the+**primary+payment+method**+associated+with+an+active+subscription.%0D%0AThis+operation+is+typically+used+when+a+customer+updates+their+card%2C+bank+accou\u0026amp;theme=44ecc26a32f1a478fe3476c2\u0026amp;signature=1ce90f3690b1599605770f257de297bfebb3df4cde48ad6afdacfd3da986c274\">\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/replace-subscription-primary-payment-method\">\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/replace-subscription-primary-payment-method.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/replace-subscription-primary-payment-method#webpage\",\"url\":\"https://docs.revolv3.com/api-reference/subscriptions/replace-subscription-primary-payment-method\",\"name\":\"Replace Subscription Primary Payment Method\",\"description\":\"Replaces the primary payment method associated with an active subscription. This operation is typically used when a customer updates their card, bank account, or switches to a different saved method for ongoing billing. You must provide the subscriptionId and the new payment method details. The new method will be used for all future charges, starting with the next billing cycle (or immediately, if a payment is due). This endpoint helps ensure billing continuity in case of expired cards, failed payments, or customer-initiated updates.\",\"dateModified\":\"2026-10-13T22:34:18.101Z\",\"isPartOf\":{\"@id\":\"https://docs.revolv3.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.revolv3.com/api-reference/subscriptions/replace-subscription-primary-payment-method#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.revolv3.com/api-reference/subscriptions/replace-subscription-primary-payment-method#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Subscriptions\",\"item\":\"https://docs.revolv3.com/api-reference/subscriptions/get-subscriptions\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Replace Subscription Primary Payment Method\",\"item\":\"https://docs.revolv3.com/api-reference/subscriptions/replace-subscription-primary-payment-method\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.revolv3.com/api-reference/subscriptions/replace-subscription-primary-payment-method#apireference\",\"headline\":\"Replace Subscription Primary Payment Method\",\"name\":\"Replace Subscription Primary Payment Method\",\"description\":\"Replaces the primary payment method associated with an active subscription. This operation is typically used when a customer updates their card, bank account, or switches to a different saved method for ongoing billing. You must provide the subscriptionId and the new payment method details. The new method will be used for all future charges, starting with the next billing cycle (or immediately, if a payment is due). This endpoint helps ensure billing continuity in case of expired cards, failed payments, or customer-initiated updates.\",\"url\":\"https://docs.revolv3.com/api-reference/subscriptions/replace-subscription-primary-payment-method\",\"mainEntityOfPage\":{\"@id\":\"https://docs.revolv3.com/api-reference/subscriptions/replace-subscription-primary-payment-method#webpage\"},\"dateModified\":\"2026-10-13T22:34:18.101Z\",\"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","description":"Searches for and returns **subscriptions associated with a specific PAN (Primary Account Number)** — the full card number.\r\nThis endpoint is useful for backend support or migration scenarios where subscriptions need to be located based on card information, especially across multiple customer profiles.\r\n\r\nYou must be PCI-compliant to use this endpoint, as it involves sensitive payment identifiers.\r\nUse with caution and ensure appropriate access control is in place.","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","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":"Replace Subscription Primary Payment Method - 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"]}