Returns a list of your subscriptions, most recent first. Optionally filter by customer or
status. Use expand (or expand_customer) to inline related objects such as the
customer, latest invoice, item prices, or applied discounts.
A cursor for use in pagination. starting_after is a subscription ID that defines your place in the list. For instance, if you make a list request and receive 20 subscriptions, ending with fsub_xyz, your subsequent call can include starting_after=fsub_xyz to fetch the next page.
A cursor for use in pagination. ending_before is a subscription ID that defines your place in the list. For instance, if you make a list request and receive 20 subscriptions, starting with fsub_abc, your subsequent call can include ending_before=fsub_abc to fetch the previous page.
Comma-separated list of related objects to expand in the response.
Supported keys: customer; latest_invoice (alias invoice); payment_method; backup_payment_method; price (alias product); and discounts. Combine discounts with coupons (expand=discounts,coupons) to hydrate each discount's nested source.coupon into a full object instead of a bare ID.
Unrecognized keys are ignored rather than rejected: a misspelled or guessed key (e.g. coupon) returns the same response as no expand at all, with no error.
Response
An envelope wrapping a list of subscription objects.
An envelope wrapping a list of subscription objects.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Flex Documentation","colors":{"primary":"#0070FA","light":"#BAB3FF","dark":"#0B0077"},"logo":{"light":"https://mintcdn.com/flex-87/1kILreF5HcjIKLdi/logo/light.svg?fit=max\u0026auto=format\u0026n=1kILreF5HcjIKLdi\u0026q=85\u0026s=f703a75bc80df014f4849a7225b4879f","dark":"https://mintcdn.com/flex-87/1kILreF5HcjIKLdi/logo/dark.svg?fit=max\u0026auto=format\u0026n=1kILreF5HcjIKLdi\u0026q=85\u0026s=1aabf14d790c002d1740276fdbced9ab"},"favicon":"https://mintcdn.com/flex-87/liG_HQMgKKwndFp8/favicon.svg?fit=max\u0026auto=format\u0026n=liG_HQMgKKwndFp8\u0026q=85\u0026s=82a2993b4fffbf19268067f48e898bed","navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.withflex.com/"}},"footer":{"socials":{"github":"https://github.com/JoinFlexHealth","linkedin":"https://www.linkedin.com/company/withflex","x":"https://x.com/paywithflex","instagram":"https://www.instagram.com/paywithflex"}},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","latex":true},"navigation":{"global":{"anchors":[{"anchor":"Status","icon":"wifi","href":"https://statuspage.incident.io/with-flex"},{"anchor":"Support","icon":"mail","href":"mailto:support@withflex.com"},{"anchor":"Website","icon":"laptop","href":"https://www.withflex.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"flex-87","hasAudioNarration":false,"actualSubdomain":"flex-87","customDomains":["docs.withflex.com"],"gitSource":{"type":"github","owner":"joinflexhealth","repo":"flex","deployBranch":"main","contentDirectory":"flex-docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae374b5b3f002741c1ab41f","collectionId":"02d9944d-fd1b-4f89-a595-9c3890413440","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae374b5b3f002741c1ab41f"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae3cfd39c57ecccbea1d926","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API Reference","count":188},{"language":"default","tag":"Guides","count":51},{"language":"default","tag":"Integration","count":29},{"language":"default","tag":"Marketing","count":21},{"language":"default","tag":"Checkout Sessions","count":13},{"language":"default","tag":"Subscriptions","count":12},{"language":"default","tag":"Products","count":9},{"language":"default","tag":"Disputes","count":8},{"language":"default","tag":"Shopify","count":7},{"language":"default","tag":"Overview","count":7}]},"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":"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":"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":"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":[{"filePath":"style.css","content":"#topbar-cta-button span.bg-primary-dark{background-color:#0b0077!important}html.dark #topbar-cta-button span.bg-primary-dark{background-color:#bab3ff1a!important;border-color:#bab3ff;border-width:1px}.content img,[data-content] img,article img,main img{border:1px solid #e8eaed!important}.content img.rounded,[data-content] img.rounded,article img.rounded,main img.rounded{border:.5px solid #e8eaed!important}.brand-logo-grid img,.doc-screenshot img,.nav-logo,img.nav-logo,img.no-border{border:0!important}.dark .nav-anchor:hover .mr-4.rounded-md.p-1.shadow-sm,.nav-anchor:hover .mr-4.rounded-md.p-1.shadow-sm{--tw-ring-opacity:1!important;--tw-ring-offset-shadow:var(--tw-ring-inset) 0 0 0 var(--tw-ring-offset-width) var(--tw-ring-offset-color)!important;--tw-ring-shadow:var(--tw-ring-inset) 0 0 0 calc(1px + var(--tw-ring-offset-width)) var(--tw-ring-color)!important;box-shadow:var(--tw-ring-offset-shadow),var(--tw-ring-shadow),var(--tw-shadow)!important;filter:none!important}.nav-anchor:hover .mr-4.rounded-md.p-1.shadow-sm{background:rgba(17,24,39,.05)!important;background-color:rgba(17,24,39,.05)!important;color:#1f2937!important}.dark .nav-anchor:hover .mr-4.rounded-md.p-1.shadow-sm{background:rgba(229,231,235,.05)!important;background-color:rgba(229,231,235,.05)!important;color:#d1d5db!important}.group:hover .group-hover\\:ring-0{--tw-ring-opacity:1!important;--tw-ring-color:rgba(17, 24, 39, 0.05)!important}.dark .group:hover .group-hover\\:ring-0{--tw-ring-opacity:1!important;--tw-ring-color:rgba(55, 65, 81, 0.4)!important}.nav-anchor:hover .secondary-opacity.group-hover\\:fill-primary-dark.group-hover\\:bg-white{background-color:currentColor!important;fill:none!important}.nav-anchor:hover .secondary-opacity{background-color:#1f2937!important}.dark .nav-anchor:hover .secondary-opacity{background-color:#d1d5db!important}.nav-anchor .mr-4.rounded-md.p-1.shadow-sm[style*=background]{background:inherit!important;background-color:inherit!important}.nav-anchor:hover .mr-4.rounded-md.p-1.shadow-sm[style*=background]{background:rgba(17,24,39,.05)!important;background-color:rgba(17,24,39,.05)!important}.dark .nav-anchor:hover .mr-4.rounded-md.p-1.shadow-sm[style*=background]{background:rgba(229,231,235,.05)!important;background-color:rgba(229,231,235,.05)!important}.nav-anchor:hover .h-4.w-4.secondary-opacity{background-color:currentColor!important}.inline-flex.items-center.gap-1\\.5.text-sm.text-gray-500 a{color:#0070fa!important}.inline-flex.items-center.gap-1\\.5.text-sm.text-gray-500 a:hover{color:#0b0077!important}html.dark .inline-flex.items-center.gap-1\\.5.text-sm a{color:#bab3ff!important}html.dark .inline-flex.items-center.gap-1\\.5.text-sm a:hover{color:#fff!important}.lucide.lucide-chevron-right{stroke:#0070fa!important}html.dark .lucide.lucide-chevron-right{stroke:#bab3ff!important}"}],"page":{"pagePath":"api-reference/subscriptions/list-subscriptions","slug":"/api-reference/subscriptions/list-subscriptions","pageMetadata":{"title":"List Subscriptions","description":"Returns a list of your subscriptions, most recent first. Optionally filter by customer or\nstatus. Use `expand` (or `expand_customer`) to inline related objects such as the\ncustomer, latest invoice, item prices, or applied discounts.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/subscriptions","href":"/api-reference/subscriptions/list-subscriptions","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Returns a list of your subscriptions, most recent first. Optionally filter by customer or\\nstatus. Use \", _jsx(_components.code, {\n children: \"expand\"\n }), \" (or \", _jsx(_components.code, {\n children: \"expand_customer\"\n }), \") to inline related objects such as the\\ncustomer, latest invoice, item prices, or applied discounts.\"]\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":"List Subscriptions","description":"Returns a list of your subscriptions, most recent first. Optionally filter by customer or\nstatus. Use `expand` (or `expand_customer`) to inline related objects such as the\ncustomer, latest invoice, item prices, or applied discounts.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/subscriptions","href":"/api-reference/subscriptions/list-subscriptions","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/flex-87/f0156321fafa1974/postcss.config.js"],"openApiReferenceData":{"operation":{"tags":["Subscriptions"],"summary":"List Subscriptions","description":"Returns a list of your subscriptions, most recent first. Optionally filter by customer or\nstatus. Use `expand` (or `expand_customer`) to inline related objects such as the\ncustomer, latest invoice, item prices, or applied discounts.","operationId":"v1.subscriptions.list","parameters":["459222d5-5745-4ab1-b114-3f7d87e61e7a","ae42a959-65d6-4737-b7cd-e295d3e2a32b","622e73a9-3709-4b4b-88a6-ed891a4a0d12","582544b1-95ef-49fe-b2a5-ecb6e117ad8b","c4f174f9-5e4d-4fb3-8a59-e191cc2b3cb9","6ec7501f-c3ed-46d6-953d-7359bb9bdb5e","c831eba8-7b34-44c7-b565-01697dead1fd","e8388453-7ba5-42df-9dff-c9ae06f2fd08"],"responses":{"200":"99d4dacd-3992-4e94-8757-7c803bf780cd","401":"36daa2f4-0020-4757-a251-47c11e34a48e","403":"39b31a91-7b4a-4a21-9389-9d8f3a1581ff","404":"fc876a4f-0a44-4b7f-903f-dd513a7b35e9","409":"55d9e2cc-fbcb-4abe-8c97-0d132b59a395","422":"c9ce5c71-2be1-4c7a-95e3-bcb756e30df5","429":"d147e17f-3591-41b0-ae61-6400321f66c5"},"x-speakeasy-pagination":{"type":"cursor","inputs":[{"name":"starting_after","in":"parameters","type":"cursor"},{"name":"limit","in":"parameters","type":"limit"}],"outputs":{"nextCursor":"$[-1].id","results":"$"}},"method":"get","type":"path","servers":["080577c1-39a5-4498-bb49-d7daab803f21"],"security":["26834da7-2a24-4de5-b97c-6bf0af826119"],"path":"/v1/subscriptions","baseUrlOptions":["https://api.withflex.com"],"title":"List Subscriptions","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"459222d5-5745-4ab1-b114-3f7d87e61e7a":{"in":"query","name":"customer","description":"Filter by customer ID.","schema":{"oneOf":[{"description":"Filter by customer ID.","examples":["fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA"],"type":"string","uniqueKey":"oneOf.0","typeLabel":"string"},{"description":"Filter by customer ID.","examples":["fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA"],"type":"null","uniqueKey":"oneOf.1","typeLabel":"null"}],"uniqueKey":"","typeLabel":"string | null"},"style":"form","example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},"ae42a959-65d6-4737-b7cd-e295d3e2a32b":{"in":"query","name":"expand_customer","description":"If true, expands the customer object in the response.","schema":{"oneOf":[{"description":"If true, expands the customer object in the response.","examples":[false],"type":"boolean","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"description":"If true, expands the customer object in the response.","examples":[false],"type":"null","uniqueKey":"oneOf.1","typeLabel":"null"}],"uniqueKey":"","typeLabel":"boolean | null"},"style":"form","example":false},"622e73a9-3709-4b4b-88a6-ed891a4a0d12":{"in":"query","name":"starting_after","description":"A cursor for use in pagination. `starting_after` is a subscription ID that defines your place in the list. For instance, if you make a list request and receive 20 subscriptions, ending with `fsub_xyz`, your subsequent call can include `starting_after=fsub_xyz` to fetch the next page.","schema":{"oneOf":[{"description":"A cursor for use in pagination. `starting_after` is a subscription ID that defines your place in the list. For instance, if you make a list request and receive 20 subscriptions, ending with `fsub_xyz`, your subsequent call can include `starting_after=fsub_xyz` to fetch the next page.","examples":["fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA"],"type":"string","uniqueKey":"oneOf.0","typeLabel":"string"},{"description":"A cursor for use in pagination. `starting_after` is a subscription ID that defines your place in the list. For instance, if you make a list request and receive 20 subscriptions, ending with `fsub_xyz`, your subsequent call can include `starting_after=fsub_xyz` to fetch the next page.","examples":["fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA"],"type":"null","uniqueKey":"oneOf.1","typeLabel":"null"}],"uniqueKey":"","typeLabel":"string | null"},"style":"form","example":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},"582544b1-95ef-49fe-b2a5-ecb6e117ad8b":{"in":"query","name":"ending_before","description":"A cursor for use in pagination. `ending_before` is a subscription ID that defines your place in the list. For instance, if you make a list request and receive 20 subscriptions, starting with `fsub_abc`, your subsequent call can include `ending_before=fsub_abc` to fetch the previous page.","schema":{"oneOf":[{"description":"A cursor for use in pagination. `ending_before` is a subscription ID that defines your place in the list. For instance, if you make a list request and receive 20 subscriptions, starting with `fsub_abc`, your subsequent call can include `ending_before=fsub_abc` to fetch the previous page.","examples":["fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA"],"type":"string","uniqueKey":"oneOf.0","typeLabel":"string"},{"description":"A cursor for use in pagination. `ending_before` is a subscription ID that defines your place in the list. For instance, if you make a list request and receive 20 subscriptions, starting with `fsub_abc`, your subsequent call can include `ending_before=fsub_abc` to fetch the previous page.","examples":["fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA"],"type":"null","uniqueKey":"oneOf.1","typeLabel":"null"}],"uniqueKey":"","typeLabel":"string | null"},"style":"form","example":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},"c4f174f9-5e4d-4fb3-8a59-e191cc2b3cb9":{"in":"query","name":"status","description":"Filter by subscription status.","schema":{"oneOf":[{"type":"string","description":"Filter by subscription status.","enum":["incomplete","incomplete_expired","trialing","active","past_due","canceled","unpaid","paused"],"example":"incomplete","uniqueKey":"oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Filter by subscription status.","uniqueKey":"oneOf.1","typeLabel":"null"}],"uniqueKey":"","typeLabel":"enum\u003cstring> | null"},"style":"form"},"6ec7501f-c3ed-46d6-953d-7359bb9bdb5e":{"in":"query","name":"offset","description":"Number of objects to skip before returning results.","schema":{"oneOf":[{"description":"Number of objects to skip before returning results.","examples":[3],"type":"integer","format":"int32","minimum":0,"maximum":2147483647,"uniqueKey":"oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"Number of objects to skip before returning results.","examples":[3],"type":"null","format":"int32","minimum":0,"maximum":2147483647,"uniqueKey":"oneOf.1","typeLabel":"null"}],"uniqueKey":"","typeLabel":"integer\u003cint32> | null"},"style":"form","example":3},"c831eba8-7b34-44c7-b565-01697dead1fd":{"in":"query","name":"limit","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","schema":{"oneOf":[{"description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","examples":[10],"type":"integer","format":"int32","minimum":0,"maximum":2147483647,"uniqueKey":"oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","examples":[10],"type":"null","format":"int32","minimum":0,"maximum":2147483647,"uniqueKey":"oneOf.1","typeLabel":"null"}],"uniqueKey":"","typeLabel":"integer\u003cint32> | null"},"style":"form","example":10},"e8388453-7ba5-42df-9dff-c9ae06f2fd08":{"in":"query","name":"expand","description":"Comma-separated list of related objects to expand in the response.\n\nSupported keys: `customer`; `latest_invoice` (alias `invoice`); `payment_method`; `backup_payment_method`; `price` (alias `product`); and `discounts`. Combine `discounts` with `coupons` (`expand=discounts,coupons`) to hydrate each discount's nested `source.coupon` into a full object instead of a bare ID.\n\nUnrecognized keys are ignored rather than rejected: a misspelled or guessed key (e.g. `coupon`) returns the same response as no `expand` at all, with no error.","schema":{"description":"Comma-separated list of related objects to expand in the response.\n\nSupported keys: `customer`; `latest_invoice` (alias `invoice`); `payment_method`; `backup_payment_method`; `price` (alias `product`); and `discounts`. Combine `discounts` with `coupons` (`expand=discounts,coupons`) to hydrate each discount's nested `source.coupon` into a full object instead of a bare ID.\n\nUnrecognized keys are ignored rather than rejected: a misspelled or guessed key (e.g. `coupon`) returns the same response as no `expand` at all, with no error.","default":"","type":"string","uniqueKey":"","typeLabel":"string"},"style":"form"}},"responses":{"99d4dacd-3992-4e94-8757-7c803bf780cd":{"description":"An envelope wrapping a list of subscription objects.","content":{"application/json":{"schema":{"description":"An envelope wrapping a list of subscription objects.","type":"object","required":["subscriptions"],"properties":{"subscriptions":{"description":"The list of subscriptions.","type":"array","items":{"description":"A Subscription represents a recurring billing arrangement that charges a customer at a fixed interval. It tracks the items being billed, the current billing period, its lifecycle status, and the invoices it generates each cycle.","type":"object","required":["cancel_at_period_end","created_at","items","status","subscription_id","test_mode"],"properties":{"subscription_id":{"description":"Unique identifier for the object.","type":"string","example":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].subscription_id","typeLabel":"string"},"created_at":{"description":"Time at which the object was created. ISO 8601 format.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].created_at","typeLabel":"string"},"items":{"description":"The items the customer is subscribed to.","type":"array","items":{"description":"A Subscription Item represents a single recurring Price billed as part of a Subscription, together with the quantity of that price the customer is subscribed to. A subscription has one item per recurring price it bills.","type":"object","required":["created_at","price","quantity","subscription_item_id","test_mode"],"properties":{"subscription_item_id":{"description":"Unique identifier for the subscription item.","type":"string","example":"fsubi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].subscription_item_id","typeLabel":"string"},"price":{"oneOf":[{"type":"string","description":"The recurring Price this item bills. Returned as a price ID by default, or as the full Price object when expanded.","example":"fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.0","typeLabel":"string"},{"type":"object","description":"The recurring Price this item bills. Returned as a price ID by default, or as the full Price object when expanded.","required":["active","created_at","price_id","product","test_mode","type","unit_amount"],"example":"fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"price_id":{"description":"The unique identifier for the price.","type":"string","example":"fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.price_id","typeLabel":"string"},"unit_amount":{"description":"The amount to charge per unit, in the smallest currency unit (e.g., `2500` = $25.00 USD).","type":"integer","format":"int32","minimum":-2147483648,"maximum":2147483647,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.unit_amount","typeLabel":"integer\u003cint32>"},"active":{"description":"Whether the price is currently active.","type":"boolean","example":false,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.active","typeLabel":"boolean"},"product":{"oneOf":[{"type":"string","description":"The product this price belongs to. Returned as a product ID by default, or as the full Product object when expanded.","example":"fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.0","typeLabel":"string"},{"type":"object","description":"The product this price belongs to. Returned as a product ID by default, or as the full Product object when expanded.","required":["active","created_at","hsa_fsa_eligibility","name","product_id","test_mode"],"example":"fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"product_id":{"description":"The unique identifier for the product.","type":"string","example":"fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.product_id","typeLabel":"string"},"name":{"description":"The name of the product.","type":"string","example":"Example","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.name","typeLabel":"string"},"created_at":{"description":"The date the product was created.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.created_at","typeLabel":"string"},"active":{"description":"Determines if the product is active or not.","type":"boolean","example":false,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.active","typeLabel":"boolean"},"hsa_fsa_eligibility":{"description":"The elegibility of the product for HSA/FSA.","type":"string","enum":["not_eligible","auto_substantiation","private_label","letter_of_medical_necessity","prescription","vision","service","pending"],"example":"not_eligible","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.hsa_fsa_eligibility","typeLabel":"enum\u003cstring>"},"test_mode":{"description":"Whether the product is in test mode or not.","type":"boolean","example":false,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.test_mode","typeLabel":"boolean"},"owner_partner_id":{"oneOf":[{"description":"The ID of the account that owns this product. For products shared across an organization this may be a sibling account; otherwise it is your own account ID.","type":"string","example":"facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.owner_partner_id.oneOf.0","typeLabel":"string"},{"description":"The ID of the account that owns this product. For products shared across an organization this may be a sibling account; otherwise it is your own account ID.","type":"null","example":"facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.owner_partner_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.owner_partner_id","typeLabel":"string | null"},"description":{"oneOf":[{"description":"The description of the product.","type":"string","example":"Premium SPF 50 mineral sunscreen","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.description.oneOf.0","typeLabel":"string"},{"description":"The description of the product.","type":"null","example":"Premium SPF 50 mineral sunscreen","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.description","typeLabel":"string | null"},"document_description":{"oneOf":[{"description":"Medical-grade description optimized for use in Letters of Medical Necessity and receipts.","deprecated":true,"type":"string","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.document_description.oneOf.0","typeLabel":"string"},{"description":"Medical-grade description optimized for use in Letters of Medical Necessity and receipts.","deprecated":true,"type":"null","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.document_description.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.document_description","typeLabel":"string | null"},"receipt_description":{"oneOf":[{"description":"Shortened description tailored to receipt line items","type":"string","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.receipt_description.oneOf.0","typeLabel":"string"},{"description":"Shortened description tailored to receipt line items","type":"null","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.receipt_description.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.receipt_description","typeLabel":"string | null"},"visit_type":{"oneOf":[{"type":"string","description":"The visit type of the product if a letter of medical necessity is required.","enum":["cbtSleep","notApplicable","metabolomics","tinnitus","gym","exerciseDiet","orthopedic","alcohol","airPurification","vaginalHealth","menstrual","canopy","alopecia","genate","weightBlanket","bedJet","siderAl","sunwinkPowder","wavWatch","bodyComplete","ageRate","nitrousOxide","happyV","groupChat","icalmAnxiety","redBloom","foodom","branchErgonomicFurniture","curalife","eloraInfantWellness","nutriHealth","olipop","goldIntimate","touchStoneEssentials","utiva","sleepGeekz","figBrew","auBabyBlanket","babySleepSack","oshWellness","currentBodyRedLight","mito","circularRing","lymaRedLight","goodAirRx","tastermonial","karunaHome","ergoStandingChair","jbaGlucoseControl","bloomNutrition","buoyDrops","luxeWonderWig","saunaMarketplace","amrioreEyewear","pivotOrthoShoe","lumenCynergy","roga","pulsetto","mitoRedLight","gutPersonal","goFlaus","myHixel","calmigo","dotFit","stripesBeauty","mixHers","pmd","positivityWithPurpose","techRing","popVeneers","vertaClean","lumen","medicalMeal","emnHealth","detergentAllergy","lowImpactExercise","mediumImpactExercise","highImpactExercise","gardening","babyCarrier","smartGlasses","automatedCleaner","uvClothing","adaptiveShoes","breathWork","nonenalOdor","meneralsNootropicPouch","babyMonitorSplit","babySleepApp","coolingSleepwear","bodyPillow","uvGlasses","nursingChairs","coolingBed","posture","supplements","sleep","redLightTherapy","fitness","smartRing","womensVaginalHealth","fertilitySupport","femaleReproduction","femaleReproductionFood","pregnancyLiterature","iceBath","orthopedicShoes","sexualHealth","glucose","metabolicTest","skinCare","oralHealth","oralAnxiety","blueLightGlasses","anxiety","brainHealth","babyMonitor","compressionSocks","compressionShorts","waterPurification","medSpa","essentialOils","sleepBuds","latchLight","nutritionist","rairflow","enduranceTraining","hydration","hairGrowth","eD","postureFitness","childDevelopment","adaptiveClothing","sleepConsulting","hairRemoval","menopause","maleFertility","anxietyHealth","bidets","speechHealth","artOfLiving","breastMilk","petSupport","diapers","gutSupplements","smartWatch","medicalBotox","biomechanicalAssessment","erectileReset","femaleOrgasm","pornAddiction","memorySupport","oralHealthMasticGum","orthopedicSandals","childDevelopmentAnxietySleep","childDevelopmentAdjustment","childDevelopmentBehavior","childDevelopmentIdentity","emnHealthMobility","adaptiveShoesDependent","speechHealthDependent","breathWorkDependent"],"example":"cbtSleep","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.visit_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The visit type of the product if a letter of medical necessity is required.","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.visit_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.visit_type","typeLabel":"enum\u003cstring> | null"},"upc_code":{"oneOf":[{"description":"The upc code of the product.","type":"string","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.upc_code.oneOf.0","typeLabel":"string"},{"description":"The upc code of the product.","type":"null","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.upc_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.upc_code","typeLabel":"string | null"},"gtin":{"oneOf":[{"description":"The gtin code of the product.","type":"string","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.gtin.oneOf.0","typeLabel":"string"},{"description":"The gtin code of the product.","type":"null","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.gtin.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.gtin","typeLabel":"string | null"},"reference_gtin":{"oneOf":[{"description":"The GTIN of a private-label reference product, used to establish HSA/FSA eligibility.","type":"string","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.reference_gtin.oneOf.0","typeLabel":"string"},{"description":"The GTIN of a private-label reference product, used to establish HSA/FSA eligibility.","type":"null","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.reference_gtin.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.reference_gtin","typeLabel":"string | null"},"metadata":{"oneOf":[{"description":"Metadata associated with the product.","type":"object","additionalProperties":{"type":"string","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.metadata.oneOf.0.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.metadata.oneOf.0","typeLabel":"object"},{"description":"Metadata associated with the product.","type":"null","additionalProperties":{"type":"string","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.metadata.oneOf.1.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.metadata","typeLabel":"object | null"},"url":{"oneOf":[{"description":"The URL of the product.","type":"string","example":"https://example.com","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.url.oneOf.0","typeLabel":"string"},{"description":"The URL of the product.","type":"null","example":"https://example.com","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.url","typeLabel":"string | null"},"client_reference_id":{"oneOf":[{"description":"An optional identifier for the product set by the client at creation time. Immutable after creation.","type":"string","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.client_reference_id.oneOf.0","typeLabel":"string"},{"description":"An optional identifier for the product set by the client at creation time. Immutable after creation.","type":"null","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.client_reference_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1.client_reference_id","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.product","typeLabel":"string | object"},"created_at":{"description":"The date the price was created.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.created_at","typeLabel":"string"},"type":{"description":"The type of the price: a single one-time charge, or a recurring charge billed on a schedule.","type":"string","enum":["one_time","recurring"],"example":"one_time","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.type","typeLabel":"enum\u003cstring>"},"test_mode":{"description":"Whether the price is in test mode.","type":"boolean","example":false,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.test_mode","typeLabel":"boolean"},"owner_partner_id":{"oneOf":[{"description":"The ID of the account that owns this price. For prices shared across an organization this may be a sibling account; otherwise it is your own account ID.","type":"string","example":"facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.owner_partner_id.oneOf.0","typeLabel":"string"},{"description":"The ID of the account that owns this price. For prices shared across an organization this may be a sibling account; otherwise it is your own account ID.","type":"null","example":"facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.owner_partner_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.owner_partner_id","typeLabel":"string | null"},"description":{"oneOf":[{"description":"The description of the price.","type":"string","example":"Premium SPF 50 mineral sunscreen","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.description.oneOf.0","typeLabel":"string"},{"description":"The description of the price.","type":"null","example":"Premium SPF 50 mineral sunscreen","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.description","typeLabel":"string | null"},"trial_period_days":{"oneOf":[{"description":"The number of trial period days before the customer is first charged for a recurring price.","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.trial_period_days.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"The number of trial period days before the customer is first charged for a recurring price.","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.trial_period_days.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.trial_period_days","typeLabel":"integer\u003cint32> | null"},"recurring":{"oneOf":[{"type":"object","description":"The recurring components of a price such as interval and trial period days.","required":["interval"],"example":{"interval":"day","interval_count":0,"trial_period_days":0},"properties":{"interval":{"description":"The billing cadence for the price.","type":"string","enum":["day","week","month","year"],"example":"day","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.recurring.oneOf.0.interval","typeLabel":"enum\u003cstring>"},"interval_count":{"oneOf":[{"description":"The number of intervals","type":"integer","format":"int64","minimum":0,"maximum":4294967295,"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.recurring.oneOf.0.interval_count.oneOf.0","typeLabel":"integer\u003cint64>"},{"description":"The number of intervals","type":"null","format":"int64","minimum":0,"maximum":4294967295,"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.recurring.oneOf.0.interval_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.recurring.oneOf.0.interval_count","typeLabel":"integer\u003cint64> | null"},"trial_period_days":{"oneOf":[{"description":"The number of trial period days before the customer is charged for the first time. Whole days only. For a precise trial-end timestamp (e.g. non-integer days), use `subscription_data.trial_end` on the Create Checkout Session request instead.","type":"integer","format":"int64","minimum":0,"maximum":4294967295,"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.recurring.oneOf.0.trial_period_days.oneOf.0","typeLabel":"integer\u003cint64>"},{"description":"The number of trial period days before the customer is charged for the first time. Whole days only. For a precise trial-end timestamp (e.g. non-integer days), use `subscription_data.trial_end` on the Create Checkout Session request instead.","type":"null","format":"int64","minimum":0,"maximum":4294967295,"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.recurring.oneOf.0.trial_period_days.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.recurring.oneOf.0.trial_period_days","typeLabel":"integer\u003cint64> | null"}},"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.recurring.oneOf.0","typeLabel":"object"},{"type":"null","description":"The recurring components of a price such as interval and trial period days.","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.recurring.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.recurring","typeLabel":"object | null"},"metadata":{"oneOf":[{"description":"Metadata information for the price object","type":"object","example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.metadata.oneOf.0","typeLabel":"object"},{"description":"Metadata information for the price object","type":"null","example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.metadata","typeLabel":"object | null"},"lookup_key":{"oneOf":[{"description":"A stable, partner-owned key for this price. Unique per account and mode across all prices, archived ones included. `null` until you set one.","type":"string","maxLength":200,"example":"standard_monthly","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.lookup_key.oneOf.0","typeLabel":"string"},{"description":"A stable, partner-owned key for this price. Unique per account and mode across all prices, archived ones included. `null` until you set one.","type":"null","maxLength":200,"example":"standard_monthly","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.lookup_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.lookup_key","typeLabel":"string | null"},"hsa_fsa_eligibility":{"oneOf":[{"type":"string","description":"The HSA/FSA eligibility for the price.","enum":["not_eligible","auto_substantiation","private_label","letter_of_medical_necessity","prescription","vision","service","pending"],"example":"not_eligible","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.hsa_fsa_eligibility.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The HSA/FSA eligibility for the price.","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.hsa_fsa_eligibility.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1.hsa_fsa_eligibility","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].price","typeLabel":"string | object"},"quantity":{"description":"The number of units of the price the customer is subscribed to.","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].quantity","typeLabel":"integer\u003cint32>"},"created_at":{"description":"Time at which the subscription item was created, as an RFC 3339 timestamp.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].created_at","typeLabel":"string"},"test_mode":{"description":"Whether the subscription item exists in test mode.","type":"boolean","example":false,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].test_mode","typeLabel":"boolean"},"updated_at":{"oneOf":[{"type":"string","description":"Time at which the subscription item was last updated, as an RFC 3339 timestamp. `null` if the item has not been updated since creation.","example":"2026-06-15T14:30:00Z","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].updated_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"Time at which the subscription item was last updated, as an RFC 3339 timestamp. `null` if the item has not been updated since creation.","example":"2026-06-15T14:30:00Z","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].updated_at","typeLabel":"string | null"}},"example":{"subscription_item_id":"fsubi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","price":"fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA","quantity":2500,"created_at":"2026-06-15T14:30:00Z","updated_at":"2026-06-15T14:30:00Z","test_mode":false},"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].\\items","typeLabel":"object[]"},"status":{"description":"Possible values are incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, or paused.","type":"string","enum":["incomplete","incomplete_expired","trialing","active","past_due","canceled","unpaid","paused"],"example":"incomplete","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"cancel_at_period_end":{"description":"If the subscription has been canceled with the at_period_end flag set to true, cancel_at_period_end on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period.","type":"boolean","example":false,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].cancel_at_period_end","typeLabel":"boolean"},"test_mode":{"description":"Whether the subscription is in test mode.","type":"boolean","example":false,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].test_mode","typeLabel":"boolean"},"latest_invoice":{"oneOf":[{"type":"string","description":"The ID of the latest invoice generated for this subscription.","example":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.0","typeLabel":"string"},{"type":"object","description":"The ID of the latest invoice generated for this subscription.","required":["amount_due","amount_paid","collection_method","created_at","invoice_id","status","test_mode","total"],"example":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"invoice_id":{"description":"The id of the invoice.","type":"string","example":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.invoice_id","typeLabel":"string"},"total":{"description":"The total amount of the invoice in cents.","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.total","typeLabel":"integer\u003cint32>"},"amount_due":{"description":"The amount due in cents.","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.amount_due","typeLabel":"integer\u003cint32>"},"amount_paid":{"description":"The amount paid in cents.","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.amount_paid","typeLabel":"integer\u003cint32>"},"status":{"description":"The status of the invoice.","type":"string","enum":["draft","open","void","paid","uncollectible"],"example":"draft","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.status","typeLabel":"enum\u003cstring>"},"collection_method":{"description":"Either charge_automatically or send_invoice. When charging automatically, Flex will attempt to pay this invoice using the default payment method attached to the customer. When sending an invoice, Flex will email this invoice to the customer with payment instructions.","type":"string","enum":["charge_automatically","send_invoice"],"example":"charge_automatically","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.collection_method","typeLabel":"enum\u003cstring>"},"test_mode":{"description":"Whether or not the invoice was created in test mode.","type":"boolean","example":false,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.test_mode","typeLabel":"boolean"},"created_at":{"description":"When the invoice was created.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.created_at","typeLabel":"string"},"payment_intent":{"oneOf":[{"type":"string","description":"The payment intent associated with this invoice. The payment intent is created when the invoice is finalized.","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.0","typeLabel":"string"},{"type":"object","description":"The payment intent associated with this invoice. The payment intent is created when the invoice is finalized.","required":["amount","capture_method","created_at","payment_intent_id","status","test_mode"],"example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"payment_intent_id":{"description":"The unique identifier for the payment intent.","type":"string","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_intent_id","typeLabel":"string"},"amount":{"description":"The amount of the payment intent in cents.","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.amount","typeLabel":"integer\u003cint32>"},"status":{"description":"The status of the payment intent.","type":"string","enum":["canceled","processing","requires_action","requires_capture","requires_confirmation","requires_payment_method","succeeded"],"example":"canceled","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.status","typeLabel":"enum\u003cstring>"},"created_at":{"description":"The time the payment intent was created.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.created_at","typeLabel":"string"},"capture_method":{"description":"The capture method of the payment intent.","type":"string","enum":["automatic","automatic_async","manual"],"example":"automatic","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.capture_method","typeLabel":"enum\u003cstring>"},"test_mode":{"description":"Whether the payment intent is in test mode.","type":"boolean","example":false,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.test_mode","typeLabel":"boolean"},"amount_capturable":{"oneOf":[{"description":"The amount that can be captured from this PaymentIntent.","type":"integer","format":"int32","maximum":2147483647,"example":2500,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.amount_capturable.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"The amount that can be captured from this PaymentIntent.","type":"null","format":"int32","maximum":2147483647,"example":2500,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.amount_capturable.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.amount_capturable","typeLabel":"integer\u003cint32> | null"},"amount_received":{"oneOf":[{"description":"The amount that was received in cents.","type":"integer","format":"int32","maximum":2147483647,"example":2500,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.amount_received.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"The amount that was received in cents.","type":"null","format":"int32","maximum":2147483647,"example":2500,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.amount_received.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.amount_received","typeLabel":"integer\u003cint32> | null"},"application_fee_amount":{"oneOf":[{"description":"The amount of the Flex application fee.","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.application_fee_amount.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"The amount of the Flex application fee.","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.application_fee_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.application_fee_amount","typeLabel":"integer\u003cint32> | null"},"customer":{"oneOf":[{"type":"string","description":"The customer associated with the payment intent.","example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.0","typeLabel":"string"},{"type":"object","description":"The customer associated with the payment intent.","required":["created_at","customer_id","email","first_name","last_name","test_mode"],"example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"customer_id":{"description":"The unique identifier for the customer.","type":"string","example":"fcus_01HACM7FZ1084XB1GB6053VM0D","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.customer_id","typeLabel":"string"},"first_name":{"description":"The customer's first name.","type":"string","example":"John","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.first_name","typeLabel":"string"},"last_name":{"description":"The customer's last name.","type":"string","example":"Doe","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.last_name","typeLabel":"string"},"email":{"description":"The customer's email address.","type":"string","example":"joh.doe@example.com","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.email","typeLabel":"string"},"created_at":{"description":"The time the customer was created.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.created_at","typeLabel":"string"},"test_mode":{"description":"Whether the customer was created in test mode.","type":"boolean","example":false,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.test_mode","typeLabel":"boolean"},"owner_partner_id":{"oneOf":[{"description":"The partner that owns this customer. When a customer is shared with you by another partner in your organization, this is that sibling partner; otherwise it is your own partner id.","type":"string","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.owner_partner_id.oneOf.0","typeLabel":"string"},{"description":"The partner that owns this customer. When a customer is shared with you by another partner in your organization, this is that sibling partner; otherwise it is your own partner id.","type":"null","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.owner_partner_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.owner_partner_id","typeLabel":"string | null"},"phone":{"oneOf":[{"description":"The customer's phone number.","type":"string","format":"phone","example":"+15555555555","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.phone.oneOf.0","typeLabel":"string\u003cphone>"},{"description":"The customer's phone number.","type":"null","format":"phone","example":"+15555555555","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.phone","typeLabel":"string\u003cphone> | null"},"employer":{"oneOf":[{"description":"The customer's employer.","type":"string","example":"Flex","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.employer.oneOf.0","typeLabel":"string"},{"description":"The customer's employer.","type":"null","example":"Flex","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.employer.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.employer","typeLabel":"string | null"},"shipping":{"oneOf":[{"type":"object","description":"The customer's shipping address.","required":["shipping_address_id"],"example":{"shipping_address_id":"fsh_01J9XR8M3K7VZ8N2YB4WJ6T0RA","line1":"123 Main St","line2":"Suite 100","city":"San Francisco","state":"CA","postal_code":"94107","country":"US"},"properties":{"shipping_address_id":{"description":"Unique identifier for the shipping address.","type":"string","example":"fsh_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.shipping.oneOf.0.shipping_address_id","typeLabel":"string"},"line1":{"oneOf":[{"description":"The first line of the street address (e.g., street number and name).","type":"string","example":"123 Main St","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.shipping.oneOf.0.line1.oneOf.0","typeLabel":"string"},{"description":"The first line of the street address (e.g., street number and name).","type":"null","example":"123 Main St","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.shipping.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.shipping.oneOf.0.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"description":"The second line of the street address (e.g., apartment, suite, or unit).","type":"string","example":"Suite 100","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.shipping.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"description":"The second line of the street address (e.g., apartment, suite, or unit).","type":"null","example":"Suite 100","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.shipping.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.shipping.oneOf.0.line2","typeLabel":"string | null"},"city":{"oneOf":[{"description":"City, district, suburb, town, or village.","type":"string","example":"San Francisco","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.shipping.oneOf.0.city.oneOf.0","typeLabel":"string"},{"description":"City, district, suburb, town, or village.","type":"null","example":"San Francisco","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.shipping.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.shipping.oneOf.0.city","typeLabel":"string | null"},"state":{"oneOf":[{"description":"State, county, province, or region.","type":"string","example":"CA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.shipping.oneOf.0.state.oneOf.0","typeLabel":"string"},{"description":"State, county, province, or region.","type":"null","example":"CA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.shipping.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.shipping.oneOf.0.state","typeLabel":"string | null"},"postal_code":{"oneOf":[{"description":"ZIP or postal code.","type":"string","example":"94107","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.shipping.oneOf.0.postal_code.oneOf.0","typeLabel":"string"},{"description":"ZIP or postal code.","type":"null","example":"94107","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.shipping.oneOf.0.postal_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.shipping.oneOf.0.postal_code","typeLabel":"string | null"},"country":{"oneOf":[{"description":"Two-letter country code (ISO 3166-1 alpha-2, e.g., `US`).","type":"string","example":"US","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.shipping.oneOf.0.country.oneOf.0","typeLabel":"string"},{"description":"Two-letter country code (ISO 3166-1 alpha-2, e.g., `US`).","type":"null","example":"US","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.shipping.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.shipping.oneOf.0.country","typeLabel":"string | null"}},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.shipping.oneOf.0","typeLabel":"object"},{"type":"null","description":"The customer's shipping address.","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.shipping.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.shipping","typeLabel":"object | null"},"metadata":{"oneOf":[{"description":"Metadata associated with the customer.","type":"object","additionalProperties":{"type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.metadata.oneOf.0.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.metadata.oneOf.0","typeLabel":"object"},{"description":"Metadata associated with the customer.","type":"null","additionalProperties":{"type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.metadata.oneOf.1.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1.metadata","typeLabel":"object | null"}},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.1","typeLabel":"object"},{"type":"null","description":"The customer associated with the payment intent.","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer.oneOf.2","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.customer","typeLabel":"string | object | null"},"transfer_data":{"oneOf":[{"type":"object","description":"The data related to the amount being transferred.","required":["destination"],"example":{"amount":2500,"destination":"facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},"properties":{"destination":{"description":"The destination account of the transfer.","type":"string","example":"facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.transfer_data.oneOf.0.destination","typeLabel":"string"},"amount":{"oneOf":[{"description":"The amount to transfer, in cents.","type":"integer","format":"int32","maximum":2147483647,"example":2500,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.transfer_data.oneOf.0.amount.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"The amount to transfer, in cents.","type":"null","format":"int32","maximum":2147483647,"example":2500,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.transfer_data.oneOf.0.amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.transfer_data.oneOf.0.amount","typeLabel":"integer\u003cint32> | null"}},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.transfer_data.oneOf.0","typeLabel":"object"},{"type":"null","description":"The data related to the amount being transferred.","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.transfer_data.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.transfer_data","typeLabel":"object | null"},"latest_charge":{"oneOf":[{"type":"string","description":"The latest charge associated with the payment intent.","example":"fch_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.0","typeLabel":"string"},{"type":"object","description":"The latest charge associated with the payment intent.","required":["amount","amount_captured","amount_refunded","captured","charge_id","created_at","disputed","paid","payment_intent","refunded","status","test_mode"],"example":"fch_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"charge_id":{"description":"Unique identifier for the charge.","type":"string","example":"fch_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.charge_id","typeLabel":"string"},"amount":{"description":"Amount intended to be collected by this payment.","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.amount","typeLabel":"integer\u003cint32>"},"amount_captured":{"description":"Amount in cents captured (can be less than the amount attribute on the charge if a partial capture was made).","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.amount_captured","typeLabel":"integer\u003cint32>"},"amount_refunded":{"description":"Amount in cents refunded (can be less than the amount attribute on the charge if a partial refund was made).","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.amount_refunded","typeLabel":"integer\u003cint32>"},"captured":{"description":"If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured.","type":"boolean","example":false,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.captured","typeLabel":"boolean"},"created_at":{"description":"Time at which the object was created. ISO 8601 format.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.created_at","typeLabel":"string"},"disputed":{"description":"Whether the charge has been disputed.","type":"boolean","example":false,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.disputed","typeLabel":"boolean"},"paid":{"description":"true if the charge succeeded, or was successfully authorized for later capture.","type":"boolean","example":false,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.paid","typeLabel":"boolean"},"refunded":{"description":"Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.","type":"boolean","example":false,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunded","typeLabel":"boolean"},"payment_intent":{"$circularRef":"8fbcacc5-2464-4789-9a44-67dbaef1711b","description":"The payment intent that generated this charge.","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.payment_intent","typeLabel":"any"},"status":{"description":"The status of the charge.","type":"string","enum":["succeeded","pending","failed"],"example":"succeeded","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.status","typeLabel":"enum\u003cstring>"},"test_mode":{"description":"Whether the charge was created in test mode.","type":"boolean","example":false,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.test_mode","typeLabel":"boolean"},"application_fee_amount":{"oneOf":[{"description":"The Flex application fee for the charge","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.application_fee_amount.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"The Flex application fee for the charge","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.application_fee_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.application_fee_amount","typeLabel":"integer\u003cint32> | null"},"customer":{"oneOf":[{"type":"string","description":"The customer this charge is for if one exists.","example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.0","typeLabel":"string"},{"type":"object","description":"The customer this charge is for if one exists.","required":["created_at","customer_id","email","first_name","last_name","test_mode"],"example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"customer_id":{"description":"The unique identifier for the customer.","type":"string","example":"fcus_01HACM7FZ1084XB1GB6053VM0D","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.customer_id","typeLabel":"string"},"first_name":{"description":"The customer's first name.","type":"string","example":"John","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.first_name","typeLabel":"string"},"last_name":{"description":"The customer's last name.","type":"string","example":"Doe","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.last_name","typeLabel":"string"},"email":{"description":"The customer's email address.","type":"string","example":"joh.doe@example.com","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.email","typeLabel":"string"},"created_at":{"description":"The time the customer was created.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.created_at","typeLabel":"string"},"test_mode":{"description":"Whether the customer was created in test mode.","type":"boolean","example":false,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.test_mode","typeLabel":"boolean"},"owner_partner_id":{"oneOf":[{"description":"The partner that owns this customer. When a customer is shared with you by another partner in your organization, this is that sibling partner; otherwise it is your own partner id.","type":"string","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.owner_partner_id.oneOf.0","typeLabel":"string"},{"description":"The partner that owns this customer. When a customer is shared with you by another partner in your organization, this is that sibling partner; otherwise it is your own partner id.","type":"null","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.owner_partner_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.owner_partner_id","typeLabel":"string | null"},"phone":{"oneOf":[{"description":"The customer's phone number.","type":"string","format":"phone","example":"+15555555555","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.phone.oneOf.0","typeLabel":"string\u003cphone>"},{"description":"The customer's phone number.","type":"null","format":"phone","example":"+15555555555","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.phone","typeLabel":"string\u003cphone> | null"},"employer":{"oneOf":[{"description":"The customer's employer.","type":"string","example":"Flex","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.employer.oneOf.0","typeLabel":"string"},{"description":"The customer's employer.","type":"null","example":"Flex","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.employer.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.employer","typeLabel":"string | null"},"shipping":{"oneOf":[{"type":"object","description":"The customer's shipping address.","required":["shipping_address_id"],"example":{"shipping_address_id":"fsh_01J9XR8M3K7VZ8N2YB4WJ6T0RA","line1":"123 Main St","line2":"Suite 100","city":"San Francisco","state":"CA","postal_code":"94107","country":"US"},"properties":{"shipping_address_id":{"description":"Unique identifier for the shipping address.","type":"string","example":"fsh_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.shipping.oneOf.0.shipping_address_id","typeLabel":"string"},"line1":{"oneOf":[{"description":"The first line of the street address (e.g., street number and name).","type":"string","example":"123 Main St","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.shipping.oneOf.0.line1.oneOf.0","typeLabel":"string"},{"description":"The first line of the street address (e.g., street number and name).","type":"null","example":"123 Main St","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.shipping.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.shipping.oneOf.0.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"description":"The second line of the street address (e.g., apartment, suite, or unit).","type":"string","example":"Suite 100","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.shipping.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"description":"The second line of the street address (e.g., apartment, suite, or unit).","type":"null","example":"Suite 100","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.shipping.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.shipping.oneOf.0.line2","typeLabel":"string | null"},"city":{"oneOf":[{"description":"City, district, suburb, town, or village.","type":"string","example":"San Francisco","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.shipping.oneOf.0.city.oneOf.0","typeLabel":"string"},{"description":"City, district, suburb, town, or village.","type":"null","example":"San Francisco","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.shipping.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.shipping.oneOf.0.city","typeLabel":"string | null"},"state":{"oneOf":[{"description":"State, county, province, or region.","type":"string","example":"CA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.shipping.oneOf.0.state.oneOf.0","typeLabel":"string"},{"description":"State, county, province, or region.","type":"null","example":"CA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.shipping.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.shipping.oneOf.0.state","typeLabel":"string | null"},"postal_code":{"oneOf":[{"description":"ZIP or postal code.","type":"string","example":"94107","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.shipping.oneOf.0.postal_code.oneOf.0","typeLabel":"string"},{"description":"ZIP or postal code.","type":"null","example":"94107","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.shipping.oneOf.0.postal_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.shipping.oneOf.0.postal_code","typeLabel":"string | null"},"country":{"oneOf":[{"description":"Two-letter country code (ISO 3166-1 alpha-2, e.g., `US`).","type":"string","example":"US","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.shipping.oneOf.0.country.oneOf.0","typeLabel":"string"},{"description":"Two-letter country code (ISO 3166-1 alpha-2, e.g., `US`).","type":"null","example":"US","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.shipping.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.shipping.oneOf.0.country","typeLabel":"string | null"}},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.shipping.oneOf.0","typeLabel":"object"},{"type":"null","description":"The customer's shipping address.","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.shipping.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.shipping","typeLabel":"object | null"},"metadata":{"oneOf":[{"description":"Metadata associated with the customer.","type":"object","additionalProperties":{"type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.metadata.oneOf.0.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.metadata.oneOf.0","typeLabel":"object"},{"description":"Metadata associated with the customer.","type":"null","additionalProperties":{"type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.metadata.oneOf.1.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1.metadata","typeLabel":"object | null"}},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.1","typeLabel":"object"},{"type":"null","description":"The customer this charge is for if one exists.","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer.oneOf.2","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.customer","typeLabel":"string | object | null"},"invoice":{"oneOf":[{"description":"The invoice this charge is for if one exists.","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.invoice.oneOf.0","typeLabel":"any"},{"type":"null","description":"The invoice this charge is for if one exists.","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.invoice.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.invoice","typeLabel":"any | null"},"failure_message":{"oneOf":[{"description":"Message to user further explaining reason for charge failure if available.","type":"string","example":"Premium SPF 50 mineral sunscreen","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_message.oneOf.0","typeLabel":"string"},{"description":"Message to user further explaining reason for charge failure if available.","type":"null","example":"Premium SPF 50 mineral sunscreen","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_message","typeLabel":"string | null"},"refunds":{"oneOf":[{"description":"A list of refunds that have been applied to the charge.","type":"array","items":{"oneOf":[{"type":"string","description":"An expandable field — either a string ID or an expanded Refund object.","example":"fre_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"object","description":"An expandable field — either a string ID or an expanded Refund object.","required":["amount","created_at","refund_id","status","test_mode"],"example":"fre_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"refund_id":{"description":"The ID of the refund","type":"string","example":"fre_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.refund_id","typeLabel":"string"},"amount":{"description":"The amount of the refund in cents","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.amount","typeLabel":"integer\u003cint32>"},"created_at":{"description":"The time at which the refund was created. ISO 8601 format.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.created_at","typeLabel":"string"},"status":{"description":"The status of the refund","type":"string","enum":["pending","requires_action","succeeded","failed","canceled"],"example":"pending","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.status","typeLabel":"enum\u003cstring>"},"test_mode":{"description":"Whether the refund was created in test mode","type":"boolean","example":false,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.test_mode","typeLabel":"boolean"},"payment_intent_id":{"oneOf":[{"description":"The ID of the payment intent that the refund is associated with","type":"string","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.payment_intent_id.oneOf.0","typeLabel":"string"},{"description":"The ID of the payment intent that the refund is associated with","type":"null","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.payment_intent_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.payment_intent_id","typeLabel":"string | null"},"reason":{"oneOf":[{"type":"string","description":"The reason for the refund","enum":["duplicate","fraudulent","requested_by_customer","expired_uncaptured_charge"],"example":"duplicate","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The reason for the refund","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.reason","typeLabel":"enum\u003cstring> | null"},"metadata":{"oneOf":[{"description":"Metadata attached to the refund","type":"object","additionalProperties":{"type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.metadata.oneOf.0.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.metadata.oneOf.0","typeLabel":"object"},{"description":"Metadata attached to the refund","type":"null","additionalProperties":{"type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.metadata.oneOf.1.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.metadata","typeLabel":"object | null"},"reference_id":{"oneOf":[{"description":"Reference number that the customer can use to trace this refund with their bank or card issuer.","type":"string","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.reference_id.oneOf.0","typeLabel":"string"},{"description":"Reference number that the customer can use to trace this refund with their bank or card issuer.","type":"null","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.reference_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.reference_id","typeLabel":"string | null"},"reference_type":{"oneOf":[{"type":"string","description":"Type of the reference number used for the refund","enum":["acquirer_reference_number","system_trace_audit_number","retrieval_reference_number"],"example":"acquirer_reference_number","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.reference_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Type of the reference number used for the refund","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.reference_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.reference_type","typeLabel":"enum\u003cstring> | null"},"reference_status":{"oneOf":[{"type":"string","description":"Status of the reference number used for the refund","enum":["available","pending","unavailable"],"example":"available","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.reference_status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Status of the reference number used for the refund","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.reference_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.reference_status","typeLabel":"enum\u003cstring> | null"},"items":{"description":"List of refund items (charges that were refunded)","default":[],"type":"array","items":{"description":"Represents a single refund item (charge that was refunded)","type":"object","required":["amount_refunded"],"properties":{"amount_refunded":{"description":"The amount refunded from this charge in cents","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.\\items.items.[INDEX].amount_refunded","typeLabel":"integer\u003cint32>"},"payment_intent":{"oneOf":[{"description":"The ID of the payment intent that the refund is associated with","type":"string","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.\\items.items.[INDEX].payment_intent.oneOf.0","typeLabel":"string"},{"description":"The ID of the payment intent that the refund is associated with","type":"null","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.\\items.items.[INDEX].payment_intent.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.\\items.items.[INDEX].payment_intent","typeLabel":"string | null"},"payment_method_id":{"oneOf":[{"description":"The ID of the payment method used for this refund","type":"string","example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.\\items.items.[INDEX].payment_method_id.oneOf.0","typeLabel":"string"},{"description":"The ID of the payment method used for this refund","type":"null","example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.\\items.items.[INDEX].payment_method_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.\\items.items.[INDEX].payment_method_id","typeLabel":"string | null"},"reference_id":{"oneOf":[{"description":"Reference number that the customer can use to trace this refund with their bank or card issuer.","type":"string","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.\\items.items.[INDEX].reference_id.oneOf.0","typeLabel":"string"},{"description":"Reference number that the customer can use to trace this refund with their bank or card issuer.","type":"null","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.\\items.items.[INDEX].reference_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.\\items.items.[INDEX].reference_id","typeLabel":"string | null"},"reference_type":{"oneOf":[{"type":"string","description":"Type of the reference number used for the refund","enum":["acquirer_reference_number","system_trace_audit_number","retrieval_reference_number"],"example":"acquirer_reference_number","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.\\items.items.[INDEX].reference_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Type of the reference number used for the refund","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.\\items.items.[INDEX].reference_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.\\items.items.[INDEX].reference_type","typeLabel":"enum\u003cstring> | null"},"reference_status":{"oneOf":[{"type":"string","description":"Status of the reference number used for the refund","enum":["available","pending","unavailable"],"example":"available","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.\\items.items.[INDEX].reference_status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Status of the reference number used for the refund","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.\\items.items.[INDEX].reference_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.\\items.items.[INDEX].reference_status","typeLabel":"enum\u003cstring> | null"}},"example":{"amount_refunded":2500,"payment_intent":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","payment_method_id":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA","reference_id":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","reference_type":"acquirer_reference_number","reference_status":"available"},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.\\items.items.[INDEX]","typeLabel":"object"},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.\\items","typeLabel":"object[]"},"subscription_id":{"oneOf":[{"description":"The subscription this refund is associated with (for subscription cancellation refunds)","type":"string","example":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.subscription_id.oneOf.0","typeLabel":"string"},{"description":"The subscription this refund is associated with (for subscription cancellation refunds)","type":"null","example":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.subscription_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.subscription_id","typeLabel":"string | null"},"invoice_id":{"oneOf":[{"description":"The invoice this refund is associated with (for subscription billing period refunds)","type":"string","example":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.invoice_id.oneOf.0","typeLabel":"string"},{"description":"The invoice this refund is associated with (for subscription billing period refunds)","type":"null","example":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.invoice_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.invoice_id","typeLabel":"string | null"},"balance_transaction":{"oneOf":[{"type":"string","description":"Balance transaction that describes the impact of this refund on your balance. Defaults to the balance transaction ID; use `?expand=balance_transaction` to inflate the full object.","example":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.0","typeLabel":"string"},{"type":"object","description":"Balance transaction that describes the impact of this refund on your balance. Defaults to the balance transaction ID; use `?expand=balance_transaction` to inflate the full object.","required":["amount","balance_transaction_id","fee","net","status","test_mode"],"example":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"balance_transaction_id":{"description":"Unique identifier for the balance transaction, prefixed with `fbtxn_`.","type":"string","example":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.balance_transaction_id","typeLabel":"string"},"amount":{"description":"Gross amount of the transaction, in the smallest currency unit (e.g., `1000` = $10.00 USD). Positive for funds added to your balance (e.g., charges) and negative for funds removed (e.g., refunds, payouts, dispute debits).","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.amount","typeLabel":"integer\u003cint32>"},"fee":{"description":"Total processing fee deducted from `amount`, in the smallest currency unit (e.g., `30` = $0.30 USD). `0` when no fee applies.","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.fee","typeLabel":"integer\u003cint32>"},"net":{"description":"Net amount that affects your balance after `fee` is applied (`net = amount - fee`), in the smallest currency unit (e.g., `970` = $9.70 USD).","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.net","typeLabel":"integer\u003cint32>"},"status":{"type":"string","enum":["available","pending"],"x-ms-enum":{"name":"BalanceTransactionStatus","modelAsString":false,"values":[{"value":"available","name":"Available","description":"Funds have settled and are available to be paid out."},{"value":"pending","name":"Pending","description":"Funds are not yet available."}]},"description":"Availability status of the funds: `pending` (not yet available) or `available` (settled and withdrawable).","example":"available","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.status","typeLabel":"enum\u003cstring>"},"test_mode":{"description":"Whether this transaction was created in test mode. `true` for test-mode data, `false` for live data.","type":"boolean","example":false,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.test_mode","typeLabel":"boolean"},"available_on":{"oneOf":[{"type":"string","description":"When the funds become available in your bank account. RFC 3339 timestamp.","example":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.available_on.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the funds become available in your bank account. RFC 3339 timestamp.","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.available_on.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.available_on","typeLabel":"string | null"},"created_at":{"oneOf":[{"type":"string","description":"When the transaction was created. RFC 3339 timestamp.","example":"2026-06-15T14:30:00Z","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.created_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the transaction was created. RFC 3339 timestamp.","example":"2026-06-15T14:30:00Z","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.created_at","typeLabel":"string | null"},"exchange_rate":{"oneOf":[{"description":"The exchange rate applied if the transaction involved a currency conversion. `null` when no conversion took place.","type":"number","format":"double","example":1,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.exchange_rate.oneOf.0","typeLabel":"number\u003cdouble>"},{"description":"The exchange rate applied if the transaction involved a currency conversion. `null` when no conversion took place.","type":"null","format":"double","example":1,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.exchange_rate.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.exchange_rate","typeLabel":"number\u003cdouble> | null"},"reporting_category":{"oneOf":[{"description":"High-level accounting category for the transaction. `null` if not yet categorized.","type":"string","example":"example_value","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.reporting_category.oneOf.0","typeLabel":"string"},{"description":"High-level accounting category for the transaction. `null` if not yet categorized.","type":"null","example":"example_value","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.reporting_category.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.reporting_category","typeLabel":"string | null"},"checkout_session_id":{"oneOf":[{"description":"ID of the Checkout Session that originated this transaction, if it stems from a checkout.","type":"string","example":"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.checkout_session_id.oneOf.0","typeLabel":"string"},{"description":"ID of the Checkout Session that originated this transaction, if it stems from a checkout.","type":"null","example":"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.checkout_session_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.checkout_session_id","typeLabel":"string | null"},"client_reference_id":{"oneOf":[{"description":"Your own identifier for the originating object, carried over from the checkout session or payment.","type":"string","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.client_reference_id.oneOf.0","typeLabel":"string"},{"description":"Your own identifier for the originating object, carried over from the checkout session or payment.","type":"null","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.client_reference_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.client_reference_id","typeLabel":"string | null"},"source_id":{"oneOf":[{"description":"ID of the Flex object that produced this transaction (e.g., a Charge `fch_`, Refund `fre_`, or Payout `fpo_`). `null` if the source has not been resolved to a Flex object.","type":"string","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.source_id.oneOf.0","typeLabel":"string"},{"description":"ID of the Flex object that produced this transaction (e.g., a Charge `fch_`, Refund `fre_`, or Payout `fpo_`). `null` if the source has not been resolved to a Flex object.","type":"null","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.source_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.source_id","typeLabel":"string | null"},"type":{"oneOf":[{"description":"The type of transaction.","type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.type.oneOf.0","typeLabel":"string"},{"description":"The type of transaction.","type":"null","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.type","typeLabel":"string | null"},"flex_payment_intent_id":{"oneOf":[{"description":"ID of the Payment Intent associated with this transaction, if any. `null` for transactions not tied to a payment (e.g., payouts).","type":"string","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.flex_payment_intent_id.oneOf.0","typeLabel":"string"},{"description":"ID of the Payment Intent associated with this transaction, if any. `null` for transactions not tied to a payment (e.g., payouts).","type":"null","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.flex_payment_intent_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.flex_payment_intent_id","typeLabel":"string | null"},"mid":{"oneOf":[{"description":"Merchant identifier (MID) for the account that processed the transaction.","type":"string","example":"example_value","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.mid.oneOf.0","typeLabel":"string"},{"description":"Merchant identifier (MID) for the account that processed the transaction.","type":"null","example":"example_value","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.mid.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.mid","typeLabel":"string | null"},"currency":{"oneOf":[{"description":"Three-letter ISO currency code, in lowercase (e.g., `usd`).","type":"string","example":"usd","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.currency.oneOf.0","typeLabel":"string"},{"description":"Three-letter ISO currency code, in lowercase (e.g., `usd`).","type":"null","example":"usd","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.currency","typeLabel":"string | null"},"metadata":{"oneOf":[{"description":"Set of key-value pairs you can attach to the object for storing additional structured information.","type":"object","additionalProperties":{"type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.metadata.oneOf.0.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.metadata.oneOf.0","typeLabel":"object"},{"description":"Set of key-value pairs you can attach to the object for storing additional structured information.","type":"null","additionalProperties":{"type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.metadata.oneOf.1.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.metadata","typeLabel":"object | null"},"transaction_fee_amount":{"oneOf":[{"description":"Portion of `fee` attributable to standard transaction processing, in the smallest currency unit. `null` if not broken out.","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.transaction_fee_amount.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"Portion of `fee` attributable to standard transaction processing, in the smallest currency unit. `null` if not broken out.","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.transaction_fee_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.transaction_fee_amount","typeLabel":"integer\u003cint32> | null"},"interchange_fee_amount":{"oneOf":[{"description":"Portion of `fee` attributable to card-network interchange, in the smallest currency unit. `null` if not broken out.","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.interchange_fee_amount.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"Portion of `fee` attributable to card-network interchange, in the smallest currency unit. `null` if not broken out.","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.interchange_fee_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.interchange_fee_amount","typeLabel":"integer\u003cint32> | null"},"lmn_fee_amount":{"oneOf":[{"description":"Portion of `fee` attributable to Letter of Medical Necessity (LMN) processing, in the smallest currency unit. `null` if not applicable.","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.lmn_fee_amount.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"Portion of `fee` attributable to Letter of Medical Necessity (LMN) processing, in the smallest currency unit. `null` if not applicable.","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.lmn_fee_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.lmn_fee_amount","typeLabel":"integer\u003cint32> | null"},"dispute_fee_amount":{"oneOf":[{"description":"Portion of `fee` attributable to a dispute, in the smallest currency unit. `null` if not applicable.","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.dispute_fee_amount.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"Portion of `fee` attributable to a dispute, in the smallest currency unit. `null` if not applicable.","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.dispute_fee_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.dispute_fee_amount","typeLabel":"integer\u003cint32> | null"},"card_type":{"oneOf":[{"description":"Card funding type used for the transaction.","type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.card_type.oneOf.0","typeLabel":"string"},{"description":"Card funding type used for the transaction.","type":"null","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.card_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.card_type","typeLabel":"string | null"},"card_network":{"oneOf":[{"description":"Card network used for the transaction (e.g., `visa`, `mastercard`).","type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.card_network.oneOf.0","typeLabel":"string"},{"description":"Card network used for the transaction (e.g., `visa`, `mastercard`).","type":"null","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.card_network.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1.card_network","typeLabel":"string | null"}},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.1","typeLabel":"object"},{"type":"null","description":"Balance transaction that describes the impact of this refund on your balance. Defaults to the balance transaction ID; use `?expand=balance_transaction` to inflate the full object.","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction.oneOf.2","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.balance_transaction","typeLabel":"string | object | null"},"failure_balance_transaction":{"oneOf":[{"type":"string","description":"After a refund fails, the balance transaction describing the adjustment that returns the funds to your balance.","example":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.0","typeLabel":"string"},{"type":"object","description":"After a refund fails, the balance transaction describing the adjustment that returns the funds to your balance.","required":["amount","balance_transaction_id","fee","net","status","test_mode"],"example":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"balance_transaction_id":{"description":"Unique identifier for the balance transaction, prefixed with `fbtxn_`.","type":"string","example":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.balance_transaction_id","typeLabel":"string"},"amount":{"description":"Gross amount of the transaction, in the smallest currency unit (e.g., `1000` = $10.00 USD). Positive for funds added to your balance (e.g., charges) and negative for funds removed (e.g., refunds, payouts, dispute debits).","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.amount","typeLabel":"integer\u003cint32>"},"fee":{"description":"Total processing fee deducted from `amount`, in the smallest currency unit (e.g., `30` = $0.30 USD). `0` when no fee applies.","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.fee","typeLabel":"integer\u003cint32>"},"net":{"description":"Net amount that affects your balance after `fee` is applied (`net = amount - fee`), in the smallest currency unit (e.g., `970` = $9.70 USD).","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.net","typeLabel":"integer\u003cint32>"},"status":{"type":"string","enum":["available","pending"],"x-ms-enum":{"name":"BalanceTransactionStatus","modelAsString":false,"values":[{"value":"available","name":"Available","description":"Funds have settled and are available to be paid out."},{"value":"pending","name":"Pending","description":"Funds are not yet available."}]},"description":"Availability status of the funds: `pending` (not yet available) or `available` (settled and withdrawable).","example":"available","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.status","typeLabel":"enum\u003cstring>"},"test_mode":{"description":"Whether this transaction was created in test mode. `true` for test-mode data, `false` for live data.","type":"boolean","example":false,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.test_mode","typeLabel":"boolean"},"available_on":{"oneOf":[{"type":"string","description":"When the funds become available in your bank account. RFC 3339 timestamp.","example":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.available_on.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the funds become available in your bank account. RFC 3339 timestamp.","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.available_on.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.available_on","typeLabel":"string | null"},"created_at":{"oneOf":[{"type":"string","description":"When the transaction was created. RFC 3339 timestamp.","example":"2026-06-15T14:30:00Z","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.created_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the transaction was created. RFC 3339 timestamp.","example":"2026-06-15T14:30:00Z","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.created_at","typeLabel":"string | null"},"exchange_rate":{"oneOf":[{"description":"The exchange rate applied if the transaction involved a currency conversion. `null` when no conversion took place.","type":"number","format":"double","example":1,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.exchange_rate.oneOf.0","typeLabel":"number\u003cdouble>"},{"description":"The exchange rate applied if the transaction involved a currency conversion. `null` when no conversion took place.","type":"null","format":"double","example":1,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.exchange_rate.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.exchange_rate","typeLabel":"number\u003cdouble> | null"},"reporting_category":{"oneOf":[{"description":"High-level accounting category for the transaction. `null` if not yet categorized.","type":"string","example":"example_value","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.reporting_category.oneOf.0","typeLabel":"string"},{"description":"High-level accounting category for the transaction. `null` if not yet categorized.","type":"null","example":"example_value","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.reporting_category.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.reporting_category","typeLabel":"string | null"},"checkout_session_id":{"oneOf":[{"description":"ID of the Checkout Session that originated this transaction, if it stems from a checkout.","type":"string","example":"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.checkout_session_id.oneOf.0","typeLabel":"string"},{"description":"ID of the Checkout Session that originated this transaction, if it stems from a checkout.","type":"null","example":"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.checkout_session_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.checkout_session_id","typeLabel":"string | null"},"client_reference_id":{"oneOf":[{"description":"Your own identifier for the originating object, carried over from the checkout session or payment.","type":"string","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.client_reference_id.oneOf.0","typeLabel":"string"},{"description":"Your own identifier for the originating object, carried over from the checkout session or payment.","type":"null","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.client_reference_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.client_reference_id","typeLabel":"string | null"},"source_id":{"oneOf":[{"description":"ID of the Flex object that produced this transaction (e.g., a Charge `fch_`, Refund `fre_`, or Payout `fpo_`). `null` if the source has not been resolved to a Flex object.","type":"string","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.source_id.oneOf.0","typeLabel":"string"},{"description":"ID of the Flex object that produced this transaction (e.g., a Charge `fch_`, Refund `fre_`, or Payout `fpo_`). `null` if the source has not been resolved to a Flex object.","type":"null","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.source_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.source_id","typeLabel":"string | null"},"type":{"oneOf":[{"description":"The type of transaction.","type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.type.oneOf.0","typeLabel":"string"},{"description":"The type of transaction.","type":"null","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.type","typeLabel":"string | null"},"flex_payment_intent_id":{"oneOf":[{"description":"ID of the Payment Intent associated with this transaction, if any. `null` for transactions not tied to a payment (e.g., payouts).","type":"string","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.flex_payment_intent_id.oneOf.0","typeLabel":"string"},{"description":"ID of the Payment Intent associated with this transaction, if any. `null` for transactions not tied to a payment (e.g., payouts).","type":"null","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.flex_payment_intent_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.flex_payment_intent_id","typeLabel":"string | null"},"mid":{"oneOf":[{"description":"Merchant identifier (MID) for the account that processed the transaction.","type":"string","example":"example_value","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.mid.oneOf.0","typeLabel":"string"},{"description":"Merchant identifier (MID) for the account that processed the transaction.","type":"null","example":"example_value","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.mid.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.mid","typeLabel":"string | null"},"currency":{"oneOf":[{"description":"Three-letter ISO currency code, in lowercase (e.g., `usd`).","type":"string","example":"usd","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.currency.oneOf.0","typeLabel":"string"},{"description":"Three-letter ISO currency code, in lowercase (e.g., `usd`).","type":"null","example":"usd","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.currency","typeLabel":"string | null"},"metadata":{"oneOf":[{"description":"Set of key-value pairs you can attach to the object for storing additional structured information.","type":"object","additionalProperties":{"type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.metadata.oneOf.0.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.metadata.oneOf.0","typeLabel":"object"},{"description":"Set of key-value pairs you can attach to the object for storing additional structured information.","type":"null","additionalProperties":{"type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.metadata.oneOf.1.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.metadata","typeLabel":"object | null"},"transaction_fee_amount":{"oneOf":[{"description":"Portion of `fee` attributable to standard transaction processing, in the smallest currency unit. `null` if not broken out.","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.transaction_fee_amount.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"Portion of `fee` attributable to standard transaction processing, in the smallest currency unit. `null` if not broken out.","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.transaction_fee_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.transaction_fee_amount","typeLabel":"integer\u003cint32> | null"},"interchange_fee_amount":{"oneOf":[{"description":"Portion of `fee` attributable to card-network interchange, in the smallest currency unit. `null` if not broken out.","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.interchange_fee_amount.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"Portion of `fee` attributable to card-network interchange, in the smallest currency unit. `null` if not broken out.","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.interchange_fee_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.interchange_fee_amount","typeLabel":"integer\u003cint32> | null"},"lmn_fee_amount":{"oneOf":[{"description":"Portion of `fee` attributable to Letter of Medical Necessity (LMN) processing, in the smallest currency unit. `null` if not applicable.","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.lmn_fee_amount.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"Portion of `fee` attributable to Letter of Medical Necessity (LMN) processing, in the smallest currency unit. `null` if not applicable.","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.lmn_fee_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.lmn_fee_amount","typeLabel":"integer\u003cint32> | null"},"dispute_fee_amount":{"oneOf":[{"description":"Portion of `fee` attributable to a dispute, in the smallest currency unit. `null` if not applicable.","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.dispute_fee_amount.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"Portion of `fee` attributable to a dispute, in the smallest currency unit. `null` if not applicable.","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.dispute_fee_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.dispute_fee_amount","typeLabel":"integer\u003cint32> | null"},"card_type":{"oneOf":[{"description":"Card funding type used for the transaction.","type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.card_type.oneOf.0","typeLabel":"string"},{"description":"Card funding type used for the transaction.","type":"null","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.card_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.card_type","typeLabel":"string | null"},"card_network":{"oneOf":[{"description":"Card network used for the transaction (e.g., `visa`, `mastercard`).","type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.card_network.oneOf.0","typeLabel":"string"},{"description":"Card network used for the transaction (e.g., `visa`, `mastercard`).","type":"null","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.card_network.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1.card_network","typeLabel":"string | null"}},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.1","typeLabel":"object"},{"type":"null","description":"After a refund fails, the balance transaction describing the adjustment that returns the funds to your balance.","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction.oneOf.2","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1.failure_balance_transaction","typeLabel":"string | object | null"}},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0.items.[INDEX]","typeLabel":"string | object"},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.0","typeLabel":"(string | object)[]"},{"description":"A list of refunds that have been applied to the charge.","type":"null","items":{"oneOf":[{"type":"string","description":"An expandable field — either a string ID or an expanded Refund object.","example":"fre_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"object","description":"An expandable field — either a string ID or an expanded Refund object.","required":["amount","created_at","refund_id","status","test_mode"],"example":"fre_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"refund_id":{"description":"The ID of the refund","type":"string","example":"fre_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},"payment_intent_id":{"oneOf":[{"description":"The ID of the payment intent that the refund is associated with","type":"string","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"description":"The ID of the payment intent that the refund is associated with","type":"null","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"amount":{"description":"The amount of the refund in cents","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647},"created_at":{"description":"The time at which the refund was created. ISO 8601 format.","type":"string","example":"2026-06-15T14:30:00Z"},"reason":{"oneOf":[{"type":"string","description":"The reason for the refund","enum":["duplicate","fraudulent","requested_by_customer","expired_uncaptured_charge"],"example":"duplicate"},{"type":"null","description":"The reason for the refund"}]},"status":{"description":"The status of the refund","type":"string","enum":["pending","requires_action","succeeded","failed","canceled"],"example":"pending"},"test_mode":{"description":"Whether the refund was created in test mode","type":"boolean","example":false},"metadata":{"oneOf":[{"description":"Metadata attached to the refund","type":"object","additionalProperties":{"type":"string"},"example":{"order_id":"8842","channel":"shopify"}},{"description":"Metadata attached to the refund","type":"null","additionalProperties":{"type":"string"},"example":{"order_id":"8842","channel":"shopify"}}]},"reference_id":{"oneOf":[{"description":"Reference number that the customer can use to trace this refund with their bank or card issuer.","type":"string","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"description":"Reference number that the customer can use to trace this refund with their bank or card issuer.","type":"null","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"reference_type":{"oneOf":[{"type":"string","description":"Type of the reference number used for the refund","enum":["acquirer_reference_number","system_trace_audit_number","retrieval_reference_number"],"example":"acquirer_reference_number"},{"type":"null","description":"Type of the reference number used for the refund"}]},"reference_status":{"oneOf":[{"type":"string","description":"Status of the reference number used for the refund","enum":["available","pending","unavailable"],"example":"available"},{"type":"null","description":"Status of the reference number used for the refund"}]},"items":{"description":"List of refund items (charges that were refunded)","default":[],"type":"array","items":{"description":"Represents a single refund item (charge that was refunded)","type":"object","required":["amount_refunded"],"properties":{"amount_refunded":{"description":"The amount refunded from this charge in cents","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647},"payment_intent":{"oneOf":[{"description":"The ID of the payment intent that the refund is associated with","type":"string","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"description":"The ID of the payment intent that the refund is associated with","type":"null","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"payment_method_id":{"oneOf":[{"description":"The ID of the payment method used for this refund","type":"string","example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"description":"The ID of the payment method used for this refund","type":"null","example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"reference_id":{"oneOf":[{"description":"Reference number that the customer can use to trace this refund with their bank or card issuer.","type":"string","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"description":"Reference number that the customer can use to trace this refund with their bank or card issuer.","type":"null","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"reference_type":{"oneOf":[{"type":"string","description":"Type of the reference number used for the refund","enum":["acquirer_reference_number","system_trace_audit_number","retrieval_reference_number"],"example":"acquirer_reference_number"},{"type":"null","description":"Type of the reference number used for the refund"}]},"reference_status":{"oneOf":[{"type":"string","description":"Status of the reference number used for the refund","enum":["available","pending","unavailable"],"example":"available"},{"type":"null","description":"Status of the reference number used for the refund"}]}},"example":{"amount_refunded":2500,"payment_intent":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","payment_method_id":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA","reference_id":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","reference_type":"acquirer_reference_number","reference_status":"available"}}},"subscription_id":{"oneOf":[{"description":"The subscription this refund is associated with (for subscription cancellation refunds)","type":"string","example":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"description":"The subscription this refund is associated with (for subscription cancellation refunds)","type":"null","example":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"invoice_id":{"oneOf":[{"description":"The invoice this refund is associated with (for subscription billing period refunds)","type":"string","example":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"description":"The invoice this refund is associated with (for subscription billing period refunds)","type":"null","example":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"balance_transaction":{"oneOf":[{"type":"string","description":"Balance transaction that describes the impact of this refund on your balance. Defaults to the balance transaction ID; use `?expand=balance_transaction` to inflate the full object.","example":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"object","description":"Balance transaction that describes the impact of this refund on your balance. Defaults to the balance transaction ID; use `?expand=balance_transaction` to inflate the full object.","required":["amount","balance_transaction_id","fee","net","status","test_mode"],"example":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"balance_transaction_id":{"description":"Unique identifier for the balance transaction, prefixed with `fbtxn_`.","type":"string","example":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},"amount":{"description":"Gross amount of the transaction, in the smallest currency unit (e.g., `1000` = $10.00 USD). Positive for funds added to your balance (e.g., charges) and negative for funds removed (e.g., refunds, payouts, dispute debits).","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647},"available_on":{"oneOf":[{"type":"string","description":"When the funds become available in your bank account. RFC 3339 timestamp.","example":"string"},{"type":"null","description":"When the funds become available in your bank account. RFC 3339 timestamp."}]},"created_at":{"oneOf":[{"type":"string","description":"When the transaction was created. RFC 3339 timestamp.","example":"2026-06-15T14:30:00Z"},{"type":"null","description":"When the transaction was created. RFC 3339 timestamp.","example":"2026-06-15T14:30:00Z"}]},"exchange_rate":{"oneOf":[{"description":"The exchange rate applied if the transaction involved a currency conversion. `null` when no conversion took place.","type":"number","format":"double","example":1},{"description":"The exchange rate applied if the transaction involved a currency conversion. `null` when no conversion took place.","type":"null","format":"double","example":1}]},"fee":{"description":"Total processing fee deducted from `amount`, in the smallest currency unit (e.g., `30` = $0.30 USD). `0` when no fee applies.","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647},"net":{"description":"Net amount that affects your balance after `fee` is applied (`net = amount - fee`), in the smallest currency unit (e.g., `970` = $9.70 USD).","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647},"reporting_category":{"oneOf":[{"description":"High-level accounting category for the transaction. `null` if not yet categorized.","type":"string","example":"example_value"},{"description":"High-level accounting category for the transaction. `null` if not yet categorized.","type":"null","example":"example_value"}]},"checkout_session_id":{"oneOf":[{"description":"ID of the Checkout Session that originated this transaction, if it stems from a checkout.","type":"string","example":"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"description":"ID of the Checkout Session that originated this transaction, if it stems from a checkout.","type":"null","example":"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"client_reference_id":{"oneOf":[{"description":"Your own identifier for the originating object, carried over from the checkout session or payment.","type":"string","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"description":"Your own identifier for the originating object, carried over from the checkout session or payment.","type":"null","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"status":{"type":"string","enum":["available","pending"],"x-ms-enum":{"name":"BalanceTransactionStatus","modelAsString":false,"values":[{"value":"available","name":"Available","description":"Funds have settled and are available to be paid out."},{"value":"pending","name":"Pending","description":"Funds are not yet available."}]},"description":"Availability status of the funds: `pending` (not yet available) or `available` (settled and withdrawable).","example":"available"},"source_id":{"oneOf":[{"description":"ID of the Flex object that produced this transaction (e.g., a Charge `fch_`, Refund `fre_`, or Payout `fpo_`). `null` if the source has not been resolved to a Flex object.","type":"string","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"description":"ID of the Flex object that produced this transaction (e.g., a Charge `fch_`, Refund `fre_`, or Payout `fpo_`). `null` if the source has not been resolved to a Flex object.","type":"null","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"type":{"oneOf":[{"description":"The type of transaction.","type":"string"},{"description":"The type of transaction.","type":"null"}]},"flex_payment_intent_id":{"oneOf":[{"description":"ID of the Payment Intent associated with this transaction, if any. `null` for transactions not tied to a payment (e.g., payouts).","type":"string","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"description":"ID of the Payment Intent associated with this transaction, if any. `null` for transactions not tied to a payment (e.g., payouts).","type":"null","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"test_mode":{"description":"Whether this transaction was created in test mode. `true` for test-mode data, `false` for live data.","type":"boolean","example":false},"mid":{"oneOf":[{"description":"Merchant identifier (MID) for the account that processed the transaction.","type":"string","example":"example_value"},{"description":"Merchant identifier (MID) for the account that processed the transaction.","type":"null","example":"example_value"}]},"currency":{"oneOf":[{"description":"Three-letter ISO currency code, in lowercase (e.g., `usd`).","type":"string","example":"usd"},{"description":"Three-letter ISO currency code, in lowercase (e.g., `usd`).","type":"null","example":"usd"}]},"metadata":{"oneOf":[{"description":"Set of key-value pairs you can attach to the object for storing additional structured information.","type":"object","additionalProperties":{"type":"string"},"example":{"order_id":"8842","channel":"shopify"}},{"description":"Set of key-value pairs you can attach to the object for storing additional structured information.","type":"null","additionalProperties":{"type":"string"},"example":{"order_id":"8842","channel":"shopify"}}]},"transaction_fee_amount":{"oneOf":[{"description":"Portion of `fee` attributable to standard transaction processing, in the smallest currency unit. `null` if not broken out.","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648},{"description":"Portion of `fee` attributable to standard transaction processing, in the smallest currency unit. `null` if not broken out.","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"interchange_fee_amount":{"oneOf":[{"description":"Portion of `fee` attributable to card-network interchange, in the smallest currency unit. `null` if not broken out.","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648},{"description":"Portion of `fee` attributable to card-network interchange, in the smallest currency unit. `null` if not broken out.","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"lmn_fee_amount":{"oneOf":[{"description":"Portion of `fee` attributable to Letter of Medical Necessity (LMN) processing, in the smallest currency unit. `null` if not applicable.","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648},{"description":"Portion of `fee` attributable to Letter of Medical Necessity (LMN) processing, in the smallest currency unit. `null` if not applicable.","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"dispute_fee_amount":{"oneOf":[{"description":"Portion of `fee` attributable to a dispute, in the smallest currency unit. `null` if not applicable.","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648},{"description":"Portion of `fee` attributable to a dispute, in the smallest currency unit. `null` if not applicable.","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"card_type":{"oneOf":[{"description":"Card funding type used for the transaction.","type":"string"},{"description":"Card funding type used for the transaction.","type":"null"}]},"card_network":{"oneOf":[{"description":"Card network used for the transaction (e.g., `visa`, `mastercard`).","type":"string"},{"description":"Card network used for the transaction (e.g., `visa`, `mastercard`).","type":"null"}]}}},{"type":"null","description":"Balance transaction that describes the impact of this refund on your balance. Defaults to the balance transaction ID; use `?expand=balance_transaction` to inflate the full object."}]},"failure_balance_transaction":{"oneOf":[{"type":"string","description":"After a refund fails, the balance transaction describing the adjustment that returns the funds to your balance.","example":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"object","description":"After a refund fails, the balance transaction describing the adjustment that returns the funds to your balance.","required":["amount","balance_transaction_id","fee","net","status","test_mode"],"example":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"balance_transaction_id":{"description":"Unique identifier for the balance transaction, prefixed with `fbtxn_`.","type":"string","example":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},"amount":{"description":"Gross amount of the transaction, in the smallest currency unit (e.g., `1000` = $10.00 USD). Positive for funds added to your balance (e.g., charges) and negative for funds removed (e.g., refunds, payouts, dispute debits).","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647},"available_on":{"oneOf":[{"type":"string","description":"When the funds become available in your bank account. RFC 3339 timestamp.","example":"string"},{"type":"null","description":"When the funds become available in your bank account. RFC 3339 timestamp."}]},"created_at":{"oneOf":[{"type":"string","description":"When the transaction was created. RFC 3339 timestamp.","example":"2026-06-15T14:30:00Z"},{"type":"null","description":"When the transaction was created. RFC 3339 timestamp.","example":"2026-06-15T14:30:00Z"}]},"exchange_rate":{"oneOf":[{"description":"The exchange rate applied if the transaction involved a currency conversion. `null` when no conversion took place.","type":"number","format":"double","example":1},{"description":"The exchange rate applied if the transaction involved a currency conversion. `null` when no conversion took place.","type":"null","format":"double","example":1}]},"fee":{"description":"Total processing fee deducted from `amount`, in the smallest currency unit (e.g., `30` = $0.30 USD). `0` when no fee applies.","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647},"net":{"description":"Net amount that affects your balance after `fee` is applied (`net = amount - fee`), in the smallest currency unit (e.g., `970` = $9.70 USD).","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647},"reporting_category":{"oneOf":[{"description":"High-level accounting category for the transaction. `null` if not yet categorized.","type":"string","example":"example_value"},{"description":"High-level accounting category for the transaction. `null` if not yet categorized.","type":"null","example":"example_value"}]},"checkout_session_id":{"oneOf":[{"description":"ID of the Checkout Session that originated this transaction, if it stems from a checkout.","type":"string","example":"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"description":"ID of the Checkout Session that originated this transaction, if it stems from a checkout.","type":"null","example":"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"client_reference_id":{"oneOf":[{"description":"Your own identifier for the originating object, carried over from the checkout session or payment.","type":"string","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"description":"Your own identifier for the originating object, carried over from the checkout session or payment.","type":"null","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"status":{"type":"string","enum":["available","pending"],"x-ms-enum":{"name":"BalanceTransactionStatus","modelAsString":false,"values":[{"value":"available","name":"Available","description":"Funds have settled and are available to be paid out."},{"value":"pending","name":"Pending","description":"Funds are not yet available."}]},"description":"Availability status of the funds: `pending` (not yet available) or `available` (settled and withdrawable).","example":"available"},"source_id":{"oneOf":[{"description":"ID of the Flex object that produced this transaction (e.g., a Charge `fch_`, Refund `fre_`, or Payout `fpo_`). `null` if the source has not been resolved to a Flex object.","type":"string","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"description":"ID of the Flex object that produced this transaction (e.g., a Charge `fch_`, Refund `fre_`, or Payout `fpo_`). `null` if the source has not been resolved to a Flex object.","type":"null","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"type":{"oneOf":[{"description":"The type of transaction.","type":"string"},{"description":"The type of transaction.","type":"null"}]},"flex_payment_intent_id":{"oneOf":[{"description":"ID of the Payment Intent associated with this transaction, if any. `null` for transactions not tied to a payment (e.g., payouts).","type":"string","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"description":"ID of the Payment Intent associated with this transaction, if any. `null` for transactions not tied to a payment (e.g., payouts).","type":"null","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"test_mode":{"description":"Whether this transaction was created in test mode. `true` for test-mode data, `false` for live data.","type":"boolean","example":false},"mid":{"oneOf":[{"description":"Merchant identifier (MID) for the account that processed the transaction.","type":"string","example":"example_value"},{"description":"Merchant identifier (MID) for the account that processed the transaction.","type":"null","example":"example_value"}]},"currency":{"oneOf":[{"description":"Three-letter ISO currency code, in lowercase (e.g., `usd`).","type":"string","example":"usd"},{"description":"Three-letter ISO currency code, in lowercase (e.g., `usd`).","type":"null","example":"usd"}]},"metadata":{"oneOf":[{"description":"Set of key-value pairs you can attach to the object for storing additional structured information.","type":"object","additionalProperties":{"type":"string"},"example":{"order_id":"8842","channel":"shopify"}},{"description":"Set of key-value pairs you can attach to the object for storing additional structured information.","type":"null","additionalProperties":{"type":"string"},"example":{"order_id":"8842","channel":"shopify"}}]},"transaction_fee_amount":{"oneOf":[{"description":"Portion of `fee` attributable to standard transaction processing, in the smallest currency unit. `null` if not broken out.","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648},{"description":"Portion of `fee` attributable to standard transaction processing, in the smallest currency unit. `null` if not broken out.","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"interchange_fee_amount":{"oneOf":[{"description":"Portion of `fee` attributable to card-network interchange, in the smallest currency unit. `null` if not broken out.","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648},{"description":"Portion of `fee` attributable to card-network interchange, in the smallest currency unit. `null` if not broken out.","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"lmn_fee_amount":{"oneOf":[{"description":"Portion of `fee` attributable to Letter of Medical Necessity (LMN) processing, in the smallest currency unit. `null` if not applicable.","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648},{"description":"Portion of `fee` attributable to Letter of Medical Necessity (LMN) processing, in the smallest currency unit. `null` if not applicable.","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"dispute_fee_amount":{"oneOf":[{"description":"Portion of `fee` attributable to a dispute, in the smallest currency unit. `null` if not applicable.","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648},{"description":"Portion of `fee` attributable to a dispute, in the smallest currency unit. `null` if not applicable.","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"card_type":{"oneOf":[{"description":"Card funding type used for the transaction.","type":"string"},{"description":"Card funding type used for the transaction.","type":"null"}]},"card_network":{"oneOf":[{"description":"Card network used for the transaction (e.g., `visa`, `mastercard`).","type":"string"},{"description":"Card network used for the transaction (e.g., `visa`, `mastercard`).","type":"null"}]}}},{"type":"null","description":"After a refund fails, the balance transaction describing the adjustment that returns the funds to your balance."}]}}}]},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.refunds","typeLabel":"(string | object)[] | null"},"transfer_group":{"oneOf":[{"description":"A string that identifies the resulting payment as part of a group","type":"string","example":"example_value","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.transfer_group.oneOf.0","typeLabel":"string"},{"description":"A string that identifies the resulting payment as part of a group","type":"null","example":"example_value","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.transfer_group.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.transfer_group","typeLabel":"string | null"},"payment_method_id":{"oneOf":[{"description":"The ID of the PaymentMethod.","type":"string","example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.payment_method_id.oneOf.0","typeLabel":"string"},{"description":"The ID of the PaymentMethod.","type":"null","example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.payment_method_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.payment_method_id","typeLabel":"string | null"},"three_d_secure":{"oneOf":[{"type":"object","description":"3D Secure authentication outcome details, if 3DS was used.","example":{"authentication_flow":"string","result":"string","result_reason":"string","version":"string"},"properties":{"authentication_flow":{"oneOf":[{"description":"How the customer was authenticated: `challenge` or `frictionless`.","type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.three_d_secure.oneOf.0.authentication_flow.oneOf.0","typeLabel":"string"},{"description":"How the customer was authenticated: `challenge` or `frictionless`.","type":"null","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.three_d_secure.oneOf.0.authentication_flow.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.three_d_secure.oneOf.0.authentication_flow","typeLabel":"string | null"},"result":{"oneOf":[{"description":"Outcome of 3D Secure authentication.","type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.three_d_secure.oneOf.0.result.oneOf.0","typeLabel":"string"},{"description":"Outcome of 3D Secure authentication.","type":"null","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.three_d_secure.oneOf.0.result.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.three_d_secure.oneOf.0.result","typeLabel":"string | null"},"result_reason":{"oneOf":[{"description":"Additional detail about why 3DS succeeded or failed.","type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.three_d_secure.oneOf.0.result_reason.oneOf.0","typeLabel":"string"},{"description":"Additional detail about why 3DS succeeded or failed.","type":"null","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.three_d_secure.oneOf.0.result_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.three_d_secure.oneOf.0.result_reason","typeLabel":"string | null"},"version":{"oneOf":[{"description":"The version of 3D Secure used.","type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.three_d_secure.oneOf.0.version.oneOf.0","typeLabel":"string"},{"description":"The version of 3D Secure used.","type":"null","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.three_d_secure.oneOf.0.version.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.three_d_secure.oneOf.0.version","typeLabel":"string | null"}},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.three_d_secure.oneOf.0","typeLabel":"object"},{"type":"null","description":"3D Secure authentication outcome details, if 3DS was used.","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.three_d_secure.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.three_d_secure","typeLabel":"object | null"},"decline_details":{"oneOf":[{"type":"object","description":"Decline and risk details for failed or blocked charges.","example":{"failure_code":"string","decline_code":"string","failure_message":"string","outcome_type":"string","network_status":"string","seller_message":"string","reason":"string","risk_level":"string"},"properties":{"failure_code":{"oneOf":[{"description":"Error code for the charge failure (e.g. `card_declined`, `expired_card`).","type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.decline_details.oneOf.0.failure_code.oneOf.0","typeLabel":"string"},{"description":"Error code for the charge failure (e.g. `card_declined`, `expired_card`).","type":"null","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.decline_details.oneOf.0.failure_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.decline_details.oneOf.0.failure_code","typeLabel":"string | null"},"decline_code":{"oneOf":[{"description":"More specific decline reason (e.g. `insufficient_funds`, `lost_card`).","type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.decline_details.oneOf.0.decline_code.oneOf.0","typeLabel":"string"},{"description":"More specific decline reason (e.g. `insufficient_funds`, `lost_card`).","type":"null","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.decline_details.oneOf.0.decline_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.decline_details.oneOf.0.decline_code","typeLabel":"string | null"},"failure_message":{"oneOf":[{"description":"User-facing failure message.","type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.decline_details.oneOf.0.failure_message.oneOf.0","typeLabel":"string"},{"description":"User-facing failure message.","type":"null","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.decline_details.oneOf.0.failure_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.decline_details.oneOf.0.failure_message","typeLabel":"string | null"},"outcome_type":{"oneOf":[{"description":"The outcome type of the decline.","type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.decline_details.oneOf.0.outcome_type.oneOf.0","typeLabel":"string"},{"description":"The outcome type of the decline.","type":"null","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.decline_details.oneOf.0.outcome_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.decline_details.oneOf.0.outcome_type","typeLabel":"string | null"},"network_status":{"oneOf":[{"description":"Network-level status: `approved_by_network`, `declined_by_network`, etc.","type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.decline_details.oneOf.0.network_status.oneOf.0","typeLabel":"string"},{"description":"Network-level status: `approved_by_network`, `declined_by_network`, etc.","type":"null","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.decline_details.oneOf.0.network_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.decline_details.oneOf.0.network_status","typeLabel":"string | null"},"seller_message":{"oneOf":[{"description":"Technical explanation of the outcome for the merchant.","type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.decline_details.oneOf.0.seller_message.oneOf.0","typeLabel":"string"},{"description":"Technical explanation of the outcome for the merchant.","type":"null","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.decline_details.oneOf.0.seller_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.decline_details.oneOf.0.seller_message","typeLabel":"string | null"},"reason":{"oneOf":[{"description":"Fraud/risk reason (e.g. `elevated_risk_level`).","type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.decline_details.oneOf.0.reason.oneOf.0","typeLabel":"string"},{"description":"Fraud/risk reason (e.g. `elevated_risk_level`).","type":"null","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.decline_details.oneOf.0.reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.decline_details.oneOf.0.reason","typeLabel":"string | null"},"risk_level":{"oneOf":[{"description":"The risk level assessed for the payment.","type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.decline_details.oneOf.0.risk_level.oneOf.0","typeLabel":"string"},{"description":"The risk level assessed for the payment.","type":"null","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.decline_details.oneOf.0.risk_level.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.decline_details.oneOf.0.risk_level","typeLabel":"string | null"}},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.decline_details.oneOf.0","typeLabel":"object"},{"type":"null","description":"Decline and risk details for failed or blocked charges.","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.decline_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.decline_details","typeLabel":"object | null"},"balance_transaction":{"oneOf":[{"type":"string","description":"Balance transaction that describes the impact of this charge on your balance. Populated on successful capture, returned as the balance transaction ID. Always serialized; `null` for uncaptured charges.","example":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.0","typeLabel":"string"},{"type":"object","description":"Balance transaction that describes the impact of this charge on your balance. Populated on successful capture, returned as the balance transaction ID. Always serialized; `null` for uncaptured charges.","required":["amount","balance_transaction_id","fee","net","status","test_mode"],"example":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"balance_transaction_id":{"description":"Unique identifier for the balance transaction, prefixed with `fbtxn_`.","type":"string","example":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.balance_transaction_id","typeLabel":"string"},"amount":{"description":"Gross amount of the transaction, in the smallest currency unit (e.g., `1000` = $10.00 USD). Positive for funds added to your balance (e.g., charges) and negative for funds removed (e.g., refunds, payouts, dispute debits).","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.amount","typeLabel":"integer\u003cint32>"},"fee":{"description":"Total processing fee deducted from `amount`, in the smallest currency unit (e.g., `30` = $0.30 USD). `0` when no fee applies.","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.fee","typeLabel":"integer\u003cint32>"},"net":{"description":"Net amount that affects your balance after `fee` is applied (`net = amount - fee`), in the smallest currency unit (e.g., `970` = $9.70 USD).","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.net","typeLabel":"integer\u003cint32>"},"status":{"type":"string","enum":["available","pending"],"x-ms-enum":{"name":"BalanceTransactionStatus","modelAsString":false,"values":[{"value":"available","name":"Available","description":"Funds have settled and are available to be paid out."},{"value":"pending","name":"Pending","description":"Funds are not yet available."}]},"description":"Availability status of the funds: `pending` (not yet available) or `available` (settled and withdrawable).","example":"available","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.status","typeLabel":"enum\u003cstring>"},"test_mode":{"description":"Whether this transaction was created in test mode. `true` for test-mode data, `false` for live data.","type":"boolean","example":false,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.test_mode","typeLabel":"boolean"},"available_on":{"oneOf":[{"type":"string","description":"When the funds become available in your bank account. RFC 3339 timestamp.","example":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.available_on.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the funds become available in your bank account. RFC 3339 timestamp.","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.available_on.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.available_on","typeLabel":"string | null"},"created_at":{"oneOf":[{"type":"string","description":"When the transaction was created. RFC 3339 timestamp.","example":"2026-06-15T14:30:00Z","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.created_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the transaction was created. RFC 3339 timestamp.","example":"2026-06-15T14:30:00Z","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.created_at","typeLabel":"string | null"},"exchange_rate":{"oneOf":[{"description":"The exchange rate applied if the transaction involved a currency conversion. `null` when no conversion took place.","type":"number","format":"double","example":1,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.exchange_rate.oneOf.0","typeLabel":"number\u003cdouble>"},{"description":"The exchange rate applied if the transaction involved a currency conversion. `null` when no conversion took place.","type":"null","format":"double","example":1,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.exchange_rate.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.exchange_rate","typeLabel":"number\u003cdouble> | null"},"reporting_category":{"oneOf":[{"description":"High-level accounting category for the transaction. `null` if not yet categorized.","type":"string","example":"example_value","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.reporting_category.oneOf.0","typeLabel":"string"},{"description":"High-level accounting category for the transaction. `null` if not yet categorized.","type":"null","example":"example_value","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.reporting_category.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.reporting_category","typeLabel":"string | null"},"checkout_session_id":{"oneOf":[{"description":"ID of the Checkout Session that originated this transaction, if it stems from a checkout.","type":"string","example":"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.checkout_session_id.oneOf.0","typeLabel":"string"},{"description":"ID of the Checkout Session that originated this transaction, if it stems from a checkout.","type":"null","example":"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.checkout_session_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.checkout_session_id","typeLabel":"string | null"},"client_reference_id":{"oneOf":[{"description":"Your own identifier for the originating object, carried over from the checkout session or payment.","type":"string","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.client_reference_id.oneOf.0","typeLabel":"string"},{"description":"Your own identifier for the originating object, carried over from the checkout session or payment.","type":"null","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.client_reference_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.client_reference_id","typeLabel":"string | null"},"source_id":{"oneOf":[{"description":"ID of the Flex object that produced this transaction (e.g., a Charge `fch_`, Refund `fre_`, or Payout `fpo_`). `null` if the source has not been resolved to a Flex object.","type":"string","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.source_id.oneOf.0","typeLabel":"string"},{"description":"ID of the Flex object that produced this transaction (e.g., a Charge `fch_`, Refund `fre_`, or Payout `fpo_`). `null` if the source has not been resolved to a Flex object.","type":"null","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.source_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.source_id","typeLabel":"string | null"},"type":{"oneOf":[{"description":"The type of transaction.","type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.type.oneOf.0","typeLabel":"string"},{"description":"The type of transaction.","type":"null","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.type","typeLabel":"string | null"},"flex_payment_intent_id":{"oneOf":[{"description":"ID of the Payment Intent associated with this transaction, if any. `null` for transactions not tied to a payment (e.g., payouts).","type":"string","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.flex_payment_intent_id.oneOf.0","typeLabel":"string"},{"description":"ID of the Payment Intent associated with this transaction, if any. `null` for transactions not tied to a payment (e.g., payouts).","type":"null","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.flex_payment_intent_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.flex_payment_intent_id","typeLabel":"string | null"},"mid":{"oneOf":[{"description":"Merchant identifier (MID) for the account that processed the transaction.","type":"string","example":"example_value","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.mid.oneOf.0","typeLabel":"string"},{"description":"Merchant identifier (MID) for the account that processed the transaction.","type":"null","example":"example_value","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.mid.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.mid","typeLabel":"string | null"},"currency":{"oneOf":[{"description":"Three-letter ISO currency code, in lowercase (e.g., `usd`).","type":"string","example":"usd","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.currency.oneOf.0","typeLabel":"string"},{"description":"Three-letter ISO currency code, in lowercase (e.g., `usd`).","type":"null","example":"usd","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.currency","typeLabel":"string | null"},"metadata":{"oneOf":[{"description":"Set of key-value pairs you can attach to the object for storing additional structured information.","type":"object","additionalProperties":{"type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.metadata.oneOf.0.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.metadata.oneOf.0","typeLabel":"object"},{"description":"Set of key-value pairs you can attach to the object for storing additional structured information.","type":"null","additionalProperties":{"type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.metadata.oneOf.1.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.metadata","typeLabel":"object | null"},"transaction_fee_amount":{"oneOf":[{"description":"Portion of `fee` attributable to standard transaction processing, in the smallest currency unit. `null` if not broken out.","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.transaction_fee_amount.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"Portion of `fee` attributable to standard transaction processing, in the smallest currency unit. `null` if not broken out.","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.transaction_fee_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.transaction_fee_amount","typeLabel":"integer\u003cint32> | null"},"interchange_fee_amount":{"oneOf":[{"description":"Portion of `fee` attributable to card-network interchange, in the smallest currency unit. `null` if not broken out.","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.interchange_fee_amount.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"Portion of `fee` attributable to card-network interchange, in the smallest currency unit. `null` if not broken out.","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.interchange_fee_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.interchange_fee_amount","typeLabel":"integer\u003cint32> | null"},"lmn_fee_amount":{"oneOf":[{"description":"Portion of `fee` attributable to Letter of Medical Necessity (LMN) processing, in the smallest currency unit. `null` if not applicable.","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.lmn_fee_amount.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"Portion of `fee` attributable to Letter of Medical Necessity (LMN) processing, in the smallest currency unit. `null` if not applicable.","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.lmn_fee_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.lmn_fee_amount","typeLabel":"integer\u003cint32> | null"},"dispute_fee_amount":{"oneOf":[{"description":"Portion of `fee` attributable to a dispute, in the smallest currency unit. `null` if not applicable.","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.dispute_fee_amount.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"Portion of `fee` attributable to a dispute, in the smallest currency unit. `null` if not applicable.","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.dispute_fee_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.dispute_fee_amount","typeLabel":"integer\u003cint32> | null"},"card_type":{"oneOf":[{"description":"Card funding type used for the transaction.","type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.card_type.oneOf.0","typeLabel":"string"},{"description":"Card funding type used for the transaction.","type":"null","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.card_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.card_type","typeLabel":"string | null"},"card_network":{"oneOf":[{"description":"Card network used for the transaction (e.g., `visa`, `mastercard`).","type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.card_network.oneOf.0","typeLabel":"string"},{"description":"Card network used for the transaction (e.g., `visa`, `mastercard`).","type":"null","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.card_network.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1.card_network","typeLabel":"string | null"}},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.1","typeLabel":"object"},{"type":"null","description":"Balance transaction that describes the impact of this charge on your balance. Populated on successful capture, returned as the balance transaction ID. Always serialized; `null` for uncaptured charges.","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction.oneOf.2","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.balance_transaction","typeLabel":"string | object | null"},"failure_balance_transaction":{"oneOf":[{"type":"string","description":"Reversal balance transaction created when a captured charge fails or is otherwise reversed and funds are credited back. Always serialized; `null` on the common success path.","example":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.0","typeLabel":"string"},{"type":"object","description":"Reversal balance transaction created when a captured charge fails or is otherwise reversed and funds are credited back. Always serialized; `null` on the common success path.","required":["amount","balance_transaction_id","fee","net","status","test_mode"],"example":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"balance_transaction_id":{"description":"Unique identifier for the balance transaction, prefixed with `fbtxn_`.","type":"string","example":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.balance_transaction_id","typeLabel":"string"},"amount":{"description":"Gross amount of the transaction, in the smallest currency unit (e.g., `1000` = $10.00 USD). Positive for funds added to your balance (e.g., charges) and negative for funds removed (e.g., refunds, payouts, dispute debits).","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.amount","typeLabel":"integer\u003cint32>"},"fee":{"description":"Total processing fee deducted from `amount`, in the smallest currency unit (e.g., `30` = $0.30 USD). `0` when no fee applies.","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.fee","typeLabel":"integer\u003cint32>"},"net":{"description":"Net amount that affects your balance after `fee` is applied (`net = amount - fee`), in the smallest currency unit (e.g., `970` = $9.70 USD).","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.net","typeLabel":"integer\u003cint32>"},"status":{"type":"string","enum":["available","pending"],"x-ms-enum":{"name":"BalanceTransactionStatus","modelAsString":false,"values":[{"value":"available","name":"Available","description":"Funds have settled and are available to be paid out."},{"value":"pending","name":"Pending","description":"Funds are not yet available."}]},"description":"Availability status of the funds: `pending` (not yet available) or `available` (settled and withdrawable).","example":"available","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.status","typeLabel":"enum\u003cstring>"},"test_mode":{"description":"Whether this transaction was created in test mode. `true` for test-mode data, `false` for live data.","type":"boolean","example":false,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.test_mode","typeLabel":"boolean"},"available_on":{"oneOf":[{"type":"string","description":"When the funds become available in your bank account. RFC 3339 timestamp.","example":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.available_on.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the funds become available in your bank account. RFC 3339 timestamp.","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.available_on.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.available_on","typeLabel":"string | null"},"created_at":{"oneOf":[{"type":"string","description":"When the transaction was created. RFC 3339 timestamp.","example":"2026-06-15T14:30:00Z","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.created_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the transaction was created. RFC 3339 timestamp.","example":"2026-06-15T14:30:00Z","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.created_at","typeLabel":"string | null"},"exchange_rate":{"oneOf":[{"description":"The exchange rate applied if the transaction involved a currency conversion. `null` when no conversion took place.","type":"number","format":"double","example":1,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.exchange_rate.oneOf.0","typeLabel":"number\u003cdouble>"},{"description":"The exchange rate applied if the transaction involved a currency conversion. `null` when no conversion took place.","type":"null","format":"double","example":1,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.exchange_rate.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.exchange_rate","typeLabel":"number\u003cdouble> | null"},"reporting_category":{"oneOf":[{"description":"High-level accounting category for the transaction. `null` if not yet categorized.","type":"string","example":"example_value","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.reporting_category.oneOf.0","typeLabel":"string"},{"description":"High-level accounting category for the transaction. `null` if not yet categorized.","type":"null","example":"example_value","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.reporting_category.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.reporting_category","typeLabel":"string | null"},"checkout_session_id":{"oneOf":[{"description":"ID of the Checkout Session that originated this transaction, if it stems from a checkout.","type":"string","example":"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.checkout_session_id.oneOf.0","typeLabel":"string"},{"description":"ID of the Checkout Session that originated this transaction, if it stems from a checkout.","type":"null","example":"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.checkout_session_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.checkout_session_id","typeLabel":"string | null"},"client_reference_id":{"oneOf":[{"description":"Your own identifier for the originating object, carried over from the checkout session or payment.","type":"string","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.client_reference_id.oneOf.0","typeLabel":"string"},{"description":"Your own identifier for the originating object, carried over from the checkout session or payment.","type":"null","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.client_reference_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.client_reference_id","typeLabel":"string | null"},"source_id":{"oneOf":[{"description":"ID of the Flex object that produced this transaction (e.g., a Charge `fch_`, Refund `fre_`, or Payout `fpo_`). `null` if the source has not been resolved to a Flex object.","type":"string","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.source_id.oneOf.0","typeLabel":"string"},{"description":"ID of the Flex object that produced this transaction (e.g., a Charge `fch_`, Refund `fre_`, or Payout `fpo_`). `null` if the source has not been resolved to a Flex object.","type":"null","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.source_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.source_id","typeLabel":"string | null"},"type":{"oneOf":[{"description":"The type of transaction.","type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.type.oneOf.0","typeLabel":"string"},{"description":"The type of transaction.","type":"null","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.type","typeLabel":"string | null"},"flex_payment_intent_id":{"oneOf":[{"description":"ID of the Payment Intent associated with this transaction, if any. `null` for transactions not tied to a payment (e.g., payouts).","type":"string","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.flex_payment_intent_id.oneOf.0","typeLabel":"string"},{"description":"ID of the Payment Intent associated with this transaction, if any. `null` for transactions not tied to a payment (e.g., payouts).","type":"null","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.flex_payment_intent_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.flex_payment_intent_id","typeLabel":"string | null"},"mid":{"oneOf":[{"description":"Merchant identifier (MID) for the account that processed the transaction.","type":"string","example":"example_value","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.mid.oneOf.0","typeLabel":"string"},{"description":"Merchant identifier (MID) for the account that processed the transaction.","type":"null","example":"example_value","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.mid.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.mid","typeLabel":"string | null"},"currency":{"oneOf":[{"description":"Three-letter ISO currency code, in lowercase (e.g., `usd`).","type":"string","example":"usd","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.currency.oneOf.0","typeLabel":"string"},{"description":"Three-letter ISO currency code, in lowercase (e.g., `usd`).","type":"null","example":"usd","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.currency","typeLabel":"string | null"},"metadata":{"oneOf":[{"description":"Set of key-value pairs you can attach to the object for storing additional structured information.","type":"object","additionalProperties":{"type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.metadata.oneOf.0.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.metadata.oneOf.0","typeLabel":"object"},{"description":"Set of key-value pairs you can attach to the object for storing additional structured information.","type":"null","additionalProperties":{"type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.metadata.oneOf.1.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.metadata","typeLabel":"object | null"},"transaction_fee_amount":{"oneOf":[{"description":"Portion of `fee` attributable to standard transaction processing, in the smallest currency unit. `null` if not broken out.","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.transaction_fee_amount.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"Portion of `fee` attributable to standard transaction processing, in the smallest currency unit. `null` if not broken out.","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.transaction_fee_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.transaction_fee_amount","typeLabel":"integer\u003cint32> | null"},"interchange_fee_amount":{"oneOf":[{"description":"Portion of `fee` attributable to card-network interchange, in the smallest currency unit. `null` if not broken out.","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.interchange_fee_amount.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"Portion of `fee` attributable to card-network interchange, in the smallest currency unit. `null` if not broken out.","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.interchange_fee_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.interchange_fee_amount","typeLabel":"integer\u003cint32> | null"},"lmn_fee_amount":{"oneOf":[{"description":"Portion of `fee` attributable to Letter of Medical Necessity (LMN) processing, in the smallest currency unit. `null` if not applicable.","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.lmn_fee_amount.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"Portion of `fee` attributable to Letter of Medical Necessity (LMN) processing, in the smallest currency unit. `null` if not applicable.","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.lmn_fee_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.lmn_fee_amount","typeLabel":"integer\u003cint32> | null"},"dispute_fee_amount":{"oneOf":[{"description":"Portion of `fee` attributable to a dispute, in the smallest currency unit. `null` if not applicable.","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.dispute_fee_amount.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"Portion of `fee` attributable to a dispute, in the smallest currency unit. `null` if not applicable.","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.dispute_fee_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.dispute_fee_amount","typeLabel":"integer\u003cint32> | null"},"card_type":{"oneOf":[{"description":"Card funding type used for the transaction.","type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.card_type.oneOf.0","typeLabel":"string"},{"description":"Card funding type used for the transaction.","type":"null","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.card_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.card_type","typeLabel":"string | null"},"card_network":{"oneOf":[{"description":"Card network used for the transaction (e.g., `visa`, `mastercard`).","type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.card_network.oneOf.0","typeLabel":"string"},{"description":"Card network used for the transaction (e.g., `visa`, `mastercard`).","type":"null","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.card_network.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1.card_network","typeLabel":"string | null"}},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.1","typeLabel":"object"},{"type":"null","description":"Reversal balance transaction created when a captured charge fails or is otherwise reversed and funds are credited back. Always serialized; `null` on the common success path.","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction.oneOf.2","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1.failure_balance_transaction","typeLabel":"string | object | null"}},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.1","typeLabel":"object"},{"type":"null","description":"The latest charge associated with the payment intent.","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge.oneOf.2","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.latest_charge","typeLabel":"string | object | null"},"invoice":{"oneOf":[{"description":"The invoice associated with the payment intent.","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.invoice.oneOf.0","typeLabel":"any"},{"type":"null","description":"The invoice associated with the payment intent.","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.invoice.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.invoice","typeLabel":"any | null"},"client_secret":{"oneOf":[{"description":"The client secret of the payment intent.","type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.client_secret.oneOf.0","typeLabel":"string"},{"description":"The client secret of the payment intent.","type":"null","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.client_secret.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.client_secret","typeLabel":"string | null"},"metadata":{"oneOf":[{"description":"The metadata associated with the payment intent.","type":"object","example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.metadata.oneOf.0","typeLabel":"object"},{"description":"The metadata associated with the payment intent.","type":"null","example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.metadata","typeLabel":"object | null"},"payment_method":{"oneOf":[{"type":"string","description":"The payment method associated with the payment intent.","example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.0","typeLabel":"string"},{"type":"object","description":"The payment method associated with the payment intent.","required":["billing_details","card","created_at","customer","off_session","payment_method_id","test_mode"],"example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"payment_method_id":{"description":"The ID of the PaymentMethod.","type":"string","example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.payment_method_id","typeLabel":"string"},"billing_details":{"description":"Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.","type":"object","properties":{"address":{"oneOf":[{"type":"object","description":"The billing address.","example":{"city":"San Francisco","country":"US","line1":"123 Main St","line2":"Suite 100","postal_code":"94107","state":"CA"},"properties":{"city":{"oneOf":[{"description":"City, district, suburb, town, or village.","type":"string","example":"San Francisco","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.billing_details.address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"description":"City, district, suburb, town, or village.","type":"null","example":"San Francisco","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.billing_details.address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.billing_details.address.oneOf.0.city","typeLabel":"string | null"},"country":{"oneOf":[{"description":"Two-letter ISO country code (e.g., `US`).","type":"string","example":"US","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.billing_details.address.oneOf.0.country.oneOf.0","typeLabel":"string"},{"description":"Two-letter ISO country code (e.g., `US`).","type":"null","example":"US","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.billing_details.address.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.billing_details.address.oneOf.0.country","typeLabel":"string | null"},"line1":{"oneOf":[{"description":"Address line 1, such as the street, PO box, or company name.","type":"string","example":"123 Main St","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.billing_details.address.oneOf.0.line1.oneOf.0","typeLabel":"string"},{"description":"Address line 1, such as the street, PO box, or company name.","type":"null","example":"123 Main St","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.billing_details.address.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.billing_details.address.oneOf.0.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"description":"Address line 2, such as the apartment, suite, unit, or building.","type":"string","example":"Suite 100","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.billing_details.address.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"description":"Address line 2, such as the apartment, suite, unit, or building.","type":"null","example":"Suite 100","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.billing_details.address.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.billing_details.address.oneOf.0.line2","typeLabel":"string | null"},"postal_code":{"oneOf":[{"description":"ZIP or postal code.","type":"string","example":"94107","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.billing_details.address.oneOf.0.postal_code.oneOf.0","typeLabel":"string"},{"description":"ZIP or postal code.","type":"null","example":"94107","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.billing_details.address.oneOf.0.postal_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.billing_details.address.oneOf.0.postal_code","typeLabel":"string | null"},"state":{"oneOf":[{"description":"State, county, province, or region.","type":"string","example":"CA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.billing_details.address.oneOf.0.state.oneOf.0","typeLabel":"string"},{"description":"State, county, province, or region.","type":"null","example":"CA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.billing_details.address.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.billing_details.address.oneOf.0.state","typeLabel":"string | null"}},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.billing_details.address.oneOf.0","typeLabel":"object"},{"type":"null","description":"The billing address.","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.billing_details.address.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.billing_details.address","typeLabel":"object | null"},"email":{"oneOf":[{"description":"The billing email address.","type":"string","example":"john.doe@example.com","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.billing_details.email.oneOf.0","typeLabel":"string"},{"description":"The billing email address.","type":"null","example":"john.doe@example.com","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.billing_details.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.billing_details.email","typeLabel":"string | null"},"name":{"oneOf":[{"description":"The billing name.","type":"string","example":"Example","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.billing_details.name.oneOf.0","typeLabel":"string"},{"description":"The billing name.","type":"null","example":"Example","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.billing_details.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.billing_details.name","typeLabel":"string | null"},"phone":{"oneOf":[{"description":"The billing phone number.","type":"string","example":"+14155550142","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.billing_details.phone.oneOf.0","typeLabel":"string"},{"description":"The billing phone number.","type":"null","example":"+14155550142","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.billing_details.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.billing_details.phone","typeLabel":"string | null"}},"example":{"address":{"city":"San Francisco","country":"US","line1":"123 Main St","line2":"Suite 100","postal_code":"94107","state":"CA"},"email":"john.doe@example.com","name":"Example","phone":"+14155550142"},"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.billing_details","typeLabel":"object"},"customer":{"oneOf":[{"type":"string","description":"The customer this payment method is attached to. Returned as the customer ID by default; expandable to the full Customer object.","example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.0","typeLabel":"string"},{"type":"object","description":"The customer this payment method is attached to. Returned as the customer ID by default; expandable to the full Customer object.","required":["created_at","customer_id","email","first_name","last_name","test_mode"],"example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"customer_id":{"description":"The unique identifier for the customer.","type":"string","example":"fcus_01HACM7FZ1084XB1GB6053VM0D","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.customer_id","typeLabel":"string"},"first_name":{"description":"The customer's first name.","type":"string","example":"John","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.first_name","typeLabel":"string"},"last_name":{"description":"The customer's last name.","type":"string","example":"Doe","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.last_name","typeLabel":"string"},"email":{"description":"The customer's email address.","type":"string","example":"joh.doe@example.com","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.email","typeLabel":"string"},"created_at":{"description":"The time the customer was created.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.created_at","typeLabel":"string"},"test_mode":{"description":"Whether the customer was created in test mode.","type":"boolean","example":false,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.test_mode","typeLabel":"boolean"},"owner_partner_id":{"oneOf":[{"description":"The partner that owns this customer. When a customer is shared with you by another partner in your organization, this is that sibling partner; otherwise it is your own partner id.","type":"string","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.owner_partner_id.oneOf.0","typeLabel":"string"},{"description":"The partner that owns this customer. When a customer is shared with you by another partner in your organization, this is that sibling partner; otherwise it is your own partner id.","type":"null","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.owner_partner_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.owner_partner_id","typeLabel":"string | null"},"phone":{"oneOf":[{"description":"The customer's phone number.","type":"string","format":"phone","example":"+15555555555","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.phone.oneOf.0","typeLabel":"string\u003cphone>"},{"description":"The customer's phone number.","type":"null","format":"phone","example":"+15555555555","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.phone","typeLabel":"string\u003cphone> | null"},"employer":{"oneOf":[{"description":"The customer's employer.","type":"string","example":"Flex","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.employer.oneOf.0","typeLabel":"string"},{"description":"The customer's employer.","type":"null","example":"Flex","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.employer.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.employer","typeLabel":"string | null"},"shipping":{"oneOf":[{"type":"object","description":"The customer's shipping address.","required":["shipping_address_id"],"example":{"shipping_address_id":"fsh_01J9XR8M3K7VZ8N2YB4WJ6T0RA","line1":"123 Main St","line2":"Suite 100","city":"San Francisco","state":"CA","postal_code":"94107","country":"US"},"properties":{"shipping_address_id":{"description":"Unique identifier for the shipping address.","type":"string","example":"fsh_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.shipping_address_id","typeLabel":"string"},"line1":{"oneOf":[{"description":"The first line of the street address (e.g., street number and name).","type":"string","example":"123 Main St","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.line1.oneOf.0","typeLabel":"string"},{"description":"The first line of the street address (e.g., street number and name).","type":"null","example":"123 Main St","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"description":"The second line of the street address (e.g., apartment, suite, or unit).","type":"string","example":"Suite 100","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"description":"The second line of the street address (e.g., apartment, suite, or unit).","type":"null","example":"Suite 100","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.line2","typeLabel":"string | null"},"city":{"oneOf":[{"description":"City, district, suburb, town, or village.","type":"string","example":"San Francisco","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.city.oneOf.0","typeLabel":"string"},{"description":"City, district, suburb, town, or village.","type":"null","example":"San Francisco","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.city","typeLabel":"string | null"},"state":{"oneOf":[{"description":"State, county, province, or region.","type":"string","example":"CA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.state.oneOf.0","typeLabel":"string"},{"description":"State, county, province, or region.","type":"null","example":"CA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.state","typeLabel":"string | null"},"postal_code":{"oneOf":[{"description":"ZIP or postal code.","type":"string","example":"94107","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.postal_code.oneOf.0","typeLabel":"string"},{"description":"ZIP or postal code.","type":"null","example":"94107","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.postal_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.postal_code","typeLabel":"string | null"},"country":{"oneOf":[{"description":"Two-letter country code (ISO 3166-1 alpha-2, e.g., `US`).","type":"string","example":"US","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.country.oneOf.0","typeLabel":"string"},{"description":"Two-letter country code (ISO 3166-1 alpha-2, e.g., `US`).","type":"null","example":"US","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.country","typeLabel":"string | null"}},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0","typeLabel":"object"},{"type":"null","description":"The customer's shipping address.","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.shipping","typeLabel":"object | null"},"metadata":{"oneOf":[{"description":"Metadata associated with the customer.","type":"object","additionalProperties":{"type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.metadata.oneOf.0.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.metadata.oneOf.0","typeLabel":"object"},{"description":"Metadata associated with the customer.","type":"null","additionalProperties":{"type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.metadata.oneOf.1.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1.metadata","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.customer","typeLabel":"string | object"},"card":{"description":"User card details.","type":"object","required":["brand","country","exp_month","exp_year","fingerprint","funding","last4"],"properties":{"brand":{"description":"The brand of the card.","type":"string","enum":["american_express","diners_club","discover","eftpos_au","JCB","master_card","union_pay","visa","unknown"],"example":"american_express","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.card.brand","typeLabel":"enum\u003cstring>"},"country":{"description":"Two-letter ISO code for the card's country.","type":"string","example":"US","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.card.country","typeLabel":"string"},"exp_month":{"description":"The card's expiration month.","type":"integer","format":"int32","example":12,"minimum":-128,"maximum":127,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.card.exp_month","typeLabel":"integer\u003cint32>"},"exp_year":{"description":"The card's expiration year.","type":"integer","format":"int32","example":2027,"minimum":-2147483648,"maximum":2147483647,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.card.exp_year","typeLabel":"integer\u003cint32>"},"fingerprint":{"description":"Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card.","type":"string","example":"abc123","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.card.fingerprint","typeLabel":"string"},"funding":{"description":"The funding type of the card.","type":"string","enum":["credit","debit","hsa_fsa","prepaid","unknown"],"example":"credit","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.card.funding","typeLabel":"enum\u003cstring>"},"last4":{"description":"The last four digits of the card.","type":"string","example":"4242","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.card.last4","typeLabel":"string"}},"example":{"brand":"american_express","country":"US","exp_month":12,"exp_year":2027,"fingerprint":"abc123","funding":"credit","last4":"4242"},"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.card","typeLabel":"object"},"created_at":{"description":"Time at which the object was created. ISO 8601 format.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.created_at","typeLabel":"string"},"test_mode":{"description":"Whether this PaymentMethod is in test mode.","type":"boolean","example":false,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.test_mode","typeLabel":"boolean"},"off_session":{"description":"Whether this PaymentMethod is valid for off_session (customer not present) purchase flows.","type":"boolean","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.off_session","typeLabel":"boolean"},"metadata":{"oneOf":[{"description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","type":"object","additionalProperties":{"type":"object","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.metadata.oneOf.0.additionalProperties","typeLabel":"object"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.metadata.oneOf.0","typeLabel":"object"},{"description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","type":"null","additionalProperties":{"type":"object","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.metadata.oneOf.1.additionalProperties","typeLabel":"object"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1.metadata","typeLabel":"object | null"}},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.1","typeLabel":"object"},{"type":"null","description":"The payment method associated with the payment intent.","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method.oneOf.2","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_method","typeLabel":"string | object | null"},"transfer_group":{"oneOf":[{"description":"A string that identifies the resulting payment as part of a group","type":"string","example":"example_value","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.transfer_group.oneOf.0","typeLabel":"string"},{"description":"A string that identifies the resulting payment as part of a group","type":"null","example":"example_value","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.transfer_group.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.transfer_group","typeLabel":"string | null"},"payment_card_type":{"oneOf":[{"type":"string","description":"The primary card type used for this payment intent","enum":["primary","secondary"],"x-ms-enum":{"name":"PaymentCardType","modelAsString":false,"values":[{"value":"primary","name":"Primary","description":"In a split cart, `Primary` refers to the HSA/FSA eligible card. In a single cart (whether it's HSA/FSA or a fully ineligible cart), `Primary` refers to the only payment card used."},{"value":"secondary","name":"Secondary","description":"In a split cart and partial authorization payment, `Secondary` refers to the non-eligible or backup credit card used for ineligible items."}]},"example":"primary","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_card_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The primary card type used for this payment intent","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_card_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.payment_card_type","typeLabel":"enum\u003cstring> | null"},"letter_fee_amount":{"oneOf":[{"description":"Letter fee portion of application_fee_amount (waterfall allocation to HSA/FSA)","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.letter_fee_amount.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"Letter fee portion of application_fee_amount (waterfall allocation to HSA/FSA)","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.letter_fee_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.letter_fee_amount","typeLabel":"integer\u003cint32> | null"},"transaction_fee":{"oneOf":[{"description":"Transaction fee portion of application_fee_amount (percentage + fixed fee)","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.transaction_fee.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"Transaction fee portion of application_fee_amount (percentage + fixed fee)","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.transaction_fee.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.transaction_fee","typeLabel":"integer\u003cint32> | null"},"last_payment_error":{"oneOf":[{"type":"object","description":"The error from the most recent failed payment attempt, if any.","required":["type"],"example":{"type":"string","code":"string","decline_code":"string","message":"string","payment_method":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},"properties":{"type":{"description":"The type of error (card, invalid_request, api, etc.)","type":"string","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.last_payment_error.oneOf.0.type","typeLabel":"string"},"code":{"oneOf":[{"description":"Machine-readable error code (card_declined, expired_card, etc.)","type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.last_payment_error.oneOf.0.code.oneOf.0","typeLabel":"string"},{"description":"Machine-readable error code (card_declined, expired_card, etc.)","type":"null","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.last_payment_error.oneOf.0.code.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.last_payment_error.oneOf.0.code","typeLabel":"string | null"},"decline_code":{"oneOf":[{"description":"Card-specific decline code (insufficient_funds, lost_card, etc.)","type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.last_payment_error.oneOf.0.decline_code.oneOf.0","typeLabel":"string"},{"description":"Card-specific decline code (insufficient_funds, lost_card, etc.)","type":"null","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.last_payment_error.oneOf.0.decline_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.last_payment_error.oneOf.0.decline_code","typeLabel":"string | null"},"message":{"oneOf":[{"description":"Human-readable error description.","type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.last_payment_error.oneOf.0.message.oneOf.0","typeLabel":"string"},{"description":"Human-readable error description.","type":"null","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.last_payment_error.oneOf.0.message.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.last_payment_error.oneOf.0.message","typeLabel":"string | null"},"payment_method":{"oneOf":[{"description":"The Flex payment method ID that failed.","type":"string","example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.last_payment_error.oneOf.0.payment_method.oneOf.0","typeLabel":"string"},{"description":"The Flex payment method ID that failed.","type":"null","example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.last_payment_error.oneOf.0.payment_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.last_payment_error.oneOf.0.payment_method","typeLabel":"string | null"}},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.last_payment_error.oneOf.0","typeLabel":"object"},{"type":"null","description":"The error from the most recent failed payment attempt, if any.","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.last_payment_error.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1.last_payment_error","typeLabel":"object | null"}},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.1","typeLabel":"object"},{"type":"null","description":"The payment intent associated with this invoice. The payment intent is created when the invoice is finalized.","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent.oneOf.2","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.payment_intent","typeLabel":"string | object | null"},"charge":{"oneOf":[{"description":"The id of the latest charge for this invoice.","type":"string","example":"fch_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.charge.oneOf.0","typeLabel":"string"},{"description":"The id of the latest charge for this invoice.","type":"null","example":"fch_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.charge.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.charge","typeLabel":"string | null"},"customer":{"oneOf":[{"type":"string","description":"The id of the customer this invoice is for.","example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.0","typeLabel":"string"},{"type":"object","description":"The id of the customer this invoice is for.","required":["created_at","customer_id","email","first_name","last_name","test_mode"],"example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"customer_id":{"description":"The unique identifier for the customer.","type":"string","example":"fcus_01HACM7FZ1084XB1GB6053VM0D","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.customer_id","typeLabel":"string"},"first_name":{"description":"The customer's first name.","type":"string","example":"John","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.first_name","typeLabel":"string"},"last_name":{"description":"The customer's last name.","type":"string","example":"Doe","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.last_name","typeLabel":"string"},"email":{"description":"The customer's email address.","type":"string","example":"joh.doe@example.com","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.email","typeLabel":"string"},"created_at":{"description":"The time the customer was created.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.created_at","typeLabel":"string"},"test_mode":{"description":"Whether the customer was created in test mode.","type":"boolean","example":false,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.test_mode","typeLabel":"boolean"},"owner_partner_id":{"oneOf":[{"description":"The partner that owns this customer. When a customer is shared with you by another partner in your organization, this is that sibling partner; otherwise it is your own partner id.","type":"string","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.owner_partner_id.oneOf.0","typeLabel":"string"},{"description":"The partner that owns this customer. When a customer is shared with you by another partner in your organization, this is that sibling partner; otherwise it is your own partner id.","type":"null","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.owner_partner_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.owner_partner_id","typeLabel":"string | null"},"phone":{"oneOf":[{"description":"The customer's phone number.","type":"string","format":"phone","example":"+15555555555","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.phone.oneOf.0","typeLabel":"string\u003cphone>"},{"description":"The customer's phone number.","type":"null","format":"phone","example":"+15555555555","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.phone","typeLabel":"string\u003cphone> | null"},"employer":{"oneOf":[{"description":"The customer's employer.","type":"string","example":"Flex","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.employer.oneOf.0","typeLabel":"string"},{"description":"The customer's employer.","type":"null","example":"Flex","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.employer.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.employer","typeLabel":"string | null"},"shipping":{"oneOf":[{"type":"object","description":"The customer's shipping address.","required":["shipping_address_id"],"example":{"shipping_address_id":"fsh_01J9XR8M3K7VZ8N2YB4WJ6T0RA","line1":"123 Main St","line2":"Suite 100","city":"San Francisco","state":"CA","postal_code":"94107","country":"US"},"properties":{"shipping_address_id":{"description":"Unique identifier for the shipping address.","type":"string","example":"fsh_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.shipping.oneOf.0.shipping_address_id","typeLabel":"string"},"line1":{"oneOf":[{"description":"The first line of the street address (e.g., street number and name).","type":"string","example":"123 Main St","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.shipping.oneOf.0.line1.oneOf.0","typeLabel":"string"},{"description":"The first line of the street address (e.g., street number and name).","type":"null","example":"123 Main St","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.shipping.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.shipping.oneOf.0.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"description":"The second line of the street address (e.g., apartment, suite, or unit).","type":"string","example":"Suite 100","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.shipping.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"description":"The second line of the street address (e.g., apartment, suite, or unit).","type":"null","example":"Suite 100","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.shipping.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.shipping.oneOf.0.line2","typeLabel":"string | null"},"city":{"oneOf":[{"description":"City, district, suburb, town, or village.","type":"string","example":"San Francisco","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.shipping.oneOf.0.city.oneOf.0","typeLabel":"string"},{"description":"City, district, suburb, town, or village.","type":"null","example":"San Francisco","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.shipping.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.shipping.oneOf.0.city","typeLabel":"string | null"},"state":{"oneOf":[{"description":"State, county, province, or region.","type":"string","example":"CA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.shipping.oneOf.0.state.oneOf.0","typeLabel":"string"},{"description":"State, county, province, or region.","type":"null","example":"CA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.shipping.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.shipping.oneOf.0.state","typeLabel":"string | null"},"postal_code":{"oneOf":[{"description":"ZIP or postal code.","type":"string","example":"94107","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.shipping.oneOf.0.postal_code.oneOf.0","typeLabel":"string"},{"description":"ZIP or postal code.","type":"null","example":"94107","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.shipping.oneOf.0.postal_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.shipping.oneOf.0.postal_code","typeLabel":"string | null"},"country":{"oneOf":[{"description":"Two-letter country code (ISO 3166-1 alpha-2, e.g., `US`).","type":"string","example":"US","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.shipping.oneOf.0.country.oneOf.0","typeLabel":"string"},{"description":"Two-letter country code (ISO 3166-1 alpha-2, e.g., `US`).","type":"null","example":"US","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.shipping.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.shipping.oneOf.0.country","typeLabel":"string | null"}},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.shipping.oneOf.0","typeLabel":"object"},{"type":"null","description":"The customer's shipping address.","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.shipping.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.shipping","typeLabel":"object | null"},"metadata":{"oneOf":[{"description":"Metadata associated with the customer.","type":"object","additionalProperties":{"type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.metadata.oneOf.0.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.metadata.oneOf.0","typeLabel":"object"},{"description":"Metadata associated with the customer.","type":"null","additionalProperties":{"type":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.metadata.oneOf.1.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1.metadata","typeLabel":"object | null"}},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.1","typeLabel":"object"},{"type":"null","description":"The id of the customer this invoice is for.","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer.oneOf.2","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.customer","typeLabel":"string | object | null"},"period_end":{"oneOf":[{"type":"string","description":"End of the usage period.","example":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.period_end.oneOf.0","typeLabel":"string"},{"type":"null","description":"End of the usage period.","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.period_end.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.period_end","typeLabel":"string | null"},"period_start":{"oneOf":[{"type":"string","description":"Start of the usage period.","example":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.period_start.oneOf.0","typeLabel":"string"},{"type":"null","description":"Start of the usage period.","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.period_start.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.period_start","typeLabel":"string | null"},"subscription":{"oneOf":[{"type":"string","description":"The subscription that this invoice was prepared for.","example":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.subscription.oneOf.0","typeLabel":"string"},{"description":"The subscription that this invoice was prepared for.","example":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.subscription.oneOf.1","typeLabel":"any"},{"type":"null","description":"The subscription that this invoice was prepared for.","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.subscription.oneOf.2","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.subscription","typeLabel":"string | any | null"},"paid_at":{"oneOf":[{"type":"string","description":"When the invoice was paid.","example":"string","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.paid_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the invoice was paid.","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.paid_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.paid_at","typeLabel":"string | null"},"metadata":{"oneOf":[{"description":"Metadata associated with the invoice.","type":"object","example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.metadata.oneOf.0","typeLabel":"object"},{"description":"Metadata associated with the invoice.","type":"null","example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.metadata","typeLabel":"object | null"},"backup_charge_status":{"oneOf":[{"type":"string","description":"Outcome of the backup-payment-method fallback for this invoice. Omitted when no fallback applied. `succeeded` on a paid invoice means the subscription's backup card covered this renewal after the default payment method failed.","enum":["pending","succeeded","failed","skipped"],"example":"pending","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.backup_charge_status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Outcome of the backup-payment-method fallback for this invoice. Omitted when no fallback applied. `succeeded` on a paid invoice means the subscription's backup card covered this renewal after the default payment method failed.","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.backup_charge_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1.backup_charge_status","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.1","typeLabel":"object"},{"type":"null","description":"The ID of the latest invoice generated for this subscription.","uniqueKey":"subscriptions.items.[INDEX].latest_invoice.oneOf.2","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].latest_invoice","typeLabel":"string | object | null"},"customer":{"oneOf":[{"type":"string","description":"The ID of the customer who owns the subscription.","example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.0","typeLabel":"string"},{"type":"object","description":"The ID of the customer who owns the subscription.","required":["created_at","customer_id","email","first_name","last_name","test_mode"],"example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"customer_id":{"description":"The unique identifier for the customer.","type":"string","example":"fcus_01HACM7FZ1084XB1GB6053VM0D","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.customer_id","typeLabel":"string"},"first_name":{"description":"The customer's first name.","type":"string","example":"John","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.first_name","typeLabel":"string"},"last_name":{"description":"The customer's last name.","type":"string","example":"Doe","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.last_name","typeLabel":"string"},"email":{"description":"The customer's email address.","type":"string","example":"joh.doe@example.com","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.email","typeLabel":"string"},"created_at":{"description":"The time the customer was created.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.created_at","typeLabel":"string"},"test_mode":{"description":"Whether the customer was created in test mode.","type":"boolean","example":false,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.test_mode","typeLabel":"boolean"},"owner_partner_id":{"oneOf":[{"description":"The partner that owns this customer. When a customer is shared with you by another partner in your organization, this is that sibling partner; otherwise it is your own partner id.","type":"string","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.owner_partner_id.oneOf.0","typeLabel":"string"},{"description":"The partner that owns this customer. When a customer is shared with you by another partner in your organization, this is that sibling partner; otherwise it is your own partner id.","type":"null","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.owner_partner_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.owner_partner_id","typeLabel":"string | null"},"phone":{"oneOf":[{"description":"The customer's phone number.","type":"string","format":"phone","example":"+15555555555","uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.phone.oneOf.0","typeLabel":"string\u003cphone>"},{"description":"The customer's phone number.","type":"null","format":"phone","example":"+15555555555","uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.phone","typeLabel":"string\u003cphone> | null"},"employer":{"oneOf":[{"description":"The customer's employer.","type":"string","example":"Flex","uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.employer.oneOf.0","typeLabel":"string"},{"description":"The customer's employer.","type":"null","example":"Flex","uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.employer.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.employer","typeLabel":"string | null"},"shipping":{"oneOf":[{"type":"object","description":"The customer's shipping address.","required":["shipping_address_id"],"example":{"shipping_address_id":"fsh_01J9XR8M3K7VZ8N2YB4WJ6T0RA","line1":"123 Main St","line2":"Suite 100","city":"San Francisco","state":"CA","postal_code":"94107","country":"US"},"properties":{"shipping_address_id":{"description":"Unique identifier for the shipping address.","type":"string","example":"fsh_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.shipping.oneOf.0.shipping_address_id","typeLabel":"string"},"line1":{"oneOf":[{"description":"The first line of the street address (e.g., street number and name).","type":"string","example":"123 Main St","uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.shipping.oneOf.0.line1.oneOf.0","typeLabel":"string"},{"description":"The first line of the street address (e.g., street number and name).","type":"null","example":"123 Main St","uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.shipping.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.shipping.oneOf.0.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"description":"The second line of the street address (e.g., apartment, suite, or unit).","type":"string","example":"Suite 100","uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.shipping.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"description":"The second line of the street address (e.g., apartment, suite, or unit).","type":"null","example":"Suite 100","uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.shipping.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.shipping.oneOf.0.line2","typeLabel":"string | null"},"city":{"oneOf":[{"description":"City, district, suburb, town, or village.","type":"string","example":"San Francisco","uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.shipping.oneOf.0.city.oneOf.0","typeLabel":"string"},{"description":"City, district, suburb, town, or village.","type":"null","example":"San Francisco","uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.shipping.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.shipping.oneOf.0.city","typeLabel":"string | null"},"state":{"oneOf":[{"description":"State, county, province, or region.","type":"string","example":"CA","uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.shipping.oneOf.0.state.oneOf.0","typeLabel":"string"},{"description":"State, county, province, or region.","type":"null","example":"CA","uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.shipping.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.shipping.oneOf.0.state","typeLabel":"string | null"},"postal_code":{"oneOf":[{"description":"ZIP or postal code.","type":"string","example":"94107","uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.shipping.oneOf.0.postal_code.oneOf.0","typeLabel":"string"},{"description":"ZIP or postal code.","type":"null","example":"94107","uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.shipping.oneOf.0.postal_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.shipping.oneOf.0.postal_code","typeLabel":"string | null"},"country":{"oneOf":[{"description":"Two-letter country code (ISO 3166-1 alpha-2, e.g., `US`).","type":"string","example":"US","uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.shipping.oneOf.0.country.oneOf.0","typeLabel":"string"},{"description":"Two-letter country code (ISO 3166-1 alpha-2, e.g., `US`).","type":"null","example":"US","uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.shipping.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.shipping.oneOf.0.country","typeLabel":"string | null"}},"uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.shipping.oneOf.0","typeLabel":"object"},{"type":"null","description":"The customer's shipping address.","uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.shipping.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.shipping","typeLabel":"object | null"},"metadata":{"oneOf":[{"description":"Metadata associated with the customer.","type":"object","additionalProperties":{"type":"string","uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.metadata.oneOf.0.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.metadata.oneOf.0","typeLabel":"object"},{"description":"Metadata associated with the customer.","type":"null","additionalProperties":{"type":"string","uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.metadata.oneOf.1.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1.metadata","typeLabel":"object | null"}},"uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.1","typeLabel":"object"},{"type":"null","description":"The ID of the customer who owns the subscription.","uniqueKey":"subscriptions.items.[INDEX].customer.oneOf.2","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].customer","typeLabel":"string | object | null"},"current_period_end":{"oneOf":[{"type":"string","description":"End of the current period that the subscription has been invoiced for.","example":"string","uniqueKey":"subscriptions.items.[INDEX].current_period_end.oneOf.0","typeLabel":"string"},{"type":"null","description":"End of the current period that the subscription has been invoiced for.","uniqueKey":"subscriptions.items.[INDEX].current_period_end.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].current_period_end","typeLabel":"string | null"},"current_period_start":{"oneOf":[{"type":"string","description":"Start of the current period that the subscription has been invoiced for.","example":"string","uniqueKey":"subscriptions.items.[INDEX].current_period_start.oneOf.0","typeLabel":"string"},{"type":"null","description":"Start of the current period that the subscription has been invoiced for.","uniqueKey":"subscriptions.items.[INDEX].current_period_start.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].current_period_start","typeLabel":"string | null"},"metadata":{"oneOf":[{"description":"A set of key/value pairs that you can attach to a subscription object.","type":"object","example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].metadata.oneOf.0","typeLabel":"object"},{"description":"A set of key/value pairs that you can attach to a subscription object.","type":"null","example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].metadata","typeLabel":"object | null"},"client_secret":{"oneOf":[{"type":"object","description":"Client secrets used to confirm the subscription's first payment or payment-method setup from your frontend. Present only while the subscription is being activated; omitted otherwise. Do not log or store these secrets; expose them only to the customer over TLS.","example":{"setup_secret":"string","payment_secret":"string"},"properties":{"setup_secret":{"oneOf":[{"description":"Client secret of the SetupIntent used to collect and save a payment method for the subscription (for example, during a trial with no immediate charge). `null` when no setup is required. Do not log or store it; expose only to the customer over TLS.","type":"string","uniqueKey":"subscriptions.items.[INDEX].client_secret.oneOf.0.setup_secret.oneOf.0","typeLabel":"string"},{"description":"Client secret of the SetupIntent used to collect and save a payment method for the subscription (for example, during a trial with no immediate charge). `null` when no setup is required. Do not log or store it; expose only to the customer over TLS.","type":"null","uniqueKey":"subscriptions.items.[INDEX].client_secret.oneOf.0.setup_secret.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].client_secret.oneOf.0.setup_secret","typeLabel":"string | null"},"payment_secret":{"oneOf":[{"description":"Client secret of the PaymentIntent used to confirm the subscription's first payment from your frontend. `null` when no immediate payment is required. Do not log or store it; expose only to the customer over TLS.","type":"string","uniqueKey":"subscriptions.items.[INDEX].client_secret.oneOf.0.payment_secret.oneOf.0","typeLabel":"string"},{"description":"Client secret of the PaymentIntent used to confirm the subscription's first payment from your frontend. `null` when no immediate payment is required. Do not log or store it; expose only to the customer over TLS.","type":"null","uniqueKey":"subscriptions.items.[INDEX].client_secret.oneOf.0.payment_secret.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].client_secret.oneOf.0.payment_secret","typeLabel":"string | null"}},"uniqueKey":"subscriptions.items.[INDEX].client_secret.oneOf.0","typeLabel":"object"},{"type":"null","description":"Client secrets used to confirm the subscription's first payment or payment-method setup from your frontend. Present only while the subscription is being activated; omitted otherwise. Do not log or store these secrets; expose them only to the customer over TLS.","uniqueKey":"subscriptions.items.[INDEX].client_secret.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].client_secret","typeLabel":"object | null"},"proration_behavior":{"oneOf":[{"type":"string","description":"The proration behavior for the subscription.","enum":["always_invoice","create_prorations","none"],"example":"always_invoice","uniqueKey":"subscriptions.items.[INDEX].proration_behavior.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The proration behavior for the subscription.","uniqueKey":"subscriptions.items.[INDEX].proration_behavior.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].proration_behavior","typeLabel":"enum\u003cstring> | null"},"trial_start":{"oneOf":[{"type":"string","description":"Start of the subscription's trial period, as an RFC 3339 timestamp. `null` if the subscription has no trial.","example":"string","uniqueKey":"subscriptions.items.[INDEX].trial_start.oneOf.0","typeLabel":"string"},{"type":"null","description":"Start of the subscription's trial period, as an RFC 3339 timestamp. `null` if the subscription has no trial.","uniqueKey":"subscriptions.items.[INDEX].trial_start.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].trial_start","typeLabel":"string | null"},"trial_end":{"oneOf":[{"type":"string","description":"End of the subscription's trial period, as an RFC 3339 timestamp. After this time the customer is billed normally. `null` if the subscription has no trial.","example":"string","uniqueKey":"subscriptions.items.[INDEX].trial_end.oneOf.0","typeLabel":"string"},{"type":"null","description":"End of the subscription's trial period, as an RFC 3339 timestamp. After this time the customer is billed normally. `null` if the subscription has no trial.","uniqueKey":"subscriptions.items.[INDEX].trial_end.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].trial_end","typeLabel":"string | null"},"cancel_at":{"oneOf":[{"type":"string","description":"A future RFC 3339 timestamp at which the subscription will automatically be canceled. `null` unless a future cancellation has been scheduled.","example":"2026-06-15T14:30:00Z","uniqueKey":"subscriptions.items.[INDEX].cancel_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"A future RFC 3339 timestamp at which the subscription will automatically be canceled. `null` unless a future cancellation has been scheduled.","example":"2026-06-15T14:30:00Z","uniqueKey":"subscriptions.items.[INDEX].cancel_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].cancel_at","typeLabel":"string | null"},"canceled_at":{"oneOf":[{"type":"string","description":"The RFC 3339 timestamp at which the subscription was actually canceled. `null` if the subscription has not been canceled. Unlike `cancel_at` (a future scheduled cancellation), this is set once the cancellation has occurred.","example":"2026-06-15T14:30:00Z","uniqueKey":"subscriptions.items.[INDEX].canceled_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"The RFC 3339 timestamp at which the subscription was actually canceled. `null` if the subscription has not been canceled. Unlike `cancel_at` (a future scheduled cancellation), this is set once the cancellation has occurred.","example":"2026-06-15T14:30:00Z","uniqueKey":"subscriptions.items.[INDEX].canceled_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].canceled_at","typeLabel":"string | null"},"default_payment_method":{"oneOf":[{"type":"string","description":"The default payment method for the subscription (expandable).","example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.0","typeLabel":"string"},{"type":"object","description":"The default payment method for the subscription (expandable).","required":["billing_details","card","created_at","customer","off_session","payment_method_id","test_mode"],"example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"payment_method_id":{"description":"The ID of the PaymentMethod.","type":"string","example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.payment_method_id","typeLabel":"string"},"billing_details":{"description":"Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.","type":"object","properties":{"address":{"oneOf":[{"type":"object","description":"The billing address.","example":{"city":"San Francisco","country":"US","line1":"123 Main St","line2":"Suite 100","postal_code":"94107","state":"CA"},"properties":{"city":{"oneOf":[{"description":"City, district, suburb, town, or village.","type":"string","example":"San Francisco","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.billing_details.address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"description":"City, district, suburb, town, or village.","type":"null","example":"San Francisco","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.billing_details.address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.billing_details.address.oneOf.0.city","typeLabel":"string | null"},"country":{"oneOf":[{"description":"Two-letter ISO country code (e.g., `US`).","type":"string","example":"US","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.billing_details.address.oneOf.0.country.oneOf.0","typeLabel":"string"},{"description":"Two-letter ISO country code (e.g., `US`).","type":"null","example":"US","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.billing_details.address.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.billing_details.address.oneOf.0.country","typeLabel":"string | null"},"line1":{"oneOf":[{"description":"Address line 1, such as the street, PO box, or company name.","type":"string","example":"123 Main St","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.billing_details.address.oneOf.0.line1.oneOf.0","typeLabel":"string"},{"description":"Address line 1, such as the street, PO box, or company name.","type":"null","example":"123 Main St","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.billing_details.address.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.billing_details.address.oneOf.0.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"description":"Address line 2, such as the apartment, suite, unit, or building.","type":"string","example":"Suite 100","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.billing_details.address.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"description":"Address line 2, such as the apartment, suite, unit, or building.","type":"null","example":"Suite 100","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.billing_details.address.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.billing_details.address.oneOf.0.line2","typeLabel":"string | null"},"postal_code":{"oneOf":[{"description":"ZIP or postal code.","type":"string","example":"94107","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.billing_details.address.oneOf.0.postal_code.oneOf.0","typeLabel":"string"},{"description":"ZIP or postal code.","type":"null","example":"94107","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.billing_details.address.oneOf.0.postal_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.billing_details.address.oneOf.0.postal_code","typeLabel":"string | null"},"state":{"oneOf":[{"description":"State, county, province, or region.","type":"string","example":"CA","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.billing_details.address.oneOf.0.state.oneOf.0","typeLabel":"string"},{"description":"State, county, province, or region.","type":"null","example":"CA","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.billing_details.address.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.billing_details.address.oneOf.0.state","typeLabel":"string | null"}},"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.billing_details.address.oneOf.0","typeLabel":"object"},{"type":"null","description":"The billing address.","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.billing_details.address.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.billing_details.address","typeLabel":"object | null"},"email":{"oneOf":[{"description":"The billing email address.","type":"string","example":"john.doe@example.com","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.billing_details.email.oneOf.0","typeLabel":"string"},{"description":"The billing email address.","type":"null","example":"john.doe@example.com","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.billing_details.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.billing_details.email","typeLabel":"string | null"},"name":{"oneOf":[{"description":"The billing name.","type":"string","example":"Example","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.billing_details.name.oneOf.0","typeLabel":"string"},{"description":"The billing name.","type":"null","example":"Example","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.billing_details.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.billing_details.name","typeLabel":"string | null"},"phone":{"oneOf":[{"description":"The billing phone number.","type":"string","example":"+14155550142","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.billing_details.phone.oneOf.0","typeLabel":"string"},{"description":"The billing phone number.","type":"null","example":"+14155550142","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.billing_details.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.billing_details.phone","typeLabel":"string | null"}},"example":{"address":{"city":"San Francisco","country":"US","line1":"123 Main St","line2":"Suite 100","postal_code":"94107","state":"CA"},"email":"john.doe@example.com","name":"Example","phone":"+14155550142"},"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.billing_details","typeLabel":"object"},"customer":{"oneOf":[{"type":"string","description":"The customer this payment method is attached to. Returned as the customer ID by default; expandable to the full Customer object.","example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.0","typeLabel":"string"},{"type":"object","description":"The customer this payment method is attached to. Returned as the customer ID by default; expandable to the full Customer object.","required":["created_at","customer_id","email","first_name","last_name","test_mode"],"example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"customer_id":{"description":"The unique identifier for the customer.","type":"string","example":"fcus_01HACM7FZ1084XB1GB6053VM0D","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.customer_id","typeLabel":"string"},"first_name":{"description":"The customer's first name.","type":"string","example":"John","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.first_name","typeLabel":"string"},"last_name":{"description":"The customer's last name.","type":"string","example":"Doe","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.last_name","typeLabel":"string"},"email":{"description":"The customer's email address.","type":"string","example":"joh.doe@example.com","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.email","typeLabel":"string"},"created_at":{"description":"The time the customer was created.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.created_at","typeLabel":"string"},"test_mode":{"description":"Whether the customer was created in test mode.","type":"boolean","example":false,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.test_mode","typeLabel":"boolean"},"owner_partner_id":{"oneOf":[{"description":"The partner that owns this customer. When a customer is shared with you by another partner in your organization, this is that sibling partner; otherwise it is your own partner id.","type":"string","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.owner_partner_id.oneOf.0","typeLabel":"string"},{"description":"The partner that owns this customer. When a customer is shared with you by another partner in your organization, this is that sibling partner; otherwise it is your own partner id.","type":"null","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.owner_partner_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.owner_partner_id","typeLabel":"string | null"},"phone":{"oneOf":[{"description":"The customer's phone number.","type":"string","format":"phone","example":"+15555555555","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.phone.oneOf.0","typeLabel":"string\u003cphone>"},{"description":"The customer's phone number.","type":"null","format":"phone","example":"+15555555555","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.phone","typeLabel":"string\u003cphone> | null"},"employer":{"oneOf":[{"description":"The customer's employer.","type":"string","example":"Flex","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.employer.oneOf.0","typeLabel":"string"},{"description":"The customer's employer.","type":"null","example":"Flex","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.employer.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.employer","typeLabel":"string | null"},"shipping":{"oneOf":[{"type":"object","description":"The customer's shipping address.","required":["shipping_address_id"],"example":{"shipping_address_id":"fsh_01J9XR8M3K7VZ8N2YB4WJ6T0RA","line1":"123 Main St","line2":"Suite 100","city":"San Francisco","state":"CA","postal_code":"94107","country":"US"},"properties":{"shipping_address_id":{"description":"Unique identifier for the shipping address.","type":"string","example":"fsh_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.shipping_address_id","typeLabel":"string"},"line1":{"oneOf":[{"description":"The first line of the street address (e.g., street number and name).","type":"string","example":"123 Main St","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.line1.oneOf.0","typeLabel":"string"},{"description":"The first line of the street address (e.g., street number and name).","type":"null","example":"123 Main St","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"description":"The second line of the street address (e.g., apartment, suite, or unit).","type":"string","example":"Suite 100","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"description":"The second line of the street address (e.g., apartment, suite, or unit).","type":"null","example":"Suite 100","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.line2","typeLabel":"string | null"},"city":{"oneOf":[{"description":"City, district, suburb, town, or village.","type":"string","example":"San Francisco","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.city.oneOf.0","typeLabel":"string"},{"description":"City, district, suburb, town, or village.","type":"null","example":"San Francisco","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.city","typeLabel":"string | null"},"state":{"oneOf":[{"description":"State, county, province, or region.","type":"string","example":"CA","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.state.oneOf.0","typeLabel":"string"},{"description":"State, county, province, or region.","type":"null","example":"CA","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.state","typeLabel":"string | null"},"postal_code":{"oneOf":[{"description":"ZIP or postal code.","type":"string","example":"94107","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.postal_code.oneOf.0","typeLabel":"string"},{"description":"ZIP or postal code.","type":"null","example":"94107","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.postal_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.postal_code","typeLabel":"string | null"},"country":{"oneOf":[{"description":"Two-letter country code (ISO 3166-1 alpha-2, e.g., `US`).","type":"string","example":"US","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.country.oneOf.0","typeLabel":"string"},{"description":"Two-letter country code (ISO 3166-1 alpha-2, e.g., `US`).","type":"null","example":"US","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.country","typeLabel":"string | null"}},"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0","typeLabel":"object"},{"type":"null","description":"The customer's shipping address.","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.shipping","typeLabel":"object | null"},"metadata":{"oneOf":[{"description":"Metadata associated with the customer.","type":"object","additionalProperties":{"type":"string","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.metadata.oneOf.0.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.metadata.oneOf.0","typeLabel":"object"},{"description":"Metadata associated with the customer.","type":"null","additionalProperties":{"type":"string","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.metadata.oneOf.1.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1.metadata","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.customer","typeLabel":"string | object"},"card":{"description":"User card details.","type":"object","required":["brand","country","exp_month","exp_year","fingerprint","funding","last4"],"properties":{"brand":{"description":"The brand of the card.","type":"string","enum":["american_express","diners_club","discover","eftpos_au","JCB","master_card","union_pay","visa","unknown"],"example":"american_express","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.card.brand","typeLabel":"enum\u003cstring>"},"country":{"description":"Two-letter ISO code for the card's country.","type":"string","example":"US","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.card.country","typeLabel":"string"},"exp_month":{"description":"The card's expiration month.","type":"integer","format":"int32","example":12,"minimum":-128,"maximum":127,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.card.exp_month","typeLabel":"integer\u003cint32>"},"exp_year":{"description":"The card's expiration year.","type":"integer","format":"int32","example":2027,"minimum":-2147483648,"maximum":2147483647,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.card.exp_year","typeLabel":"integer\u003cint32>"},"fingerprint":{"description":"Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card.","type":"string","example":"abc123","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.card.fingerprint","typeLabel":"string"},"funding":{"description":"The funding type of the card.","type":"string","enum":["credit","debit","hsa_fsa","prepaid","unknown"],"example":"credit","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.card.funding","typeLabel":"enum\u003cstring>"},"last4":{"description":"The last four digits of the card.","type":"string","example":"4242","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.card.last4","typeLabel":"string"}},"example":{"brand":"american_express","country":"US","exp_month":12,"exp_year":2027,"fingerprint":"abc123","funding":"credit","last4":"4242"},"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.card","typeLabel":"object"},"created_at":{"description":"Time at which the object was created. ISO 8601 format.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.created_at","typeLabel":"string"},"test_mode":{"description":"Whether this PaymentMethod is in test mode.","type":"boolean","example":false,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.test_mode","typeLabel":"boolean"},"off_session":{"description":"Whether this PaymentMethod is valid for off_session (customer not present) purchase flows.","type":"boolean","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.off_session","typeLabel":"boolean"},"metadata":{"oneOf":[{"description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","type":"object","additionalProperties":{"type":"object","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.metadata.oneOf.0.additionalProperties","typeLabel":"object"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.metadata.oneOf.0","typeLabel":"object"},{"description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","type":"null","additionalProperties":{"type":"object","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.metadata.oneOf.1.additionalProperties","typeLabel":"object"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1.metadata","typeLabel":"object | null"}},"uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.1","typeLabel":"object"},{"type":"null","description":"The default payment method for the subscription (expandable).","uniqueKey":"subscriptions.items.[INDEX].default_payment_method.oneOf.2","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].default_payment_method","typeLabel":"string | object | null"},"backup_payment_method":{"oneOf":[{"type":"string","description":"The payment method charged when the default one fails (expandable). Omitted when the subscription has no backup.","example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.0","typeLabel":"string"},{"type":"object","description":"The payment method charged when the default one fails (expandable). Omitted when the subscription has no backup.","required":["billing_details","card","created_at","customer","off_session","payment_method_id","test_mode"],"example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"payment_method_id":{"description":"The ID of the PaymentMethod.","type":"string","example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.payment_method_id","typeLabel":"string"},"billing_details":{"description":"Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.","type":"object","properties":{"address":{"oneOf":[{"type":"object","description":"The billing address.","example":{"city":"San Francisco","country":"US","line1":"123 Main St","line2":"Suite 100","postal_code":"94107","state":"CA"},"properties":{"city":{"oneOf":[{"description":"City, district, suburb, town, or village.","type":"string","example":"San Francisco","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.billing_details.address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"description":"City, district, suburb, town, or village.","type":"null","example":"San Francisco","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.billing_details.address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.billing_details.address.oneOf.0.city","typeLabel":"string | null"},"country":{"oneOf":[{"description":"Two-letter ISO country code (e.g., `US`).","type":"string","example":"US","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.billing_details.address.oneOf.0.country.oneOf.0","typeLabel":"string"},{"description":"Two-letter ISO country code (e.g., `US`).","type":"null","example":"US","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.billing_details.address.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.billing_details.address.oneOf.0.country","typeLabel":"string | null"},"line1":{"oneOf":[{"description":"Address line 1, such as the street, PO box, or company name.","type":"string","example":"123 Main St","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.billing_details.address.oneOf.0.line1.oneOf.0","typeLabel":"string"},{"description":"Address line 1, such as the street, PO box, or company name.","type":"null","example":"123 Main St","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.billing_details.address.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.billing_details.address.oneOf.0.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"description":"Address line 2, such as the apartment, suite, unit, or building.","type":"string","example":"Suite 100","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.billing_details.address.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"description":"Address line 2, such as the apartment, suite, unit, or building.","type":"null","example":"Suite 100","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.billing_details.address.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.billing_details.address.oneOf.0.line2","typeLabel":"string | null"},"postal_code":{"oneOf":[{"description":"ZIP or postal code.","type":"string","example":"94107","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.billing_details.address.oneOf.0.postal_code.oneOf.0","typeLabel":"string"},{"description":"ZIP or postal code.","type":"null","example":"94107","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.billing_details.address.oneOf.0.postal_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.billing_details.address.oneOf.0.postal_code","typeLabel":"string | null"},"state":{"oneOf":[{"description":"State, county, province, or region.","type":"string","example":"CA","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.billing_details.address.oneOf.0.state.oneOf.0","typeLabel":"string"},{"description":"State, county, province, or region.","type":"null","example":"CA","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.billing_details.address.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.billing_details.address.oneOf.0.state","typeLabel":"string | null"}},"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.billing_details.address.oneOf.0","typeLabel":"object"},{"type":"null","description":"The billing address.","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.billing_details.address.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.billing_details.address","typeLabel":"object | null"},"email":{"oneOf":[{"description":"The billing email address.","type":"string","example":"john.doe@example.com","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.billing_details.email.oneOf.0","typeLabel":"string"},{"description":"The billing email address.","type":"null","example":"john.doe@example.com","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.billing_details.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.billing_details.email","typeLabel":"string | null"},"name":{"oneOf":[{"description":"The billing name.","type":"string","example":"Example","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.billing_details.name.oneOf.0","typeLabel":"string"},{"description":"The billing name.","type":"null","example":"Example","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.billing_details.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.billing_details.name","typeLabel":"string | null"},"phone":{"oneOf":[{"description":"The billing phone number.","type":"string","example":"+14155550142","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.billing_details.phone.oneOf.0","typeLabel":"string"},{"description":"The billing phone number.","type":"null","example":"+14155550142","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.billing_details.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.billing_details.phone","typeLabel":"string | null"}},"example":{"address":{"city":"San Francisco","country":"US","line1":"123 Main St","line2":"Suite 100","postal_code":"94107","state":"CA"},"email":"john.doe@example.com","name":"Example","phone":"+14155550142"},"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.billing_details","typeLabel":"object"},"customer":{"oneOf":[{"type":"string","description":"The customer this payment method is attached to. Returned as the customer ID by default; expandable to the full Customer object.","example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.0","typeLabel":"string"},{"type":"object","description":"The customer this payment method is attached to. Returned as the customer ID by default; expandable to the full Customer object.","required":["created_at","customer_id","email","first_name","last_name","test_mode"],"example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"customer_id":{"description":"The unique identifier for the customer.","type":"string","example":"fcus_01HACM7FZ1084XB1GB6053VM0D","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.customer_id","typeLabel":"string"},"first_name":{"description":"The customer's first name.","type":"string","example":"John","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.first_name","typeLabel":"string"},"last_name":{"description":"The customer's last name.","type":"string","example":"Doe","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.last_name","typeLabel":"string"},"email":{"description":"The customer's email address.","type":"string","example":"joh.doe@example.com","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.email","typeLabel":"string"},"created_at":{"description":"The time the customer was created.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.created_at","typeLabel":"string"},"test_mode":{"description":"Whether the customer was created in test mode.","type":"boolean","example":false,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.test_mode","typeLabel":"boolean"},"owner_partner_id":{"oneOf":[{"description":"The partner that owns this customer. When a customer is shared with you by another partner in your organization, this is that sibling partner; otherwise it is your own partner id.","type":"string","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.owner_partner_id.oneOf.0","typeLabel":"string"},{"description":"The partner that owns this customer. When a customer is shared with you by another partner in your organization, this is that sibling partner; otherwise it is your own partner id.","type":"null","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.owner_partner_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.owner_partner_id","typeLabel":"string | null"},"phone":{"oneOf":[{"description":"The customer's phone number.","type":"string","format":"phone","example":"+15555555555","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.phone.oneOf.0","typeLabel":"string\u003cphone>"},{"description":"The customer's phone number.","type":"null","format":"phone","example":"+15555555555","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.phone","typeLabel":"string\u003cphone> | null"},"employer":{"oneOf":[{"description":"The customer's employer.","type":"string","example":"Flex","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.employer.oneOf.0","typeLabel":"string"},{"description":"The customer's employer.","type":"null","example":"Flex","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.employer.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.employer","typeLabel":"string | null"},"shipping":{"oneOf":[{"type":"object","description":"The customer's shipping address.","required":["shipping_address_id"],"example":{"shipping_address_id":"fsh_01J9XR8M3K7VZ8N2YB4WJ6T0RA","line1":"123 Main St","line2":"Suite 100","city":"San Francisco","state":"CA","postal_code":"94107","country":"US"},"properties":{"shipping_address_id":{"description":"Unique identifier for the shipping address.","type":"string","example":"fsh_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.shipping_address_id","typeLabel":"string"},"line1":{"oneOf":[{"description":"The first line of the street address (e.g., street number and name).","type":"string","example":"123 Main St","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.line1.oneOf.0","typeLabel":"string"},{"description":"The first line of the street address (e.g., street number and name).","type":"null","example":"123 Main St","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"description":"The second line of the street address (e.g., apartment, suite, or unit).","type":"string","example":"Suite 100","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"description":"The second line of the street address (e.g., apartment, suite, or unit).","type":"null","example":"Suite 100","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.line2","typeLabel":"string | null"},"city":{"oneOf":[{"description":"City, district, suburb, town, or village.","type":"string","example":"San Francisco","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.city.oneOf.0","typeLabel":"string"},{"description":"City, district, suburb, town, or village.","type":"null","example":"San Francisco","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.city","typeLabel":"string | null"},"state":{"oneOf":[{"description":"State, county, province, or region.","type":"string","example":"CA","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.state.oneOf.0","typeLabel":"string"},{"description":"State, county, province, or region.","type":"null","example":"CA","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.state","typeLabel":"string | null"},"postal_code":{"oneOf":[{"description":"ZIP or postal code.","type":"string","example":"94107","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.postal_code.oneOf.0","typeLabel":"string"},{"description":"ZIP or postal code.","type":"null","example":"94107","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.postal_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.postal_code","typeLabel":"string | null"},"country":{"oneOf":[{"description":"Two-letter country code (ISO 3166-1 alpha-2, e.g., `US`).","type":"string","example":"US","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.country.oneOf.0","typeLabel":"string"},{"description":"Two-letter country code (ISO 3166-1 alpha-2, e.g., `US`).","type":"null","example":"US","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0.country","typeLabel":"string | null"}},"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.0","typeLabel":"object"},{"type":"null","description":"The customer's shipping address.","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.shipping.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.shipping","typeLabel":"object | null"},"metadata":{"oneOf":[{"description":"Metadata associated with the customer.","type":"object","additionalProperties":{"type":"string","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.metadata.oneOf.0.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.metadata.oneOf.0","typeLabel":"object"},{"description":"Metadata associated with the customer.","type":"null","additionalProperties":{"type":"string","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.metadata.oneOf.1.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1.metadata","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.customer","typeLabel":"string | object"},"card":{"description":"User card details.","type":"object","required":["brand","country","exp_month","exp_year","fingerprint","funding","last4"],"properties":{"brand":{"description":"The brand of the card.","type":"string","enum":["american_express","diners_club","discover","eftpos_au","JCB","master_card","union_pay","visa","unknown"],"example":"american_express","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.card.brand","typeLabel":"enum\u003cstring>"},"country":{"description":"Two-letter ISO code for the card's country.","type":"string","example":"US","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.card.country","typeLabel":"string"},"exp_month":{"description":"The card's expiration month.","type":"integer","format":"int32","example":12,"minimum":-128,"maximum":127,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.card.exp_month","typeLabel":"integer\u003cint32>"},"exp_year":{"description":"The card's expiration year.","type":"integer","format":"int32","example":2027,"minimum":-2147483648,"maximum":2147483647,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.card.exp_year","typeLabel":"integer\u003cint32>"},"fingerprint":{"description":"Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card.","type":"string","example":"abc123","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.card.fingerprint","typeLabel":"string"},"funding":{"description":"The funding type of the card.","type":"string","enum":["credit","debit","hsa_fsa","prepaid","unknown"],"example":"credit","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.card.funding","typeLabel":"enum\u003cstring>"},"last4":{"description":"The last four digits of the card.","type":"string","example":"4242","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.card.last4","typeLabel":"string"}},"example":{"brand":"american_express","country":"US","exp_month":12,"exp_year":2027,"fingerprint":"abc123","funding":"credit","last4":"4242"},"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.card","typeLabel":"object"},"created_at":{"description":"Time at which the object was created. ISO 8601 format.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.created_at","typeLabel":"string"},"test_mode":{"description":"Whether this PaymentMethod is in test mode.","type":"boolean","example":false,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.test_mode","typeLabel":"boolean"},"off_session":{"description":"Whether this PaymentMethod is valid for off_session (customer not present) purchase flows.","type":"boolean","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.off_session","typeLabel":"boolean"},"metadata":{"oneOf":[{"description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","type":"object","additionalProperties":{"type":"object","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.metadata.oneOf.0.additionalProperties","typeLabel":"object"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.metadata.oneOf.0","typeLabel":"object"},{"description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","type":"null","additionalProperties":{"type":"object","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.metadata.oneOf.1.additionalProperties","typeLabel":"object"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1.metadata","typeLabel":"object | null"}},"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.1","typeLabel":"object"},{"type":"null","description":"The payment method charged when the default one fails (expandable). Omitted when the subscription has no backup.","uniqueKey":"subscriptions.items.[INDEX].backup_payment_method.oneOf.2","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].backup_payment_method","typeLabel":"string | object | null"},"discounts":{"oneOf":[{"description":"The discounts applied to the subscription. Only present when `expand=discounts` is requested; omitted from the response otherwise. Usually 0–1 elements (Flex applies at most one coupon per subscription today), but modeled as an array for Stripe parity and future multi-discount support.\n\nFull `Discount` objects rather than `Expandable`: unlike the other expandable fields, `discounts` is populated only on `expand=discounts` and is always hydrated, so it never serializes as a bare ID. (The nested `source.coupon` inside each discount is still an `Expandable`, honoring `expand=discounts,coupons`.)","type":"array","items":{"description":"A Discount object represents the application of a coupon or promotion code to a checkout session, customer, subscription, or invoice. It records which coupon was redeemed, what the discount was applied to, and the time window over which it applies.","type":"object","required":["discount_id","source","start","test_mode"],"properties":{"discount_id":{"description":"The ID of the discount.","type":"string","example":"fdi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].discount_id","typeLabel":"string"},"source":{"description":"The source of the discount (coupon or promotion code).","type":"object","required":["coupon","type"],"properties":{"coupon":{"oneOf":[{"type":"string","description":"The coupon that was redeemed. Returned as a coupon ID by default; pass `expand=discounts,coupons` on the Subscription API to expand it to the full coupon object.","example":"fcoup_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.0","typeLabel":"string"},{"type":"object","description":"The coupon that was redeemed. Returned as a coupon ID by default; pass `expand=discounts,coupons` on the Subscription API to expand it to the full coupon object.","required":["coupon_id","created_at","duration","name","test_mode","valid"],"example":"fcoup_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"coupon_id":{"description":"Unique identifier for the object.","type":"string","example":"fcoup_1234567890","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1.coupon_id","typeLabel":"string"},"duration":{"type":"string","enum":["once","repeating","forever"],"x-ms-enum":{"name":"CouponDuration","modelAsString":false,"values":[{"value":"once","name":"Once","description":"Applies to the first charge from a subscription with this coupon applied."},{"value":"repeating","name":"Repeating","description":"Applies to charges in the first duration_in_months months from a subscription with this coupon applied."},{"value":"forever","name":"Forever","description":"Applies to all charges from a subscription with this coupon applied."}]},"description":"One of forever, once, and repeating. Describes how long a customer who applies this coupon will get the discount.","example":"once","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1.duration","typeLabel":"enum\u003cstring>"},"name":{"description":"Name of the coupon displayed to customers.","type":"string","example":"Example","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1.name","typeLabel":"string"},"valid":{"description":"Taking account of the above properties, whether this coupon can still be applied to a customer.","type":"boolean","example":false,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1.valid","typeLabel":"boolean"},"created_at":{"description":"Date when this coupon was created.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1.created_at","typeLabel":"string"},"test_mode":{"description":"Whether the coupon is in test mode","type":"boolean","example":false,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1.test_mode","typeLabel":"boolean"},"amount_off":{"oneOf":[{"description":"Amount that will be taken off the subtotal of any invoices for this customer.","type":"integer","format":"int32","maximum":2147483647,"example":2500,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1.amount_off.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"Amount that will be taken off the subtotal of any invoices for this customer.","type":"null","format":"int32","maximum":2147483647,"example":2500,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1.amount_off.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1.amount_off","typeLabel":"integer\u003cint32> | null"},"applies_to":{"oneOf":[{"type":"object","description":"An object containing the ID of the product that the coupon can be applied to.","required":["products"],"example":{"products":["fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA"]},"properties":{"products":{"description":"The product that this coupon applies to.","type":"array","items":{"type":"string","example":"fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1.applies_to.oneOf.0.products.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1.applies_to.oneOf.0.products","typeLabel":"string[]"}},"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1.applies_to.oneOf.0","typeLabel":"object"},{"type":"object","description":"An object containing the ID of the product that the coupon can be applied to.","required":["prices"],"properties":{"prices":{"description":"The price that this coupon applies to.","type":"array","items":{"type":"string","example":"fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1.applies_to.oneOf.1.prices.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1.applies_to.oneOf.1.prices","typeLabel":"string[]"}},"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1.applies_to.oneOf.1","typeLabel":"object"},{"type":"object","description":"An object containing the ID of the product that the coupon can be applied to.","required":["fee_types"],"properties":{"fee_types":{"description":"The fee types that this coupon applies to.","type":"array","items":{"description":"The kind of fee applied to a checkout session: a Letter of Medical Necessity consultation fee, or a custom fee you define.","type":"string","enum":["lmn_consultation","custom"],"example":"lmn_consultation","uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1.applies_to.oneOf.2.fee_types.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1.applies_to.oneOf.2.fee_types","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1.applies_to.oneOf.2","typeLabel":"object"},{"type":"string","description":"An object containing the ID of the product that the coupon can be applied to.","enum":["shipping"],"example":{"products":["fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA"]},"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1.applies_to.oneOf.3","typeLabel":"enum\u003cstring>"},{"type":"null","description":"An object containing the ID of the product that the coupon can be applied to.","uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1.applies_to.oneOf.4","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1.applies_to","typeLabel":"object · object · object · enum\u003cstring> · null"},"duration_in_months":{"oneOf":[{"description":"If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once.","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1.duration_in_months.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once.","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1.duration_in_months.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1.duration_in_months","typeLabel":"integer\u003cint32> | null"},"metadata":{"oneOf":[{"description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","type":"object","example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1.metadata.oneOf.0","typeLabel":"object"},{"description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","type":"null","example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1.metadata","typeLabel":"object | null"},"percent_off":{"oneOf":[{"description":"Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon.","type":"number","format":"double","uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1.percent_off.oneOf.0","typeLabel":"number\u003cdouble>"},{"description":"Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon.","type":"null","format":"double","uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1.percent_off.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1.percent_off","typeLabel":"number\u003cdouble> | null"},"max_redemptions":{"oneOf":[{"description":"Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1.max_redemptions.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1.max_redemptions.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1.max_redemptions","typeLabel":"integer\u003cint32> | null"},"times_redeemed":{"oneOf":[{"description":"Number of times this coupon has been applied to a customer.","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1.times_redeemed.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"Number of times this coupon has been applied to a customer.","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1.times_redeemed.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1.times_redeemed","typeLabel":"integer\u003cint32> | null"}},"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.coupon","typeLabel":"string | object"},"type":{"description":"The type of source.","type":"string","enum":["coupon","promotion_code"],"example":"coupon","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source.type","typeLabel":"enum\u003cstring>"}},"example":{"coupon":"fcoup_01J9XR8M3K7VZ8N2YB4WJ6T0RA","type":"coupon"},"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].source","typeLabel":"object"},"test_mode":{"description":"Whether the discount was applied in test mode","type":"boolean","example":false,"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].test_mode","typeLabel":"boolean"},"start":{"description":"Date that the coupon was applied.","type":"string","example":"string","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].start","typeLabel":"string"},"checkout_session":{"oneOf":[{"description":"The checkout session that the discount was applied to.","type":"string","example":"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].checkout_session.oneOf.0","typeLabel":"string"},{"description":"The checkout session that the discount was applied to.","type":"null","example":"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].checkout_session.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].checkout_session","typeLabel":"string | null"},"customer":{"oneOf":[{"description":"The customer that the discount was applied to.","type":"string","example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].customer.oneOf.0","typeLabel":"string"},{"description":"The customer that the discount was applied to.","type":"null","example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].customer.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].customer","typeLabel":"string | null"},"subscription":{"oneOf":[{"description":"The subscription that the discount was applied to.","type":"string","example":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].subscription.oneOf.0","typeLabel":"string"},{"description":"The subscription that the discount was applied to.","type":"null","example":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].subscription.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].subscription","typeLabel":"string | null"},"invoice":{"oneOf":[{"description":"The invoice that the discount was applied to.","type":"string","example":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].invoice.oneOf.0","typeLabel":"string"},{"description":"The invoice that the discount was applied to.","type":"null","example":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].invoice.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].invoice","typeLabel":"string | null"},"promo_code":{"oneOf":[{"description":"The promo code applied to create the discount.","type":"string","example":"fpromo_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].promo_code.oneOf.0","typeLabel":"string"},{"description":"The promo code applied to create the discount.","type":"null","example":"fpromo_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].promo_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].promo_code","typeLabel":"string | null"},"end":{"oneOf":[{"type":"string","description":"If the coupon has a duration of repeating, the date that this discount will end. If the coupon has a duration of once or forever, this attribute will be null.","example":"string","uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].end.oneOf.0","typeLabel":"string"},{"type":"null","description":"If the coupon has a duration of repeating, the date that this discount will end. If the coupon has a duration of once or forever, this attribute will be null.","uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].end.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX].end","typeLabel":"string | null"}},"example":{"discount_id":"fdi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","checkout_session":"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA","customer":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","subscription":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA","invoice":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA","source":{"coupon":"fcoup_01J9XR8M3K7VZ8N2YB4WJ6T0RA","type":"coupon"},"promo_code":"fpromo_01J9XR8M3K7VZ8N2YB4WJ6T0RA","test_mode":false,"end":"string","start":"string"},"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.0","typeLabel":"object[]"},{"description":"The discounts applied to the subscription. Only present when `expand=discounts` is requested; omitted from the response otherwise. Usually 0–1 elements (Flex applies at most one coupon per subscription today), but modeled as an array for Stripe parity and future multi-discount support.\n\nFull `Discount` objects rather than `Expandable`: unlike the other expandable fields, `discounts` is populated only on `expand=discounts` and is always hydrated, so it never serializes as a bare ID. (The nested `source.coupon` inside each discount is still an `Expandable`, honoring `expand=discounts,coupons`.)","type":"null","items":{"description":"A Discount object represents the application of a coupon or promotion code to a checkout session, customer, subscription, or invoice. It records which coupon was redeemed, what the discount was applied to, and the time window over which it applies.","type":"object","required":["discount_id","source","start","test_mode"],"properties":{"discount_id":{"description":"The ID of the discount.","type":"string","example":"fdi_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},"checkout_session":{"oneOf":[{"description":"The checkout session that the discount was applied to.","type":"string","example":"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"description":"The checkout session that the discount was applied to.","type":"null","example":"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"customer":{"oneOf":[{"description":"The customer that the discount was applied to.","type":"string","example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"description":"The customer that the discount was applied to.","type":"null","example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"subscription":{"oneOf":[{"description":"The subscription that the discount was applied to.","type":"string","example":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"description":"The subscription that the discount was applied to.","type":"null","example":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"invoice":{"oneOf":[{"description":"The invoice that the discount was applied to.","type":"string","example":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"description":"The invoice that the discount was applied to.","type":"null","example":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"source":{"description":"The source of the discount (coupon or promotion code).","type":"object","required":["coupon","type"],"properties":{"coupon":{"oneOf":[{"type":"string","description":"The coupon that was redeemed. Returned as a coupon ID by default; pass `expand=discounts,coupons` on the Subscription API to expand it to the full coupon object.","example":"fcoup_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"object","description":"The coupon that was redeemed. Returned as a coupon ID by default; pass `expand=discounts,coupons` on the Subscription API to expand it to the full coupon object.","required":["coupon_id","created_at","duration","name","test_mode","valid"],"example":"fcoup_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"coupon_id":{"description":"Unique identifier for the object.","type":"string","example":"fcoup_1234567890"},"amount_off":{"oneOf":[{"description":"Amount that will be taken off the subtotal of any invoices for this customer.","type":"integer","format":"int32","maximum":2147483647,"example":2500,"minimum":-2147483648},{"description":"Amount that will be taken off the subtotal of any invoices for this customer.","type":"null","format":"int32","maximum":2147483647,"example":2500,"minimum":-2147483648}]},"applies_to":{"oneOf":[{"type":"object","description":"An object containing the ID of the product that the coupon can be applied to.","required":["products"],"example":{"products":["fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA"]},"properties":{"products":{"description":"The product that this coupon applies to.","type":"array","items":{"type":"string","example":"fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}}}},{"type":"object","description":"An object containing the ID of the product that the coupon can be applied to.","required":["prices"],"properties":{"prices":{"description":"The price that this coupon applies to.","type":"array","items":{"type":"string","example":"fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}}}},{"type":"object","description":"An object containing the ID of the product that the coupon can be applied to.","required":["fee_types"],"properties":{"fee_types":{"description":"The fee types that this coupon applies to.","type":"array","items":{"description":"The kind of fee applied to a checkout session: a Letter of Medical Necessity consultation fee, or a custom fee you define.","type":"string","enum":["lmn_consultation","custom"],"example":"lmn_consultation"}}}},{"type":"string","description":"An object containing the ID of the product that the coupon can be applied to.","enum":["shipping"],"example":{"products":["fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA"]}},{"type":"null","description":"An object containing the ID of the product that the coupon can be applied to."}]},"duration":{"type":"string","enum":["once","repeating","forever"],"x-ms-enum":{"name":"CouponDuration","modelAsString":false,"values":[{"value":"once","name":"Once","description":"Applies to the first charge from a subscription with this coupon applied."},{"value":"repeating","name":"Repeating","description":"Applies to charges in the first duration_in_months months from a subscription with this coupon applied."},{"value":"forever","name":"Forever","description":"Applies to all charges from a subscription with this coupon applied."}]},"description":"One of forever, once, and repeating. Describes how long a customer who applies this coupon will get the discount.","example":"once"},"duration_in_months":{"oneOf":[{"description":"If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once.","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648},{"description":"If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once.","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"metadata":{"oneOf":[{"description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","type":"object","example":{"order_id":"8842","channel":"shopify"}},{"description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","type":"null","example":{"order_id":"8842","channel":"shopify"}}]},"name":{"description":"Name of the coupon displayed to customers.","type":"string","example":"Example"},"percent_off":{"oneOf":[{"description":"Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon.","type":"number","format":"double"},{"description":"Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon.","type":"null","format":"double"}]},"max_redemptions":{"oneOf":[{"description":"Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648},{"description":"Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"times_redeemed":{"oneOf":[{"description":"Number of times this coupon has been applied to a customer.","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648},{"description":"Number of times this coupon has been applied to a customer.","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"valid":{"description":"Taking account of the above properties, whether this coupon can still be applied to a customer.","type":"boolean","example":false},"created_at":{"description":"Date when this coupon was created.","type":"string","example":"2026-06-15T14:30:00Z"},"test_mode":{"description":"Whether the coupon is in test mode","type":"boolean","example":false}}}]},"type":{"description":"The type of source.","type":"string","enum":["coupon","promotion_code"],"example":"coupon"}},"example":{"coupon":"fcoup_01J9XR8M3K7VZ8N2YB4WJ6T0RA","type":"coupon"}},"promo_code":{"oneOf":[{"description":"The promo code applied to create the discount.","type":"string","example":"fpromo_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"description":"The promo code applied to create the discount.","type":"null","example":"fpromo_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"test_mode":{"description":"Whether the discount was applied in test mode","type":"boolean","example":false},"end":{"oneOf":[{"type":"string","description":"If the coupon has a duration of repeating, the date that this discount will end. If the coupon has a duration of once or forever, this attribute will be null.","example":"string"},{"type":"null","description":"If the coupon has a duration of repeating, the date that this discount will end. If the coupon has a duration of once or forever, this attribute will be null."}]},"start":{"description":"Date that the coupon was applied.","type":"string","example":"string"}},"example":{"discount_id":"fdi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","checkout_session":"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA","customer":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","subscription":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA","invoice":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA","source":{"coupon":"fcoup_01J9XR8M3K7VZ8N2YB4WJ6T0RA","type":"coupon"},"promo_code":"fpromo_01J9XR8M3K7VZ8N2YB4WJ6T0RA","test_mode":false,"end":"string","start":"string"}},"uniqueKey":"subscriptions.items.[INDEX].discounts.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].discounts","typeLabel":"object[] | null"},"pause":{"oneOf":[{"type":"object","description":"The current pause. Present only while the subscription is paused.","required":["paused_at"],"example":{"paused_at":"2026-06-15T14:30:00Z","resume_at":"2026-06-15T14:30:00Z","billing_cycle_anchor":"unchanged","proration_behavior":"always_invoice","credit":"unused_time"},"properties":{"paused_at":{"description":"When the subscription was paused. ISO 8601 format. While paused, this is also the subscription's `current_period_end`.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].pause.oneOf.0.paused_at","typeLabel":"string"},"resume_at":{"oneOf":[{"type":"string","description":"When Flex resumes the subscription on its own. `null` when it stays paused until you resume it.","example":"2026-06-15T14:30:00Z","uniqueKey":"subscriptions.items.[INDEX].pause.oneOf.0.resume_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"When Flex resumes the subscription on its own. `null` when it stays paused until you resume it.","example":"2026-06-15T14:30:00Z","uniqueKey":"subscriptions.items.[INDEX].pause.oneOf.0.resume_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].pause.oneOf.0.resume_at","typeLabel":"string | null"},"billing_cycle_anchor":{"oneOf":[{"type":"string","description":"Where billing restarts when Flex resumes at `resume_at`: `now` or `unchanged`. `null` when no resume is scheduled.","enum":["now","unchanged"],"x-ms-enum":{"name":"SubscriptionResumeBillingCycleAnchor","modelAsString":false,"values":[{"value":"now","name":"Now","description":"Bill monthly from the resume date, charging the full period now, net of any unused time credited at the pause. After an uncredited pause that ends inside the paid period, nothing is charged now and the next charge covers the time from the old period end."},{"value":"unchanged","name":"Unchanged","description":"Keep the original billing date."}]},"example":"unchanged","uniqueKey":"subscriptions.items.[INDEX].pause.oneOf.0.billing_cycle_anchor.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Where billing restarts when Flex resumes at `resume_at`: `now` or `unchanged`. `null` when no resume is scheduled.","example":"unchanged","uniqueKey":"subscriptions.items.[INDEX].pause.oneOf.0.billing_cycle_anchor.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].pause.oneOf.0.billing_cycle_anchor","typeLabel":"enum\u003cstring> | null"},"proration_behavior":{"oneOf":[{"type":"string","description":"How the partial period is billed when `billing_cycle_anchor` is `unchanged`. `null` otherwise.","enum":["create_prorations","always_invoice"],"x-ms-enum":{"name":"SubscriptionResumeProrationBehavior","modelAsString":false,"values":[{"value":"create_prorations","name":"CreateProrations","description":"Bill the partial period on the original billing date, with the next full period."},{"value":"always_invoice","name":"AlwaysInvoice","description":"Bill the partial period now, net of any unused time credited at the pause. A negative amount charges nothing and goes to the customer's balance."}]},"example":"always_invoice","uniqueKey":"subscriptions.items.[INDEX].pause.oneOf.0.proration_behavior.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"How the partial period is billed when `billing_cycle_anchor` is `unchanged`. `null` otherwise.","example":"always_invoice","uniqueKey":"subscriptions.items.[INDEX].pause.oneOf.0.proration_behavior.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].pause.oneOf.0.proration_behavior","typeLabel":"enum\u003cstring> | null"},"credit":{"type":"string","enum":["unused_time","none"],"x-ms-enum":{"name":"SubscriptionPauseCredit","modelAsString":false,"values":[{"value":"unused_time","name":"UnusedTime","description":"Credit the unused paid time from the pause to the period end. The resume charge is net of it."},{"value":"none","name":"None","description":"Credit nothing for the paused days inside the paid period. A resume before the period ends keeps the paid days after it."}]},"description":"What the pause credited for the paid time left in the period.","example":"unused_time","default":"unused_time","uniqueKey":"subscriptions.items.[INDEX].pause.oneOf.0.credit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"subscriptions.items.[INDEX].pause.oneOf.0","typeLabel":"object"},{"type":"null","description":"The current pause. Present only while the subscription is paused.","uniqueKey":"subscriptions.items.[INDEX].pause.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].pause","typeLabel":"object | null"}},"example":{"subscription_id":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA","created_at":"2026-06-15T14:30:00Z","items":[{"subscription_item_id":"fsubi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","price":"fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA","quantity":2500,"created_at":"2026-06-15T14:30:00Z","updated_at":"2026-06-15T14:30:00Z","test_mode":false}],"latest_invoice":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA","customer":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","status":"incomplete","cancel_at_period_end":false,"current_period_end":"string","current_period_start":"string","metadata":{"order_id":"8842","channel":"shopify"},"test_mode":false,"client_secret":{"setup_secret":"string","payment_secret":"string"},"proration_behavior":"always_invoice","trial_start":"string","trial_end":"string","cancel_at":"2026-06-15T14:30:00Z","canceled_at":"2026-06-15T14:30:00Z","default_payment_method":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA","backup_payment_method":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA","discounts":[{"discount_id":"fdi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","checkout_session":"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA","customer":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","subscription":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA","invoice":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA","source":{"coupon":"fcoup_01J9XR8M3K7VZ8N2YB4WJ6T0RA","type":"coupon"},"promo_code":"fpromo_01J9XR8M3K7VZ8N2YB4WJ6T0RA","test_mode":false,"end":"string","start":"string"}],"pause":{"paused_at":"2026-06-15T14:30:00Z","resume_at":"2026-06-15T14:30:00Z","billing_cycle_anchor":"unchanged","proration_behavior":"always_invoice","credit":"unused_time"}},"uniqueKey":"subscriptions.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"subscriptions","typeLabel":"object[]"}},"example":{"subscriptions":[{"subscription_id":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA","created_at":"2026-06-15T14:30:00Z","items":[{"subscription_item_id":"fsubi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","price":"fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA","quantity":2500,"created_at":"2026-06-15T14:30:00Z","updated_at":"2026-06-15T14:30:00Z","test_mode":false}],"latest_invoice":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA","customer":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","status":"incomplete","cancel_at_period_end":false,"current_period_end":"string","current_period_start":"string","metadata":{"order_id":"8842","channel":"shopify"},"test_mode":false,"client_secret":{"setup_secret":"string","payment_secret":"string"},"proration_behavior":"always_invoice","trial_start":"string","trial_end":"string","cancel_at":"2026-06-15T14:30:00Z","canceled_at":"2026-06-15T14:30:00Z","default_payment_method":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA","backup_payment_method":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA","discounts":[{"discount_id":"fdi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","checkout_session":"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA","customer":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","subscription":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA","invoice":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA","source":{"coupon":"fcoup_01J9XR8M3K7VZ8N2YB4WJ6T0RA","type":"coupon"},"promo_code":"fpromo_01J9XR8M3K7VZ8N2YB4WJ6T0RA","test_mode":false,"end":"string","start":"string"}],"pause":{"paused_at":"2026-06-15T14:30:00Z","resume_at":"2026-06-15T14:30:00Z","billing_cycle_anchor":"unchanged","proration_behavior":"always_invoice","credit":"unused_time"}}]},"uniqueKey":"","typeLabel":"object"},"example":{"subscriptions":[{"subscription_id":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA","created_at":"2026-06-15T14:30:00Z","items":[{"subscription_item_id":"fsubi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","price":"fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA","quantity":2500,"created_at":"2026-06-15T14:30:00Z","updated_at":"2026-06-15T14:30:00Z","test_mode":false}],"latest_invoice":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA","customer":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","status":"incomplete","cancel_at_period_end":false,"current_period_end":"string","current_period_start":"string","metadata":{"order_id":"8842","channel":"shopify"},"test_mode":false,"client_secret":{"setup_secret":"string","payment_secret":"string"},"proration_behavior":"always_invoice","trial_start":"string","trial_end":"string","cancel_at":"2026-06-15T14:30:00Z","canceled_at":"2026-06-15T14:30:00Z","default_payment_method":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA","backup_payment_method":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA","discounts":[{"discount_id":"fdi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","checkout_session":"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA","customer":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","subscription":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA","invoice":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA","source":{"coupon":"fcoup_01J9XR8M3K7VZ8N2YB4WJ6T0RA","type":"coupon"},"promo_code":"fpromo_01J9XR8M3K7VZ8N2YB4WJ6T0RA","test_mode":false,"end":"string","start":"string"}],"pause":{"paused_at":"2026-06-15T14:30:00Z","resume_at":"2026-06-15T14:30:00Z","billing_cycle_anchor":"unchanged","proration_behavior":"always_invoice","credit":"unused_time"}}]},"examples":{"Example":{"title":"Example","value":{"subscriptions":[{"subscription_id":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA","created_at":"2026-06-15T14:30:00Z","items":[{"subscription_item_id":"fsubi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","price":"fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA","quantity":2500,"created_at":"2026-06-15T14:30:00Z","updated_at":"2026-06-15T14:30:00Z","test_mode":false}],"latest_invoice":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA","customer":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","status":"incomplete","cancel_at_period_end":false,"current_period_end":"string","current_period_start":"string","metadata":{"order_id":"8842","channel":"shopify"},"test_mode":false,"client_secret":{"setup_secret":"string","payment_secret":"string"},"proration_behavior":"always_invoice","trial_start":"string","trial_end":"string","cancel_at":"2026-06-15T14:30:00Z","canceled_at":"2026-06-15T14:30:00Z","default_payment_method":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA","backup_payment_method":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA","discounts":[{"discount_id":"fdi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","checkout_session":"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA","customer":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","subscription":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA","invoice":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA","source":{"coupon":"fcoup_01J9XR8M3K7VZ8N2YB4WJ6T0RA","type":"coupon"},"promo_code":"fpromo_01J9XR8M3K7VZ8N2YB4WJ6T0RA","test_mode":false,"end":"string","start":"string"}],"pause":{"paused_at":"2026-06-15T14:30:00Z","resume_at":"2026-06-15T14:30:00Z","billing_cycle_anchor":"unchanged","proration_behavior":"always_invoice","credit":"unused_time"}}]}}},"exampleType":"examples"}},"exampleType":"examples"},"36daa2f4-0020-4757-a251-47c11e34a48e":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"HttpError","description":"The error response returned when a request cannot be completed.","type":"object","required":["code","detail"],"properties":{"code":{"description":"A short machine-readable error code identifying the type of error.","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"description":"A human-readable explanation of what went wrong.","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"}},"example":{"code":"string","detail":"string"},"uniqueKey":"","typeLabel":"HttpError · object"},"example":{"code":"string","detail":"string"},"examples":{"Example":{"title":"Example","value":{"code":"string","detail":"string"}}},"exampleType":"examples"}},"exampleType":"examples"},"39b31a91-7b4a-4a21-9389-9d8f3a1581ff":{"description":"Forbidden","content":{"application/json":{"schema":{"title":"HttpError","description":"The error response returned when a request cannot be completed.","type":"object","required":["code","detail"],"properties":{"code":{"description":"A short machine-readable error code identifying the type of error.","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"description":"A human-readable explanation of what went wrong.","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"}},"example":{"code":"string","detail":"string"},"uniqueKey":"","typeLabel":"HttpError · object"},"example":{"code":"string","detail":"string"},"examples":{"Example":{"title":"Example","value":{"code":"string","detail":"string"}}},"exampleType":"examples"}},"exampleType":"examples"},"fc876a4f-0a44-4b7f-903f-dd513a7b35e9":{"description":"Not Found","content":{"application/json":{"schema":{"title":"HttpError","description":"The error response returned when a request cannot be completed.","type":"object","required":["code","detail"],"properties":{"code":{"description":"A short machine-readable error code identifying the type of error.","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"description":"A human-readable explanation of what went wrong.","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"}},"example":{"code":"string","detail":"string"},"uniqueKey":"","typeLabel":"HttpError · object"},"example":{"code":"string","detail":"string"},"examples":{"Example":{"title":"Example","value":{"code":"string","detail":"string"}}},"exampleType":"examples"}},"exampleType":"examples"},"55d9e2cc-fbcb-4abe-8c97-0d132b59a395":{"description":"Conflict","content":{"application/json":{"schema":{"title":"HttpError","description":"The error response returned when a request cannot be completed.","type":"object","required":["code","detail"],"properties":{"code":{"description":"A short machine-readable error code identifying the type of error.","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"description":"A human-readable explanation of what went wrong.","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"}},"example":{"code":"string","detail":"string"},"uniqueKey":"","typeLabel":"HttpError · object"},"example":{"code":"string","detail":"string"},"examples":{"Example":{"title":"Example","value":{"code":"string","detail":"string"}}},"exampleType":"examples"}},"exampleType":"examples"},"c9ce5c71-2be1-4c7a-95e3-bcb756e30df5":{"description":"Validation Error","content":{"application/json":{"schema":{"description":"The error response returned when request validation fails (HTTP 422).","type":"object","required":["detail"],"properties":{"detail":{"description":"The list of validation errors, one entry per invalid field.","type":"array","items":{"description":"Validation errors have their own schema to provide context for invalid requests eg. mismatched types and out of bounds values. There may be any number of these per 422 UNPROCESSABLE ENTITY error.","type":"object","required":["loc","msg","type"],"properties":{"loc":{"description":"The location as a [`Vec`] of [`String`]s -- often in the form `[\"body\", \"field_name\"]`, `[\"query\", \"field_name\"]`, etc. They may, however, be arbitarily deep.","type":"array","items":{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"string[]"},"msg":{"description":"The message accompanying the validation error item.","type":"string","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"description":"The type of error, often \"type_error\" or \"value_error\", but sometimes with more context like as \"value_error.number.not_ge\"","type":"string","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"}},"example":{"loc":["string"],"msg":"string","type":"string"},"uniqueKey":"detail.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"detail","typeLabel":"object[]"}},"example":{"detail":[{"loc":["string"],"msg":"string","type":"string"}]},"uniqueKey":"","typeLabel":"object"},"example":{"detail":[{"loc":["string"],"msg":"string","type":"string"}]},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["string"],"msg":"string","type":"string"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"d147e17f-3591-41b0-ae61-6400321f66c5":{"description":"Too Many Requests","content":{"application/json":{"schema":{"title":"HttpError","description":"The error response returned when a request cannot be completed.","type":"object","required":["code","detail"],"properties":{"code":{"description":"A short machine-readable error code identifying the type of error.","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"description":"A human-readable explanation of what went wrong.","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"}},"example":{"code":"string","detail":"string"},"uniqueKey":"","typeLabel":"HttpError · object"},"example":{"code":"string","detail":"string"},"examples":{"Example":{"title":"Example","value":{"code":"string","detail":"string"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"26834da7-2a24-4de5-b97c-6bf0af826119":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Use a Bearer token to access this API.","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"080577c1-39a5-4498-bb49-d7daab803f21":{"url":"https://api.withflex.com"}},"schemas":{"8fbcacc5-2464-4789-9a44-67dbaef1711b":{"oneOf":[{"type":"string","description":"An expandable field — either a string ID or an expanded PaymentIntent object.","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"object","description":"An expandable field — either a string ID or an expanded PaymentIntent object.","required":["amount","capture_method","created_at","payment_intent_id","status","test_mode"],"example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"payment_intent_id":{"description":"The unique identifier for the payment intent.","type":"string","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},"amount":{"description":"The amount of the payment intent in cents.","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true},"status":{"description":"The status of the payment intent.","type":"string","enum":["canceled","processing","requires_action","requires_capture","requires_confirmation","requires_payment_method","succeeded"],"example":"canceled","isRequired":true},"created_at":{"description":"The time the payment intent was created.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true},"capture_method":{"description":"The capture method of the payment intent.","type":"string","enum":["automatic","automatic_async","manual"],"example":"automatic","isRequired":true},"test_mode":{"description":"Whether the payment intent is in test mode.","type":"boolean","example":false,"isRequired":true},"amount_capturable":{"oneOf":[{"type":"integer","description":"The amount that can be captured from this PaymentIntent.","format":"int32","maximum":2147483647,"minimum":-2147483648,"example":2500},{"type":"null","description":"The amount that can be captured from this PaymentIntent.","format":"int32","maximum":2147483647,"minimum":-2147483648,"example":2500}]},"amount_received":{"oneOf":[{"type":"integer","description":"The amount that was received in cents.","format":"int32","maximum":2147483647,"minimum":-2147483648,"example":2500},{"type":"null","description":"The amount that was received in cents.","format":"int32","maximum":2147483647,"minimum":-2147483648,"example":2500}]},"application_fee_amount":{"oneOf":[{"type":"integer","description":"The amount of the Flex application fee.","format":"int32","maximum":2147483647,"minimum":-2147483648},{"type":"null","description":"The amount of the Flex application fee.","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"customer":{"oneOf":[{"type":"string","description":"The customer associated with the payment intent.","example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"object","description":"The customer associated with the payment intent.","required":["created_at","customer_id","email","first_name","last_name","test_mode"],"example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"customer_id":{"description":"The unique identifier for the customer.","type":"string","example":"fcus_01HACM7FZ1084XB1GB6053VM0D","isRequired":true},"first_name":{"description":"The customer's first name.","type":"string","example":"John","isRequired":true},"last_name":{"description":"The customer's last name.","type":"string","example":"Doe","isRequired":true},"email":{"description":"The customer's email address.","type":"string","example":"joh.doe@example.com","isRequired":true},"created_at":{"description":"The time the customer was created.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true},"test_mode":{"description":"Whether the customer was created in test mode.","type":"boolean","example":false,"isRequired":true},"owner_partner_id":{"oneOf":[{"type":"string","description":"The partner that owns this customer. When a customer is shared with you by another partner in your organization, this is that sibling partner; otherwise it is your own partner id.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"The partner that owns this customer. When a customer is shared with you by another partner in your organization, this is that sibling partner; otherwise it is your own partner id.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"phone":{"oneOf":[{"type":"string","description":"The customer's phone number.","format":"phone","example":"+15555555555"},{"type":"null","description":"The customer's phone number.","format":"phone","example":"+15555555555"}]},"employer":{"oneOf":[{"type":"string","description":"The customer's employer.","example":"Flex"},{"type":"null","description":"The customer's employer.","example":"Flex"}]},"shipping":{"oneOf":[{"type":"object","description":"The customer's shipping address.","required":["shipping_address_id"],"example":{"shipping_address_id":"fsh_01J9XR8M3K7VZ8N2YB4WJ6T0RA","line1":"123 Main St","line2":"Suite 100","city":"San Francisco","state":"CA","postal_code":"94107","country":"US"},"properties":{"shipping_address_id":{"description":"Unique identifier for the shipping address.","type":"string","example":"fsh_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},"line1":{"oneOf":[{"type":"string","description":"The first line of the street address (e.g., street number and name).","example":"123 Main St"},{"type":"null","description":"The first line of the street address (e.g., street number and name).","example":"123 Main St"}]},"line2":{"oneOf":[{"type":"string","description":"The second line of the street address (e.g., apartment, suite, or unit).","example":"Suite 100"},{"type":"null","description":"The second line of the street address (e.g., apartment, suite, or unit).","example":"Suite 100"}]},"city":{"oneOf":[{"type":"string","description":"City, district, suburb, town, or village.","example":"San Francisco"},{"type":"null","description":"City, district, suburb, town, or village.","example":"San Francisco"}]},"state":{"oneOf":[{"type":"string","description":"State, county, province, or region.","example":"CA"},{"type":"null","description":"State, county, province, or region.","example":"CA"}]},"postal_code":{"oneOf":[{"type":"string","description":"ZIP or postal code.","example":"94107"},{"type":"null","description":"ZIP or postal code.","example":"94107"}]},"country":{"oneOf":[{"type":"string","description":"Two-letter country code (ISO 3166-1 alpha-2, e.g., `US`).","example":"US"},{"type":"null","description":"Two-letter country code (ISO 3166-1 alpha-2, e.g., `US`).","example":"US"}]}}},{"type":"null","description":"The customer's shipping address."}]},"metadata":{"oneOf":[{"type":"object","description":"Metadata associated with the customer.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"string"}},{"type":"null","description":"Metadata associated with the customer.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"string"}}]}}},{"type":"null","description":"The customer associated with the payment intent."}]},"transfer_data":{"oneOf":[{"type":"object","description":"The data related to the amount being transferred.","required":["destination"],"example":{"amount":2500,"destination":"facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},"properties":{"destination":{"description":"The destination account of the transfer.","type":"string","example":"facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},"amount":{"oneOf":[{"type":"integer","description":"The amount to transfer, in cents.","format":"int32","maximum":2147483647,"minimum":-2147483648,"example":2500},{"type":"null","description":"The amount to transfer, in cents.","format":"int32","maximum":2147483647,"minimum":-2147483648,"example":2500}]}}},{"type":"null","description":"The data related to the amount being transferred."}]},"latest_charge":{"oneOf":[{"type":"string","description":"The latest charge associated with the payment intent.","example":"fch_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"object","description":"The latest charge associated with the payment intent.","required":["amount","amount_captured","amount_refunded","captured","charge_id","created_at","disputed","paid","payment_intent","refunded","status","test_mode"],"example":"fch_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"charge_id":{"description":"Unique identifier for the charge.","type":"string","example":"fch_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},"amount":{"description":"Amount intended to be collected by this payment.","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true},"amount_captured":{"description":"Amount in cents captured (can be less than the amount attribute on the charge if a partial capture was made).","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true},"amount_refunded":{"description":"Amount in cents refunded (can be less than the amount attribute on the charge if a partial refund was made).","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true},"captured":{"description":"If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured.","type":"boolean","example":false,"isRequired":true},"created_at":{"description":"Time at which the object was created. ISO 8601 format.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true},"disputed":{"description":"Whether the charge has been disputed.","type":"boolean","example":false,"isRequired":true},"paid":{"description":"true if the charge succeeded, or was successfully authorized for later capture.","type":"boolean","example":false,"isRequired":true},"refunded":{"description":"Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.","type":"boolean","example":false,"isRequired":true},"payment_intent":{"$circularRef":"8fbcacc5-2464-4789-9a44-67dbaef1711b","description":"The payment intent that generated this charge.","isRequired":true},"status":{"description":"The status of the charge.","type":"string","enum":["succeeded","pending","failed"],"example":"succeeded","isRequired":true},"test_mode":{"description":"Whether the charge was created in test mode.","type":"boolean","example":false,"isRequired":true},"application_fee_amount":{"oneOf":[{"type":"integer","description":"The Flex application fee for the charge","format":"int32","maximum":2147483647,"minimum":-2147483648},{"type":"null","description":"The Flex application fee for the charge","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"customer":{"oneOf":[{"type":"string","description":"The customer this charge is for if one exists.","example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"object","description":"The customer this charge is for if one exists.","required":["created_at","customer_id","email","first_name","last_name","test_mode"],"example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"customer_id":{"description":"The unique identifier for the customer.","type":"string","example":"fcus_01HACM7FZ1084XB1GB6053VM0D","isRequired":true},"first_name":{"description":"The customer's first name.","type":"string","example":"John","isRequired":true},"last_name":{"description":"The customer's last name.","type":"string","example":"Doe","isRequired":true},"email":{"description":"The customer's email address.","type":"string","example":"joh.doe@example.com","isRequired":true},"created_at":{"description":"The time the customer was created.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true},"test_mode":{"description":"Whether the customer was created in test mode.","type":"boolean","example":false,"isRequired":true},"owner_partner_id":{"oneOf":[{"type":"string","description":"The partner that owns this customer. When a customer is shared with you by another partner in your organization, this is that sibling partner; otherwise it is your own partner id.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"The partner that owns this customer. When a customer is shared with you by another partner in your organization, this is that sibling partner; otherwise it is your own partner id.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"phone":{"oneOf":[{"type":"string","description":"The customer's phone number.","format":"phone","example":"+15555555555"},{"type":"null","description":"The customer's phone number.","format":"phone","example":"+15555555555"}]},"employer":{"oneOf":[{"type":"string","description":"The customer's employer.","example":"Flex"},{"type":"null","description":"The customer's employer.","example":"Flex"}]},"shipping":{"oneOf":[{"type":"object","description":"The customer's shipping address.","required":["shipping_address_id"],"example":{"shipping_address_id":"fsh_01J9XR8M3K7VZ8N2YB4WJ6T0RA","line1":"123 Main St","line2":"Suite 100","city":"San Francisco","state":"CA","postal_code":"94107","country":"US"},"properties":{"shipping_address_id":{"description":"Unique identifier for the shipping address.","type":"string","example":"fsh_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},"line1":{"oneOf":[{"type":"string","description":"The first line of the street address (e.g., street number and name).","example":"123 Main St"},{"type":"null","description":"The first line of the street address (e.g., street number and name).","example":"123 Main St"}]},"line2":{"oneOf":[{"type":"string","description":"The second line of the street address (e.g., apartment, suite, or unit).","example":"Suite 100"},{"type":"null","description":"The second line of the street address (e.g., apartment, suite, or unit).","example":"Suite 100"}]},"city":{"oneOf":[{"type":"string","description":"City, district, suburb, town, or village.","example":"San Francisco"},{"type":"null","description":"City, district, suburb, town, or village.","example":"San Francisco"}]},"state":{"oneOf":[{"type":"string","description":"State, county, province, or region.","example":"CA"},{"type":"null","description":"State, county, province, or region.","example":"CA"}]},"postal_code":{"oneOf":[{"type":"string","description":"ZIP or postal code.","example":"94107"},{"type":"null","description":"ZIP or postal code.","example":"94107"}]},"country":{"oneOf":[{"type":"string","description":"Two-letter country code (ISO 3166-1 alpha-2, e.g., `US`).","example":"US"},{"type":"null","description":"Two-letter country code (ISO 3166-1 alpha-2, e.g., `US`).","example":"US"}]}}},{"type":"null","description":"The customer's shipping address."}]},"metadata":{"oneOf":[{"type":"object","description":"Metadata associated with the customer.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"string"}},{"type":"null","description":"Metadata associated with the customer.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"string"}}]}}},{"type":"null","description":"The customer this charge is for if one exists."}]},"invoice":{"oneOf":[{"type":"string","description":"The invoice this charge is for if one exists.","example":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"object","description":"The invoice this charge is for if one exists.","required":["amount_due","amount_paid","collection_method","created_at","invoice_id","status","test_mode","total"],"example":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"invoice_id":{"description":"The id of the invoice.","type":"string","example":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},"total":{"description":"The total amount of the invoice in cents.","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true},"amount_due":{"description":"The amount due in cents.","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true},"amount_paid":{"description":"The amount paid in cents.","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true},"status":{"description":"The status of the invoice.","type":"string","enum":["draft","open","void","paid","uncollectible"],"example":"draft","isRequired":true},"collection_method":{"description":"Either charge_automatically or send_invoice. When charging automatically, Flex will attempt to pay this invoice using the default payment method attached to the customer. When sending an invoice, Flex will email this invoice to the customer with payment instructions.","type":"string","enum":["charge_automatically","send_invoice"],"example":"charge_automatically","isRequired":true},"test_mode":{"description":"Whether or not the invoice was created in test mode.","type":"boolean","example":false,"isRequired":true},"created_at":{"description":"When the invoice was created.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true},"payment_intent":{"oneOf":[{"description":"The payment intent associated with this invoice. The payment intent is created when the invoice is finalized."},{"type":"null","description":"The payment intent associated with this invoice. The payment intent is created when the invoice is finalized."}]},"charge":{"oneOf":[{"type":"string","description":"The id of the latest charge for this invoice.","example":"fch_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"The id of the latest charge for this invoice.","example":"fch_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"customer":{"oneOf":[{"type":"string","description":"The id of the customer this invoice is for.","example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"object","description":"The id of the customer this invoice is for.","required":["created_at","customer_id","email","first_name","last_name","test_mode"],"example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"customer_id":{"description":"The unique identifier for the customer.","type":"string","example":"fcus_01HACM7FZ1084XB1GB6053VM0D","isRequired":true},"first_name":{"description":"The customer's first name.","type":"string","example":"John","isRequired":true},"last_name":{"description":"The customer's last name.","type":"string","example":"Doe","isRequired":true},"email":{"description":"The customer's email address.","type":"string","example":"joh.doe@example.com","isRequired":true},"created_at":{"description":"The time the customer was created.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true},"test_mode":{"description":"Whether the customer was created in test mode.","type":"boolean","example":false,"isRequired":true},"owner_partner_id":{"oneOf":[{"type":"string","description":"The partner that owns this customer. When a customer is shared with you by another partner in your organization, this is that sibling partner; otherwise it is your own partner id.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"The partner that owns this customer. When a customer is shared with you by another partner in your organization, this is that sibling partner; otherwise it is your own partner id.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"phone":{"oneOf":[{"type":"string","description":"The customer's phone number.","format":"phone","example":"+15555555555"},{"type":"null","description":"The customer's phone number.","format":"phone","example":"+15555555555"}]},"employer":{"oneOf":[{"type":"string","description":"The customer's employer.","example":"Flex"},{"type":"null","description":"The customer's employer.","example":"Flex"}]},"shipping":{"oneOf":[{"type":"object","description":"The customer's shipping address.","required":["shipping_address_id"],"example":{"shipping_address_id":"fsh_01J9XR8M3K7VZ8N2YB4WJ6T0RA","line1":"123 Main St","line2":"Suite 100","city":"San Francisco","state":"CA","postal_code":"94107","country":"US"},"properties":{"shipping_address_id":{"description":"Unique identifier for the shipping address.","type":"string","example":"fsh_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},"line1":{"oneOf":[{"type":"string","description":"The first line of the street address (e.g., street number and name).","example":"123 Main St"},{"type":"null","description":"The first line of the street address (e.g., street number and name).","example":"123 Main St"}]},"line2":{"oneOf":[{"type":"string","description":"The second line of the street address (e.g., apartment, suite, or unit).","example":"Suite 100"},{"type":"null","description":"The second line of the street address (e.g., apartment, suite, or unit).","example":"Suite 100"}]},"city":{"oneOf":[{"type":"string","description":"City, district, suburb, town, or village.","example":"San Francisco"},{"type":"null","description":"City, district, suburb, town, or village.","example":"San Francisco"}]},"state":{"oneOf":[{"type":"string","description":"State, county, province, or region.","example":"CA"},{"type":"null","description":"State, county, province, or region.","example":"CA"}]},"postal_code":{"oneOf":[{"type":"string","description":"ZIP or postal code.","example":"94107"},{"type":"null","description":"ZIP or postal code.","example":"94107"}]},"country":{"oneOf":[{"type":"string","description":"Two-letter country code (ISO 3166-1 alpha-2, e.g., `US`).","example":"US"},{"type":"null","description":"Two-letter country code (ISO 3166-1 alpha-2, e.g., `US`).","example":"US"}]}}},{"type":"null","description":"The customer's shipping address."}]},"metadata":{"oneOf":[{"type":"object","description":"Metadata associated with the customer.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"string"}},{"type":"null","description":"Metadata associated with the customer.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"string"}}]}}},{"type":"null","description":"The id of the customer this invoice is for."}]},"period_end":{"oneOf":[{"type":"string","description":"End of the usage period.","example":"string"},{"type":"null","description":"End of the usage period."}]},"period_start":{"oneOf":[{"type":"string","description":"Start of the usage period.","example":"string"},{"type":"null","description":"Start of the usage period."}]},"subscription":{"oneOf":[{"type":"string","description":"The subscription that this invoice was prepared for.","example":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"object","description":"The subscription that this invoice was prepared for.","required":["cancel_at_period_end","created_at","items","status","subscription_id","test_mode"],"example":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"subscription_id":{"description":"Unique identifier for the object.","type":"string","example":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},"created_at":{"description":"Time at which the object was created. ISO 8601 format.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true},"items":{"description":"The items the customer is subscribed to.","type":"array","items":{"description":"A Subscription Item represents a single recurring Price billed as part of a Subscription, together with the quantity of that price the customer is subscribed to. A subscription has one item per recurring price it bills.","type":"object","required":["created_at","price","quantity","subscription_item_id","test_mode"],"properties":{"subscription_item_id":{"description":"Unique identifier for the subscription item.","type":"string","example":"fsubi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},"price":{"oneOf":[{"type":"string","description":"The recurring Price this item bills. Returned as a price ID by default, or as the full Price object when expanded.","example":"fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},{"type":"object","description":"The recurring Price this item bills. Returned as a price ID by default, or as the full Price object when expanded.","required":["active","created_at","price_id","product","test_mode","type","unit_amount"],"example":"fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"price_id":{"description":"The unique identifier for the price.","type":"string","example":"fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},"unit_amount":{"description":"The amount to charge per unit, in the smallest currency unit (e.g., `2500` = $25.00 USD).","type":"integer","format":"int32","minimum":-2147483648,"maximum":2147483647,"isRequired":true},"active":{"description":"Whether the price is currently active.","type":"boolean","example":false,"isRequired":true},"product":{"oneOf":[{"type":"string","description":"The product this price belongs to. Returned as a product ID by default, or as the full Product object when expanded.","example":"fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},{"type":"object","description":"The product this price belongs to. Returned as a product ID by default, or as the full Product object when expanded.","required":["active","created_at","hsa_fsa_eligibility","name","product_id","test_mode"],"example":"fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"product_id":{"description":"The unique identifier for the product.","type":"string","example":"fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},"name":{"description":"The name of the product.","type":"string","example":"Example","isRequired":true},"created_at":{"description":"The date the product was created.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true},"active":{"description":"Determines if the product is active or not.","type":"boolean","example":false,"isRequired":true},"hsa_fsa_eligibility":{"description":"The elegibility of the product for HSA/FSA.","type":"string","enum":["not_eligible","auto_substantiation","private_label","letter_of_medical_necessity","prescription","vision","service","pending"],"example":"not_eligible","isRequired":true},"test_mode":{"description":"Whether the product is in test mode or not.","type":"boolean","example":false,"isRequired":true},"owner_partner_id":{"oneOf":[{"type":"string","description":"The ID of the account that owns this product. For products shared across an organization this may be a sibling account; otherwise it is your own account ID.","example":"facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"The ID of the account that owns this product. For products shared across an organization this may be a sibling account; otherwise it is your own account ID.","example":"facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"description":{"oneOf":[{"type":"string","description":"The description of the product.","example":"Premium SPF 50 mineral sunscreen"},{"type":"null","description":"The description of the product.","example":"Premium SPF 50 mineral sunscreen"}]},"document_description":{"oneOf":[{"type":"string","description":"Medical-grade description optimized for use in Letters of Medical Necessity and receipts.","deprecated":true},{"type":"null","description":"Medical-grade description optimized for use in Letters of Medical Necessity and receipts.","deprecated":true}]},"receipt_description":{"oneOf":[{"type":"string","description":"Shortened description tailored to receipt line items"},{"type":"null","description":"Shortened description tailored to receipt line items"}]},"visit_type":{"oneOf":[{"type":"string","description":"The visit type of the product if a letter of medical necessity is required.","enum":["cbtSleep","notApplicable","metabolomics","tinnitus","gym","exerciseDiet","orthopedic","alcohol","airPurification","vaginalHealth","menstrual","canopy","alopecia","genate","weightBlanket","bedJet","siderAl","sunwinkPowder","wavWatch","bodyComplete","ageRate","nitrousOxide","happyV","groupChat","icalmAnxiety","redBloom","foodom","branchErgonomicFurniture","curalife","eloraInfantWellness","nutriHealth","olipop","goldIntimate","touchStoneEssentials","utiva","sleepGeekz","figBrew","auBabyBlanket","babySleepSack","oshWellness","currentBodyRedLight","mito","circularRing","lymaRedLight","goodAirRx","tastermonial","karunaHome","ergoStandingChair","jbaGlucoseControl","bloomNutrition","buoyDrops","luxeWonderWig","saunaMarketplace","amrioreEyewear","pivotOrthoShoe","lumenCynergy","roga","pulsetto","mitoRedLight","gutPersonal","goFlaus","myHixel","calmigo","dotFit","stripesBeauty","mixHers","pmd","positivityWithPurpose","techRing","popVeneers","vertaClean","lumen","medicalMeal","emnHealth","detergentAllergy","lowImpactExercise","mediumImpactExercise","highImpactExercise","gardening","babyCarrier","smartGlasses","automatedCleaner","uvClothing","adaptiveShoes","breathWork","nonenalOdor","meneralsNootropicPouch","babyMonitorSplit","babySleepApp","coolingSleepwear","bodyPillow","uvGlasses","nursingChairs","coolingBed","posture","supplements","sleep","redLightTherapy","fitness","smartRing","womensVaginalHealth","fertilitySupport","femaleReproduction","femaleReproductionFood","pregnancyLiterature","iceBath","orthopedicShoes","sexualHealth","glucose","metabolicTest","skinCare","oralHealth","oralAnxiety","blueLightGlasses","anxiety","brainHealth","babyMonitor","compressionSocks","compressionShorts","waterPurification","medSpa","essentialOils","sleepBuds","latchLight","nutritionist","rairflow","enduranceTraining","hydration","hairGrowth","eD","postureFitness","childDevelopment","adaptiveClothing","sleepConsulting","hairRemoval","menopause","maleFertility","anxietyHealth","bidets","speechHealth","artOfLiving","breastMilk","petSupport","diapers","gutSupplements","smartWatch","medicalBotox","biomechanicalAssessment","erectileReset","femaleOrgasm","pornAddiction","memorySupport","oralHealthMasticGum","orthopedicSandals","childDevelopmentAnxietySleep","childDevelopmentAdjustment","childDevelopmentBehavior","childDevelopmentIdentity","emnHealthMobility","adaptiveShoesDependent","speechHealthDependent","breathWorkDependent"],"example":"cbtSleep"},{"type":"null","description":"The visit type of the product if a letter of medical necessity is required."}]},"upc_code":{"oneOf":[{"type":"string","description":"The upc code of the product."},{"type":"null","description":"The upc code of the product."}]},"gtin":{"oneOf":[{"type":"string","description":"The gtin code of the product."},{"type":"null","description":"The gtin code of the product."}]},"reference_gtin":{"oneOf":[{"type":"string","description":"The GTIN of a private-label reference product, used to establish HSA/FSA eligibility."},{"type":"null","description":"The GTIN of a private-label reference product, used to establish HSA/FSA eligibility."}]},"metadata":{"oneOf":[{"type":"object","description":"Metadata associated with the product.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"string"}},{"type":"null","description":"Metadata associated with the product.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"string"}}]},"url":{"oneOf":[{"type":"string","description":"The URL of the product.","example":"https://example.com"},{"type":"null","description":"The URL of the product.","example":"https://example.com"}]},"client_reference_id":{"oneOf":[{"type":"string","description":"An optional identifier for the product set by the client at creation time. Immutable after creation.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"An optional identifier for the product set by the client at creation time. Immutable after creation.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]}},"isRequired":true}],"isRequired":true},"created_at":{"description":"The date the price was created.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true},"type":{"description":"The type of the price: a single one-time charge, or a recurring charge billed on a schedule.","type":"string","enum":["one_time","recurring"],"example":"one_time","isRequired":true},"test_mode":{"description":"Whether the price is in test mode.","type":"boolean","example":false,"isRequired":true},"owner_partner_id":{"oneOf":[{"type":"string","description":"The ID of the account that owns this price. For prices shared across an organization this may be a sibling account; otherwise it is your own account ID.","example":"facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"The ID of the account that owns this price. For prices shared across an organization this may be a sibling account; otherwise it is your own account ID.","example":"facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"description":{"oneOf":[{"type":"string","description":"The description of the price.","example":"Premium SPF 50 mineral sunscreen"},{"type":"null","description":"The description of the price.","example":"Premium SPF 50 mineral sunscreen"}]},"trial_period_days":{"oneOf":[{"type":"integer","description":"The number of trial period days before the customer is first charged for a recurring price.","format":"int32","maximum":2147483647,"minimum":-2147483648},{"type":"null","description":"The number of trial period days before the customer is first charged for a recurring price.","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"recurring":{"oneOf":[{"type":"object","description":"The recurring components of a price such as interval and trial period days.","required":["interval"],"example":{"interval":"day","interval_count":0,"trial_period_days":0},"properties":{"interval":{"description":"The billing cadence for the price.","type":"string","enum":["day","week","month","year"],"example":"day","isRequired":true},"interval_count":{"oneOf":[{"type":"integer","description":"The number of intervals","format":"int64","maximum":4294967295,"minimum":0},{"type":"null","description":"The number of intervals","format":"int64","maximum":4294967295,"minimum":0}]},"trial_period_days":{"oneOf":[{"type":"integer","description":"The number of trial period days before the customer is charged for the first time. Whole days only. For a precise trial-end timestamp (e.g. non-integer days), use `subscription_data.trial_end` on the Create Checkout Session request instead.","format":"int64","maximum":4294967295,"minimum":0},{"type":"null","description":"The number of trial period days before the customer is charged for the first time. Whole days only. For a precise trial-end timestamp (e.g. non-integer days), use `subscription_data.trial_end` on the Create Checkout Session request instead.","format":"int64","maximum":4294967295,"minimum":0}]}}},{"type":"null","description":"The recurring components of a price such as interval and trial period days."}]},"metadata":{"oneOf":[{"type":"object","description":"Metadata information for the price object","example":{"order_id":"8842","channel":"shopify"}},{"type":"null","description":"Metadata information for the price object","example":{"order_id":"8842","channel":"shopify"}}]},"lookup_key":{"oneOf":[{"type":"string","description":"A stable, partner-owned key for this price. Unique per account and mode across all prices, archived ones included. `null` until you set one.","maxLength":200,"example":"standard_monthly"},{"type":"null","description":"A stable, partner-owned key for this price. Unique per account and mode across all prices, archived ones included. `null` until you set one.","maxLength":200,"example":"standard_monthly"}]},"hsa_fsa_eligibility":{"oneOf":[{"type":"string","description":"The HSA/FSA eligibility for the price.","enum":["not_eligible","auto_substantiation","private_label","letter_of_medical_necessity","prescription","vision","service","pending"],"example":"not_eligible"},{"type":"null","description":"The HSA/FSA eligibility for the price."}]}},"isRequired":true}],"isRequired":true},"quantity":{"description":"The number of units of the price the customer is subscribed to.","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true},"created_at":{"description":"Time at which the subscription item was created, as an RFC 3339 timestamp.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true},"test_mode":{"description":"Whether the subscription item exists in test mode.","type":"boolean","example":false,"isRequired":true},"updated_at":{"oneOf":[{"type":"string","description":"Time at which the subscription item was last updated, as an RFC 3339 timestamp. `null` if the item has not been updated since creation.","example":"2026-06-15T14:30:00Z"},{"type":"null","description":"Time at which the subscription item was last updated, as an RFC 3339 timestamp. `null` if the item has not been updated since creation.","example":"2026-06-15T14:30:00Z"}]}},"example":{"subscription_item_id":"fsubi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","price":"fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA","quantity":2500,"created_at":"2026-06-15T14:30:00Z","updated_at":"2026-06-15T14:30:00Z","test_mode":false}},"isRequired":true},"status":{"description":"Possible values are incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, or paused.","type":"string","enum":["incomplete","incomplete_expired","trialing","active","past_due","canceled","unpaid","paused"],"example":"incomplete","isRequired":true},"cancel_at_period_end":{"description":"If the subscription has been canceled with the at_period_end flag set to true, cancel_at_period_end on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period.","type":"boolean","example":false,"isRequired":true},"test_mode":{"description":"Whether the subscription is in test mode.","type":"boolean","example":false,"isRequired":true},"latest_invoice":{"oneOf":[{"description":"The ID of the latest invoice generated for this subscription."},{"type":"null","description":"The ID of the latest invoice generated for this subscription."}]},"customer":{"oneOf":[{"type":"string","description":"The ID of the customer who owns the subscription.","example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"object","description":"The ID of the customer who owns the subscription.","required":["created_at","customer_id","email","first_name","last_name","test_mode"],"example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"customer_id":{"description":"The unique identifier for the customer.","type":"string","example":"fcus_01HACM7FZ1084XB1GB6053VM0D","isRequired":true},"first_name":{"description":"The customer's first name.","type":"string","example":"John","isRequired":true},"last_name":{"description":"The customer's last name.","type":"string","example":"Doe","isRequired":true},"email":{"description":"The customer's email address.","type":"string","example":"joh.doe@example.com","isRequired":true},"created_at":{"description":"The time the customer was created.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true},"test_mode":{"description":"Whether the customer was created in test mode.","type":"boolean","example":false,"isRequired":true},"owner_partner_id":{"oneOf":[{"type":"string","description":"The partner that owns this customer. When a customer is shared with you by another partner in your organization, this is that sibling partner; otherwise it is your own partner id.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"The partner that owns this customer. When a customer is shared with you by another partner in your organization, this is that sibling partner; otherwise it is your own partner id.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"phone":{"oneOf":[{"type":"string","description":"The customer's phone number.","format":"phone","example":"+15555555555"},{"type":"null","description":"The customer's phone number.","format":"phone","example":"+15555555555"}]},"employer":{"oneOf":[{"type":"string","description":"The customer's employer.","example":"Flex"},{"type":"null","description":"The customer's employer.","example":"Flex"}]},"shipping":{"oneOf":[{"type":"object","description":"The customer's shipping address.","required":["shipping_address_id"],"example":{"shipping_address_id":"fsh_01J9XR8M3K7VZ8N2YB4WJ6T0RA","line1":"123 Main St","line2":"Suite 100","city":"San Francisco","state":"CA","postal_code":"94107","country":"US"},"properties":{"shipping_address_id":{"description":"Unique identifier for the shipping address.","type":"string","example":"fsh_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},"line1":{"oneOf":[{"type":"string","description":"The first line of the street address (e.g., street number and name).","example":"123 Main St"},{"type":"null","description":"The first line of the street address (e.g., street number and name).","example":"123 Main St"}]},"line2":{"oneOf":[{"type":"string","description":"The second line of the street address (e.g., apartment, suite, or unit).","example":"Suite 100"},{"type":"null","description":"The second line of the street address (e.g., apartment, suite, or unit).","example":"Suite 100"}]},"city":{"oneOf":[{"type":"string","description":"City, district, suburb, town, or village.","example":"San Francisco"},{"type":"null","description":"City, district, suburb, town, or village.","example":"San Francisco"}]},"state":{"oneOf":[{"type":"string","description":"State, county, province, or region.","example":"CA"},{"type":"null","description":"State, county, province, or region.","example":"CA"}]},"postal_code":{"oneOf":[{"type":"string","description":"ZIP or postal code.","example":"94107"},{"type":"null","description":"ZIP or postal code.","example":"94107"}]},"country":{"oneOf":[{"type":"string","description":"Two-letter country code (ISO 3166-1 alpha-2, e.g., `US`).","example":"US"},{"type":"null","description":"Two-letter country code (ISO 3166-1 alpha-2, e.g., `US`).","example":"US"}]}}},{"type":"null","description":"The customer's shipping address."}]},"metadata":{"oneOf":[{"type":"object","description":"Metadata associated with the customer.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"string"}},{"type":"null","description":"Metadata associated with the customer.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"string"}}]}}},{"type":"null","description":"The ID of the customer who owns the subscription."}]},"current_period_end":{"oneOf":[{"type":"string","description":"End of the current period that the subscription has been invoiced for.","example":"string"},{"type":"null","description":"End of the current period that the subscription has been invoiced for."}]},"current_period_start":{"oneOf":[{"type":"string","description":"Start of the current period that the subscription has been invoiced for.","example":"string"},{"type":"null","description":"Start of the current period that the subscription has been invoiced for."}]},"metadata":{"oneOf":[{"type":"object","description":"A set of key/value pairs that you can attach to a subscription object.","example":{"order_id":"8842","channel":"shopify"}},{"type":"null","description":"A set of key/value pairs that you can attach to a subscription object.","example":{"order_id":"8842","channel":"shopify"}}]},"client_secret":{"oneOf":[{"type":"object","description":"Client secrets used to confirm the subscription's first payment or payment-method setup from your frontend. Present only while the subscription is being activated; omitted otherwise. Do not log or store these secrets; expose them only to the customer over TLS.","example":{"setup_secret":"string","payment_secret":"string"},"properties":{"setup_secret":{"oneOf":[{"type":"string","description":"Client secret of the SetupIntent used to collect and save a payment method for the subscription (for example, during a trial with no immediate charge). `null` when no setup is required. Do not log or store it; expose only to the customer over TLS."},{"type":"null","description":"Client secret of the SetupIntent used to collect and save a payment method for the subscription (for example, during a trial with no immediate charge). `null` when no setup is required. Do not log or store it; expose only to the customer over TLS."}]},"payment_secret":{"oneOf":[{"type":"string","description":"Client secret of the PaymentIntent used to confirm the subscription's first payment from your frontend. `null` when no immediate payment is required. Do not log or store it; expose only to the customer over TLS."},{"type":"null","description":"Client secret of the PaymentIntent used to confirm the subscription's first payment from your frontend. `null` when no immediate payment is required. Do not log or store it; expose only to the customer over TLS."}]}}},{"type":"null","description":"Client secrets used to confirm the subscription's first payment or payment-method setup from your frontend. Present only while the subscription is being activated; omitted otherwise. Do not log or store these secrets; expose them only to the customer over TLS."}]},"proration_behavior":{"oneOf":[{"type":"string","description":"The proration behavior for the subscription.","enum":["always_invoice","create_prorations","none"],"example":"always_invoice"},{"type":"null","description":"The proration behavior for the subscription."}]},"trial_start":{"oneOf":[{"type":"string","description":"Start of the subscription's trial period, as an RFC 3339 timestamp. `null` if the subscription has no trial.","example":"string"},{"type":"null","description":"Start of the subscription's trial period, as an RFC 3339 timestamp. `null` if the subscription has no trial."}]},"trial_end":{"oneOf":[{"type":"string","description":"End of the subscription's trial period, as an RFC 3339 timestamp. After this time the customer is billed normally. `null` if the subscription has no trial.","example":"string"},{"type":"null","description":"End of the subscription's trial period, as an RFC 3339 timestamp. After this time the customer is billed normally. `null` if the subscription has no trial."}]},"cancel_at":{"oneOf":[{"type":"string","description":"A future RFC 3339 timestamp at which the subscription will automatically be canceled. `null` unless a future cancellation has been scheduled.","example":"2026-06-15T14:30:00Z"},{"type":"null","description":"A future RFC 3339 timestamp at which the subscription will automatically be canceled. `null` unless a future cancellation has been scheduled.","example":"2026-06-15T14:30:00Z"}]},"canceled_at":{"oneOf":[{"type":"string","description":"The RFC 3339 timestamp at which the subscription was actually canceled. `null` if the subscription has not been canceled. Unlike `cancel_at` (a future scheduled cancellation), this is set once the cancellation has occurred.","example":"2026-06-15T14:30:00Z"},{"type":"null","description":"The RFC 3339 timestamp at which the subscription was actually canceled. `null` if the subscription has not been canceled. Unlike `cancel_at` (a future scheduled cancellation), this is set once the cancellation has occurred.","example":"2026-06-15T14:30:00Z"}]},"default_payment_method":{"oneOf":[{"type":"string","description":"The default payment method for the subscription (expandable).","example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"object","description":"The default payment method for the subscription (expandable).","required":["billing_details","card","created_at","customer","off_session","payment_method_id","test_mode"],"example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"payment_method_id":{"description":"The ID of the PaymentMethod.","type":"string","example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},"billing_details":{"description":"Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.","type":"object","properties":{"address":{"oneOf":[{"type":"object","description":"The billing address.","example":{"city":"San Francisco","country":"US","line1":"123 Main St","line2":"Suite 100","postal_code":"94107","state":"CA"},"properties":{"city":{"oneOf":[{"type":"string","description":"City, district, suburb, town, or village.","example":"San Francisco"},{"type":"null","description":"City, district, suburb, town, or village.","example":"San Francisco"}]},"country":{"oneOf":[{"type":"string","description":"Two-letter ISO country code (e.g., `US`).","example":"US"},{"type":"null","description":"Two-letter ISO country code (e.g., `US`).","example":"US"}]},"line1":{"oneOf":[{"type":"string","description":"Address line 1, such as the street, PO box, or company name.","example":"123 Main St"},{"type":"null","description":"Address line 1, such as the street, PO box, or company name.","example":"123 Main St"}]},"line2":{"oneOf":[{"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building.","example":"Suite 100"},{"type":"null","description":"Address line 2, such as the apartment, suite, unit, or building.","example":"Suite 100"}]},"postal_code":{"oneOf":[{"type":"string","description":"ZIP or postal code.","example":"94107"},{"type":"null","description":"ZIP or postal code.","example":"94107"}]},"state":{"oneOf":[{"type":"string","description":"State, county, province, or region.","example":"CA"},{"type":"null","description":"State, county, province, or region.","example":"CA"}]}}},{"type":"null","description":"The billing address."}]},"email":{"oneOf":[{"type":"string","description":"The billing email address.","example":"john.doe@example.com"},{"type":"null","description":"The billing email address.","example":"john.doe@example.com"}]},"name":{"oneOf":[{"type":"string","description":"The billing name.","example":"Example"},{"type":"null","description":"The billing name.","example":"Example"}]},"phone":{"oneOf":[{"type":"string","description":"The billing phone number.","example":"+14155550142"},{"type":"null","description":"The billing phone number.","example":"+14155550142"}]}},"example":{"address":{"city":"San Francisco","country":"US","line1":"123 Main St","line2":"Suite 100","postal_code":"94107","state":"CA"},"email":"john.doe@example.com","name":"Example","phone":"+14155550142"},"isRequired":true},"customer":{"oneOf":[{"type":"string","description":"The customer this payment method is attached to. Returned as the customer ID by default; expandable to the full Customer object.","example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},{"type":"object","description":"The customer this payment method is attached to. Returned as the customer ID by default; expandable to the full Customer object.","required":["created_at","customer_id","email","first_name","last_name","test_mode"],"example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"customer_id":{"description":"The unique identifier for the customer.","type":"string","example":"fcus_01HACM7FZ1084XB1GB6053VM0D","isRequired":true},"first_name":{"description":"The customer's first name.","type":"string","example":"John","isRequired":true},"last_name":{"description":"The customer's last name.","type":"string","example":"Doe","isRequired":true},"email":{"description":"The customer's email address.","type":"string","example":"joh.doe@example.com","isRequired":true},"created_at":{"description":"The time the customer was created.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true},"test_mode":{"description":"Whether the customer was created in test mode.","type":"boolean","example":false,"isRequired":true},"owner_partner_id":{"oneOf":[{"type":"string","description":"The partner that owns this customer. When a customer is shared with you by another partner in your organization, this is that sibling partner; otherwise it is your own partner id.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"The partner that owns this customer. When a customer is shared with you by another partner in your organization, this is that sibling partner; otherwise it is your own partner id.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"phone":{"oneOf":[{"type":"string","description":"The customer's phone number.","format":"phone","example":"+15555555555"},{"type":"null","description":"The customer's phone number.","format":"phone","example":"+15555555555"}]},"employer":{"oneOf":[{"type":"string","description":"The customer's employer.","example":"Flex"},{"type":"null","description":"The customer's employer.","example":"Flex"}]},"shipping":{"type":"any","description":"The customer's shipping address."},"metadata":{"oneOf":[{"type":"object","description":"Metadata associated with the customer.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"string"}},{"type":"null","description":"Metadata associated with the customer.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"string"}}]}},"isRequired":true}],"isRequired":true},"card":{"description":"User card details.","type":"object","required":["brand","country","exp_month","exp_year","fingerprint","funding","last4"],"properties":{"brand":{"description":"The brand of the card.","type":"string","enum":["american_express","diners_club","discover","eftpos_au","JCB","master_card","union_pay","visa","unknown"],"example":"american_express","isRequired":true},"country":{"description":"Two-letter ISO code for the card's country.","type":"string","example":"US","isRequired":true},"exp_month":{"description":"The card's expiration month.","type":"integer","format":"int32","example":12,"minimum":-128,"maximum":127,"isRequired":true},"exp_year":{"description":"The card's expiration year.","type":"integer","format":"int32","example":2027,"minimum":-2147483648,"maximum":2147483647,"isRequired":true},"fingerprint":{"description":"Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card.","type":"string","example":"abc123","isRequired":true},"funding":{"description":"The funding type of the card.","type":"string","enum":["credit","debit","hsa_fsa","prepaid","unknown"],"example":"credit","isRequired":true},"last4":{"description":"The last four digits of the card.","type":"string","example":"4242","isRequired":true}},"example":{"brand":"american_express","country":"US","exp_month":12,"exp_year":2027,"fingerprint":"abc123","funding":"credit","last4":"4242"},"isRequired":true},"created_at":{"description":"Time at which the object was created. ISO 8601 format.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true},"test_mode":{"description":"Whether this PaymentMethod is in test mode.","type":"boolean","example":false,"isRequired":true},"off_session":{"description":"Whether this PaymentMethod is valid for off_session (customer not present) purchase flows.","type":"boolean","isRequired":true},"metadata":{"oneOf":[{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"object"}},{"type":"null","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"object"}}]}}},{"type":"null","description":"The default payment method for the subscription (expandable)."}]},"backup_payment_method":{"oneOf":[{"type":"string","description":"The payment method charged when the default one fails (expandable). Omitted when the subscription has no backup.","example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"object","description":"The payment method charged when the default one fails (expandable). Omitted when the subscription has no backup.","required":["billing_details","card","created_at","customer","off_session","payment_method_id","test_mode"],"example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"payment_method_id":{"description":"The ID of the PaymentMethod.","type":"string","example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},"billing_details":{"description":"Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.","type":"object","properties":{"address":{"oneOf":[{"type":"object","description":"The billing address.","example":{"city":"San Francisco","country":"US","line1":"123 Main St","line2":"Suite 100","postal_code":"94107","state":"CA"},"properties":{"city":{"oneOf":[{"type":"string","description":"City, district, suburb, town, or village.","example":"San Francisco"},{"type":"null","description":"City, district, suburb, town, or village.","example":"San Francisco"}]},"country":{"oneOf":[{"type":"string","description":"Two-letter ISO country code (e.g., `US`).","example":"US"},{"type":"null","description":"Two-letter ISO country code (e.g., `US`).","example":"US"}]},"line1":{"oneOf":[{"type":"string","description":"Address line 1, such as the street, PO box, or company name.","example":"123 Main St"},{"type":"null","description":"Address line 1, such as the street, PO box, or company name.","example":"123 Main St"}]},"line2":{"oneOf":[{"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building.","example":"Suite 100"},{"type":"null","description":"Address line 2, such as the apartment, suite, unit, or building.","example":"Suite 100"}]},"postal_code":{"oneOf":[{"type":"string","description":"ZIP or postal code.","example":"94107"},{"type":"null","description":"ZIP or postal code.","example":"94107"}]},"state":{"oneOf":[{"type":"string","description":"State, county, province, or region.","example":"CA"},{"type":"null","description":"State, county, province, or region.","example":"CA"}]}}},{"type":"null","description":"The billing address."}]},"email":{"oneOf":[{"type":"string","description":"The billing email address.","example":"john.doe@example.com"},{"type":"null","description":"The billing email address.","example":"john.doe@example.com"}]},"name":{"oneOf":[{"type":"string","description":"The billing name.","example":"Example"},{"type":"null","description":"The billing name.","example":"Example"}]},"phone":{"oneOf":[{"type":"string","description":"The billing phone number.","example":"+14155550142"},{"type":"null","description":"The billing phone number.","example":"+14155550142"}]}},"example":{"address":{"city":"San Francisco","country":"US","line1":"123 Main St","line2":"Suite 100","postal_code":"94107","state":"CA"},"email":"john.doe@example.com","name":"Example","phone":"+14155550142"},"isRequired":true},"customer":{"oneOf":[{"type":"string","description":"The customer this payment method is attached to. Returned as the customer ID by default; expandable to the full Customer object.","example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},{"type":"object","description":"The customer this payment method is attached to. Returned as the customer ID by default; expandable to the full Customer object.","required":["created_at","customer_id","email","first_name","last_name","test_mode"],"example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"customer_id":{"description":"The unique identifier for the customer.","type":"string","example":"fcus_01HACM7FZ1084XB1GB6053VM0D","isRequired":true},"first_name":{"description":"The customer's first name.","type":"string","example":"John","isRequired":true},"last_name":{"description":"The customer's last name.","type":"string","example":"Doe","isRequired":true},"email":{"description":"The customer's email address.","type":"string","example":"joh.doe@example.com","isRequired":true},"created_at":{"description":"The time the customer was created.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true},"test_mode":{"description":"Whether the customer was created in test mode.","type":"boolean","example":false,"isRequired":true},"owner_partner_id":{"oneOf":[{"type":"string","description":"The partner that owns this customer. When a customer is shared with you by another partner in your organization, this is that sibling partner; otherwise it is your own partner id.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"The partner that owns this customer. When a customer is shared with you by another partner in your organization, this is that sibling partner; otherwise it is your own partner id.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"phone":{"oneOf":[{"type":"string","description":"The customer's phone number.","format":"phone","example":"+15555555555"},{"type":"null","description":"The customer's phone number.","format":"phone","example":"+15555555555"}]},"employer":{"oneOf":[{"type":"string","description":"The customer's employer.","example":"Flex"},{"type":"null","description":"The customer's employer.","example":"Flex"}]},"shipping":{"type":"any","description":"The customer's shipping address."},"metadata":{"oneOf":[{"type":"object","description":"Metadata associated with the customer.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"string"}},{"type":"null","description":"Metadata associated with the customer.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"string"}}]}},"isRequired":true}],"isRequired":true},"card":{"description":"User card details.","type":"object","required":["brand","country","exp_month","exp_year","fingerprint","funding","last4"],"properties":{"brand":{"description":"The brand of the card.","type":"string","enum":["american_express","diners_club","discover","eftpos_au","JCB","master_card","union_pay","visa","unknown"],"example":"american_express","isRequired":true},"country":{"description":"Two-letter ISO code for the card's country.","type":"string","example":"US","isRequired":true},"exp_month":{"description":"The card's expiration month.","type":"integer","format":"int32","example":12,"minimum":-128,"maximum":127,"isRequired":true},"exp_year":{"description":"The card's expiration year.","type":"integer","format":"int32","example":2027,"minimum":-2147483648,"maximum":2147483647,"isRequired":true},"fingerprint":{"description":"Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card.","type":"string","example":"abc123","isRequired":true},"funding":{"description":"The funding type of the card.","type":"string","enum":["credit","debit","hsa_fsa","prepaid","unknown"],"example":"credit","isRequired":true},"last4":{"description":"The last four digits of the card.","type":"string","example":"4242","isRequired":true}},"example":{"brand":"american_express","country":"US","exp_month":12,"exp_year":2027,"fingerprint":"abc123","funding":"credit","last4":"4242"},"isRequired":true},"created_at":{"description":"Time at which the object was created. ISO 8601 format.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true},"test_mode":{"description":"Whether this PaymentMethod is in test mode.","type":"boolean","example":false,"isRequired":true},"off_session":{"description":"Whether this PaymentMethod is valid for off_session (customer not present) purchase flows.","type":"boolean","isRequired":true},"metadata":{"oneOf":[{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"object"}},{"type":"null","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"object"}}]}}},{"type":"null","description":"The payment method charged when the default one fails (expandable). Omitted when the subscription has no backup."}]},"discounts":{"oneOf":[{"type":"array","items":{"description":"A Discount object represents the application of a coupon or promotion code to a checkout session, customer, subscription, or invoice. It records which coupon was redeemed, what the discount was applied to, and the time window over which it applies.","type":"object","required":["discount_id","source","start","test_mode"],"properties":{"discount_id":{"description":"The ID of the discount.","type":"string","example":"fdi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},"source":{"description":"The source of the discount (coupon or promotion code).","type":"object","required":["coupon","type"],"properties":{"coupon":{"oneOf":[{"type":"string","description":"The coupon that was redeemed. Returned as a coupon ID by default; pass `expand=discounts,coupons` on the Subscription API to expand it to the full coupon object.","example":"fcoup_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},{"type":"object","description":"The coupon that was redeemed. Returned as a coupon ID by default; pass `expand=discounts,coupons` on the Subscription API to expand it to the full coupon object.","required":["coupon_id","created_at","duration","name","test_mode","valid"],"example":"fcoup_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"coupon_id":{"description":"Unique identifier for the object.","type":"string","example":"fcoup_1234567890","isRequired":true},"duration":{"type":"string","enum":["once","repeating","forever"],"x-ms-enum":{"name":"CouponDuration","modelAsString":false,"values":[{"value":"once","name":"Once","description":"Applies to the first charge from a subscription with this coupon applied."},{"value":"repeating","name":"Repeating","description":"Applies to charges in the first duration_in_months months from a subscription with this coupon applied."},{"value":"forever","name":"Forever","description":"Applies to all charges from a subscription with this coupon applied."}]},"description":"One of forever, once, and repeating. Describes how long a customer who applies this coupon will get the discount.","example":"once","isRequired":true},"name":{"description":"Name of the coupon displayed to customers.","type":"string","example":"Example","isRequired":true},"valid":{"description":"Taking account of the above properties, whether this coupon can still be applied to a customer.","type":"boolean","example":false,"isRequired":true},"created_at":{"description":"Date when this coupon was created.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true},"test_mode":{"description":"Whether the coupon is in test mode","type":"boolean","example":false,"isRequired":true},"amount_off":{"oneOf":[{"type":"integer","description":"Amount that will be taken off the subtotal of any invoices for this customer.","format":"int32","maximum":2147483647,"minimum":-2147483648,"example":2500},{"type":"null","description":"Amount that will be taken off the subtotal of any invoices for this customer.","format":"int32","maximum":2147483647,"minimum":-2147483648,"example":2500}]},"applies_to":{"oneOf":[{"type":"object","description":"An object containing the ID of the product that the coupon can be applied to.","required":["products"],"example":{"products":["fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA"]},"properties":{"products":{"description":"The product that this coupon applies to.","type":"array","items":{"type":"string","example":"fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},"isRequired":true}}},{"type":"object","description":"An object containing the ID of the product that the coupon can be applied to.","required":["prices"],"properties":{"prices":{"description":"The price that this coupon applies to.","type":"array","items":{"type":"string","example":"fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},"isRequired":true}}},{"type":"object","description":"An object containing the ID of the product that the coupon can be applied to.","required":["fee_types"],"properties":{"fee_types":{"description":"The fee types that this coupon applies to.","type":"array","items":{"description":"The kind of fee applied to a checkout session: a Letter of Medical Necessity consultation fee, or a custom fee you define.","type":"string","enum":["lmn_consultation","custom"],"example":"lmn_consultation"},"isRequired":true}}},{"type":"string","description":"An object containing the ID of the product that the coupon can be applied to.","enum":["shipping"],"example":{"products":["fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA"]}},{"type":"null","description":"An object containing the ID of the product that the coupon can be applied to."}]},"duration_in_months":{"oneOf":[{"type":"integer","description":"If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once.","format":"int32","maximum":2147483647,"minimum":-2147483648},{"type":"null","description":"If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once.","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"metadata":{"oneOf":[{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","example":{"order_id":"8842","channel":"shopify"}},{"type":"null","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","example":{"order_id":"8842","channel":"shopify"}}]},"percent_off":{"oneOf":[{"type":"number","description":"Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon.","format":"double"},{"type":"null","description":"Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon.","format":"double"}]},"max_redemptions":{"oneOf":[{"type":"integer","description":"Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.","format":"int32","maximum":2147483647,"minimum":-2147483648},{"type":"null","description":"Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"times_redeemed":{"oneOf":[{"type":"integer","description":"Number of times this coupon has been applied to a customer.","format":"int32","maximum":2147483647,"minimum":-2147483648},{"type":"null","description":"Number of times this coupon has been applied to a customer.","format":"int32","maximum":2147483647,"minimum":-2147483648}]}},"isRequired":true}],"isRequired":true},"type":{"description":"The type of source.","type":"string","enum":["coupon","promotion_code"],"example":"coupon","isRequired":true}},"example":{"coupon":"fcoup_01J9XR8M3K7VZ8N2YB4WJ6T0RA","type":"coupon"},"isRequired":true},"test_mode":{"description":"Whether the discount was applied in test mode","type":"boolean","example":false,"isRequired":true},"start":{"description":"Date that the coupon was applied.","type":"string","example":"string","isRequired":true},"checkout_session":{"oneOf":[{"type":"string","description":"The checkout session that the discount was applied to.","example":"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"The checkout session that the discount was applied to.","example":"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"customer":{"oneOf":[{"type":"string","description":"The customer that the discount was applied to.","example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"The customer that the discount was applied to.","example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"subscription":{"oneOf":[{"type":"string","description":"The subscription that the discount was applied to.","example":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"The subscription that the discount was applied to.","example":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"invoice":{"oneOf":[{"type":"string","description":"The invoice that the discount was applied to.","example":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"The invoice that the discount was applied to.","example":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"promo_code":{"oneOf":[{"type":"string","description":"The promo code applied to create the discount.","example":"fpromo_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"The promo code applied to create the discount.","example":"fpromo_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"end":{"oneOf":[{"type":"string","description":"If the coupon has a duration of repeating, the date that this discount will end. If the coupon has a duration of once or forever, this attribute will be null.","example":"string"},{"type":"null","description":"If the coupon has a duration of repeating, the date that this discount will end. If the coupon has a duration of once or forever, this attribute will be null."}]}},"example":{"discount_id":"fdi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","checkout_session":"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA","customer":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","subscription":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA","invoice":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA","source":{"coupon":"fcoup_01J9XR8M3K7VZ8N2YB4WJ6T0RA","type":"coupon"},"promo_code":"fpromo_01J9XR8M3K7VZ8N2YB4WJ6T0RA","test_mode":false,"end":"string","start":"string"}},"description":"The discounts applied to the subscription. Only present when `expand=discounts` is requested; omitted from the response otherwise. Usually 0–1 elements (Flex applies at most one coupon per subscription today), but modeled as an array for Stripe parity and future multi-discount support.\n\nFull `Discount` objects rather than `Expandable`: unlike the other expandable fields, `discounts` is populated only on `expand=discounts` and is always hydrated, so it never serializes as a bare ID. (The nested `source.coupon` inside each discount is still an `Expandable`, honoring `expand=discounts,coupons`.)"},{"type":"null","description":"The discounts applied to the subscription. Only present when `expand=discounts` is requested; omitted from the response otherwise. Usually 0–1 elements (Flex applies at most one coupon per subscription today), but modeled as an array for Stripe parity and future multi-discount support.\n\nFull `Discount` objects rather than `Expandable`: unlike the other expandable fields, `discounts` is populated only on `expand=discounts` and is always hydrated, so it never serializes as a bare ID. (The nested `source.coupon` inside each discount is still an `Expandable`, honoring `expand=discounts,coupons`.)"}]},"pause":{"oneOf":[{"type":"object","description":"The current pause. Present only while the subscription is paused.","required":["paused_at"],"example":{"paused_at":"2026-06-15T14:30:00Z","resume_at":"2026-06-15T14:30:00Z","billing_cycle_anchor":"unchanged","proration_behavior":"always_invoice","credit":"unused_time"},"properties":{"paused_at":{"description":"When the subscription was paused. ISO 8601 format. While paused, this is also the subscription's `current_period_end`.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true},"resume_at":{"oneOf":[{"type":"string","description":"When Flex resumes the subscription on its own. `null` when it stays paused until you resume it.","example":"2026-06-15T14:30:00Z"},{"type":"null","description":"When Flex resumes the subscription on its own. `null` when it stays paused until you resume it.","example":"2026-06-15T14:30:00Z"}]},"billing_cycle_anchor":{"oneOf":[{"type":"string","description":"Where billing restarts when Flex resumes at `resume_at`: `now` or `unchanged`. `null` when no resume is scheduled.","enum":["now","unchanged"],"x-ms-enum":{"name":"SubscriptionResumeBillingCycleAnchor","modelAsString":false,"values":[{"value":"now","name":"Now","description":"Bill monthly from the resume date, charging the full period now, net of any unused time credited at the pause. After an uncredited pause that ends inside the paid period, nothing is charged now and the next charge covers the time from the old period end."},{"value":"unchanged","name":"Unchanged","description":"Keep the original billing date."}]},"example":"unchanged"},{"type":"null","description":"Where billing restarts when Flex resumes at `resume_at`: `now` or `unchanged`. `null` when no resume is scheduled.","example":"unchanged"}]},"proration_behavior":{"oneOf":[{"type":"string","description":"How the partial period is billed when `billing_cycle_anchor` is `unchanged`. `null` otherwise.","enum":["create_prorations","always_invoice"],"x-ms-enum":{"name":"SubscriptionResumeProrationBehavior","modelAsString":false,"values":[{"value":"create_prorations","name":"CreateProrations","description":"Bill the partial period on the original billing date, with the next full period."},{"value":"always_invoice","name":"AlwaysInvoice","description":"Bill the partial period now, net of any unused time credited at the pause. A negative amount charges nothing and goes to the customer's balance."}]},"example":"always_invoice"},{"type":"null","description":"How the partial period is billed when `billing_cycle_anchor` is `unchanged`. `null` otherwise.","example":"always_invoice"}]},"credit":{"type":"string","enum":["unused_time","none"],"x-ms-enum":{"name":"SubscriptionPauseCredit","modelAsString":false,"values":[{"value":"unused_time","name":"UnusedTime","description":"Credit the unused paid time from the pause to the period end. The resume charge is net of it."},{"value":"none","name":"None","description":"Credit nothing for the paused days inside the paid period. A resume before the period ends keeps the paid days after it."}]},"description":"What the pause credited for the paid time left in the period.","example":"unused_time","default":"unused_time"}}},{"type":"null","description":"The current pause. Present only while the subscription is paused."}]}}},{"type":"null","description":"The subscription that this invoice was prepared for."}]},"paid_at":{"oneOf":[{"type":"string","description":"When the invoice was paid.","example":"string"},{"type":"null","description":"When the invoice was paid."}]},"metadata":{"oneOf":[{"type":"object","description":"Metadata associated with the invoice.","example":{"order_id":"8842","channel":"shopify"}},{"type":"null","description":"Metadata associated with the invoice.","example":{"order_id":"8842","channel":"shopify"}}]},"backup_charge_status":{"oneOf":[{"type":"string","description":"Outcome of the backup-payment-method fallback for this invoice. Omitted when no fallback applied. `succeeded` on a paid invoice means the subscription's backup card covered this renewal after the default payment method failed.","enum":["pending","succeeded","failed","skipped"],"example":"pending"},{"type":"null","description":"Outcome of the backup-payment-method fallback for this invoice. Omitted when no fallback applied. `succeeded` on a paid invoice means the subscription's backup card covered this renewal after the default payment method failed."}]}}},{"type":"null","description":"The invoice this charge is for if one exists."}]},"failure_message":{"oneOf":[{"type":"string","description":"Message to user further explaining reason for charge failure if available.","example":"Premium SPF 50 mineral sunscreen"},{"type":"null","description":"Message to user further explaining reason for charge failure if available.","example":"Premium SPF 50 mineral sunscreen"}]},"refunds":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"An expandable field — either a string ID or an expanded Refund object.","example":"fre_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"object","description":"An expandable field — either a string ID or an expanded Refund object.","required":["amount","created_at","refund_id","status","test_mode"],"example":"fre_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"refund_id":{"description":"The ID of the refund","type":"string","example":"fre_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},"amount":{"description":"The amount of the refund in cents","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true},"created_at":{"description":"The time at which the refund was created. ISO 8601 format.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true},"status":{"description":"The status of the refund","type":"string","enum":["pending","requires_action","succeeded","failed","canceled"],"example":"pending","isRequired":true},"test_mode":{"description":"Whether the refund was created in test mode","type":"boolean","example":false,"isRequired":true},"payment_intent_id":{"oneOf":[{"type":"string","description":"The ID of the payment intent that the refund is associated with","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"The ID of the payment intent that the refund is associated with","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"reason":{"oneOf":[{"type":"string","description":"The reason for the refund","enum":["duplicate","fraudulent","requested_by_customer","expired_uncaptured_charge"],"example":"duplicate"},{"type":"null","description":"The reason for the refund"}]},"metadata":{"oneOf":[{"type":"object","description":"Metadata attached to the refund","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"string"}},{"type":"null","description":"Metadata attached to the refund","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"string"}}]},"reference_id":{"oneOf":[{"type":"string","description":"Reference number that the customer can use to trace this refund with their bank or card issuer.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"Reference number that the customer can use to trace this refund with their bank or card issuer.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"reference_type":{"oneOf":[{"type":"string","description":"Type of the reference number used for the refund","enum":["acquirer_reference_number","system_trace_audit_number","retrieval_reference_number"],"example":"acquirer_reference_number"},{"type":"null","description":"Type of the reference number used for the refund"}]},"reference_status":{"oneOf":[{"type":"string","description":"Status of the reference number used for the refund","enum":["available","pending","unavailable"],"example":"available"},{"type":"null","description":"Status of the reference number used for the refund"}]},"items":{"description":"List of refund items (charges that were refunded)","default":[],"type":"array","items":{"description":"Represents a single refund item (charge that was refunded)","type":"object","required":["amount_refunded"],"properties":{"amount_refunded":{"description":"The amount refunded from this charge in cents","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true},"payment_intent":{"oneOf":[{"type":"string","description":"The ID of the payment intent that the refund is associated with","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"The ID of the payment intent that the refund is associated with","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"payment_method_id":{"oneOf":[{"type":"string","description":"The ID of the payment method used for this refund","example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"The ID of the payment method used for this refund","example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"reference_id":{"oneOf":[{"type":"string","description":"Reference number that the customer can use to trace this refund with their bank or card issuer.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"Reference number that the customer can use to trace this refund with their bank or card issuer.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"reference_type":{"oneOf":[{"type":"string","description":"Type of the reference number used for the refund","enum":["acquirer_reference_number","system_trace_audit_number","retrieval_reference_number"],"example":"acquirer_reference_number"},{"type":"null","description":"Type of the reference number used for the refund"}]},"reference_status":{"oneOf":[{"type":"string","description":"Status of the reference number used for the refund","enum":["available","pending","unavailable"],"example":"available"},{"type":"null","description":"Status of the reference number used for the refund"}]}},"example":{"amount_refunded":2500,"payment_intent":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","payment_method_id":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA","reference_id":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","reference_type":"acquirer_reference_number","reference_status":"available"}}},"subscription_id":{"oneOf":[{"type":"string","description":"The subscription this refund is associated with (for subscription cancellation refunds)","example":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"The subscription this refund is associated with (for subscription cancellation refunds)","example":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"invoice_id":{"oneOf":[{"type":"string","description":"The invoice this refund is associated with (for subscription billing period refunds)","example":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"The invoice this refund is associated with (for subscription billing period refunds)","example":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"balance_transaction":{"oneOf":[{"type":"string","description":"Balance transaction that describes the impact of this refund on your balance. Defaults to the balance transaction ID; use `?expand=balance_transaction` to inflate the full object.","example":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"object","description":"Balance transaction that describes the impact of this refund on your balance. Defaults to the balance transaction ID; use `?expand=balance_transaction` to inflate the full object.","required":["amount","balance_transaction_id","fee","net","status","test_mode"],"example":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"balance_transaction_id":{"description":"Unique identifier for the balance transaction, prefixed with `fbtxn_`.","type":"string","example":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},"amount":{"description":"Gross amount of the transaction, in the smallest currency unit (e.g., `1000` = $10.00 USD). Positive for funds added to your balance (e.g., charges) and negative for funds removed (e.g., refunds, payouts, dispute debits).","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true},"fee":{"description":"Total processing fee deducted from `amount`, in the smallest currency unit (e.g., `30` = $0.30 USD). `0` when no fee applies.","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true},"net":{"description":"Net amount that affects your balance after `fee` is applied (`net = amount - fee`), in the smallest currency unit (e.g., `970` = $9.70 USD).","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true},"status":{"type":"string","enum":["available","pending"],"x-ms-enum":{"name":"BalanceTransactionStatus","modelAsString":false,"values":[{"value":"available","name":"Available","description":"Funds have settled and are available to be paid out."},{"value":"pending","name":"Pending","description":"Funds are not yet available."}]},"description":"Availability status of the funds: `pending` (not yet available) or `available` (settled and withdrawable).","example":"available","isRequired":true},"test_mode":{"description":"Whether this transaction was created in test mode. `true` for test-mode data, `false` for live data.","type":"boolean","example":false,"isRequired":true},"available_on":{"oneOf":[{"type":"string","description":"When the funds become available in your bank account. RFC 3339 timestamp.","example":"string"},{"type":"null","description":"When the funds become available in your bank account. RFC 3339 timestamp."}]},"created_at":{"oneOf":[{"type":"string","description":"When the transaction was created. RFC 3339 timestamp.","example":"2026-06-15T14:30:00Z"},{"type":"null","description":"When the transaction was created. RFC 3339 timestamp.","example":"2026-06-15T14:30:00Z"}]},"exchange_rate":{"oneOf":[{"type":"number","description":"The exchange rate applied if the transaction involved a currency conversion. `null` when no conversion took place.","format":"double","example":1},{"type":"null","description":"The exchange rate applied if the transaction involved a currency conversion. `null` when no conversion took place.","format":"double","example":1}]},"reporting_category":{"oneOf":[{"type":"string","description":"High-level accounting category for the transaction. `null` if not yet categorized.","example":"example_value"},{"type":"null","description":"High-level accounting category for the transaction. `null` if not yet categorized.","example":"example_value"}]},"checkout_session_id":{"oneOf":[{"type":"string","description":"ID of the Checkout Session that originated this transaction, if it stems from a checkout.","example":"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"ID of the Checkout Session that originated this transaction, if it stems from a checkout.","example":"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"client_reference_id":{"oneOf":[{"type":"string","description":"Your own identifier for the originating object, carried over from the checkout session or payment.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"Your own identifier for the originating object, carried over from the checkout session or payment.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"source_id":{"oneOf":[{"type":"string","description":"ID of the Flex object that produced this transaction (e.g., a Charge `fch_`, Refund `fre_`, or Payout `fpo_`). `null` if the source has not been resolved to a Flex object.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"ID of the Flex object that produced this transaction (e.g., a Charge `fch_`, Refund `fre_`, or Payout `fpo_`). `null` if the source has not been resolved to a Flex object.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"type":{"oneOf":[{"type":"string","description":"The type of transaction."},{"type":"null","description":"The type of transaction."}]},"flex_payment_intent_id":{"oneOf":[{"type":"string","description":"ID of the Payment Intent associated with this transaction, if any. `null` for transactions not tied to a payment (e.g., payouts).","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"ID of the Payment Intent associated with this transaction, if any. `null` for transactions not tied to a payment (e.g., payouts).","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"mid":{"oneOf":[{"type":"string","description":"Merchant identifier (MID) for the account that processed the transaction.","example":"example_value"},{"type":"null","description":"Merchant identifier (MID) for the account that processed the transaction.","example":"example_value"}]},"currency":{"oneOf":[{"type":"string","description":"Three-letter ISO currency code, in lowercase (e.g., `usd`).","example":"usd"},{"type":"null","description":"Three-letter ISO currency code, in lowercase (e.g., `usd`).","example":"usd"}]},"metadata":{"oneOf":[{"type":"object","description":"Set of key-value pairs you can attach to the object for storing additional structured information.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"string"}},{"type":"null","description":"Set of key-value pairs you can attach to the object for storing additional structured information.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"string"}}]},"transaction_fee_amount":{"oneOf":[{"type":"integer","description":"Portion of `fee` attributable to standard transaction processing, in the smallest currency unit. `null` if not broken out.","format":"int32","maximum":2147483647,"minimum":-2147483648},{"type":"null","description":"Portion of `fee` attributable to standard transaction processing, in the smallest currency unit. `null` if not broken out.","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"interchange_fee_amount":{"oneOf":[{"type":"integer","description":"Portion of `fee` attributable to card-network interchange, in the smallest currency unit. `null` if not broken out.","format":"int32","maximum":2147483647,"minimum":-2147483648},{"type":"null","description":"Portion of `fee` attributable to card-network interchange, in the smallest currency unit. `null` if not broken out.","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"lmn_fee_amount":{"oneOf":[{"type":"integer","description":"Portion of `fee` attributable to Letter of Medical Necessity (LMN) processing, in the smallest currency unit. `null` if not applicable.","format":"int32","maximum":2147483647,"minimum":-2147483648},{"type":"null","description":"Portion of `fee` attributable to Letter of Medical Necessity (LMN) processing, in the smallest currency unit. `null` if not applicable.","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"dispute_fee_amount":{"oneOf":[{"type":"integer","description":"Portion of `fee` attributable to a dispute, in the smallest currency unit. `null` if not applicable.","format":"int32","maximum":2147483647,"minimum":-2147483648},{"type":"null","description":"Portion of `fee` attributable to a dispute, in the smallest currency unit. `null` if not applicable.","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"card_type":{"oneOf":[{"type":"string","description":"Card funding type used for the transaction."},{"type":"null","description":"Card funding type used for the transaction."}]},"card_network":{"oneOf":[{"type":"string","description":"Card network used for the transaction (e.g., `visa`, `mastercard`)."},{"type":"null","description":"Card network used for the transaction (e.g., `visa`, `mastercard`)."}]}}},{"type":"null","description":"Balance transaction that describes the impact of this refund on your balance. Defaults to the balance transaction ID; use `?expand=balance_transaction` to inflate the full object."}]},"failure_balance_transaction":{"oneOf":[{"type":"string","description":"After a refund fails, the balance transaction describing the adjustment that returns the funds to your balance.","example":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"object","description":"After a refund fails, the balance transaction describing the adjustment that returns the funds to your balance.","required":["amount","balance_transaction_id","fee","net","status","test_mode"],"example":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"balance_transaction_id":{"description":"Unique identifier for the balance transaction, prefixed with `fbtxn_`.","type":"string","example":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},"amount":{"description":"Gross amount of the transaction, in the smallest currency unit (e.g., `1000` = $10.00 USD). Positive for funds added to your balance (e.g., charges) and negative for funds removed (e.g., refunds, payouts, dispute debits).","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true},"fee":{"description":"Total processing fee deducted from `amount`, in the smallest currency unit (e.g., `30` = $0.30 USD). `0` when no fee applies.","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true},"net":{"description":"Net amount that affects your balance after `fee` is applied (`net = amount - fee`), in the smallest currency unit (e.g., `970` = $9.70 USD).","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true},"status":{"type":"string","enum":["available","pending"],"x-ms-enum":{"name":"BalanceTransactionStatus","modelAsString":false,"values":[{"value":"available","name":"Available","description":"Funds have settled and are available to be paid out."},{"value":"pending","name":"Pending","description":"Funds are not yet available."}]},"description":"Availability status of the funds: `pending` (not yet available) or `available` (settled and withdrawable).","example":"available","isRequired":true},"test_mode":{"description":"Whether this transaction was created in test mode. `true` for test-mode data, `false` for live data.","type":"boolean","example":false,"isRequired":true},"available_on":{"oneOf":[{"type":"string","description":"When the funds become available in your bank account. RFC 3339 timestamp.","example":"string"},{"type":"null","description":"When the funds become available in your bank account. RFC 3339 timestamp."}]},"created_at":{"oneOf":[{"type":"string","description":"When the transaction was created. RFC 3339 timestamp.","example":"2026-06-15T14:30:00Z"},{"type":"null","description":"When the transaction was created. RFC 3339 timestamp.","example":"2026-06-15T14:30:00Z"}]},"exchange_rate":{"oneOf":[{"type":"number","description":"The exchange rate applied if the transaction involved a currency conversion. `null` when no conversion took place.","format":"double","example":1},{"type":"null","description":"The exchange rate applied if the transaction involved a currency conversion. `null` when no conversion took place.","format":"double","example":1}]},"reporting_category":{"oneOf":[{"type":"string","description":"High-level accounting category for the transaction. `null` if not yet categorized.","example":"example_value"},{"type":"null","description":"High-level accounting category for the transaction. `null` if not yet categorized.","example":"example_value"}]},"checkout_session_id":{"oneOf":[{"type":"string","description":"ID of the Checkout Session that originated this transaction, if it stems from a checkout.","example":"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"ID of the Checkout Session that originated this transaction, if it stems from a checkout.","example":"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"client_reference_id":{"oneOf":[{"type":"string","description":"Your own identifier for the originating object, carried over from the checkout session or payment.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"Your own identifier for the originating object, carried over from the checkout session or payment.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"source_id":{"oneOf":[{"type":"string","description":"ID of the Flex object that produced this transaction (e.g., a Charge `fch_`, Refund `fre_`, or Payout `fpo_`). `null` if the source has not been resolved to a Flex object.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"ID of the Flex object that produced this transaction (e.g., a Charge `fch_`, Refund `fre_`, or Payout `fpo_`). `null` if the source has not been resolved to a Flex object.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"type":{"oneOf":[{"type":"string","description":"The type of transaction."},{"type":"null","description":"The type of transaction."}]},"flex_payment_intent_id":{"oneOf":[{"type":"string","description":"ID of the Payment Intent associated with this transaction, if any. `null` for transactions not tied to a payment (e.g., payouts).","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"ID of the Payment Intent associated with this transaction, if any. `null` for transactions not tied to a payment (e.g., payouts).","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"mid":{"oneOf":[{"type":"string","description":"Merchant identifier (MID) for the account that processed the transaction.","example":"example_value"},{"type":"null","description":"Merchant identifier (MID) for the account that processed the transaction.","example":"example_value"}]},"currency":{"oneOf":[{"type":"string","description":"Three-letter ISO currency code, in lowercase (e.g., `usd`).","example":"usd"},{"type":"null","description":"Three-letter ISO currency code, in lowercase (e.g., `usd`).","example":"usd"}]},"metadata":{"oneOf":[{"type":"object","description":"Set of key-value pairs you can attach to the object for storing additional structured information.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"string"}},{"type":"null","description":"Set of key-value pairs you can attach to the object for storing additional structured information.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"string"}}]},"transaction_fee_amount":{"oneOf":[{"type":"integer","description":"Portion of `fee` attributable to standard transaction processing, in the smallest currency unit. `null` if not broken out.","format":"int32","maximum":2147483647,"minimum":-2147483648},{"type":"null","description":"Portion of `fee` attributable to standard transaction processing, in the smallest currency unit. `null` if not broken out.","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"interchange_fee_amount":{"oneOf":[{"type":"integer","description":"Portion of `fee` attributable to card-network interchange, in the smallest currency unit. `null` if not broken out.","format":"int32","maximum":2147483647,"minimum":-2147483648},{"type":"null","description":"Portion of `fee` attributable to card-network interchange, in the smallest currency unit. `null` if not broken out.","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"lmn_fee_amount":{"oneOf":[{"type":"integer","description":"Portion of `fee` attributable to Letter of Medical Necessity (LMN) processing, in the smallest currency unit. `null` if not applicable.","format":"int32","maximum":2147483647,"minimum":-2147483648},{"type":"null","description":"Portion of `fee` attributable to Letter of Medical Necessity (LMN) processing, in the smallest currency unit. `null` if not applicable.","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"dispute_fee_amount":{"oneOf":[{"type":"integer","description":"Portion of `fee` attributable to a dispute, in the smallest currency unit. `null` if not applicable.","format":"int32","maximum":2147483647,"minimum":-2147483648},{"type":"null","description":"Portion of `fee` attributable to a dispute, in the smallest currency unit. `null` if not applicable.","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"card_type":{"oneOf":[{"type":"string","description":"Card funding type used for the transaction."},{"type":"null","description":"Card funding type used for the transaction."}]},"card_network":{"oneOf":[{"type":"string","description":"Card network used for the transaction (e.g., `visa`, `mastercard`)."},{"type":"null","description":"Card network used for the transaction (e.g., `visa`, `mastercard`)."}]}}},{"type":"null","description":"After a refund fails, the balance transaction describing the adjustment that returns the funds to your balance."}]}}}]},"description":"A list of refunds that have been applied to the charge."},{"type":"null","description":"A list of refunds that have been applied to the charge."}]},"transfer_group":{"oneOf":[{"type":"string","description":"A string that identifies the resulting payment as part of a group","example":"example_value"},{"type":"null","description":"A string that identifies the resulting payment as part of a group","example":"example_value"}]},"payment_method_id":{"oneOf":[{"type":"string","description":"The ID of the PaymentMethod.","example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"The ID of the PaymentMethod.","example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"three_d_secure":{"oneOf":[{"type":"object","description":"3D Secure authentication outcome details, if 3DS was used.","example":{"authentication_flow":"string","result":"string","result_reason":"string","version":"string"},"properties":{"authentication_flow":{"oneOf":[{"type":"string","description":"How the customer was authenticated: `challenge` or `frictionless`."},{"type":"null","description":"How the customer was authenticated: `challenge` or `frictionless`."}]},"result":{"oneOf":[{"type":"string","description":"Outcome of 3D Secure authentication."},{"type":"null","description":"Outcome of 3D Secure authentication."}]},"result_reason":{"oneOf":[{"type":"string","description":"Additional detail about why 3DS succeeded or failed."},{"type":"null","description":"Additional detail about why 3DS succeeded or failed."}]},"version":{"oneOf":[{"type":"string","description":"The version of 3D Secure used."},{"type":"null","description":"The version of 3D Secure used."}]}}},{"type":"null","description":"3D Secure authentication outcome details, if 3DS was used."}]},"decline_details":{"oneOf":[{"type":"object","description":"Decline and risk details for failed or blocked charges.","example":{"failure_code":"string","decline_code":"string","failure_message":"string","outcome_type":"string","network_status":"string","seller_message":"string","reason":"string","risk_level":"string"},"properties":{"failure_code":{"oneOf":[{"type":"string","description":"Error code for the charge failure (e.g. `card_declined`, `expired_card`)."},{"type":"null","description":"Error code for the charge failure (e.g. `card_declined`, `expired_card`)."}]},"decline_code":{"oneOf":[{"type":"string","description":"More specific decline reason (e.g. `insufficient_funds`, `lost_card`)."},{"type":"null","description":"More specific decline reason (e.g. `insufficient_funds`, `lost_card`)."}]},"failure_message":{"oneOf":[{"type":"string","description":"User-facing failure message."},{"type":"null","description":"User-facing failure message."}]},"outcome_type":{"oneOf":[{"type":"string","description":"The outcome type of the decline."},{"type":"null","description":"The outcome type of the decline."}]},"network_status":{"oneOf":[{"type":"string","description":"Network-level status: `approved_by_network`, `declined_by_network`, etc."},{"type":"null","description":"Network-level status: `approved_by_network`, `declined_by_network`, etc."}]},"seller_message":{"oneOf":[{"type":"string","description":"Technical explanation of the outcome for the merchant."},{"type":"null","description":"Technical explanation of the outcome for the merchant."}]},"reason":{"oneOf":[{"type":"string","description":"Fraud/risk reason (e.g. `elevated_risk_level`)."},{"type":"null","description":"Fraud/risk reason (e.g. `elevated_risk_level`)."}]},"risk_level":{"oneOf":[{"type":"string","description":"The risk level assessed for the payment."},{"type":"null","description":"The risk level assessed for the payment."}]}}},{"type":"null","description":"Decline and risk details for failed or blocked charges."}]},"balance_transaction":{"oneOf":[{"type":"string","description":"Balance transaction that describes the impact of this charge on your balance. Populated on successful capture, returned as the balance transaction ID. Always serialized; `null` for uncaptured charges.","example":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"object","description":"Balance transaction that describes the impact of this charge on your balance. Populated on successful capture, returned as the balance transaction ID. Always serialized; `null` for uncaptured charges.","required":["amount","balance_transaction_id","fee","net","status","test_mode"],"example":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"balance_transaction_id":{"description":"Unique identifier for the balance transaction, prefixed with `fbtxn_`.","type":"string","example":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},"amount":{"description":"Gross amount of the transaction, in the smallest currency unit (e.g., `1000` = $10.00 USD). Positive for funds added to your balance (e.g., charges) and negative for funds removed (e.g., refunds, payouts, dispute debits).","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true},"fee":{"description":"Total processing fee deducted from `amount`, in the smallest currency unit (e.g., `30` = $0.30 USD). `0` when no fee applies.","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true},"net":{"description":"Net amount that affects your balance after `fee` is applied (`net = amount - fee`), in the smallest currency unit (e.g., `970` = $9.70 USD).","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true},"status":{"type":"string","enum":["available","pending"],"x-ms-enum":{"name":"BalanceTransactionStatus","modelAsString":false,"values":[{"value":"available","name":"Available","description":"Funds have settled and are available to be paid out."},{"value":"pending","name":"Pending","description":"Funds are not yet available."}]},"description":"Availability status of the funds: `pending` (not yet available) or `available` (settled and withdrawable).","example":"available","isRequired":true},"test_mode":{"description":"Whether this transaction was created in test mode. `true` for test-mode data, `false` for live data.","type":"boolean","example":false,"isRequired":true},"available_on":{"oneOf":[{"type":"string","description":"When the funds become available in your bank account. RFC 3339 timestamp.","example":"string"},{"type":"null","description":"When the funds become available in your bank account. RFC 3339 timestamp."}]},"created_at":{"oneOf":[{"type":"string","description":"When the transaction was created. RFC 3339 timestamp.","example":"2026-06-15T14:30:00Z"},{"type":"null","description":"When the transaction was created. RFC 3339 timestamp.","example":"2026-06-15T14:30:00Z"}]},"exchange_rate":{"oneOf":[{"type":"number","description":"The exchange rate applied if the transaction involved a currency conversion. `null` when no conversion took place.","format":"double","example":1},{"type":"null","description":"The exchange rate applied if the transaction involved a currency conversion. `null` when no conversion took place.","format":"double","example":1}]},"reporting_category":{"oneOf":[{"type":"string","description":"High-level accounting category for the transaction. `null` if not yet categorized.","example":"example_value"},{"type":"null","description":"High-level accounting category for the transaction. `null` if not yet categorized.","example":"example_value"}]},"checkout_session_id":{"oneOf":[{"type":"string","description":"ID of the Checkout Session that originated this transaction, if it stems from a checkout.","example":"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"ID of the Checkout Session that originated this transaction, if it stems from a checkout.","example":"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"client_reference_id":{"oneOf":[{"type":"string","description":"Your own identifier for the originating object, carried over from the checkout session or payment.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"Your own identifier for the originating object, carried over from the checkout session or payment.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"source_id":{"oneOf":[{"type":"string","description":"ID of the Flex object that produced this transaction (e.g., a Charge `fch_`, Refund `fre_`, or Payout `fpo_`). `null` if the source has not been resolved to a Flex object.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"ID of the Flex object that produced this transaction (e.g., a Charge `fch_`, Refund `fre_`, or Payout `fpo_`). `null` if the source has not been resolved to a Flex object.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"type":{"oneOf":[{"type":"string","description":"The type of transaction."},{"type":"null","description":"The type of transaction."}]},"flex_payment_intent_id":{"oneOf":[{"type":"string","description":"ID of the Payment Intent associated with this transaction, if any. `null` for transactions not tied to a payment (e.g., payouts).","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"ID of the Payment Intent associated with this transaction, if any. `null` for transactions not tied to a payment (e.g., payouts).","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"mid":{"oneOf":[{"type":"string","description":"Merchant identifier (MID) for the account that processed the transaction.","example":"example_value"},{"type":"null","description":"Merchant identifier (MID) for the account that processed the transaction.","example":"example_value"}]},"currency":{"oneOf":[{"type":"string","description":"Three-letter ISO currency code, in lowercase (e.g., `usd`).","example":"usd"},{"type":"null","description":"Three-letter ISO currency code, in lowercase (e.g., `usd`).","example":"usd"}]},"metadata":{"oneOf":[{"type":"object","description":"Set of key-value pairs you can attach to the object for storing additional structured information.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"string"}},{"type":"null","description":"Set of key-value pairs you can attach to the object for storing additional structured information.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"string"}}]},"transaction_fee_amount":{"oneOf":[{"type":"integer","description":"Portion of `fee` attributable to standard transaction processing, in the smallest currency unit. `null` if not broken out.","format":"int32","maximum":2147483647,"minimum":-2147483648},{"type":"null","description":"Portion of `fee` attributable to standard transaction processing, in the smallest currency unit. `null` if not broken out.","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"interchange_fee_amount":{"oneOf":[{"type":"integer","description":"Portion of `fee` attributable to card-network interchange, in the smallest currency unit. `null` if not broken out.","format":"int32","maximum":2147483647,"minimum":-2147483648},{"type":"null","description":"Portion of `fee` attributable to card-network interchange, in the smallest currency unit. `null` if not broken out.","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"lmn_fee_amount":{"oneOf":[{"type":"integer","description":"Portion of `fee` attributable to Letter of Medical Necessity (LMN) processing, in the smallest currency unit. `null` if not applicable.","format":"int32","maximum":2147483647,"minimum":-2147483648},{"type":"null","description":"Portion of `fee` attributable to Letter of Medical Necessity (LMN) processing, in the smallest currency unit. `null` if not applicable.","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"dispute_fee_amount":{"oneOf":[{"type":"integer","description":"Portion of `fee` attributable to a dispute, in the smallest currency unit. `null` if not applicable.","format":"int32","maximum":2147483647,"minimum":-2147483648},{"type":"null","description":"Portion of `fee` attributable to a dispute, in the smallest currency unit. `null` if not applicable.","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"card_type":{"oneOf":[{"type":"string","description":"Card funding type used for the transaction."},{"type":"null","description":"Card funding type used for the transaction."}]},"card_network":{"oneOf":[{"type":"string","description":"Card network used for the transaction (e.g., `visa`, `mastercard`)."},{"type":"null","description":"Card network used for the transaction (e.g., `visa`, `mastercard`)."}]}}},{"type":"null","description":"Balance transaction that describes the impact of this charge on your balance. Populated on successful capture, returned as the balance transaction ID. Always serialized; `null` for uncaptured charges."}]},"failure_balance_transaction":{"oneOf":[{"type":"string","description":"Reversal balance transaction created when a captured charge fails or is otherwise reversed and funds are credited back. Always serialized; `null` on the common success path.","example":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"object","description":"Reversal balance transaction created when a captured charge fails or is otherwise reversed and funds are credited back. Always serialized; `null` on the common success path.","required":["amount","balance_transaction_id","fee","net","status","test_mode"],"example":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"balance_transaction_id":{"description":"Unique identifier for the balance transaction, prefixed with `fbtxn_`.","type":"string","example":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},"amount":{"description":"Gross amount of the transaction, in the smallest currency unit (e.g., `1000` = $10.00 USD). Positive for funds added to your balance (e.g., charges) and negative for funds removed (e.g., refunds, payouts, dispute debits).","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true},"fee":{"description":"Total processing fee deducted from `amount`, in the smallest currency unit (e.g., `30` = $0.30 USD). `0` when no fee applies.","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true},"net":{"description":"Net amount that affects your balance after `fee` is applied (`net = amount - fee`), in the smallest currency unit (e.g., `970` = $9.70 USD).","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true},"status":{"type":"string","enum":["available","pending"],"x-ms-enum":{"name":"BalanceTransactionStatus","modelAsString":false,"values":[{"value":"available","name":"Available","description":"Funds have settled and are available to be paid out."},{"value":"pending","name":"Pending","description":"Funds are not yet available."}]},"description":"Availability status of the funds: `pending` (not yet available) or `available` (settled and withdrawable).","example":"available","isRequired":true},"test_mode":{"description":"Whether this transaction was created in test mode. `true` for test-mode data, `false` for live data.","type":"boolean","example":false,"isRequired":true},"available_on":{"oneOf":[{"type":"string","description":"When the funds become available in your bank account. RFC 3339 timestamp.","example":"string"},{"type":"null","description":"When the funds become available in your bank account. RFC 3339 timestamp."}]},"created_at":{"oneOf":[{"type":"string","description":"When the transaction was created. RFC 3339 timestamp.","example":"2026-06-15T14:30:00Z"},{"type":"null","description":"When the transaction was created. RFC 3339 timestamp.","example":"2026-06-15T14:30:00Z"}]},"exchange_rate":{"oneOf":[{"type":"number","description":"The exchange rate applied if the transaction involved a currency conversion. `null` when no conversion took place.","format":"double","example":1},{"type":"null","description":"The exchange rate applied if the transaction involved a currency conversion. `null` when no conversion took place.","format":"double","example":1}]},"reporting_category":{"oneOf":[{"type":"string","description":"High-level accounting category for the transaction. `null` if not yet categorized.","example":"example_value"},{"type":"null","description":"High-level accounting category for the transaction. `null` if not yet categorized.","example":"example_value"}]},"checkout_session_id":{"oneOf":[{"type":"string","description":"ID of the Checkout Session that originated this transaction, if it stems from a checkout.","example":"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"ID of the Checkout Session that originated this transaction, if it stems from a checkout.","example":"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"client_reference_id":{"oneOf":[{"type":"string","description":"Your own identifier for the originating object, carried over from the checkout session or payment.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"Your own identifier for the originating object, carried over from the checkout session or payment.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"source_id":{"oneOf":[{"type":"string","description":"ID of the Flex object that produced this transaction (e.g., a Charge `fch_`, Refund `fre_`, or Payout `fpo_`). `null` if the source has not been resolved to a Flex object.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"ID of the Flex object that produced this transaction (e.g., a Charge `fch_`, Refund `fre_`, or Payout `fpo_`). `null` if the source has not been resolved to a Flex object.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"type":{"oneOf":[{"type":"string","description":"The type of transaction."},{"type":"null","description":"The type of transaction."}]},"flex_payment_intent_id":{"oneOf":[{"type":"string","description":"ID of the Payment Intent associated with this transaction, if any. `null` for transactions not tied to a payment (e.g., payouts).","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"ID of the Payment Intent associated with this transaction, if any. `null` for transactions not tied to a payment (e.g., payouts).","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"mid":{"oneOf":[{"type":"string","description":"Merchant identifier (MID) for the account that processed the transaction.","example":"example_value"},{"type":"null","description":"Merchant identifier (MID) for the account that processed the transaction.","example":"example_value"}]},"currency":{"oneOf":[{"type":"string","description":"Three-letter ISO currency code, in lowercase (e.g., `usd`).","example":"usd"},{"type":"null","description":"Three-letter ISO currency code, in lowercase (e.g., `usd`).","example":"usd"}]},"metadata":{"oneOf":[{"type":"object","description":"Set of key-value pairs you can attach to the object for storing additional structured information.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"string"}},{"type":"null","description":"Set of key-value pairs you can attach to the object for storing additional structured information.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"string"}}]},"transaction_fee_amount":{"oneOf":[{"type":"integer","description":"Portion of `fee` attributable to standard transaction processing, in the smallest currency unit. `null` if not broken out.","format":"int32","maximum":2147483647,"minimum":-2147483648},{"type":"null","description":"Portion of `fee` attributable to standard transaction processing, in the smallest currency unit. `null` if not broken out.","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"interchange_fee_amount":{"oneOf":[{"type":"integer","description":"Portion of `fee` attributable to card-network interchange, in the smallest currency unit. `null` if not broken out.","format":"int32","maximum":2147483647,"minimum":-2147483648},{"type":"null","description":"Portion of `fee` attributable to card-network interchange, in the smallest currency unit. `null` if not broken out.","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"lmn_fee_amount":{"oneOf":[{"type":"integer","description":"Portion of `fee` attributable to Letter of Medical Necessity (LMN) processing, in the smallest currency unit. `null` if not applicable.","format":"int32","maximum":2147483647,"minimum":-2147483648},{"type":"null","description":"Portion of `fee` attributable to Letter of Medical Necessity (LMN) processing, in the smallest currency unit. `null` if not applicable.","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"dispute_fee_amount":{"oneOf":[{"type":"integer","description":"Portion of `fee` attributable to a dispute, in the smallest currency unit. `null` if not applicable.","format":"int32","maximum":2147483647,"minimum":-2147483648},{"type":"null","description":"Portion of `fee` attributable to a dispute, in the smallest currency unit. `null` if not applicable.","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"card_type":{"oneOf":[{"type":"string","description":"Card funding type used for the transaction."},{"type":"null","description":"Card funding type used for the transaction."}]},"card_network":{"oneOf":[{"type":"string","description":"Card network used for the transaction (e.g., `visa`, `mastercard`)."},{"type":"null","description":"Card network used for the transaction (e.g., `visa`, `mastercard`)."}]}}},{"type":"null","description":"Reversal balance transaction created when a captured charge fails or is otherwise reversed and funds are credited back. Always serialized; `null` on the common success path."}]}}},{"type":"null","description":"The latest charge associated with the payment intent."}]},"invoice":{"oneOf":[{"type":"string","description":"The invoice associated with the payment intent.","example":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"object","description":"The invoice associated with the payment intent.","required":["amount_due","amount_paid","collection_method","created_at","invoice_id","status","test_mode","total"],"example":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"invoice_id":{"description":"The id of the invoice.","type":"string","example":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},"total":{"description":"The total amount of the invoice in cents.","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true},"amount_due":{"description":"The amount due in cents.","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true},"amount_paid":{"description":"The amount paid in cents.","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true},"status":{"description":"The status of the invoice.","type":"string","enum":["draft","open","void","paid","uncollectible"],"example":"draft","isRequired":true},"collection_method":{"description":"Either charge_automatically or send_invoice. When charging automatically, Flex will attempt to pay this invoice using the default payment method attached to the customer. When sending an invoice, Flex will email this invoice to the customer with payment instructions.","type":"string","enum":["charge_automatically","send_invoice"],"example":"charge_automatically","isRequired":true},"test_mode":{"description":"Whether or not the invoice was created in test mode.","type":"boolean","example":false,"isRequired":true},"created_at":{"description":"When the invoice was created.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true},"payment_intent":{"oneOf":[{"description":"The payment intent associated with this invoice. The payment intent is created when the invoice is finalized."},{"type":"null","description":"The payment intent associated with this invoice. The payment intent is created when the invoice is finalized."}]},"charge":{"oneOf":[{"type":"string","description":"The id of the latest charge for this invoice.","example":"fch_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"The id of the latest charge for this invoice.","example":"fch_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"customer":{"oneOf":[{"type":"string","description":"The id of the customer this invoice is for.","example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"object","description":"The id of the customer this invoice is for.","required":["created_at","customer_id","email","first_name","last_name","test_mode"],"example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"customer_id":{"description":"The unique identifier for the customer.","type":"string","example":"fcus_01HACM7FZ1084XB1GB6053VM0D","isRequired":true},"first_name":{"description":"The customer's first name.","type":"string","example":"John","isRequired":true},"last_name":{"description":"The customer's last name.","type":"string","example":"Doe","isRequired":true},"email":{"description":"The customer's email address.","type":"string","example":"joh.doe@example.com","isRequired":true},"created_at":{"description":"The time the customer was created.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true},"test_mode":{"description":"Whether the customer was created in test mode.","type":"boolean","example":false,"isRequired":true},"owner_partner_id":{"oneOf":[{"type":"string","description":"The partner that owns this customer. When a customer is shared with you by another partner in your organization, this is that sibling partner; otherwise it is your own partner id.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"The partner that owns this customer. When a customer is shared with you by another partner in your organization, this is that sibling partner; otherwise it is your own partner id.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"phone":{"oneOf":[{"type":"string","description":"The customer's phone number.","format":"phone","example":"+15555555555"},{"type":"null","description":"The customer's phone number.","format":"phone","example":"+15555555555"}]},"employer":{"oneOf":[{"type":"string","description":"The customer's employer.","example":"Flex"},{"type":"null","description":"The customer's employer.","example":"Flex"}]},"shipping":{"oneOf":[{"type":"object","description":"The customer's shipping address.","required":["shipping_address_id"],"example":{"shipping_address_id":"fsh_01J9XR8M3K7VZ8N2YB4WJ6T0RA","line1":"123 Main St","line2":"Suite 100","city":"San Francisco","state":"CA","postal_code":"94107","country":"US"},"properties":{"shipping_address_id":{"description":"Unique identifier for the shipping address.","type":"string","example":"fsh_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},"line1":{"oneOf":[{"type":"string","description":"The first line of the street address (e.g., street number and name).","example":"123 Main St"},{"type":"null","description":"The first line of the street address (e.g., street number and name).","example":"123 Main St"}]},"line2":{"oneOf":[{"type":"string","description":"The second line of the street address (e.g., apartment, suite, or unit).","example":"Suite 100"},{"type":"null","description":"The second line of the street address (e.g., apartment, suite, or unit).","example":"Suite 100"}]},"city":{"oneOf":[{"type":"string","description":"City, district, suburb, town, or village.","example":"San Francisco"},{"type":"null","description":"City, district, suburb, town, or village.","example":"San Francisco"}]},"state":{"oneOf":[{"type":"string","description":"State, county, province, or region.","example":"CA"},{"type":"null","description":"State, county, province, or region.","example":"CA"}]},"postal_code":{"oneOf":[{"type":"string","description":"ZIP or postal code.","example":"94107"},{"type":"null","description":"ZIP or postal code.","example":"94107"}]},"country":{"oneOf":[{"type":"string","description":"Two-letter country code (ISO 3166-1 alpha-2, e.g., `US`).","example":"US"},{"type":"null","description":"Two-letter country code (ISO 3166-1 alpha-2, e.g., `US`).","example":"US"}]}}},{"type":"null","description":"The customer's shipping address."}]},"metadata":{"oneOf":[{"type":"object","description":"Metadata associated with the customer.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"string"}},{"type":"null","description":"Metadata associated with the customer.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"string"}}]}}},{"type":"null","description":"The id of the customer this invoice is for."}]},"period_end":{"oneOf":[{"type":"string","description":"End of the usage period.","example":"string"},{"type":"null","description":"End of the usage period."}]},"period_start":{"oneOf":[{"type":"string","description":"Start of the usage period.","example":"string"},{"type":"null","description":"Start of the usage period."}]},"subscription":{"oneOf":[{"type":"string","description":"The subscription that this invoice was prepared for.","example":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"object","description":"The subscription that this invoice was prepared for.","required":["cancel_at_period_end","created_at","items","status","subscription_id","test_mode"],"example":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"subscription_id":{"description":"Unique identifier for the object.","type":"string","example":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},"created_at":{"description":"Time at which the object was created. ISO 8601 format.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true},"items":{"description":"The items the customer is subscribed to.","type":"array","items":{"description":"A Subscription Item represents a single recurring Price billed as part of a Subscription, together with the quantity of that price the customer is subscribed to. A subscription has one item per recurring price it bills.","type":"object","required":["created_at","price","quantity","subscription_item_id","test_mode"],"properties":{"subscription_item_id":{"description":"Unique identifier for the subscription item.","type":"string","example":"fsubi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},"price":{"oneOf":[{"type":"string","description":"The recurring Price this item bills. Returned as a price ID by default, or as the full Price object when expanded.","example":"fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},{"type":"object","description":"The recurring Price this item bills. Returned as a price ID by default, or as the full Price object when expanded.","required":["active","created_at","price_id","product","test_mode","type","unit_amount"],"example":"fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"price_id":{"description":"The unique identifier for the price.","type":"string","example":"fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},"unit_amount":{"description":"The amount to charge per unit, in the smallest currency unit (e.g., `2500` = $25.00 USD).","type":"integer","format":"int32","minimum":-2147483648,"maximum":2147483647,"isRequired":true},"active":{"description":"Whether the price is currently active.","type":"boolean","example":false,"isRequired":true},"product":{"oneOf":[{"type":"string","description":"The product this price belongs to. Returned as a product ID by default, or as the full Product object when expanded.","example":"fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},{"type":"object","description":"The product this price belongs to. Returned as a product ID by default, or as the full Product object when expanded.","required":["active","created_at","hsa_fsa_eligibility","name","product_id","test_mode"],"example":"fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"product_id":{"description":"The unique identifier for the product.","type":"string","example":"fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},"name":{"description":"The name of the product.","type":"string","example":"Example","isRequired":true},"created_at":{"description":"The date the product was created.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true},"active":{"description":"Determines if the product is active or not.","type":"boolean","example":false,"isRequired":true},"hsa_fsa_eligibility":{"description":"The elegibility of the product for HSA/FSA.","type":"string","enum":["not_eligible","auto_substantiation","private_label","letter_of_medical_necessity","prescription","vision","service","pending"],"example":"not_eligible","isRequired":true},"test_mode":{"description":"Whether the product is in test mode or not.","type":"boolean","example":false,"isRequired":true},"owner_partner_id":{"oneOf":[{"type":"string","description":"The ID of the account that owns this product. For products shared across an organization this may be a sibling account; otherwise it is your own account ID.","example":"facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"The ID of the account that owns this product. For products shared across an organization this may be a sibling account; otherwise it is your own account ID.","example":"facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"description":{"oneOf":[{"type":"string","description":"The description of the product.","example":"Premium SPF 50 mineral sunscreen"},{"type":"null","description":"The description of the product.","example":"Premium SPF 50 mineral sunscreen"}]},"document_description":{"oneOf":[{"type":"string","description":"Medical-grade description optimized for use in Letters of Medical Necessity and receipts.","deprecated":true},{"type":"null","description":"Medical-grade description optimized for use in Letters of Medical Necessity and receipts.","deprecated":true}]},"receipt_description":{"oneOf":[{"type":"string","description":"Shortened description tailored to receipt line items"},{"type":"null","description":"Shortened description tailored to receipt line items"}]},"visit_type":{"oneOf":[{"type":"string","description":"The visit type of the product if a letter of medical necessity is required.","enum":["cbtSleep","notApplicable","metabolomics","tinnitus","gym","exerciseDiet","orthopedic","alcohol","airPurification","vaginalHealth","menstrual","canopy","alopecia","genate","weightBlanket","bedJet","siderAl","sunwinkPowder","wavWatch","bodyComplete","ageRate","nitrousOxide","happyV","groupChat","icalmAnxiety","redBloom","foodom","branchErgonomicFurniture","curalife","eloraInfantWellness","nutriHealth","olipop","goldIntimate","touchStoneEssentials","utiva","sleepGeekz","figBrew","auBabyBlanket","babySleepSack","oshWellness","currentBodyRedLight","mito","circularRing","lymaRedLight","goodAirRx","tastermonial","karunaHome","ergoStandingChair","jbaGlucoseControl","bloomNutrition","buoyDrops","luxeWonderWig","saunaMarketplace","amrioreEyewear","pivotOrthoShoe","lumenCynergy","roga","pulsetto","mitoRedLight","gutPersonal","goFlaus","myHixel","calmigo","dotFit","stripesBeauty","mixHers","pmd","positivityWithPurpose","techRing","popVeneers","vertaClean","lumen","medicalMeal","emnHealth","detergentAllergy","lowImpactExercise","mediumImpactExercise","highImpactExercise","gardening","babyCarrier","smartGlasses","automatedCleaner","uvClothing","adaptiveShoes","breathWork","nonenalOdor","meneralsNootropicPouch","babyMonitorSplit","babySleepApp","coolingSleepwear","bodyPillow","uvGlasses","nursingChairs","coolingBed","posture","supplements","sleep","redLightTherapy","fitness","smartRing","womensVaginalHealth","fertilitySupport","femaleReproduction","femaleReproductionFood","pregnancyLiterature","iceBath","orthopedicShoes","sexualHealth","glucose","metabolicTest","skinCare","oralHealth","oralAnxiety","blueLightGlasses","anxiety","brainHealth","babyMonitor","compressionSocks","compressionShorts","waterPurification","medSpa","essentialOils","sleepBuds","latchLight","nutritionist","rairflow","enduranceTraining","hydration","hairGrowth","eD","postureFitness","childDevelopment","adaptiveClothing","sleepConsulting","hairRemoval","menopause","maleFertility","anxietyHealth","bidets","speechHealth","artOfLiving","breastMilk","petSupport","diapers","gutSupplements","smartWatch","medicalBotox","biomechanicalAssessment","erectileReset","femaleOrgasm","pornAddiction","memorySupport","oralHealthMasticGum","orthopedicSandals","childDevelopmentAnxietySleep","childDevelopmentAdjustment","childDevelopmentBehavior","childDevelopmentIdentity","emnHealthMobility","adaptiveShoesDependent","speechHealthDependent","breathWorkDependent"],"example":"cbtSleep"},{"type":"null","description":"The visit type of the product if a letter of medical necessity is required."}]},"upc_code":{"oneOf":[{"type":"string","description":"The upc code of the product."},{"type":"null","description":"The upc code of the product."}]},"gtin":{"oneOf":[{"type":"string","description":"The gtin code of the product."},{"type":"null","description":"The gtin code of the product."}]},"reference_gtin":{"oneOf":[{"type":"string","description":"The GTIN of a private-label reference product, used to establish HSA/FSA eligibility."},{"type":"null","description":"The GTIN of a private-label reference product, used to establish HSA/FSA eligibility."}]},"metadata":{"oneOf":[{"type":"object","description":"Metadata associated with the product.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"string"}},{"type":"null","description":"Metadata associated with the product.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"string"}}]},"url":{"oneOf":[{"type":"string","description":"The URL of the product.","example":"https://example.com"},{"type":"null","description":"The URL of the product.","example":"https://example.com"}]},"client_reference_id":{"oneOf":[{"type":"string","description":"An optional identifier for the product set by the client at creation time. Immutable after creation.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"An optional identifier for the product set by the client at creation time. Immutable after creation.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]}},"isRequired":true}],"isRequired":true},"created_at":{"description":"The date the price was created.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true},"type":{"description":"The type of the price: a single one-time charge, or a recurring charge billed on a schedule.","type":"string","enum":["one_time","recurring"],"example":"one_time","isRequired":true},"test_mode":{"description":"Whether the price is in test mode.","type":"boolean","example":false,"isRequired":true},"owner_partner_id":{"oneOf":[{"type":"string","description":"The ID of the account that owns this price. For prices shared across an organization this may be a sibling account; otherwise it is your own account ID.","example":"facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"The ID of the account that owns this price. For prices shared across an organization this may be a sibling account; otherwise it is your own account ID.","example":"facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"description":{"oneOf":[{"type":"string","description":"The description of the price.","example":"Premium SPF 50 mineral sunscreen"},{"type":"null","description":"The description of the price.","example":"Premium SPF 50 mineral sunscreen"}]},"trial_period_days":{"oneOf":[{"type":"integer","description":"The number of trial period days before the customer is first charged for a recurring price.","format":"int32","maximum":2147483647,"minimum":-2147483648},{"type":"null","description":"The number of trial period days before the customer is first charged for a recurring price.","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"recurring":{"oneOf":[{"type":"object","description":"The recurring components of a price such as interval and trial period days.","required":["interval"],"example":{"interval":"day","interval_count":0,"trial_period_days":0},"properties":{"interval":{"description":"The billing cadence for the price.","type":"string","enum":["day","week","month","year"],"example":"day","isRequired":true},"interval_count":{"oneOf":[{"type":"integer","description":"The number of intervals","format":"int64","maximum":4294967295,"minimum":0},{"type":"null","description":"The number of intervals","format":"int64","maximum":4294967295,"minimum":0}]},"trial_period_days":{"oneOf":[{"type":"integer","description":"The number of trial period days before the customer is charged for the first time. Whole days only. For a precise trial-end timestamp (e.g. non-integer days), use `subscription_data.trial_end` on the Create Checkout Session request instead.","format":"int64","maximum":4294967295,"minimum":0},{"type":"null","description":"The number of trial period days before the customer is charged for the first time. Whole days only. For a precise trial-end timestamp (e.g. non-integer days), use `subscription_data.trial_end` on the Create Checkout Session request instead.","format":"int64","maximum":4294967295,"minimum":0}]}}},{"type":"null","description":"The recurring components of a price such as interval and trial period days."}]},"metadata":{"oneOf":[{"type":"object","description":"Metadata information for the price object","example":{"order_id":"8842","channel":"shopify"}},{"type":"null","description":"Metadata information for the price object","example":{"order_id":"8842","channel":"shopify"}}]},"lookup_key":{"oneOf":[{"type":"string","description":"A stable, partner-owned key for this price. Unique per account and mode across all prices, archived ones included. `null` until you set one.","maxLength":200,"example":"standard_monthly"},{"type":"null","description":"A stable, partner-owned key for this price. Unique per account and mode across all prices, archived ones included. `null` until you set one.","maxLength":200,"example":"standard_monthly"}]},"hsa_fsa_eligibility":{"oneOf":[{"type":"string","description":"The HSA/FSA eligibility for the price.","enum":["not_eligible","auto_substantiation","private_label","letter_of_medical_necessity","prescription","vision","service","pending"],"example":"not_eligible"},{"type":"null","description":"The HSA/FSA eligibility for the price."}]}},"isRequired":true}],"isRequired":true},"quantity":{"description":"The number of units of the price the customer is subscribed to.","type":"integer","format":"int32","example":2500,"minimum":-2147483648,"maximum":2147483647,"isRequired":true},"created_at":{"description":"Time at which the subscription item was created, as an RFC 3339 timestamp.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true},"test_mode":{"description":"Whether the subscription item exists in test mode.","type":"boolean","example":false,"isRequired":true},"updated_at":{"oneOf":[{"type":"string","description":"Time at which the subscription item was last updated, as an RFC 3339 timestamp. `null` if the item has not been updated since creation.","example":"2026-06-15T14:30:00Z"},{"type":"null","description":"Time at which the subscription item was last updated, as an RFC 3339 timestamp. `null` if the item has not been updated since creation.","example":"2026-06-15T14:30:00Z"}]}},"example":{"subscription_item_id":"fsubi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","price":"fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA","quantity":2500,"created_at":"2026-06-15T14:30:00Z","updated_at":"2026-06-15T14:30:00Z","test_mode":false}},"isRequired":true},"status":{"description":"Possible values are incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, or paused.","type":"string","enum":["incomplete","incomplete_expired","trialing","active","past_due","canceled","unpaid","paused"],"example":"incomplete","isRequired":true},"cancel_at_period_end":{"description":"If the subscription has been canceled with the at_period_end flag set to true, cancel_at_period_end on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period.","type":"boolean","example":false,"isRequired":true},"test_mode":{"description":"Whether the subscription is in test mode.","type":"boolean","example":false,"isRequired":true},"latest_invoice":{"oneOf":[{"description":"The ID of the latest invoice generated for this subscription."},{"type":"null","description":"The ID of the latest invoice generated for this subscription."}]},"customer":{"oneOf":[{"type":"string","description":"The ID of the customer who owns the subscription.","example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"object","description":"The ID of the customer who owns the subscription.","required":["created_at","customer_id","email","first_name","last_name","test_mode"],"example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"customer_id":{"description":"The unique identifier for the customer.","type":"string","example":"fcus_01HACM7FZ1084XB1GB6053VM0D","isRequired":true},"first_name":{"description":"The customer's first name.","type":"string","example":"John","isRequired":true},"last_name":{"description":"The customer's last name.","type":"string","example":"Doe","isRequired":true},"email":{"description":"The customer's email address.","type":"string","example":"joh.doe@example.com","isRequired":true},"created_at":{"description":"The time the customer was created.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true},"test_mode":{"description":"Whether the customer was created in test mode.","type":"boolean","example":false,"isRequired":true},"owner_partner_id":{"oneOf":[{"type":"string","description":"The partner that owns this customer. When a customer is shared with you by another partner in your organization, this is that sibling partner; otherwise it is your own partner id.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"The partner that owns this customer. When a customer is shared with you by another partner in your organization, this is that sibling partner; otherwise it is your own partner id.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"phone":{"oneOf":[{"type":"string","description":"The customer's phone number.","format":"phone","example":"+15555555555"},{"type":"null","description":"The customer's phone number.","format":"phone","example":"+15555555555"}]},"employer":{"oneOf":[{"type":"string","description":"The customer's employer.","example":"Flex"},{"type":"null","description":"The customer's employer.","example":"Flex"}]},"shipping":{"oneOf":[{"type":"object","description":"The customer's shipping address.","required":["shipping_address_id"],"example":{"shipping_address_id":"fsh_01J9XR8M3K7VZ8N2YB4WJ6T0RA","line1":"123 Main St","line2":"Suite 100","city":"San Francisco","state":"CA","postal_code":"94107","country":"US"},"properties":{"shipping_address_id":{"description":"Unique identifier for the shipping address.","type":"string","example":"fsh_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},"line1":{"oneOf":[{"type":"string","description":"The first line of the street address (e.g., street number and name).","example":"123 Main St"},{"type":"null","description":"The first line of the street address (e.g., street number and name).","example":"123 Main St"}]},"line2":{"oneOf":[{"type":"string","description":"The second line of the street address (e.g., apartment, suite, or unit).","example":"Suite 100"},{"type":"null","description":"The second line of the street address (e.g., apartment, suite, or unit).","example":"Suite 100"}]},"city":{"oneOf":[{"type":"string","description":"City, district, suburb, town, or village.","example":"San Francisco"},{"type":"null","description":"City, district, suburb, town, or village.","example":"San Francisco"}]},"state":{"oneOf":[{"type":"string","description":"State, county, province, or region.","example":"CA"},{"type":"null","description":"State, county, province, or region.","example":"CA"}]},"postal_code":{"oneOf":[{"type":"string","description":"ZIP or postal code.","example":"94107"},{"type":"null","description":"ZIP or postal code.","example":"94107"}]},"country":{"oneOf":[{"type":"string","description":"Two-letter country code (ISO 3166-1 alpha-2, e.g., `US`).","example":"US"},{"type":"null","description":"Two-letter country code (ISO 3166-1 alpha-2, e.g., `US`).","example":"US"}]}}},{"type":"null","description":"The customer's shipping address."}]},"metadata":{"oneOf":[{"type":"object","description":"Metadata associated with the customer.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"string"}},{"type":"null","description":"Metadata associated with the customer.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"string"}}]}}},{"type":"null","description":"The ID of the customer who owns the subscription."}]},"current_period_end":{"oneOf":[{"type":"string","description":"End of the current period that the subscription has been invoiced for.","example":"string"},{"type":"null","description":"End of the current period that the subscription has been invoiced for."}]},"current_period_start":{"oneOf":[{"type":"string","description":"Start of the current period that the subscription has been invoiced for.","example":"string"},{"type":"null","description":"Start of the current period that the subscription has been invoiced for."}]},"metadata":{"oneOf":[{"type":"object","description":"A set of key/value pairs that you can attach to a subscription object.","example":{"order_id":"8842","channel":"shopify"}},{"type":"null","description":"A set of key/value pairs that you can attach to a subscription object.","example":{"order_id":"8842","channel":"shopify"}}]},"client_secret":{"oneOf":[{"type":"object","description":"Client secrets used to confirm the subscription's first payment or payment-method setup from your frontend. Present only while the subscription is being activated; omitted otherwise. Do not log or store these secrets; expose them only to the customer over TLS.","example":{"setup_secret":"string","payment_secret":"string"},"properties":{"setup_secret":{"oneOf":[{"type":"string","description":"Client secret of the SetupIntent used to collect and save a payment method for the subscription (for example, during a trial with no immediate charge). `null` when no setup is required. Do not log or store it; expose only to the customer over TLS."},{"type":"null","description":"Client secret of the SetupIntent used to collect and save a payment method for the subscription (for example, during a trial with no immediate charge). `null` when no setup is required. Do not log or store it; expose only to the customer over TLS."}]},"payment_secret":{"oneOf":[{"type":"string","description":"Client secret of the PaymentIntent used to confirm the subscription's first payment from your frontend. `null` when no immediate payment is required. Do not log or store it; expose only to the customer over TLS."},{"type":"null","description":"Client secret of the PaymentIntent used to confirm the subscription's first payment from your frontend. `null` when no immediate payment is required. Do not log or store it; expose only to the customer over TLS."}]}}},{"type":"null","description":"Client secrets used to confirm the subscription's first payment or payment-method setup from your frontend. Present only while the subscription is being activated; omitted otherwise. Do not log or store these secrets; expose them only to the customer over TLS."}]},"proration_behavior":{"oneOf":[{"type":"string","description":"The proration behavior for the subscription.","enum":["always_invoice","create_prorations","none"],"example":"always_invoice"},{"type":"null","description":"The proration behavior for the subscription."}]},"trial_start":{"oneOf":[{"type":"string","description":"Start of the subscription's trial period, as an RFC 3339 timestamp. `null` if the subscription has no trial.","example":"string"},{"type":"null","description":"Start of the subscription's trial period, as an RFC 3339 timestamp. `null` if the subscription has no trial."}]},"trial_end":{"oneOf":[{"type":"string","description":"End of the subscription's trial period, as an RFC 3339 timestamp. After this time the customer is billed normally. `null` if the subscription has no trial.","example":"string"},{"type":"null","description":"End of the subscription's trial period, as an RFC 3339 timestamp. After this time the customer is billed normally. `null` if the subscription has no trial."}]},"cancel_at":{"oneOf":[{"type":"string","description":"A future RFC 3339 timestamp at which the subscription will automatically be canceled. `null` unless a future cancellation has been scheduled.","example":"2026-06-15T14:30:00Z"},{"type":"null","description":"A future RFC 3339 timestamp at which the subscription will automatically be canceled. `null` unless a future cancellation has been scheduled.","example":"2026-06-15T14:30:00Z"}]},"canceled_at":{"oneOf":[{"type":"string","description":"The RFC 3339 timestamp at which the subscription was actually canceled. `null` if the subscription has not been canceled. Unlike `cancel_at` (a future scheduled cancellation), this is set once the cancellation has occurred.","example":"2026-06-15T14:30:00Z"},{"type":"null","description":"The RFC 3339 timestamp at which the subscription was actually canceled. `null` if the subscription has not been canceled. Unlike `cancel_at` (a future scheduled cancellation), this is set once the cancellation has occurred.","example":"2026-06-15T14:30:00Z"}]},"default_payment_method":{"oneOf":[{"type":"string","description":"The default payment method for the subscription (expandable).","example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"object","description":"The default payment method for the subscription (expandable).","required":["billing_details","card","created_at","customer","off_session","payment_method_id","test_mode"],"example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"payment_method_id":{"description":"The ID of the PaymentMethod.","type":"string","example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},"billing_details":{"description":"Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.","type":"object","properties":{"address":{"oneOf":[{"type":"object","description":"The billing address.","example":{"city":"San Francisco","country":"US","line1":"123 Main St","line2":"Suite 100","postal_code":"94107","state":"CA"},"properties":{"city":{"oneOf":[{"type":"string","description":"City, district, suburb, town, or village.","example":"San Francisco"},{"type":"null","description":"City, district, suburb, town, or village.","example":"San Francisco"}]},"country":{"oneOf":[{"type":"string","description":"Two-letter ISO country code (e.g., `US`).","example":"US"},{"type":"null","description":"Two-letter ISO country code (e.g., `US`).","example":"US"}]},"line1":{"oneOf":[{"type":"string","description":"Address line 1, such as the street, PO box, or company name.","example":"123 Main St"},{"type":"null","description":"Address line 1, such as the street, PO box, or company name.","example":"123 Main St"}]},"line2":{"oneOf":[{"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building.","example":"Suite 100"},{"type":"null","description":"Address line 2, such as the apartment, suite, unit, or building.","example":"Suite 100"}]},"postal_code":{"oneOf":[{"type":"string","description":"ZIP or postal code.","example":"94107"},{"type":"null","description":"ZIP or postal code.","example":"94107"}]},"state":{"oneOf":[{"type":"string","description":"State, county, province, or region.","example":"CA"},{"type":"null","description":"State, county, province, or region.","example":"CA"}]}}},{"type":"null","description":"The billing address."}]},"email":{"oneOf":[{"type":"string","description":"The billing email address.","example":"john.doe@example.com"},{"type":"null","description":"The billing email address.","example":"john.doe@example.com"}]},"name":{"oneOf":[{"type":"string","description":"The billing name.","example":"Example"},{"type":"null","description":"The billing name.","example":"Example"}]},"phone":{"oneOf":[{"type":"string","description":"The billing phone number.","example":"+14155550142"},{"type":"null","description":"The billing phone number.","example":"+14155550142"}]}},"example":{"address":{"city":"San Francisco","country":"US","line1":"123 Main St","line2":"Suite 100","postal_code":"94107","state":"CA"},"email":"john.doe@example.com","name":"Example","phone":"+14155550142"},"isRequired":true},"customer":{"oneOf":[{"type":"string","description":"The customer this payment method is attached to. Returned as the customer ID by default; expandable to the full Customer object.","example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},{"type":"object","description":"The customer this payment method is attached to. Returned as the customer ID by default; expandable to the full Customer object.","required":["created_at","customer_id","email","first_name","last_name","test_mode"],"example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"customer_id":{"description":"The unique identifier for the customer.","type":"string","example":"fcus_01HACM7FZ1084XB1GB6053VM0D","isRequired":true},"first_name":{"description":"The customer's first name.","type":"string","example":"John","isRequired":true},"last_name":{"description":"The customer's last name.","type":"string","example":"Doe","isRequired":true},"email":{"description":"The customer's email address.","type":"string","example":"joh.doe@example.com","isRequired":true},"created_at":{"description":"The time the customer was created.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true},"test_mode":{"description":"Whether the customer was created in test mode.","type":"boolean","example":false,"isRequired":true},"owner_partner_id":{"oneOf":[{"type":"string","description":"The partner that owns this customer. When a customer is shared with you by another partner in your organization, this is that sibling partner; otherwise it is your own partner id.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"The partner that owns this customer. When a customer is shared with you by another partner in your organization, this is that sibling partner; otherwise it is your own partner id.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"phone":{"oneOf":[{"type":"string","description":"The customer's phone number.","format":"phone","example":"+15555555555"},{"type":"null","description":"The customer's phone number.","format":"phone","example":"+15555555555"}]},"employer":{"oneOf":[{"type":"string","description":"The customer's employer.","example":"Flex"},{"type":"null","description":"The customer's employer.","example":"Flex"}]},"shipping":{"oneOf":[{"type":"object","description":"The customer's shipping address.","required":["shipping_address_id"],"example":{"shipping_address_id":"fsh_01J9XR8M3K7VZ8N2YB4WJ6T0RA","line1":"123 Main St","line2":"Suite 100","city":"San Francisco","state":"CA","postal_code":"94107","country":"US"},"properties":{"shipping_address_id":{"description":"Unique identifier for the shipping address.","type":"string","example":"fsh_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},"line1":{"oneOf":[{"type":"string","description":"The first line of the street address (e.g., street number and name).","example":"123 Main St"},{"type":"null","description":"The first line of the street address (e.g., street number and name).","example":"123 Main St"}]},"line2":{"oneOf":[{"type":"string","description":"The second line of the street address (e.g., apartment, suite, or unit).","example":"Suite 100"},{"type":"null","description":"The second line of the street address (e.g., apartment, suite, or unit).","example":"Suite 100"}]},"city":{"oneOf":[{"type":"string","description":"City, district, suburb, town, or village.","example":"San Francisco"},{"type":"null","description":"City, district, suburb, town, or village.","example":"San Francisco"}]},"state":{"oneOf":[{"type":"string","description":"State, county, province, or region.","example":"CA"},{"type":"null","description":"State, county, province, or region.","example":"CA"}]},"postal_code":{"oneOf":[{"type":"string","description":"ZIP or postal code.","example":"94107"},{"type":"null","description":"ZIP or postal code.","example":"94107"}]},"country":{"oneOf":[{"type":"string","description":"Two-letter country code (ISO 3166-1 alpha-2, e.g., `US`).","example":"US"},{"type":"null","description":"Two-letter country code (ISO 3166-1 alpha-2, e.g., `US`).","example":"US"}]}}},{"type":"null","description":"The customer's shipping address."}]},"metadata":{"oneOf":[{"type":"object","description":"Metadata associated with the customer.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"string"}},{"type":"null","description":"Metadata associated with the customer.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"string"}}]}},"isRequired":true}],"isRequired":true},"card":{"description":"User card details.","type":"object","required":["brand","country","exp_month","exp_year","fingerprint","funding","last4"],"properties":{"brand":{"description":"The brand of the card.","type":"string","enum":["american_express","diners_club","discover","eftpos_au","JCB","master_card","union_pay","visa","unknown"],"example":"american_express","isRequired":true},"country":{"description":"Two-letter ISO code for the card's country.","type":"string","example":"US","isRequired":true},"exp_month":{"description":"The card's expiration month.","type":"integer","format":"int32","example":12,"minimum":-128,"maximum":127,"isRequired":true},"exp_year":{"description":"The card's expiration year.","type":"integer","format":"int32","example":2027,"minimum":-2147483648,"maximum":2147483647,"isRequired":true},"fingerprint":{"description":"Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card.","type":"string","example":"abc123","isRequired":true},"funding":{"description":"The funding type of the card.","type":"string","enum":["credit","debit","hsa_fsa","prepaid","unknown"],"example":"credit","isRequired":true},"last4":{"description":"The last four digits of the card.","type":"string","example":"4242","isRequired":true}},"example":{"brand":"american_express","country":"US","exp_month":12,"exp_year":2027,"fingerprint":"abc123","funding":"credit","last4":"4242"},"isRequired":true},"created_at":{"description":"Time at which the object was created. ISO 8601 format.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true},"test_mode":{"description":"Whether this PaymentMethod is in test mode.","type":"boolean","example":false,"isRequired":true},"off_session":{"description":"Whether this PaymentMethod is valid for off_session (customer not present) purchase flows.","type":"boolean","isRequired":true},"metadata":{"oneOf":[{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"object"}},{"type":"null","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"object"}}]}}},{"type":"null","description":"The default payment method for the subscription (expandable)."}]},"backup_payment_method":{"oneOf":[{"type":"string","description":"The payment method charged when the default one fails (expandable). Omitted when the subscription has no backup.","example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"object","description":"The payment method charged when the default one fails (expandable). Omitted when the subscription has no backup.","required":["billing_details","card","created_at","customer","off_session","payment_method_id","test_mode"],"example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"payment_method_id":{"description":"The ID of the PaymentMethod.","type":"string","example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},"billing_details":{"description":"Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.","type":"object","properties":{"address":{"oneOf":[{"type":"object","description":"The billing address.","example":{"city":"San Francisco","country":"US","line1":"123 Main St","line2":"Suite 100","postal_code":"94107","state":"CA"},"properties":{"city":{"oneOf":[{"type":"string","description":"City, district, suburb, town, or village.","example":"San Francisco"},{"type":"null","description":"City, district, suburb, town, or village.","example":"San Francisco"}]},"country":{"oneOf":[{"type":"string","description":"Two-letter ISO country code (e.g., `US`).","example":"US"},{"type":"null","description":"Two-letter ISO country code (e.g., `US`).","example":"US"}]},"line1":{"oneOf":[{"type":"string","description":"Address line 1, such as the street, PO box, or company name.","example":"123 Main St"},{"type":"null","description":"Address line 1, such as the street, PO box, or company name.","example":"123 Main St"}]},"line2":{"oneOf":[{"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building.","example":"Suite 100"},{"type":"null","description":"Address line 2, such as the apartment, suite, unit, or building.","example":"Suite 100"}]},"postal_code":{"oneOf":[{"type":"string","description":"ZIP or postal code.","example":"94107"},{"type":"null","description":"ZIP or postal code.","example":"94107"}]},"state":{"oneOf":[{"type":"string","description":"State, county, province, or region.","example":"CA"},{"type":"null","description":"State, county, province, or region.","example":"CA"}]}}},{"type":"null","description":"The billing address."}]},"email":{"oneOf":[{"type":"string","description":"The billing email address.","example":"john.doe@example.com"},{"type":"null","description":"The billing email address.","example":"john.doe@example.com"}]},"name":{"oneOf":[{"type":"string","description":"The billing name.","example":"Example"},{"type":"null","description":"The billing name.","example":"Example"}]},"phone":{"oneOf":[{"type":"string","description":"The billing phone number.","example":"+14155550142"},{"type":"null","description":"The billing phone number.","example":"+14155550142"}]}},"example":{"address":{"city":"San Francisco","country":"US","line1":"123 Main St","line2":"Suite 100","postal_code":"94107","state":"CA"},"email":"john.doe@example.com","name":"Example","phone":"+14155550142"},"isRequired":true},"customer":{"oneOf":[{"type":"string","description":"The customer this payment method is attached to. Returned as the customer ID by default; expandable to the full Customer object.","example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},{"type":"object","description":"The customer this payment method is attached to. Returned as the customer ID by default; expandable to the full Customer object.","required":["created_at","customer_id","email","first_name","last_name","test_mode"],"example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"customer_id":{"description":"The unique identifier for the customer.","type":"string","example":"fcus_01HACM7FZ1084XB1GB6053VM0D","isRequired":true},"first_name":{"description":"The customer's first name.","type":"string","example":"John","isRequired":true},"last_name":{"description":"The customer's last name.","type":"string","example":"Doe","isRequired":true},"email":{"description":"The customer's email address.","type":"string","example":"joh.doe@example.com","isRequired":true},"created_at":{"description":"The time the customer was created.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true},"test_mode":{"description":"Whether the customer was created in test mode.","type":"boolean","example":false,"isRequired":true},"owner_partner_id":{"oneOf":[{"type":"string","description":"The partner that owns this customer. When a customer is shared with you by another partner in your organization, this is that sibling partner; otherwise it is your own partner id.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"The partner that owns this customer. When a customer is shared with you by another partner in your organization, this is that sibling partner; otherwise it is your own partner id.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"phone":{"oneOf":[{"type":"string","description":"The customer's phone number.","format":"phone","example":"+15555555555"},{"type":"null","description":"The customer's phone number.","format":"phone","example":"+15555555555"}]},"employer":{"oneOf":[{"type":"string","description":"The customer's employer.","example":"Flex"},{"type":"null","description":"The customer's employer.","example":"Flex"}]},"shipping":{"oneOf":[{"type":"object","description":"The customer's shipping address.","required":["shipping_address_id"],"example":{"shipping_address_id":"fsh_01J9XR8M3K7VZ8N2YB4WJ6T0RA","line1":"123 Main St","line2":"Suite 100","city":"San Francisco","state":"CA","postal_code":"94107","country":"US"},"properties":{"shipping_address_id":{"description":"Unique identifier for the shipping address.","type":"string","example":"fsh_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},"line1":{"oneOf":[{"type":"string","description":"The first line of the street address (e.g., street number and name).","example":"123 Main St"},{"type":"null","description":"The first line of the street address (e.g., street number and name).","example":"123 Main St"}]},"line2":{"oneOf":[{"type":"string","description":"The second line of the street address (e.g., apartment, suite, or unit).","example":"Suite 100"},{"type":"null","description":"The second line of the street address (e.g., apartment, suite, or unit).","example":"Suite 100"}]},"city":{"oneOf":[{"type":"string","description":"City, district, suburb, town, or village.","example":"San Francisco"},{"type":"null","description":"City, district, suburb, town, or village.","example":"San Francisco"}]},"state":{"oneOf":[{"type":"string","description":"State, county, province, or region.","example":"CA"},{"type":"null","description":"State, county, province, or region.","example":"CA"}]},"postal_code":{"oneOf":[{"type":"string","description":"ZIP or postal code.","example":"94107"},{"type":"null","description":"ZIP or postal code.","example":"94107"}]},"country":{"oneOf":[{"type":"string","description":"Two-letter country code (ISO 3166-1 alpha-2, e.g., `US`).","example":"US"},{"type":"null","description":"Two-letter country code (ISO 3166-1 alpha-2, e.g., `US`).","example":"US"}]}}},{"type":"null","description":"The customer's shipping address."}]},"metadata":{"oneOf":[{"type":"object","description":"Metadata associated with the customer.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"string"}},{"type":"null","description":"Metadata associated with the customer.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"string"}}]}},"isRequired":true}],"isRequired":true},"card":{"description":"User card details.","type":"object","required":["brand","country","exp_month","exp_year","fingerprint","funding","last4"],"properties":{"brand":{"description":"The brand of the card.","type":"string","enum":["american_express","diners_club","discover","eftpos_au","JCB","master_card","union_pay","visa","unknown"],"example":"american_express","isRequired":true},"country":{"description":"Two-letter ISO code for the card's country.","type":"string","example":"US","isRequired":true},"exp_month":{"description":"The card's expiration month.","type":"integer","format":"int32","example":12,"minimum":-128,"maximum":127,"isRequired":true},"exp_year":{"description":"The card's expiration year.","type":"integer","format":"int32","example":2027,"minimum":-2147483648,"maximum":2147483647,"isRequired":true},"fingerprint":{"description":"Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card.","type":"string","example":"abc123","isRequired":true},"funding":{"description":"The funding type of the card.","type":"string","enum":["credit","debit","hsa_fsa","prepaid","unknown"],"example":"credit","isRequired":true},"last4":{"description":"The last four digits of the card.","type":"string","example":"4242","isRequired":true}},"example":{"brand":"american_express","country":"US","exp_month":12,"exp_year":2027,"fingerprint":"abc123","funding":"credit","last4":"4242"},"isRequired":true},"created_at":{"description":"Time at which the object was created. ISO 8601 format.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true},"test_mode":{"description":"Whether this PaymentMethod is in test mode.","type":"boolean","example":false,"isRequired":true},"off_session":{"description":"Whether this PaymentMethod is valid for off_session (customer not present) purchase flows.","type":"boolean","isRequired":true},"metadata":{"oneOf":[{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"object"}},{"type":"null","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"object"}}]}}},{"type":"null","description":"The payment method charged when the default one fails (expandable). Omitted when the subscription has no backup."}]},"discounts":{"oneOf":[{"type":"array","items":{"description":"A Discount object represents the application of a coupon or promotion code to a checkout session, customer, subscription, or invoice. It records which coupon was redeemed, what the discount was applied to, and the time window over which it applies.","type":"object","required":["discount_id","source","start","test_mode"],"properties":{"discount_id":{"description":"The ID of the discount.","type":"string","example":"fdi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},"source":{"description":"The source of the discount (coupon or promotion code).","type":"object","required":["coupon","type"],"properties":{"coupon":{"oneOf":[{"type":"string","description":"The coupon that was redeemed. Returned as a coupon ID by default; pass `expand=discounts,coupons` on the Subscription API to expand it to the full coupon object.","example":"fcoup_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},{"type":"object","description":"The coupon that was redeemed. Returned as a coupon ID by default; pass `expand=discounts,coupons` on the Subscription API to expand it to the full coupon object.","required":["coupon_id","created_at","duration","name","test_mode","valid"],"example":"fcoup_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"coupon_id":{"description":"Unique identifier for the object.","type":"string","example":"fcoup_1234567890","isRequired":true},"duration":{"type":"string","enum":["once","repeating","forever"],"x-ms-enum":{"name":"CouponDuration","modelAsString":false,"values":[{"value":"once","name":"Once","description":"Applies to the first charge from a subscription with this coupon applied."},{"value":"repeating","name":"Repeating","description":"Applies to charges in the first duration_in_months months from a subscription with this coupon applied."},{"value":"forever","name":"Forever","description":"Applies to all charges from a subscription with this coupon applied."}]},"description":"One of forever, once, and repeating. Describes how long a customer who applies this coupon will get the discount.","example":"once","isRequired":true},"name":{"description":"Name of the coupon displayed to customers.","type":"string","example":"Example","isRequired":true},"valid":{"description":"Taking account of the above properties, whether this coupon can still be applied to a customer.","type":"boolean","example":false,"isRequired":true},"created_at":{"description":"Date when this coupon was created.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true},"test_mode":{"description":"Whether the coupon is in test mode","type":"boolean","example":false,"isRequired":true},"amount_off":{"oneOf":[{"type":"integer","description":"Amount that will be taken off the subtotal of any invoices for this customer.","format":"int32","maximum":2147483647,"minimum":-2147483648,"example":2500},{"type":"null","description":"Amount that will be taken off the subtotal of any invoices for this customer.","format":"int32","maximum":2147483647,"minimum":-2147483648,"example":2500}]},"applies_to":{"oneOf":[{"type":"object","description":"An object containing the ID of the product that the coupon can be applied to.","required":["products"],"example":{"products":["fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA"]},"properties":{"products":{"description":"The product that this coupon applies to.","type":"array","items":{"type":"string","example":"fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},"isRequired":true}}},{"type":"object","description":"An object containing the ID of the product that the coupon can be applied to.","required":["prices"],"properties":{"prices":{"description":"The price that this coupon applies to.","type":"array","items":{"type":"string","example":"fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},"isRequired":true}}},{"type":"object","description":"An object containing the ID of the product that the coupon can be applied to.","required":["fee_types"],"properties":{"fee_types":{"description":"The fee types that this coupon applies to.","type":"array","items":{"description":"The kind of fee applied to a checkout session: a Letter of Medical Necessity consultation fee, or a custom fee you define.","type":"string","enum":["lmn_consultation","custom"],"example":"lmn_consultation"},"isRequired":true}}},{"type":"string","description":"An object containing the ID of the product that the coupon can be applied to.","enum":["shipping"],"example":{"products":["fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA"]}},{"type":"null","description":"An object containing the ID of the product that the coupon can be applied to."}]},"duration_in_months":{"oneOf":[{"type":"integer","description":"If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once.","format":"int32","maximum":2147483647,"minimum":-2147483648},{"type":"null","description":"If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once.","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"metadata":{"oneOf":[{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","example":{"order_id":"8842","channel":"shopify"}},{"type":"null","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","example":{"order_id":"8842","channel":"shopify"}}]},"percent_off":{"oneOf":[{"type":"number","description":"Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon.","format":"double"},{"type":"null","description":"Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon.","format":"double"}]},"max_redemptions":{"oneOf":[{"type":"integer","description":"Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.","format":"int32","maximum":2147483647,"minimum":-2147483648},{"type":"null","description":"Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"times_redeemed":{"oneOf":[{"type":"integer","description":"Number of times this coupon has been applied to a customer.","format":"int32","maximum":2147483647,"minimum":-2147483648},{"type":"null","description":"Number of times this coupon has been applied to a customer.","format":"int32","maximum":2147483647,"minimum":-2147483648}]}},"isRequired":true}],"isRequired":true},"type":{"description":"The type of source.","type":"string","enum":["coupon","promotion_code"],"example":"coupon","isRequired":true}},"example":{"coupon":"fcoup_01J9XR8M3K7VZ8N2YB4WJ6T0RA","type":"coupon"},"isRequired":true},"test_mode":{"description":"Whether the discount was applied in test mode","type":"boolean","example":false,"isRequired":true},"start":{"description":"Date that the coupon was applied.","type":"string","example":"string","isRequired":true},"checkout_session":{"oneOf":[{"type":"string","description":"The checkout session that the discount was applied to.","example":"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"The checkout session that the discount was applied to.","example":"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"customer":{"oneOf":[{"type":"string","description":"The customer that the discount was applied to.","example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"The customer that the discount was applied to.","example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"subscription":{"oneOf":[{"type":"string","description":"The subscription that the discount was applied to.","example":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"The subscription that the discount was applied to.","example":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"invoice":{"oneOf":[{"type":"string","description":"The invoice that the discount was applied to.","example":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"The invoice that the discount was applied to.","example":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"promo_code":{"oneOf":[{"type":"string","description":"The promo code applied to create the discount.","example":"fpromo_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"The promo code applied to create the discount.","example":"fpromo_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"end":{"oneOf":[{"type":"string","description":"If the coupon has a duration of repeating, the date that this discount will end. If the coupon has a duration of once or forever, this attribute will be null.","example":"string"},{"type":"null","description":"If the coupon has a duration of repeating, the date that this discount will end. If the coupon has a duration of once or forever, this attribute will be null."}]}},"example":{"discount_id":"fdi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","checkout_session":"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA","customer":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","subscription":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA","invoice":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA","source":{"coupon":"fcoup_01J9XR8M3K7VZ8N2YB4WJ6T0RA","type":"coupon"},"promo_code":"fpromo_01J9XR8M3K7VZ8N2YB4WJ6T0RA","test_mode":false,"end":"string","start":"string"}},"description":"The discounts applied to the subscription. Only present when `expand=discounts` is requested; omitted from the response otherwise. Usually 0–1 elements (Flex applies at most one coupon per subscription today), but modeled as an array for Stripe parity and future multi-discount support.\n\nFull `Discount` objects rather than `Expandable`: unlike the other expandable fields, `discounts` is populated only on `expand=discounts` and is always hydrated, so it never serializes as a bare ID. (The nested `source.coupon` inside each discount is still an `Expandable`, honoring `expand=discounts,coupons`.)"},{"type":"null","description":"The discounts applied to the subscription. Only present when `expand=discounts` is requested; omitted from the response otherwise. Usually 0–1 elements (Flex applies at most one coupon per subscription today), but modeled as an array for Stripe parity and future multi-discount support.\n\nFull `Discount` objects rather than `Expandable`: unlike the other expandable fields, `discounts` is populated only on `expand=discounts` and is always hydrated, so it never serializes as a bare ID. (The nested `source.coupon` inside each discount is still an `Expandable`, honoring `expand=discounts,coupons`.)"}]},"pause":{"oneOf":[{"type":"object","description":"The current pause. Present only while the subscription is paused.","required":["paused_at"],"example":{"paused_at":"2026-06-15T14:30:00Z","resume_at":"2026-06-15T14:30:00Z","billing_cycle_anchor":"unchanged","proration_behavior":"always_invoice","credit":"unused_time"},"properties":{"paused_at":{"description":"When the subscription was paused. ISO 8601 format. While paused, this is also the subscription's `current_period_end`.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true},"resume_at":{"oneOf":[{"type":"string","description":"When Flex resumes the subscription on its own. `null` when it stays paused until you resume it.","example":"2026-06-15T14:30:00Z"},{"type":"null","description":"When Flex resumes the subscription on its own. `null` when it stays paused until you resume it.","example":"2026-06-15T14:30:00Z"}]},"billing_cycle_anchor":{"oneOf":[{"type":"string","description":"Where billing restarts when Flex resumes at `resume_at`: `now` or `unchanged`. `null` when no resume is scheduled.","enum":["now","unchanged"],"x-ms-enum":{"name":"SubscriptionResumeBillingCycleAnchor","modelAsString":false,"values":[{"value":"now","name":"Now","description":"Bill monthly from the resume date, charging the full period now, net of any unused time credited at the pause. After an uncredited pause that ends inside the paid period, nothing is charged now and the next charge covers the time from the old period end."},{"value":"unchanged","name":"Unchanged","description":"Keep the original billing date."}]},"example":"unchanged"},{"type":"null","description":"Where billing restarts when Flex resumes at `resume_at`: `now` or `unchanged`. `null` when no resume is scheduled.","example":"unchanged"}]},"proration_behavior":{"oneOf":[{"type":"string","description":"How the partial period is billed when `billing_cycle_anchor` is `unchanged`. `null` otherwise.","enum":["create_prorations","always_invoice"],"x-ms-enum":{"name":"SubscriptionResumeProrationBehavior","modelAsString":false,"values":[{"value":"create_prorations","name":"CreateProrations","description":"Bill the partial period on the original billing date, with the next full period."},{"value":"always_invoice","name":"AlwaysInvoice","description":"Bill the partial period now, net of any unused time credited at the pause. A negative amount charges nothing and goes to the customer's balance."}]},"example":"always_invoice"},{"type":"null","description":"How the partial period is billed when `billing_cycle_anchor` is `unchanged`. `null` otherwise.","example":"always_invoice"}]},"credit":{"type":"string","enum":["unused_time","none"],"x-ms-enum":{"name":"SubscriptionPauseCredit","modelAsString":false,"values":[{"value":"unused_time","name":"UnusedTime","description":"Credit the unused paid time from the pause to the period end. The resume charge is net of it."},{"value":"none","name":"None","description":"Credit nothing for the paused days inside the paid period. A resume before the period ends keeps the paid days after it."}]},"description":"What the pause credited for the paid time left in the period.","example":"unused_time","default":"unused_time"}}},{"type":"null","description":"The current pause. Present only while the subscription is paused."}]}}},{"type":"null","description":"The subscription that this invoice was prepared for."}]},"paid_at":{"oneOf":[{"type":"string","description":"When the invoice was paid.","example":"string"},{"type":"null","description":"When the invoice was paid."}]},"metadata":{"oneOf":[{"type":"object","description":"Metadata associated with the invoice.","example":{"order_id":"8842","channel":"shopify"}},{"type":"null","description":"Metadata associated with the invoice.","example":{"order_id":"8842","channel":"shopify"}}]},"backup_charge_status":{"oneOf":[{"type":"string","description":"Outcome of the backup-payment-method fallback for this invoice. Omitted when no fallback applied. `succeeded` on a paid invoice means the subscription's backup card covered this renewal after the default payment method failed.","enum":["pending","succeeded","failed","skipped"],"example":"pending"},{"type":"null","description":"Outcome of the backup-payment-method fallback for this invoice. Omitted when no fallback applied. `succeeded` on a paid invoice means the subscription's backup card covered this renewal after the default payment method failed."}]}}},{"type":"null","description":"The invoice associated with the payment intent."}]},"client_secret":{"oneOf":[{"type":"string","description":"The client secret of the payment intent."},{"type":"null","description":"The client secret of the payment intent."}]},"metadata":{"oneOf":[{"type":"object","description":"The metadata associated with the payment intent.","example":{"order_id":"8842","channel":"shopify"}},{"type":"null","description":"The metadata associated with the payment intent.","example":{"order_id":"8842","channel":"shopify"}}]},"payment_method":{"oneOf":[{"type":"string","description":"The payment method associated with the payment intent.","example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"object","description":"The payment method associated with the payment intent.","required":["billing_details","card","created_at","customer","off_session","payment_method_id","test_mode"],"example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"payment_method_id":{"description":"The ID of the PaymentMethod.","type":"string","example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},"billing_details":{"description":"Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.","type":"object","properties":{"address":{"oneOf":[{"type":"object","description":"The billing address.","example":{"city":"San Francisco","country":"US","line1":"123 Main St","line2":"Suite 100","postal_code":"94107","state":"CA"},"properties":{"city":{"oneOf":[{"type":"string","description":"City, district, suburb, town, or village.","example":"San Francisco"},{"type":"null","description":"City, district, suburb, town, or village.","example":"San Francisco"}]},"country":{"oneOf":[{"type":"string","description":"Two-letter ISO country code (e.g., `US`).","example":"US"},{"type":"null","description":"Two-letter ISO country code (e.g., `US`).","example":"US"}]},"line1":{"oneOf":[{"type":"string","description":"Address line 1, such as the street, PO box, or company name.","example":"123 Main St"},{"type":"null","description":"Address line 1, such as the street, PO box, or company name.","example":"123 Main St"}]},"line2":{"oneOf":[{"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building.","example":"Suite 100"},{"type":"null","description":"Address line 2, such as the apartment, suite, unit, or building.","example":"Suite 100"}]},"postal_code":{"oneOf":[{"type":"string","description":"ZIP or postal code.","example":"94107"},{"type":"null","description":"ZIP or postal code.","example":"94107"}]},"state":{"oneOf":[{"type":"string","description":"State, county, province, or region.","example":"CA"},{"type":"null","description":"State, county, province, or region.","example":"CA"}]}}},{"type":"null","description":"The billing address."}]},"email":{"oneOf":[{"type":"string","description":"The billing email address.","example":"john.doe@example.com"},{"type":"null","description":"The billing email address.","example":"john.doe@example.com"}]},"name":{"oneOf":[{"type":"string","description":"The billing name.","example":"Example"},{"type":"null","description":"The billing name.","example":"Example"}]},"phone":{"oneOf":[{"type":"string","description":"The billing phone number.","example":"+14155550142"},{"type":"null","description":"The billing phone number.","example":"+14155550142"}]}},"example":{"address":{"city":"San Francisco","country":"US","line1":"123 Main St","line2":"Suite 100","postal_code":"94107","state":"CA"},"email":"john.doe@example.com","name":"Example","phone":"+14155550142"},"isRequired":true},"customer":{"oneOf":[{"type":"string","description":"The customer this payment method is attached to. Returned as the customer ID by default; expandable to the full Customer object.","example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},{"type":"object","description":"The customer this payment method is attached to. Returned as the customer ID by default; expandable to the full Customer object.","required":["created_at","customer_id","email","first_name","last_name","test_mode"],"example":"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"customer_id":{"description":"The unique identifier for the customer.","type":"string","example":"fcus_01HACM7FZ1084XB1GB6053VM0D","isRequired":true},"first_name":{"description":"The customer's first name.","type":"string","example":"John","isRequired":true},"last_name":{"description":"The customer's last name.","type":"string","example":"Doe","isRequired":true},"email":{"description":"The customer's email address.","type":"string","example":"joh.doe@example.com","isRequired":true},"created_at":{"description":"The time the customer was created.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true},"test_mode":{"description":"Whether the customer was created in test mode.","type":"boolean","example":false,"isRequired":true},"owner_partner_id":{"oneOf":[{"type":"string","description":"The partner that owns this customer. When a customer is shared with you by another partner in your organization, this is that sibling partner; otherwise it is your own partner id.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"The partner that owns this customer. When a customer is shared with you by another partner in your organization, this is that sibling partner; otherwise it is your own partner id.","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]},"phone":{"oneOf":[{"type":"string","description":"The customer's phone number.","format":"phone","example":"+15555555555"},{"type":"null","description":"The customer's phone number.","format":"phone","example":"+15555555555"}]},"employer":{"oneOf":[{"type":"string","description":"The customer's employer.","example":"Flex"},{"type":"null","description":"The customer's employer.","example":"Flex"}]},"shipping":{"oneOf":[{"type":"object","description":"The customer's shipping address.","required":["shipping_address_id"],"example":{"shipping_address_id":"fsh_01J9XR8M3K7VZ8N2YB4WJ6T0RA","line1":"123 Main St","line2":"Suite 100","city":"San Francisco","state":"CA","postal_code":"94107","country":"US"},"properties":{"shipping_address_id":{"description":"Unique identifier for the shipping address.","type":"string","example":"fsh_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true},"line1":{"oneOf":[{"type":"string","description":"The first line of the street address (e.g., street number and name).","example":"123 Main St"},{"type":"null","description":"The first line of the street address (e.g., street number and name).","example":"123 Main St"}]},"line2":{"oneOf":[{"type":"string","description":"The second line of the street address (e.g., apartment, suite, or unit).","example":"Suite 100"},{"type":"null","description":"The second line of the street address (e.g., apartment, suite, or unit).","example":"Suite 100"}]},"city":{"oneOf":[{"type":"string","description":"City, district, suburb, town, or village.","example":"San Francisco"},{"type":"null","description":"City, district, suburb, town, or village.","example":"San Francisco"}]},"state":{"oneOf":[{"type":"string","description":"State, county, province, or region.","example":"CA"},{"type":"null","description":"State, county, province, or region.","example":"CA"}]},"postal_code":{"oneOf":[{"type":"string","description":"ZIP or postal code.","example":"94107"},{"type":"null","description":"ZIP or postal code.","example":"94107"}]},"country":{"oneOf":[{"type":"string","description":"Two-letter country code (ISO 3166-1 alpha-2, e.g., `US`).","example":"US"},{"type":"null","description":"Two-letter country code (ISO 3166-1 alpha-2, e.g., `US`).","example":"US"}]}}},{"type":"null","description":"The customer's shipping address."}]},"metadata":{"oneOf":[{"type":"object","description":"Metadata associated with the customer.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"string"}},{"type":"null","description":"Metadata associated with the customer.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"string"}}]}},"isRequired":true}],"isRequired":true},"card":{"description":"User card details.","type":"object","required":["brand","country","exp_month","exp_year","fingerprint","funding","last4"],"properties":{"brand":{"description":"The brand of the card.","type":"string","enum":["american_express","diners_club","discover","eftpos_au","JCB","master_card","union_pay","visa","unknown"],"example":"american_express","isRequired":true},"country":{"description":"Two-letter ISO code for the card's country.","type":"string","example":"US","isRequired":true},"exp_month":{"description":"The card's expiration month.","type":"integer","format":"int32","example":12,"minimum":-128,"maximum":127,"isRequired":true},"exp_year":{"description":"The card's expiration year.","type":"integer","format":"int32","example":2027,"minimum":-2147483648,"maximum":2147483647,"isRequired":true},"fingerprint":{"description":"Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card.","type":"string","example":"abc123","isRequired":true},"funding":{"description":"The funding type of the card.","type":"string","enum":["credit","debit","hsa_fsa","prepaid","unknown"],"example":"credit","isRequired":true},"last4":{"description":"The last four digits of the card.","type":"string","example":"4242","isRequired":true}},"example":{"brand":"american_express","country":"US","exp_month":12,"exp_year":2027,"fingerprint":"abc123","funding":"credit","last4":"4242"},"isRequired":true},"created_at":{"description":"Time at which the object was created. ISO 8601 format.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true},"test_mode":{"description":"Whether this PaymentMethod is in test mode.","type":"boolean","example":false,"isRequired":true},"off_session":{"description":"Whether this PaymentMethod is valid for off_session (customer not present) purchase flows.","type":"boolean","isRequired":true},"metadata":{"oneOf":[{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"object"}},{"type":"null","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","example":{"order_id":"8842","channel":"shopify"},"additionalProperties":{"type":"object"}}]}}},{"type":"null","description":"The payment method associated with the payment intent."}]},"transfer_group":{"oneOf":[{"type":"string","description":"A string that identifies the resulting payment as part of a group","example":"example_value"},{"type":"null","description":"A string that identifies the resulting payment as part of a group","example":"example_value"}]},"payment_card_type":{"oneOf":[{"type":"string","description":"The primary card type used for this payment intent","enum":["primary","secondary"],"x-ms-enum":{"name":"PaymentCardType","modelAsString":false,"values":[{"value":"primary","name":"Primary","description":"In a split cart, `Primary` refers to the HSA/FSA eligible card. In a single cart (whether it's HSA/FSA or a fully ineligible cart), `Primary` refers to the only payment card used."},{"value":"secondary","name":"Secondary","description":"In a split cart and partial authorization payment, `Secondary` refers to the non-eligible or backup credit card used for ineligible items."}]},"example":"primary"},{"type":"null","description":"The primary card type used for this payment intent"}]},"letter_fee_amount":{"oneOf":[{"type":"integer","description":"Letter fee portion of application_fee_amount (waterfall allocation to HSA/FSA)","format":"int32","maximum":2147483647,"minimum":-2147483648},{"type":"null","description":"Letter fee portion of application_fee_amount (waterfall allocation to HSA/FSA)","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"transaction_fee":{"oneOf":[{"type":"integer","description":"Transaction fee portion of application_fee_amount (percentage + fixed fee)","format":"int32","maximum":2147483647,"minimum":-2147483648},{"type":"null","description":"Transaction fee portion of application_fee_amount (percentage + fixed fee)","format":"int32","maximum":2147483647,"minimum":-2147483648}]},"last_payment_error":{"oneOf":[{"type":"object","description":"The error from the most recent failed payment attempt, if any.","required":["type"],"example":{"type":"string","code":"string","decline_code":"string","message":"string","payment_method":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},"properties":{"type":{"description":"The type of error (card, invalid_request, api, etc.)","type":"string","isRequired":true},"code":{"oneOf":[{"type":"string","description":"Machine-readable error code (card_declined, expired_card, etc.)"},{"type":"null","description":"Machine-readable error code (card_declined, expired_card, etc.)"}]},"decline_code":{"oneOf":[{"type":"string","description":"Card-specific decline code (insufficient_funds, lost_card, etc.)"},{"type":"null","description":"Card-specific decline code (insufficient_funds, lost_card, etc.)"}]},"message":{"oneOf":[{"type":"string","description":"Human-readable error description."},{"type":"null","description":"Human-readable error description."}]},"payment_method":{"oneOf":[{"type":"string","description":"The Flex payment method ID that failed.","example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},{"type":"null","description":"The Flex payment method ID that failed.","example":"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}]}}},{"type":"null","description":"The error from the most recent failed payment attempt, if any."}]}}}]}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Use a Bearer token to access this API.","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Use a Bearer token to access this API.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"flex-87","siteName":"Flex Documentation","title":"List Subscriptions - Flex Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-28T22:54:20.755Z","originalFileLocation":"api-reference/subscriptions/list-subscriptions.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=\"Returns a list of your subscriptions, most recent first. Optionally filter by customer or status. Use expand (or expand_customer) to inline related objects such as the customer, latest invoice, item prices, or applied discounts.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Flex 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/flex-87/uZDAr5goax7LGN2W/_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/flex-87/uZDAr5goax7LGN2W/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/flex-87/uZDAr5goax7LGN2W/_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/flex-87/uZDAr5goax7LGN2W/_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/flex-87/uZDAr5goax7LGN2W/_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/flex-87/uZDAr5goax7LGN2W/_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/flex-87/uZDAr5goax7LGN2W/_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/flex-87/uZDAr5goax7LGN2W/_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/flex-87/uZDAr5goax7LGN2W/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List Subscriptions - Flex Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns a list of your subscriptions, most recent first. Optionally filter by customer or status. Use expand (or expand_customer) to inline related objects such as the customer, latest invoice, item prices, or applied discounts.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Flex Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.withflex.com/api-reference/subscriptions/list-subscriptions\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://flex-87.mintlify.app/_mintlify/api/og/v2?division=Subscriptions\u0026amp;title=List+Subscriptions\u0026amp;description=Returns+a+list+of+your+subscriptions%2C+most+recent+first.+Optionally+filter+by+customer+or%0Astatus.+Use+%60expand%60+%28or+%60expand_customer%60%29+to+inline+related+objects+\u0026amp;theme=166c4e73f0167deeef40f76e\u0026amp;signature=cd587d53d86e301cae1814549374bc7c47b2ef186cb66299b4d0dec3a2ea12cc\">\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=\"List Subscriptions - Flex Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns a list of your subscriptions, most recent first. Optionally filter by customer or status. Use expand (or expand_customer) to inline related objects such as the customer, latest invoice, item prices, or applied discounts.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://flex-87.mintlify.app/_mintlify/api/og/v2?division=Subscriptions\u0026amp;title=List+Subscriptions\u0026amp;description=Returns+a+list+of+your+subscriptions%2C+most+recent+first.+Optionally+filter+by+customer+or%0Astatus.+Use+%60expand%60+%28or+%60expand_customer%60%29+to+inline+related+objects+\u0026amp;theme=166c4e73f0167deeef40f76e\u0026amp;signature=cd587d53d86e301cae1814549374bc7c47b2ef186cb66299b4d0dec3a2ea12cc\">\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/flex-87/uZDAr5goax7LGN2W/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Flex Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0070FA\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.withflex.com/api-reference/subscriptions/list-subscriptions\">\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/list-subscriptions.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.withflex.com/#organization\",\"name\":\"Flex Documentation\",\"url\":\"https://docs.withflex.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/flex-87/1kILreF5HcjIKLdi/logo/light.svg?fit=max\u0026auto=format\u0026n=1kILreF5HcjIKLdi\u0026q=85\u0026s=f703a75bc80df014f4849a7225b4879f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.withflex.com#website\",\"name\":\"Flex Documentation\",\"url\":\"https://docs.withflex.com\",\"publisher\":{\"@id\":\"https://docs.withflex.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.withflex.com/api-reference/subscriptions/list-subscriptions#webpage\",\"url\":\"https://docs.withflex.com/api-reference/subscriptions/list-subscriptions\",\"name\":\"List Subscriptions\",\"description\":\"Returns a list of your subscriptions, most recent first. Optionally filter by customer or status. Use expand (or expand_customer) to inline related objects such as the customer, latest invoice, item prices, or applied discounts.\",\"dateModified\":\"2026-10-28T22:54:20.755Z\",\"isPartOf\":{\"@id\":\"https://docs.withflex.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.withflex.com/api-reference/subscriptions/list-subscriptions#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.withflex.com/api-reference/subscriptions/list-subscriptions#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.withflex.com/api-reference/shipping-rates/list-shipping-rates\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List Subscriptions\",\"item\":\"https://docs.withflex.com/api-reference/subscriptions/list-subscriptions\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.withflex.com/api-reference/subscriptions/list-subscriptions#apireference\",\"headline\":\"List Subscriptions\",\"name\":\"List Subscriptions\",\"description\":\"Returns a list of your subscriptions, most recent first. Optionally filter by customer or status. Use expand (or expand_customer) to inline related objects such as the customer, latest invoice, item prices, or applied discounts.\",\"url\":\"https://docs.withflex.com/api-reference/subscriptions/list-subscriptions\",\"mainEntityOfPage\":{\"@id\":\"https://docs.withflex.com/api-reference/subscriptions/list-subscriptions#webpage\"},\"dateModified\":\"2026-10-28T22:54:20.755Z\",\"publisher\":{\"@id\":\"https://docs.withflex.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.withflex.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Flex Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Flex Documentation","nav":{"global":{"anchors":[{"anchor":"Status","icon":"wifi","href":"https://statuspage.incident.io/with-flex"},{"anchor":"Support","icon":"mail","href":"mailto:support@withflex.com"},{"anchor":"Website","icon":"laptop","href":"https://www.withflex.com"}]},"tabs":[{"tab":"Welcome","pages":[{"title":"Welcome","href":""}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/developer-guides/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Overview","pages":[{"title":"Introduction to the Flex API","sidebarTitle":"Introduction","href":"/api-reference/introduction"},{"title":"Expanding Resources","sidebarTitle":"Expanding Resources","href":"/api-reference/expanding-resources"}]},{"group":"API Reference","pages":[{"group":"Shipping Rates","pages":[{"title":"List Shipping Rates","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/shipping_rates","href":"/api-reference/shipping-rates/list-shipping-rates"},{"title":"Create Shipping Rate","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/shipping_rates","href":"/api-reference/shipping-rates/create-shipping-rate"},{"title":"Get Shipping Rate","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/shipping_rates/{id}","href":"/api-reference/shipping-rates/get-shipping-rate"},{"title":"Update Shipping Rate","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/shipping_rates/{id}","href":"/api-reference/shipping-rates/update-shipping-rate"}]},{"group":"Disputes","pages":[{"title":"List Disputes","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/disputes","href":"/api-reference/disputes/list-disputes"},{"title":"Count Disputes","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/disputes/count","href":"/api-reference/disputes/count-disputes"},{"title":"Get Dispute","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/disputes/{dispute_id}","href":"/api-reference/disputes/get-dispute"},{"title":"Update Dispute","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/disputes/{dispute_id}","href":"/api-reference/disputes/update-dispute"},{"title":"Close Dispute","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/disputes/{dispute_id}/close","href":"/api-reference/disputes/close-dispute"}]},{"group":"Events","pages":[{"title":"Retry Event","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/events/{id}/retry","href":"/api-reference/events/retry-event"}]},{"group":"Checkout Sessions","pages":[{"title":"List Checkout Sessions","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/checkout/sessions","href":"/api-reference/checkout-sessions/list-checkout-sessions"},{"title":"Create Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/checkout/sessions","href":"/api-reference/checkout-sessions/create-checkout-session"},{"title":"Get Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/checkout/sessions/{id}","href":"/api-reference/checkout-sessions/get-checkout-session"},{"title":"Get Line Items","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/checkout/sessions/{id}/line_items","href":"/api-reference/checkout-sessions/get-line-items"},{"title":"Confirm Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/checkout/sessions/{id}/confirm","href":"/api-reference/checkout-sessions/confirm-checkout-session"},{"title":"Capture Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/checkout/sessions/{id}/capture","href":"/api-reference/checkout-sessions/capture-checkout-session"},{"title":"Preview Capture Allocation","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/checkout/sessions/{id}/capture_allocation","href":"/api-reference/checkout-sessions/preview-capture-allocation"},{"title":"Reauth Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/checkout/sessions/{id}/reauth","href":"/api-reference/checkout-sessions/reauth-checkout-session"},{"title":"Refund Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/checkout/sessions/{id}/refund","href":"/api-reference/checkout-sessions/refund-checkout-session"},{"title":"Preview Refund Allocation","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/checkout/sessions/{id}/refund_allocation","href":"/api-reference/checkout-sessions/preview-refund-allocation"},{"title":"Cancel Auth Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/checkout/sessions/{id}/cancel","href":"/api-reference/checkout-sessions/cancel-auth-checkout-session"},{"title":"Resend Checkout Session Receipts","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/checkout/sessions/{id}/receipts/resend","href":"/api-reference/checkout-sessions/resend-checkout-session-receipts"},{"title":"Resend Checkout Session Lomn","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/checkout/sessions/{id}/lomn/resend","href":"/api-reference/checkout-sessions/resend-checkout-session-lomn"}]},{"group":"Coupons","pages":[{"title":"List Coupons","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/coupons","href":"/api-reference/coupons/list-coupons"},{"title":"Create Coupon","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/coupons","href":"/api-reference/coupons/create-coupon"},{"title":"Get Coupon","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/coupons/{id}","href":"/api-reference/coupons/get-coupon"}]},{"group":"Customers","pages":[{"title":"List customers","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/customers","href":"/api-reference/customers/list-customers"},{"title":"Create or update a customer","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/customers","href":"/api-reference/customers/create-or-update-a-customer"},{"title":"Retrieve a customer","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/customers/{id}","href":"/api-reference/customers/retrieve-a-customer"},{"title":"Delete a customer","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/customers/{id}","href":"/api-reference/customers/delete-a-customer"},{"title":"Update a customer","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/customers/{id}","href":"/api-reference/customers/update-a-customer"},{"title":"List a customer's payment methods","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/customers/{id}/payment_methods","href":"/api-reference/customers/list-a-customers-payment-methods"},{"title":"Retrieve a customer's payment method","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/customers/{id}/payment_methods/{pm_id}","href":"/api-reference/customers/retrieve-a-customers-payment-method"}]},{"group":"Exports","pages":[{"title":"List Exports","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/exports","href":"/api-reference/exports/list-exports"},{"title":"Create Export","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/exports","href":"/api-reference/exports/create-export"},{"title":"Get Export","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/exports/{id}","href":"/api-reference/exports/get-export"},{"title":"Cancel Export","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/exports/{id}/cancel","href":"/api-reference/exports/cancel-export"},{"title":"Create Export Url","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/exports/{id}/presigned_url","href":"/api-reference/exports/create-export-url"}]},{"group":"Invoices","pages":[{"title":"List Invoices","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/invoices","href":"/api-reference/invoices/list-invoices"},{"title":"Get Invoice","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/invoices/{id}","href":"/api-reference/invoices/get-invoice"},{"title":"Mark Invoice Uncollectible","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/invoices/{id}/mark_uncollectible","href":"/api-reference/invoices/mark-invoice-uncollectible"}]},{"group":"Products","pages":[{"title":"List Product Components","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/product_components","href":"/api-reference/products/list-product-components"},{"title":"Create Product Component","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/product_components","href":"/api-reference/products/create-product-component"},{"title":"Get Product Component","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/product_components/{id}","href":"/api-reference/products/get-product-component"},{"title":"Update Product Component","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/product_components/{id}","href":"/api-reference/products/update-product-component"},{"title":"List Products","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/products","href":"/api-reference/products/list-products"},{"title":"Create Product","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/products","href":"/api-reference/products/create-product"},{"title":"Processing Status","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/products/processing_status","href":"/api-reference/products/processing-status"},{"title":"Get Product","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/products/{id}","href":"/api-reference/products/get-product"},{"title":"Update Product","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/products/{id}","href":"/api-reference/products/update-product"}]},{"group":"Payment Intents","pages":[{"title":"List Payment Intents","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/payment_intents","href":"/api-reference/payment-intents/list-payment-intents"},{"title":"Get Payment Intent","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/payment_intents/{id}","href":"/api-reference/payment-intents/get-payment-intent"},{"title":"Send Receipt","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/payment_intents/{id}/receipt","href":"/api-reference/payment-intents/send-receipt"},{"title":"Cancel Payment Intent","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/payment_intents/{id}/cancel","href":"/api-reference/payment-intents/cancel-payment-intent"}]},{"group":"Payment Links","pages":[{"title":"List Payment Links","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/payment_links","href":"/api-reference/payment-links/list-payment-links"},{"title":"Create Payment Link","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/payment_links","href":"/api-reference/payment-links/create-payment-link"},{"title":"Get Payment Link","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/payment_links/{id}","href":"/api-reference/payment-links/get-payment-link"},{"title":"Update Payment Link","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/payment_links/{id}","href":"/api-reference/payment-links/update-payment-link"}]},{"group":"Payouts","pages":[{"title":"List Payouts","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/payouts","href":"/api-reference/payouts/list-payouts"}]},{"group":"Prices","pages":[{"title":"List Prices","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/prices","href":"/api-reference/prices/list-prices"},{"title":"Create Price","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/prices","href":"/api-reference/prices/create-price"},{"title":"Get Price","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/prices/{id}","href":"/api-reference/prices/get-price"},{"title":"Update Price","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/prices/{id}","href":"/api-reference/prices/update-price"}]},{"group":"Promo Codes","pages":[{"title":"List Promo Codes","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/promo_codes","href":"/api-reference/promo-codes/list-promo-codes"},{"title":"Create Promo Code","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/promo_codes","href":"/api-reference/promo-codes/create-promo-code"},{"title":"Get Promo Code","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/promo_codes/{id}","href":"/api-reference/promo-codes/get-promo-code"},{"title":"Update Promo Code","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/promo_codes/{id}","href":"/api-reference/promo-codes/update-promo-code"}]},{"group":"Refunds","pages":[{"title":"List Refunds","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/refunds","href":"/api-reference/refunds/list-refunds"},{"title":"Create Refund","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/refunds","href":"/api-reference/refunds/create-refund"},{"title":"Get Refund","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/refunds/{refund_id}","href":"/api-reference/refunds/get-refund"},{"title":"Update Refund","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/refunds/{refund_id}","href":"/api-reference/refunds/update-refund"}]},{"group":"Reviews","pages":[{"title":"List Reviews","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/reviews","href":"/api-reference/reviews/list-reviews"},{"title":"Get Review","description":"Retrieves the details of a fraud review.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/reviews/{review_id}","href":"/api-reference/reviews/get-review"}]},{"group":"Subscriptions","pages":[{"title":"List Subscriptions","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/subscriptions","href":"/api-reference/subscriptions/list-subscriptions"},{"title":"Get Subscription","description":"Retrieves the subscription with the given ID. Use `expand` (or `expand_customer`) to\ninline related objects such as the customer, latest invoice, default payment method,\nitem prices, or applied discounts.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/subscriptions/{id}","href":"/api-reference/subscriptions/get-subscription"},{"title":"Cancel Subscription","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/subscriptions/{id}","href":"/api-reference/subscriptions/cancel-subscription"},{"title":"Update Subscription","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/subscriptions/{id}","href":"/api-reference/subscriptions/update-subscription"},{"title":"Resend Subscription Receipts","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/subscriptions/{id}/receipts/resend","href":"/api-reference/subscriptions/resend-subscription-receipts"},{"title":"Get Refund Preview","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/subscriptions/{id}/refund_preview","href":"/api-reference/subscriptions/get-refund-preview"},{"title":"Pause Subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/subscriptions/{id}/pause","href":"/api-reference/subscriptions/pause-subscription"},{"title":"Update Pause","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/subscriptions/{id}/pause","href":"/api-reference/subscriptions/update-pause"},{"title":"Resume Subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/subscriptions/{id}/resume","href":"/api-reference/subscriptions/resume-subscription"},{"title":"Stop a failed resume and keep the subscription paused","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/subscriptions/{id}/resume/cancel","href":"/api-reference/subscriptions/stop-a-failed-resume-and-keep-the-subscription-paused"}]},{"group":"Balance Transactions","pages":[{"title":"List Balance Transactions","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/balance_transactions","href":"/api-reference/balance-transactions/list-balance-transactions"}]},{"group":"Setup Intents","pages":[{"title":"List Setup Intents","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/setup_intents","href":"/api-reference/setup-intents/list-setup-intents"},{"title":"Create Setup Intent","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/setup_intents","href":"/api-reference/setup-intents/create-setup-intent"},{"title":"Get Setup Intent","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/setup_intents/{id}","href":"/api-reference/setup-intents/get-setup-intent"}]},{"group":"Captures","pages":[{"title":"List captures","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/captures","href":"/api-reference/captures/list-captures"},{"title":"Retrieve a capture","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/captures/{capture_id}","href":"/api-reference/captures/retrieve-a-capture"},{"title":"Update a capture","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/captures/{capture_id}","href":"/api-reference/captures/update-a-capture"}]},{"group":"Files","pages":[{"title":"List Files","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/files","href":"/api-reference/files/list-files"},{"title":"Create File","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/files","href":"/api-reference/files/create-file"},{"title":"Retrieve File","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/files/{id}","href":"/api-reference/files/retrieve-file"}]}]}]},{"tab":"Compliance","pages":[{"title":"Compliance","href":"/compliance/introduction"}]},{"tab":"Marketing","pages":[{"title":"Marketing","href":"/merchant-success/introduction"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"List Subscriptions - Flex Documentation","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}