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.

Gera um checkout para cobrar manualmente um período de renovação de uma assinatura com billing_source: manual. O checkout criado pode ser enviado ao cliente para que ele conclua o pagamento.

​
Autenticação

Requer um token de acesso válido (CHARGEFY_ACCESS_TOKEN) no header Authorization. Escopos necessários: web:write ou subscriptions:write.

​
Parâmetros de Path

ParâmetroTipoObrigatórioDescrição
idstringSimID da assinatura

​
Parâmetros do Body

Todos os campos são opcionais. Quando não fornecidos, os dados do cliente e do produto são herdados da assinatura.
ParâmetroTipoObrigatórioDescrição
customer_idstringNãoID do cliente. Se omitido, usa o cliente da assinatura
customer_emailstringNãoE-mail do cliente. Se omitido, usa o e-mail do cliente da assinatura
customer_namestringNãoNome do cliente. Se omitido, usa o nome do cliente da assinatura
customer_tax_idstringNãoCPF/CNPJ do cliente
amountnumberNãoValor em centavos a cobrar neste período. Se omitido, usa o valor padrão do produto
success_urlstringNãoURL de redirecionamento após pagamento bem-sucedido
cancel_urlstringNãoURL de redirecionamento em caso de cancelamento
metadataobjectNãoMetadados personalizados a incluir no checkout
no_fees_installmentsbooleanNãoSe true, habilita parcelamento sem juros
Este endpoint está disponível exclusivamente para assinaturas com billing_source: manual. Assinaturas com status canceled retornam erro 409 Conflict.

​
Campos da Resposta

Retorna o objeto do checkout criado (status 201).
CampoTipoDescrição
idstringID do checkout criado
urlstringURL para o cliente concluir o pagamento
statusstringStatus do checkout (open)
product_idstringID do produto da assinatura
subscription_idstringID da assinatura vinculada ao checkout
customer_emailstring | nullE-mail do cliente pré-preenchido
customer_namestring | nullNome do cliente pré-preenchido
amountnumber | nullValor em centavos
success_urlstring | nullURL de sucesso
cancel_urlstring | nullURL de cancelamento
created_atdatetimeData de criação do checkout

​
Exemplo de Requisição

curl -X POST "https://api.chargefy.io/api/v1/subscriptions/sub_1a2b3c4d/manual-renewal-checkout" \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 4990,
    "success_url": "https://meusite.com.br/obrigado",
    "cancel_url": "https://meusite.com.br/cancelado"
  }'

​
Exemplo de Resposta

{
  "id": "chk_abc123",
  "url": "https://checkout.chargefy.io/c/chk_abc123",
  "status": "open",
  "product_id": "prod_abc123",
  "subscription_id": "sub_1a2b3c4d",
  "customer_email": "cliente@exemplo.com",
  "customer_name": "João Silva",
  "amount": 4990,
  "success_url": "https://meusite.com.br/obrigado",
  "cancel_url": "https://meusite.com.br/cancelado",
  "created_at": "2026-03-30T10:00:00Z"
}