Pular para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://developer.pagou.ai/llms.txt

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

Use este fluxo para um novo plano recorrente com cartão.

​
Pré-requisitos

  • Assinaturas precisam estar habilitadas para a sua conta.
  • O cliente já precisa existir em /v2/customers.
  • O cartão precisa ser coletado com Payment Element e retornar um token pgct_.

​
Requisição do back-end

curl --request POST \
  --url https://api.pagou.ai/v2/subscriptions \
  --header "Authorization: Bearer SEU_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "customer_id": "9f9a8df6-0b3d-40d5-9f6b-a9e96c0a9101",
    "token": "pgct_example_token",
    "amount": 4900,
    "currency": "BRL",
    "interval": "month",
    "interval_count": 1,
    "failure_policy": "retry_then_cancel",
    "metadata": {
      "plan": "pro"
    }
  }'

​
Comportamento

  • amount está em centavos e é usado em cada ciclo de cobrança.
  • Sem trial_end, a primeira cobrança acontece imediatamente e a assinatura fica active após sucesso.
  • Com trial_end, a Pagou pode validar o cartão primeiro e manter a assinatura como trialing até o fim do teste.
  • Um customer_id desconhecido retorna 404.
  • Permissão de assinatura desabilitada retorna 403.

​
O que armazenar

  • id da assinatura
  • id do cliente
  • status atual
  • current_period_start e current_period_end
  • id da última transação, quando existir

​
Leia a seguir