{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Lago","description":"Developer documentation for Lago, the open-source billing platform for usage metering, subscriptions, invoicing, payments, and revenue operations.","colors":{"primary":"#006CFA","light":"#006CFA","dark":"#006CFA"},"logo":{"light":"https://mintcdn.com/lago-docs/zZSJbpe68PHhSs3x/logo/light.svg?fit=max\u0026auto=format\u0026n=zZSJbpe68PHhSs3x\u0026q=85\u0026s=b4af3001527c985b81858b9a0928534c","dark":"https://mintcdn.com/lago-docs/zZSJbpe68PHhSs3x/logo/dark.svg?fit=max\u0026auto=format\u0026n=zZSJbpe68PHhSs3x\u0026q=85\u0026s=1eb7aacac796b0cc6bf05be790a792b1"},"favicon":"https://mintcdn.com/lago-docs/8N-yOElNGe9jRGG5/favicon.svg?fit=max\u0026auto=format\u0026n=8N-yOElNGe9jRGG5\u0026q=85\u0026s=5c319e58dd9b5c5b8a31cf2ad8009a1c","api":{"openapi":"https://swagger.getlago.com/openapi.yaml","mdx":{"server":"https://api.getlago.com/api/v1"}},"background":{"color":{"light":"#F5F5EF","dark":"#131923"}},"navbar":{"links":[{"href":"https://getlago.com/book-a-demo","label":"Book a Demo"}],"primary":{"type":"button","label":"Get Started","href":"https://getlago.com/book-a-demo"}},"footer":{"socials":{"github":"https://github.com/getlago/lago","slack":"https://getlago.com/slack","x":"https://x.com/getlago","linkedin":"https://www.linkedin.com/company/getlago","youtube":"https://www.youtube.com/channel/UCp6ltp7n3SgDVsmerJ7O7ZA"},"links":[{"header":"Documentation","items":[{"label":"Get started","href":"https://getlago.com/docs/guide/introduction/welcome-to-lago"},{"label":"API reference","href":"https://getlago.com/docs/api-reference/intro"},{"label":"Integrations","href":"https://getlago.com/docs/integrations/introduction"},{"label":"Templates","href":"https://getlago.com/docs/templates/introduction"},{"label":"Changelog","href":"https://getlago.com/docs/changelog/product"},{"label":"FAQ","href":"https://getlago.com/docs/faq/about-lago"}]},{"header":"Developers","items":[{"label":"Developer hub","href":"https://getlago.com/docs/developers"},{"label":"Authentication","href":"https://getlago.com/docs/auth"},{"label":"Webhooks","href":"https://getlago.com/docs/guide/webhooks"},{"label":"SDKs","href":"https://getlago.com/docs/developers"},{"label":"OpenAPI spec","href":"https://swagger.getlago.com/"},{"label":"MCP server","href":"https://getlago.com/docs/guide/ai-agents/mcp-server"},{"label":"Self-hosted","href":"https://getlago.com/docs/guide/lago-self-hosted/overview"},{"label":"llms.txt","href":"https://getlago.com/docs/llms.txt"}]},{"header":"Platform","items":[{"label":"Usage metering","href":"https://getlago.com/platform/usage-metering"},{"label":"Billing \u0026 invoicing","href":"https://getlago.com/platform/billing-invoicing"},{"label":"Cash collection","href":"https://getlago.com/platform/cash-collection"},{"label":"Revenue analytics","href":"https://getlago.com/platform/revenue-analytics"},{"label":"Entitlements","href":"https://getlago.com/platform/entitlements"},{"label":"Lago AI","href":"https://getlago.com/platform/ai"},{"label":"Pricing","href":"https://getlago.com/pricing"}]},{"header":"Company","items":[{"label":"About Lago","href":"https://getlago.com/docs/about"},{"label":"Customers","href":"https://getlago.com/customers"},{"label":"Blog","href":"https://getlago.com/blog"},{"label":"Contact","href":"https://getlago.com/docs/contact"},{"label":"Trust center","href":"https://security.getlago.com"},{"label":"Status","href":"https://status.getlago.com"}]}]},"seo":{"metatags":{"canonical":"https://getlago.com/docs","description":"Developer documentation for Lago's API-first billing platform, including OpenAPI, SDKs, webhooks, MCP, authentication, and implementation guides.","keywords":"Lago API, billing API, usage metering API, OpenAPI, billing SDK, Lago MCP"},"organization":{"id":"https://getlago.com/#organization","name":"Lago","legalName":"Get Lago Corp.","url":"https://getlago.com","logo":"https://getlago.com/docs/logo/light.svg","sameAs":["https://github.com/getlago","https://www.linkedin.com/company/getlago","https://x.com/GetLago","https://www.youtube.com/channel/UCp6ltp7n3SgDVsmerJ7O7ZA"]},"indexing":"all"},"fonts":{"heading":{"family":"GT America","weight":700,"source":"fonts/GT-America-Standard-Medium.woff2","format":"woff2"},"body":{"family":"GT America","source":"fonts/GT-America-Standard-Regular.woff2","format":"woff2"}},"styling":{"codeblocks":"dark","latex":true},"integrations":{"ga4":{"measurementId":"G-743BQ9THCG"},"cookies":{"key":"lago_docs_analytics","value":"granted"}},"errors":{"404":{"redirect":false,"title":"Documentation page not found","description":"No Lago documentation exists at this URL. Start at [Lago Developer Documentation](/welcome), browse [Developer Resources](/developers), inspect the [documentation index](/llms.txt) or [sitemap](/sitemap.xml), or search the [API reference](/api-reference/intro)."}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"navigation":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://getlago.com/blog"},{"anchor":"Community","icon":"slack","href":"https://getlago.com/slack"},{"anchor":"GitHub","icon":"github","href":"https://github.com/getlago/lago"},{"anchor":"Status","icon":"signal-bars","href":"https://status.getlago.com/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"lago-docs","hasAudioNarration":false,"actualSubdomain":"lago-docs","customDomains":["getlago.com"],"gitSource":{"type":"github","owner":"getlago","repo":"lago-doc","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae275a1d202a2a3560748b2","collectionId":"312f2fb3-308c-4ddf-af8a-489b3a1726d2","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae275a1d202a2a3560748b2"},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae275fd623bc73d19496767","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"API References","count":235},{"language":"default","tag":"API Reference","count":235},{"language":"default","tag":"Guide","count":199},{"language":"default","tag":"Integrations","count":54},{"language":"default","tag":"Plans","count":46},{"language":"default","tag":"Resources","count":44},{"language":"default","tag":"Charges","count":39},{"language":"default","tag":"Pricing \u0026 Subscriptions","count":35},{"language":"default","tag":"Subscriptions","count":31},{"language":"default","tag":"Invoices","count":27}]},"assistantConfig":{},"basePath":"/docs","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":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"html{visibility:hidden;background-color:#f5f5ef}@media (prefers-color-scheme:dark){html{background-color:#131923}}html.ready{visibility:visible}.dark .welcome-card{background-color:#1c2535!important;border-color:rgba(255,255,255,.1)!important;box-shadow:0 1px 2px 0 rgba(0,0,0,.3)!important;color:#e5e7eb}.dark .welcome-card:hover{background-color:#243044!important}.dark #changelog-month-nav .changelog-month-nav__list a:hover,.dark .welcome-card h3{color:#fff}.dark .welcome-card p{color:#9ca3af!important}#changelog-month-nav{padding-left:2.5rem;width:19rem;box-sizing:border-box;margin-bottom:1.75rem;max-height:45vh;overflow-y:auto}#changelog-month-nav .changelog-month-nav__year{margin:0 0 .5rem;font-size:.875rem;line-height:1.5rem;font-weight:500;color:#364152}#changelog-month-nav .changelog-month-nav__list{list-style:none;margin:0;padding:0;border-left:1px solid rgba(0,0,0,.08)}#changelog-month-nav .changelog-month-nav__list a{display:block;padding:.25rem 0 .25rem .75rem;margin-left:-1px;border-left:1px solid transparent;font-size:.875rem;line-height:1.5rem;color:#697586;text-decoration:none;transition:color .15s ease,border-color .15s ease}#changelog-month-nav .changelog-month-nav__list a:hover{color:#121926}#changelog-month-nav .changelog-month-nav__list a.is-active{color:#006cfa;border-left-color:#006cfa;font-weight:500}.dark #changelog-month-nav .changelog-month-nav__year{color:#cdd5df}.dark #changelog-month-nav .changelog-month-nav__list{border-left-color:rgba(255,255,255,.12)}.dark #changelog-month-nav .changelog-month-nav__list a{color:#9aa4b2}.dark #changelog-month-nav .changelog-month-nav__list a.is-active{color:#4d9bff;border-left-color:#4d9bff}.update-container>div:first-child{display:none}.update-container>div:nth-child(2){flex:1 1 100%;max-width:100%;width:100%}.update-container{gap:0}#footer a[href*=\"utm_campaign=poweredBy\"]{display:none}"}],"page":{"pagePath":"api-reference/credit-notes/update","slug":"/api-reference/credit-notes/update","pageMetadata":{"openapi":"PUT /credit_notes/{lago_id}","authMethod":"bearer","title":"Update a credit note","description":"This endpoint updates an existing credit note.","href":"/api-reference/credit-notes/update"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"This endpoint updates an existing credit note.\"\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":{"codeStyling":"dark","config":{},"pageMetadata":{"openapi":"PUT /credit_notes/{lago_id}","authMethod":"bearer","title":"Update a credit note","description":"This endpoint updates an existing credit note.","href":"/api-reference/credit-notes/update"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/lago-docs/a0e77058367d9146/canonical.js","/docs/_mintlify/custom/lago-docs/fa2446312177e9c6/loader.js","/docs/_mintlify/custom/lago-docs/c55d8403f7fc83ad/changelog-anchor-redirect.js","/docs/_mintlify/custom/lago-docs/8c326c8b67b47933/changelog-month-nav.js","/docs/_mintlify/custom/lago-docs/103c90943d27f62a/webmcp.js","/docs/_mintlify/custom/lago-docs/1219fb859e5c496e/github-outbound.js"],"openApiReferenceData":{"operation":{"tags":["credit_notes"],"summary":"Update a credit note","description":"This endpoint updates an existing credit note.","operationId":"updateCreditNote","requestBody":"3558dc4d-a39c-488e-94f9-8969ab7a93e6","responses":{"200":"af35b858-db3c-4e4d-bafe-5f5b7a77092b","400":"96d7a4a6-46a5-46eb-a514-1073db6cbae8","401":"067742dd-2ae7-40ef-b990-1ab2361f97cb","404":"be3e202b-e432-4577-bd4d-09bd40245d36","422":"49d67553-e1d6-416a-b508-2a137e8a07b1"},"method":"put","type":"path","servers":["ab22d038-f0d2-40e8-a0fc-d85f6e51c13a","73e77e8d-608b-424b-a1d5-dcecb28afce5"],"security":["dfacd25f-1a82-4597-8d1f-85d526ac05d9"],"path":"/credit_notes/{lago_id}","baseUrlOptions":["https://api.getlago.com/api/v1","https://api.eu.getlago.com/api/v1"],"title":"Update a credit note","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"36f99d42-8241-4e6f-95b1-d8bc86f6e57c":{"name":"lago_id","in":"path","description":"The credit note unique identifier, created by Lago.","required":true,"schema":{"type":"string","example":"12345","isRequired":true,"description":"The credit note unique identifier, created by Lago.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"description":"Credit note update payload","content":{"application/json":{"schema":{"type":"object","required":["credit_note"],"properties":{"credit_note":{"type":"object","properties":{"refund_status":{"type":"string","enum":["pending","succeeded","failed"],"description":"The status of the refund portion of the credit note. It indicates the current state or condition of the refund associated with the credit note. The possible values for this field are:\n\n- `pending`: this status indicates that the refund is pending execution. The refund request has been initiated but has not been processed or completed yet.\n- `succeeded`: this status indicates that the refund has been successfully executed. The refund amount has been processed and returned to the customer or the designated recipient.\n- `failed`: this status indicates that the refund failed to execute. The refund request encountered an error or unsuccessful processing, and the refund amount could not be returned.","example":"succeeded","uniqueKey":"credit_note.refund_status","typeLabel":"enum\u003cstring>"},"metadata":{"type":"object","description":"Metadata to set as key-value pairs. Keys are strings (max 100 characters), values can be strings (max 255 characters) or null.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"credit_note.metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"credit_note.metadata.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.metadata.additionalProperties","typeLabel":"string | null"},"example":{"external_id":"ext-123","synced_at":"2024-01-15"},"uniqueKey":"credit_note.metadata","typeLabel":"object"}},"isRequired":true,"uniqueKey":"credit_note","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"credit_note":{"refund_status":"succeeded","metadata":{"external_id":"ext-123","synced_at":"2024-01-15"}}}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"af35b858-db3c-4e4d-bafe-5f5b7a77092b":{"description":"Credit note updated","content":{"application/json":{"schema":{"type":"object","required":["credit_note"],"properties":{"credit_note":{"type":"object","required":["lago_id","sequential_id","billing_entity_code","number","lago_invoice_id","invoice_number","purchase_order_number","issuing_date","credit_status","refund_status","reason","description","currency","total_amount_cents","precise_total_amount_cents","credit_amount_cents","refund_amount_cents","offset_amount_cents","balance_amount_cents","taxes_amount_cents","precise_taxes_amount_cents","taxes_rate","sub_total_excluding_taxes_amount_cents","coupons_adjustment_amount_cents","created_at","updated_at","file_url","xml_url","self_billed"],"properties":{"lago_id":{"type":"string","format":"uuid","description":"The credit note unique identifier, created by Lago.","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","isRequired":true,"uniqueKey":"credit_note.lago_id","typeLabel":"string\u003cuuid>"},"billing_entity_code":{"type":"string","example":"acme_corp","description":"The unique code of the billing entity associated with the credit note.","isRequired":true,"uniqueKey":"credit_note.billing_entity_code","typeLabel":"string"},"sequential_id":{"type":"integer","description":"The sequential identifier of the credit note, specifically scoped on the associated invoice. It provides a unique numerical identifier for the credit note within the context of the invoice.","example":2,"isRequired":true,"uniqueKey":"credit_note.sequential_id","typeLabel":"integer"},"number":{"type":"string","description":"The credit note unique number.","example":"LAG-1234-CN2","isRequired":true,"uniqueKey":"credit_note.number","typeLabel":"string"},"lago_invoice_id":{"type":"string","format":"uuid","description":"Unique identifier assigned to the invoice that the credit note belongs to","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","isRequired":true,"uniqueKey":"credit_note.lago_invoice_id","typeLabel":"string\u003cuuid>"},"invoice_number":{"type":"string","description":"The invoice unique number, related to the credit note.","example":"LAG-1234","isRequired":true,"uniqueKey":"credit_note.invoice_number","typeLabel":"string"},"purchase_order_number":{"oneOf":[{"type":"string","example":"PO-123","description":"The purchase order number of the invoice the credit note belongs to.","isRequired":true,"uniqueKey":"credit_note.purchase_order_number.oneOf.0","typeLabel":"string"},{"type":"null","example":"PO-123","description":"The purchase order number of the invoice the credit note belongs to.","isRequired":true,"uniqueKey":"credit_note.purchase_order_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.purchase_order_number","typeLabel":"string | null"},"issuing_date":{"type":"string","format":"date","description":"The date of creation of the credit note. It follows the ISO 8601 date format and provides the specific date when the credit note was created.","example":"2022-12-06","isRequired":true,"uniqueKey":"credit_note.issuing_date","typeLabel":"string\u003cdate>"},"credit_status":{"oneOf":[{"type":"string","enum":["available","consumed","voided",null],"description":"The status of the credit portion of the credit note. It indicates the current state or condition of the credit amount associated with the credit note. The possible values for this field are:\n\n- `available`: this status indicates that an amount remains available for future usage. The credit can be applied towards future transactions or invoices.\n- `consumed`: this status indicates that the credit amount has been fully consumed. The remaining amount is 0, indicating that the credit has been utilized in its entirety.\n- `voided`: this status indicates that the remaining amount of the credit cannot be used any further. The credit has been voided and is no longer available for application or redemption.","example":"available","isRequired":true,"uniqueKey":"credit_note.credit_status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["available","consumed","voided",null],"description":"The status of the credit portion of the credit note. It indicates the current state or condition of the credit amount associated with the credit note. The possible values for this field are:\n\n- `available`: this status indicates that an amount remains available for future usage. The credit can be applied towards future transactions or invoices.\n- `consumed`: this status indicates that the credit amount has been fully consumed. The remaining amount is 0, indicating that the credit has been utilized in its entirety.\n- `voided`: this status indicates that the remaining amount of the credit cannot be used any further. The credit has been voided and is no longer available for application or redemption.","example":"available","isRequired":true,"uniqueKey":"credit_note.credit_status.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.credit_status","typeLabel":"enum\u003cstring> | null"},"refund_status":{"oneOf":[{"type":"string","enum":["pending","succeeded","failed",null],"description":"The status of the refund portion of the credit note. It indicates the current state or condition of the refund associated with the credit note. The possible values for this field are:\n\n- `pending`: this status indicates that the refund is pending execution. The refund request has been initiated but has not been processed or completed yet.\n- `succeeded`: this status indicates that the refund has been successfully executed. The refund amount has been processed and returned to the customer or the designated recipient.\n- `failed`: this status indicates that the refund failed to execute. The refund request encountered an error or unsuccessful processing, and the refund amount could not be returned.","example":"pending","isRequired":true,"uniqueKey":"credit_note.refund_status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["pending","succeeded","failed",null],"description":"The status of the refund portion of the credit note. It indicates the current state or condition of the refund associated with the credit note. The possible values for this field are:\n\n- `pending`: this status indicates that the refund is pending execution. The refund request has been initiated but has not been processed or completed yet.\n- `succeeded`: this status indicates that the refund has been successfully executed. The refund amount has been processed and returned to the customer or the designated recipient.\n- `failed`: this status indicates that the refund failed to execute. The refund request encountered an error or unsuccessful processing, and the refund amount could not be returned.","example":"pending","isRequired":true,"uniqueKey":"credit_note.refund_status.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.refund_status","typeLabel":"enum\u003cstring> | null"},"reason":{"type":"string","enum":["duplicated_charge","product_unsatisfactory","order_change","order_cancellation","fraudulent_charge","other"],"description":"The reason of the credit note creation.\nPossible values are `duplicated_charge`, `product_unsatisfactory`, `order_change`, `order_cancellation`, `fraudulent_charge` or `other`.","example":"other","isRequired":true,"uniqueKey":"credit_note.reason","typeLabel":"enum\u003cstring>"},"description":{"oneOf":[{"type":"string","description":"The description of the credit note.","example":"Free text","isRequired":true,"uniqueKey":"credit_note.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"The description of the credit note.","example":"Free text","isRequired":true,"uniqueKey":"credit_note.description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.description","typeLabel":"string | null"},"currency":{"type":"string","example":"EUR","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BIF","BMD","BND","BOB","BRL","BSD","BWP","BYN","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","ISK","JMD","JPY","KES","KGS","KHR","KMF","KRW","KYD","KZT","LAK","LBP","LKR","LRD","LSL","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW"],"description":"The currency of the credit note.","isRequired":true,"uniqueKey":"credit_note.currency","typeLabel":"enum\u003cstring>"},"total_amount_cents":{"type":"integer","description":"The total amount of the credit note, expressed in cents.","example":120,"isRequired":true,"uniqueKey":"credit_note.total_amount_cents","typeLabel":"integer"},"precise_total_amount_cents":{"type":"string","description":"The total amount of the credit note, expressed in cents, with precision.","example":"120.0001","isRequired":true,"uniqueKey":"credit_note.precise_total_amount_cents","typeLabel":"string"},"taxes_amount_cents":{"type":"integer","description":"The tax amount of the credit note, expressed in cents.","example":20,"isRequired":true,"uniqueKey":"credit_note.taxes_amount_cents","typeLabel":"integer"},"precise_taxes_amount_cents":{"type":"string","description":"The tax amount of the credit note, expressed in cents, with precision.","example":"20.0001","isRequired":true,"uniqueKey":"credit_note.precise_taxes_amount_cents","typeLabel":"string"},"taxes_rate":{"type":"number","description":"The tax rate associated with this specific credit note.","example":20,"isRequired":true,"uniqueKey":"credit_note.taxes_rate","typeLabel":"number"},"sub_total_excluding_taxes_amount_cents":{"type":"integer","description":"The subtotal of the credit note excluding any applicable taxes, expressed in cents.","example":100,"isRequired":true,"uniqueKey":"credit_note.sub_total_excluding_taxes_amount_cents","typeLabel":"integer"},"balance_amount_cents":{"type":"integer","description":"The remaining credit note amount, expressed in cents.","example":100,"isRequired":true,"uniqueKey":"credit_note.balance_amount_cents","typeLabel":"integer"},"credit_amount_cents":{"type":"integer","description":"The credited amount of the credit note, expressed in cents.","example":100,"isRequired":true,"uniqueKey":"credit_note.credit_amount_cents","typeLabel":"integer"},"refund_amount_cents":{"type":"integer","description":"The refunded amount of the credit note, expressed in cents.","example":0,"isRequired":true,"uniqueKey":"credit_note.refund_amount_cents","typeLabel":"integer"},"offset_amount_cents":{"type":"integer","description":"The offset amount (deducted from the invoice balance) of the credit note, expressed in cents.","example":0,"isRequired":true,"uniqueKey":"credit_note.offset_amount_cents","typeLabel":"integer"},"coupons_adjustment_amount_cents":{"type":"integer","description":"The pro-rated amount of the coupons applied to the source invoice.","example":20,"isRequired":true,"uniqueKey":"credit_note.coupons_adjustment_amount_cents","typeLabel":"integer"},"created_at":{"type":"string","format":"date-time","description":"The date when the credit note was created. It is expressed in Coordinated Universal Time (UTC).","example":"2022-09-14T16:35:31Z","isRequired":true,"uniqueKey":"credit_note.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"The date when the credit note was last updated. It is expressed in Coordinated Universal Time (UTC).","example":"2022-09-14T16:35:31Z","isRequired":true,"uniqueKey":"credit_note.updated_at","typeLabel":"string\u003cdate-time>"},"file_url":{"oneOf":[{"type":"string","description":"The PDF file of the credit note. It is `null` while no PDF has been generated.","example":"https://getlago.com/credit_note/file","isRequired":true,"uniqueKey":"credit_note.file_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The PDF file of the credit note. It is `null` while no PDF has been generated.","example":"https://getlago.com/credit_note/file","isRequired":true,"uniqueKey":"credit_note.file_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.file_url","typeLabel":"string | null"},"xml_url":{"oneOf":[{"type":"string","description":"The e-invoicing XML file of the credit note. It is `null` while no XML file has been generated.","example":"https://getlago.com/credit_note/xml","isRequired":true,"uniqueKey":"credit_note.xml_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The e-invoicing XML file of the credit note. It is `null` while no XML file has been generated.","example":"https://getlago.com/credit_note/xml","isRequired":true,"uniqueKey":"credit_note.xml_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.xml_url","typeLabel":"string | null"},"self_billed":{"type":"boolean","example":false,"description":"Indicates if the credit note belongs to self-billed invoice. Self-billing is a process where an organization creates the invoice on behalf of the partner.","isRequired":true,"uniqueKey":"credit_note.self_billed","typeLabel":"boolean"},"items":{"type":"array","items":{"type":"object","required":["lago_id","amount_cents","precise_amount_cents","amount_currency","fee"],"properties":{"lago_id":{"type":"string","format":"uuid","description":"The credit note's item unique identifier, created by Lago.","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].lago_id","typeLabel":"string\u003cuuid>"},"amount_cents":{"type":"integer","description":"The credit note's item amount, expressed in cents.","example":100,"isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].amount_cents","typeLabel":"integer"},"precise_amount_cents":{"type":"string","description":"The credit note's item amount, expressed in cents, with precision.","example":"100.0001","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].precise_amount_cents","typeLabel":"string"},"amount_currency":{"type":"string","example":"EUR","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BIF","BMD","BND","BOB","BRL","BSD","BWP","BYN","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","ISK","JMD","JPY","KES","KGS","KHR","KMF","KRW","KYD","KZT","LAK","LBP","LKR","LRD","LSL","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW"],"description":"The credit note's item currency.","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].amount_currency","typeLabel":"enum\u003cstring>"},"fee":{"type":"object","required":["item","amount_cents","amount_currency","taxes_amount_cents","taxes_rate","total_amount_cents","total_amount_currency","pay_in_advance","invoiceable","units","total_aggregated_units","precise_unit_amount","sub_total_excluding_taxes_amount_cents","sub_total_excluding_taxes_precise_amount_cents","payment_status"],"properties":{"amount_cents":{"type":"integer","description":"The cost of this specific fee, excluding any applicable taxes.","example":100,"isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_cents","typeLabel":"integer"},"amount_currency":{"type":"string","example":"EUR","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BIF","BMD","BND","BOB","BRL","BSD","BWP","BYN","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","ISK","JMD","JPY","KES","KGS","KHR","KMF","KRW","KYD","KZT","LAK","LBP","LKR","LRD","LSL","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW"],"description":"The currency of this specific fee. It indicates the monetary unit in which the fee's cost is expressed.","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_currency","typeLabel":"enum\u003cstring>"},"taxes_amount_cents":{"type":"integer","description":"The cost of the tax associated with this specific fee.","example":20,"isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.taxes_amount_cents","typeLabel":"integer"},"taxes_rate":{"type":"number","description":"The tax rate associated with this specific fee.","example":20,"isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.taxes_rate","typeLabel":"number"},"units":{"type":"string","description":"The number of units used to charge the customer. This field indicates the quantity or count of units consumed or utilized in the context of the charge. It helps in determining the basis for calculating the fee or cost associated with the usage of the service or product provided to the customer.","example":"0.32","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.units","typeLabel":"string"},"precise_unit_amount":{"type":"string","description":"The unit amount of the fee per unit, with precision.","example":"312.5","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.precise_unit_amount","typeLabel":"string"},"total_aggregated_units":{"oneOf":[{"type":"string","description":"The total number of units that have been aggregated for this specific fee. It is `null` on fees that do not aggregate units, such as `subscription`, `add_on` and `credit` fees.","example":"0.32","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.total_aggregated_units.oneOf.0","typeLabel":"string"},{"type":"null","description":"The total number of units that have been aggregated for this specific fee. It is `null` on fees that do not aggregate units, such as `subscription`, `add_on` and `credit` fees.","example":"0.32","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.total_aggregated_units.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.total_aggregated_units","typeLabel":"string | null"},"total_amount_cents":{"type":"integer","description":"The cost of this specific fee, including any applicable taxes.","example":120,"isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.total_amount_cents","typeLabel":"integer"},"total_amount_currency":{"type":"string","example":"EUR","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BIF","BMD","BND","BOB","BRL","BSD","BWP","BYN","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","ISK","JMD","JPY","KES","KGS","KHR","KMF","KRW","KYD","KZT","LAK","LBP","LKR","LRD","LSL","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW"],"description":"The currency of this specific fee, including any applicable taxes.","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.total_amount_currency","typeLabel":"enum\u003cstring>"},"pay_in_advance":{"type":"boolean","description":"Flag that indicates whether the fee was paid in advance. It serves as a boolean value, where `true` represents that the fee was paid in advance (straightaway), and `false` indicates that the fee was not paid in arrears (at the end of the period).","example":true,"isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.pay_in_advance","typeLabel":"boolean"},"invoiceable":{"type":"boolean","description":"Flag that indicates whether the fee was included on the invoice. It serves as a boolean value, where `true` represents that the fee was included on the invoice, and `false` indicates that the fee was not included on the invoice.","example":true,"isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.invoiceable","typeLabel":"boolean"},"payment_status":{"type":"string","enum":["pending","succeeded","failed","refunded"],"description":"Indicates the payment status of the fee. It represents the current status of the payment associated with the fee. The possible values for this field are `pending`, `succeeded`, `failed` and `refunded`.","example":"pending","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.payment_status","typeLabel":"enum\u003cstring>"},"sub_total_excluding_taxes_amount_cents":{"type":"integer","description":"The sub total of the fee excluding taxes, in cents.","example":100,"isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.sub_total_excluding_taxes_amount_cents","typeLabel":"integer"},"sub_total_excluding_taxes_precise_amount_cents":{"type":"string","description":"The sub total of the fee excluding taxes, with precision.","example":"100.0","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.sub_total_excluding_taxes_precise_amount_cents","typeLabel":"string"},"item":{"type":"object","description":"Item attached to the fee","required":["type","code","name","description","invoice_display_name","filters","filter_invoice_display_name","lago_item_id","item_type","grouped_by"],"properties":{"type":{"type":"string","enum":["charge","fixed_charge","add_on","subscription","credit","commitment"],"description":"The fee type. Possible values are `add_on`, `charge`, `fixed_charge`, `credit`, `subscription` or `commitment`.","example":"subscription","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.item.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"The code of the fee item. The value depends on the type of the fee item:\n\n- If the fee item is a `charge`, it is the billable metric code.\n- If the fee item is an `add_on` or a `fixed_charge`, it is the add-on code.\n- If the fee item is a `credit`, it is always `\"credit\"`.\n- For all the other fee items, it is the subscription plan code.\n","example":"startup","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.item.code","typeLabel":"string"},"name":{"type":"string","description":"The name of the fee item. The value depends on the type of the fee item:\n\n- If the fee item is a `charge`, it is the billable metric name.\n- If the fee item is an `add_on`, it is the add-on name.\n- If the fee item is a `credit`, it is the wallet transaction name if set, or `\"credit\"` if not.\n- If the fee item is a `fixed_charge`, it is the fixed charge add-on name.\n- For all the other fee items, it is the subscription plan name.\n","example":"Startup","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.item.name","typeLabel":"string"},"description":{"oneOf":[{"type":"string","description":"The description of the fee item. The value depends on the type of the fee item:\n\n- If the fee item is a `charge`, it is the billable metric description.\n- If the fee item is an `add_on`, it is the add-on description.\n- If the fee item is a `credit`, it is always `\"credit\"`.\n- If the fee item is a `fixed_charge`, it is the fixed charge add-on description.\n- For all the other fee items, it is the subscription plan description.\n","example":"Startup","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.item.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"The description of the fee item. The value depends on the type of the fee item:\n\n- If the fee item is a `charge`, it is the billable metric description.\n- If the fee item is an `add_on`, it is the add-on description.\n- If the fee item is a `credit`, it is always `\"credit\"`.\n- If the fee item is a `fixed_charge`, it is the fixed charge add-on description.\n- For all the other fee items, it is the subscription plan description.\n","example":"Startup","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.item.description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.item.description","typeLabel":"string | null"},"invoice_display_name":{"type":"string","description":"Specifies the name that will be displayed on an invoice. If no value is set for this field, we'll fallback to a value that depends on the type of the fee items:\n\n- If the fee item is a `charge`, we'll fallback to the `invoice_display_name` of the `charge` or the billable metric name if no `invoice_display_name` is set.\n- If the fee item is an `add_on`, we'll fallback to the `invoice_name` of the `add_on` or the `name` of the `add_on`.\n- If the fee item is a `credit`, we'll fallback to the wallet transaction name if set, or `credit` if not.\n- If the fee item is a `fixed_charge`, we'll fallback to the `invoice_display_name` of the `fixed_charge` or the `invoice_name` of the `fixed_charge_add_on` if no `invoice_display_name` is set.\n- For all the other fee items, we'll fallback to the `invoice_display_name` of the subscription plan.\n","example":"Setup Fee (SF1)","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.item.invoice_display_name","typeLabel":"string"},"filter_invoice_display_name":{"oneOf":[{"type":"string","description":"Specifies the name that will be displayed on an invoice. If no value is set for this field, the actual charge filter values will be used as the default display name.","example":"AWS eu-east-1","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.item.filter_invoice_display_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Specifies the name that will be displayed on an invoice. If no value is set for this field, the actual charge filter values will be used as the default display name.","example":"AWS eu-east-1","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.item.filter_invoice_display_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.item.filter_invoice_display_name","typeLabel":"string | null"},"filters":{"oneOf":[{"type":"object","description":"Key value list of event properties","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"credit_note.\\items.items.[INDEX].fee.item.filters.oneOf.0.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"credit_note.\\items.items.[INDEX].fee.item.filters.oneOf.0.additionalProperties","typeLabel":"string[]"},"isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.item.filters.oneOf.0","typeLabel":"object"},{"type":"null","description":"Key value list of event properties","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"credit_note.\\items.items.[INDEX].fee.item.filters.oneOf.1.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"credit_note.\\items.items.[INDEX].fee.item.filters.oneOf.1.additionalProperties","typeLabel":"string[]"},"isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.item.filters.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.item.filters","typeLabel":"object | null"},"lago_item_id":{"type":"string","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","description":"Unique identifier of the fee item, created by Lago. The object it points to is given by `item_type`:\n\n- If the fee item is a `charge`, it is the billable metric identifier.\n- If the fee item is an `add_on` or a `fixed_charge`, it is the add-on identifier.\n- If the fee item is a `credit`, it is the wallet transaction identifier.\n- For all the other fee items, it is the subscription identifier.\n","format":"uuid","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.item.lago_item_id","typeLabel":"string\u003cuuid>"},"item_type":{"type":"string","enum":["AddOn","BillableMetric","Subscription","WalletTransaction"],"description":"The type of the fee item. Possible values are `AddOn`, `BillableMetric`, `WalletTransaction`, `Subscription`.","example":"Subscription","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.item.item_type","typeLabel":"enum\u003cstring>"},"grouped_by":{"type":"object","description":"Key value list of event properties aggregated by the charge model","additionalProperties":{"type":"string","uniqueKey":"credit_note.\\items.items.[INDEX].fee.item.grouped_by.additionalProperties","typeLabel":"string"},"isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.item.grouped_by","typeLabel":"object"}},"isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.item","typeLabel":"object"},"lago_id":{"oneOf":[{"type":"string","format":"uuid","description":"Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the fee's record within the Lago system.","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","uniqueKey":"credit_note.\\items.items.[INDEX].fee.lago_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the fee's record within the Lago system.","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","uniqueKey":"credit_note.\\items.items.[INDEX].fee.lago_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.\\items.items.[INDEX].fee.lago_id","typeLabel":"string\u003cuuid> | null"},"lago_charge_id":{"oneOf":[{"type":"string","format":"uuid","description":"Unique identifier assigned to the charge that the fee belongs to","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","uniqueKey":"credit_note.\\items.items.[INDEX].fee.lago_charge_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Unique identifier assigned to the charge that the fee belongs to","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","uniqueKey":"credit_note.\\items.items.[INDEX].fee.lago_charge_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.\\items.items.[INDEX].fee.lago_charge_id","typeLabel":"string\u003cuuid> | null"},"lago_charge_filter_id":{"oneOf":[{"type":"string","format":"uuid","description":"Unique identifier assigned to the charge filter that the fee belongs to","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","uniqueKey":"credit_note.\\items.items.[INDEX].fee.lago_charge_filter_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Unique identifier assigned to the charge filter that the fee belongs to","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","uniqueKey":"credit_note.\\items.items.[INDEX].fee.lago_charge_filter_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.\\items.items.[INDEX].fee.lago_charge_filter_id","typeLabel":"string\u003cuuid> | null"},"lago_fixed_charge_id":{"oneOf":[{"type":"string","format":"uuid","description":"Unique identifier assigned to the fixed charge that the fee belongs to","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","uniqueKey":"credit_note.\\items.items.[INDEX].fee.lago_fixed_charge_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Unique identifier assigned to the fixed charge that the fee belongs to","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","uniqueKey":"credit_note.\\items.items.[INDEX].fee.lago_fixed_charge_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.\\items.items.[INDEX].fee.lago_fixed_charge_id","typeLabel":"string\u003cuuid> | null"},"lago_invoice_id":{"oneOf":[{"type":"string","format":"uuid","description":"Unique identifier assigned to the invoice that the fee belongs to","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","uniqueKey":"credit_note.\\items.items.[INDEX].fee.lago_invoice_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Unique identifier assigned to the invoice that the fee belongs to","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","uniqueKey":"credit_note.\\items.items.[INDEX].fee.lago_invoice_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.\\items.items.[INDEX].fee.lago_invoice_id","typeLabel":"string\u003cuuid> | null"},"lago_true_up_fee_id":{"oneOf":[{"type":"string","format":"uuid","description":"Unique identifier assigned to the true-up fee when a minimum has been set to the charge. This identifier helps to distinguish and manage the true-up fee associated with the charge, which may be applicable when a minimum threshold or limit is set for the charge amount.","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","uniqueKey":"credit_note.\\items.items.[INDEX].fee.lago_true_up_fee_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Unique identifier assigned to the true-up fee when a minimum has been set to the charge. This identifier helps to distinguish and manage the true-up fee associated with the charge, which may be applicable when a minimum threshold or limit is set for the charge amount.","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","uniqueKey":"credit_note.\\items.items.[INDEX].fee.lago_true_up_fee_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.\\items.items.[INDEX].fee.lago_true_up_fee_id","typeLabel":"string\u003cuuid> | null"},"lago_true_up_parent_fee_id":{"oneOf":[{"type":"string","format":"uuid","description":"Unique identifier assigned to the parent fee on which the true-up fee is assigned. This identifier establishes the relationship between the parent fee and the associated true-up fee.","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","uniqueKey":"credit_note.\\items.items.[INDEX].fee.lago_true_up_parent_fee_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Unique identifier assigned to the parent fee on which the true-up fee is assigned. This identifier establishes the relationship between the parent fee and the associated true-up fee.","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","uniqueKey":"credit_note.\\items.items.[INDEX].fee.lago_true_up_parent_fee_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.\\items.items.[INDEX].fee.lago_true_up_parent_fee_id","typeLabel":"string\u003cuuid> | null"},"lago_original_fee_id":{"oneOf":[{"type":"string","format":"uuid","description":"Unique identifier assigned to the fee this fee was derived from. It is set on fees regenerated from an existing fee, and `null` otherwise.","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","uniqueKey":"credit_note.\\items.items.[INDEX].fee.lago_original_fee_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Unique identifier assigned to the fee this fee was derived from. It is set on fees regenerated from an existing fee, and `null` otherwise.","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","uniqueKey":"credit_note.\\items.items.[INDEX].fee.lago_original_fee_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.\\items.items.[INDEX].fee.lago_original_fee_id","typeLabel":"string\u003cuuid> | null"},"lago_subscription_id":{"oneOf":[{"type":"string","format":"uuid","description":"Unique identifier assigned to the subscription, created by Lago. This field is specifically displayed when the fee type is charge or subscription.","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","uniqueKey":"credit_note.\\items.items.[INDEX].fee.lago_subscription_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Unique identifier assigned to the subscription, created by Lago. This field is specifically displayed when the fee type is charge or subscription.","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","uniqueKey":"credit_note.\\items.items.[INDEX].fee.lago_subscription_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.\\items.items.[INDEX].fee.lago_subscription_id","typeLabel":"string\u003cuuid> | null"},"lago_customer_id":{"oneOf":[{"type":"string","format":"uuid","description":"Unique identifier assigned to the customer, created by Lago. This field is specifically displayed when the fee type is charge or subscription.","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","uniqueKey":"credit_note.\\items.items.[INDEX].fee.lago_customer_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Unique identifier assigned to the customer, created by Lago. This field is specifically displayed when the fee type is charge or subscription.","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","uniqueKey":"credit_note.\\items.items.[INDEX].fee.lago_customer_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.\\items.items.[INDEX].fee.lago_customer_id","typeLabel":"string\u003cuuid> | null"},"external_customer_id":{"oneOf":[{"type":"string","description":"Unique identifier assigned to the customer in your application. This field is specifically displayed when the fee type is charge or subscription.","example":"external_id","uniqueKey":"credit_note.\\items.items.[INDEX].fee.external_customer_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier assigned to the customer in your application. This field is specifically displayed when the fee type is charge or subscription.","example":"external_id","uniqueKey":"credit_note.\\items.items.[INDEX].fee.external_customer_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.\\items.items.[INDEX].fee.external_customer_id","typeLabel":"string | null"},"external_subscription_id":{"oneOf":[{"type":"string","description":"Unique identifier assigned to the subscription in your application. This field is specifically displayed when the fee type is charge or subscription.","example":"external_id","uniqueKey":"credit_note.\\items.items.[INDEX].fee.external_subscription_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier assigned to the subscription in your application. This field is specifically displayed when the fee type is charge or subscription.","example":"external_id","uniqueKey":"credit_note.\\items.items.[INDEX].fee.external_subscription_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.\\items.items.[INDEX].fee.external_subscription_id","typeLabel":"string | null"},"precise_amount":{"type":"string","description":"The cost of this specific fee, excluding any applicable taxes, with precision.","example":"1.0001","uniqueKey":"credit_note.\\items.items.[INDEX].fee.precise_amount","typeLabel":"string"},"precise_total_amount":{"type":"string","description":"The cost of this specific fee, including any applicable taxes, with precision.","example":"1.0212","uniqueKey":"credit_note.\\items.items.[INDEX].fee.precise_total_amount","typeLabel":"string"},"taxes_precise_amount":{"type":"string","description":"The cost of the tax associated with this specific fee, with precision.","example":"0.20123","uniqueKey":"credit_note.\\items.items.[INDEX].fee.taxes_precise_amount","typeLabel":"string"},"events_count":{"oneOf":[{"type":"integer","description":"The number of events that have been sent and used to charge the customer. This field indicates the count or quantity of events that have been processed and considered in the charging process.","example":23,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.events_count.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of events that have been sent and used to charge the customer. This field indicates the count or quantity of events that have been processed and considered in the charging process.","example":23,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.events_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.\\items.items.[INDEX].fee.events_count","typeLabel":"integer | null"},"from_date":{"oneOf":[{"type":"string","format":"date-time","description":"The beginning date of the period that the fee covers. It is returned only for `subscription`, `charge`, `add_on` and `fixed_charge` fees. This field indicates the start date of the billing period or subscription period associated with the fee.","example":"2022-04-29T08:59:51Z","uniqueKey":"credit_note.\\items.items.[INDEX].fee.from_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The beginning date of the period that the fee covers. It is returned only for `subscription`, `charge`, `add_on` and `fixed_charge` fees. This field indicates the start date of the billing period or subscription period associated with the fee.","example":"2022-04-29T08:59:51Z","uniqueKey":"credit_note.\\items.items.[INDEX].fee.from_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.\\items.items.[INDEX].fee.from_date","typeLabel":"string\u003cdate-time> | null"},"to_date":{"oneOf":[{"type":"string","format":"date-time","description":"The ending date of the period that the fee covers. It is returned only for `subscription`, `charge`, `add_on` and `fixed_charge` fees. This field indicates the end date of the billing period or subscription period associated with the fee.","example":"2022-05-29T08:59:51Z","uniqueKey":"credit_note.\\items.items.[INDEX].fee.to_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The ending date of the period that the fee covers. It is returned only for `subscription`, `charge`, `add_on` and `fixed_charge` fees. This field indicates the end date of the billing period or subscription period associated with the fee.","example":"2022-05-29T08:59:51Z","uniqueKey":"credit_note.\\items.items.[INDEX].fee.to_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.\\items.items.[INDEX].fee.to_date","typeLabel":"string\u003cdate-time> | null"},"created_at":{"oneOf":[{"type":"string","format":"date-time","description":"The date and time when the fee was created. It is provided in Coordinated Universal Time (UTC) format.","example":"2022-08-24T14:58:59Z","uniqueKey":"credit_note.\\items.items.[INDEX].fee.created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date and time when the fee was created. It is provided in Coordinated Universal Time (UTC) format.","example":"2022-08-24T14:58:59Z","uniqueKey":"credit_note.\\items.items.[INDEX].fee.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.\\items.items.[INDEX].fee.created_at","typeLabel":"string\u003cdate-time> | null"},"succeeded_at":{"oneOf":[{"type":"string","format":"date-time","description":"The date and time when the payment for the fee was successfully processed. It is provided in Coordinated Universal Time (UTC) format.","example":"2022-08-24T14:58:59Z","uniqueKey":"credit_note.\\items.items.[INDEX].fee.succeeded_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date and time when the payment for the fee was successfully processed. It is provided in Coordinated Universal Time (UTC) format.","example":"2022-08-24T14:58:59Z","uniqueKey":"credit_note.\\items.items.[INDEX].fee.succeeded_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.\\items.items.[INDEX].fee.succeeded_at","typeLabel":"string\u003cdate-time> | null"},"failed_at":{"oneOf":[{"type":"string","format":"date-time","description":"The date and time when the payment for the fee failed to process. It is provided in Coordinated Universal Time (UTC) format.","example":"2022-08-24T14:58:59Z","uniqueKey":"credit_note.\\items.items.[INDEX].fee.failed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date and time when the payment for the fee failed to process. It is provided in Coordinated Universal Time (UTC) format.","example":"2022-08-24T14:58:59Z","uniqueKey":"credit_note.\\items.items.[INDEX].fee.failed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.\\items.items.[INDEX].fee.failed_at","typeLabel":"string\u003cdate-time> | null"},"refunded_at":{"oneOf":[{"type":"string","format":"date-time","description":"The date and time when the payment for the fee was refunded. It is provided in Coordinated Universal Time (UTC) format","example":"2022-08-24T14:58:59Z","uniqueKey":"credit_note.\\items.items.[INDEX].fee.refunded_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date and time when the payment for the fee was refunded. It is provided in Coordinated Universal Time (UTC) format","example":"2022-08-24T14:58:59Z","uniqueKey":"credit_note.\\items.items.[INDEX].fee.refunded_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.\\items.items.[INDEX].fee.refunded_at","typeLabel":"string\u003cdate-time> | null"},"event_transaction_id":{"oneOf":[{"type":"string","description":"Unique identifier assigned to the transaction. This field is specifically displayed when the fee type is `charge` and the payment for the fee is made in advance (`pay_in_advance` is set to `true`).","example":"transaction_1234567890","uniqueKey":"credit_note.\\items.items.[INDEX].fee.event_transaction_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier assigned to the transaction. This field is specifically displayed when the fee type is `charge` and the payment for the fee is made in advance (`pay_in_advance` is set to `true`).","example":"transaction_1234567890","uniqueKey":"credit_note.\\items.items.[INDEX].fee.event_transaction_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.\\items.items.[INDEX].fee.event_transaction_id","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"The description of the fee.","example":"Fee description","uniqueKey":"credit_note.\\items.items.[INDEX].fee.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"The description of the fee.","example":"Fee description","uniqueKey":"credit_note.\\items.items.[INDEX].fee.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.\\items.items.[INDEX].fee.description","typeLabel":"string | null"},"precise_coupons_amount_cents":{"type":"string","description":"The coupon amount applied to the fee, with precision.","example":"0.0","uniqueKey":"credit_note.\\items.items.[INDEX].fee.precise_coupons_amount_cents","typeLabel":"string"},"amount_details":{"type":"object","properties":{"plan_amount_cents":{"type":"integer","description":"The base cost of the plan, excluding any applicable taxes, that is billed on a recurring basis. This value is defined at 0 if your plan is a pay-as-you-go plan.","example":10000,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.plan_amount_cents","typeLabel":"integer"},"graduated_ranges":{"type":"array","description":"Graduated ranges, used for a `graduated` charge model.","items":{"type":"object","required":["units","from_value","to_value","flat_unit_amount","per_unit_amount","per_unit_total_amount","total_with_flat_amount"],"properties":{"units":{"type":"string","pattern":"^[0-9]+.?[0-9]*$","example":"10.0","description":"Total units received in Lago.","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.graduated_ranges.items.[INDEX].units","typeLabel":"string"},"from_value":{"type":"integer","description":"Lower value of a tier. It is either 0 or the previous range's `to_value + 1`.","example":0,"isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.graduated_ranges.items.[INDEX].from_value","typeLabel":"integer"},"to_value":{"oneOf":[{"type":"integer","description":"Highest value of a tier.\n- This value is higher than the from_value of the same tier.\n- This value is null for the last tier.","example":10,"isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.graduated_ranges.items.[INDEX].to_value.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Highest value of a tier.\n- This value is higher than the from_value of the same tier.\n- This value is null for the last tier.","example":10,"isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.graduated_ranges.items.[INDEX].to_value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.graduated_ranges.items.[INDEX].to_value","typeLabel":"integer | null"},"flat_unit_amount":{"type":"string","description":"Flat unit amount within a specified tier.","example":"1.0","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.graduated_ranges.items.[INDEX].flat_unit_amount","typeLabel":"string"},"per_unit_amount":{"type":"string","description":"Amount per unit within a specified tier.","example":"1.0","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.graduated_ranges.items.[INDEX].per_unit_amount","typeLabel":"string"},"per_unit_total_amount":{"type":"string","description":"Total amount of received units to be charged within a specified tier.","example":"10.0","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.graduated_ranges.items.[INDEX].per_unit_total_amount","typeLabel":"string"},"total_with_flat_amount":{"type":"string","description":"Total amount to be charged for a specific tier, taking into account the flat_unit_amount and the per_unit_total_amount.","example":"11.0","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.graduated_ranges.items.[INDEX].total_with_flat_amount","typeLabel":"string"}},"uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.graduated_ranges.items.[INDEX]","typeLabel":"object"},"uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.graduated_ranges","typeLabel":"object[]"},"graduated_percentage_ranges":{"type":"array","description":"Graduated percentage ranges, used for a `graduated_percentage` charge model.","items":{"type":"object","required":["units","from_value","to_value","flat_unit_amount","rate","per_unit_total_amount","total_with_flat_amount"],"properties":{"units":{"type":"string","pattern":"^[0-9]+.?[0-9]*$","example":"10.0","description":"Total units received in Lago.","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.graduated_percentage_ranges.items.[INDEX].units","typeLabel":"string"},"from_value":{"type":"integer","description":"Lower value of a tier. It is either 0 or the previous range's `to_value + 1`.","example":0,"isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.graduated_percentage_ranges.items.[INDEX].from_value","typeLabel":"integer"},"to_value":{"oneOf":[{"type":"integer","description":"Highest value of a tier.\n- This value is higher than the from_value of the same tier.\n- This value is null for the last tier.","example":10,"isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.graduated_percentage_ranges.items.[INDEX].to_value.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Highest value of a tier.\n- This value is higher than the from_value of the same tier.\n- This value is null for the last tier.","example":10,"isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.graduated_percentage_ranges.items.[INDEX].to_value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.graduated_percentage_ranges.items.[INDEX].to_value","typeLabel":"integer | null"},"flat_unit_amount":{"type":"string","description":"Flat unit amount within a specified tier.","example":"1.0","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.graduated_percentage_ranges.items.[INDEX].flat_unit_amount","typeLabel":"string"},"rate":{"type":"string","format":"^[0-9]+.?[0-9]*$","description":"Percentage rate applied within a specified tier.","example":"1.0","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.graduated_percentage_ranges.items.[INDEX].rate","typeLabel":"string\u003c^[0-9]+.?[0-9]*$>"},"per_unit_total_amount":{"type":"string","description":"Total amount of received units to be charged within a specified tier.","example":"10.0","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.graduated_percentage_ranges.items.[INDEX].per_unit_total_amount","typeLabel":"string"},"total_with_flat_amount":{"type":"string","description":"Total amount to be charged for a specific tier, taking into account the flat_unit_amount and the per_unit_total_amount.","example":"11.0","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.graduated_percentage_ranges.items.[INDEX].total_with_flat_amount","typeLabel":"string"}},"uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.graduated_percentage_ranges.items.[INDEX]","typeLabel":"object"},"uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.graduated_percentage_ranges","typeLabel":"object[]"},"free_units":{"type":"string","pattern":"^[0-9]+.?[0-9]*$","example":"10.0","description":"The quantity of units that are provided free of charge for each billing period in a `package` charge model.","uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.free_units","typeLabel":"string"},"paid_units":{"type":"string","pattern":"^[0-9]+.?[0-9]*$","example":"40.0","description":"The quantity of units that are not provided free of charge for each billing period in a `package` charge model.","uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.paid_units","typeLabel":"string"},"per_package_size":{"type":"integer","description":"The quantity of units included, defined for Package or Percentage charge model.","example":1000,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.per_package_size","typeLabel":"integer"},"per_package_unit_amount":{"type":"string","pattern":"^[0-9]+.?[0-9]*$","description":"Total amount to charge for received paid_units, defined for Package or Percentage charge model.","example":"0.5","uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.per_package_unit_amount","typeLabel":"string"},"per_unit_total_amount":{"type":"string","pattern":"^[0-9]+.?[0-9]*$","description":"Total amount of received units to be charged for the Volume or Percentage charge model.","example":"10.0","uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.per_unit_total_amount","typeLabel":"string"},"units":{"type":"string","pattern":"^[0-9]+.?[0-9]*$","example":"20.0","description":"The total units received in Lago for the Percentage charge model.","uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.units","typeLabel":"string"},"free_events":{"type":"integer","example":10,"description":"Total number of free events allowed for the Percentage charge model.","uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.free_events","typeLabel":"integer"},"rate":{"type":"string","format":"^[0-9]+.?[0-9]*$","description":"Percentage rate applied for the Percentage charge model.","example":"1.0","uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.rate","typeLabel":"string\u003c^[0-9]+.?[0-9]*$>"},"paid_events":{"type":"integer","example":20,"description":"Total number of paid events for the Percentage charge model.","uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.paid_events","typeLabel":"integer"},"fixed_fee_unit_amount":{"type":"string","description":"Fixed fee unit price per received paid_event for the Percentage charge model.","example":"1.0","uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.fixed_fee_unit_amount","typeLabel":"string"},"fixed_fee_total_amount":{"type":"string","description":"Total amount to charge for received paid_events for the Percentage charge model.","example":"20.0","uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.fixed_fee_total_amount","typeLabel":"string"},"min_max_adjustment_total_amount":{"type":"string","description":"Total adjustment amount linked to minimum and maximum spending per transaction for the Percentage charge model.","example":"20.0","uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.min_max_adjustment_total_amount","typeLabel":"string"},"per_unit_amount":{"type":"string","pattern":"^[0-9]+.?[0-9]*$","description":"The flat amount for a whole tier, excluding tax, for a `volume` charge model.","example":"0.5","uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.per_unit_amount","typeLabel":"string"},"flat_unit_amount":{"type":"string","pattern":"^[0-9]+.?[0-9]*$","description":"The unit price, excluding tax, for a specific tier of a `volume` charge model.","example":"10.0","uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details.flat_unit_amount","typeLabel":"string"}},"description":"List of all unit amount details for calculating the fee.","uniqueKey":"credit_note.\\items.items.[INDEX].fee.amount_details","typeLabel":"object"},"self_billed":{"type":"boolean","example":false,"description":"Indicates if the fee belongs to self-billed invoice. Self-billing is a process where an organization creates the invoice on behalf of the partner.","uniqueKey":"credit_note.\\items.items.[INDEX].fee.self_billed","typeLabel":"boolean"},"applied_taxes":{"type":"array","description":"List of fee applied taxes","items":{"type":"object","required":["lago_id","lago_tax_id","tax_name","tax_code","tax_rate","tax_description","amount_cents","amount_currency","created_at"],"properties":{"lago_id":{"type":"string","format":"uuid","description":"Unique identifier of the applied tax, created by Lago.","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.applied_taxes.items.[INDEX].lago_id","typeLabel":"string\u003cuuid>"},"lago_tax_id":{"oneOf":[{"type":"string","format":"uuid","description":"Unique identifier of the tax, created by Lago.","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.applied_taxes.items.[INDEX].lago_tax_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Unique identifier of the tax, created by Lago.","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.applied_taxes.items.[INDEX].lago_tax_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.applied_taxes.items.[INDEX].lago_tax_id","typeLabel":"string\u003cuuid> | null"},"tax_name":{"type":"string","description":"Name of the tax.","example":"TVA","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.applied_taxes.items.[INDEX].tax_name","typeLabel":"string"},"tax_code":{"type":"string","description":"Unique code used to identify the tax associated with the API request.","example":"french_standard_vat","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.applied_taxes.items.[INDEX].tax_code","typeLabel":"string"},"tax_rate":{"type":"number","description":"The percentage rate of the tax","example":20,"isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.applied_taxes.items.[INDEX].tax_rate","typeLabel":"number"},"tax_description":{"oneOf":[{"type":"string","description":"Internal description of the tax","example":"French standard VAT","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.applied_taxes.items.[INDEX].tax_description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Internal description of the tax","example":"French standard VAT","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.applied_taxes.items.[INDEX].tax_description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.applied_taxes.items.[INDEX].tax_description","typeLabel":"string | null"},"amount_cents":{"type":"integer","description":"Amount of the tax","example":2000,"isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.applied_taxes.items.[INDEX].amount_cents","typeLabel":"integer"},"amount_currency":{"type":"string","example":"USD","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BIF","BMD","BND","BOB","BRL","BSD","BWP","BYN","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","ISK","JMD","JPY","KES","KGS","KHR","KMF","KRW","KYD","KZT","LAK","LBP","LKR","LRD","LSL","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW"],"description":"Currency of the tax","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.applied_taxes.items.[INDEX].amount_currency","typeLabel":"enum\u003cstring>"},"created_at":{"type":"string","format":"date-time","description":"The date and time when the applied tax was created. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the applied tax was initially created.","example":"2022-09-14T16:35:31Z","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.applied_taxes.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"lago_fee_id":{"type":"string","format":"uuid","description":"Unique identifier of the fee, created by Lago.","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","uniqueKey":"credit_note.\\items.items.[INDEX].fee.applied_taxes.items.[INDEX].lago_fee_id","typeLabel":"string\u003cuuid>"}},"uniqueKey":"credit_note.\\items.items.[INDEX].fee.applied_taxes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"credit_note.\\items.items.[INDEX].fee.applied_taxes","typeLabel":"object[]"},"pricing_unit_details":{"oneOf":[{"type":"object","required":["lago_pricing_unit_id","pricing_unit_code","short_name","amount_cents","precise_amount_cents","unit_amount_cents","precise_unit_amount","conversion_rate"],"properties":{"lago_pricing_unit_id":{"type":"string","format":"uuid","description":"Unique identifier of the pricing unit, created by Lago.","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.pricing_unit_details.oneOf.0.lago_pricing_unit_id","typeLabel":"string\u003cuuid>"},"pricing_unit_code":{"type":"string","description":"The code of the pricing unit.","example":"credits","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.pricing_unit_details.oneOf.0.pricing_unit_code","typeLabel":"string"},"short_name":{"type":"string","description":"The short name of the pricing unit. Will be used as currency name in the UI and PDFs.","example":"CR","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.pricing_unit_details.oneOf.0.short_name","typeLabel":"string"},"amount_cents":{"type":"integer","description":"The amount in cents in the pricing unit.","example":200,"isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.pricing_unit_details.oneOf.0.amount_cents","typeLabel":"integer"},"precise_amount_cents":{"type":"string","description":"The precise amount in cents in the pricing unit.","example":"200.0","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.pricing_unit_details.oneOf.0.precise_amount_cents","typeLabel":"string"},"unit_amount_cents":{"type":"integer","description":"The unit amount in cents in the pricing unit.","example":100,"isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.pricing_unit_details.oneOf.0.unit_amount_cents","typeLabel":"integer"},"precise_unit_amount":{"type":"string","description":"The precise unit amount in the pricing unit.","example":"100.0","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.pricing_unit_details.oneOf.0.precise_unit_amount","typeLabel":"string"},"conversion_rate":{"type":"string","description":"The conversion rate from pricing units to the plan's currency.","example":"0.5","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee.pricing_unit_details.oneOf.0.conversion_rate","typeLabel":"string"}},"description":"Details about the pricing unit used and amounts for this fee.","uniqueKey":"credit_note.\\items.items.[INDEX].fee.pricing_unit_details.oneOf.0","typeLabel":"object"},{"type":"null","required":["lago_pricing_unit_id","pricing_unit_code","short_name","amount_cents","precise_amount_cents","unit_amount_cents","precise_unit_amount","conversion_rate"],"properties":{"lago_pricing_unit_id":{"type":"string","format":"uuid","description":"Unique identifier of the pricing unit, created by Lago.","example":"1a901a90-1a90-1a90-1a90-1a901a901a90"},"pricing_unit_code":{"type":"string","description":"The code of the pricing unit.","example":"credits"},"short_name":{"type":"string","description":"The short name of the pricing unit. Will be used as currency name in the UI and PDFs.","example":"CR"},"amount_cents":{"type":"integer","description":"The amount in cents in the pricing unit.","example":200},"precise_amount_cents":{"type":"string","description":"The precise amount in cents in the pricing unit.","example":"200.0"},"unit_amount_cents":{"type":"integer","description":"The unit amount in cents in the pricing unit.","example":100},"precise_unit_amount":{"type":"string","description":"The precise unit amount in the pricing unit.","example":"100.0"},"conversion_rate":{"type":"string","description":"The conversion rate from pricing units to the plan's currency.","example":"0.5"}},"description":"Details about the pricing unit used and amounts for this fee.","uniqueKey":"credit_note.\\items.items.[INDEX].fee.pricing_unit_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.\\items.items.[INDEX].fee.pricing_unit_details","typeLabel":"object | null"},"presentation_breakdowns":{"type":"array","description":"Array of usage breakdowns split by presentation group keys without affecting pricing or aggregation.","items":{"type":"object","properties":{"presentation_by":{"type":"object","description":"Key value list of event properties used for presentation grouping.","additionalProperties":{"type":"string","uniqueKey":"credit_note.\\items.items.[INDEX].fee.presentation_breakdowns.items.[INDEX].presentation_by.additionalProperties","typeLabel":"string"},"uniqueKey":"credit_note.\\items.items.[INDEX].fee.presentation_breakdowns.items.[INDEX].presentation_by","typeLabel":"object"},"units":{"type":"string","example":"9.0","description":"The number of units consumed for a specific presentation group.","uniqueKey":"credit_note.\\items.items.[INDEX].fee.presentation_breakdowns.items.[INDEX].units","typeLabel":"string"}},"uniqueKey":"credit_note.\\items.items.[INDEX].fee.presentation_breakdowns.items.[INDEX]","typeLabel":"object"},"uniqueKey":"credit_note.\\items.items.[INDEX].fee.presentation_breakdowns","typeLabel":"object[]"}},"description":"The fee object related to the credit note item.","isRequired":true,"uniqueKey":"credit_note.\\items.items.[INDEX].fee","typeLabel":"object"}},"uniqueKey":"credit_note.\\items.items.[INDEX]","typeLabel":"object"},"description":"Array of credit note's items.","uniqueKey":"credit_note.\\items","typeLabel":"object[]"},"applied_taxes":{"type":"array","items":{"type":"object","required":["lago_id","lago_tax_id","tax_name","tax_code","tax_rate","tax_description","amount_cents","amount_currency","created_at"],"properties":{"lago_id":{"type":"string","format":"uuid","description":"Unique identifier of the applied tax, created by Lago.","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","isRequired":true,"uniqueKey":"credit_note.applied_taxes.items.[INDEX].lago_id","typeLabel":"string\u003cuuid>"},"lago_tax_id":{"oneOf":[{"type":"string","format":"uuid","description":"Unique identifier of the tax, created by Lago.","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","isRequired":true,"uniqueKey":"credit_note.applied_taxes.items.[INDEX].lago_tax_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Unique identifier of the tax, created by Lago.","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","isRequired":true,"uniqueKey":"credit_note.applied_taxes.items.[INDEX].lago_tax_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.applied_taxes.items.[INDEX].lago_tax_id","typeLabel":"string\u003cuuid> | null"},"tax_name":{"type":"string","description":"Name of the tax.","example":"TVA","isRequired":true,"uniqueKey":"credit_note.applied_taxes.items.[INDEX].tax_name","typeLabel":"string"},"tax_code":{"type":"string","description":"Unique code used to identify the tax associated with the API request.","example":"french_standard_vat","isRequired":true,"uniqueKey":"credit_note.applied_taxes.items.[INDEX].tax_code","typeLabel":"string"},"tax_rate":{"type":"number","description":"The percentage rate of the tax","example":20,"isRequired":true,"uniqueKey":"credit_note.applied_taxes.items.[INDEX].tax_rate","typeLabel":"number"},"tax_description":{"oneOf":[{"type":"string","description":"Internal description of the tax","example":"French standard VAT","isRequired":true,"uniqueKey":"credit_note.applied_taxes.items.[INDEX].tax_description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Internal description of the tax","example":"French standard VAT","isRequired":true,"uniqueKey":"credit_note.applied_taxes.items.[INDEX].tax_description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.applied_taxes.items.[INDEX].tax_description","typeLabel":"string | null"},"amount_cents":{"type":"integer","description":"Amount of the tax","example":2000,"isRequired":true,"uniqueKey":"credit_note.applied_taxes.items.[INDEX].amount_cents","typeLabel":"integer"},"amount_currency":{"type":"string","example":"USD","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BIF","BMD","BND","BOB","BRL","BSD","BWP","BYN","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","ISK","JMD","JPY","KES","KGS","KHR","KMF","KRW","KYD","KZT","LAK","LBP","LKR","LRD","LSL","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW"],"description":"Currency of the tax","isRequired":true,"uniqueKey":"credit_note.applied_taxes.items.[INDEX].amount_currency","typeLabel":"enum\u003cstring>"},"created_at":{"type":"string","format":"date-time","description":"The date and time when the applied tax was created. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the applied tax was initially created.","example":"2022-09-14T16:35:31Z","isRequired":true,"uniqueKey":"credit_note.applied_taxes.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"lago_credit_note_id":{"type":"string","format":"uuid","description":"Unique identifier of the credit note, created by Lago.","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","uniqueKey":"credit_note.applied_taxes.items.[INDEX].lago_credit_note_id","typeLabel":"string\u003cuuid>"},"base_amount_cents":{"type":"integer","example":100,"uniqueKey":"credit_note.applied_taxes.items.[INDEX].base_amount_cents","typeLabel":"integer"}},"uniqueKey":"credit_note.applied_taxes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"credit_note.applied_taxes","typeLabel":"object[]"},"customer":{"type":"object","required":["lago_id","sequential_id","slug","external_id","billing_entity_code","address_line1","address_line2","applicable_timezone","city","country","currency","email","legal_name","legal_number","logo_url","name","firstname","lastname","account_type","customer_type","phone","state","tax_identification_number","timezone","url","zipcode","net_payment_term","external_salesforce_id","created_at","updated_at","finalize_zero_amount_invoice","skip_invoice_custom_sections","billing_configuration","shipping_address","metadata"],"properties":{"lago_id":{"type":"string","description":"Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer's record within the Lago system","format":"uuid","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","isRequired":true,"uniqueKey":"credit_note.customer.lago_id","typeLabel":"string\u003cuuid>"},"sequential_id":{"type":"integer","description":"The unique identifier assigned to the customer within the organization's scope. This identifier is used to track and reference the customer's order of creation within the organization's system. It ensures that each customer has a distinct `sequential_id` associated with them, allowing for easy identification and sorting based on the order of creation","example":1,"isRequired":true,"uniqueKey":"credit_note.customer.sequential_id","typeLabel":"integer"},"slug":{"type":"string","description":"A concise and unique identifier for the customer, formed by combining the Organization's `name`, `id`, and customer's `sequential_id`","example":"LAG-1234-001","isRequired":true,"uniqueKey":"credit_note.customer.slug","typeLabel":"string"},"external_id":{"type":"string","description":"The customer external unique identifier (provided by your own application)","example":"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba","isRequired":true,"uniqueKey":"credit_note.customer.external_id","typeLabel":"string"},"billing_entity_code":{"type":"string","description":"The unique code of the billing entity associated with the customer.","example":"acme_corp","isRequired":true,"uniqueKey":"credit_note.customer.billing_entity_code","typeLabel":"string"},"address_line1":{"oneOf":[{"type":"string","description":"The first line of the billing address","example":"5230 Penfield Ave","isRequired":true,"uniqueKey":"credit_note.customer.address_line1.oneOf.0","typeLabel":"string"},{"type":"null","description":"The first line of the billing address","example":"5230 Penfield Ave","isRequired":true,"uniqueKey":"credit_note.customer.address_line1.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.customer.address_line1","typeLabel":"string | null"},"address_line2":{"oneOf":[{"type":"string","description":"The second line of the billing address","example":null,"isRequired":true,"uniqueKey":"credit_note.customer.address_line2.oneOf.0","typeLabel":"string"},{"type":"null","description":"The second line of the billing address","example":null,"isRequired":true,"uniqueKey":"credit_note.customer.address_line2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.customer.address_line2","typeLabel":"string | null"},"applicable_timezone":{"type":"string","description":"The customer's applicable timezone, used for billing purposes in their local time.","enum":["UTC","Africa/Algiers","Africa/Cairo","Africa/Casablanca","Africa/Harare","Africa/Johannesburg","Africa/Monrovia","Africa/Nairobi","America/Argentina/Buenos_Aires","America/Bogota","America/Caracas","America/Chicago","America/Chihuahua","America/Denver","America/Guatemala","America/Guyana","America/Halifax","America/Indiana/Indianapolis","America/Juneau","America/La_Paz","America/Lima","America/Los_Angeles","America/Mazatlan","America/Mexico_City","America/Monterrey","America/Montevideo","America/New_York","America/Nuuk","America/Phoenix","America/Puerto_Rico","America/Regina","America/Santiago","America/Sao_Paulo","America/St_Johns","America/Tijuana","Asia/Almaty","Asia/Baghdad","Asia/Baku","Asia/Bangkok","Asia/Chongqing","Asia/Colombo","Asia/Dhaka","Asia/Hong_Kong","Asia/Irkutsk","Asia/Jakarta","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kathmandu","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuwait","Asia/Magadan","Asia/Muscat","Asia/Novosibirsk","Asia/Riyadh","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Tokyo","Asia/Ulaanbaatar","Asia/Urumqi","Asia/Vladivostok","Asia/Yakutsk","Asia/Yangon","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Cape_Verde","Atlantic/South_Georgia","Australia/Adelaide","Australia/Brisbane","Australia/Darwin","Australia/Hobart","Australia/Melbourne","Australia/Perth","Australia/Sydney","Europe/Amsterdam","Europe/Athens","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Copenhagen","Europe/Dublin","Europe/Helsinki","Europe/Istanbul","Europe/Kaliningrad","Europe/Kyiv","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Madrid","Europe/Minsk","Europe/Moscow","Europe/Paris","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/Sarajevo","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zurich","GMT+12","Pacific/Apia","Pacific/Auckland","Pacific/Chatham","Pacific/Fakaofo","Pacific/Fiji","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Majuro","Pacific/Midway","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Port_Moresby","Pacific/Tongatapu"],"example":"America/Los_Angeles","isRequired":true,"uniqueKey":"credit_note.customer.applicable_timezone","typeLabel":"enum\u003cstring>"},"city":{"oneOf":[{"type":"string","description":"The city of the customer's billing address","example":"Woodland Hills","isRequired":true,"uniqueKey":"credit_note.customer.city.oneOf.0","typeLabel":"string"},{"type":"null","description":"The city of the customer's billing address","example":"Woodland Hills","isRequired":true,"uniqueKey":"credit_note.customer.city.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.customer.city","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"Country code of the customer's billing address. Format must be ISO 3166 (alpha-2)","enum":[null,"AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"example":"US","isRequired":true,"uniqueKey":"credit_note.customer.country.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Country code of the customer's billing address. Format must be ISO 3166 (alpha-2)","enum":[null,"AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"example":"US","isRequired":true,"uniqueKey":"credit_note.customer.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.customer.country","typeLabel":"enum\u003cstring> | null"},"currency":{"oneOf":[{"type":"string","description":"Currency of the customer. Format must be ISO 4217","enum":[null,"AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BIF","BMD","BND","BOB","BRL","BSD","BWP","BYN","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ETB","EUR","FJD","FKP","GBP","GEL","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","ISK","JMD","JPY","KES","KGS","KHR","KMF","KRW","KYD","KZT","LAK","LBP","LKR","LRD","LSL","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW"],"example":"USD","isRequired":true,"uniqueKey":"credit_note.customer.currency.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Currency of the customer. Format must be ISO 4217","enum":[null,"AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BIF","BMD","BND","BOB","BRL","BSD","BWP","BYN","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ETB","EUR","FJD","FKP","GBP","GEL","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","ISK","JMD","JPY","KES","KGS","KHR","KMF","KRW","KYD","KZT","LAK","LBP","LKR","LRD","LSL","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW"],"example":"USD","isRequired":true,"uniqueKey":"credit_note.customer.currency.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.customer.currency","typeLabel":"enum\u003cstring> | null"},"email":{"oneOf":[{"type":"string","description":"The email of the customer","format":"email","example":"dinesh@piedpiper.example","isRequired":true,"uniqueKey":"credit_note.customer.email.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","description":"The email of the customer","format":"email","example":"dinesh@piedpiper.example","isRequired":true,"uniqueKey":"credit_note.customer.email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.customer.email","typeLabel":"string\u003cemail> | null"},"legal_name":{"oneOf":[{"type":"string","description":"The legal company name of the customer","example":"Coleman-Blair","isRequired":true,"uniqueKey":"credit_note.customer.legal_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The legal company name of the customer","example":"Coleman-Blair","isRequired":true,"uniqueKey":"credit_note.customer.legal_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.customer.legal_name","typeLabel":"string | null"},"legal_number":{"oneOf":[{"type":"string","description":"The legal company number of the customer","example":"49-008-2965","isRequired":true,"uniqueKey":"credit_note.customer.legal_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"The legal company number of the customer","example":"49-008-2965","isRequired":true,"uniqueKey":"credit_note.customer.legal_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.customer.legal_number","typeLabel":"string | null"},"logo_url":{"oneOf":[{"type":"string","description":"The logo URL of the customer","example":"http://hooli.com/logo.png","isRequired":true,"uniqueKey":"credit_note.customer.logo_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The logo URL of the customer","example":"http://hooli.com/logo.png","isRequired":true,"uniqueKey":"credit_note.customer.logo_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.customer.logo_url","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"The full name of the customer","example":"Gavin Belson","isRequired":true,"uniqueKey":"credit_note.customer.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The full name of the customer","example":"Gavin Belson","isRequired":true,"uniqueKey":"credit_note.customer.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.customer.name","typeLabel":"string | null"},"firstname":{"oneOf":[{"type":"string","description":"First name of the customer","example":"Gavin","isRequired":true,"uniqueKey":"credit_note.customer.firstname.oneOf.0","typeLabel":"string"},{"type":"null","description":"First name of the customer","example":"Gavin","isRequired":true,"uniqueKey":"credit_note.customer.firstname.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.customer.firstname","typeLabel":"string | null"},"lastname":{"oneOf":[{"type":"string","description":"Last name of the customer","example":"Belson","isRequired":true,"uniqueKey":"credit_note.customer.lastname.oneOf.0","typeLabel":"string"},{"type":"null","description":"Last name of the customer","example":"Belson","isRequired":true,"uniqueKey":"credit_note.customer.lastname.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.customer.lastname","typeLabel":"string | null"},"account_type":{"type":"string","description":"The type of the account. It can have one of the following values:\n- `customer`: the account is a customer.\n- `partner`: the account is a partner.","enum":["customer","partner"],"example":"customer","isRequired":true,"uniqueKey":"credit_note.customer.account_type","typeLabel":"enum\u003cstring>"},"customer_type":{"oneOf":[{"type":"string","description":"The type of the customer. It can have one of the following values:\n- `company`: the customer is a company.\n- `individual`: the customer is an individual.","enum":["company","individual",null],"example":"company","isRequired":true,"uniqueKey":"credit_note.customer.customer_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The type of the customer. It can have one of the following values:\n- `company`: the customer is a company.\n- `individual`: the customer is an individual.","enum":["company","individual",null],"example":"company","isRequired":true,"uniqueKey":"credit_note.customer.customer_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.customer.customer_type","typeLabel":"enum\u003cstring> | null"},"phone":{"oneOf":[{"type":"string","description":"The phone number of the customer","example":"1-171-883-3711 x245","isRequired":true,"uniqueKey":"credit_note.customer.phone.oneOf.0","typeLabel":"string"},{"type":"null","description":"The phone number of the customer","example":"1-171-883-3711 x245","isRequired":true,"uniqueKey":"credit_note.customer.phone.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.customer.phone","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"The state of the customer's billing address","example":"CA","isRequired":true,"uniqueKey":"credit_note.customer.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"The state of the customer's billing address","example":"CA","isRequired":true,"uniqueKey":"credit_note.customer.state.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.customer.state","typeLabel":"string | null"},"tax_identification_number":{"oneOf":[{"type":"string","description":"The tax identification number of the customer","example":"EU123456789","isRequired":true,"uniqueKey":"credit_note.customer.tax_identification_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"The tax identification number of the customer","example":"EU123456789","isRequired":true,"uniqueKey":"credit_note.customer.tax_identification_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.customer.tax_identification_number","typeLabel":"string | null"},"timezone":{"oneOf":[{"type":"string","description":"The customer's timezone, used for billing purposes in their local time. Overrides the organization's timezone","enum":[null,"UTC","Africa/Algiers","Africa/Cairo","Africa/Casablanca","Africa/Harare","Africa/Johannesburg","Africa/Monrovia","Africa/Nairobi","America/Argentina/Buenos_Aires","America/Bogota","America/Caracas","America/Chicago","America/Chihuahua","America/Denver","America/Godthab","America/Guatemala","America/Guyana","America/Halifax","America/Indiana/Indianapolis","America/Juneau","America/La_Paz","America/Lima","America/Los_Angeles","America/Mazatlan","America/Mexico_City","America/Monterrey","America/Montevideo","America/New_York","America/Phoenix","America/Puerto_Rico","America/Regina","America/Santiago","America/Sao_Paulo","America/St_Johns","America/Tijuana","Asia/Almaty","Asia/Baghdad","Asia/Baku","Asia/Bangkok","Asia/Chongqing","Asia/Colombo","Asia/Dhaka","Asia/Hong_Kong","Asia/Irkutsk","Asia/Jakarta","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kathmandu","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuwait","Asia/Magadan","Asia/Muscat","Asia/Novosibirsk","Asia/Rangoon","Asia/Riyadh","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Tokyo","Asia/Ulaanbaatar","Asia/Urumqi","Asia/Vladivostok","Asia/Yakutsk","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Cape_Verde","Atlantic/South_Georgia","Australia/Adelaide","Australia/Brisbane","Australia/Darwin","Australia/Hobart","Australia/Melbourne","Australia/Perth","Australia/Sydney","Europe/Amsterdam","Europe/Athens","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Copenhagen","Europe/Dublin","Europe/Helsinki","Europe/Istanbul","Europe/Kaliningrad","Europe/Kiev","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Madrid","Europe/Minsk","Europe/Moscow","Europe/Paris","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/Sarajevo","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zurich","GMT+12","Pacific/Apia","Pacific/Auckland","Pacific/Chatham","Pacific/Fakaofo","Pacific/Fiji","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Majuro","Pacific/Midway","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Port_Moresby","Pacific/Tongatapu"],"example":"America/Los_Angeles","isRequired":true,"uniqueKey":"credit_note.customer.timezone.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The customer's timezone, used for billing purposes in their local time. Overrides the organization's timezone","enum":[null,"UTC","Africa/Algiers","Africa/Cairo","Africa/Casablanca","Africa/Harare","Africa/Johannesburg","Africa/Monrovia","Africa/Nairobi","America/Argentina/Buenos_Aires","America/Bogota","America/Caracas","America/Chicago","America/Chihuahua","America/Denver","America/Godthab","America/Guatemala","America/Guyana","America/Halifax","America/Indiana/Indianapolis","America/Juneau","America/La_Paz","America/Lima","America/Los_Angeles","America/Mazatlan","America/Mexico_City","America/Monterrey","America/Montevideo","America/New_York","America/Phoenix","America/Puerto_Rico","America/Regina","America/Santiago","America/Sao_Paulo","America/St_Johns","America/Tijuana","Asia/Almaty","Asia/Baghdad","Asia/Baku","Asia/Bangkok","Asia/Chongqing","Asia/Colombo","Asia/Dhaka","Asia/Hong_Kong","Asia/Irkutsk","Asia/Jakarta","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kathmandu","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuwait","Asia/Magadan","Asia/Muscat","Asia/Novosibirsk","Asia/Rangoon","Asia/Riyadh","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Tokyo","Asia/Ulaanbaatar","Asia/Urumqi","Asia/Vladivostok","Asia/Yakutsk","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Cape_Verde","Atlantic/South_Georgia","Australia/Adelaide","Australia/Brisbane","Australia/Darwin","Australia/Hobart","Australia/Melbourne","Australia/Perth","Australia/Sydney","Europe/Amsterdam","Europe/Athens","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Copenhagen","Europe/Dublin","Europe/Helsinki","Europe/Istanbul","Europe/Kaliningrad","Europe/Kiev","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Madrid","Europe/Minsk","Europe/Moscow","Europe/Paris","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/Sarajevo","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zurich","GMT+12","Pacific/Apia","Pacific/Auckland","Pacific/Chatham","Pacific/Fakaofo","Pacific/Fiji","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Majuro","Pacific/Midway","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Port_Moresby","Pacific/Tongatapu"],"example":"America/Los_Angeles","isRequired":true,"uniqueKey":"credit_note.customer.timezone.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.customer.timezone","typeLabel":"enum\u003cstring> | null"},"url":{"oneOf":[{"type":"string","description":"The custom website URL of the customer","example":"http://hooli.com","isRequired":true,"uniqueKey":"credit_note.customer.url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The custom website URL of the customer","example":"http://hooli.com","isRequired":true,"uniqueKey":"credit_note.customer.url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.customer.url","typeLabel":"string | null"},"zipcode":{"oneOf":[{"type":"string","description":"The zipcode of the customer's billing address","example":"91364","isRequired":true,"uniqueKey":"credit_note.customer.zipcode.oneOf.0","typeLabel":"string"},{"type":"null","description":"The zipcode of the customer's billing address","example":"91364","isRequired":true,"uniqueKey":"credit_note.customer.zipcode.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.customer.zipcode","typeLabel":"string | null"},"net_payment_term":{"oneOf":[{"type":"integer","description":"The net payment term, expressed in days, specifies the duration within which a customer is expected to remit payment after the invoice is finalized.","example":30,"isRequired":true,"uniqueKey":"credit_note.customer.net_payment_term.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The net payment term, expressed in days, specifies the duration within which a customer is expected to remit payment after the invoice is finalized.","example":30,"isRequired":true,"uniqueKey":"credit_note.customer.net_payment_term.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.customer.net_payment_term","typeLabel":"integer | null"},"external_salesforce_id":{"oneOf":[{"type":"string","description":"The customer ID within the Salesforce system","example":"0015p00001JQx1QAAT","isRequired":true,"uniqueKey":"credit_note.customer.external_salesforce_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer ID within the Salesforce system","example":"0015p00001JQx1QAAT","isRequired":true,"uniqueKey":"credit_note.customer.external_salesforce_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.customer.external_salesforce_id","typeLabel":"string | null"},"created_at":{"type":"string","description":"The date of the customer creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The creation_date provides a standardized and internationally recognized timestamp for when the customer object was created","format":"date-time","example":"2022-04-29T08:59:51Z","isRequired":true,"uniqueKey":"credit_note.customer.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","description":"The date of the customer update, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The update_date provides a standardized and internationally recognized timestamp for when the customer object was updated","format":"date-time","example":"2022-04-29T08:59:51Z","isRequired":true,"uniqueKey":"credit_note.customer.updated_at","typeLabel":"string\u003cdate-time>"},"finalize_zero_amount_invoice":{"type":"string","description":"Specifies how invoices with a zero total amount should be handled:\n- `inherit`: (Default) Follows the organization-level configuration.\n- `finalize`: Invoices are issued and finalized even if the total amount is zero.\n- `skip`: Invoices with a total amount of zero are not finalized.","enum":["inherit","skip","finalize"],"example":"inherit","isRequired":true,"uniqueKey":"credit_note.customer.finalize_zero_amount_invoice","typeLabel":"enum\u003cstring>"},"skip_invoice_custom_sections":{"type":"boolean","description":"Set to true to exclude all invoice custom sections from PDF generation for this customer only.","example":false,"isRequired":true,"uniqueKey":"credit_note.customer.skip_invoice_custom_sections","typeLabel":"boolean"},"billing_configuration":{"type":"object","description":"Configuration specific to the payment provider, utilized for billing the customer. This object contains settings and parameters necessary for processing payments and invoicing the customer.","properties":{"invoice_grace_period":{"oneOf":[{"type":"integer","description":"The grace period, expressed in days, for the invoice. This period refers to the additional time granted to the customer beyond the invoice due date to adjust usage and line items. It is null when the customer has no grace period of its own and falls back to the billing entity. This is a premium feature, the value is ignored without a premium license.","example":3,"uniqueKey":"credit_note.customer.billing_configuration.invoice_grace_period.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The grace period, expressed in days, for the invoice. This period refers to the additional time granted to the customer beyond the invoice due date to adjust usage and line items. It is null when the customer has no grace period of its own and falls back to the billing entity. This is a premium feature, the value is ignored without a premium license.","example":3,"uniqueKey":"credit_note.customer.billing_configuration.invoice_grace_period.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.customer.billing_configuration.invoice_grace_period","typeLabel":"integer | null"},"subscription_invoice_issuing_date_anchor":{"oneOf":[{"type":"string","description":"Defines whether the issuing date follows the current billing period's end date or the next period starting date.","default":null,"enum":["current_period_end","next_period_start",null],"example":"next_period_start","uniqueKey":"credit_note.customer.billing_configuration.subscription_invoice_issuing_date_anchor.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Defines whether the issuing date follows the current billing period's end date or the next period starting date.","default":null,"enum":["current_period_end","next_period_start",null],"example":"next_period_start","uniqueKey":"credit_note.customer.billing_configuration.subscription_invoice_issuing_date_anchor.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.customer.billing_configuration.subscription_invoice_issuing_date_anchor","typeLabel":"enum\u003cstring> | null"},"subscription_invoice_issuing_date_adjustment":{"oneOf":[{"type":"string","description":"The logic applied on top of the subscription_invoice_issuing_date_anchor rule. You can opt to use the invoice finalization date, that includes any configured grace period.","default":null,"enum":["align_with_finalization_date","keep_anchor",null],"example":"keep_anchor","uniqueKey":"credit_note.customer.billing_configuration.subscription_invoice_issuing_date_adjustment.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The logic applied on top of the subscription_invoice_issuing_date_anchor rule. You can opt to use the invoice finalization date, that includes any configured grace period.","default":null,"enum":["align_with_finalization_date","keep_anchor",null],"example":"keep_anchor","uniqueKey":"credit_note.customer.billing_configuration.subscription_invoice_issuing_date_adjustment.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.customer.billing_configuration.subscription_invoice_issuing_date_adjustment","typeLabel":"enum\u003cstring> | null"},"payment_provider":{"oneOf":[{"type":"string","description":"The payment provider utilized to initiate payments for invoices issued by Lago.\nAccepted values: `stripe`, `adyen`, `cashfree`, `flutterwave`, `gocardless`, `moneyhash` or null. This field is required if you intend to assign a `provider_customer_id`. Send null to detach the customer from its current payment provider.","enum":["stripe","adyen","cashfree","flutterwave","gocardless","moneyhash",null],"example":"stripe","uniqueKey":"credit_note.customer.billing_configuration.payment_provider.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The payment provider utilized to initiate payments for invoices issued by Lago.\nAccepted values: `stripe`, `adyen`, `cashfree`, `flutterwave`, `gocardless`, `moneyhash` or null. This field is required if you intend to assign a `provider_customer_id`. Send null to detach the customer from its current payment provider.","enum":["stripe","adyen","cashfree","flutterwave","gocardless","moneyhash",null],"example":"stripe","uniqueKey":"credit_note.customer.billing_configuration.payment_provider.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.customer.billing_configuration.payment_provider","typeLabel":"enum\u003cstring> | null"},"payment_provider_code":{"oneOf":[{"type":"string","description":"Unique code used to identify a payment provider connection.","example":"stripe-eu-1","uniqueKey":"credit_note.customer.billing_configuration.payment_provider_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique code used to identify a payment provider connection.","example":"stripe-eu-1","uniqueKey":"credit_note.customer.billing_configuration.payment_provider_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.customer.billing_configuration.payment_provider_code","typeLabel":"string | null"},"provider_customer_id":{"type":"string","description":"The customer ID within the payment provider's system. If this field is not provided, Lago has the option to create a new customer record within the payment provider's system on behalf of the customer","example":"cus_12345","uniqueKey":"credit_note.customer.billing_configuration.provider_customer_id","typeLabel":"string"},"sync":{"type":"boolean","description":"Set this field to `true` if you want to create the customer in the payment provider synchronously with the customer creation process in Lago. This option is applicable only when the `provider_customer_id` is `null` and the customer is automatically created in the payment provider through Lago. By default, the value is set to `false`","example":true,"uniqueKey":"credit_note.customer.billing_configuration.sync","typeLabel":"boolean"},"sync_with_provider":{"type":"boolean","description":"Set this field to `true` if you want to create a customer record in the payment provider's system. This option is applicable only when the `provider_customer_id` is null and the `sync_with_provider` field is set to `true`. By default, the value is set to `false`","example":true,"uniqueKey":"credit_note.customer.billing_configuration.sync_with_provider","typeLabel":"boolean"},"document_locale":{"oneOf":[{"type":"string","description":"The document locale, specified in the ISO 639-1 format. This field represents the language or locale used for the documents issued by Lago","example":"fr","uniqueKey":"credit_note.customer.billing_configuration.document_locale.oneOf.0","typeLabel":"string"},{"type":"null","description":"The document locale, specified in the ISO 639-1 format. This field represents the language or locale used for the documents issued by Lago","example":"fr","uniqueKey":"credit_note.customer.billing_configuration.document_locale.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.customer.billing_configuration.document_locale","typeLabel":"string | null"},"provider_payment_methods":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"credit_note.customer.billing_configuration.provider_payment_methods.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Specifies the available payment methods that can be used for this customer when `payment_provider` is set to `stripe`. The `provider_payment_methods` field is an array that allows multiple payment options to be defined. If this field is not explicitly set, the payment methods will be set to `card`. For now, possible values are `card`, `sepa_debit`, `us_bank_account`, `bacs_debit`, `boleto`, `link`, `crypto` and `customer_balance`. Note that when `link` is selected, `card` should also be provided in the array. When `customer_balance` is selected, no other payment can be selected.","example":["card","sepa_debit","us_bank_account","bacs_debit","link","boleto","crypto","customer_balance"],"uniqueKey":"credit_note.customer.billing_configuration.provider_payment_methods.oneOf.0","typeLabel":"string[]"},{"type":"null","description":"Specifies the available payment methods that can be used for this customer when `payment_provider` is set to `stripe`. The `provider_payment_methods` field is an array that allows multiple payment options to be defined. If this field is not explicitly set, the payment methods will be set to `card`. For now, possible values are `card`, `sepa_debit`, `us_bank_account`, `bacs_debit`, `boleto`, `link`, `crypto` and `customer_balance`. Note that when `link` is selected, `card` should also be provided in the array. When `customer_balance` is selected, no other payment can be selected.","example":["card","sepa_debit","us_bank_account","bacs_debit","link","boleto","crypto","customer_balance"],"uniqueKey":"credit_note.customer.billing_configuration.provider_payment_methods.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.customer.billing_configuration.provider_payment_methods","typeLabel":"string[] | null"}},"isRequired":true,"uniqueKey":"credit_note.customer.billing_configuration","typeLabel":"object"},"shipping_address":{"type":"object","description":"The shipping address of the customer.","properties":{"address_line1":{"oneOf":[{"type":"string","description":"The first line of the shipping address","example":"5230 Penfield Ave","uniqueKey":"credit_note.customer.shipping_address.address_line1.oneOf.0","typeLabel":"string"},{"type":"null","description":"The first line of the shipping address","example":"5230 Penfield Ave","uniqueKey":"credit_note.customer.shipping_address.address_line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.customer.shipping_address.address_line1","typeLabel":"string | null"},"address_line2":{"oneOf":[{"type":"string","description":"The second line of the shipping address","example":null,"uniqueKey":"credit_note.customer.shipping_address.address_line2.oneOf.0","typeLabel":"string"},{"type":"null","description":"The second line of the shipping address","example":null,"uniqueKey":"credit_note.customer.shipping_address.address_line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.customer.shipping_address.address_line2","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","description":"The city of the customer's shipping address","example":"Woodland Hills","uniqueKey":"credit_note.customer.shipping_address.city.oneOf.0","typeLabel":"string"},{"type":"null","description":"The city of the customer's shipping address","example":"Woodland Hills","uniqueKey":"credit_note.customer.shipping_address.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.customer.shipping_address.city","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"Country code of the customer's shipping address. Format must be ISO 3166 (alpha-2)","enum":[null,"AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"example":"US","uniqueKey":"credit_note.customer.shipping_address.country.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Country code of the customer's shipping address. Format must be ISO 3166 (alpha-2)","enum":[null,"AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"example":"US","uniqueKey":"credit_note.customer.shipping_address.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.customer.shipping_address.country","typeLabel":"enum\u003cstring> | null"},"state":{"oneOf":[{"type":"string","description":"The state of the customer's shipping address","example":"CA","uniqueKey":"credit_note.customer.shipping_address.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"The state of the customer's shipping address","example":"CA","uniqueKey":"credit_note.customer.shipping_address.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.customer.shipping_address.state","typeLabel":"string | null"},"zipcode":{"oneOf":[{"type":"string","description":"The zipcode of the customer's shipping address","example":"91364","uniqueKey":"credit_note.customer.shipping_address.zipcode.oneOf.0","typeLabel":"string"},{"type":"null","description":"The zipcode of the customer's shipping address","example":"91364","uniqueKey":"credit_note.customer.shipping_address.zipcode.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.customer.shipping_address.zipcode","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"credit_note.customer.shipping_address","typeLabel":"object"},"metadata":{"type":"array","items":{"type":"object","description":"Set of key-value pairs that you can attach to a customer. This can be useful for storing additional information about the customer in a structured format","required":["lago_id","key","value","display_in_invoice","created_at"],"properties":{"lago_id":{"type":"string","description":"A unique identifier for the customer metadata object in the Lago application. Can be used to update a key-value pair","format":"uuid","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","isRequired":true,"uniqueKey":"credit_note.customer.metadata.items.[INDEX].lago_id","typeLabel":"string\u003cuuid>"},"key":{"type":"string","description":"The metadata object key","example":"Purchase Order","isRequired":true,"uniqueKey":"credit_note.customer.metadata.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"The metadata object value","example":"123456789","isRequired":true,"uniqueKey":"credit_note.customer.metadata.items.[INDEX].value","typeLabel":"string"},"display_in_invoice":{"type":"boolean","description":"Determines whether the item or information should be displayed in the invoice. If set to true, the item or information will be included and visible in the generated invoice. If set to false, the item or information will be excluded and not displayed in the invoice.","example":true,"isRequired":true,"uniqueKey":"credit_note.customer.metadata.items.[INDEX].display_in_invoice","typeLabel":"boolean"},"created_at":{"type":"string","description":"The date of the metadata object creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The creation_date provides a standardized and internationally recognized timestamp for when the metadata object was created","format":"date-time","example":"2022-04-29T08:59:51Z","isRequired":true,"uniqueKey":"credit_note.customer.metadata.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"credit_note.customer.metadata.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"credit_note.customer.metadata","typeLabel":"object[]"},"integration_customers":{"type":"array","items":{"type":"object","description":"Configuration specific to the accounting and tax integrations. This object contains settings and parameters necessary for syncing documents and payments.","required":["lago_id","type","external_customer_id","integration_code","code","is_default","category"],"properties":{"lago_id":{"type":"string","description":"A unique identifier for the integration customer object in the Lago application.","format":"uuid","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","isRequired":true,"uniqueKey":"credit_note.customer.integration_customers.items.[INDEX].lago_id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"The integration type used for accounting, tax and CRM syncs.\nAccepted values: `netsuite`, `anrok`, `avalara`, `xero`, `hubspot`, `salesforce`.","enum":["netsuite","anrok","avalara","xero","hubspot","salesforce"],"example":"netsuite","isRequired":true,"uniqueKey":"credit_note.customer.integration_customers.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"integration_code":{"type":"string","description":"Unique code used to identify an integration connection.","example":"netsuite-eu-1","isRequired":true,"uniqueKey":"credit_note.customer.integration_customers.items.[INDEX].integration_code","typeLabel":"string"},"code":{"oneOf":[{"type":"string","description":"Unique code identifying this integration customer. It defaults to the code of the integration connection.","example":"netsuite-eu-1","isRequired":true,"uniqueKey":"credit_note.customer.integration_customers.items.[INDEX].code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique code identifying this integration customer. It defaults to the code of the integration connection.","example":"netsuite-eu-1","isRequired":true,"uniqueKey":"credit_note.customer.integration_customers.items.[INDEX].code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.customer.integration_customers.items.[INDEX].code","typeLabel":"string | null"},"is_default":{"type":"boolean","description":"Whether this integration customer is the default one of its category for the customer.","example":true,"isRequired":true,"uniqueKey":"credit_note.customer.integration_customers.items.[INDEX].is_default","typeLabel":"boolean"},"category":{"oneOf":[{"type":"string","description":"The category of the integration connection. It is derived from the integration type.\nAccepted values: `payment`, `tax`, `accounting`, `crm`.","enum":["payment","tax","accounting","crm",null],"example":"accounting","isRequired":true,"uniqueKey":"credit_note.customer.integration_customers.items.[INDEX].category.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The category of the integration connection. It is derived from the integration type.\nAccepted values: `payment`, `tax`, `accounting`, `crm`.","enum":["payment","tax","accounting","crm",null],"example":"accounting","isRequired":true,"uniqueKey":"credit_note.customer.integration_customers.items.[INDEX].category.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.customer.integration_customers.items.[INDEX].category","typeLabel":"enum\u003cstring> | null"},"external_customer_id":{"oneOf":[{"type":"string","description":"The customer ID within the integration's system. It is `null` when the customer has not been created in the integration's system yet.","example":"cus_12345","isRequired":true,"uniqueKey":"credit_note.customer.integration_customers.items.[INDEX].external_customer_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer ID within the integration's system. It is `null` when the customer has not been created in the integration's system yet.","example":"cus_12345","isRequired":true,"uniqueKey":"credit_note.customer.integration_customers.items.[INDEX].external_customer_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credit_note.customer.integration_customers.items.[INDEX].external_customer_id","typeLabel":"string | null"},"sync_with_provider":{"oneOf":[{"type":"boolean","description":"Set this field to `true` if you want to create a customer record in the integration's system. This option is applicable only when the `external_customer_id` is null and the `sync_with_provider` field is set to `true`. By default, the value is set to `false`","example":true,"uniqueKey":"credit_note.customer.integration_customers.items.[INDEX].sync_with_provider.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Set this field to `true` if you want to create a customer record in the integration's system. This option is applicable only when the `external_customer_id` is null and the `sync_with_provider` field is set to `true`. By default, the value is set to `false`","example":true,"uniqueKey":"credit_note.customer.integration_customers.items.[INDEX].sync_with_provider.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.customer.integration_customers.items.[INDEX].sync_with_provider","typeLabel":"boolean | null"},"subsidiary_id":{"type":"string","description":"This optional field is needed only when working with `netsuite` connection.","example":"2","uniqueKey":"credit_note.customer.integration_customers.items.[INDEX].subsidiary_id","typeLabel":"string"},"targeted_object":{"oneOf":[{"type":"string","description":"This optional field is present only when working with `hubspot` connection.","example":"contacts","uniqueKey":"credit_note.customer.integration_customers.items.[INDEX].targeted_object.oneOf.0","typeLabel":"string"},{"type":"null","description":"This optional field is present only when working with `hubspot` connection.","example":"contacts","uniqueKey":"credit_note.customer.integration_customers.items.[INDEX].targeted_object.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.customer.integration_customers.items.[INDEX].targeted_object","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","description":"This optional field is present only when working with `hubspot` connection.","example":"dinesh@piedpiper.example","uniqueKey":"credit_note.customer.integration_customers.items.[INDEX].email.oneOf.0","typeLabel":"string"},{"type":"null","description":"This optional field is present only when working with `hubspot` connection.","example":"dinesh@piedpiper.example","uniqueKey":"credit_note.customer.integration_customers.items.[INDEX].email.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.customer.integration_customers.items.[INDEX].email","typeLabel":"string | null"}},"uniqueKey":"credit_note.customer.integration_customers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"credit_note.customer.integration_customers","typeLabel":"object[]"}},"uniqueKey":"credit_note.customer","typeLabel":"object"},"metadata":{"oneOf":[{"type":"object","description":"Custom metadata stored as key-value pairs.\nKeys are strings (max 100 characters), values can be strings (max 255 characters) or null.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"credit_note.metadata.oneOf.0.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"credit_note.metadata.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.metadata.oneOf.0.additionalProperties","typeLabel":"string | null"},"example":{"external_id":"ext-123","synced_at":"2024-01-15","source":null},"uniqueKey":"credit_note.metadata.oneOf.0","typeLabel":"object"},{"type":"null","description":"Custom metadata stored as key-value pairs.\nKeys are strings (max 100 characters), values can be strings (max 255 characters) or null.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"credit_note.metadata.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"credit_note.metadata.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.metadata.oneOf.1.additionalProperties","typeLabel":"string | null"},"example":{"external_id":"ext-123","synced_at":"2024-01-15","source":null},"uniqueKey":"credit_note.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_note.metadata","typeLabel":"object | null"},"error_details":{"type":"array","description":"The errors raised while the credit note was issued. When the key is present it is always an array, empty when no error was raised.","items":{"type":"object","required":["lago_id","error_code","details"],"properties":{"lago_id":{"type":"string","format":"uuid","description":"The credit note error details unique identifier, created by Lago.","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","isRequired":true,"uniqueKey":"credit_note.error_details.items.[INDEX].lago_id","typeLabel":"string\u003cuuid>"},"error_code":{"type":"string","enum":["not_provided","tax_error","tax_voiding_error","invoice_generation_error"],"description":"The type of the error.","example":"tax_error","isRequired":true,"uniqueKey":"credit_note.error_details.items.[INDEX].error_code","typeLabel":"enum\u003cstring>"},"details":{"type":"object","description":"The details of the error.","isRequired":true,"uniqueKey":"credit_note.error_details.items.[INDEX].details","typeLabel":"object"}},"uniqueKey":"credit_note.error_details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"credit_note.error_details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"credit_note","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"credit_note":{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","billing_entity_code":"acme_corp","sequential_id":2,"number":"LAG-1234-CN2","lago_invoice_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","invoice_number":"LAG-1234","purchase_order_number":"PO-123","issuing_date":"2022-12-06","credit_status":"available","refund_status":"pending","reason":"other","description":"Free text","currency":"EUR","total_amount_cents":120,"precise_total_amount_cents":"120.0001","taxes_amount_cents":20,"precise_taxes_amount_cents":"20.0001","taxes_rate":20,"sub_total_excluding_taxes_amount_cents":100,"balance_amount_cents":100,"credit_amount_cents":100,"refund_amount_cents":0,"offset_amount_cents":0,"coupons_adjustment_amount_cents":20,"created_at":"2022-09-14T16:35:31Z","updated_at":"2022-09-14T16:35:31Z","file_url":"https://getlago.com/credit_note/file","xml_url":"https://getlago.com/credit_note/xml","self_billed":false,"items":[{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","amount_cents":100,"precise_amount_cents":"100.0001","amount_currency":"EUR","fee":{"amount_cents":100,"amount_currency":"EUR","taxes_amount_cents":20,"taxes_rate":20,"units":"0.32","precise_unit_amount":"312.5","total_aggregated_units":"0.32","total_amount_cents":120,"total_amount_currency":"EUR","pay_in_advance":true,"invoiceable":true,"payment_status":"pending","sub_total_excluding_taxes_amount_cents":100,"sub_total_excluding_taxes_precise_amount_cents":"100.0","item":{"type":"subscription","code":"startup","name":"Startup","description":"Startup","invoice_display_name":"Setup Fee (SF1)","filter_invoice_display_name":"AWS eu-east-1","filters":{},"lago_item_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","item_type":"Subscription","grouped_by":{}},"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","lago_charge_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","lago_charge_filter_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","lago_fixed_charge_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","lago_invoice_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","lago_true_up_fee_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","lago_true_up_parent_fee_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","lago_original_fee_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","lago_subscription_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","lago_customer_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","external_customer_id":"external_id","external_subscription_id":"external_id","precise_amount":"1.0001","precise_total_amount":"1.0212","taxes_precise_amount":"0.20123","events_count":23,"from_date":"2022-04-29T08:59:51Z","to_date":"2022-05-29T08:59:51Z","created_at":"2022-08-24T14:58:59Z","succeeded_at":"2022-08-24T14:58:59Z","failed_at":"2022-08-24T14:58:59Z","refunded_at":"2022-08-24T14:58:59Z","event_transaction_id":"transaction_1234567890","description":"Fee description","precise_coupons_amount_cents":"0.0","amount_details":{"plan_amount_cents":10000,"graduated_ranges":[{"units":"10.0","from_value":0,"to_value":10,"flat_unit_amount":"1.0","per_unit_amount":"1.0","per_unit_total_amount":"10.0","total_with_flat_amount":"11.0"}],"graduated_percentage_ranges":[{"units":"10.0","from_value":0,"to_value":10,"flat_unit_amount":"1.0","rate":"1.0","per_unit_total_amount":"10.0","total_with_flat_amount":"11.0"}],"free_units":"10.0","paid_units":"40.0","per_package_size":1000,"per_package_unit_amount":"0.5","per_unit_total_amount":"10.0","units":"20.0","free_events":10,"rate":"1.0","paid_events":20,"fixed_fee_unit_amount":"1.0","fixed_fee_total_amount":"20.0","min_max_adjustment_total_amount":"20.0","per_unit_amount":"0.5","flat_unit_amount":"10.0"},"self_billed":false,"applied_taxes":[{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","lago_tax_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","tax_name":"TVA","tax_code":"french_standard_vat","tax_rate":20,"tax_description":"French standard VAT","amount_cents":2000,"amount_currency":"USD","created_at":"2022-09-14T16:35:31Z","lago_fee_id":"1a901a90-1a90-1a90-1a90-1a901a901a90"}],"pricing_unit_details":{"lago_pricing_unit_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","pricing_unit_code":"credits","short_name":"CR","amount_cents":200,"precise_amount_cents":"200.0","unit_amount_cents":100,"precise_unit_amount":"100.0","conversion_rate":"0.5"},"presentation_breakdowns":[{"presentation_by":{},"units":"9.0"}]}}],"applied_taxes":[{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","lago_tax_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","tax_name":"TVA","tax_code":"french_standard_vat","tax_rate":20,"tax_description":"French standard VAT","amount_cents":2000,"amount_currency":"USD","created_at":"2022-09-14T16:35:31Z","lago_credit_note_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","base_amount_cents":100}],"customer":{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","sequential_id":1,"slug":"LAG-1234-001","external_id":"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba","billing_entity_code":"acme_corp","address_line1":"5230 Penfield Ave","address_line2":null,"applicable_timezone":"America/Los_Angeles","city":"Woodland Hills","country":"US","currency":"USD","email":"dinesh@piedpiper.example","legal_name":"Coleman-Blair","legal_number":"49-008-2965","logo_url":"http://hooli.com/logo.png","name":"Gavin Belson","firstname":"Gavin","lastname":"Belson","account_type":"customer","customer_type":"company","phone":"1-171-883-3711 x245","state":"CA","tax_identification_number":"EU123456789","timezone":"America/Los_Angeles","url":"http://hooli.com","zipcode":"91364","net_payment_term":30,"external_salesforce_id":"0015p00001JQx1QAAT","created_at":"2022-04-29T08:59:51Z","updated_at":"2022-04-29T08:59:51Z","finalize_zero_amount_invoice":"inherit","skip_invoice_custom_sections":false,"billing_configuration":{"invoice_grace_period":3,"subscription_invoice_issuing_date_anchor":"next_period_start","subscription_invoice_issuing_date_adjustment":"keep_anchor","payment_provider":"stripe","payment_provider_code":"stripe-eu-1","provider_customer_id":"cus_12345","sync":true,"sync_with_provider":true,"document_locale":"fr","provider_payment_methods":["card","sepa_debit","us_bank_account","bacs_debit","link","boleto","crypto","customer_balance"]},"shipping_address":{"address_line1":"5230 Penfield Ave","address_line2":null,"city":"Woodland Hills","country":"US","state":"CA","zipcode":"91364"},"metadata":[{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","key":"Purchase Order","value":"123456789","display_in_invoice":true,"created_at":"2022-04-29T08:59:51Z"}],"integration_customers":[{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","type":"netsuite","integration_code":"netsuite-eu-1","code":"netsuite-eu-1","is_default":true,"category":"accounting","external_customer_id":"cus_12345","sync_with_provider":true,"subsidiary_id":"2","targeted_object":"contacts","email":"dinesh@piedpiper.example"}]},"metadata":{"external_id":"ext-123","synced_at":"2024-01-15","source":null},"error_details":[{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","error_code":"tax_error","details":{}}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"96d7a4a6-46a5-46eb-a514-1073db6cbae8":{"description":"Bad Request error","content":{"application/json":{"schema":{"type":"object","required":["status","error"],"properties":{"status":{"type":"integer","format":"int32","example":400,"isRequired":true,"uniqueKey":"status","typeLabel":"integer\u003cint32>"},"error":{"type":"string","example":"Bad request","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":400,"error":"Bad request"}}},"exampleType":"generated"}},"exampleType":"generated"},"067742dd-2ae7-40ef-b990-1ab2361f97cb":{"description":"Unauthorized error","content":{"application/json":{"schema":{"type":"object","required":["status","error"],"properties":{"status":{"type":"integer","format":"int32","example":401,"isRequired":true,"uniqueKey":"status","typeLabel":"integer\u003cint32>"},"error":{"type":"string","example":"Unauthorized","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":401,"error":"Unauthorized"}}},"exampleType":"generated"}},"exampleType":"generated"},"be3e202b-e432-4577-bd4d-09bd40245d36":{"description":"Not Found error","content":{"application/json":{"schema":{"type":"object","required":["status","error","code"],"properties":{"status":{"type":"integer","format":"int32","example":404,"isRequired":true,"uniqueKey":"status","typeLabel":"integer\u003cint32>"},"error":{"type":"string","example":"Not Found","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","example":"object_not_found","isRequired":true,"uniqueKey":"code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":404,"error":"Not Found","code":"object_not_found"}}},"exampleType":"generated"}},"exampleType":"generated"},"49d67553-e1d6-416a-b508-2a137e8a07b1":{"description":"Unprocessable entity error","content":{"application/json":{"schema":{"type":"object","required":["status","error","code","error_details"],"properties":{"status":{"type":"integer","format":"int32","example":422,"isRequired":true,"uniqueKey":"status","typeLabel":"integer\u003cint32>"},"error":{"type":"string","example":"Unprocessable entity","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","example":"validation_errors","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"error_details":{"type":"object","isRequired":true,"uniqueKey":"error_details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":422,"error":"Unprocessable entity","code":"validation_errors","error_details":{}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"dfacd25f-1a82-4597-8d1f-85d526ac05d9":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"ab22d038-f0d2-40e8-a0fc-d85f6e51c13a":{"url":"https://api.getlago.com/api/v1","description":"US Lago cluster"},"73e77e8d-608b-424b-a1d5-dcecb28afce5":{"url":"https://api.eu.getlago.com/api/v1","description":"EU Lago cluster"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"https://swagger.getlago.com/openapi.yaml"},"subdomain":"lago-docs","siteName":"Lago","title":"Update a credit note - Lago","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-28T09:36:38.384Z","originalFileLocation":"api-reference/credit-notes/update.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"This endpoint updates an existing credit note.\">\u003cmeta data-mint-head name=\"keywords\" content=\"Lago API, billing API, usage metering API, OpenAPI, billing SDK, Lago MCP\">\u003cmeta data-mint-head name=\"application-name\" content=\"Lago\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/lago-docs/PXUAhcpsneOuo3Dn/_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=\"/docs/mintlify-assets/_mintlify/favicons/lago-docs/PXUAhcpsneOuo3Dn/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/lago-docs/PXUAhcpsneOuo3Dn/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/lago-docs/PXUAhcpsneOuo3Dn/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/lago-docs/PXUAhcpsneOuo3Dn/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/lago-docs/PXUAhcpsneOuo3Dn/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/lago-docs/PXUAhcpsneOuo3Dn/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/lago-docs/PXUAhcpsneOuo3Dn/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/lago-docs/PXUAhcpsneOuo3Dn/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update a credit note - Lago\">\u003cmeta data-mint-head property=\"og:description\" content=\"This endpoint updates an existing credit note.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Lago\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://getlago.com/docs/api-reference/credit-notes/update\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://lago-docs.mintlify.app/_mintlify/api/og/v2?division=Credit+notes\u0026amp;title=Update+a+credit+note\u0026amp;description=This+endpoint+updates+an+existing+credit+note.\u0026amp;theme=eb987f771609ccd12d360d11\u0026amp;signature=04600bbae90a6386ddf509daff05b9e2eaf16f2d9cc8fd4624281d2c12a35301\">\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=\"Update a credit note - Lago\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"This endpoint updates an existing credit note.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://lago-docs.mintlify.app/_mintlify/api/og/v2?division=Credit+notes\u0026amp;title=Update+a+credit+note\u0026amp;description=This+endpoint+updates+an+existing+credit+note.\u0026amp;theme=eb987f771609ccd12d360d11\u0026amp;signature=04600bbae90a6386ddf509daff05b9e2eaf16f2d9cc8fd4624281d2c12a35301\">\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=\"/docs/mintlify-assets/_mintlify/favicons/lago-docs/PXUAhcpsneOuo3Dn/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Lago\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#006CFA\">\u003clink data-mint-head rel=\"canonical\" href=\"https://getlago.com/docs/api-reference/credit-notes/update\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/credit-notes/update.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://getlago.com/#organization\",\"name\":\"Lago\",\"legalName\":\"Get Lago Corp.\",\"url\":\"https://getlago.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://getlago.com/docs/logo/light.svg\"},\"sameAs\":[\"https://github.com/getlago\",\"https://www.linkedin.com/company/getlago\",\"https://x.com/GetLago\",\"https://www.youtube.com/channel/UCp6ltp7n3SgDVsmerJ7O7ZA\"]},{\"@type\":\"WebSite\",\"@id\":\"https://getlago.com/docs#website\",\"name\":\"Lago\",\"url\":\"https://getlago.com/docs\",\"publisher\":{\"@id\":\"https://getlago.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://getlago.com/docs/api-reference/credit-notes/update#webpage\",\"url\":\"https://getlago.com/docs/api-reference/credit-notes/update\",\"name\":\"Update a credit note\",\"description\":\"This endpoint updates an existing credit note.\",\"dateModified\":\"2026-01-28T09:36:38.384Z\",\"isPartOf\":{\"@id\":\"https://getlago.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://getlago.com/docs/api-reference/credit-notes/update#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://getlago.com/docs/api-reference/credit-notes/update#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://getlago.com/docs/api-reference/intro\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Credit notes\",\"item\":\"https://getlago.com/docs/api-reference/credit-notes/credit-note-object\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update a credit note\",\"item\":\"https://getlago.com/docs/api-reference/credit-notes/update\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://getlago.com/docs/api-reference/credit-notes/update#apireference\",\"headline\":\"Update a credit note\",\"name\":\"Update a credit note\",\"description\":\"This endpoint updates an existing credit note.\",\"url\":\"https://getlago.com/docs/api-reference/credit-notes/update\",\"mainEntityOfPage\":{\"@id\":\"https://getlago.com/docs/api-reference/credit-notes/update#webpage\"},\"dateModified\":\"2026-01-28T09:36:38.384Z\",\"publisher\":{\"@id\":\"https://getlago.com/#organization\"},\"isPartOf\":{\"@id\":\"https://getlago.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Lago\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Lago","nav":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://getlago.com/blog"},{"anchor":"Community","icon":"slack","href":"https://getlago.com/slack"},{"anchor":"GitHub","icon":"github","href":"https://github.com/getlago/lago"},{"anchor":"Status","icon":"signal-bars","href":"https://status.getlago.com/"}]},"tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/welcome"}]},{"tab":"Guide","pages":[{"title":"Guide","href":"/guide/introduction/welcome-to-lago"}]},{"tab":"API References","groups":[{"group":"API Reference","pages":[{"group":"Getting started","pages":[{"title":"Introduction","href":"/api-reference/intro"},{"title":"API standards","href":"/api-reference/api-standards"},{"title":"API versioning and deprecation policy","href":"/api-reference/versioning"},{"title":"Errors","href":"/api-reference/errors"},{"title":"Pagination","href":"/api-reference/pagination"},{"title":"Rate limits","href":"/api-reference/rate-limits"}]},{"group":"Add-ons","pages":[{"title":"The add-on object","href":"/api-reference/add-ons/add-on-object"},{"openapi":"POST /add_ons","title":"Create an add-on","href":"/api-reference/add-ons/create"},{"openapi":"PUT /add_ons/{code}","title":"Update an add-on","href":"/api-reference/add-ons/update"},{"openapi":"DELETE /add_ons/{code}","title":"Delete an add-on","href":"/api-reference/add-ons/destroy"},{"openapi":"GET /add_ons/{code}","title":"Retrieve an add-on","href":"/api-reference/add-ons/get-specific"},{"openapi":"GET /add_ons","title":"List all add-ons","href":"/api-reference/add-ons/get-all"}]},{"group":"Alerts","pages":[{"title":"The alert object","href":"/api-reference/alerts/alert-object"},{"openapi":"POST /subscriptions/{external_id}/alerts","title":"Create an alert","href":"/api-reference/alerts/create"},{"openapi":"PUT /subscriptions/{external_id}/alerts/{code}","title":"Update an alert","href":"/api-reference/alerts/update"},{"openapi":"DELETE /subscriptions/{external_id}/alerts/{code}","title":"Delete an alert","href":"/api-reference/alerts/delete"},{"openapi":"GET /subscriptions/{external_id}/alerts/{code}","title":"Retrieve an alert","href":"/api-reference/alerts/get-specific"},{"openapi":"GET /subscriptions/{external_id}/alerts","title":"List all alerts","href":"/api-reference/alerts/get-all"}]},{"group":"Audit logs","pages":[{"title":"The activity log object","href":"/api-reference/audit-logs/activity-logs-object"},{"openapi":"GET /activity_logs","title":"List all activity logs","href":"/api-reference/audit-logs/get-all-activity-logs"},{"openapi":"GET /activity_logs/{activity_id}","title":"Retrieve an activity log","href":"/api-reference/audit-logs/get-specific-activity-log"},{"title":"The API log object","href":"/api-reference/audit-logs/api-logs-object"},{"openapi":"GET /api_logs","title":"List all API logs","href":"/api-reference/audit-logs/get-all-api-logs"},{"openapi":"GET /api_logs/{request_id}","title":"Retrieve an API log","href":"/api-reference/audit-logs/get-specific-api-log"}]},{"group":"Billable metrics","pages":[{"title":"The billable metric object","href":"/api-reference/billable-metrics/object"},{"title":"Create a billable metric","openapi":"POST /billable_metrics","href":"/api-reference/billable-metrics/create"},{"title":"Update a billable metric","openapi":"PUT /billable_metrics/{code}","href":"/api-reference/billable-metrics/update"},{"openapi":"DELETE /billable_metrics/{code}","title":"Delete a billable metric","href":"/api-reference/billable-metrics/destroy"},{"openapi":"GET /billable_metrics/{code}","title":"Retrieve a billable metric","href":"/api-reference/billable-metrics/get-specific"},{"openapi":"GET /billable_metrics","title":"List all billable metrics","href":"/api-reference/billable-metrics/get-all"}]},{"group":"Billing entities","pages":[{"title":"The billing entity object","href":"/api-reference/billing-entities/object"},{"title":"Create a billing entity","openapi":"POST /billing_entities","href":"/api-reference/billing-entities/create"},{"title":"Update a billing entity","openapi":"PUT /billing_entities/{code}","href":"/api-reference/billing-entities/update"},{"title":"Retrieve a billing entity","openapi":"GET /billing_entities/{code}","href":"/api-reference/billing-entities/get-specific"},{"title":"List all billing entities","openapi":"GET /billing_entities","href":"/api-reference/billing-entities/get-all"}]},{"group":"Coupons","pages":[{"title":"The coupon object","href":"/api-reference/coupons/coupon-object"},{"openapi":"POST /coupons","title":"Create a coupon","href":"/api-reference/coupons/create"},{"openapi":"PUT /coupons/{code}","title":"Update a coupon","href":"/api-reference/coupons/update"},{"openapi":"DELETE /coupons/{code}","title":"Delete a coupon","href":"/api-reference/coupons/destroy"},{"openapi":"GET /coupons/{code}","title":"Retrieve a coupon","href":"/api-reference/coupons/get-specific"},{"openapi":"GET /coupons","title":"List all coupons","href":"/api-reference/coupons/get-all"},{"title":"The applied coupon object","href":"/api-reference/coupons/applied-coupon-object"},{"openapi":"POST /applied_coupons","title":"Apply a coupon","href":"/api-reference/coupons/apply"},{"openapi":"DELETE /customers/{external_customer_id}/applied_coupons/{applied_coupon_id}","title":"Delete an applied coupon","href":"/api-reference/coupons/destroy-applied-coupon"},{"openapi":"GET /applied_coupons","title":"List all applied coupons","href":"/api-reference/coupons/get-all-applied"}]},{"group":"Credit notes","pages":[{"title":"The credit note object","href":"/api-reference/credit-notes/credit-note-object"},{"openapi":"POST /credit_notes/estimate","title":"Estimate a credit note","href":"/api-reference/credit-notes/estimate"},{"openapi":"POST /credit_notes","title":"Create a credit note","href":"/api-reference/credit-notes/create"},{"openapi":"POST /credit_notes/{lago_id}/download","title":"Download a credit note","description":"This endpoint downloads the PDF of an existing credit note. Only `finalized` credit notes can be downloaded; any other credit note returns a `404` error.\nWhen the PDF has already been generated, the credit note object is returned and its `file_url` points to the document. When it has not been generated yet, the response is a `200` with an empty body and the generation starts in the background. Call the endpoint again to get the credit note object with its `file_url`.","href":"/api-reference/credit-notes/download"},{"openapi":"PUT /credit_notes/{lago_id}","title":"Update a credit note","href":"/api-reference/credit-notes/update"},{"openapi":"PUT /credit_notes/{lago_id}/void","title":"Void available credit","description":"This endpoint voids the available credit linked to a specific credit note.","href":"/api-reference/credit-notes/void"},{"openapi":"GET /credit_notes/{lago_id}","title":"Retrieve a credit note","href":"/api-reference/credit-notes/get-specific"},{"openapi":"GET /credit_notes","title":"List all credit notes","href":"/api-reference/credit-notes/get-all"},{"group":"Metadata","pages":[{"openapi":"POST /credit_notes/{lago_id}/metadata","title":"Replace all metadata","href":"/api-reference/credit-notes/metadata/create-metadata-cn"},{"openapi":"PATCH /credit_notes/{lago_id}/metadata","title":"Update metadata","href":"/api-reference/credit-notes/metadata/update-metadata-cn"},{"openapi":"DELETE /credit_notes/{lago_id}/metadata/{key}","title":"Delete a metadata","href":"/api-reference/credit-notes/metadata/delete-a-metadata-cn"},{"openapi":"DELETE /credit_notes/{lago_id}/metadata","title":"Delete all metadata","href":"/api-reference/credit-notes/metadata/delete-all-metadata-cn"}]}]},{"group":"Customer usage","pages":[{"title":"The customer usage object","href":"/api-reference/customer-usage/customer-usage-object"},{"openapi":"GET /analytics/usage","title":"Retrieve usages","href":"/api-reference/customer-usage/usages"},{"openapi":"GET /customers/{external_customer_id}/current_usage","title":"Retrieve current usage","href":"/api-reference/customer-usage/get-current"},{"openapi":"GET /customers/{external_customer_id}/projected_usage","title":"Retrieve projected usage","href":"/api-reference/customer-usage/get-projected"},{"openapi":"GET /customers/{external_customer_id}/past_usage","title":"Retrieve past usage","href":"/api-reference/customer-usage/get-past"}]},{"group":"Customers","pages":[{"title":"The customer object","href":"/api-reference/customers/object"},{"openapi":"POST /customers","title":"Create a customer","href":"/api-reference/customers/create"},{"openapi":"POST /customers","title":"Update a customer","href":"/api-reference/customers/update"},{"openapi":"POST /customers/{external_customer_id}/checkout_url","title":"Regenerate checkout URL","href":"/api-reference/customers/psp-checkout-url"},{"openapi":"DELETE /customers/{external_customer_id}","title":"Delete a customer","href":"/api-reference/customers/delete"},{"openapi":"GET /customers/{external_customer_id}","title":"Retrieve a customer","href":"/api-reference/customers/get-specific"},{"openapi":"GET /customers","title":"List all customers","href":"/api-reference/customers/get-all"},{"openapi":"GET /customers/{external_customer_id}/portal_url","title":"Retrieve customer portal URL","href":"/api-reference/customers/customer-portal"}]},{"group":"Entitlements","pages":[{"title":"The feature object","href":"/api-reference/entitlements/features/feature-object"},{"openapi":"POST /features","title":"Create a feature","href":"/api-reference/entitlements/features/create-feature"},{"openapi":"PUT /features/{code}","title":"Update a feature","href":"/api-reference/entitlements/features/update-feature"},{"openapi":"DELETE /features/{code}","title":"Delete a feature","href":"/api-reference/entitlements/features/delete-feature"},{"openapi":"DELETE /features/{code}/privileges/{privilege_code}","title":"Delete a feature privilege","href":"/api-reference/entitlements/features/delete-privilege"},{"openapi":"GET /features/{code}","title":"Retrieve a feature","href":"/api-reference/entitlements/features/get-feature"},{"openapi":"GET /features","title":"List all features","href":"/api-reference/entitlements/features/get-all-features"},{"title":"The plan entitlement object","href":"/api-reference/entitlements/plan-entitlements/plan-entitlement-object"},{"openapi":"POST /plans/{code}/entitlements","title":"Create plan entitlements","href":"/api-reference/entitlements/plan-entitlements/create-plan-entitlement"},{"openapi":"PATCH /plans/{code}/entitlements","title":"Update plan entitlements","href":"/api-reference/entitlements/plan-entitlements/update-plan-entitlement"},{"openapi":"DELETE /plans/{code}/entitlements/{feature_code}","title":"Delete a plan entitlement","href":"/api-reference/entitlements/plan-entitlements/delete-plan-entitlement"},{"openapi":"DELETE /plans/{code}/entitlements/{feature_code}/privileges/{privilege_code}","title":"Delete a plan entitlement privilege","href":"/api-reference/entitlements/plan-entitlements/delete-plan-entitlement-privilege"},{"openapi":"GET /plans/{code}/entitlements/{feature_code}","title":"Retrieve a plan entitlement","href":"/api-reference/entitlements/plan-entitlements/get-specific-plan-entitlement"},{"openapi":"GET /plans/{code}/entitlements","title":"List plan entitlements","href":"/api-reference/entitlements/plan-entitlements/get-all-plan-entitlements"},{"title":"The subscription entitlement object","href":"/api-reference/entitlements/subscription-entitlements/subscription-entitlement-object"},{"openapi":"PATCH /subscriptions/{external_id}/entitlements","title":"Update subscription entitlements","href":"/api-reference/entitlements/subscription-entitlements/update-subscription-entitlement"},{"openapi":"DELETE /subscriptions/{external_id}/entitlements/{feature_code}","title":"Delete a subscription entitlement","href":"/api-reference/entitlements/subscription-entitlements/delete-subscription-entitlement"},{"openapi":"DELETE /subscriptions/{external_id}/entitlements/{feature_code}/privileges/{privilege_code}","title":"Delete a subscription entitlement privilege","href":"/api-reference/entitlements/subscription-entitlements/delete-subscription-entitlement-privilege"},{"openapi":"GET /subscriptions/{external_id}/entitlements","title":"List subscription entitlements","href":"/api-reference/entitlements/subscription-entitlements/get-all-subscription-entitlements"}]},{"group":"Events","pages":[{"title":"The event object","href":"/api-reference/events/event-object"},{"openapi":"POST /events","title":"Send usage event","href":"/api-reference/events/usage"},{"openapi":"POST /events/batch","title":"Batch usage events","href":"/api-reference/events/batch"},{"openapi":"POST /events/estimate_fees","title":"Estimate an upcoming fee","href":"/api-reference/events/estimated-fee"},{"openapi":"GET /events/{transaction_id}","title":"Retrieve an event","href":"/api-reference/events/get-specific"},{"openapi":"GET /events","title":"List all events","href":"/api-reference/events/list-events"}]},{"group":"Fees","pages":[{"title":"The fee object","href":"/api-reference/fees/fee-object"},{"openapi":"PUT /fees/{lago_id}","title":"Update a fee","href":"/api-reference/fees/update-fee"},{"openapi":"DELETE /fees/{lago_id}","title":"Delete a fee","href":"/api-reference/fees/destroy-fee"},{"openapi":"GET /fees/{lago_id}","title":"Retrieve a fee","href":"/api-reference/fees/retrieve-fee"},{"openapi":"GET /fees","title":"List all fees","href":"/api-reference/fees/list-fees"}]},{"group":"Invoices","pages":[{"title":"The invoice object","href":"/api-reference/invoices/invoice-object"},{"openapi":"POST /invoices","title":"Create a one-off invoice","href":"/api-reference/invoices/create-oneoff"},{"openapi":"POST /invoices/preview","title":"Preview an invoice","href":"/api-reference/invoices/preview"},{"openapi":"POST /invoices/{lago_id}/download","title":"Download an invoice","href":"/api-reference/invoices/download"},{"openapi":"POST /invoices/{lago_id}/void","title":"Void an invoice","href":"/api-reference/invoices/void"},{"openapi":"POST /invoices/{lago_id}/retry","title":"Retry an invoice finalization","href":"/api-reference/invoices/retry_finalization"},{"openapi":"POST /invoices/{lago_id}/retry_payment","title":"Retry an invoice payment","href":"/api-reference/invoices/retry"},{"openapi":"POST /invoices/{lago_id}/payment_url","title":"Generate a payment URL","href":"/api-reference/invoices/payment-url"},{"openapi":"PUT /invoices/{lago_id}/refresh","title":"Refresh an invoice","href":"/api-reference/invoices/refresh"},{"openapi":"PUT /invoices/{lago_id}/finalize","title":"Finalize an invoice","href":"/api-reference/invoices/finalize"},{"openapi":"PUT /invoices/{lago_id}","title":"Update an invoice","href":"/api-reference/invoices/update"},{"openapi":"GET /invoices/{lago_id}","title":"Retrieve an invoice","href":"/api-reference/invoices/get-specific"},{"openapi":"GET /invoices","title":"List all invoices","href":"/api-reference/invoices/get-all"}]},{"group":"Organizations","pages":[{"title":"The organization object","href":"/api-reference/organizations/organization-object"},{"openapi":"PUT /organizations","title":"Update organization (deprecated)","href":"/api-reference/organizations/update"}]},{"group":"Payments","pages":[{"title":"The payment object","href":"/api-reference/payments/payment-object"},{"title":"Create a payment","openapi":"POST /payments","href":"/api-reference/payments/create"},{"title":"Retrieve a payment","openapi":"GET /payments/{lago_id}","href":"/api-reference/payments/get-specific"},{"title":"List all payments","openapi":"GET /payments","href":"/api-reference/payments/get-all"}]},{"group":"Payment methods","pages":[{"title":"The payment method object","href":"/api-reference/payment-methods/payment-method-object"},{"openapi":"PUT /customers/{external_customer_id}/payment_methods/{lago_id}/set_as_default","title":"Update a payment method","href":"/api-reference/payment-methods/update"},{"openapi":"DELETE /customers/{external_customer_id}/payment_methods/{lago_id}","title":"Delete a payment method from a customer","href":"/api-reference/payment-methods/delete"},{"openapi":"GET /customers/{external_customer_id}/payment_methods","title":"List all payment methods for a customer","href":"/api-reference/payment-methods/get-all"}]},{"group":"Payment receipts","pages":[{"title":"The payment receipt object","href":"/api-reference/payment-receipts/payment-receipt-object"},{"openapi":"GET /payment_receipts/{lago_id}","title":"Retrieve a payment receipt","href":"/api-reference/payment-receipts/get-specific"},{"openapi":"GET /payment_receipts","title":"List all payment receipts","href":"/api-reference/payment-receipts/get-all"}]},{"group":"Payment requests","pages":[{"title":"The payment request object","href":"/api-reference/payment-requests/payment-request-object"},{"title":"Create a payment request","openapi":"POST /payment_requests","href":"/api-reference/payment-requests/create"},{"title":"List all payment requests","openapi":"GET /payment_requests","href":"/api-reference/payment-requests/get-all"}]},{"group":"Plans","pages":[{"title":"The plan object","href":"/api-reference/plans/object"},{"title":"Create a plan","openapi":"POST /plans","href":"/api-reference/plans/create"},{"title":"Update a plan","openapi":"PUT /plans/{code}","href":"/api-reference/plans/update"},{"openapi":"DELETE /plans/{code}","title":"Delete a plan","href":"/api-reference/plans/destroy"},{"openapi":"GET /plans/{code}","title":"Retrieve a plan","href":"/api-reference/plans/get-specific"},{"openapi":"GET /plans","title":"List all plans","href":"/api-reference/plans/get-all-plans"},{"group":"Charges","pages":[{"title":"The charge object","href":"/api-reference/plans/charges/object"},{"title":"Create a charge","openapi":"POST /plans/{code}/charges","href":"/api-reference/plans/charges/create"},{"title":"Update a charge","openapi":"PUT /plans/{code}/charges/{charge_code}","href":"/api-reference/plans/charges/update"},{"title":"Delete a charge","openapi":"DELETE /plans/{code}/charges/{charge_code}","href":"/api-reference/plans/charges/destroy"},{"title":"Retrieve a charge","openapi":"GET /plans/{code}/charges/{charge_code}","href":"/api-reference/plans/charges/get-specific"},{"title":"List all charges","openapi":"GET /plans/{code}/charges","href":"/api-reference/plans/charges/get-all"},{"group":"Filters","pages":[{"title":"The charge filter object","href":"/api-reference/plans/charges/filters/object"},{"title":"Create a charge filter","openapi":"POST /plans/{code}/charges/{charge_code}/filters","href":"/api-reference/plans/charges/filters/create"},{"title":"Update a charge filter","openapi":"PUT /plans/{code}/charges/{charge_code}/filters/{filter_id}","href":"/api-reference/plans/charges/filters/update"},{"title":"Delete a charge filter","openapi":"DELETE /plans/{code}/charges/{charge_code}/filters/{filter_id}","href":"/api-reference/plans/charges/filters/destroy"},{"title":"Retrieve a charge filter","openapi":"GET /plans/{code}/charges/{charge_code}/filters/{filter_id}","href":"/api-reference/plans/charges/filters/get-specific"},{"title":"List all charge filters","openapi":"GET /plans/{code}/charges/{charge_code}/filters","href":"/api-reference/plans/charges/filters/get-all"}]}]},{"group":"Fixed Charges","pages":[{"title":"The fixed charge object","href":"/api-reference/plans/fixed-charges/object"},{"title":"Create a fixed charge","openapi":"POST /plans/{code}/fixed_charges","href":"/api-reference/plans/fixed-charges/create"},{"title":"Update a fixed charge","openapi":"PUT /plans/{code}/fixed_charges/{fixed_charge_code}","href":"/api-reference/plans/fixed-charges/update"},{"title":"Delete a fixed charge","openapi":"DELETE /plans/{code}/fixed_charges/{fixed_charge_code}","href":"/api-reference/plans/fixed-charges/destroy"},{"title":"Retrieve a fixed charge","openapi":"GET /plans/{code}/fixed_charges/{fixed_charge_code}","href":"/api-reference/plans/fixed-charges/get-specific"},{"title":"List all fixed charges","openapi":"GET /plans/{code}/fixed_charges","href":"/api-reference/plans/fixed-charges/get-all"}]}]},{"group":"Quotes \u0026 Order forms","pages":[{"group":"Quotes","pages":[{"title":"The quote object","href":"/api-reference/quotes/quote-object"},{"title":"The quote version object","href":"/api-reference/quotes/quote-version-object"},{"openapi":"POST /quote_versions/{lago_id}/approve","title":"Approve a quote version","href":"/api-reference/quotes/approve-version"},{"openapi":"POST /quote_versions/{lago_id}/void","title":"Void a quote version","href":"/api-reference/quotes/void-version"},{"openapi":"POST /quote_versions/{lago_id}/clone","title":"Clone a quote version","href":"/api-reference/quotes/clone-version"},{"openapi":"GET /quotes/{lago_id}","title":"Retrieve a quote","href":"/api-reference/quotes/get-specific"},{"openapi":"GET /quotes","title":"List all quotes","href":"/api-reference/quotes/get-all"},{"openapi":"GET /quote_versions/{lago_id}","title":"Retrieve a quote version","href":"/api-reference/quotes/get-specific-version"},{"openapi":"GET /quotes/{lago_id}/versions","title":"List all versions of a quote","href":"/api-reference/quotes/get-all-versions"}]},{"group":"Order forms","pages":[{"title":"The order form object","href":"/api-reference/quotes/order-forms/order-form-object"},{"openapi":"POST /order_forms/{lago_id}/mark_as_signed","title":"Mark an order form as signed","href":"/api-reference/quotes/order-forms/mark-as-signed"},{"openapi":"POST /order_forms/{lago_id}/void","title":"Void an order form","href":"/api-reference/quotes/order-forms/void"},{"openapi":"GET /order_forms/{lago_id}","title":"Retrieve an order form","href":"/api-reference/quotes/order-forms/get-specific"},{"openapi":"GET /order_forms","title":"List all order forms","href":"/api-reference/quotes/order-forms/get-all"}]},{"group":"Orders","pages":[{"title":"The order object","href":"/api-reference/quotes/orders/order-object"},{"openapi":"POST /orders/{lago_id}/execute","title":"Execute an order","href":"/api-reference/quotes/orders/execute"},{"openapi":"GET /orders/{lago_id}","title":"Retrieve an order","href":"/api-reference/quotes/orders/get-specific"},{"openapi":"GET /orders","title":"List all orders","href":"/api-reference/quotes/orders/get-all"}]}]},{"group":"Resources","pages":[{"title":"Currencies","href":"/api-reference/resources/currencies"},{"title":"Timezones","href":"/api-reference/resources/timezones"},{"title":"Document locales","href":"/api-reference/resources/locales"}]},{"group":"Subscriptions","pages":[{"title":"The subscription object","href":"/api-reference/subscriptions/subscription-object"},{"title":"Create a subscription","openapi":"POST /subscriptions","href":"/api-reference/subscriptions/assign-plan"},{"title":"Update a subscription","openapi":"PUT /subscriptions/{external_id}","href":"/api-reference/subscriptions/update"},{"title":"Terminate a subscription","openapi":"DELETE /subscriptions/{external_id}","href":"/api-reference/subscriptions/terminate"},{"title":"Retrieve a subscription","openapi":"GET /subscriptions/{external_id}","href":"/api-reference/subscriptions/get-specific"},{"title":"List all subscriptions","openapi":"GET /subscriptions","href":"/api-reference/subscriptions/get-all"},{"group":"Lifetime Usage","pages":[{"title":"The lifetime usage object","href":"/api-reference/subscriptions/lifetime-usage-object"},{"title":"Update subscription lifetime usage","openapi":"PUT /subscriptions/{external_id}/lifetime_usage","href":"/api-reference/subscriptions/update-lifetime-usage"},{"title":"Retrieve subscription lifetime usage","openapi":"GET /subscriptions/{external_id}/lifetime_usage","href":"/api-reference/subscriptions/get-lifetime-usage"}]},{"group":"Charges","pages":[{"title":"The charge object","href":"/api-reference/subscriptions/charges/object"},{"title":"Update a charge","openapi":"PUT /subscriptions/{external_id}/charges/{charge_code}","href":"/api-reference/subscriptions/charges/update"},{"title":"Retrieve a charge","openapi":"GET /subscriptions/{external_id}/charges/{charge_code}","href":"/api-reference/subscriptions/charges/get-specific"},{"title":"List all charges","openapi":"GET /subscriptions/{external_id}/charges","href":"/api-reference/subscriptions/charges/get-all"},{"group":"Filters","pages":[{"title":"The charge filter object","href":"/api-reference/subscriptions/charges/filters/object"},{"title":"Create a charge filter","openapi":"POST /subscriptions/{external_id}/charges/{charge_code}/filters","href":"/api-reference/subscriptions/charges/filters/create"},{"title":"Update a charge filter","openapi":"PUT /subscriptions/{external_id}/charges/{charge_code}/filters/{filter_id}","href":"/api-reference/subscriptions/charges/filters/update"},{"title":"Delete a charge filter","openapi":"DELETE /subscriptions/{external_id}/charges/{charge_code}/filters/{filter_id}","href":"/api-reference/subscriptions/charges/filters/destroy"},{"title":"Retrieve a charge filter","openapi":"GET /subscriptions/{external_id}/charges/{charge_code}/filters/{filter_id}","href":"/api-reference/subscriptions/charges/filters/get-specific"},{"title":"List all charge filters","openapi":"GET /subscriptions/{external_id}/charges/{charge_code}/filters","href":"/api-reference/subscriptions/charges/filters/get-all"}]}]},{"group":"Fixed Charges","pages":[{"title":"The fixed charge object","href":"/api-reference/subscriptions/fixed-charges/object"},{"title":"Update a fixed charge","openapi":"PUT /subscriptions/{external_id}/fixed_charges/{fixed_charge_code}","href":"/api-reference/subscriptions/fixed-charges/update"},{"title":"Retrieve a fixed charge","openapi":"GET /subscriptions/{external_id}/fixed_charges/{fixed_charge_code}","href":"/api-reference/subscriptions/fixed-charges/get-specific"},{"title":"List all fixed charges","openapi":"GET /subscriptions/{external_id}/fixed_charges","href":"/api-reference/subscriptions/fixed-charges/get-all"}]}]},{"group":"Taxes","pages":[{"title":"The tax object","href":"/api-reference/taxes/tax-object"},{"openapi":"POST /taxes","title":"Create a tax rate","href":"/api-reference/taxes/create"},{"openapi":"PUT /taxes/{code}","title":"Update a tax rate","href":"/api-reference/taxes/update"},{"openapi":"DELETE /taxes/{code}","title":"Delete a tax rate","href":"/api-reference/taxes/destroy"},{"openapi":"GET /taxes/{code}","title":"Retrieve a tax rate","href":"/api-reference/taxes/get-specific"},{"openapi":"GET /taxes","title":"List all tax rates","href":"/api-reference/taxes/get-all"}]},{"group":"Wallets","pages":[{"title":"The wallet object","href":"/api-reference/wallets/wallet-object"},{"openapi":"POST /wallets","title":"Create a wallet","href":"/api-reference/wallets/create"},{"openapi":"PUT /wallets/{lago_id}","title":"Update a wallet","href":"/api-reference/wallets/update"},{"openapi":"DELETE /wallets/{lago_id}","title":"Terminate a wallet","href":"/api-reference/wallets/terminate"},{"openapi":"GET /wallets/{lago_id}","title":"Retrieve a wallet","href":"/api-reference/wallets/get-specific"},{"openapi":"GET /wallets","title":"List all wallets","href":"/api-reference/wallets/get-all"},{"group":"Wallets by code","pages":[{"openapi":"POST /customers/{external_customer_id}/wallets","title":"Create a wallet for a customer","href":"/api-reference/wallets/create-for-customer"},{"openapi":"PUT /customers/{external_customer_id}/wallets/{code}","title":"Update a wallet by code","href":"/api-reference/wallets/update-by-code"},{"openapi":"DELETE /customers/{external_customer_id}/wallets/{code}","title":"Terminate a wallet by code","href":"/api-reference/wallets/terminate-by-code"},{"openapi":"GET /customers/{external_customer_id}/wallets/{code}","title":"Retrieve a wallet by code","href":"/api-reference/wallets/get-specific-by-code"},{"openapi":"GET /customers/{external_customer_id}/wallets","title":"List all wallets for a customer","href":"/api-reference/wallets/get-all-for-customer"}]},{"group":"Wallet transactions","pages":[{"title":"The wallet transaction object","href":"/api-reference/wallets/wallet-transaction-object"},{"openapi":"POST /wallet_transactions","title":"Top-up a wallet","href":"/api-reference/wallets/top-up"},{"openapi":"POST /wallet_transactions/{lago_id}/payment_url","title":"Generate a payment URL","href":"/api-reference/wallets/wallet-transaction-payment-url"},{"openapi":"GET /wallet_transactions/{lago_id}","title":"Retrieve a transaction","href":"/api-reference/wallets/get-specific-transaction"},{"openapi":"GET /wallets/{lago_id}/wallet_transactions","title":"List all wallet transactions","href":"/api-reference/wallets/get-all-transactions"},{"openapi":"GET /wallet_transactions/{lago_id}/consumptions","title":"List all consumptions for a wallet transaction","href":"/api-reference/wallets/get-all-consumptions"},{"openapi":"GET /wallet_transactions/{lago_id}/fundings","title":"List all fundings for a wallet transaction","href":"/api-reference/wallets/get-all-fundings"}]},{"group":"Wallet alerts","pages":[{"title":"The wallet alert object","href":"/api-reference/wallets/wallet-alert-object"},{"openapi":"POST /customers/{external_customer_id}/wallets/{wallet_code}/alerts","title":"Create a wallet alert","href":"/api-reference/wallets/create-alert"},{"openapi":"PUT /customers/{external_customer_id}/wallets/{wallet_code}/alerts/{code}","title":"Update a wallet alert","href":"/api-reference/wallets/update-alert"},{"openapi":"DELETE /customers/{external_customer_id}/wallets/{wallet_code}/alerts/{code}","title":"Delete a wallet alert","href":"/api-reference/wallets/delete-alert"},{"openapi":"GET /customers/{external_customer_id}/wallets/{wallet_code}/alerts/{code}","title":"Retrieve a wallet alert","href":"/api-reference/wallets/get-specific-alert"},{"openapi":"GET /customers/{external_customer_id}/wallets/{wallet_code}/alerts","title":"List all wallet alerts","href":"/api-reference/wallets/get-all-alerts"}]}]},{"group":"Webhook endpoints","pages":[{"title":"The webhook endpoint object","href":"/api-reference/webhook-endpoints/webhook-endpoint-object"},{"openapi":"POST /webhook_endpoints","title":"Create a webhook endpoint","href":"/api-reference/webhook-endpoints/create"},{"openapi":"PUT /webhook_endpoints/{lago_id}","title":"Update a webhook endpoint","href":"/api-reference/webhook-endpoints/update"},{"openapi":"DELETE /webhook_endpoints/{lago_id}","title":"Delete a webhook endpoint","href":"/api-reference/webhook-endpoints/destroy"},{"openapi":"GET /webhook_endpoints","title":"List all webhook endpoints","href":"/api-reference/webhook-endpoints/get-all"},{"openapi":"GET /webhook_endpoints/{lago_id}","title":"Retrieve a webhook endpoint","href":"/api-reference/webhook-endpoints/get-specific"}]},{"group":"Webhooks","pages":[{"title":"Format and signature","href":"/api-reference/webhooks/format---signature"},{"title":"Messages","href":"/api-reference/webhooks/messages"}]}]}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/introduction"}]},{"tab":"Templates","pages":[{"title":"Templates","href":"/templates/introduction"}]},{"tab":"FAQ","pages":[{"title":"FAQ","href":"/faq/about-lago"}]},{"tab":"Knowledge Base","href":"https://knowledge.getlago.com"},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/product"}]}]},"title":"Update a credit note - Lago","buildId":"dpl_AUojGTPodKNPTVaxVPcxnNvkSVqo","deploymentId":"dpl_AUojGTPodKNPTVaxVPcxnNvkSVqo","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-D2GYGXhJ.js","utils-BFd71lo2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-i162M7Za.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-oUw0la6W.js","snippetPresets-DtIWL37f.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BCMBbEQM.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DC4RgS91.js","shallow-CgVeLRFv.js","getApiPlaygroundDisplay-D5biMY5x.js","CodeSnippet-BFsbT-Fu.js","CodeSnippets-zLLOIece.js","Page-Ddn8iQDL.js","getPastedJson-BrHW4jRt.js","icon-CkMCp-Tk.js","MethodPill-CCcSM-Ep.js","DuplicateIcon-4tBrFI-V.js","createIcon-YbZxtfvX.js","DynamicMarkdown-BQC1aHST.js","SectionHeading-Dyh8yRs0.js","axios-vUo_bRtp.js","Markdown-DnRxVfNy.js","clsx-BHwt7gjg.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CI1QhstW.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ctpizp2W.js"]}