> ## Documentation Index > Fetch the complete documentation index at: https://docs.beinfi.com/llms.txt > Use this file to discover all available pages before exploring further. # Criar assinatura > 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. ## OpenAPI ````yaml /api-reference/openapi.pt-BR.json post /billing/products/{productID}/subscriptions openapi: 3.1.0 info: title: Infi API version: 0.0.1 description: > A API REST do Infi: catálogo, clientes, medição de uso, assinaturas, faturas, pagamentos e checkout. **Autenticação.** Envie a chave secreta em `Authorization: Bearer sk_test_…` (sandbox) ou `sk_live_…` (produção). O prefixo da chave decide o ambiente. As rotas de checkout (`/pay/*`) e `/public/*` não levam chave: rodam no navegador de quem paga. **Idempotência.** Toda requisição que altera dados exige o header `Idempotency-Key`. Uma repetição com a mesma chave devolve a resposta original em vez de executar de novo. **Valores.** Dinheiro e quantidades trafegam como texto decimal (`"150.00"`, `"0.0001"`), nunca como número de ponto flutuante. **Erros.** O corpo traz `error_code` (estável, use para decidir), `message` (para pessoas) e `tracer_id` (envie ao suporte). Erros de limite de requisições e de idempotência vêm aninhados em `error`, com `code` e `request_id`. servers: - url: https://api-sandbox.beinfi.com description: Sandbox - url: https://api.beinfi.com description: Produção security: - bearerAuth: [] tags: - name: Catálogo - name: Clientes - name: Medição de uso - name: Assinaturas - name: Faturas - name: Pagamentos - name: Checkout - name: Cupons - name: Cobrança - name: Conta - name: Webhooks - name: Conta de teste - name: Rail - name: Lojas paths: /billing/products/{productID}/subscriptions: parameters: - $ref: '#/components/parameters/ProductID' post: tags: - Assinaturas 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. `customerId` é o id da inscrição do cliente no produto (de `POST /metering/products/{productID}/customers`), não o id do cliente. operationId: createSubscription parameters: - $ref: '#/components/parameters/IdempotencyKey' 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. productVersionId: type: - string - 'null' format: uuid description: >- Versão do produto que a assinatura cobra. Se omitido, usa a versão publicada mais recente. anchor: type: - string - '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. items: type: array items: type: object required: - kind properties: kind: type: string enum: - recurring_fee - credit_grant - metered_usage timing: type: - string - 'null' enum: - advance - arrears - null 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. responses: '201': content: application/json: schema: type: object properties: subscription: $ref: '#/components/schemas/Subscription' period: $ref: '#/components/schemas/SubscriptionPeriod' description: Criado. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '422': $ref: '#/components/responses/ValidationFailed' components: parameters: ProductID: name: productID in: path required: true schema: type: string format: uuid description: ID do produto. IdempotencyKey: name: Idempotency-Key in: header required: false schema: type: string description: >- Chave única por operação (um UUID serve). Repetir com a mesma chave devolve a resposta original. schemas: Subscription: type: object properties: id: type: string format: uuid customerId: type: string format: uuid description: Id da inscrição. productVersionId: type: string format: uuid description: >- A versão do produto assinada. Define o preço cobrado, mesmo se o produto mudar depois. status: type: string enum: - trialing - active - past_due - paused - canceled billingCycle: type: string enum: - weekly - monthly - annual collectionMethod: type: string enum: - charge_automatically - send_invoice description: >- `charge_automatically` cobra sozinho; `send_invoice` envia a fatura para o cliente pagar. billingMode: type: string enum: - arrears - advance description: '`advance` cobra no início do período; `arrears`, no fim.' anchor: type: string format: date-time description: Data de referência a partir da qual os períodos são contados. nextBillingDate: type: - string - 'null' format: date-time description: Próxima cobrança. startedAt: type: string format: date-time canceledAt: type: - string - 'null' format: date-time items: type: array items: $ref: '#/components/schemas/SubscriptionItem' description: O que a assinatura cobra ou concede. SubscriptionPeriod: type: object properties: id: type: string format: uuid subscriptionId: type: string format: uuid periodStart: type: string format: date-time description: Início do período (incluído). periodEnd: type: string format: date-time description: Fim do período (não incluído). status: type: string enum: - open - closed - invoiced description: >- `open` (recebendo uso), `closed` (terminou, fatura ainda não gerada) ou `invoiced` (já faturado). invoiceId: type: - string - 'null' format: uuid description: Fatura que cobrou este período description: >- Uma janela de cobrança da assinatura. O uso medido entra no período em aberto. SubscriptionItem: type: object properties: id: type: string format: uuid 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. timing: type: - string - 'null' enum: - advance - arrears - null description: '`advance` cobra no início do período; `arrears`, no fim.' productVersionId: type: string format: uuid description: A versão do produto de onde o item vem. createdAt: type: string format: date-time canceledAt: type: - string - 'null' format: date-time Error: type: object required: - message - error_code - tracer_id properties: message: type: string description: Frase legível para pessoas. error_code: $ref: '#/components/schemas/ErrorCode' description: Código estável do erro. Use-o para decidir o que fazer. tracer_id: type: string description: Identificador da requisição. Informe-o ao falar com o suporte. description: >- O corpo de erro padrão. É plano (sem o envelope `error`) e o identificador de rastreio é `tracer_id`. ValidationError: type: object required: - message - error_code - tracer_id - errors properties: message: type: string error_code: $ref: '#/components/schemas/ErrorCode' tracer_id: type: string errors: type: array items: type: object required: - field - value - constraint - description properties: field: type: string value: type: string constraint: type: string description: type: string description: >- Detalhe por campo (`field`, `description`). Sempre presente num `422`; pode vir vazio. 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"). ErrorCode: 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. responses: BadRequest: content: application/json: schema: $ref: '#/components/schemas/Error' description: Requisição malformada. Unauthorized: content: application/json: schema: $ref: '#/components/schemas/Error' description: Chave ausente ou inválida. ValidationFailed: content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: >- Um ou mais campos são inválidos. O detalhe de cada campo está em `errors[]`. securitySchemes: bearerAuth: type: http scheme: bearer description: >- Chave secreta da conta: `Authorization: Bearer sk_test_…` ou `sk_live_…`. Use só no servidor. ````