Catalisa.Building Blocks

API do Billing

46 endpoints em 10 recursos. A permissão de cada rota é a que o código exige — conferida linha a linha, não copiada do nome.

Ver a referência detalhada, com corpo de requisição e catálogo de erros →

47 endpoints

Contas de cobrança

/billing/api/v1/billing-accounts5
  • POST/billing/api/v1/billing-accountsCria conta de cobrançaBILLING_ACCOUNTS_CREATE
  • GET/billing/api/v1/billing-accountsLista contas. Filtros: filter[status], filter[personId]BILLING_ACCOUNTS_READ
  • GET/billing/api/v1/billing-accounts/:idBusca contaBILLING_ACCOUNTS_READ
  • PATCH/billing/api/v1/billing-accounts/:idAtualiza contaBILLING_ACCOUNTS_UPDATE
  • DELETE/billing/api/v1/billing-accounts/:idExclusão lógica. 204BILLING_ACCOUNTS_DELETE

Produtos de faturamento

/billing/api/v1/products5
  • POST/billing/api/v1/productsCria produto cobrávelBILLING_PRODUCTS_CREATE
  • GET/billing/api/v1/productsLista. Filtros: filter[isActive], filter[pricingModel]BILLING_PRODUCTS_READ
  • GET/billing/api/v1/products/:idBusca produtoBILLING_PRODUCTS_READ
  • PATCH/billing/api/v1/products/:idAtualiza produtoBILLING_PRODUCTS_UPDATE
  • DELETE/billing/api/v1/products/:idExclusão lógica. 204BILLING_PRODUCTS_DELETE

Planos

/billing/api/v1/plans7
  • POST/billing/api/v1/plansCria planoBILLING_PLANS_CREATE
  • GET/billing/api/v1/plansLista. Filtros: filter[isActive], filter[billingInterval]BILLING_PLANS_READ
  • GET/billing/api/v1/plans/:idBusca plano com itensBILLING_PLANS_READ
  • PATCH/billing/api/v1/plans/:idAtualiza planoBILLING_PLANS_UPDATE
  • DELETE/billing/api/v1/plans/:idExclusão lógica. 204BILLING_PLANS_DELETE
  • POST/billing/api/v1/plans/:id/itemsAdiciona produto ao plano. 201BILLING_PLANS_UPDATE
  • DELETE/billing/api/v1/plans/:planId/items/:itemIdRemove item do plano. 204BILLING_PLANS_UPDATE

Configuração da organização

/billing/api/v1/config2
  • GET/billing/api/v1/configLê a configuração; cria com padrões se não existirBILLING_CONFIG_MANAGE
  • PATCH/billing/api/v1/configAtualiza moeda, ciclo, prazo, prefixo e rodapéBILLING_CONFIG_MANAGE

Assinaturas

/billing/api/v1/subscriptions7
  • POST/billing/api/v1/subscriptionsCria assinatura. 201BILLING_SUBSCRIPTIONS_CREATE
  • GET/billing/api/v1/subscriptionsLista. Filtros: filter[billingAccountId], filter[planId], filter[status]BILLING_SUBSCRIPTIONS_READ
  • GET/billing/api/v1/subscriptions/:idBusca assinaturaBILLING_SUBSCRIPTIONS_READ
  • PATCH/billing/api/v1/subscriptions/:idAltera **apenas** quantityBILLING_SUBSCRIPTIONS_UPDATE
  • POST/billing/api/v1/subscriptions/:id/cancelCancela agora ou ao fim do períodoBILLING_SUBSCRIPTIONS_CANCEL
  • POST/billing/api/v1/subscriptions/:id/pausePausa (só de ACTIVE)BILLING_SUBSCRIPTIONS_UPDATE
  • POST/billing/api/v1/subscriptions/:id/resumeRetoma (só de PAUSED)BILLING_SUBSCRIPTIONS_UPDATE

Medidores de uso

/billing/api/v1/meters5
  • POST/billing/api/v1/metersCria medidor. 201BILLING_METERS_CREATE
  • GET/billing/api/v1/metersLista. Filtros: filter[productId], filter[isActive]BILLING_METERS_READ
  • GET/billing/api/v1/meters/:idBusca medidorBILLING_METERS_READ
  • PATCH/billing/api/v1/meters/:idAtualiza medidorBILLING_METERS_UPDATE
  • DELETE/billing/api/v1/meters/:idExclusão lógica. 204BILLING_METERS_DELETE

Uso

/billing/api/v1/usage3
  • POST/billing/api/v1/usageRegistra um evento de uso. 201BILLING_USAGE_CREATE
  • POST/billing/api/v1/usage/batchRegistra lote de 1 a 1.000 eventos. 201BILLING_USAGE_CREATE
  • GET/billing/api/v1/usage/summaryResumo por medidor no períodoBILLING_USAGE_READ

Faturas

/billing/api/v1/invoices8
  • POST/billing/api/v1/invoicesCria fatura em branco (DRAFT). 201BILLING_INVOICES_CREATE
  • POST/billing/api/v1/invoices/generateGera fatura a partir de uma assinatura. 201BILLING_INVOICES_CREATE
  • GET/billing/api/v1/invoicesLista. Filtros: filter[billingAccountId], filter[status], filter[startDate], filter[endDate]BILLING_INVOICES_READ
  • GET/billing/api/v1/invoices/:idBusca fatura com itensBILLING_INVOICES_READ
  • PATCH/billing/api/v1/invoices/:idAltera notes e dueDate. Só em DRAFTBILLING_INVOICES_UPDATE
  • POST/billing/api/v1/invoices/:id/line-itemsAdiciona linha. Só em DRAFT. 201BILLING_INVOICES_UPDATE
  • POST/billing/api/v1/invoices/:id/finalizeDRAFT → PENDING, congela a faturaBILLING_INVOICES_FINALIZE
  • POST/billing/api/v1/invoices/:id/voidAnula. Recusa PAID e VOIDBILLING_INVOICES_VOID

Pagamentos

/billing/api/v1/payments4
  • POST/billing/api/v1/paymentsRegistra pagamento. 201BILLING_PAYMENTS_READ ⚠
  • GET/billing/api/v1/paymentsLista. Filtros: filter[billingAccountId], filter[invoiceId], filter[status]BILLING_PAYMENTS_READ
  • GET/billing/api/v1/payments/:idBusca pagamentoBILLING_PAYMENTS_READ
  • POST/billing/api/v1/payments/:id/refundEstorna total ou parcialBILLING_PAYMENTS_REFUND

Saúde

/billing/health1
  • GET/billing/healthResponde { status, service, version, timestamp }. Não toca banco nem Redis.