Creates a refund for a previously succeeded payment intent and returns the resulting Refund.
The referenced payment intent must have a succeeded status. If amount is omitted, the full amount of the payment intent is refunded. A refund.created event is emitted, and the returned refund’s status may still be pending; subsequent status changes are delivered via webhooks.
{"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.4043","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}],"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/refunds/create-refund","slug":"/api-reference/refunds/create-refund","pageMetadata":{"title":"Create Refund","description":"Creates a refund for a previously succeeded payment intent and returns the resulting Refund.\n\nThe referenced payment intent must have a `succeeded` status. If `amount` is omitted, the full amount of the payment intent is refunded. A `refund.created` event is emitted, and the returned refund's `status` may still be `pending`; subsequent status changes are delivered via webhooks.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/refunds","href":"/api-reference/refunds/create-refund","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Creates a refund for a previously succeeded payment intent and returns the resulting Refund.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The referenced payment intent must have a \", _jsx(_components.code, {\n children: \"succeeded\"\n }), \" status. If \", _jsx(_components.code, {\n children: \"amount\"\n }), \" is omitted, the full amount of the payment intent is refunded. A \", _jsx(_components.code, {\n children: \"refund.created\"\n }), \" event is emitted, and the returned refund’s \", _jsx(_components.code, {\n children: \"status\"\n }), \" may still be \", _jsx(_components.code, {\n children: \"pending\"\n }), \"; subsequent status changes are delivered via webhooks.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create Refund","description":"Creates a refund for a previously succeeded payment intent and returns the resulting Refund.\n\nThe referenced payment intent must have a `succeeded` status. If `amount` is omitted, the full amount of the payment intent is refunded. A `refund.created` event is emitted, and the returned refund's `status` may still be `pending`; subsequent status changes are delivered via webhooks.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/refunds","href":"/api-reference/refunds/create-refund","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/flex-87/f0156321fafa1974/postcss.config.js"],"openApiReferenceData":{"operation":{"tags":["Refunds"],"summary":"Create Refund","description":"Creates a refund for a previously succeeded payment intent and returns the resulting Refund.\n\nThe referenced payment intent must have a `succeeded` status. If `amount` is omitted, the full amount of the payment intent is refunded. A `refund.created` event is emitted, and the returned refund's `status` may still be `pending`; subsequent status changes are delivered via webhooks.","operationId":"v1.refunds.create","requestBody":"7552b79b-73ff-4949-aac4-dfa85aaafb8a","responses":{"200":"6bfbc5fe-82e3-40cc-a718-5efc75e2a5a7","401":"c23cb97b-db60-44d1-a2f0-1aef64759db1","403":"0047d85f-7bbd-4bf4-891a-95766f903d8e","404":"2bce60f9-fa6d-4473-912e-436bffb950ee","409":"12daa816-03d6-49e5-bb0c-505f746ab6ea","422":"fa431863-6ca7-4c2e-a8f1-5b711a4ffa25","429":"d62959e2-2f01-465f-9947-f39933eefb31"},"security":["bd6bb570-9ca3-420e-949b-c6f2aebc5911"],"method":"post","type":"path","servers":["080577c1-39a5-4498-bb49-d7daab803f21"],"path":"/v1/refunds","baseUrlOptions":["https://api.withflex.com"],"title":"Create Refund","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"description":"An envelope wrapping a single refund object.","content":{"application/json":{"schema":{"description":"An envelope wrapping a single refund object.","type":"object","required":["refund"],"properties":{"refund":{"description":"The refund object.","type":"object","required":["payment_intent_id"],"properties":{"payment_intent_id":{"description":"ID of the PaymentIntent to refund. The payment intent must have a `succeeded` status.","type":"string","example":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true,"uniqueKey":"refund.payment_intent_id","typeLabel":"string"},"amount":{"oneOf":[{"description":"Amount to refund, in the smallest currency unit (e.g., `2500` = $25.00 USD). When omitted, the full amount of the payment intent is refunded.","type":"integer","format":"int32","maximum":2147483647,"example":2500,"minimum":-2147483648,"uniqueKey":"refund.amount.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"Amount to refund, in the smallest currency unit (e.g., `2500` = $25.00 USD). When omitted, the full amount of the payment intent is refunded.","type":"null","format":"int32","maximum":2147483647,"example":2500,"minimum":-2147483648,"uniqueKey":"refund.amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.amount","typeLabel":"integer\u003cint32> | null"},"reason":{"oneOf":[{"type":"string","description":"The reason for the refund. Optional.","enum":["duplicate","fraudulent","requested_by_customer","expired_uncaptured_charge"],"example":"duplicate","uniqueKey":"refund.reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The reason for the refund. Optional.","uniqueKey":"refund.reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.reason","typeLabel":"enum\u003cstring> | null"},"metadata":{"oneOf":[{"description":"Set of key-value pairs you can attach to the refund for storing additional structured information.","type":"object","additionalProperties":{"type":"string","uniqueKey":"refund.metadata.oneOf.0.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"refund.metadata.oneOf.0","typeLabel":"object"},{"description":"Set of key-value pairs you can attach to the refund for storing additional structured information.","type":"null","additionalProperties":{"type":"string","uniqueKey":"refund.metadata.oneOf.1.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"refund.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.metadata","typeLabel":"object | null"}},"example":{"payment_intent_id":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","amount":2500,"reason":"duplicate","metadata":{"order_id":"8842","channel":"shopify"}},"isRequired":true,"uniqueKey":"refund","typeLabel":"object"}},"example":{"refund":{"payment_intent_id":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","amount":2500,"reason":"duplicate","metadata":{"order_id":"8842","channel":"shopify"}}},"uniqueKey":"","typeLabel":"object"},"example":{"refund":{"payment_intent_id":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","amount":2500,"reason":"duplicate","metadata":{"order_id":"8842","channel":"shopify"}}},"examples":{"Example":{"title":"Example","value":{"refund":{"payment_intent_id":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","amount":2500,"reason":"duplicate","metadata":{"order_id":"8842","channel":"shopify"}}}}},"exampleType":"examples"}},"required":true,"exampleType":"examples"},"responses":{"6bfbc5fe-82e3-40cc-a718-5efc75e2a5a7":{"description":"An envelope wrapping a single refund object.","content":{"application/json":{"schema":{"description":"An envelope wrapping a single refund object.","type":"object","required":["refund"],"properties":{"refund":{"description":"The refund object.","type":"object","required":["amount","created_at","refund_id","status","test_mode"],"properties":{"refund_id":{"description":"The ID of the refund","type":"string","example":"fre_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true,"uniqueKey":"refund.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":"refund.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":"refund.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":"refund.status","typeLabel":"enum\u003cstring>"},"test_mode":{"description":"Whether the refund was created in test mode","type":"boolean","example":false,"isRequired":true,"uniqueKey":"refund.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":"refund.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":"refund.payment_intent_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The reason for the refund","uniqueKey":"refund.reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.reason","typeLabel":"enum\u003cstring> | null"},"metadata":{"oneOf":[{"description":"Metadata attached to the refund","type":"object","additionalProperties":{"type":"string","uniqueKey":"refund.metadata.oneOf.0.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"refund.metadata.oneOf.0","typeLabel":"object"},{"description":"Metadata attached to the refund","type":"null","additionalProperties":{"type":"string","uniqueKey":"refund.metadata.oneOf.1.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"refund.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.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":"refund.reference_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.reference_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Type of the reference number used for the refund","uniqueKey":"refund.reference_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.reference_status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Status of the reference number used for the refund","uniqueKey":"refund.reference_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.\\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":"refund.\\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":"refund.\\items.items.[INDEX].payment_intent.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.\\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":"refund.\\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":"refund.\\items.items.[INDEX].payment_method_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.\\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":"refund.\\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":"refund.\\items.items.[INDEX].reference_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.\\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":"refund.\\items.items.[INDEX].reference_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Type of the reference number used for the refund","uniqueKey":"refund.\\items.items.[INDEX].reference_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.\\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":"refund.\\items.items.[INDEX].reference_status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Status of the reference number used for the refund","uniqueKey":"refund.\\items.items.[INDEX].reference_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.\\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":"refund.\\items.items.[INDEX]","typeLabel":"object"},"uniqueKey":"refund.\\items","typeLabel":"object[]"},"subscription_id":{"oneOf":[{"description":"The subscription this refund is associated with (for subscription cancellation refunds)","type":"string","example":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"refund.subscription_id.oneOf.0","typeLabel":"string"},{"description":"The subscription this refund is associated with (for subscription cancellation refunds)","type":"null","example":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"refund.subscription_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.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":"refund.invoice_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.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":"refund.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":"refund.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":"refund.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":"refund.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":"refund.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":"refund.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":"refund.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":"refund.balance_transaction.oneOf.1.available_on.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.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":"refund.balance_transaction.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.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":"refund.balance_transaction.oneOf.1.exchange_rate.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.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":"refund.balance_transaction.oneOf.1.reporting_category.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.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":"refund.balance_transaction.oneOf.1.checkout_session_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.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":"refund.balance_transaction.oneOf.1.client_reference_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.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":"refund.balance_transaction.oneOf.1.source_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.balance_transaction.oneOf.1.source_id","typeLabel":"string | null"},"type":{"oneOf":[{"description":"The type of transaction.","type":"string","uniqueKey":"refund.balance_transaction.oneOf.1.type.oneOf.0","typeLabel":"string"},{"description":"The type of transaction.","type":"null","uniqueKey":"refund.balance_transaction.oneOf.1.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.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":"refund.balance_transaction.oneOf.1.flex_payment_intent_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.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":"refund.balance_transaction.oneOf.1.mid.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.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":"refund.balance_transaction.oneOf.1.currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.balance_transaction.oneOf.1.metadata.oneOf.0.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"refund.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":"refund.balance_transaction.oneOf.1.metadata.oneOf.1.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"refund.balance_transaction.oneOf.1.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.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":"refund.balance_transaction.oneOf.1.transaction_fee_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.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":"refund.balance_transaction.oneOf.1.interchange_fee_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.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":"refund.balance_transaction.oneOf.1.lmn_fee_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.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":"refund.balance_transaction.oneOf.1.dispute_fee_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.balance_transaction.oneOf.1.card_type.oneOf.0","typeLabel":"string"},{"description":"Card funding type used for the transaction.","type":"null","uniqueKey":"refund.balance_transaction.oneOf.1.card_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.balance_transaction.oneOf.1.card_network.oneOf.0","typeLabel":"string"},{"description":"Card network used for the transaction (e.g., `visa`, `mastercard`).","type":"null","uniqueKey":"refund.balance_transaction.oneOf.1.card_network.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.balance_transaction.oneOf.1.card_network","typeLabel":"string | null"}},"uniqueKey":"refund.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":"refund.balance_transaction.oneOf.2","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.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":"refund.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":"refund.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":"refund.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":"refund.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":"refund.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":"refund.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":"refund.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":"refund.failure_balance_transaction.oneOf.1.available_on.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.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":"refund.failure_balance_transaction.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.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":"refund.failure_balance_transaction.oneOf.1.exchange_rate.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.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":"refund.failure_balance_transaction.oneOf.1.reporting_category.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.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":"refund.failure_balance_transaction.oneOf.1.checkout_session_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.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":"refund.failure_balance_transaction.oneOf.1.client_reference_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.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":"refund.failure_balance_transaction.oneOf.1.source_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.failure_balance_transaction.oneOf.1.source_id","typeLabel":"string | null"},"type":{"oneOf":[{"description":"The type of transaction.","type":"string","uniqueKey":"refund.failure_balance_transaction.oneOf.1.type.oneOf.0","typeLabel":"string"},{"description":"The type of transaction.","type":"null","uniqueKey":"refund.failure_balance_transaction.oneOf.1.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.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":"refund.failure_balance_transaction.oneOf.1.flex_payment_intent_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.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":"refund.failure_balance_transaction.oneOf.1.mid.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.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":"refund.failure_balance_transaction.oneOf.1.currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.failure_balance_transaction.oneOf.1.metadata.oneOf.0.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"refund.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":"refund.failure_balance_transaction.oneOf.1.metadata.oneOf.1.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"refund.failure_balance_transaction.oneOf.1.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.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":"refund.failure_balance_transaction.oneOf.1.transaction_fee_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.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":"refund.failure_balance_transaction.oneOf.1.interchange_fee_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.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":"refund.failure_balance_transaction.oneOf.1.lmn_fee_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.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":"refund.failure_balance_transaction.oneOf.1.dispute_fee_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.failure_balance_transaction.oneOf.1.card_type.oneOf.0","typeLabel":"string"},{"description":"Card funding type used for the transaction.","type":"null","uniqueKey":"refund.failure_balance_transaction.oneOf.1.card_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.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":"refund.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":"refund.failure_balance_transaction.oneOf.1.card_network.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund.failure_balance_transaction.oneOf.1.card_network","typeLabel":"string | null"}},"uniqueKey":"refund.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":"refund.failure_balance_transaction.oneOf.2","typeLabel":"null"}],"uniqueKey":"refund.failure_balance_transaction","typeLabel":"string | object | null"}},"example":{"refund_id":"fre_01J9XR8M3K7VZ8N2YB4WJ6T0RA","payment_intent_id":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","amount":2500,"created_at":"2026-06-15T14:30:00Z","reason":"duplicate","status":"pending","test_mode":false,"metadata":{"order_id":"8842","channel":"shopify"},"reference_id":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","reference_type":"acquirer_reference_number","reference_status":"available","items":[{"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":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA","invoice_id":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA","balance_transaction":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA","failure_balance_transaction":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA"},"isRequired":true,"uniqueKey":"refund","typeLabel":"object"}},"example":{"refund":{"refund_id":"fre_01J9XR8M3K7VZ8N2YB4WJ6T0RA","payment_intent_id":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","amount":2500,"created_at":"2026-06-15T14:30:00Z","reason":"duplicate","status":"pending","test_mode":false,"metadata":{"order_id":"8842","channel":"shopify"},"reference_id":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","reference_type":"acquirer_reference_number","reference_status":"available","items":[{"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":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA","invoice_id":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA","balance_transaction":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA","failure_balance_transaction":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}},"uniqueKey":"","typeLabel":"object"},"example":{"refund":{"refund_id":"fre_01J9XR8M3K7VZ8N2YB4WJ6T0RA","payment_intent_id":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","amount":2500,"created_at":"2026-06-15T14:30:00Z","reason":"duplicate","status":"pending","test_mode":false,"metadata":{"order_id":"8842","channel":"shopify"},"reference_id":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","reference_type":"acquirer_reference_number","reference_status":"available","items":[{"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":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA","invoice_id":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA","balance_transaction":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA","failure_balance_transaction":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}},"examples":{"Example":{"title":"Example","value":{"refund":{"refund_id":"fre_01J9XR8M3K7VZ8N2YB4WJ6T0RA","payment_intent_id":"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA","amount":2500,"created_at":"2026-06-15T14:30:00Z","reason":"duplicate","status":"pending","test_mode":false,"metadata":{"order_id":"8842","channel":"shopify"},"reference_id":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","reference_type":"acquirer_reference_number","reference_status":"available","items":[{"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":"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA","invoice_id":"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA","balance_transaction":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA","failure_balance_transaction":"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA"}}}},"exampleType":"examples"}},"exampleType":"examples"},"c23cb97b-db60-44d1-a2f0-1aef64759db1":{"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"},"0047d85f-7bbd-4bf4-891a-95766f903d8e":{"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"},"2bce60f9-fa6d-4473-912e-436bffb950ee":{"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"},"12daa816-03d6-49e5-bb0c-505f746ab6ea":{"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"},"fa431863-6ca7-4c2e-a8f1-5b711a4ffa25":{"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"},"d62959e2-2f01-465f-9947-f39933eefb31":{"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":{"bd6bb570-9ca3-420e-949b-c6f2aebc5911":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Use a Bearer token to access this API.","scopes":["refunds:write"],"schemeName":"BearerAuth"}}},"servers":{"080577c1-39a5-4498-bb49-d7daab803f21":{"url":"https://api.withflex.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Use a Bearer token to access this API.","scopes":["refunds:write"],"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":"Create Refund - Flex Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-28T22:54:20.702Z","originalFileLocation":"api-reference/refunds/create-refund.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=\"Creates a refund for a previously succeeded payment intent and returns the resulting Refund. The referenced payment intent must have a succeeded status. If amount is omitted, the full amount of the payment intent is refunded. A refund.created event is emitted, and the returned refund\u0026#x27;s status may still be pending; subsequent status changes are delivered via webhooks.\">\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=\"Create Refund - Flex Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a refund for a previously succeeded payment intent and returns the resulting Refund. The referenced payment intent must have a succeeded status. If amount is omitted, the full amount of the payment intent is refunded. A refund.created event is emitted, and the returned refund\u0026#x27;s status may still be pending; subsequent status changes are delivered via webhooks.\">\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/refunds/create-refund\">\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=Refunds\u0026amp;title=Create+Refund\u0026amp;description=Creates+a+refund+for+a+previously+succeeded+payment+intent+and+returns+the+resulting+Refund.%0A%0AThe+referenced+payment+intent+must+have+a+%60succeeded%60+status.+If+%60\u0026amp;theme=166c4e73f0167deeef40f76e\u0026amp;signature=2d663901abaeb9f48f9dde13dc131959be139ac74b992ef108b27b0e68284f5c\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create Refund - Flex Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a refund for a previously succeeded payment intent and returns the resulting Refund. The referenced payment intent must have a succeeded status. If amount is omitted, the full amount of the payment intent is refunded. A refund.created event is emitted, and the returned refund\u0026#x27;s status may still be pending; subsequent status changes are delivered via webhooks.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://flex-87.mintlify.app/_mintlify/api/og/v2?division=Refunds\u0026amp;title=Create+Refund\u0026amp;description=Creates+a+refund+for+a+previously+succeeded+payment+intent+and+returns+the+resulting+Refund.%0A%0AThe+referenced+payment+intent+must+have+a+%60succeeded%60+status.+If+%60\u0026amp;theme=166c4e73f0167deeef40f76e\u0026amp;signature=2d663901abaeb9f48f9dde13dc131959be139ac74b992ef108b27b0e68284f5c\">\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/refunds/create-refund\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/refunds/create-refund.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/refunds/create-refund#webpage\",\"url\":\"https://docs.withflex.com/api-reference/refunds/create-refund\",\"name\":\"Create Refund\",\"description\":\"Creates a refund for a previously succeeded payment intent and returns the resulting Refund. The referenced payment intent must have a succeeded status. If amount is omitted, the full amount of the payment intent is refunded. A refund.created event is emitted, and the returned refund's status may still be pending; subsequent status changes are delivered via webhooks.\",\"dateModified\":\"2026-10-28T22:54:20.702Z\",\"isPartOf\":{\"@id\":\"https://docs.withflex.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.withflex.com/api-reference/refunds/create-refund#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.withflex.com/api-reference/refunds/create-refund#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\":\"Refunds\",\"item\":\"https://docs.withflex.com/api-reference/refunds/list-refunds\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create Refund\",\"item\":\"https://docs.withflex.com/api-reference/refunds/create-refund\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.withflex.com/api-reference/refunds/create-refund#apireference\",\"headline\":\"Create Refund\",\"name\":\"Create Refund\",\"description\":\"Creates a refund for a previously succeeded payment intent and returns the resulting Refund. The referenced payment intent must have a succeeded status. If amount is omitted, the full amount of the payment intent is refunded. A refund.created event is emitted, and the returned refund's status may still be pending; subsequent status changes are delivered via webhooks.\",\"url\":\"https://docs.withflex.com/api-reference/refunds/create-refund\",\"mainEntityOfPage\":{\"@id\":\"https://docs.withflex.com/api-reference/refunds/create-refund#webpage\"},\"dateModified\":\"2026-10-28T22:54:20.702Z\",\"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","description":"Returns a list of your refunds, most recent first.","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","description":"Retrieves the details of an existing refund by its ID.","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","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","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":"Create Refund - Flex Documentation","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}