Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.chargefy.io/llms.txt

Use this file to discover all available pages before exploring further.

Abril 2026 — Normalização do modelo de Produtos e Preços

22 de abril de 2026
Refactor grande no objeto de Produto e Preço: separamos o que você vende (Product) do como cobrar (Price), e os campos de valor (currency, unit_amount, interval) viraram imutáveis. Mudanças visíveis na API, no dashboard e nos webhooks.

Produto agora é separado de Preço

  • Um Product descreve o que você vende; um Price descreve como cobrar.
  • Um produto pode ter múltiplos preços (mensal + anual no mesmo plano, por exemplo).
  • Novo campo products.default_price_id — ponteiro pro preço padrão. Usado pelo checkout quando o caller só manda product_id.

Campos de preço redesenhados

AntesAgora
price_amountunit_amount
price_currencycurrency
is_archivedactive (invertido — true = ativo)
recurring_intervalinterval
amount_type (fixed/custom/free)removido — derivado do valor e type
Novos campos:
  • interval_count — cobrança a cada N intervalos (trimestral, bienal, etc)
  • tax_behaviorunspecified / inclusive / exclusive (declarativo; roadmap aplica no cálculo)
  • metadata — metadata livre por preço
  • zoop_recurrence_plan_id — movido de Product pra Price (suporta múltiplos preços recorrentes)
type agora é 'one_time' | 'recurring', substituindo os valores legados price_fixed | price_custom | price_free.

Novos endpoints dedicados

  • POST /functions/v1/create-price — adiciona preço a produto existente
  • PATCH /functions/v1/update-price — atualiza active, metadata, tax_behavior. currency/unit_amount/interval são imutáveis (campos de valor precisam ser auditáveis)

Quantidade em checkouts e assinaturas

  • checkouts.seats renomeado pra checkouts.quantity
  • subscription_product_prices ganha quantity (default 1)
  • Total cobrado = unit_amount × quantity (modelo “licensed”)
  • Substitui o antigo seat_based_pricing_enabled — agora é implícito, sem flag

Removido

  • PWYW (“Pague Quanto Quiser”) — campos minimum_amount, maximum_amount, preset_amount saíram. Produtos que usavam foram migrados pra preço fixo (preset → minimum → 0).
  • Split por produtoproducts.fee_percent e products.fee_recipient_organization_id removidos. Split de marketplace agora vem sempre de organization_relationships (configurado na criação da sub-org).
  • products.reference_id — nunca foi wired; removido. IDs externos, use metadata.
  • products.user_metadata renomeado pra products.metadata.

Para integrações externas

  • Webhook payloads de product.* e suborganization.product_* agora usam os nomes novos (unit_amount, currency, interval, etc).
  • Código que lia price.amount_type, price.price_amount etc precisa migrar. Ver Preços pros nomes novos.
Docs atualizados: Produtos, Preços, Precificação por Quantidade, API Reference — Products, API Reference — Prices.

v1.0.0 — Lançamento da Plataforma

12 de março de 2026
Temos o prazer de anunciar o lançamento oficial da Chargefy! A plataforma completa de pagamentos e assinaturas para desenvolvedores e empresas.

Checkout

  • Checkout integrado com suporte a PIX, Cartão de Crédito e Boleto
  • Página de checkout personalizável com a identidade visual da sua marca
  • Checkout embeddable via SDK para integração direta no seu site

Assinaturas e Recorrência

  • Sistema completo de assinaturas com cobrança recorrente
  • Gerenciamento de ciclos de cobrança (mensal, trimestral, anual)
  • Upgrades, downgrades e cancelamentos de planos

Dashboard

  • Painel de gerenciamento com visão geral de vendas e métricas
  • Gerenciamento de produtos, clientes e vendas
  • Relatórios e exportação de dados

API REST

  • API completa para integração com qualquer plataforma
  • Autenticação via tokens de acesso (OAT)
  • Documentação interativa com exemplos de código

SDK TypeScript

  • SDK oficial para Node.js e navegadores
  • Tipagem completa com TypeScript
  • Componentes React para checkout embeddable

Webhooks

  • Sistema de webhooks para notificações em tempo real
  • Verificação HMAC-SHA256 para segurança
  • Painel de monitoramento de entregas

Portal do Cliente

  • Portal self-service para clientes gerenciarem suas assinaturas
  • Histórico de vendas e faturas
  • Atualização de métodos de pagamento