In one read: the enrollment, the balance of each meter, live subscriptions (with their items) and current-period usage. Use it to render the customer’s panel or to decide, before serving a request, whether they still have balance.
customerID here is the enrollment ID, not the customer ID.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Infi","colors":{"primary":"#0A1430","light":"#E2B13C","dark":"#0A1430"},"logo":{"light":"https://mintcdn.com/beinfi/owBheEE6vXSyqXTj/logo/logo.svg?fit=max\u0026auto=format\u0026n=owBheEE6vXSyqXTj\u0026q=85\u0026s=b1b9ce09a8814e42032ef2bf2c08fb54","dark":"https://mintcdn.com/beinfi/owBheEE6vXSyqXTj/logo/logo.svg?fit=max\u0026auto=format\u0026n=owBheEE6vXSyqXTj\u0026q=85\u0026s=b1b9ce09a8814e42032ef2bf2c08fb54","href":"https://beinfi.com"},"favicon":"https://mintcdn.com/beinfi/owBheEE6vXSyqXTj/favicon.svg?fit=max\u0026auto=format\u0026n=owBheEE6vXSyqXTj\u0026q=85\u0026s=cbb3280c14965b007e9662521134e88c","api":{"playground":{"display":"interactive"}},"navbar":{"links":[{"href":"https://app-sandbox.beinfi.com","label":"Sandbox"}],"primary":{"type":"button","label":"Começar","href":"https://app.beinfi.com"}},"footer":{"socials":{"website":"https://beinfi.com"}},"styling":{"latex":true},"navigation":{"languages":[{"language":"pt-BR","default":true,"href":"introducao"},{"language":"en","href":"en/introducao"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"beinfi","hasAudioNarration":false,"actualSubdomain":"beinfi","customDomains":["docs.beinfi.com"],"gitSource":{"type":"github","owner":"be-infinitum","repo":"infi","deployBranch":"main","contentDirectory":"infi-docs","isPrivate":true,"mountPath":"","label":"","_id":"6adfafa06d56e5c194b62908"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6ae91a58c27bfbde36d8601a","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"pt-BR","tag":"Referência da API","count":72},{"language":"en","tag":"API reference","count":72},{"language":"pt-BR","tag":"Catálogo","count":21},{"language":"en","tag":"Catalog","count":21},{"language":"pt-BR","tag":"Guias","count":17},{"language":"en","tag":"Guides","count":17},{"language":"pt-BR","tag":"Começar","count":13},{"language":"en","tag":"Get started","count":13},{"language":"pt-BR","tag":"Clientes","count":8},{"language":"pt-BR","tag":"Faturas","count":8},{"language":"en","tag":"Customers","count":8},{"language":"en","tag":"Invoices","count":8},{"language":"pt-BR","tag":"Webhooks","count":7},{"language":"en","tag":"Webhooks","count":7},{"language":"pt-BR","tag":"Conta","count":5},{"language":"pt-BR","tag":"Cupons","count":5},{"language":"pt-BR","tag":"Pagamentos","count":5},{"language":"en","tag":"Account","count":5},{"language":"en","tag":"Coupons","count":5},{"language":"en","tag":"Payments","count":5}]},"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":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"en/api-reference/customers/get-customer-state","slug":"/en/api-reference/customers/get-customer-state","pageMetadata":{"title":"Get customer state","description":"In one read: the enrollment, the balance of each meter, live subscriptions (with their items) and current-period usage. Use it to render the customer's panel or to decide, before serving a request, whether they still have balance.\n`customerID` here is the enrollment ID, not the customer ID.\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /customers/{customerID}/state","href":"/en/api-reference/customers/get-customer-state","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: [\"In one read: the enrollment, the balance of each meter, live subscriptions (with their items) and current-period usage. Use it to render the customer’s panel or to decide, before serving a request, whether they still have balance.\\n\", _jsx(_components.code, {\n children: \"customerID\"\n }), \" here is the enrollment ID, not the customer ID.\"]\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":"Get customer state","description":"In one read: the enrollment, the balance of each meter, live subscriptions (with their items) and current-period usage. Use it to render the customer's panel or to decide, before serving a request, whether they still have balance.\n`customerID` here is the enrollment ID, not the customer ID.\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /customers/{customerID}/state","href":"/en/api-reference/customers/get-customer-state","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Customers"],"operationId":"getCustomerState","responses":{"200":"949217a5-05e2-4c32-86dd-5d3da453d335","401":"d3a13fb0-a8c0-4b4e-9a1c-921737359622","404":"871f4764-b563-4db1-998f-68c68783bb93"},"summary":"Get customer state","description":"In one read: the enrollment, the balance of each meter, live subscriptions (with their items) and current-period usage. Use it to render the customer's panel or to decide, before serving a request, whether they still have balance.\n`customerID` here is the enrollment ID, not the customer ID.\n","method":"get","type":"path","servers":["32764daa-a0ab-4e11-9cce-071a6d157f12","8926f6ec-3b25-4b18-916e-1427c5952655"],"security":["6ad9c29e-e93e-4c8b-8dc5-5621a2b1f9da"],"path":"/customers/{customerID}/state","baseUrlOptions":["https://api-sandbox.beinfi.com","https://api.beinfi.com"],"title":"Get customer state","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"fdd432e0-de6b-43aa-8dff-7a4c0fed2347":{"name":"customerID","in":"path","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"description":"ID of the customer's enrollment in the product (not the customer ID).","uniqueKey":"","typeLabel":"string\u003cuuid>"},"description":"ID of the customer's enrollment in the product (not the customer ID)."}},"responses":{"949217a5-05e2-4c32-86dd-5d3da453d335":{"content":{"application/json":{"schema":{"type":"object","required":["customer","balances","subscriptions","usage","access"],"properties":{"customer":{"type":"object","required":["id","customerId","productId","externalId","metadata","creditAlertSent","createdAt"],"properties":{"id":{"type":"string","format":"uuid","description":"Enrollment ID. This is the one billing and usage calls expect.","isRequired":true,"uniqueKey":"customer.id","typeLabel":"string\u003cuuid>"},"customerId":{"type":"string","pattern":"^cus_[0-9A-Za-z]{22}$","example":"cus_6Tq0Y2rGJ1aQ9zXk3LmPbV","description":"Customer ID. Do not use it for billing and usage calls; use `id`.","isRequired":true,"uniqueKey":"customer.customerId","typeLabel":"string"},"productId":{"type":"string","pattern":"^prod_[0-9A-Za-z]{22}$","example":"prod_1d4YogBuw00jAySh5mbUpk","isRequired":true,"uniqueKey":"customer.productId","typeLabel":"string"},"externalId":{"type":"string","description":"The customer's id in your own system.","isRequired":true,"uniqueKey":"customer.externalId","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":true,"description":"The free-form data sent at enrollment.","isRequired":true,"uniqueKey":"customer.metadata","typeLabel":"object"},"creditAlertSent":{"type":"boolean","description":"Whether the low-balance alert has already been sent for this enrollment.","isRequired":true,"uniqueKey":"customer.creditAlertSent","typeLabel":"boolean"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"customer.createdAt","typeLabel":"string\u003cdate-time>"},"name":{"oneOf":[{"type":"string","uniqueKey":"customer.name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"customer.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.name","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","uniqueKey":"customer.email.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"customer.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.email","typeLabel":"string | null"},"taxId":{"oneOf":[{"type":"string","description":"CPF or CNPJ.","uniqueKey":"customer.taxId.oneOf.0","typeLabel":"string"},{"type":"null","description":"CPF or CNPJ.","uniqueKey":"customer.taxId.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.taxId","typeLabel":"string | null"},"pspRef":{"oneOf":[{"type":"string","description":"The customer's reference with the payment processor, when there is one.","uniqueKey":"customer.pspRef.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer's reference with the payment processor, when there is one.","uniqueKey":"customer.pspRef.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.pspRef","typeLabel":"string | null"}},"description":"The enrollment.","isRequired":true,"uniqueKey":"customer","typeLabel":"object"},"balances":{"type":"array","items":{"type":"object","required":["allowed","meter","balance","total"],"properties":{"meter":{"type":"string","description":"Meter key.","isRequired":true,"uniqueKey":"balances.items.[INDEX].meter","typeLabel":"string"},"balance":{"type":"string","description":"Current balance, as a decimal string. Can be negative.","isRequired":true,"uniqueKey":"balances.items.[INDEX].balance","typeLabel":"string"},"total":{"type":"string","description":"Total ever credited to this meter.","isRequired":true,"uniqueKey":"balances.items.[INDEX].total","typeLabel":"string"},"allowed":{"type":"boolean","isRequired":true,"uniqueKey":"balances.items.[INDEX].allowed","typeLabel":"boolean"}},"uniqueKey":"balances.items.[INDEX]","typeLabel":"object"},"description":"One balance per meter.","isRequired":true,"uniqueKey":"balances","typeLabel":"object[]"},"subscriptions":{"type":"array","items":{"type":"object","required":["id","customerId","productVersionId","status","billingCycle","billingMode","anchor","startedAt"],"properties":{"id":{"type":"string","pattern":"^sub_[0-9A-Za-z]{22}$","example":"sub_2Kp7rWqT0aLm4XcVb8NzJe","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].id","typeLabel":"string"},"customerId":{"type":"string","format":"uuid","description":"Enrollment ID.","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].customerId","typeLabel":"string\u003cuuid>"},"productVersionId":{"type":"string","format":"uuid","description":"The product version subscribed to. It sets the price billed, even if the product changes later.","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].productVersionId","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["trialing","active","past_due","paused","canceled"],"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"billingCycle":{"type":"string","enum":["weekly","monthly","annual"],"isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].billingCycle","typeLabel":"enum\u003cstring>"},"billingMode":{"type":"string","enum":["arrears","advance"],"description":"`advance` bills at the start of the period; `arrears`, at the end.","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].billingMode","typeLabel":"enum\u003cstring>"},"anchor":{"type":"string","format":"date-time","description":"Reference date the billing periods are counted from.","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].anchor","typeLabel":"string\u003cdate-time>"},"startedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].startedAt","typeLabel":"string\u003cdate-time>"},"collectionMethod":{"type":"string","enum":["charge_automatically","send_invoice"],"description":"`charge_automatically` charges on its own; `send_invoice` sends the invoice for the customer to pay.","uniqueKey":"subscriptions.items.[INDEX].collectionMethod","typeLabel":"enum\u003cstring>"},"nextBillingDate":{"oneOf":[{"type":"string","format":"date-time","description":"Next billing date.","uniqueKey":"subscriptions.items.[INDEX].nextBillingDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Next billing date.","uniqueKey":"subscriptions.items.[INDEX].nextBillingDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].nextBillingDate","typeLabel":"string\u003cdate-time> | null"},"canceledAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"subscriptions.items.[INDEX].canceledAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"subscriptions.items.[INDEX].canceledAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].canceledAt","typeLabel":"string\u003cdate-time> | null"},"cancelReason":{"type":"object","required":["code"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].cancelReason.code","typeLabel":"string"},"note":{"type":"string","uniqueKey":"subscriptions.items.[INDEX].cancelReason.note","typeLabel":"string"},"source":{"type":"string","enum":["buyer","merchant"],"uniqueKey":"subscriptions.items.[INDEX].cancelReason.source","typeLabel":"enum\u003cstring>"}},"uniqueKey":"subscriptions.items.[INDEX].cancelReason","typeLabel":"object"},"items":{"type":"array","items":{"type":"object","required":["id","kind","productVersionId","createdAt"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"kind":{"type":"string","enum":["recurring_fee","credit_grant","metered_usage","prepaid_usage"],"description":"`recurring_fee` is the fixed recurring fee; `credit_grant`, credits granted each cycle; `metered_usage`, usage billed afterwards; `prepaid_usage`, usage paid upfront.","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].kind","typeLabel":"enum\u003cstring>"},"productVersionId":{"type":"string","format":"uuid","description":"The product version the item comes from.","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].productVersionId","typeLabel":"string\u003cuuid>"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"timing":{"oneOf":[{"type":"string","enum":["advance","arrears",null],"description":"`advance` bills at the start of the period; `arrears`, at the end.","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].timing.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["advance","arrears",null],"description":"`advance` bills at the start of the period; `arrears`, at the end.","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].timing.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].timing","typeLabel":"enum\u003cstring> | null"},"canceledAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].canceledAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].canceledAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX].canceledAt","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"subscriptions.items.[INDEX].\\items.items.[INDEX]","typeLabel":"object"},"description":"What the subscription bills or grants.","uniqueKey":"subscriptions.items.[INDEX].\\items","typeLabel":"object[]"}},"uniqueKey":"subscriptions.items.[INDEX]","typeLabel":"object"},"description":"Live subscriptions, with their items.","isRequired":true,"uniqueKey":"subscriptions","typeLabel":"object[]"},"usage":{"type":"object","required":["customerId","from","to","meters"],"properties":{"customerId":{"type":"string","format":"uuid","description":"Enrollment ID.","isRequired":true,"uniqueKey":"usage.customerId","typeLabel":"string\u003cuuid>"},"from":{"type":"string","format":"date-time","description":"Window start.","isRequired":true,"uniqueKey":"usage.from","typeLabel":"string\u003cdate-time>"},"to":{"type":"string","format":"date-time","description":"Window end.","isRequired":true,"uniqueKey":"usage.to","typeLabel":"string\u003cdate-time>"},"meters":{"type":"array","items":{"type":"object","required":["meterId","meter","unit","totalValue","eventCount"],"properties":{"meterId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"usage.meters.items.[INDEX].meterId","typeLabel":"string\u003cuuid>"},"meter":{"type":"string","description":"Meter key.","isRequired":true,"uniqueKey":"usage.meters.items.[INDEX].meter","typeLabel":"string"},"unit":{"type":"string","description":"The meter's unit.","isRequired":true,"uniqueKey":"usage.meters.items.[INDEX].unit","typeLabel":"string"},"totalValue":{"type":"string","description":"Quantity summed over the window, as a decimal string.","isRequired":true,"uniqueKey":"usage.meters.items.[INDEX].totalValue","typeLabel":"string"},"eventCount":{"type":"integer","description":"How many events were recorded.","isRequired":true,"uniqueKey":"usage.meters.items.[INDEX].eventCount","typeLabel":"integer"},"totalAmount":{"oneOf":[{"type":"string","description":"Money value of that quantity at the applicable price. Null when the meter has no price.","uniqueKey":"usage.meters.items.[INDEX].totalAmount.oneOf.0","typeLabel":"string"},{"type":"null","description":"Money value of that quantity at the applicable price. Null when the meter has no price.","uniqueKey":"usage.meters.items.[INDEX].totalAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"usage.meters.items.[INDEX].totalAmount","typeLabel":"string | null"},"currency":{"oneOf":[{"type":"string","description":"Currency of `totalAmount`.","uniqueKey":"usage.meters.items.[INDEX].currency.oneOf.0","typeLabel":"string"},{"type":"null","description":"Currency of `totalAmount`.","uniqueKey":"usage.meters.items.[INDEX].currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"usage.meters.items.[INDEX].currency","typeLabel":"string | null"}},"uniqueKey":"usage.meters.items.[INDEX]","typeLabel":"object"},"description":"One total per meter.","isRequired":true,"uniqueKey":"usage.meters","typeLabel":"object[]"}},"description":"Current-period usage.","isRequired":true,"uniqueKey":"usage","typeLabel":"object"},"access":{"type":"array","items":{"type":"object","required":["productId","name","kind"],"properties":{"productId":{"type":"string","pattern":"^prod_[0-9A-Za-z]{22}$","example":"prod_1d4YogBuw00jAySh5mbUpk","isRequired":true,"uniqueKey":"access.items.[INDEX].productId","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"access.items.[INDEX].name","typeLabel":"string"},"kind":{"type":"string","enum":["purchase","subscription"],"isRequired":true,"uniqueKey":"access.items.[INDEX].kind","typeLabel":"enum\u003cstring>"},"key":{"type":"string","uniqueKey":"access.items.[INDEX].key","typeLabel":"string"},"subscriptionStatus":{"type":"string","enum":["active","trialing","past_due"],"uniqueKey":"access.items.[INDEX].subscriptionStatus","typeLabel":"enum\u003cstring>"},"renewsAt":{"type":"string","format":"date-time","uniqueKey":"access.items.[INDEX].renewsAt","typeLabel":"string\u003cdate-time>"},"cancelAtPeriodEnd":{"type":"boolean","uniqueKey":"access.items.[INDEX].cancelAtPeriodEnd","typeLabel":"boolean"}},"uniqueKey":"access.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"access","typeLabel":"object[]"}},"description":"The customer's state in one read: the enrollment, each meter's balance, live subscriptions and current-period usage.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"customer":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","customerId":"cus_6Tq0Y2rGJ1aQ9zXk3LmPbV","productId":"prod_1d4YogBuw00jAySh5mbUpk","externalId":"\u003cstring>","metadata":{},"creditAlertSent":true,"createdAt":"2023-11-07T05:31:56Z","name":"\u003cstring>","email":"\u003cstring>","taxId":"\u003cstring>","pspRef":"\u003cstring>"},"balances":[{"meter":"\u003cstring>","balance":"\u003cstring>","total":"\u003cstring>","allowed":true}],"subscriptions":[{"id":"sub_2Kp7rWqT0aLm4XcVb8NzJe","customerId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","productVersionId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","status":"trialing","billingCycle":"weekly","billingMode":"arrears","anchor":"2023-11-07T05:31:56Z","startedAt":"2023-11-07T05:31:56Z","collectionMethod":"charge_automatically","nextBillingDate":"2023-11-07T05:31:56Z","canceledAt":"2023-11-07T05:31:56Z","cancelReason":{"code":"\u003cstring>","note":"\u003cstring>","source":"buyer"},"items":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","kind":"recurring_fee","productVersionId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","createdAt":"2023-11-07T05:31:56Z","timing":"advance","canceledAt":"2023-11-07T05:31:56Z"}]}],"usage":{"customerId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","from":"2023-11-07T05:31:56Z","to":"2023-11-07T05:31:56Z","meters":[{"meterId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","meter":"\u003cstring>","unit":"\u003cstring>","totalValue":"\u003cstring>","eventCount":123,"totalAmount":"\u003cstring>","currency":"\u003cstring>"}]},"access":[{"productId":"prod_1d4YogBuw00jAySh5mbUpk","name":"\u003cstring>","kind":"purchase","key":"\u003cstring>","subscriptionStatus":"active","renewsAt":"2023-11-07T05:31:56Z","cancelAtPeriodEnd":true}]}}},"exampleType":"generated"}},"description":"Customer state.","exampleType":"generated"},"d3a13fb0-a8c0-4b4e-9a1c-921737359622":{"content":{"application/json":{"schema":{"type":"object","required":["message","error_code","tracer_id"],"properties":{"message":{"type":"string","description":"Human-readable sentence.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error_code":{"type":"string","examples":["internal_error","validation_failed","bad_request","unauthorized","forbidden","not_found","conflict","rate_limited"],"description":"Stable error code. Branch on it.","isRequired":true,"uniqueKey":"error_code","typeLabel":"string"},"tracer_id":{"type":"string","description":"Request id. Include it when contacting support.","isRequired":true,"uniqueKey":"tracer_id","typeLabel":"string"}},"description":"The standard error body. It is flat (no `error` wrapper) and the trace id is `tracer_id`.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","error_code":"internal_error","tracer_id":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Missing or invalid API key.","exampleType":"generated"},"871f4764-b563-4db1-998f-68c68783bb93":{"content":{"application/json":{"schema":{"type":"object","required":["message","error_code","tracer_id","resource"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error_code":{"type":"string","examples":["internal_error","validation_failed","bad_request","unauthorized","forbidden","not_found","conflict","rate_limited"],"description":"Stable error code. The list is open: besides the generic codes, each area defines its own (`coupon_expired`, `insufficient_balance`, `version_not_draft`, `idempotency_key_reused`…). Handle a code you do not recognize by its HTTP status and show `message`; do not fail parsing the response.","isRequired":true,"uniqueKey":"error_code","typeLabel":"string"},"tracer_id":{"type":"string","isRequired":true,"uniqueKey":"tracer_id","typeLabel":"string"},"resource":{"type":"string","isRequired":true,"uniqueKey":"resource","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","error_code":"internal_error","tracer_id":"\u003cstring>","resource":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Resource not found.","exampleType":"generated"}},"security":{"6ad9c29e-e93e-4c8b-8dc5-5621a2b1f9da":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Your account's secret key: `Authorization: Bearer sk_test_…` or `sk_live_…`. Server-side only.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"32764daa-a0ab-4e11-9cce-071a6d157f12":{"url":"https://api-sandbox.beinfi.com","description":"Sandbox"},"8926f6ec-3b25-4b18-916e-1427c5952655":{"url":"https://api.beinfi.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Your account's secret key: `Authorization: Bearer sk_test_…` or `sk_live_…`. Server-side only.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Your account's secret key: `Authorization: Bearer sk_test_…` or `sk_live_…`. Server-side only.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.en.json"},"subdomain":"beinfi","siteName":"Infi","title":"Get customer state - Infi","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"pt-BR":{"href":"/introducao","matchLevel":4},"en":{"href":"/en/api-reference/customers/get-customer-state","matchLevel":0}}},"lastModified":"2026-11-02T23:19:07.170Z","originalFileLocation":"en/api-reference/customers/get-customer-state.mdx","locale":"en"},"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=\"In one read: the enrollment, the balance of each meter, live subscriptions (with their items) and current-period usage. Use it to render the customer\u0026#x27;s panel or to decide, before serving a request, whether they still have balance. customerID here is the enrollment ID, not the customer ID.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Infi\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/beinfi/6L9ijlDVcq5aSfgL/_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/beinfi/6L9ijlDVcq5aSfgL/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/beinfi/6L9ijlDVcq5aSfgL/_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/beinfi/6L9ijlDVcq5aSfgL/_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/beinfi/6L9ijlDVcq5aSfgL/_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/beinfi/6L9ijlDVcq5aSfgL/_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/beinfi/6L9ijlDVcq5aSfgL/_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/beinfi/6L9ijlDVcq5aSfgL/_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/beinfi/6L9ijlDVcq5aSfgL/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get customer state - Infi\">\u003cmeta data-mint-head property=\"og:description\" content=\"In one read: the enrollment, the balance of each meter, live subscriptions (with their items) and current-period usage. Use it to render the customer\u0026#x27;s panel or to decide, before serving a request, whether they still have balance. customerID here is the enrollment ID, not the customer ID.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Infi\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.beinfi.com/en/api-reference/customers/get-customer-state\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://beinfi.mintlify.site/_mintlify/api/og/v2?division=Customers\u0026amp;title=Get+customer+state\u0026amp;description=In+one+read%3A+the+enrollment%2C+the+balance+of+each+meter%2C+live+subscriptions+%28with+their+items%29+and+current-period+usage.+Use+it+to+render+the+customer%27s+panel+or\u0026amp;theme=0f1e10ebee4743982aba108c\u0026amp;signature=bd6a393273acc8e78f36178853e3176001ebce7aa9861230a3117fa653e47c5c\">\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=\"Get customer state - Infi\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"In one read: the enrollment, the balance of each meter, live subscriptions (with their items) and current-period usage. Use it to render the customer\u0026#x27;s panel or to decide, before serving a request, whether they still have balance. customerID here is the enrollment ID, not the customer ID.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://beinfi.mintlify.site/_mintlify/api/og/v2?division=Customers\u0026amp;title=Get+customer+state\u0026amp;description=In+one+read%3A+the+enrollment%2C+the+balance+of+each+meter%2C+live+subscriptions+%28with+their+items%29+and+current-period+usage.+Use+it+to+render+the+customer%27s+panel+or\u0026amp;theme=0f1e10ebee4743982aba108c\u0026amp;signature=bd6a393273acc8e78f36178853e3176001ebce7aa9861230a3117fa653e47c5c\">\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/beinfi/6L9ijlDVcq5aSfgL/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Infi\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0A1430\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.beinfi.com/en/api-reference/customers/get-customer-state\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/en/api-reference/customers/get-customer-state.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.beinfi.com/#organization\",\"name\":\"Infi\",\"url\":\"https://docs.beinfi.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/beinfi/owBheEE6vXSyqXTj/logo/logo.svg?fit=max\u0026auto=format\u0026n=owBheEE6vXSyqXTj\u0026q=85\u0026s=b1b9ce09a8814e42032ef2bf2c08fb54\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.beinfi.com#website\",\"name\":\"Infi\",\"url\":\"https://docs.beinfi.com\",\"publisher\":{\"@id\":\"https://docs.beinfi.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.beinfi.com/en/api-reference/customers/get-customer-state#webpage\",\"url\":\"https://docs.beinfi.com/en/api-reference/customers/get-customer-state\",\"name\":\"Get customer state\",\"description\":\"In one read: the enrollment, the balance of each meter, live subscriptions (with their items) and current-period usage. Use it to render the customer's panel or to decide, before serving a request, whether they still have balance. customerID here is the enrollment ID, not the customer ID.\",\"dateModified\":\"2026-11-02T23:19:07.170Z\",\"isPartOf\":{\"@id\":\"https://docs.beinfi.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.beinfi.com/en/api-reference/customers/get-customer-state#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.beinfi.com/en/api-reference/customers/get-customer-state#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Customers\",\"item\":\"https://docs.beinfi.com/en/api-reference/customers/create-a-customer\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get customer state\",\"item\":\"https://docs.beinfi.com/en/api-reference/customers/get-customer-state\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.beinfi.com/en/api-reference/customers/get-customer-state#apireference\",\"headline\":\"Get customer state\",\"name\":\"Get customer state\",\"description\":\"In one read: the enrollment, the balance of each meter, live subscriptions (with their items) and current-period usage. Use it to render the customer's panel or to decide, before serving a request, whether they still have balance. customerID here is the enrollment ID, not the customer ID.\",\"url\":\"https://docs.beinfi.com/en/api-reference/customers/get-customer-state\",\"mainEntityOfPage\":{\"@id\":\"https://docs.beinfi.com/en/api-reference/customers/get-customer-state#webpage\"},\"dateModified\":\"2026-11-02T23:19:07.170Z\",\"publisher\":{\"@id\":\"https://docs.beinfi.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.beinfi.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Infi\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Infi","nav":{"global":null,"languages":[{"language":"pt-BR","default":true,"pages":[{"title":"pt-BR","href":"/introducao"}]},{"language":"en","tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/en/introducao"}]},{"tab":"API reference","groups":[{"group":"Checkout","pages":[{"title":"Read an invoice at checkout","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /pay/{slug}/invoices/{invoiceID}","href":"/en/api-reference/checkout/read-an-invoice-at-checkout"},{"title":"Pay an invoice at checkout","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /pay/{slug}/invoices/{invoiceID}/charge","href":"/en/api-reference/checkout/pay-an-invoice-at-checkout"},{"title":"Apply a coupon to an invoice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /pay/{slug}/invoices/{invoiceID}/coupon","href":"/en/api-reference/checkout/apply-a-coupon-to-an-invoice"},{"title":"Download a digital product","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /pay/{slug}/download/{token}","href":"/en/api-reference/checkout/download-a-digital-product"}]},{"group":"Test account","pages":[{"title":"Create a test account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /public/v1/claimables","href":"/en/api-reference/test-account/create-a-test-account"},{"title":"Get a test account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /public/v1/claimables/{claimableID}","href":"/en/api-reference/test-account/get-a-test-account"}]},{"group":"Catalog","pages":[{"title":"Prepare an image upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /catalog/images/presign","href":"/en/api-reference/catalog/prepare-an-image-upload"},{"title":"List products","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /products","href":"/en/api-reference/catalog/list-products"},{"title":"Create a product","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /products","href":"/en/api-reference/catalog/create-a-product"},{"title":"Get a product","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /products/{productID}","href":"/en/api-reference/catalog/get-a-product"},{"title":"Update a product","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json patch /products/{productID}","href":"/en/api-reference/catalog/update-a-product"},{"title":"List product versions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /products/{productID}/versions","href":"/en/api-reference/catalog/list-product-versions"},{"title":"Create a new version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /products/{productID}/versions","href":"/en/api-reference/catalog/create-a-new-version"},{"title":"Publish a version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /products/{productID}/versions/{versionID}/publish","href":"/en/api-reference/catalog/publish-a-version"},{"title":"List a version's prices","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /products/{productID}/versions/{versionID}/prices","href":"/en/api-reference/catalog/list-a-versions-prices"},{"title":"Add a price to a version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /products/{productID}/versions/{versionID}/prices","href":"/en/api-reference/catalog/add-a-price-to-a-version"},{"title":"List a product's meters","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /products/{productID}/meters","href":"/en/api-reference/catalog/list-a-products-meters"},{"title":"Create a meter","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /products/{productID}/meters","href":"/en/api-reference/catalog/create-a-meter"},{"title":"Create a link with a product","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /payment-links","href":"/en/api-reference/catalog/create-a-link-with-a-product"},{"title":"List a product's links","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /products/{productID}/payment-links","href":"/en/api-reference/catalog/list-a-products-links"},{"title":"Create a payment link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /products/{productID}/payment-links","href":"/en/api-reference/catalog/create-a-payment-link"},{"title":"Revoke a payment link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json delete /products/{productID}/payment-links/{linkID}","href":"/en/api-reference/catalog/revoke-a-payment-link"},{"title":"Update a meter","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json patch /products/{productID}/meters/{meterID}","href":"/en/api-reference/catalog/update-a-meter"},{"title":"Get a file upload URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /products/{productID}/deliverable/presign","href":"/en/api-reference/catalog/get-a-file-upload-url"},{"title":"Get the deliverable","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /products/{productID}/deliverable","href":"/en/api-reference/catalog/get-the-deliverable"},{"title":"Save the deliverable","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json put /products/{productID}/deliverable","href":"/en/api-reference/catalog/save-the-deliverable"},{"title":"Delete the deliverable","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json delete /products/{productID}/deliverable","href":"/en/api-reference/catalog/delete-the-deliverable"}]},{"group":"Customers","pages":[{"title":"Create a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /customers","href":"/en/api-reference/customers/create-a-customer"},{"title":"Enroll a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /products/{productID}/customers","href":"/en/api-reference/customers/enroll-a-customer"},{"title":"Get a customer","description":"Given a customer ID, returns the customer and all their enrollments (`CustomerDetail`). Given an enrollment ID, returns just that enrollment (`ProductCustomer`).\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /customers/{customerID}","href":"/en/api-reference/customers/get-a-customer"},{"title":"Get customer state","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /customers/{customerID}/state","href":"/en/api-reference/customers/get-customer-state"},{"title":"Get balances","description":"Returns the enrollment's balance for each meter, or for a single one when you send `meter`.\n`customerID` here is the enrollment ID.\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /customers/{customerID}/wallet","href":"/en/api-reference/customers/get-balances"},{"title":"List customer rate cards","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /customers/{customerID}/rate-cards","href":"/en/api-reference/customers/list-customer-rate-cards"},{"title":"Set a customer rate card","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /customers/{customerID}/rate-cards","href":"/en/api-reference/customers/set-a-customer-rate-card"},{"title":"Delete a customer rate card","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json delete /customers/{customerID}/rate-cards/{rateCardID}","href":"/en/api-reference/customers/delete-a-customer-rate-card"}]},{"group":"Metering","pages":[{"title":"Record a usage event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /metering/events","href":"/en/api-reference/metering/record-a-usage-event"},{"title":"Record usage events in batch","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /metering/events/batch","href":"/en/api-reference/metering/record-usage-events-in-batch"},{"title":"Get customer usage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /metering/usage","href":"/en/api-reference/metering/get-customer-usage"}]},{"group":"Invoices","pages":[{"title":"List invoices","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /billing/invoices","href":"/en/api-reference/invoices/list-invoices"},{"title":"Create a one-off invoice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /billing/invoices","href":"/en/api-reference/invoices/create-a-one-off-invoice"},{"title":"Invoice accrued usage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /billing/invoices/from-usage","href":"/en/api-reference/invoices/invoice-accrued-usage"},{"title":"Sell a product","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /billing/products/{productID}/invoices","href":"/en/api-reference/invoices/sell-a-product"},{"title":"Invoice the current period","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /billing/subscriptions/{subscriptionID}/invoices","href":"/en/api-reference/invoices/invoice-the-current-period"},{"title":"Get an invoice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /billing/invoices/{invoiceID}","href":"/en/api-reference/invoices/get-an-invoice"},{"title":"Email an invoice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /billing/invoices/{invoiceID}/send","href":"/en/api-reference/invoices/email-an-invoice"},{"title":"Void an invoice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /billing/invoices/{invoiceID}/void","href":"/en/api-reference/invoices/void-an-invoice"}]},{"group":"Payments","pages":[{"title":"List payments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /billing/payments","href":"/en/api-reference/payments/list-payments"},{"title":"List an invoice's payments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /billing/invoices/{invoiceID}/payments","href":"/en/api-reference/payments/list-an-invoices-payments"},{"title":"Get a payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /billing/payments/{paymentID}","href":"/en/api-reference/payments/get-a-payment"},{"title":"Refund a payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /billing/payments/{paymentID}/refund","href":"/en/api-reference/payments/refund-a-payment"},{"title":"List a payment's refunds","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /billing/payments/{paymentID}/refunds","href":"/en/api-reference/payments/list-a-payments-refunds"}]},{"group":"Subscriptions","pages":[{"title":"Create a subscription","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /billing/products/{productID}/subscriptions","href":"/en/api-reference/subscriptions/create-a-subscription"},{"title":"List an enrollment's subscriptions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /billing/customers/{customerID}/subscriptions","href":"/en/api-reference/subscriptions/list-an-enrollments-subscriptions"},{"title":"Get a subscription","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /billing/subscriptions/{subscriptionID}","href":"/en/api-reference/subscriptions/get-a-subscription"}]},{"group":"Billing","pages":[{"title":"List invoice download links","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /billing/invoices/{invoiceID}/deliverable","href":"/en/api-reference/billing/list-invoice-download-links"}]},{"group":"Coupons","pages":[{"title":"List coupons","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /billing/coupons","href":"/en/api-reference/coupons/list-coupons"},{"title":"Create a coupon","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /billing/coupons","href":"/en/api-reference/coupons/create-a-coupon"},{"title":"Get a coupon","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /billing/coupons/{couponID}","href":"/en/api-reference/coupons/get-a-coupon"},{"title":"Delete a coupon","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json delete /billing/coupons/{couponID}","href":"/en/api-reference/coupons/delete-a-coupon"},{"title":"Activate or archive a coupon","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json patch /billing/coupons/{couponID}","href":"/en/api-reference/coupons/activate-or-archive-a-coupon"}]},{"group":"Account","pages":[{"title":"Get your account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /account/tenant","href":"/en/api-reference/account/get-your-account"},{"title":"Update your account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json patch /account/tenant","href":"/en/api-reference/account/update-your-account"},{"title":"List API keys","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /account/api-keys","href":"/en/api-reference/account/list-api-keys"},{"title":"Create an API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /account/api-keys","href":"/en/api-reference/account/create-an-api-key"},{"title":"Revoke an API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json delete /account/api-keys/{keyID}","href":"/en/api-reference/account/revoke-an-api-key"}]},{"group":"Webhooks","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /account/webhooks","href":"/en/api-reference/webhooks/list-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /account/webhooks","href":"/en/api-reference/webhooks/create-a-webhook-endpoint"},{"title":"List webhook deliveries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /account/webhooks/deliveries","href":"/en/api-reference/webhooks/list-webhook-deliveries"},{"title":"Get a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /account/webhooks/{endpointID}","href":"/en/api-reference/webhooks/get-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json delete /account/webhooks/{endpointID}","href":"/en/api-reference/webhooks/delete-a-webhook-endpoint"},{"title":"Update a webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json patch /account/webhooks/{endpointID}","href":"/en/api-reference/webhooks/update-a-webhook"},{"title":"Rotate a webhook secret","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /account/webhooks/{endpointID}/rotate-secret","href":"/en/api-reference/webhooks/rotate-a-webhook-secret"}]}]}]}]},"basePath":"","title":"Get customer state - Infi","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}