O que a assinatura cobra, item a item. Cada item tem kind: recurring_fee (mensalidade fixa, com timingadvance para cobrar no início do período ou arrears para cobrar no fim; o padrão é advance), credit_grant (créditos liberados a cada ciclo) ou metered_usage (uso medido, cobrado no fim do período). Só recurring_fee aceita timing. Se omitido, os itens seguem o modelo de preço do produto: um produto pré-pago cobra a mensalidade no início e libera créditos; os demais cobram a mensalidade e o uso no fim do período.
Uma janela de cobrança da assinatura. O uso medido entra no período em aberto.
Show child attributes
{"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":"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},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/assinaturas/criar-assinatura","slug":"/api-reference/assinaturas/criar-assinatura","pageMetadata":{"title":"Criar assinatura","description":"Cria uma assinatura do cliente no produto e abre o primeiro período de cobrança. A resposta traz a assinatura e esse período.\n\n`customerId` é o id da inscrição do cliente no produto (de `POST /metering/products/{productID}/customers`), não o id do cliente.\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json post /billing/products/{productID}/subscriptions","href":"/api-reference/assinaturas/criar-assinatura","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Cria uma assinatura do cliente no produto e abre o primeiro período de cobrança. A resposta traz a assinatura e esse período.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"customerId\"\n }), \" é o id da inscrição do cliente no produto (de \", _jsx(_components.code, {\n children: \"POST /metering/products/{productID}/customers\"\n }), \"), não o id do cliente.\"]\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":"Criar assinatura","description":"Cria uma assinatura do cliente no produto e abre o primeiro período de cobrança. A resposta traz a assinatura e esse período.\n\n`customerId` é o id da inscrição do cliente no produto (de `POST /metering/products/{productID}/customers`), não o id do cliente.\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json post /billing/products/{productID}/subscriptions","href":"/api-reference/assinaturas/criar-assinatura","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Assinaturas"],"operationId":"createSubscription","parameters":["c52d2866-d951-49d7-8a22-c12a74e49b9d"],"requestBody":"8df098e8-71a9-43c3-91b7-bc110f30f556","responses":{"201":"af085d19-1c5d-43f6-896a-16aeaa6e8dd5","400":"d51c9652-57a6-4929-909b-a8e253086b3e","401":"0ff52372-748a-47c5-879c-4eed337b963c","422":"6c62b4eb-1a94-4643-948c-1463b9c59c89"},"summary":"Criar assinatura","description":"Cria uma assinatura do cliente no produto e abre o primeiro período de cobrança. A resposta traz a assinatura e esse período.\n\n`customerId` é o id da inscrição do cliente no produto (de `POST /metering/products/{productID}/customers`), não o id do cliente.\n","method":"post","type":"path","servers":["9905c4d0-fcf0-4e80-9c22-501ee865364e","9b95f906-d9e1-4d9b-a04a-d3024008b68c"],"security":["0ac7feb9-6f99-460a-8a7b-dd0f6d2a1f37"],"path":"/billing/products/{productID}/subscriptions","baseUrlOptions":["https://api-sandbox.beinfi.com","https://api.beinfi.com"],"title":"Criar assinatura","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"c52d2866-d951-49d7-8a22-c12a74e49b9d":{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","isRequired":false,"description":"Chave única por operação (um UUID serve). Repetir com a mesma chave devolve a resposta original.","uniqueKey":"","typeLabel":"string"},"description":"Chave única por operação (um UUID serve). Repetir com a mesma chave devolve a resposta original."},"08aba3f8-1f82-41d3-b177-53548efa6c4b":{"name":"productID","in":"path","required":true,"schema":{"type":"string","pattern":"^prod_[0-9A-Za-z]{22}$","example":"prod_1d4YogBuw00jAySh5mbUpk","isRequired":true,"description":"ID do produto.","uniqueKey":"","typeLabel":"string"},"description":"ID do produto."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId"],"properties":{"customerId":{"type":"string","format":"uuid","description":"Id da inscrição do cliente neste produto.","isRequired":true,"uniqueKey":"customerId","typeLabel":"string\u003cuuid>"},"productVersionId":{"oneOf":[{"type":"string","format":"uuid","description":"Versão do produto que a assinatura cobra. Se omitido, usa a versão publicada mais recente.","uniqueKey":"productVersionId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Versão do produto que a assinatura cobra. Se omitido, usa a versão publicada mais recente.","uniqueKey":"productVersionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"productVersionId","typeLabel":"string\u003cuuid> | null"},"anchor":{"oneOf":[{"type":"string","format":"date-time","description":"Data de início do ciclo, que define o dia das próximas cobranças. Se omitido, é o momento da criação.","uniqueKey":"anchor.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Data de início do ciclo, que define o dia das próximas cobranças. Se omitido, é o momento da criação.","uniqueKey":"anchor.oneOf.1","typeLabel":"null"}],"uniqueKey":"anchor","typeLabel":"string\u003cdate-time> | null"},"items":{"type":"array","items":{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["recurring_fee","credit_grant","metered_usage"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].kind","typeLabel":"enum\u003cstring>"},"timing":{"oneOf":[{"type":"string","enum":["advance","arrears",null],"uniqueKey":"\\items.items.[INDEX].timing.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["advance","arrears",null],"uniqueKey":"\\items.items.[INDEX].timing.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].timing","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"\\items.items.[INDEX]","typeLabel":"object"},"description":"O que a assinatura cobra, item a item. Cada item tem `kind`: `recurring_fee` (mensalidade fixa, com `timing` `advance` para cobrar no início do período ou `arrears` para cobrar no fim; o padrão é `advance`), `credit_grant` (créditos liberados a cada ciclo) ou `metered_usage` (uso medido, cobrado no fim do período). Só `recurring_fee` aceita `timing`. Se omitido, os itens seguem o modelo de preço do produto: um produto pré-pago cobra a mensalidade no início e libera créditos; os demais cobram a mensalidade e o uso no fim do período.\n","uniqueKey":"\\items","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"customerId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","productVersionId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","anchor":"2023-11-07T05:31:56Z","items":[{}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"af085d19-1c5d-43f6-896a-16aeaa6e8dd5":{"content":{"application/json":{"schema":{"type":"object","required":["subscription","period"],"properties":{"subscription":{"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":"subscription.id","typeLabel":"string"},"customerId":{"type":"string","format":"uuid","description":"Id da inscrição.","isRequired":true,"uniqueKey":"subscription.customerId","typeLabel":"string\u003cuuid>"},"productVersionId":{"type":"string","format":"uuid","description":"A versão do produto assinada. Define o preço cobrado, mesmo se o produto mudar depois.","isRequired":true,"uniqueKey":"subscription.productVersionId","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["trialing","active","past_due","paused","canceled"],"isRequired":true,"uniqueKey":"subscription.status","typeLabel":"enum\u003cstring>"},"billingCycle":{"type":"string","enum":["weekly","monthly","annual"],"isRequired":true,"uniqueKey":"subscription.billingCycle","typeLabel":"enum\u003cstring>"},"billingMode":{"type":"string","enum":["arrears","advance"],"description":"`advance` cobra no início do período; `arrears`, no fim.","isRequired":true,"uniqueKey":"subscription.billingMode","typeLabel":"enum\u003cstring>"},"anchor":{"type":"string","format":"date-time","description":"Data de referência a partir da qual os períodos são contados.","isRequired":true,"uniqueKey":"subscription.anchor","typeLabel":"string\u003cdate-time>"},"startedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"subscription.startedAt","typeLabel":"string\u003cdate-time>"},"collectionMethod":{"type":"string","enum":["charge_automatically","send_invoice"],"description":"`charge_automatically` cobra sozinho; `send_invoice` envia a fatura para o cliente pagar.","uniqueKey":"subscription.collectionMethod","typeLabel":"enum\u003cstring>"},"nextBillingDate":{"oneOf":[{"type":"string","format":"date-time","description":"Próxima cobrança.","uniqueKey":"subscription.nextBillingDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Próxima cobrança.","uniqueKey":"subscription.nextBillingDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscription.nextBillingDate","typeLabel":"string\u003cdate-time> | null"},"canceledAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"subscription.canceledAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"subscription.canceledAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscription.canceledAt","typeLabel":"string\u003cdate-time> | null"},"cancelReason":{"type":"object","required":["code"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"subscription.cancelReason.code","typeLabel":"string"},"note":{"type":"string","uniqueKey":"subscription.cancelReason.note","typeLabel":"string"},"source":{"type":"string","enum":["buyer","merchant"],"uniqueKey":"subscription.cancelReason.source","typeLabel":"enum\u003cstring>"}},"uniqueKey":"subscription.cancelReason","typeLabel":"object"},"items":{"type":"array","items":{"type":"object","required":["id","kind","productVersionId","createdAt"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"subscription.\\items.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"kind":{"type":"string","enum":["recurring_fee","credit_grant","metered_usage","prepaid_usage"],"description":"`recurring_fee` é a mensalidade fixa; `credit_grant`, créditos concedidos a cada ciclo; `metered_usage`, uso cobrado depois; `prepaid_usage`, uso pago antes.","isRequired":true,"uniqueKey":"subscription.\\items.items.[INDEX].kind","typeLabel":"enum\u003cstring>"},"productVersionId":{"type":"string","format":"uuid","description":"A versão do produto de onde o item vem.","isRequired":true,"uniqueKey":"subscription.\\items.items.[INDEX].productVersionId","typeLabel":"string\u003cuuid>"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"subscription.\\items.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"timing":{"oneOf":[{"type":"string","enum":["advance","arrears",null],"description":"`advance` cobra no início do período; `arrears`, no fim.","uniqueKey":"subscription.\\items.items.[INDEX].timing.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["advance","arrears",null],"description":"`advance` cobra no início do período; `arrears`, no fim.","uniqueKey":"subscription.\\items.items.[INDEX].timing.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscription.\\items.items.[INDEX].timing","typeLabel":"enum\u003cstring> | null"},"canceledAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"subscription.\\items.items.[INDEX].canceledAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"subscription.\\items.items.[INDEX].canceledAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscription.\\items.items.[INDEX].canceledAt","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"subscription.\\items.items.[INDEX]","typeLabel":"object"},"description":"O que a assinatura cobra ou concede.","uniqueKey":"subscription.\\items","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"subscription","typeLabel":"object"},"period":{"type":"object","required":["id","subscriptionId","periodStart","periodEnd","status"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"period.id","typeLabel":"string\u003cuuid>"},"subscriptionId":{"type":"string","pattern":"^sub_[0-9A-Za-z]{22}$","example":"sub_2Kp7rWqT0aLm4XcVb8NzJe","isRequired":true,"uniqueKey":"period.subscriptionId","typeLabel":"string"},"periodStart":{"type":"string","format":"date-time","description":"Início do período (incluído).","isRequired":true,"uniqueKey":"period.periodStart","typeLabel":"string\u003cdate-time>"},"periodEnd":{"type":"string","format":"date-time","description":"Fim do período (não incluído).","isRequired":true,"uniqueKey":"period.periodEnd","typeLabel":"string\u003cdate-time>"},"status":{"type":"string","enum":["open","closed","invoiced"],"description":"`open` (recebendo uso), `closed` (terminou, fatura ainda não gerada) ou `invoiced` (já faturado).","isRequired":true,"uniqueKey":"period.status","typeLabel":"enum\u003cstring>"},"invoiceId":{"oneOf":[{"type":"string","description":"Fatura que cobrou este período","pattern":"^inv_[0-9A-Za-z]{22}$","example":"inv_6yi30EKotIwGHZdePSdsFc","uniqueKey":"period.invoiceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Fatura que cobrou este período","uniqueKey":"period.invoiceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"period.invoiceId","typeLabel":"string | null"}},"description":"Uma janela de cobrança da assinatura. O uso medido entra no período em aberto.","isRequired":true,"uniqueKey":"period","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"subscription":{"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"}]},"period":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","subscriptionId":"sub_2Kp7rWqT0aLm4XcVb8NzJe","periodStart":"2023-11-07T05:31:56Z","periodEnd":"2023-11-07T05:31:56Z","status":"open","invoiceId":"inv_6yi30EKotIwGHZdePSdsFc"}}}},"exampleType":"generated"}},"description":"Criado.","exampleType":"generated"},"d51c9652-57a6-4929-909b-a8e253086b3e":{"content":{"application/json":{"schema":{"type":"object","required":["message","error_code","tracer_id"],"properties":{"message":{"type":"string","description":"Frase legível para pessoas.","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":"Código estável do erro. Use-o para decidir o que fazer.","isRequired":true,"uniqueKey":"error_code","typeLabel":"string"},"tracer_id":{"type":"string","description":"Identificador da requisição. Informe-o ao falar com o suporte.","isRequired":true,"uniqueKey":"tracer_id","typeLabel":"string"}},"description":"O corpo de erro padrão. É plano (sem o envelope `error`) e o identificador de rastreio é `tracer_id`.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","error_code":"internal_error","tracer_id":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Requisição malformada.","exampleType":"generated"},"0ff52372-748a-47c5-879c-4eed337b963c":{"content":{"application/json":{"schema":{"type":"object","required":["message","error_code","tracer_id"],"properties":{"message":{"type":"string","description":"Frase legível para pessoas.","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":"Código estável do erro. Use-o para decidir o que fazer.","isRequired":true,"uniqueKey":"error_code","typeLabel":"string"},"tracer_id":{"type":"string","description":"Identificador da requisição. Informe-o ao falar com o suporte.","isRequired":true,"uniqueKey":"tracer_id","typeLabel":"string"}},"description":"O corpo de erro padrão. É plano (sem o envelope `error`) e o identificador de rastreio é `tracer_id`.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","error_code":"internal_error","tracer_id":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Chave ausente ou inválida.","exampleType":"generated"},"6c62b4eb-1a94-4643-948c-1463b9c59c89":{"content":{"application/json":{"schema":{"type":"object","required":["message","error_code","tracer_id","errors"],"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":"Código estável do erro. A lista não é fechada: além dos códigos genéricos, cada área tem os seus (`coupon_expired`, `insufficient_balance`, `version_not_draft`, `idempotency_key_reused`…). Um código que você não conhece deve ser tratado pelo status HTTP, mostrando `message`; não falhe ao ler a resposta.","isRequired":true,"uniqueKey":"error_code","typeLabel":"string"},"tracer_id":{"type":"string","isRequired":true,"uniqueKey":"tracer_id","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","required":["field","value","constraint","description"],"properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"value":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].value","typeLabel":"string"},"constraint":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].constraint","typeLabel":"string"},"description":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].description","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"Detalhe por campo (`field`, `description`). Sempre presente num `422`; pode vir vazio.","isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"description":"Corpo de um `422`. Mesmo formato de `Error`, mais `errors[]` com o detalhe por campo. É ali que está a frase que diz o que corrigir (por exemplo, \"product has no published version\").","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","error_code":"internal_error","tracer_id":"\u003cstring>","errors":[{"field":"\u003cstring>","value":"\u003cstring>","constraint":"\u003cstring>","description":"\u003cstring>"}]}}},"exampleType":"generated"}},"description":"Um ou mais campos são inválidos. O detalhe de cada campo está em `errors[]`.","exampleType":"generated"}},"security":{"0ac7feb9-6f99-460a-8a7b-dd0f6d2a1f37":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Chave secreta da conta: `Authorization: Bearer sk_test_…` ou `sk_live_…`. Use só no servidor.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"9905c4d0-fcf0-4e80-9c22-501ee865364e":{"url":"https://api-sandbox.beinfi.com","description":"Sandbox"},"9b95f906-d9e1-4d9b-a04a-d3024008b68c":{"url":"https://api.beinfi.com","description":"Produção"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Chave secreta da conta: `Authorization: Bearer sk_test_…` ou `sk_live_…`. Use só no servidor.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Chave secreta da conta: `Authorization: Bearer sk_test_…` ou `sk_live_…`. Use só no servidor.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.pt-BR.json"},"subdomain":"beinfi","siteName":"Infi","title":"Criar assinatura - Infi","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"pt-BR":{"href":"/api-reference/assinaturas/criar-assinatura","matchLevel":0},"en":{"href":"/en/introducao","matchLevel":4}}},"lastModified":"2026-11-02T23:19:06.467Z","originalFileLocation":"api-reference/assinaturas/criar-assinatura.mdx","locale":"pt-BR"},"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=\"Cria uma assinatura do cliente no produto e abre o primeiro período de cobrança. A resposta traz a assinatura e esse período. customerId é o id da inscrição do cliente no produto (de POST /metering/products/{productID}/customers), não o id do cliente.\">\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=\"Criar assinatura - Infi\">\u003cmeta data-mint-head property=\"og:description\" content=\"Cria uma assinatura do cliente no produto e abre o primeiro período de cobrança. A resposta traz a assinatura e esse período. customerId é o id da inscrição do cliente no produto (de POST /metering/products/{productID}/customers), não o id do cliente.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Infi\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.beinfi.com/api-reference/assinaturas/criar-assinatura\">\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=Assinaturas\u0026amp;title=Criar+assinatura\u0026amp;description=Cria+uma+assinatura+do+cliente+no+produto+e+abre+o+primeiro+per%C3%ADodo+de+cobran%C3%A7a.+A+resposta+traz+a+assinatura+e+esse+per%C3%ADodo.%0A%0A%60customerId%60+%C3%A9+o+id+da+inscri%C3%A7%C3%A3o+\u0026amp;theme=0f1e10ebee4743982aba108c\u0026amp;signature=309a2be9cde5f980c8e3142e3bea3341a09d2963e006e244367e2df37d2cec37\">\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=\"Criar assinatura - Infi\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Cria uma assinatura do cliente no produto e abre o primeiro período de cobrança. A resposta traz a assinatura e esse período. customerId é o id da inscrição do cliente no produto (de POST /metering/products/{productID}/customers), não o id do cliente.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://beinfi.mintlify.site/_mintlify/api/og/v2?division=Assinaturas\u0026amp;title=Criar+assinatura\u0026amp;description=Cria+uma+assinatura+do+cliente+no+produto+e+abre+o+primeiro+per%C3%ADodo+de+cobran%C3%A7a.+A+resposta+traz+a+assinatura+e+esse+per%C3%ADodo.%0A%0A%60customerId%60+%C3%A9+o+id+da+inscri%C3%A7%C3%A3o+\u0026amp;theme=0f1e10ebee4743982aba108c\u0026amp;signature=309a2be9cde5f980c8e3142e3bea3341a09d2963e006e244367e2df37d2cec37\">\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/api-reference/assinaturas/criar-assinatura\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/assinaturas/criar-assinatura.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/api-reference/assinaturas/criar-assinatura#webpage\",\"url\":\"https://docs.beinfi.com/api-reference/assinaturas/criar-assinatura\",\"name\":\"Criar assinatura\",\"description\":\"Cria uma assinatura do cliente no produto e abre o primeiro período de cobrança. A resposta traz a assinatura e esse período. customerId é o id da inscrição do cliente no produto (de POST /metering/products/{productID}/customers), não o id do cliente.\",\"dateModified\":\"2026-11-02T23:19:06.467Z\",\"isPartOf\":{\"@id\":\"https://docs.beinfi.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.beinfi.com/api-reference/assinaturas/criar-assinatura#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.beinfi.com/api-reference/assinaturas/criar-assinatura#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Infi\",\"item\":\"https://docs.beinfi.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Criar assinatura\",\"item\":\"https://docs.beinfi.com/api-reference/assinaturas/criar-assinatura\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.beinfi.com/api-reference/assinaturas/criar-assinatura#apireference\",\"headline\":\"Criar assinatura\",\"name\":\"Criar assinatura\",\"description\":\"Cria uma assinatura do cliente no produto e abre o primeiro período de cobrança. A resposta traz a assinatura e esse período. customerId é o id da inscrição do cliente no produto (de POST /metering/products/{productID}/customers), não o id do cliente.\",\"url\":\"https://docs.beinfi.com/api-reference/assinaturas/criar-assinatura\",\"mainEntityOfPage\":{\"@id\":\"https://docs.beinfi.com/api-reference/assinaturas/criar-assinatura#webpage\"},\"dateModified\":\"2026-11-02T23:19:06.467Z\",\"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,"tabs":[{"tab":"Guias","pages":[{"title":"Guias","href":"/introducao"}]},{"tab":"Referência da API","groups":[{"group":"Checkout","pages":[{"title":"Ler fatura no checkout","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json get /pay/{slug}/invoices/{invoiceID}","href":"/api-reference/checkout/ler-fatura-no-checkout"},{"title":"Pagar fatura no checkout","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json post /pay/{slug}/invoices/{invoiceID}/charge","href":"/api-reference/checkout/pagar-fatura-no-checkout"},{"title":"Aplicar cupom na fatura","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json post /pay/{slug}/invoices/{invoiceID}/coupon","href":"/api-reference/checkout/aplicar-cupom-na-fatura"},{"title":"Baixar produto digital","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json get /pay/{slug}/download/{token}","href":"/api-reference/checkout/baixar-produto-digital"}]},{"group":"Conta de teste","pages":[{"title":"Criar conta de teste","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json post /public/v1/claimables","href":"/api-reference/conta-de-teste/criar-conta-de-teste"},{"title":"Consultar conta de teste","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json get /public/v1/claimables/{claimableID}","href":"/api-reference/conta-de-teste/consultar-conta-de-teste"}]},{"group":"Catálogo","pages":[{"title":"Preparar envio de imagem","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json post /catalog/images/presign","href":"/api-reference/catálogo/preparar-envio-de-imagem"},{"title":"Listar produtos","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json get /products","href":"/api-reference/catálogo/listar-produtos"},{"title":"Criar produto","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json post /products","href":"/api-reference/catálogo/criar-produto"},{"title":"Consultar produto","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json get /products/{productID}","href":"/api-reference/catálogo/consultar-produto"},{"title":"Atualizar produto","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json patch /products/{productID}","href":"/api-reference/catálogo/atualizar-produto"},{"title":"Listar versões do produto","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json get /products/{productID}/versions","href":"/api-reference/catálogo/listar-versões-do-produto"},{"title":"Criar nova versão","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json post /products/{productID}/versions","href":"/api-reference/catálogo/criar-nova-versão"},{"title":"Publicar versão","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json post /products/{productID}/versions/{versionID}/publish","href":"/api-reference/catálogo/publicar-versão"},{"title":"Listar preços da versão","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json get /products/{productID}/versions/{versionID}/prices","href":"/api-reference/catálogo/listar-preços-da-versão"},{"title":"Adicionar preço à versão","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json post /products/{productID}/versions/{versionID}/prices","href":"/api-reference/catálogo/adicionar-preço-à-versão"},{"title":"Listar medidores do produto","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json get /products/{productID}/meters","href":"/api-reference/catálogo/listar-medidores-do-produto"},{"title":"Criar medidor","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json post /products/{productID}/meters","href":"/api-reference/catálogo/criar-medidor"},{"title":"Criar link com produto","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json post /payment-links","href":"/api-reference/catálogo/criar-link-com-produto"},{"title":"Listar links do produto","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json get /products/{productID}/payment-links","href":"/api-reference/catálogo/listar-links-do-produto"},{"title":"Criar link de pagamento","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json post /products/{productID}/payment-links","href":"/api-reference/catálogo/criar-link-de-pagamento"},{"title":"Revogar link de pagamento","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json delete /products/{productID}/payment-links/{linkID}","href":"/api-reference/catálogo/revogar-link-de-pagamento"},{"title":"Atualizar medidor","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json patch /products/{productID}/meters/{meterID}","href":"/api-reference/catálogo/atualizar-medidor"},{"title":"Gerar URL de upload do arquivo","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json post /products/{productID}/deliverable/presign","href":"/api-reference/catálogo/gerar-url-de-upload-do-arquivo"},{"title":"Consultar entregável","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json get /products/{productID}/deliverable","href":"/api-reference/catálogo/consultar-entregável"},{"title":"Salvar entregável","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json put /products/{productID}/deliverable","href":"/api-reference/catálogo/salvar-entregável"},{"title":"Remover entregável","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json delete /products/{productID}/deliverable","href":"/api-reference/catálogo/remover-entregável"}]},{"group":"Clientes","pages":[{"title":"Criar cliente","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json post /customers","href":"/api-reference/clientes/criar-cliente"},{"title":"Inscrever cliente no produto","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json post /products/{productID}/customers","href":"/api-reference/clientes/inscrever-cliente-no-produto"},{"title":"Buscar cliente","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json get /customers/{customerID}","href":"/api-reference/clientes/buscar-cliente"},{"title":"Consultar estado do cliente","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json get /customers/{customerID}/state","href":"/api-reference/clientes/consultar-estado-do-cliente"},{"title":"Consultar créditos","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json get /customers/{customerID}/wallet","href":"/api-reference/clientes/consultar-créditos"},{"title":"Listar preços do cliente","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json get /customers/{customerID}/rate-cards","href":"/api-reference/clientes/listar-preços-do-cliente"},{"title":"Definir preço do cliente","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json post /customers/{customerID}/rate-cards","href":"/api-reference/clientes/definir-preço-do-cliente"},{"title":"Remover preço do cliente","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json delete /customers/{customerID}/rate-cards/{rateCardID}","href":"/api-reference/clientes/remover-preço-do-cliente"}]},{"group":"Medição de uso","pages":[{"title":"Registrar evento de uso","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json post /metering/events","href":"/api-reference/medição-de-uso/registrar-evento-de-uso"},{"title":"Registrar eventos em lote","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json post /metering/events/batch","href":"/api-reference/medição-de-uso/registrar-eventos-em-lote"},{"title":"Consultar uso do cliente","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json get /metering/usage","href":"/api-reference/medição-de-uso/consultar-uso-do-cliente"}]},{"group":"Faturas","pages":[{"title":"Listar faturas","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json get /billing/invoices","href":"/api-reference/faturas/listar-faturas"},{"title":"Criar fatura avulsa","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json post /billing/invoices","href":"/api-reference/faturas/criar-fatura-avulsa"},{"title":"Faturar uso acumulado","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json post /billing/invoices/from-usage","href":"/api-reference/faturas/faturar-uso-acumulado"},{"title":"Vender um produto","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json post /billing/products/{productID}/invoices","href":"/api-reference/faturas/vender-um-produto"},{"title":"Faturar período da assinatura","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json post /billing/subscriptions/{subscriptionID}/invoices","href":"/api-reference/faturas/faturar-período-da-assinatura"},{"title":"Consultar fatura","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json get /billing/invoices/{invoiceID}","href":"/api-reference/faturas/consultar-fatura"},{"title":"Enviar fatura por e-mail","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json post /billing/invoices/{invoiceID}/send","href":"/api-reference/faturas/enviar-fatura-por-e-mail"},{"title":"Cancelar fatura","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json post /billing/invoices/{invoiceID}/void","href":"/api-reference/faturas/cancelar-fatura"}]},{"group":"Pagamentos","pages":[{"title":"Listar pagamentos","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json get /billing/payments","href":"/api-reference/pagamentos/listar-pagamentos"},{"title":"Listar pagamentos da fatura","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json get /billing/invoices/{invoiceID}/payments","href":"/api-reference/pagamentos/listar-pagamentos-da-fatura"},{"title":"Consultar pagamento","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json get /billing/payments/{paymentID}","href":"/api-reference/pagamentos/consultar-pagamento"},{"title":"Reembolsar pagamento","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json post /billing/payments/{paymentID}/refund","href":"/api-reference/pagamentos/reembolsar-pagamento"},{"title":"Listar reembolsos do pagamento","description":"Todos os reembolsos de um pagamento, dos mais antigos para os mais recentes. Como um pagamento pode ser reembolsado em partes, é aqui que você vê o que compõe o `refundedAmount` do pagamento.\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json get /billing/payments/{paymentID}/refunds","href":"/api-reference/pagamentos/listar-reembolsos-do-pagamento"}]},{"group":"Assinaturas","pages":[{"title":"Criar assinatura","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json post /billing/products/{productID}/subscriptions","href":"/api-reference/assinaturas/criar-assinatura"},{"title":"Listar assinaturas de uma inscrição","description":"Lista as assinaturas de uma inscrição, das mais recentes para as mais antigas. `customerID` é o id da inscrição do cliente no produto, não o id do cliente.\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json get /billing/customers/{customerID}/subscriptions","href":"/api-reference/assinaturas/listar-assinaturas-de-uma-inscrição"},{"title":"Consultar assinatura","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json get /billing/subscriptions/{subscriptionID}","href":"/api-reference/assinaturas/consultar-assinatura"}]},{"group":"Cobrança","pages":[{"title":"Listar links de download da fatura","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json get /billing/invoices/{invoiceID}/deliverable","href":"/api-reference/cobrança/listar-links-de-download-da-fatura"}]},{"group":"Cupons","pages":[{"title":"Listar cupons","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json get /billing/coupons","href":"/api-reference/cupons/listar-cupons"},{"title":"Criar cupom","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json post /billing/coupons","href":"/api-reference/cupons/criar-cupom"},{"title":"Consultar cupom","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json get /billing/coupons/{couponID}","href":"/api-reference/cupons/consultar-cupom"},{"title":"Excluir cupom","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json delete /billing/coupons/{couponID}","href":"/api-reference/cupons/excluir-cupom"},{"title":"Ativar ou arquivar cupom","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json patch /billing/coupons/{couponID}","href":"/api-reference/cupons/ativar-ou-arquivar-cupom"}]},{"group":"Conta","pages":[{"title":"Consultar a conta","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json get /account/tenant","href":"/api-reference/conta/consultar-a-conta"},{"title":"Atualizar a conta","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json patch /account/tenant","href":"/api-reference/conta/atualizar-a-conta"},{"title":"Listar chaves de API","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json get /account/api-keys","href":"/api-reference/conta/listar-chaves-de-api"},{"title":"Criar chave de API","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json post /account/api-keys","href":"/api-reference/conta/criar-chave-de-api"},{"title":"Revogar chave de API","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json delete /account/api-keys/{keyID}","href":"/api-reference/conta/revogar-chave-de-api"}]},{"group":"Webhooks","pages":[{"title":"Listar webhooks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json get /account/webhooks","href":"/api-reference/webhooks/listar-webhooks"},{"title":"Criar webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json post /account/webhooks","href":"/api-reference/webhooks/criar-webhook"},{"title":"Listar entregas de webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json get /account/webhooks/deliveries","href":"/api-reference/webhooks/listar-entregas-de-webhook"},{"title":"Consultar webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json get /account/webhooks/{endpointID}","href":"/api-reference/webhooks/consultar-webhook"},{"title":"Excluir webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json delete /account/webhooks/{endpointID}","href":"/api-reference/webhooks/excluir-webhook"},{"title":"Atualizar webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json patch /account/webhooks/{endpointID}","href":"/api-reference/webhooks/atualizar-webhook"},{"title":"Trocar segredo do webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.pt-BR.json post /account/webhooks/{endpointID}/rotate-secret","href":"/api-reference/webhooks/trocar-segredo-do-webhook"}]}]}]},{"language":"en","pages":[{"title":"en","href":"/en/introducao"}]}]},"basePath":"","title":"Criar assinatura - 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"]}