This object represents a payment method stored against a customer.
The CustomerPaymentMethod object represents a payment instrument held against a customer and used to bill their subscriptions. Payment details are never stored by Juo — the object exposes only the non-sensitive attributes needed to display a payment method to the customer, such as the card brand, masked number, and expiry.
billingAddress is the address associated with the payment instrument, and is null when the payment provider does not supply one. It is distinct from the delivery address on a subscription or schedule order.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Developer documentation","colors":{"primary":"#0D9373","light":"#07C983","dark":"#0D9373"},"logo":{"light":"https://mintcdn.com/juo/cWBbLfFsu7G7x1mQ/logo/light.svg?fit=max\u0026auto=format\u0026n=cWBbLfFsu7G7x1mQ\u0026q=85\u0026s=f13f7b33b950522934898d18eb965a2e","dark":"https://mintcdn.com/juo/cWBbLfFsu7G7x1mQ/logo/dark.svg?fit=max\u0026auto=format\u0026n=cWBbLfFsu7G7x1mQ\u0026q=85\u0026s=cafe884c4acd726c219658d0c7cc8fd0"},"favicon":"https://mintcdn.com/juo/cWBbLfFsu7G7x1mQ/favicon.svg?fit=max\u0026auto=format\u0026n=cWBbLfFsu7G7x1mQ\u0026q=85\u0026s=a89152a6353d4e977e31bdbd37ec640d","background":{"decoration":"gradient"},"icons":{"library":"lucide"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Community","icon":"slack","href":"https://juo.community"},{"anchor":"Changelog","icon":"newspaper","href":"https://juo.com/changelog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"juo","hasAudioNarration":false,"actualSubdomain":"juo","customDomains":["juo.dev"],"gitSource":{"type":"github","owner":"juo","repo":"subscriptions-dev-docs","deployBranch":"master","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ac78351769f7f65cc69a68f","collectionId":"460bef9f-bb4b-4cb1-a0ca-e8b40f0ebb32","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ac78351769f7f65cc69a68f"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ad07d1fd7c9ed5c31a96190","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"default","tag":"API Reference","count":111},{"language":"default","tag":"Admin API","count":77},{"language":"default","tag":"Core Resources","count":76},{"language":"default","tag":"Docs","count":44},{"language":"default","tag":"Customer API","count":34},{"language":"default","tag":"Webhooks","count":28},{"language":"default","tag":"Topics","count":26},{"language":"default","tag":"Blocks","count":21},{"language":"default","tag":"Subscriptions","count":17},{"language":"default","tag":"Platform","count":14}]},"assistantConfig":{},"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":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"docs/api-reference/customer/payment-methods/resource","slug":"/docs/api-reference/customer/payment-methods/resource","pageMetadata":{"title":"Payment method resource","description":"This object represents a payment method stored against a customer.","openapi-schema":"openapi-customer.json CustomerPaymentMethod","href":"/docs/api-reference/customer/payment-methods/resource"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"This object represents a payment method stored against a customer.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`The `,_jsx(_components.code,{children:`CustomerPaymentMethod`}),` object represents a payment instrument held against a customer and used to bill their subscriptions. Payment details are never stored by Juo — the object exposes only the non-sensitive attributes needed to display a payment method to the customer, such as the card brand, masked number, and expiry.`]}),`\n`,_jsx(Heading,{level:`3`,id:`billing-address`,children:`Billing address`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`billingAddress`}),` is the address associated with the payment instrument, and is `,_jsx(_components.code,{children:`null`}),` when the payment provider does not supply one. It is distinct from the delivery address on a subscription or schedule order.`]}),`\n`,_jsx(Heading,{level:`3`,id:`reference`,children:`Reference`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Payment method resource","description":"This object represents a payment method stored against a customer.","openapi-schema":"openapi-customer.json CustomerPaymentMethod","href":"/docs/api-reference/customer/payment-methods/resource"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Billing address","slug":"billing-address","depth":3,"children":[]},{"title":"Reference","slug":"reference","depth":3,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"schemaData":{"type":"object","properties":{"id":{"format":"uuid","type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"customer":{"oneOf":[{"type":"string","description":"Customer `id` when not expanded, or the full `Customer` object when the field name is included in the `expand` query parameter.","minLength":1,"example":"7654321","isRequired":true,"uniqueKey":"customer.oneOf.0","typeLabel":"string"},{"type":"object","title":"Customer","description":"Customer `id` when not expanded, or the full `Customer` object when the field name is included in the `expand` query parameter.","required":["id","resource","displayName","email","phone","customAttributes"],"properties":{"id":{"minLength":1,"description":"Customer ID (numeric string).","type":"string","example":"7654321","isRequired":true,"uniqueKey":"customer.oneOf.1.id","typeLabel":"string"},"resource":{"type":"string","enum":["customer"],"isRequired":true,"uniqueKey":"customer.oneOf.1.resource","typeLabel":"enum\u003cstring>"},"displayName":{"minLength":1,"description":"Customer's full name.","type":"string","example":"Jane Smith","isRequired":true,"uniqueKey":"customer.oneOf.1.displayName","typeLabel":"string"},"email":{"oneOf":[{"type":"null","description":"Customer's contact email.","format":"email","example":"[email protected]","isRequired":true,"uniqueKey":"customer.oneOf.1.email.oneOf.0","typeLabel":"null"},{"type":"string","description":"Customer's contact email.","format":"email","example":"[email protected]","isRequired":true,"uniqueKey":"customer.oneOf.1.email.oneOf.1","typeLabel":"string\u003cemail>"}],"isRequired":true,"uniqueKey":"customer.oneOf.1.email","typeLabel":"null | string\u003cemail>"},"phone":{"oneOf":[{"type":"null","description":"Customer's contact phone number in E.164 format.","minLength":1,"example":"+15550100","isRequired":true,"uniqueKey":"customer.oneOf.1.phone.oneOf.0","typeLabel":"null"},{"type":"string","description":"Customer's contact phone number in E.164 format.","minLength":1,"example":"+15550100","isRequired":true,"uniqueKey":"customer.oneOf.1.phone.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"customer.oneOf.1.phone","typeLabel":"null | string"},"customAttributes":{"description":"Arbitrary key-value pairs attached to this customer. Attributes whose key starts with `_` are internal and excluded.","type":"array","items":{"type":"object","properties":{"key":{"minLength":1,"type":"string","isRequired":true,"uniqueKey":"customer.oneOf.1.customAttributes.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","isRequired":true,"uniqueKey":"customer.oneOf.1.customAttributes.items.[INDEX].value","typeLabel":"string"}},"required":["key","value"],"uniqueKey":"customer.oneOf.1.customAttributes.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"customer.oneOf.1.customAttributes","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"customer.oneOf.1","typeLabel":"Customer · object"}],"isRequired":true,"uniqueKey":"customer","typeLabel":"string | Customer · object"},"instrument":{"oneOf":[{"type":"object","required":["type","brand","maskedNumber","lastDigits"],"properties":{"type":{"type":"string","enum":["credit-card"],"isRequired":true,"uniqueKey":"instrument.oneOf.0.type","typeLabel":"enum\u003cstring>"},"brand":{"description":"Credit card network name.","type":"string","isRequired":true,"uniqueKey":"instrument.oneOf.0.brand","typeLabel":"string"},"maskedNumber":{"description":"Masked card number.","type":"string","isRequired":true,"uniqueKey":"instrument.oneOf.0.maskedNumber","typeLabel":"string"},"lastDigits":{"description":"Last digits of the card number.","type":"string","isRequired":true,"uniqueKey":"instrument.oneOf.0.lastDigits","typeLabel":"string"},"expiryMonth":{"type":"integer","uniqueKey":"instrument.oneOf.0.expiryMonth","typeLabel":"integer"},"expiryYear":{"type":"integer","uniqueKey":"instrument.oneOf.0.expiryYear","typeLabel":"integer"},"cardholderName":{"type":"string","uniqueKey":"instrument.oneOf.0.cardholderName","typeLabel":"string"}},"uniqueKey":"instrument.oneOf.0","typeLabel":"object"},{"type":"object","required":["type","paypalAccountEmail"],"properties":{"type":{"type":"string","enum":["paypal"],"isRequired":true,"uniqueKey":"instrument.oneOf.1.type","typeLabel":"enum\u003cstring>"},"paypalAccountEmail":{"oneOf":[{"type":"null","description":"Email of the associated PayPal account.","format":"email","isRequired":true,"uniqueKey":"instrument.oneOf.1.paypalAccountEmail.oneOf.0","typeLabel":"null"},{"type":"string","description":"Email of the associated PayPal account.","format":"email","isRequired":true,"uniqueKey":"instrument.oneOf.1.paypalAccountEmail.oneOf.1","typeLabel":"string\u003cemail>"}],"isRequired":true,"uniqueKey":"instrument.oneOf.1.paypalAccountEmail","typeLabel":"null | string\u003cemail>"}},"uniqueKey":"instrument.oneOf.1","typeLabel":"object"},{"type":"object","required":["type","maskedNumber"],"properties":{"type":{"type":"string","enum":["shop-pay"],"isRequired":true,"uniqueKey":"instrument.oneOf.2.type","typeLabel":"enum\u003cstring>"},"maskedNumber":{"description":"Masked card number.","type":"string","isRequired":true,"uniqueKey":"instrument.oneOf.2.maskedNumber","typeLabel":"string"},"expiryMonth":{"type":"integer","uniqueKey":"instrument.oneOf.2.expiryMonth","typeLabel":"integer"},"expiryYear":{"type":"integer","uniqueKey":"instrument.oneOf.2.expiryYear","typeLabel":"integer"},"cardholderName":{"type":"string","uniqueKey":"instrument.oneOf.2.cardholderName","typeLabel":"string"}},"uniqueKey":"instrument.oneOf.2","typeLabel":"object"},{"type":"object","required":["type","consumerName","consumerBic","maskedConsumerAccount"],"properties":{"type":{"type":"string","enum":["sepa-direct-debit"],"isRequired":true,"uniqueKey":"instrument.oneOf.3.type","typeLabel":"enum\u003cstring>"},"consumerName":{"description":"Full name of the account holder.","type":"string","isRequired":true,"uniqueKey":"instrument.oneOf.3.consumerName","typeLabel":"string"},"consumerBic":{"oneOf":[{"type":"null","description":"BIC code.","isRequired":true,"uniqueKey":"instrument.oneOf.3.consumerBic.oneOf.0","typeLabel":"null"},{"type":"string","description":"BIC code.","isRequired":true,"uniqueKey":"instrument.oneOf.3.consumerBic.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"instrument.oneOf.3.consumerBic","typeLabel":"null | string"},"maskedConsumerAccount":{"description":"Masked IBAN.","type":"string","isRequired":true,"uniqueKey":"instrument.oneOf.3.maskedConsumerAccount","typeLabel":"string"}},"uniqueKey":"instrument.oneOf.3","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["blik"],"isRequired":true,"uniqueKey":"instrument.oneOf.4.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"instrument.oneOf.4","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["mbway"],"isRequired":true,"uniqueKey":"instrument.oneOf.5.type","typeLabel":"enum\u003cstring>"},"phone":{"type":"string","uniqueKey":"instrument.oneOf.5.phone","typeLabel":"string"}},"uniqueKey":"instrument.oneOf.5","typeLabel":"object"},{"type":"object","required":["type","maskedNumber"],"properties":{"type":{"type":"string","enum":["bacs"],"isRequired":true,"uniqueKey":"instrument.oneOf.6.type","typeLabel":"enum\u003cstring>"},"maskedNumber":{"description":"Masked number.","type":"string","isRequired":true,"uniqueKey":"instrument.oneOf.6.maskedNumber","typeLabel":"string"}},"uniqueKey":"instrument.oneOf.6","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["manual"],"isRequired":true,"uniqueKey":"instrument.oneOf.7.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"instrument.oneOf.7","typeLabel":"object"}],"uniqueKey":"instrument","typeLabel":"object"},"billingAddress":{"oneOf":[{"type":"null","uniqueKey":"billingAddress.oneOf.0","typeLabel":"null"},{"type":"object","required":["firstName","lastName","address1","address2","zip","city","country","countryCode","provinceCode","province","phone","company"],"properties":{"firstName":{"oneOf":[{"type":"null","description":"Customer's first name.","minLength":1,"isRequired":true,"uniqueKey":"billingAddress.oneOf.1.firstName.oneOf.0","typeLabel":"null"},{"type":"string","description":"Customer's first name.","minLength":1,"isRequired":true,"uniqueKey":"billingAddress.oneOf.1.firstName.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"billingAddress.oneOf.1.firstName","typeLabel":"null | string"},"lastName":{"oneOf":[{"type":"null","description":"Customer's last name.","minLength":1,"isRequired":true,"uniqueKey":"billingAddress.oneOf.1.lastName.oneOf.0","typeLabel":"null"},{"type":"string","description":"Customer's last name.","minLength":1,"isRequired":true,"uniqueKey":"billingAddress.oneOf.1.lastName.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"billingAddress.oneOf.1.lastName","typeLabel":"null | string"},"address1":{"oneOf":[{"type":"null","description":"Primary street address.","minLength":1,"isRequired":true,"uniqueKey":"billingAddress.oneOf.1.address1.oneOf.0","typeLabel":"null"},{"type":"string","description":"Primary street address.","minLength":1,"isRequired":true,"uniqueKey":"billingAddress.oneOf.1.address1.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"billingAddress.oneOf.1.address1","typeLabel":"null | string"},"address2":{"oneOf":[{"type":"null","description":"Additional address information (apartment, suite, etc.)","minLength":1,"isRequired":true,"uniqueKey":"billingAddress.oneOf.1.address2.oneOf.0","typeLabel":"null"},{"type":"string","description":"Additional address information (apartment, suite, etc.)","minLength":1,"isRequired":true,"uniqueKey":"billingAddress.oneOf.1.address2.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"billingAddress.oneOf.1.address2","typeLabel":"null | string"},"zip":{"oneOf":[{"type":"null","description":"Postal/ZIP code.","minLength":1,"isRequired":true,"uniqueKey":"billingAddress.oneOf.1.zip.oneOf.0","typeLabel":"null"},{"type":"string","description":"Postal/ZIP code.","minLength":1,"isRequired":true,"uniqueKey":"billingAddress.oneOf.1.zip.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"billingAddress.oneOf.1.zip","typeLabel":"null | string"},"city":{"oneOf":[{"type":"null","description":"City name.","minLength":1,"isRequired":true,"uniqueKey":"billingAddress.oneOf.1.city.oneOf.0","typeLabel":"null"},{"type":"string","description":"City name.","minLength":1,"isRequired":true,"uniqueKey":"billingAddress.oneOf.1.city.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"billingAddress.oneOf.1.city","typeLabel":"null | string"},"country":{"oneOf":[{"type":"null","description":"Full country name.","minLength":1,"isRequired":true,"uniqueKey":"billingAddress.oneOf.1.country.oneOf.0","typeLabel":"null"},{"type":"string","description":"Full country name.","minLength":1,"isRequired":true,"uniqueKey":"billingAddress.oneOf.1.country.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"billingAddress.oneOf.1.country","typeLabel":"null | string"},"countryCode":{"oneOf":[{"type":"null","description":"Two-letter country code (ISO 3166-1).","maxLength":2,"minLength":2,"isRequired":true,"uniqueKey":"billingAddress.oneOf.1.countryCode.oneOf.0","typeLabel":"null"},{"type":"string","description":"Two-letter country code (ISO 3166-1).","maxLength":2,"minLength":2,"isRequired":true,"uniqueKey":"billingAddress.oneOf.1.countryCode.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"billingAddress.oneOf.1.countryCode","typeLabel":"null | string"},"provinceCode":{"oneOf":[{"type":"null","description":"Province/state code.","minLength":1,"isRequired":true,"uniqueKey":"billingAddress.oneOf.1.provinceCode.oneOf.0","typeLabel":"null"},{"type":"string","description":"Province/state code.","minLength":1,"isRequired":true,"uniqueKey":"billingAddress.oneOf.1.provinceCode.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"billingAddress.oneOf.1.provinceCode","typeLabel":"null | string"},"province":{"oneOf":[{"type":"null","description":"Full province/state name.","minLength":1,"isRequired":true,"uniqueKey":"billingAddress.oneOf.1.province.oneOf.0","typeLabel":"null"},{"type":"string","description":"Full province/state name.","minLength":1,"isRequired":true,"uniqueKey":"billingAddress.oneOf.1.province.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"billingAddress.oneOf.1.province","typeLabel":"null | string"},"phone":{"oneOf":[{"type":"null","description":"Contact phone number.","minLength":1,"isRequired":true,"uniqueKey":"billingAddress.oneOf.1.phone.oneOf.0","typeLabel":"null"},{"type":"string","description":"Contact phone number.","minLength":1,"isRequired":true,"uniqueKey":"billingAddress.oneOf.1.phone.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"billingAddress.oneOf.1.phone","typeLabel":"null | string"},"company":{"oneOf":[{"type":"null","description":"Company name.","minLength":1,"isRequired":true,"uniqueKey":"billingAddress.oneOf.1.company.oneOf.0","typeLabel":"null"},{"type":"string","description":"Company name.","minLength":1,"isRequired":true,"uniqueKey":"billingAddress.oneOf.1.company.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"billingAddress.oneOf.1.company","typeLabel":"null | string"}},"uniqueKey":"billingAddress.oneOf.1","typeLabel":"object"}],"uniqueKey":"billingAddress","typeLabel":"null | object"}},"required":["id","customer"],"title":"CustomerPaymentMethod","uniqueKey":"","typeLabel":"CustomerPaymentMethod · object","example":{"title":"Example","value":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","customer":"7654321","instrument":{"type":"credit-card","brand":"\u003cstring>","maskedNumber":"\u003cstring>","lastDigits":"\u003cstring>","expiryMonth":123,"expiryYear":123,"cardholderName":"\u003cstring>"},"billingAddress":{"firstName":"\u003cstring>","lastName":"\u003cstring>","address1":"\u003cstring>","address2":"\u003cstring>","zip":"\u003cstring>","city":"\u003cstring>","country":"\u003cstring>","countryCode":"\u003cstring>","provinceCode":"\u003cstring>","province":"\u003cstring>","phone":"\u003cstring>","company":"\u003cstring>"}}}},"originalFileLocation":"openapi-customer.json"},"subdomain":"juo","siteName":"Developer documentation","title":"Payment method resource - Developer documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-05T13:45:25.069Z","originalFileLocation":"docs/api-reference/customer/payment-methods/resource.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=\"This object represents a payment method stored against a customer.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Developer documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/juo/HRxdlVE07BysfB5B/_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/juo/HRxdlVE07BysfB5B/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/juo/HRxdlVE07BysfB5B/_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/juo/HRxdlVE07BysfB5B/_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/juo/HRxdlVE07BysfB5B/_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/juo/HRxdlVE07BysfB5B/_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/juo/HRxdlVE07BysfB5B/_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/juo/HRxdlVE07BysfB5B/_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/juo/HRxdlVE07BysfB5B/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Payment method resource - Developer documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"This object represents a payment method stored against a customer.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Developer documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://juo.dev/docs/api-reference/customer/payment-methods/resource\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://juo.mintlify.app/_mintlify/api/og/v2?division=Payment+methods\u0026amp;title=Payment+method+resource\u0026amp;description=This+object+represents+a+payment+method+stored+against+a+customer.\u0026amp;theme=156a7f98b0ee4b6c07470a6b\u0026amp;signature=f4087e478bda61504d17409d2ad59079968201a70663300040f719c6479a6678\">\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=\"Payment method resource - Developer documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"This object represents a payment method stored against a customer.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://juo.mintlify.app/_mintlify/api/og/v2?division=Payment+methods\u0026amp;title=Payment+method+resource\u0026amp;description=This+object+represents+a+payment+method+stored+against+a+customer.\u0026amp;theme=156a7f98b0ee4b6c07470a6b\u0026amp;signature=f4087e478bda61504d17409d2ad59079968201a70663300040f719c6479a6678\">\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/juo/HRxdlVE07BysfB5B/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Developer documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9373\">\u003clink data-mint-head rel=\"canonical\" href=\"https://juo.dev/docs/api-reference/customer/payment-methods/resource\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/customer/payment-methods/resource.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://juo.dev/#organization\",\"name\":\"Developer documentation\",\"url\":\"https://juo.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/juo/cWBbLfFsu7G7x1mQ/logo/light.svg?fit=max\u0026auto=format\u0026n=cWBbLfFsu7G7x1mQ\u0026q=85\u0026s=f13f7b33b950522934898d18eb965a2e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://juo.dev#website\",\"name\":\"Developer documentation\",\"url\":\"https://juo.dev\",\"publisher\":{\"@id\":\"https://juo.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://juo.dev/docs/api-reference/customer/payment-methods/resource#webpage\",\"url\":\"https://juo.dev/docs/api-reference/customer/payment-methods/resource\",\"name\":\"Payment method resource\",\"description\":\"This object represents a payment method stored against a customer.\",\"dateModified\":\"2026-08-05T13:45:25.069Z\",\"isPartOf\":{\"@id\":\"https://juo.dev#website\"},\"breadcrumb\":{\"@id\":\"https://juo.dev/docs/api-reference/customer/payment-methods/resource#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://juo.dev/docs/api-reference/customer/payment-methods/resource#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Core Resources\",\"item\":\"https://juo.dev/docs/api-reference/customer/products/resource\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Payment method resource\",\"item\":\"https://juo.dev/docs/api-reference/customer/payment-methods/resource\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://juo.dev/docs/api-reference/customer/payment-methods/resource#apireference\",\"headline\":\"Payment method resource\",\"name\":\"Payment method resource\",\"description\":\"This object represents a payment method stored against a customer.\",\"url\":\"https://juo.dev/docs/api-reference/customer/payment-methods/resource\",\"mainEntityOfPage\":{\"@id\":\"https://juo.dev/docs/api-reference/customer/payment-methods/resource#webpage\"},\"dateModified\":\"2026-08-05T13:45:25.069Z\",\"publisher\":{\"@id\":\"https://juo.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://juo.dev#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Developer documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Developer documentation","nav":{"global":{"anchors":[{"anchor":"Community","icon":"slack","href":"https://juo.community"},{"anchor":"Changelog","icon":"newspaper","href":"https://juo.com/changelog"}]},"tabs":[{"tab":"Platform","icon":"layers","pages":[{"title":"Platform","href":"/docs/introduction"}]},{"tab":"API Reference","icon":"square-terminal","dropdowns":[{"dropdown":"Admin API","icon":"wrench","groups":[{"group":" ","pages":[{"title":"Introduction","href":"/docs/api-reference/admin/introduction"}]},{"group":"Core Resources","pages":[{"group":"Customers","pages":[{"title":"Customer resource","href":"/docs/api-reference/admin/customers/resource"},{"title":"List customers","openapi":"openapi-admin.json GET /customers","href":"/docs/api-reference/admin/customers/list"},{"title":"Create a customer","openapi":"openapi-admin.json POST /customers","href":"/docs/api-reference/admin/customers/create"},{"title":"Update a customer","openapi":"openapi-admin.json PATCH /customers/{customerId}","href":"/docs/api-reference/admin/customers/update"},{"title":"Delete a customer","openapi":"openapi-admin.json DELETE /customers/{customerId}","href":"/docs/api-reference/admin/customers/delete"},{"title":"Add a payment method","openapi":"openapi-admin.json POST /customers/{customerId}/payment-methods","href":"/docs/api-reference/admin/customers/add-payment-method"}]},{"group":"Products","pages":[{"title":"Product resource","href":"/docs/api-reference/admin/products/resource"},{"title":"List products","openapi":"openapi-admin.json GET /products","href":"/docs/api-reference/admin/products/list"},{"title":"Create a product","openapi":"openapi-admin.json POST /products","href":"/docs/api-reference/admin/products/create"},{"title":"Update a product","openapi":"openapi-admin.json PATCH /products/{productId}","href":"/docs/api-reference/admin/products/update"},{"title":"Delete a product","openapi":"openapi-admin.json DELETE /products/{productId}","href":"/docs/api-reference/admin/products/delete"},{"title":"Assign product to plan","openapi":"openapi-admin.json POST /products/{productId}/plans","href":"/docs/api-reference/admin/products/assign-plan"},{"title":"Remove product from plan","openapi":"openapi-admin.json DELETE /products/{productId}/plans","href":"/docs/api-reference/admin/products/remove-plan"},{"title":"Add a variant","openapi":"openapi-admin.json POST /products/{productId}/variants","href":"/docs/api-reference/admin/products/add-variant"},{"title":"Remove a variant","openapi":"openapi-admin.json DELETE /products/{productId}/variants/{variantId}","href":"/docs/api-reference/admin/products/remove-variant"},{"title":"Assign variant to plan","openapi":"openapi-admin.json POST /products/{productId}/variants/{variantId}/plans","href":"/docs/api-reference/admin/products/assign-variant-plan"},{"title":"Remove variant from plan","openapi":"openapi-admin.json DELETE /products/{productId}/variants/{variantId}/plans","href":"/docs/api-reference/admin/products/remove-variant-plan"}]},{"group":"Subscriptions","pages":[{"title":"Subscription resource","href":"/docs/api-reference/admin/subscriptions/resource"},{"title":"List subscriptions","openapi":"openapi-admin.json GET /subscriptions","href":"/docs/api-reference/admin/subscriptions/list"},{"title":"Create a subscription","openapi":"openapi-admin.json POST /subscriptions","href":"/docs/api-reference/admin/subscriptions/create"},{"title":"Update subscription","openapi":"openapi-admin.json PATCH /subscriptions/{subscriptionId}","href":"/docs/api-reference/admin/subscriptions/update"},{"title":"Cancel subscription","openapi":"openapi-admin.json POST /subscriptions/{subscriptionId}/cancel","href":"/docs/api-reference/admin/subscriptions/cancel"},{"title":"Resume subscription","openapi":"openapi-admin.json POST /subscriptions/{subscriptionId}/resume","href":"/docs/api-reference/admin/subscriptions/resume"},{"title":"Pause subscription","openapi":"openapi-admin.json POST /subscriptions/{subscriptionId}/pause","href":"/docs/api-reference/admin/subscriptions/pause"},{"title":"Reactivate subscription","openapi":"openapi-admin.json POST /subscriptions/{subscriptionId}/reactivate","href":"/docs/api-reference/admin/subscriptions/reactivate"},{"title":"Add custom attributes to a subscription","openapi":"openapi-admin.json POST /subscriptions/{subscriptionId}/custom-attributes","href":"/docs/api-reference/admin/subscriptions/add-custom-attributes"},{"title":"Set custom attributes on a subscription","openapi":"openapi-admin.json PATCH /subscriptions/{subscriptionId}/custom-attributes","href":"/docs/api-reference/admin/subscriptions/set-custom-attributes"}]},{"group":"Subscription items","pages":[{"title":"Subscription item resource","href":"/docs/api-reference/admin/subscription-items/resource"},{"title":"Create a subscription item","openapi":"openapi-admin.json POST /subscriptions/{subscriptionId}/items","href":"/docs/api-reference/admin/subscription-items/create"},{"title":"Update subscription item","openapi":"openapi-admin.json PATCH /subscriptions/{subscriptionId}/items/{itemId}","href":"/docs/api-reference/admin/subscription-items/update"},{"title":"Delete subscription item","openapi":"openapi-admin.json DELETE /subscriptions/{subscriptionId}/items/{itemId}","href":"/docs/api-reference/admin/subscription-items/delete"}]},{"group":"Subscription discounts","pages":[{"title":"Subscription discount resource","href":"/docs/api-reference/admin/subscription-discounts/resource"},{"title":"Create a subscription discount","openapi":"openapi-admin.json POST /subscriptions/{subscriptionId}/discounts","href":"/docs/api-reference/admin/subscription-discounts/create"},{"title":"Update a subscription discount","openapi":"openapi-admin.json PATCH /subscriptions/{subscriptionId}/discounts/{discountId}","href":"/docs/api-reference/admin/subscription-discounts/update"},{"title":"Delete a subscription discount","openapi":"openapi-admin.json DELETE /subscriptions/{subscriptionId}/discounts/{discountId}","href":"/docs/api-reference/admin/subscription-discounts/delete"}]},{"group":"Schedules","pages":[{"title":"Schedule order resource","href":"/docs/api-reference/admin/schedules/resource"},{"title":"Get schedule","openapi":"openapi-admin.json GET /schedules/","href":"/docs/api-reference/admin/schedules/get"}]},{"group":"Schedule adjustments","pages":[{"title":"Schedule adjustment resource","href":"/docs/api-reference/admin/schedule-adjustments/resource"},{"title":"Actions","href":"/docs/api-reference/admin/schedule-adjustments/actions"},{"title":"Matchers","href":"/docs/api-reference/admin/schedule-adjustments/matchers"},{"title":"List schedule adjustments","openapi":"openapi-admin.json GET /schedules/adjustments","href":"/docs/api-reference/admin/schedule-adjustments/list"},{"title":"Create a schedule adjustment","openapi":"openapi-admin.json POST /schedules/adjustments","href":"/docs/api-reference/admin/schedule-adjustments/create"},{"title":"Delete a schedule adjustment","openapi":"openapi-admin.json DELETE /schedules/adjustments/{adjustmentId}","href":"/docs/api-reference/admin/schedule-adjustments/delete"}]}]},{"group":"Analytics","pages":[{"title":"List analytics metrics","openapi":"openapi-admin.json GET /analytics/metrics","href":"/docs/api-reference/admin/analytics/list-metrics"},{"title":"Query analytics","openapi":"openapi-admin.json POST /analytics/query","href":"/docs/api-reference/admin/analytics/query"}]},{"group":"Events","pages":[{"title":"Event resource","href":"/docs/api-reference/admin/events/resource"},{"title":"List events","openapi":"openapi-admin.json GET /events","href":"/docs/api-reference/admin/events/list"},{"title":"List event types","openapi":"openapi-admin.json GET /events/types","href":"/docs/api-reference/admin/events/list-types"}]},{"group":"Webhooks","pages":[{"title":"Overview","href":"/docs/api-reference/admin/webhooks/overview"},{"title":"Signature verification","href":"/docs/api-reference/admin/webhooks/signature-verification"},{"group":"Topics","pages":[{"title":"Customer created","version":null,"deprecated":null,"openapi":"/openapi-admin.json webhook customer.created","href":"/api-reference/customer-created"},{"title":"Customer updated","version":null,"deprecated":null,"openapi":"/openapi-admin.json webhook customer.updated","href":"/api-reference/customer-updated"},{"title":"Customer payment method created","version":null,"deprecated":null,"openapi":"/openapi-admin.json webhook customer-payment-method.created","href":"/api-reference/customer-payment-method-created"},{"title":"Customer payment method updated","version":null,"deprecated":null,"openapi":"/openapi-admin.json webhook customer-payment-method.updated","href":"/api-reference/customer-payment-method-updated"},{"title":"Customer payment method revoked","version":null,"deprecated":null,"openapi":"/openapi-admin.json webhook customer-payment-method.revoked","href":"/api-reference/customer-payment-method-revoked"},{"title":"Subscription created","version":null,"deprecated":null,"openapi":"/openapi-admin.json webhook subscription.created","href":"/api-reference/subscription-created"},{"title":"Subscription updated","version":null,"deprecated":null,"openapi":"/openapi-admin.json webhook subscription.updated","href":"/api-reference/subscription-updated"},{"title":"Subscription renewed","version":null,"deprecated":null,"openapi":"/openapi-admin.json webhook subscription.renewed","href":"/api-reference/subscription-renewed"},{"title":"Subscription item created","version":null,"deprecated":null,"openapi":"/openapi-admin.json webhook subscription-item.created","href":"/api-reference/subscription-item-created"},{"title":"Subscription item updated","version":null,"deprecated":null,"openapi":"/openapi-admin.json webhook subscription-item.updated","href":"/api-reference/subscription-item-updated"},{"title":"Subscription item deleted","version":null,"deprecated":null,"openapi":"/openapi-admin.json webhook subscription-item.deleted","href":"/api-reference/subscription-item-deleted"},{"title":"Subscription discount created","version":null,"deprecated":null,"openapi":"/openapi-admin.json webhook subscription-discount.created","href":"/api-reference/subscription-discount-created"},{"title":"Subscription discount updated","version":null,"deprecated":null,"openapi":"/openapi-admin.json webhook subscription-discount.updated","href":"/api-reference/subscription-discount-updated"},{"title":"Subscription discount deleted","version":null,"deprecated":null,"openapi":"/openapi-admin.json webhook subscription-discount.deleted","href":"/api-reference/subscription-discount-deleted"},{"title":"Schedule adjustment created","version":null,"deprecated":null,"openapi":"/openapi-admin.json webhook schedule-adjustment.created","href":"/api-reference/schedule-adjustment-created"},{"title":"Schedule adjustment updated","version":null,"deprecated":null,"openapi":"/openapi-admin.json webhook schedule-adjustment.updated","href":"/api-reference/schedule-adjustment-updated"},{"title":"Schedule adjustment deleted","version":null,"deprecated":null,"openapi":"/openapi-admin.json webhook schedule-adjustment.deleted","href":"/api-reference/schedule-adjustment-deleted"},{"title":"Product created","version":null,"deprecated":null,"openapi":"/openapi-admin.json webhook product.created","href":"/api-reference/product-created"},{"title":"Product updated","version":null,"deprecated":null,"openapi":"/openapi-admin.json webhook product.updated","href":"/api-reference/product-updated"},{"title":"Product deleted","version":null,"deprecated":null,"openapi":"/openapi-admin.json webhook product.deleted","href":"/api-reference/product-deleted"},{"title":"Product variant created","version":null,"deprecated":null,"openapi":"/openapi-admin.json webhook product-variant.created","href":"/api-reference/product-variant-created"},{"title":"Product variant updated","version":null,"deprecated":null,"openapi":"/openapi-admin.json webhook product-variant.updated","href":"/api-reference/product-variant-updated"},{"title":"Product variant deleted","version":null,"deprecated":null,"openapi":"/openapi-admin.json webhook product-variant.deleted","href":"/api-reference/product-variant-deleted"},{"title":"Order created","version":null,"deprecated":null,"openapi":"/openapi-admin.json webhook order.created","href":"/api-reference/order-created"},{"title":"Order updated","version":null,"deprecated":null,"openapi":"/openapi-admin.json webhook order.updated","href":"/api-reference/order-updated"},{"title":"Order deleted","version":null,"deprecated":null,"openapi":"/openapi-admin.json webhook order.deleted","href":"/api-reference/order-deleted"}]}]}]},{"dropdown":"Customer API","icon":"user","groups":[{"group":" ","pages":[{"title":"Introduction","href":"/docs/api-reference/customer/introduction"}]},{"group":"Core Resources","pages":[{"group":"Products","pages":[{"title":"Product resource","href":"/docs/api-reference/customer/products/resource"},{"title":"List products","openapi":"openapi-customer.json GET /products","href":"/docs/api-reference/customer/products/list"}]},{"group":"Subscriptions","pages":[{"title":"Subscription resource","href":"/docs/api-reference/customer/subscriptions/resource"},{"title":"List subscriptions","openapi":"openapi-customer.json GET /subscriptions","href":"/docs/api-reference/customer/subscriptions/list"},{"title":"Update subscription","openapi":"openapi-customer.json PATCH /subscriptions/{subscriptionId}","href":"/docs/api-reference/customer/subscriptions/update"},{"title":"Cancel subscription","openapi":"openapi-customer.json POST /subscriptions/{subscriptionId}/cancel","href":"/docs/api-reference/customer/subscriptions/cancel"},{"title":"Resume subscription","openapi":"openapi-customer.json POST /subscriptions/{subscriptionId}/resume","href":"/docs/api-reference/customer/subscriptions/resume"},{"title":"Pause subscription","openapi":"openapi-customer.json POST /subscriptions/{subscriptionId}/pause","href":"/docs/api-reference/customer/subscriptions/pause"},{"title":"Reactivate subscription","openapi":"openapi-customer.json POST /subscriptions/{subscriptionId}/reactivate","href":"/docs/api-reference/customer/subscriptions/reactivate"}]},{"group":"Subscription items","pages":[{"title":"Subscription item resource","href":"/docs/api-reference/customer/subscription-items/resource"},{"title":"Create a subscription item","openapi":"openapi-customer.json POST /subscriptions/{subscriptionId}/items","href":"/docs/api-reference/customer/subscription-items/create"},{"title":"Update subscription item","openapi":"openapi-customer.json PATCH /subscriptions/{subscriptionId}/items/{itemId}","href":"/docs/api-reference/customer/subscription-items/update"},{"title":"Delete subscription item","openapi":"openapi-customer.json DELETE /subscriptions/{subscriptionId}/items/{itemId}","href":"/docs/api-reference/customer/subscription-items/delete"}]},{"group":"Subscription discounts","pages":[{"title":"Subscription discount resource","href":"/docs/api-reference/customer/subscription-discounts/resource"},{"title":"Create a subscription discount","openapi":"openapi-customer.json POST /subscriptions/{subscriptionId}/discounts","href":"/docs/api-reference/customer/subscription-discounts/create"},{"title":"Delete a subscription discount","openapi":"openapi-customer.json DELETE /subscriptions/{subscriptionId}/discounts/{discountId}","href":"/docs/api-reference/customer/subscription-discounts/delete"}]},{"group":"Orders","pages":[{"title":"Order resource","href":"/docs/api-reference/customer/orders/resource"},{"title":"List orders","openapi":"openapi-customer.json GET /orders","href":"/docs/api-reference/customer/orders/list"},{"title":"Pay an order","description":"Returns a payment link for an order with an outstanding balance.","openapi":"openapi-customer.json POST /orders/{orderId}/pay","href":"/docs/api-reference/customer/orders/pay"}]},{"group":"Payment methods","pages":[{"title":"Payment method resource","href":"/docs/api-reference/customer/payment-methods/resource"},{"title":"Create a payment method","description":"Used to create a payment method.","openapi":"openapi-customer.json POST /payment-methods","href":"/docs/api-reference/customer/payment-methods/create"}]},{"group":"Schedules","pages":[{"title":"Schedule order resource","href":"/docs/api-reference/customer/schedules/resource"},{"title":"Get schedule","openapi":"openapi-customer.json GET /schedules/","href":"/docs/api-reference/customer/schedules/get"}]},{"group":"Schedule adjustments","pages":[{"title":"Schedule adjustment resource","href":"/docs/api-reference/customer/schedule-adjustments/resource"},{"title":"List schedule adjustments","openapi":"openapi-customer.json GET /schedules/adjustments","href":"/docs/api-reference/customer/schedule-adjustments/list"},{"title":"Create a schedule adjustment","openapi":"openapi-customer.json POST /schedules/adjustments","href":"/docs/api-reference/customer/schedule-adjustments/create"},{"title":"Delete a schedule adjustment","openapi":"openapi-customer.json DELETE /schedules/adjustments/{adjustmentId}","href":"/docs/api-reference/customer/schedule-adjustments/delete"}]},{"group":"Authentication","pages":[{"title":"Get Shopify auth token","openapi":"openapi-customer.json GET /auth/shopify/token","href":"/docs/api-reference/customer/auth/shopify-token"}]},{"group":"Workflows","pages":[{"title":"Workflow run resource","href":"/docs/api-reference/customer/workflows/resource"},{"title":"Start a workflow","openapi":"openapi-customer.json POST /workflows/start","href":"/docs/api-reference/customer/workflows/start"},{"title":"Get workflow run","openapi":"openapi-customer.json GET /workflows/{runId}","href":"/docs/api-reference/customer/workflows/get"},{"title":"Respond to a workflow run","openapi":"openapi-customer.json POST /workflows/{runId}/respond","href":"/docs/api-reference/customer/workflows/respond"},{"title":"Cancel workflow run","openapi":"openapi-customer.json POST /workflows/{runId}/cancel","href":"/docs/api-reference/customer/workflows/cancel"}]}]}]}]},{"tab":"Blocks","icon":"blocks","pages":[{"title":"Blocks","href":"/docs/blocks/overview"}]},{"tab":"Customer UI","icon":"palette","pages":[{"title":"Customer UI","href":"/docs/customer-ui/getting-started"}]}]},"basePath":"","title":"Payment method resource - Developer documentation","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DX1Meug0.js","utils-B_OMIQVC.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChxhRPMa.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CuKvD8Iv.js","snippetPresets-C5d7p2hp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CfHcE8m4.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C1zZV314.js","shallow-CmQhqCJn.js","getApiPlaygroundDisplay-YRo9s1O7.js","CodeSnippet-RN1MTdfk.js","CodeSnippets-DKLPHxJA.js","Page-BAvA99GL.js","getPastedJson-bz0M41mU.js","icon-CsmhpPrv.js","MethodPill-CNGsVE77.js","DuplicateIcon-DilfU_Z2.js","createIcon-BdsYzQck.js","DynamicMarkdown-CbqEDjbV.js","SectionHeading-O6hXpFCN.js","axios-vUo_bRtp.js","Markdown-nKm-uidQ.js","clsx-ClVdStUn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CIQkMg3R.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ImrFS4Fy.js"]}