The Engine granted the credits of a paid top-up purchase, so they are in the customer’s balance and can be spent. Sent once per purchase, after the grant is committed. A paid invoice alone does not mean the credits are spendable; wait for this event or poll GET /credit-top-up-purchases/{id} until fulfillment_status is fulfilled.
Purchase snapshot serialized by Nozle Core and passed through unchanged by the Engine.
Show child attributes
Response
200
Return a 2xx status within 30 seconds to acknowledge the delivery. Any other status, a timeout or a connection error is a failed attempt; Nozle makes up to 3 attempts.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Nozle","description":"AI billing \u0026 margin intelligence platform","colors":{"primary":"#6366F1"},"logo":{"light":"https://mintcdn.com/nozle-d78f01d8/XThuRXIhS3KDmLQC/images/nozle-logo.svg?fit=max\u0026auto=format\u0026n=XThuRXIhS3KDmLQC\u0026q=85\u0026s=7635161461eebaa39ca1c108d6c13efe","dark":"https://mintcdn.com/nozle-d78f01d8/XThuRXIhS3KDmLQC/images/nozle-logo.svg?fit=max\u0026auto=format\u0026n=XThuRXIhS3KDmLQC\u0026q=85\u0026s=7635161461eebaa39ca1c108d6c13efe"},"favicon":"https://mintcdn.com/nozle-d78f01d8/XThuRXIhS3KDmLQC/images/nozle-logo.svg?fit=max\u0026auto=format\u0026n=XThuRXIhS3KDmLQC\u0026q=85\u0026s=7635161461eebaa39ca1c108d6c13efe","api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","python","javascript","go","ruby","php","java"]},"mdx":{"auth":{"method":"bearer"},"server":"https://api.nozle.app/engine/api/v1"}},"navbar":{"links":[{"href":"https://app.nozle.dev","label":"Dashboard"}]},"footer":{"socials":{"github":"https://github.com/nozle-dev"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"nozle-d78f01d8","hasAudioNarration":false,"actualSubdomain":"nozle-d78f01d8","customDomains":["docs.nozle.dev"],"gitSource":{"type":"github","owner":"nozle-dev","repo":"nozledocs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"collectionId":"32842193-7306-413d-a8a9-f57e5e204198","liveDeploymentHistoryId":"6ae0bdd26f3f3032700d11df","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae0bdd26f3f3032700d11df"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae0d3b5854bb5a1e92b75b5","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"API Reference","count":303},{"language":"default","tag":"Platform \u0026 Operations","count":94},{"language":"default","tag":"Invoicing \u0026 Payments","count":84},{"language":"default","tag":"Webhook Events","count":72},{"language":"default","tag":"Billing Resources","count":66},{"language":"default","tag":"SDKs","count":59},{"language":"default","tag":"Application Workflows","count":33},{"language":"default","tag":"Documentation","count":32},{"language":"default","tag":"React SDK","count":32},{"language":"default","tag":"Plans","count":28}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/the-credits-of-a-paid-top-up-can-be-spent","slug":"/api-reference/the-credits-of-a-paid-top-up-can-be-spent","pageMetadata":{"title":"The credits of a paid top up can be spent","description":"The Engine granted the credits of a paid top-up purchase, so they are in the customer's balance and can be spent. Sent once per purchase, after the grant is committed. A paid invoice alone does not mean the credits are spendable; wait for this event or poll `GET /credit-top-up-purchases/{id}` until `fulfillment_status` is `fulfilled`.","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook credit_top_up_purchase_fulfilled","href":"/api-reference/the-credits-of-a-paid-top-up-can-be-spent","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"The Engine granted the credits of a paid top-up purchase, so they are in the customer’s balance and can be spent. Sent once per purchase, after the grant is committed. A paid invoice alone does not mean the credits are spendable; wait for this event or poll \", _jsx(_components.code, {\n children: \"GET /credit-top-up-purchases/{id}\"\n }), \" until \", _jsx(_components.code, {\n children: \"fulfillment_status\"\n }), \" is \", _jsx(_components.code, {\n children: \"fulfilled\"\n }), \".\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"The credits of a paid top up can be spent","description":"The Engine granted the credits of a paid top-up purchase, so they are in the customer's balance and can be spent. Sent once per purchase, after the grant is committed. A paid invoice alone does not mean the credits are spendable; wait for this event or poll `GET /credit-top-up-purchases/{id}` until `fulfillment_status` is `fulfilled`.","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook credit_top_up_purchase_fulfilled","href":"/api-reference/the-credits-of-a-paid-top-up-can-be-spent","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"creditTopUpPurchaseFulfilled","summary":"The credits of a paid top-up can be spent","description":"The Engine granted the credits of a paid top-up purchase, so they are in the customer's balance and can be spent. Sent once per purchase, after the grant is committed. A paid invoice alone does not mean the credits are spendable; wait for this event or poll `GET /credit-top-up-purchases/{id}` until `fulfillment_status` is `fulfilled`.","parameters":["f0ea9113-c8d8-42b4-9ebe-0ede8f94a202","e9217594-d0a5-4243-b9b3-8d7ade53424a","022d4c06-f2a2-4c5b-9c9e-a51be13a75a6"],"requestBody":"e1e123c7-5857-4298-a372-e1b4f8796e6f","responses":{"200":"cfa32bfe-5f1a-454e-928b-c689b3279e45"},"method":"post","type":"webhook","servers":["2ebce7f6-5535-4308-b920-55036f74141d"],"security":["796fc84a-2336-4bfd-81b3-7f95c81173dd"],"path":"credit_top_up_purchase_fulfilled","baseUrlOptions":["https://api.nozle.app/core/api/v1"],"title":"The credits of a paid top-up can be spent","codeSamples":[],"requestExampleLanguages":["bash","python","javascript","go","ruby","php","java"],"requiredOnlyExamples":false,"requestExamples":[{"language":"json","filename":"Example","code":"{\n \"webhook_type\": \"credit_top_up_purchase.fulfilled\",\n \"object_type\": \"credit_top_up_purchase\",\n \"organization_id\": \"00000000-0000-4000-8000-000000000001\",\n \"credit_top_up_purchase\": {\n \"nozle_id\": \"00000000-0000-4000-8000-000000000002\",\n \"organization_id\": \"00000000-0000-4000-8000-000000000001\",\n \"customer_id\": \"00000000-0000-4000-8000-000000000003\",\n \"external_customer_id\": \"customer_123\",\n \"credit_system_id\": \"00000000-0000-4000-8000-000000000004\",\n \"credit_system_code\": \"ai_credits\",\n \"top_up_package_id\": \"00000000-0000-4000-8000-000000000005\",\n \"package_code\": \"starter_pack\",\n \"package_name\": \"Starter pack\",\n \"credit_amount\": \"250.0\",\n \"amount_cents\": 1000,\n \"currency\": \"USD\",\n \"expires_after_days\": null,\n \"invoice_id\": \"00000000-0000-4000-8000-000000000006\",\n \"invoice_number\": \"FYN-47DD-008-001\",\n \"invoice_amount_cents\": 1000,\n \"payment_status\": \"succeeded\",\n \"fulfillment_status\": \"fulfilled\",\n \"fulfilled_at\": \"2026-10-27T14:12:39Z\",\n \"payment_id\": null,\n \"payment_provider\": \"stripe\",\n \"payment_provider_type\": null,\n \"payment_provider_code\": null,\n \"provider_payment_id\": null,\n \"payment_url\": null,\n \"replayed\": false,\n \"created_at\": \"2026-10-27T14:12:01Z\"\n }\n}"}],"requestExampleType":"webhook","responseExampleType":"generated"},"dependencies":{"parameters":{"f0ea9113-c8d8-42b4-9ebe-0ede8f94a202":{"name":"X-Nozle-Signature","in":"header","description":"Signature of the webhook payload","required":true,"schema":{"type":"string","example":"Ap¶5ɿΣ6ÐfV£Ä\u0015\u0015ºõÔõÔ[DæAâÿüÚ","isRequired":true,"description":"Signature of the webhook payload","uniqueKey":"","typeLabel":"string"}},"e9217594-d0a5-4243-b9b3-8d7ade53424a":{"name":"X-Nozle-Signature-Algorithm","in":"header","description":"Algorithm used to generate the signature","required":true,"schema":{"type":"string","enum":["jwt","hmac"],"example":"hmac","isRequired":true,"description":"Algorithm used to generate the signature","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"022d4c06-f2a2-4c5b-9c9e-a51be13a75a6":{"name":"X-Nozle-Unique-Key","in":"header","description":"Unique id of the webhook. It can be used for idempotency","required":true,"schema":{"type":"string","format":"uuid","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","isRequired":true,"description":"Unique id of the webhook. It can be used for idempotency","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"requestBody":{"description":"Details of the event","content":{"application/json":{"schema":{"type":"object","required":["webhook_type","object_type","organization_id","credit_top_up_purchase"],"properties":{"webhook_type":{"type":"string","enum":["credit_top_up_purchase.fulfilled"],"isRequired":true,"uniqueKey":"webhook_type","typeLabel":"enum\u003cstring>"},"object_type":{"type":"string","enum":["credit_top_up_purchase"],"isRequired":true,"uniqueKey":"object_type","typeLabel":"enum\u003cstring>"},"organization_id":{"type":"string","format":"uuid","description":"Unique identifier of the organization, created by Nozle.","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","isRequired":true,"uniqueKey":"organization_id","typeLabel":"string\u003cuuid>"},"credit_top_up_purchase":{"type":"object","description":"Purchase snapshot serialized by Nozle Core and passed through unchanged by the Engine.","properties":{"nozle_id":{"type":"string","uniqueKey":"credit_top_up_purchase.nozle_id","typeLabel":"string"},"organization_id":{"type":"string","uniqueKey":"credit_top_up_purchase.organization_id","typeLabel":"string"},"customer_id":{"type":"string","uniqueKey":"credit_top_up_purchase.customer_id","typeLabel":"string"},"external_customer_id":{"type":"string","uniqueKey":"credit_top_up_purchase.external_customer_id","typeLabel":"string"},"credit_system_id":{"type":"string","uniqueKey":"credit_top_up_purchase.credit_system_id","typeLabel":"string"},"credit_system_code":{"type":"string","uniqueKey":"credit_top_up_purchase.credit_system_code","typeLabel":"string"},"top_up_package_id":{"type":"string","uniqueKey":"credit_top_up_purchase.top_up_package_id","typeLabel":"string"},"package_code":{"type":"string","uniqueKey":"credit_top_up_purchase.package_code","typeLabel":"string"},"package_name":{"oneOf":[{"type":"string","uniqueKey":"credit_top_up_purchase.package_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"credit_top_up_purchase.package_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_top_up_purchase.package_name","typeLabel":"string | null"},"credit_amount":{"type":"string","description":"Credits the package grants, as a decimal string.","uniqueKey":"credit_top_up_purchase.credit_amount","typeLabel":"string"},"amount_cents":{"type":"integer","uniqueKey":"credit_top_up_purchase.amount_cents","typeLabel":"integer"},"currency":{"type":"string","uniqueKey":"credit_top_up_purchase.currency","typeLabel":"string"},"expires_after_days":{"oneOf":[{"type":"integer","uniqueKey":"credit_top_up_purchase.expires_after_days.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"credit_top_up_purchase.expires_after_days.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_top_up_purchase.expires_after_days","typeLabel":"integer | null"},"invoice_id":{"type":"string","uniqueKey":"credit_top_up_purchase.invoice_id","typeLabel":"string"},"invoice_number":{"oneOf":[{"type":"string","uniqueKey":"credit_top_up_purchase.invoice_number.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"credit_top_up_purchase.invoice_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_top_up_purchase.invoice_number","typeLabel":"string | null"},"invoice_amount_cents":{"type":"integer","uniqueKey":"credit_top_up_purchase.invoice_amount_cents","typeLabel":"integer"},"payment_status":{"type":"string","enum":["pending","succeeded","failed","voided"],"description":"Payment of the top-up invoice. `succeeded` does not mean the credits can be spent yet; see `fulfillment_status`.","uniqueKey":"credit_top_up_purchase.payment_status","typeLabel":"enum\u003cstring>"},"fulfillment_status":{"type":"string","enum":["pending","fulfilled"],"description":"`fulfilled` once the credits are granted and can be spent (Core 11.1.0 and later), then the `credit_top_up_purchase.fulfilled` webhook is sent. `pending` before.","uniqueKey":"credit_top_up_purchase.fulfillment_status","typeLabel":"enum\u003cstring>"},"fulfilled_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the credits were granted, or `null` while `fulfillment_status` is `pending`.","uniqueKey":"credit_top_up_purchase.fulfilled_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the credits were granted, or `null` while `fulfillment_status` is `pending`.","uniqueKey":"credit_top_up_purchase.fulfilled_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_top_up_purchase.fulfilled_at","typeLabel":"string\u003cdate-time> | null"},"payment_id":{"oneOf":[{"type":"string","uniqueKey":"credit_top_up_purchase.payment_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"credit_top_up_purchase.payment_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_top_up_purchase.payment_id","typeLabel":"string | null"},"payment_provider":{"oneOf":[{"type":"string","description":"For example `stripe` or `razorpay`.","uniqueKey":"credit_top_up_purchase.payment_provider.oneOf.0","typeLabel":"string"},{"type":"null","description":"For example `stripe` or `razorpay`.","uniqueKey":"credit_top_up_purchase.payment_provider.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_top_up_purchase.payment_provider","typeLabel":"string | null"},"payment_provider_type":{"oneOf":[{"type":"string","uniqueKey":"credit_top_up_purchase.payment_provider_type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"credit_top_up_purchase.payment_provider_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_top_up_purchase.payment_provider_type","typeLabel":"string | null"},"payment_provider_code":{"oneOf":[{"type":"string","uniqueKey":"credit_top_up_purchase.payment_provider_code.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"credit_top_up_purchase.payment_provider_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_top_up_purchase.payment_provider_code","typeLabel":"string | null"},"provider_payment_id":{"oneOf":[{"type":"string","uniqueKey":"credit_top_up_purchase.provider_payment_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"credit_top_up_purchase.provider_payment_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_top_up_purchase.provider_payment_id","typeLabel":"string | null"},"payment_url":{"oneOf":[{"type":"string","description":"Hosted payment page. Stripe: a `checkout.stripe.com` page valid for 24 hours. Razorpay: an `rzp.io` payment link.","uniqueKey":"credit_top_up_purchase.payment_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Hosted payment page. Stripe: a `checkout.stripe.com` page valid for 24 hours. Razorpay: an `rzp.io` payment link.","uniqueKey":"credit_top_up_purchase.payment_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"credit_top_up_purchase.payment_url","typeLabel":"string | null"},"replayed":{"type":"boolean","uniqueKey":"credit_top_up_purchase.replayed","typeLabel":"boolean"},"created_at":{"type":"string","format":"date-time","uniqueKey":"credit_top_up_purchase.created_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"credit_top_up_purchase","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"webhook_type":"credit_top_up_purchase.fulfilled","object_type":"credit_top_up_purchase","organization_id":"00000000-0000-4000-8000-000000000001","credit_top_up_purchase":{"nozle_id":"00000000-0000-4000-8000-000000000002","organization_id":"00000000-0000-4000-8000-000000000001","customer_id":"00000000-0000-4000-8000-000000000003","external_customer_id":"customer_123","credit_system_id":"00000000-0000-4000-8000-000000000004","credit_system_code":"ai_credits","top_up_package_id":"00000000-0000-4000-8000-000000000005","package_code":"starter_pack","package_name":"Starter pack","credit_amount":"250.0","amount_cents":1000,"currency":"USD","expires_after_days":null,"invoice_id":"00000000-0000-4000-8000-000000000006","invoice_number":"FYN-47DD-008-001","invoice_amount_cents":1000,"payment_status":"succeeded","fulfillment_status":"fulfilled","fulfilled_at":"2026-10-27T14:12:39Z","payment_id":null,"payment_provider":"stripe","payment_provider_type":null,"payment_provider_code":null,"provider_payment_id":null,"payment_url":null,"replayed":false,"created_at":"2026-10-27T14:12:01Z"}},"examples":{"Example":{"title":"Example","value":{"webhook_type":"credit_top_up_purchase.fulfilled","object_type":"credit_top_up_purchase","organization_id":"00000000-0000-4000-8000-000000000001","credit_top_up_purchase":{"nozle_id":"00000000-0000-4000-8000-000000000002","organization_id":"00000000-0000-4000-8000-000000000001","customer_id":"00000000-0000-4000-8000-000000000003","external_customer_id":"customer_123","credit_system_id":"00000000-0000-4000-8000-000000000004","credit_system_code":"ai_credits","top_up_package_id":"00000000-0000-4000-8000-000000000005","package_code":"starter_pack","package_name":"Starter pack","credit_amount":"250.0","amount_cents":1000,"currency":"USD","expires_after_days":null,"invoice_id":"00000000-0000-4000-8000-000000000006","invoice_number":"FYN-47DD-008-001","invoice_amount_cents":1000,"payment_status":"succeeded","fulfillment_status":"fulfilled","fulfilled_at":"2026-10-27T14:12:39Z","payment_id":null,"payment_provider":"stripe","payment_provider_type":null,"payment_provider_code":null,"provider_payment_id":null,"payment_url":null,"replayed":false,"created_at":"2026-10-27T14:12:01Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"cfa32bfe-5f1a-454e-928b-c689b3279e45":{"description":"Return a 2xx status within 30 seconds to acknowledge the delivery. Any other status, a timeout or a connection error is a failed attempt; Nozle makes up to 3 attempts.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"796fc84a-2336-4bfd-81b3-7f95c81173dd":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"2ebce7f6-5535-4308-b920-55036f74141d":{"url":"https://api.nozle.app/core/api/v1","description":"Nozle Billing API"}},"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":"nozle-openapi.yaml"},"subdomain":"nozle-d78f01d8","siteName":"Nozle","title":"The credits of a paid top up can be spent - Nozle","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-27T16:40:50.643Z","originalFileLocation":"api-reference/the-credits-of-a-paid-top-up-can-be-spent.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=\"The Engine granted the credits of a paid top-up purchase, so they are in the customer\u0026#x27;s balance and can be spent. Sent once per purchase, after the grant is committed. A paid invoice alone does not mean the credits are spendable; wait for this event or poll GET /credit-top-up-purchases/{id} until fulfillment_status is fulfilled.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Nozle\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/nozle-d78f01d8/dsQrUEOvyOI7KRQW/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/nozle-d78f01d8/dsQrUEOvyOI7KRQW/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/nozle-d78f01d8/dsQrUEOvyOI7KRQW/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/nozle-d78f01d8/dsQrUEOvyOI7KRQW/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/nozle-d78f01d8/dsQrUEOvyOI7KRQW/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/nozle-d78f01d8/dsQrUEOvyOI7KRQW/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/nozle-d78f01d8/dsQrUEOvyOI7KRQW/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/nozle-d78f01d8/dsQrUEOvyOI7KRQW/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/nozle-d78f01d8/dsQrUEOvyOI7KRQW/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"The credits of a paid top up can be spent - Nozle\">\u003cmeta data-mint-head property=\"og:description\" content=\"The Engine granted the credits of a paid top-up purchase, so they are in the customer\u0026#x27;s balance and can be spent. Sent once per purchase, after the grant is committed. A paid invoice alone does not mean the credits are spendable; wait for this event or poll GET /credit-top-up-purchases/{id} until fulfillment_status is fulfilled.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Nozle\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.nozle.dev/api-reference/the-credits-of-a-paid-top-up-can-be-spent\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://nozle-d78f01d8.mintlify.app/_mintlify/api/og/v2?division=Wallets+and+Credits\u0026amp;title=The+credits+of+a+paid+top+up+can+be+spent\u0026amp;description=The+Engine+granted+the+credits+of+a+paid+top-up+purchase%2C+so+they+are+in+the+customer%27s+balance+and+can+be+spent.+Sent+once+per+purchase%2C+after+the+grant+is+com\u0026amp;theme=df1fc43b077bc417f789de1e\u0026amp;signature=aca78e3033ad999bc108661fcf1f488e964d830266244035b3196f6cd0eb21cf\">\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=\"The credits of a paid top up can be spent - Nozle\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The Engine granted the credits of a paid top-up purchase, so they are in the customer\u0026#x27;s balance and can be spent. Sent once per purchase, after the grant is committed. A paid invoice alone does not mean the credits are spendable; wait for this event or poll GET /credit-top-up-purchases/{id} until fulfillment_status is fulfilled.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://nozle-d78f01d8.mintlify.app/_mintlify/api/og/v2?division=Wallets+and+Credits\u0026amp;title=The+credits+of+a+paid+top+up+can+be+spent\u0026amp;description=The+Engine+granted+the+credits+of+a+paid+top-up+purchase%2C+so+they+are+in+the+customer%27s+balance+and+can+be+spent.+Sent+once+per+purchase%2C+after+the+grant+is+com\u0026amp;theme=df1fc43b077bc417f789de1e\u0026amp;signature=aca78e3033ad999bc108661fcf1f488e964d830266244035b3196f6cd0eb21cf\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/nozle-d78f01d8/dsQrUEOvyOI7KRQW/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Nozle\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6366F1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.nozle.dev/api-reference/the-credits-of-a-paid-top-up-can-be-spent\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/the-credits-of-a-paid-top-up-can-be-spent.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.nozle.dev/#organization\",\"name\":\"Nozle\",\"url\":\"https://docs.nozle.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/nozle-d78f01d8/XThuRXIhS3KDmLQC/images/nozle-logo.svg?fit=max\u0026auto=format\u0026n=XThuRXIhS3KDmLQC\u0026q=85\u0026s=7635161461eebaa39ca1c108d6c13efe\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.nozle.dev#website\",\"name\":\"Nozle\",\"url\":\"https://docs.nozle.dev\",\"publisher\":{\"@id\":\"https://docs.nozle.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.nozle.dev/api-reference/the-credits-of-a-paid-top-up-can-be-spent#webpage\",\"url\":\"https://docs.nozle.dev/api-reference/the-credits-of-a-paid-top-up-can-be-spent\",\"name\":\"The credits of a paid top up can be spent\",\"description\":\"The Engine granted the credits of a paid top-up purchase, so they are in the customer's balance and can be spent. Sent once per purchase, after the grant is committed. A paid invoice alone does not mean the credits are spendable; wait for this event or poll GET /credit-top-up-purchases/{id} until fulfillment_status is fulfilled.\",\"dateModified\":\"2026-10-27T16:40:50.643Z\",\"isPartOf\":{\"@id\":\"https://docs.nozle.dev#website\"},\"breadcrumb\":{\"@id\":\"https://docs.nozle.dev/api-reference/the-credits-of-a-paid-top-up-can-be-spent#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.nozle.dev/api-reference/the-credits-of-a-paid-top-up-can-be-spent#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Platform \u0026 Operations\",\"item\":\"https://docs.nozle.dev/api-reference/billing-entities/list-all-billing-entities\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Webhook Events\",\"item\":\"https://docs.nozle.dev/api-reference/a-new-alert-was-triggered\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"The credits of a paid top up can be spent\",\"item\":\"https://docs.nozle.dev/api-reference/the-credits-of-a-paid-top-up-can-be-spent\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.nozle.dev/api-reference/the-credits-of-a-paid-top-up-can-be-spent#apireference\",\"headline\":\"The credits of a paid top up can be spent\",\"name\":\"The credits of a paid top up can be spent\",\"description\":\"The Engine granted the credits of a paid top-up purchase, so they are in the customer's balance and can be spent. Sent once per purchase, after the grant is committed. A paid invoice alone does not mean the credits are spendable; wait for this event or poll GET /credit-top-up-purchases/{id} until fulfillment_status is fulfilled.\",\"url\":\"https://docs.nozle.dev/api-reference/the-credits-of-a-paid-top-up-can-be-spent\",\"mainEntityOfPage\":{\"@id\":\"https://docs.nozle.dev/api-reference/the-credits-of-a-paid-top-up-can-be-spent#webpage\"},\"dateModified\":\"2026-10-27T16:40:50.643Z\",\"publisher\":{\"@id\":\"https://docs.nozle.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.nozle.dev#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Nozle\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Nozle","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/guides/getting-started/introduction"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API Introduction","href":"/api/introduction"},{"title":"API Standards","href":"/api/api-standards"},{"title":"Authentication","href":"/api/authentication"},{"title":"Errors","href":"/api/errors"},{"title":"Webhooks","href":"/api/webhooks"},{"title":"Receive Nozle webhooks","href":"/api/receive-webhooks"},{"title":"Webhook events","href":"/api/webhook-events"},{"title":"Changes in Core 3.11 and Engine 2.3","href":"/api/changes-3-11"},{"title":"Idempotency","href":"/api/idempotency"},{"title":"MCP Server","href":"/api/mcp"}]},{"group":"Application Workflows","pages":[{"group":"Checkout \u0026 Subscriptions","pages":[{"title":"Application Billing API","href":"/billing-api/overview"},{"title":"Create Subscription","api":"POST https://api.nozle.app/engine/api/v1/subscribe","href":"/api/subscribe"},{"title":"Create Checkout Session","api":"POST https://api.nozle.app/engine/api/v1/checkout","href":"/api/create-checkout"},{"title":"Manage Payment Method","api":"POST https://api.nozle.app/engine/api/v1/customers/{customer_id}/payment-method/manage","href":"/api/manage-payment-method"},{"title":"Billing Status","api":"GET https://api.nozle.app/engine/api/v1/billing/status","href":"/api/billing-status"},{"title":"Subscription self-service","href":"/api/subscription-management"},{"title":"Plan Transition Policies","api":"PUT https://api.nozle.app/core/api/v1/plans/{plan_code}/transition-policies/{target_plan_code}","href":"/api/plan-transition-policies"},{"title":"Plan Versions and Migrations","api":"POST https://api.nozle.app/core/api/v1/plans/{code}/version-migrations","href":"/api/plan-versions"},{"title":"Import External Billing State","api":"POST https://api.nozle.app/core/api/v1/customers/{customer_id}/billing-state-imports","href":"/api/import-billing-state"},{"title":"Entity Subscriptions","api":"POST https://api.nozle.app/core/api/v1/customers/{customer_id}/entity-subscriptions/checkout","href":"/api/entity-subscriptions"},{"title":"Upgrade Plan","api":"POST https://api.nozle.app/engine/api/v1/billing/upgrade","href":"/api/upgrade"},{"title":"Cancel Subscription","api":"DELETE https://api.nozle.app/engine/api/v1/subscriptions/{id}","href":"/api/cancel-subscription"}]},{"group":"Product Credits","pages":[{"title":"Customer Credit Balances","api":"GET https://api.nozle.app/engine/api/v1/customers/{customer_id}/credit-systems","href":"/api/customer-credit-balances"},{"title":"Customer Credit Operations","api":"GET https://api.nozle.app/engine/api/v1/customers/{customer_id}/credit-operations","href":"/api/customer-credit-operations"},{"title":"Customer Entities","api":"GET https://api.nozle.app/engine/api/v1/customers/{customer_id}/entities","href":"/api/customer-entities"},{"title":"Entity Credit Balances","api":"GET https://api.nozle.app/engine/api/v1/customers/{customer_id}/entities/{entity_id}/credit-systems","href":"/api/entity-credit-balances"},{"title":"Entity Credit Operations","api":"GET https://api.nozle.app/engine/api/v1/customers/{customer_id}/entities/{entity_id}/credit-operations","href":"/api/entity-credit-operations"},{"title":"Entity Credit Transfers","api":"POST https://api.nozle.app/engine/api/v1/customers/{customer_id}/entities/{entity_id}/credit-allocations","href":"/api/entity-credit-transfers"},{"title":"Import Opening Credit Balance","api":"POST https://api.nozle.app/engine/api/v1/customers/{customer_id}/credit-balance-imports","href":"/api/import-opening-credit-balance"},{"title":"Check Credit Usage","api":"POST https://api.nozle.app/engine/api/v1/usage/check","href":"/api/usage-check"},{"title":"Track and Consume Credits","api":"POST https://api.nozle.app/engine/api/v1/usage/track","href":"/api/usage-track"},{"title":"Create Credit Top-up Purchase","api":"POST https://api.nozle.app/engine/api/v1/credit-top-up-purchases","href":"/api/create-credit-top-up-purchase"},{"title":"Check \u0026 Deduct Credits","api":"POST https://api.nozle.app/engine/api/v1/check-and-deduct","href":"/api/check-and-deduct"},{"title":"Legacy Invoice Wallet Balance","api":"GET https://api.nozle.app/engine/api/v1/credits/{id}/balance","href":"/api/credit-balance"}]},{"group":"Entitlements","pages":[{"title":"Check Entitlement","api":"GET https://api.nozle.app/engine/api/v1/can","href":"/api/check-entitlement"}]},{"group":"Margin Intelligence","pages":[{"title":"Margin Summary","api":"GET https://api.nozle.app/engine/api/v1/margin/summary","href":"/api/margin-summary"},{"title":"Margin by Customer","api":"GET https://api.nozle.app/engine/api/v1/margin/customers","href":"/api/margin-customers"},{"title":"Margin Trend","api":"GET https://api.nozle.app/engine/api/v1/margin/trend","href":"/api/margin-trend"},{"title":"Simulate Margin","api":"POST https://api.nozle.app/engine/api/v1/margin/simulate","href":"/api/margin-simulate"},{"title":"Cost Events","api":"POST https://api.nozle.app/engine/api/v1/cost-events","href":"/api/cost-events"},{"title":"Shared Period Costs","href":"/api/shared-costs"},{"title":"Cost Intelligence report","href":"/api/cost-intelligence-report"}]},{"group":"AI Proxy","pages":[{"title":"LLM Proxy","href":"/api/llm-proxy"}]}]},{"group":"Billing Resources","pages":[{"group":"Customers","expanded":false,"pages":[{"title":"Create a customer","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /customers","href":"/api-reference/customers/create-a-customer"},{"title":"List all customers","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /customers","href":"/api-reference/customers/list-all-customers"},{"title":"Retrieve a customer","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /customers/{external_customer_id}","href":"/api-reference/customers/retrieve-a-customer"},{"title":"Delete a customer","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml delete /customers/{external_customer_id}","href":"/api-reference/customers/delete-a-customer"},{"title":"Get a customer portal URL","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /customers/{external_customer_id}/portal_url","href":"/api-reference/customers/get-a-customer-portal-url"},{"title":"Generate a Customer Payment Provider Checkout URL","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /customers/{external_customer_id}/checkout_url","href":"/api-reference/customers/generate-a-customer-payment-provider-checkout-url"}]},{"group":"Plans","expanded":false,"pages":[{"title":"Create a plan","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /plans","href":"/api-reference/plans/create-a-plan"},{"title":"List all plans","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /plans","href":"/api-reference/plans/list-all-plans"},{"title":"Update a plan","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml put /plans/{code}","href":"/api-reference/plans/update-a-plan"},{"title":"Retrieve a plan","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /plans/{code}","href":"/api-reference/plans/retrieve-a-plan"},{"title":"Delete a plan","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml delete /plans/{code}","href":"/api-reference/plans/delete-a-plan"},{"title":"Replace plan metadata","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /plans/{code}/metadata","href":"/api-reference/plans/replace-plan-metadata"},{"title":"Merge plan metadata","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml patch /plans/{code}/metadata","href":"/api-reference/plans/merge-plan-metadata"},{"title":"Delete all plan metadata","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml delete /plans/{code}/metadata","href":"/api-reference/plans/delete-all-plan-metadata"},{"title":"Delete a metadata key","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml delete /plans/{code}/metadata/{key}","href":"/api-reference/plans/delete-a-metadata-key"},{"title":"Create a charge","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /plans/{code}/charges","href":"/api-reference/plans/create-a-charge"},{"title":"List all charges for a plan","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /plans/{code}/charges","href":"/api-reference/plans/list-all-charges-for-a-plan"},{"title":"Retrieve a charge","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /plans/{code}/charges/{charge_code}","href":"/api-reference/plans/retrieve-a-charge"},{"title":"Update a charge","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml put /plans/{code}/charges/{charge_code}","href":"/api-reference/plans/update-a-charge"},{"title":"Delete a charge","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml delete /plans/{code}/charges/{charge_code}","href":"/api-reference/plans/delete-a-charge"},{"title":"Create a charge filter","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /plans/{code}/charges/{charge_code}/filters","href":"/api-reference/plans/create-a-charge-filter"},{"title":"List all filters for a charge","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /plans/{code}/charges/{charge_code}/filters","href":"/api-reference/plans/list-all-filters-for-a-charge"},{"title":"Retrieve a charge filter","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /plans/{code}/charges/{charge_code}/filters/{filter_id}","href":"/api-reference/plans/retrieve-a-charge-filter"},{"title":"Update a charge filter","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml put /plans/{code}/charges/{charge_code}/filters/{filter_id}","href":"/api-reference/plans/update-a-charge-filter"},{"title":"Delete a charge filter","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml delete /plans/{code}/charges/{charge_code}/filters/{filter_id}","href":"/api-reference/plans/delete-a-charge-filter"},{"title":"Create a fixed charge","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /plans/{code}/fixed_charges","href":"/api-reference/plans/create-a-fixed-charge"},{"title":"List all fixed charges for a plan","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /plans/{code}/fixed_charges","href":"/api-reference/plans/list-all-fixed-charges-for-a-plan"},{"title":"Retrieve a fixed charge","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /plans/{code}/fixed_charges/{fixed_charge_code}","href":"/api-reference/plans/retrieve-a-fixed-charge"},{"title":"Update a fixed charge","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml put /plans/{code}/fixed_charges/{fixed_charge_code}","href":"/api-reference/plans/update-a-fixed-charge"},{"title":"Delete a fixed charge","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml delete /plans/{code}/fixed_charges/{fixed_charge_code}","href":"/api-reference/plans/delete-a-fixed-charge"}]},{"group":"Subscriptions","expanded":false,"pages":[{"title":"List all customer's subscriptions","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /customers/{external_customer_id}/subscriptions","href":"/api-reference/customers/list-all-customers-subscriptions"},{"title":"Assign a plan to a customer","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /subscriptions","href":"/api-reference/subscriptions/assign-a-plan-to-a-customer"},{"title":"List all subscriptions","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /subscriptions","href":"/api-reference/subscriptions/list-all-subscriptions"},{"title":"Retrieve a subscription","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /subscriptions/{external_id}","href":"/api-reference/subscriptions/retrieve-a-subscription"},{"title":"Update a subscription","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml put /subscriptions/{external_id}","href":"/api-reference/subscriptions/update-a-subscription"},{"title":"Terminate a subscription","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml delete /subscriptions/{external_id}","href":"/api-reference/subscriptions/terminate-a-subscription"},{"title":"Retrieve subscription lifetime usage","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /subscriptions/{external_id}/lifetime_usage","href":"/api-reference/subscriptions/retrieve-subscription-lifetime-usage"},{"title":"Update a subscription lifetime usage","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml put /subscriptions/{external_id}/lifetime_usage","href":"/api-reference/subscriptions/update-a-subscription-lifetime-usage"},{"title":"List subscription alerts","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /subscriptions/{external_id}/alerts","href":"/api-reference/subscriptions/list-subscription-alerts"},{"title":"Create subscription alert(s)","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /subscriptions/{external_id}/alerts","href":"/api-reference/subscriptions/create-subscription-alerts"},{"title":"Delete all subscription alerts","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml delete /subscriptions/{external_id}/alerts","href":"/api-reference/subscriptions/delete-all-subscription-alerts"},{"title":"Retrieve a subscription alert","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /subscriptions/{external_id}/alerts/{code}","href":"/api-reference/subscriptions/retrieve-a-subscription-alert"},{"title":"Update a subscription alert","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml put /subscriptions/{external_id}/alerts/{code}","href":"/api-reference/subscriptions/update-a-subscription-alert"},{"title":"Delete a subscription alert","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml delete /subscriptions/{external_id}/alerts/{code}","href":"/api-reference/subscriptions/delete-a-subscription-alert"},{"title":"List all fixed charges for a subscription","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /subscriptions/{external_id}/fixed_charges","href":"/api-reference/subscriptions/list-all-fixed-charges-for-a-subscription"},{"title":"List all charges for a subscription","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /subscriptions/{external_id}/charges","href":"/api-reference/subscriptions/list-all-charges-for-a-subscription"},{"title":"Retrieve a charge for a subscription","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /subscriptions/{external_id}/charges/{charge_code}","href":"/api-reference/subscriptions/retrieve-a-charge-for-a-subscription"},{"title":"Override a charge for a subscription","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml put /subscriptions/{external_id}/charges/{charge_code}","href":"/api-reference/subscriptions/override-a-charge-for-a-subscription"},{"title":"Create a charge filter","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /subscriptions/{external_id}/charges/{charge_code}/filters","href":"/api-reference/subscriptions/create-a-charge-filter"},{"title":"List all filters for a charge","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /subscriptions/{external_id}/charges/{charge_code}/filters","href":"/api-reference/subscriptions/list-all-filters-for-a-charge"},{"title":"Retrieve a charge filter","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /subscriptions/{external_id}/charges/{charge_code}/filters/{filter_id}","href":"/api-reference/subscriptions/retrieve-a-charge-filter"},{"title":"Update a charge filter","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml put /subscriptions/{external_id}/charges/{charge_code}/filters/{filter_id}","href":"/api-reference/subscriptions/update-a-charge-filter"},{"title":"Delete a charge filter","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml delete /subscriptions/{external_id}/charges/{charge_code}/filters/{filter_id}","href":"/api-reference/subscriptions/delete-a-charge-filter"},{"title":"Retrieve a fixed charge for a subscription","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /subscriptions/{external_id}/fixed_charges/{fixed_charge_code}","href":"/api-reference/subscriptions/retrieve-a-fixed-charge-for-a-subscription"},{"title":"Override a fixed charge for a subscription","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml put /subscriptions/{external_id}/fixed_charges/{fixed_charge_code}","href":"/api-reference/subscriptions/override-a-fixed-charge-for-a-subscription"}]},{"group":"Features \u0026 Entitlements","expanded":false,"pages":[{"title":"Create a feature","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /features","href":"/api-reference/features/create-a-feature"},{"title":"List all features","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /features","href":"/api-reference/features/list-all-features"},{"title":"Update a feature","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml put /features/{code}","href":"/api-reference/features/update-a-feature"},{"title":"Delete a feature","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml delete /features/{code}","href":"/api-reference/features/delete-a-feature"},{"title":"Retrieve a feature","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /features/{code}","href":"/api-reference/features/retrieve-a-feature"},{"title":"Delete a privilege. Deleting a privilege removes it from all plans and subscriptions.","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml delete /features/{code}/privileges/{privilege_code}","href":"/api-reference/features/delete-a-privilege-deleting-a-privilege-removes-it-from-all-plans-and-subscriptions"},{"title":"Create an entitlement","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /plans/{code}/entitlements","href":"/api-reference/entitlements/create-an-entitlement"},{"title":"List all entitlements","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /plans/{code}/entitlements","href":"/api-reference/entitlements/list-all-entitlements"},{"title":"Partial update of an entitlement","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml patch /plans/{code}/entitlements","href":"/api-reference/entitlements/partial-update-of-an-entitlement"},{"title":"Retrieve an entitlement","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /plans/{code}/entitlements/{feature_code}","href":"/api-reference/entitlements/retrieve-an-entitlement"},{"title":"Delete an entitlement","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml delete /plans/{code}/entitlements/{feature_code}","href":"/api-reference/entitlements/delete-an-entitlement"},{"title":"Remove a privilege from an entitlement","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml delete /plans/{code}/entitlements/{feature_code}/privileges/{privilege_code}","href":"/api-reference/entitlements/remove-a-privilege-from-an-entitlement"},{"title":"List all subscription entitlements","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /subscriptions/{external_id}/entitlements","href":"/api-reference/entitlements/list-all-subscription-entitlements"},{"title":"Update subscription entitlements","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml patch /subscriptions/{external_id}/entitlements","href":"/api-reference/entitlements/update-subscription-entitlements"},{"title":"Remove an entitlement from a subscription","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml delete /subscriptions/{external_id}/entitlements/{feature_code}","href":"/api-reference/entitlements/remove-an-entitlement-from-a-subscription"},{"title":"Remove a privilege from a subscription entitlement override","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml delete /subscriptions/{external_id}/entitlements/{feature_code}/privileges/{privilege_code}","href":"/api-reference/entitlements/remove-a-privilege-from-a-subscription-entitlement-override"}]}]},{"group":"Usage \u0026 Metering","pages":[{"group":"Usage Events","expanded":false,"pages":[{"title":"Send usage events","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /events","href":"/api-reference/events/send-usage-events"},{"title":"List all events","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /events","href":"/api-reference/events/list-all-events"},{"title":"Batch multiple events","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /events/batch","href":"/api-reference/events/batch-multiple-events"},{"title":"Estimate fees for a pay in advance charge","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /events/estimate_fees","href":"/api-reference/events/estimate-fees-for-a-pay-in-advance-charge"},{"title":"Estimate instant fees for a pay in advance charge","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /events/estimate_instant_fees","href":"/api-reference/events/estimate-instant-fees-for-a-pay-in-advance-charge"},{"title":"Batch estimate instant fees for a pay in advance charge","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /events/batch_estimate_instant_fees","href":"/api-reference/events/batch-estimate-instant-fees-for-a-pay-in-advance-charge"},{"title":"Retrieve a specific event","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /events/{transaction_id}","href":"/api-reference/events/retrieve-a-specific-event"}]},{"group":"Features","expanded":false,"pages":[{"title":"Create a feature","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /features","href":"/api-reference/features/create-a-feature"},{"title":"List all features","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /features","href":"/api-reference/features/list-all-features"},{"title":"Evaluate a metered Feature expression","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /features/evaluate_expression","href":"/api-reference/features/evaluate-a-metered-feature-expression"},{"title":"Update a feature","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml put /features/{code}","href":"/api-reference/features/update-a-feature"},{"title":"Delete a feature","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml delete /features/{code}","href":"/api-reference/features/delete-a-feature"},{"title":"Retrieve a feature","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /features/{code}","href":"/api-reference/features/retrieve-a-feature"}]},{"group":"Customer Usage","expanded":false,"pages":[{"title":"Retrieve customer current usage","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /customers/{external_customer_id}/current_usage","href":"/api-reference/customers/retrieve-customer-current-usage"},{"title":"Retrieve customer current and projected usage","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /customers/{external_customer_id}/projected_usage","href":"/api-reference/customers/retrieve-customer-current-and-projected-usage"},{"title":"Retrieve customer past usage","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /customers/{external_customer_id}/past_usage","href":"/api-reference/customers/retrieve-customer-past-usage"}]}]},{"group":"Invoicing \u0026 Payments","pages":[{"group":"Invoices","expanded":false,"pages":[{"title":"List all customer's invoices","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /customers/{external_customer_id}/invoices","href":"/api-reference/customers/list-all-customers-invoices"},{"title":"Create a one-off invoice","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /invoices","href":"/api-reference/invoices/create-a-one-off-invoice"},{"title":"List all invoices","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /invoices","href":"/api-reference/invoices/list-all-invoices"},{"title":"Update an invoice","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml put /invoices/{id}","href":"/api-reference/invoices/update-an-invoice"},{"title":"Retrieve an invoice","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /invoices/{id}","href":"/api-reference/invoices/retrieve-an-invoice"},{"title":"Download an invoice PDF","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /invoices/{id}/download","href":"/api-reference/invoices/download-an-invoice-pdf"},{"title":"Finalize a draft invoice","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml put /invoices/{id}/finalize","href":"/api-reference/invoices/finalize-a-draft-invoice"},{"title":"Mark an invoice payment dispute as lost","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /invoices/{id}/lose_dispute","href":"/api-reference/invoices/mark-an-invoice-payment-dispute-as-lost"},{"title":"Refresh a draft invoice","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml put /invoices/{id}/refresh","href":"/api-reference/invoices/refresh-a-draft-invoice"},{"title":"Retry generation of a failed invoice","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /invoices/{id}/retry","href":"/api-reference/invoices/retry-generation-of-a-failed-invoice"},{"title":"Generate a payment URL","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /invoices/{id}/payment_url","href":"/api-reference/invoices/generate-a-payment-url"},{"title":"Create an invoice preview","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /invoices/preview","href":"/api-reference/invoices/create-an-invoice-preview"},{"title":"Retry an invoice payment","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /invoices/{id}/retry_payment","href":"/api-reference/invoices/retry-an-invoice-payment"},{"title":"Void an invoice","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /invoices/{id}/void","href":"/api-reference/invoices/void-an-invoice"}]},{"group":"Fees","expanded":false,"pages":[{"title":"List all fees","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /fees","href":"/api-reference/fees/list-all-fees"},{"title":"Retrieve a specific fee","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /fees/{id}","href":"/api-reference/fees/retrieve-a-specific-fee"},{"title":"Update a fee","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml put /fees/{id}","href":"/api-reference/fees/update-a-fee"},{"title":"Delete a fee","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml delete /fees/{id}","href":"/api-reference/fees/delete-a-fee"}]},{"group":"Wallets","expanded":false,"pages":[{"title":"Create a wallet","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /wallets","href":"/api-reference/wallets/create-a-wallet"},{"title":"List all customer's wallets","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /customers/{external_customer_id}/wallets","href":"/api-reference/wallets/list-all-customers-wallets"},{"title":"Update a wallet","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml put /wallets/{id}","href":"/api-reference/wallets/update-a-wallet"},{"title":"Retrieve a wallet","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /wallets/{id}","href":"/api-reference/wallets/retrieve-a-wallet"},{"title":"Terminate a wallet","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml delete /wallets/{id}","href":"/api-reference/wallets/terminate-a-wallet"},{"title":"Replace wallet metadata","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /wallets/{id}/metadata","href":"/api-reference/wallets/replace-wallet-metadata"},{"title":"Merge wallet metadata","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml patch /wallets/{id}/metadata","href":"/api-reference/wallets/merge-wallet-metadata"},{"title":"Delete all wallet metadata","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml delete /wallets/{id}/metadata","href":"/api-reference/wallets/delete-all-wallet-metadata"},{"title":"Delete a metadata key","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml delete /wallets/{id}/metadata/{key}","href":"/api-reference/wallets/delete-a-metadata-key"},{"title":"List wallet alerts","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /customers/{external_customer_id}/wallets/{wallet_code}/alerts","href":"/api-reference/wallets/list-wallet-alerts"},{"title":"Create wallet alert(s)","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /customers/{external_customer_id}/wallets/{wallet_code}/alerts","href":"/api-reference/wallets/create-wallet-alerts"},{"title":"Delete all wallet alerts","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml delete /customers/{external_customer_id}/wallets/{wallet_code}/alerts","href":"/api-reference/wallets/delete-all-wallet-alerts"},{"title":"Retrieve a wallet alert","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /customers/{external_customer_id}/wallets/{wallet_code}/alerts/{code}","href":"/api-reference/wallets/retrieve-a-wallet-alert"},{"title":"Update a wallet alert","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml put /customers/{external_customer_id}/wallets/{wallet_code}/alerts/{code}","href":"/api-reference/wallets/update-a-wallet-alert"},{"title":"Delete a wallet alert","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml delete /customers/{external_customer_id}/wallets/{wallet_code}/alerts/{code}","href":"/api-reference/wallets/delete-a-wallet-alert"},{"title":"Create a wallet","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /wallets","href":"/api-reference/wallets/create-a-wallet"},{"title":"List all wallets","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /wallets","href":"/api-reference/wallets/list-all-wallets"},{"title":"Update a wallet","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml put /wallets/{id}","href":"/api-reference/wallets/update-a-wallet"},{"title":"Retrieve a wallet","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /wallets/{id}","href":"/api-reference/wallets/retrieve-a-wallet"},{"title":"Terminate a wallet","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml delete /wallets/{id}","href":"/api-reference/wallets/terminate-a-wallet"},{"title":"Replace wallet metadata","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /wallets/{id}/metadata","href":"/api-reference/wallets/replace-wallet-metadata"},{"title":"Merge wallet metadata","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml patch /wallets/{id}/metadata","href":"/api-reference/wallets/merge-wallet-metadata"},{"title":"Delete all wallet metadata","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml delete /wallets/{id}/metadata","href":"/api-reference/wallets/delete-all-wallet-metadata"},{"title":"Delete a metadata key","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml delete /wallets/{id}/metadata/{key}","href":"/api-reference/wallets/delete-a-metadata-key"},{"title":"Top up a wallet","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /wallet_transactions","href":"/api-reference/wallets/top-up-a-wallet"},{"title":"Retrieve a wallet transaction","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /wallet_transactions/{id}","href":"/api-reference/wallets/retrieve-a-wallet-transaction"},{"title":"Generate a payment URL","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /wallet_transactions/{id}/payment_url","href":"/api-reference/wallets/generate-a-payment-url"},{"title":"List all consumptions for a wallet transaction","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /wallet_transactions/{id}/consumptions","href":"/api-reference/wallets/list-all-consumptions-for-a-wallet-transaction"},{"title":"List all fundings for a wallet transaction","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /wallet_transactions/{id}/fundings","href":"/api-reference/wallets/list-all-fundings-for-a-wallet-transaction"},{"title":"List all wallet transactions","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /wallets/{id}/wallet_transactions","href":"/api-reference/wallets/list-all-wallet-transactions"}]},{"group":"Coupons","expanded":false,"pages":[{"title":"Apply a coupon to a customer","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /applied_coupons","href":"/api-reference/coupons/apply-a-coupon-to-a-customer"},{"title":"List all applied coupons","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /applied_coupons","href":"/api-reference/coupons/list-all-applied-coupons"},{"title":"Create a coupon","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /coupons","href":"/api-reference/coupons/create-a-coupon"},{"title":"List all coupons","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /coupons","href":"/api-reference/coupons/list-all-coupons"},{"title":"Update a coupon","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml put /coupons/{code}","href":"/api-reference/coupons/update-a-coupon"},{"title":"Retrieve a coupon","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /coupons/{code}","href":"/api-reference/coupons/retrieve-a-coupon"},{"title":"Delete a coupon","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml delete /coupons/{code}","href":"/api-reference/coupons/delete-a-coupon"},{"title":"List all customer's applied coupons","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /customers/{external_customer_id}/applied_coupons","href":"/api-reference/customers/list-all-customers-applied-coupons"},{"title":"Delete an applied coupon","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml delete /customers/{external_customer_id}/applied_coupons/{applied_coupon_id}","href":"/api-reference/coupons/delete-an-applied-coupon"}]},{"group":"Add-ons","expanded":false,"pages":[{"title":"Create an add-on","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /add_ons","href":"/api-reference/add-ons/create-an-add-on"},{"title":"List all add-ons","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /add_ons","href":"/api-reference/add-ons/list-all-add-ons"},{"title":"Update an add-on","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml put /add_ons/{code}","href":"/api-reference/add-ons/update-an-add-on"},{"title":"Retrieve an add-on","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /add_ons/{code}","href":"/api-reference/add-ons/retrieve-an-add-on"},{"title":"Delete an add-on","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml delete /add_ons/{code}","href":"/api-reference/add-ons/delete-an-add-on"}]},{"group":"Credit Notes","expanded":false,"pages":[{"title":"Create a credit note","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /credit_notes","href":"/api-reference/credit-notes/create-a-credit-note"},{"title":"List all credit notes","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /credit_notes","href":"/api-reference/credit-notes/list-all-credit-notes"},{"title":"Update a credit note","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml put /credit_notes/{id}","href":"/api-reference/credit-notes/update-a-credit-note"},{"title":"Retrieve a credit note","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /credit_notes/{id}","href":"/api-reference/credit-notes/retrieve-a-credit-note"},{"title":"Download a credit note PDF","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /credit_notes/{id}/download","href":"/api-reference/credit-notes/download-a-credit-note-pdf"},{"title":"Estimate amounts for a new credit note","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /credit_notes/estimate","href":"/api-reference/credit-notes/estimate-amounts-for-a-new-credit-note"},{"title":"Void available credit","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml put /credit_notes/{id}/void","href":"/api-reference/credit-notes/void-available-credit"},{"title":"Replace credit note metadata","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /credit_notes/{id}/metadata","href":"/api-reference/credit-notes/replace-credit-note-metadata"},{"title":"Merge credit note metadata","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml patch /credit_notes/{id}/metadata","href":"/api-reference/credit-notes/merge-credit-note-metadata"},{"title":"Delete all credit note metadata","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml delete /credit_notes/{id}/metadata","href":"/api-reference/credit-notes/delete-all-credit-note-metadata"},{"title":"Delete a metadata key","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml delete /credit_notes/{id}/metadata/{key}","href":"/api-reference/credit-notes/delete-a-metadata-key"},{"title":"List all customer's credit notes","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /customers/{external_customer_id}/credit_notes","href":"/api-reference/customers/list-all-customers-credit-notes"}]},{"group":"Taxes","expanded":false,"pages":[{"title":"Create a tax","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /taxes","href":"/api-reference/taxes/create-a-tax"},{"title":"List all taxes","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /taxes","href":"/api-reference/taxes/list-all-taxes"},{"title":"Update a tax","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml put /taxes/{code}","href":"/api-reference/taxes/update-a-tax"},{"title":"Retrieve a Tax","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /taxes/{code}","href":"/api-reference/taxes/retrieve-a-tax"},{"title":"Delete a tax","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml delete /taxes/{code}","href":"/api-reference/taxes/delete-a-tax"}]},{"group":"Payments","expanded":false,"pages":[{"title":"List all customer's payments","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /customers/{external_customer_id}/payments","href":"/api-reference/customers/list-all-customers-payments"},{"title":"Create a payment","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /payments","href":"/api-reference/payments/create-a-payment"},{"title":"List all payments","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /payments","href":"/api-reference/payments/list-all-payments"},{"title":"Retrieve a payment","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /payments/{id}","href":"/api-reference/payments/retrieve-a-payment"}]},{"group":"Payment Methods","expanded":false,"pages":[{"title":"List all customer payment methods","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /customers/{external_customer_id}/payment_methods","href":"/api-reference/payment-methods/list-all-customer-payment-methods"},{"title":"Set the payment method as default","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml put /customers/{external_customer_id}/payment_methods/{id}/set_as_default","href":"/api-reference/payment-methods/set-the-payment-method-as-default"},{"title":"Delete a payment method","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml delete /customers/{external_customer_id}/payment_methods/{id}","href":"/api-reference/payment-methods/delete-a-payment-method"}]},{"group":"Payment Receipts","expanded":false,"pages":[{"title":"List all payment receipts","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /payment_receipts","href":"/api-reference/payment-receipts/list-all-payment-receipts"},{"title":"Retrieve a payment receipt","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /payment_receipts/{id}","href":"/api-reference/payment-receipts/retrieve-a-payment-receipt"}]},{"group":"Payment Requests","expanded":false,"pages":[{"title":"List all customer's payment requests","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /customers/{external_customer_id}/payment_requests","href":"/api-reference/customers/list-all-customers-payment-requests"},{"title":"Create a payment request","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /payment_requests","href":"/api-reference/payment-requests/create-a-payment-request"},{"title":"List all payment requests","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /payment_requests","href":"/api-reference/payment-requests/list-all-payment-requests"},{"title":"Retrieve a payment request","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /payment_requests/{id}","href":"/api-reference/payment-requests/retrieve-a-payment-request"}]}]},{"group":"Platform \u0026 Operations","pages":[{"group":"Billing Entities","expanded":false,"pages":[{"title":"List all billing entities","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /billing_entities","href":"/api-reference/billing-entities/list-all-billing-entities"},{"title":"Create a billing entity","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /billing_entities","href":"/api-reference/billing-entities/create-a-billing-entity"},{"title":"Retrieve a billing entity","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /billing_entities/{code}","href":"/api-reference/billing-entities/retrieve-a-billing-entity"},{"title":"Update a billing entity","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml put /billing_entities/{code}","href":"/api-reference/billing-entities/update-a-billing-entity"}]},{"group":"Webhook Endpoints","expanded":false,"pages":[{"title":"Create a webhook_endpoint","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml post /webhook_endpoints","href":"/api-reference/webhook-endpoints/create-a-webhook_endpoint"},{"title":"List all webhook endpoints","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /webhook_endpoints","href":"/api-reference/webhook-endpoints/list-all-webhook-endpoints"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml put /webhook_endpoints/{id}","href":"/api-reference/webhook-endpoints/update-a-webhook-endpoint"},{"title":"Retrieve a webhook endpoint","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /webhook_endpoints/{id}","href":"/api-reference/webhook-endpoints/retrieve-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml delete /webhook_endpoints/{id}","href":"/api-reference/webhook-endpoints/delete-a-webhook-endpoint"}]},{"group":"Webhook Keys","expanded":false,"pages":[{"title":"Retrieve webhook public key as JSON","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /webhooks/json_public_key","href":"/api-reference/webhooks/retrieve-webhook-public-key-as-json"},{"title":"Retrieve webhook public key","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /webhooks/public_key","href":"/api-reference/webhooks/retrieve-webhook-public-key"}]},{"group":"Webhook Events","expanded":false,"pages":[{"group":"Alerts","expanded":false,"pages":[{"title":"A new alert was triggered","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook alert_triggered","href":"/api-reference/a-new-alert-was-triggered"}]},{"group":"Customers","expanded":false,"pages":[{"title":"A new customer has been created","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook customer_created","href":"/api-reference/a-new-customer-has-been-created"},{"title":"A customer has been updated","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook customer_updated","href":"/api-reference/a-customer-has-been-updated"},{"title":"A customer was created on an accouting integration","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook customer_accounting_provider_created","href":"/api-reference/a-customer-was-created-on-an-accouting-integration"},{"title":"An error was encountered while syncing a customer to an accounting provider","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook customer_accounting_provider_error","href":"/api-reference/an-error-was-encountered-while-syncing-a-customer-to-an-accounting-provider"},{"title":"A customer has been created in a crm integration","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook customer_crm_provider_created","href":"/api-reference/a-customer-has-been-created-in-a-crm-integration"},{"title":"Syncing a customer to a crm integration has failed","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook customer_crm_provider_error","href":"/api-reference/syncing-a-customer-to-a-crm-integration-has-failed"},{"title":"A customer has been created on a payment provider","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook customer_payment_provider_created","href":"/api-reference/a-customer-has-been-created-on-a-payment-provider"},{"title":"An error was encountered while syncing a customer to a payment provider","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook customer_payment_provider_error","href":"/api-reference/an-error-was-encountered-while-syncing-a-customer-to-a-payment-provider"},{"title":"A checkout url was generated for a customer","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook customer_checkout_url_generated","href":"/api-reference/a-checkout-url-was-generated-for-a-customer"},{"title":"An error was encountered while fetching taxes for a customer on a tax provider","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook customer_tax_provider_error","href":"/api-reference/an-error-was-encountered-while-fetching-taxes-for-a-customer-on-a-tax-provider"},{"title":"Vies vat number has been checked for a customer","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook customer_vies_check","href":"/api-reference/vies-vat-number-has-been-checked-for-a-customer"}]},{"group":"Credit Notes","expanded":false,"pages":[{"title":"A new credit note has been created","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook credit_note_created","href":"/api-reference/a-new-credit-note-has-been-created"},{"title":"A new credit note pdf has been generated","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook credit_note_generated","href":"/api-reference/a-new-credit-note-pdf-has-been-generated"},{"title":"The refund of a credit note has failed on a payment provider","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook credit_note_provider_refund_failure","href":"/api-reference/the-refund-of-a-credit-note-has-failed-on-a-payment-provider"}]},{"group":"Dunning Campaigns","expanded":false,"pages":[{"title":"The dunning campaign has been completed for a customer","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook dunning_campaign_finished","href":"/api-reference/the-dunning-campaign-has-been-completed-for-a-customer"}]},{"group":"Event Ingestion","expanded":false,"pages":[{"title":"An error has been detected on an event","version":null,"deprecated":true,"openapi":"/nozle-openapi.yaml webhook event_error","href":"/api-reference/an-error-has-been-detected-on-an-event"},{"title":"Errors were encountered while post processing some events","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook events_errors","href":"/api-reference/errors-were-encountered-while-post-processing-some-events"}]},{"group":"Features","expanded":false,"pages":[{"title":"A new feature has been created","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook feature_created","href":"/api-reference/a-new-feature-has-been-created"},{"title":"A feature has been updated","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook feature_updated","href":"/api-reference/a-feature-has-been-updated"},{"title":"A feature has been deleted","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook feature_deleted","href":"/api-reference/a-feature-has-been-deleted"}]},{"group":"Subscriptions and Fees","expanded":false,"pages":[{"title":"A pay in advance fee has been created","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook fee_created","href":"/api-reference/a-pay-in-advance-fee-has-been-created"},{"title":"An error was encountered while fetching taxes for a fee on a tax provider","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook fee_tax_provider_error","href":"/api-reference/an-error-was-encountered-while-fetching-taxes-for-a-fee-on-a-tax-provider"},{"title":"A subscription has been canceled","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook subscription_canceled","href":"/api-reference/a-subscription-has-been-canceled"},{"title":"A subscription is incomplete and waiting for payment","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook subscription_incomplete","href":"/api-reference/a-subscription-is-incomplete-and-waiting-for-payment"},{"title":"A subscription has been terminated","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook subscription_terminated","href":"/api-reference/a-subscription-has-been-terminated"},{"title":"An subscription has started","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook subscription_started","href":"/api-reference/an-subscription-has-started"},{"title":"A subscription has been updated","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook subscription_updated","href":"/api-reference/a-subscription-has-been-updated"},{"title":"A subscription will be terminated in the future","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook subscription_termination_alert","href":"/api-reference/a-subscription-will-be-terminated-in-the-future"},{"title":"A subscription trial period has ended","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook subscription_trial_ended","href":"/api-reference/a-subscription-trial-period-has-ended"},{"title":"A usage threshold has been reached by a subscription","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook subscription_usage_threshold_reached","href":"/api-reference/a-usage-threshold-has-been-reached-by-a-subscription"}]},{"group":"Invoices","expanded":false,"pages":[{"title":"A new invoice has been emitted","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook invoice_created","href":"/api-reference/a-new-invoice-has-been-emitted"},{"title":"A new one off invoice has been emitted","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook invoice_one_off_created","href":"/api-reference/a-new-one-off-invoice-has-been-emitted"},{"title":"A new prepaid credit invoice has been emitted","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook invoice_paid_credit_added","href":"/api-reference/a-new-prepaid-credit-invoice-has-been-emitted"},{"title":"A new invoice pdf has been generated","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook invoice_generated","href":"/api-reference/a-new-invoice-pdf-has-been-generated"},{"title":"A new draft invoice has been emitted","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook invoice_drafted","href":"/api-reference/a-new-draft-invoice-has-been-emitted"},{"title":"An invoice has been voided","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook invoice_voided","href":"/api-reference/an-invoice-has-been-voided"},{"title":"A payment dispute has been lost for an invoice payment","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook invoice_payment_dispute_lost","href":"/api-reference/a-payment-dispute-has-been-lost-for-an-invoice-payment"},{"title":"The payment status of an invoice has been updated","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook payment_request_payment_status_updated","href":"/api-reference/the-payment-status-of-an-invoice-has-been-updated"},{"title":"An invoice payment is overdue","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook invoice_payment_overdue","href":"/api-reference/an-invoice-payment-is-overdue"},{"title":"A payment attempt for an invoice has failed on a payment provider","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook invoice_payment_failure","href":"/api-reference/a-payment-attempt-for-an-invoice-has-failed-on-a-payment-provider"},{"title":"An invoice has been synced again to a crm integration","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook invoice_resynced","href":"/api-reference/an-invoice-has-been-synced-again-to-a-crm-integration"}]},{"group":"Integrations","expanded":false,"pages":[{"title":"An error was encountered while processing data on an integration","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook integration_provider_error","href":"/api-reference/an-error-was-encountered-while-processing-data-on-an-integration"}]},{"group":"Quotes","expanded":false,"pages":[{"title":"An order has been created","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook order_created","href":"/api-reference/an-order-has-been-created"},{"title":"An order has been executed","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook order_executed","href":"/api-reference/an-order-has-been-executed"},{"title":"An order has failed","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook order_failed","href":"/api-reference/an-order-has-failed"},{"title":"An order form has been created","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook order_form_created","href":"/api-reference/an-order-form-has-been-created"},{"title":"An order form has been signed","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook order_form_signed","href":"/api-reference/an-order-form-has-been-signed"},{"title":"An order form has expired","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook order_form_expired","href":"/api-reference/an-order-form-has-expired"},{"title":"An order form has been voided","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook order_form_voided","href":"/api-reference/an-order-form-has-been-voided"},{"title":"A quote has been created","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook quote_created","href":"/api-reference/a-quote-has-been-created"},{"title":"A quote has been approved","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook quote_approved","href":"/api-reference/a-quote-has-been-approved"},{"title":"A quote has been voided","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook quote_voided","href":"/api-reference/a-quote-has-been-voided"}]},{"group":"Payments","expanded":false,"pages":[{"title":"A payment has been successfully processed","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook payment_succeeded","href":"/api-reference/a-payment-has-been-successfully-processed"},{"title":"An action is required to process a payment","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook payment_requires_action","href":"/api-reference/an-action-is-required-to-process-a-payment"},{"title":"An error was raised by a payment provider","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook payment_provider_error","href":"/api-reference/an-error-was-raised-by-a-payment-provider"},{"title":"An new payment request has been created","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook payment_request_created","href":"/api-reference/an-new-payment-request-has-been-created"},{"title":"A payment attempt for a payment request has failed on a payment provider","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook payment_request_payment_failure","href":"/api-reference/a-payment-attempt-for-a-payment-request-has-failed-on-a-payment-provider"},{"title":"The payment status of an invoice has been updated","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook payment_request_payment_status_updated","href":"/api-reference/the-payment-status-of-an-invoice-has-been-updated"},{"title":"A paid plan change needs review","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook plan_upgrade_intent_needs_review","href":"/api-reference/a-paid-plan-change-needs-review"}]},{"group":"Payment Receipts","expanded":false,"pages":[{"title":"A payment receipt has been created","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook payment_receipt_created","href":"/api-reference/a-payment-receipt-has-been-created"},{"title":"A payment receipt pdf has been generated","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook payment_receipt_generated","href":"/api-reference/a-payment-receipt-pdf-has-been-generated"}]},{"group":"Plans","expanded":false,"pages":[{"title":"A new plan has been created","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook plan_created","href":"/api-reference/a-new-plan-has-been-created"},{"title":"A plan has been updated","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook plan_updated","href":"/api-reference/a-plan-has-been-updated"},{"title":"A plan version has been created","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook plan_version_created","href":"/api-reference/a-plan-version-has-been-created"},{"title":"A plan has been deleted","description":"A plan is deleted.","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook plan_deleted","href":"/api-reference/a-plan-has-been-deleted"}]},{"group":"Wallets and Credits","expanded":false,"pages":[{"title":"The credits of a paid top up can be spent","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook credit_top_up_purchase_fulfilled","href":"/api-reference/the-credits-of-a-paid-top-up-can-be-spent"},{"title":"A wallet has been created","description":"A wallet is created.","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook wallet_created","href":"/api-reference/a-wallet-has-been-created"},{"title":"The balance of a wallet has been depleted","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook wallet_depleted_ongoing_balance","href":"/api-reference/the-balance-of-a-wallet-has-been-depleted"},{"title":"A wallet has been terminated","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook wallet_terminated","href":"/api-reference/a-wallet-has-been-terminated"},{"title":"A wallet has been updated","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook wallet_updated","href":"/api-reference/a-wallet-has-been-updated"},{"title":"A new wallet transaction has been created","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook wallet_transaction_created","href":"/api-reference/a-new-wallet-transaction-has-been-created"},{"title":"A wallet transaction has been updated","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook wallet_transaction_updated","href":"/api-reference/a-wallet-transaction-has-been-updated"},{"title":"A payment attempt for a wallet transaction has failed on a payment provider","version":null,"deprecated":null,"openapi":"/nozle-openapi.yaml webhook wallet_transaction_payment_failure","href":"/api-reference/a-payment-attempt-for-a-wallet-transaction-has-failed-on-a-payment-provider"}]}]},{"group":"Organizations","expanded":false,"pages":[{"title":"Update your organization","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml put /organizations","href":"/api-reference/organizations/update-your-organization"}]},{"group":"Analytics","expanded":false,"pages":[{"title":"List gross revenue","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /analytics/gross_revenue","href":"/api-reference/analytics/list-gross-revenue"},{"title":"List of finalized invoices","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /analytics/invoice_collection","href":"/api-reference/analytics/list-of-finalized-invoices"},{"title":"List usage revenue","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /analytics/invoiced_usage","href":"/api-reference/analytics/list-usage-revenue"},{"title":"List MRR","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /analytics/mrr","href":"/api-reference/analytics/list-mrr"},{"title":"List overdue balance","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /analytics/overdue_balance","href":"/api-reference/analytics/list-overdue-balance"},{"title":"List usage","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /analytics/usage","href":"/api-reference/analytics/list-usage"}]},{"group":"Activity Logs","expanded":false,"pages":[{"title":"List all activity logs","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /activity_logs","href":"/api-reference/activity-logs/list-all-activity-logs"},{"title":"Retrieve an activity log","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /activity_logs/{activity_id}","href":"/api-reference/activity-logs/retrieve-an-activity-log"}]},{"group":"API Logs","expanded":false,"pages":[{"title":"List all api logs","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /api_logs","href":"/api-reference/api-logs/list-all-api-logs"},{"title":"Retrieve an api log","deprecated":null,"version":null,"openapi":"/nozle-openapi.yaml get /api_logs/{request_id}","href":"/api-reference/api-logs/retrieve-an-api-log"}]}]}]},{"tab":"SDKs","dropdowns":[{"dropdown":"React SDK","icon":{"style":"brands","name":"react"},"groups":[{"group":"Setup","pages":[{"title":"Installation","href":"/sdks/react/installation"},{"title":"Appearance","href":"/sdks/react/styling"}]},{"group":"Components","pages":[{"title":"Components","sidebarTitle":"Overview","href":"/sdks/react/components"},{"group":"Pricing","pages":[{"title":"PricingTable","href":"/sdks/react/components/pricing-table"},{"title":"PlanCard","href":"/sdks/react/components/plan-card"},{"title":"PlanComparison","href":"/sdks/react/components/plan-comparison"}]},{"group":"Checkout","pages":[{"title":"CheckoutButton","href":"/sdks/react/components/checkout-button"},{"title":"Checkout","href":"/sdks/react/components/checkout"}]},{"group":"Plan change","pages":[{"title":"UpgradeButton","href":"/sdks/react/components/upgrade-button"},{"title":"UpgradeModal","href":"/sdks/react/components/upgrade-modal"},{"title":"PlanChangeControl","href":"/sdks/react/components/plan-change-control"},{"title":"CancellationControl","href":"/sdks/react/components/cancellation-control"}]},{"group":"Billing display","pages":[{"title":"CurrentPlan","href":"/sdks/react/components/current-plan"},{"title":"PlanBadge","href":"/sdks/react/components/plan-badge"},{"title":"PaymentMethodDisplay","href":"/sdks/react/components/payment-method-display"},{"title":"BillingPortal","href":"/sdks/react/components/billing-portal"},{"title":"PoweredByNozle","href":"/sdks/react/components/powered-by-nozle"}]},{"group":"Usage","pages":[{"title":"UsageMeter","href":"/sdks/react/components/usage-meter"},{"title":"UsageDashboard","href":"/sdks/react/components/usage-dashboard"},{"title":"UsageAlert","href":"/sdks/react/components/usage-alert"},{"title":"UsageBreakdown","href":"/sdks/react/components/usage-breakdown"},{"title":"UsageTrend","href":"/sdks/react/components/usage-trend"}]},{"group":"Credits","pages":[{"title":"CreditBalance","href":"/sdks/react/components/credit-balance"},{"title":"CreditHistory","href":"/sdks/react/components/credit-history"}]},{"group":"Access control","pages":[{"title":"FeatureGate","href":"/sdks/react/components/feature-gate"},{"title":"PlanGate","href":"/sdks/react/components/plan-gate"},{"title":"UsageGate","href":"/sdks/react/components/usage-gate"},{"title":"UpgradePrompt","href":"/sdks/react/components/upgrade-prompt"},{"title":"LockedOverlay","href":"/sdks/react/components/locked-overlay"}]}]},{"group":"Billing","pages":[{"title":"Billing portal and self-service","href":"/sdks/react/billing-portal"},{"title":"Provider and hooks","href":"/sdks/react/hooks"}]},{"group":"Entitlements","pages":[{"title":"Feature gates","href":"/sdks/react/gates"}]}]},{"dropdown":"Node.js SDK","icon":{"style":"brands","name":"node-js"},"groups":[{"group":"Setup","pages":[{"title":"Installation","href":"/sdks/node/installation"},{"title":"Errors and retries","href":"/sdks/node/errors"}]},{"group":"Billing","pages":[{"title":"Billing and subscriptions","href":"/sdks/node/billing"},{"title":"Tracking events","href":"/sdks/node/tracking-events"},{"title":"Product credits","href":"/sdks/node/credits"}]},{"group":"Customers","pages":[{"title":"Customers and Entities","href":"/sdks/node/customers-entities"}]},{"group":"Entitlements","pages":[{"title":"Entitlements","href":"/sdks/node/entitlements"}]},{"group":"Margin Intelligence","pages":[{"title":"Margin queries","href":"/sdks/node/margin-queries"}]},{"group":"LLM Usage","pages":[{"title":"LLM auto-capture","href":"/sdks/node/llm-auto-capture"}]}]},{"dropdown":"Python SDK","icon":{"style":"brands","name":"python"},"groups":[{"group":"Setup","pages":[{"title":"Installation","href":"/sdks/python/installation"},{"title":"Errors and retries","href":"/sdks/python/errors"}]},{"group":"Billing","pages":[{"title":"Billing and subscriptions","href":"/sdks/python/billing"},{"title":"Tracking events","href":"/sdks/python/tracking-events"},{"title":"Product credits","href":"/sdks/python/credits"}]},{"group":"Customers","pages":[{"title":"Customers and Entities","href":"/sdks/python/customers-entities"}]},{"group":"Entitlements","pages":[{"title":"Entitlements","href":"/sdks/python/entitlements"}]},{"group":"Margin Intelligence","pages":[{"title":"Margin queries","href":"/sdks/python/margin-queries"}]},{"group":"LLM Usage","pages":[{"title":"LLM auto-capture","href":"/sdks/python/llm-auto-capture"}]}]},{"dropdown":"Go SDK","icon":{"style":"brands","name":"golang"},"groups":[{"group":"Setup","pages":[{"title":"Installation","href":"/sdks/go/installation"},{"title":"Errors and retries","href":"/sdks/go/errors"}]},{"group":"Billing","pages":[{"title":"Billing and subscriptions","href":"/sdks/go/billing"},{"title":"Tracking events","href":"/sdks/go/tracking-events"},{"title":"Product credits","href":"/sdks/go/credits"}]},{"group":"Customers","pages":[{"title":"Customers and Entities","href":"/sdks/go/customers-entities"}]},{"group":"Entitlements","pages":[{"title":"Entitlements","href":"/sdks/go/entitlements"}]},{"group":"Margin Intelligence","pages":[{"title":"Margin queries","href":"/sdks/go/margin-queries"}]},{"group":"LLM Usage","pages":[{"title":"LLM auto-capture","href":"/sdks/go/llm-usage"}]}]}]},{"tab":"AI Coding Agents","pages":[{"title":"AI Coding Agents","href":"/guides/agent-kit/overview"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"title":"The credits of a paid top up can be spent - Nozle","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}