Pular para o conteúdo
Referência

Assinaturas

Planos, assinaturas, faturas, cupons e política de retentativa (dunning).

Exige o produto RECURRING ativo para a empresa em Produção. No Sandbox basta não estar desativado.
GET/v1/recurring/overview

MRR, ativos, inadimplência

Escopo subscriptions.read
GET/v1/recurring/customers

Assinantes

Escopo subscriptions.read
Parâmetros de consulta
page
inteiroPágina (começa em 1).
pageSize
inteiro ≤ 200Itens por página (padrão 25).
GET/v1/plans

Lista planos

Escopo subscriptions.read
POST/v1/plans

Cria plano

Escopo subscriptions.manage
Corpo (JSON)
nameobrigatório
stringNome do plano.
amountobrigatório
string | inteiroValor por ciclo em centavos.
intervalobrigatório
enumWEEK, MONTH, QUARTER, SEMESTER, YEAR, CUSTOM.
intervalCount
inteiroMultiplicador do intervalo. Padrão 1.
trialDays
inteiroDias de teste.
setupFee
centavosTaxa de adesão.
maxCycles
inteiroEncerra após N ciclos.
methodsobrigatório
listaMétodos aceitos.
GET/v1/plans/:id

Consulta plano

Escopo subscriptions.read
PATCH/v1/plans/:id

Atualiza plano

Escopo subscriptions.manage
DELETE/v1/plans/:id

Remove plano (com histórico, apenas desativa)

Escopo subscriptions.manage
GET/v1/subscriptions

Lista assinaturas

Escopo subscriptions.read
Parâmetros de consulta
page
inteiroPágina (começa em 1).
pageSize
inteiro ≤ 200Itens por página (padrão 25).
GET/v1/subscriptions/:id

Consulta assinatura

Escopo subscriptions.read
POST/v1/subscriptions

Cria assinatura

Escopo subscriptions.manageAceita Idempotency-Key
Corpo (JSON)
planIdobrigatório
stringPlano.
customerId | customerobrigatório
string | objetoCliente existente ou dados de um novo.
methodobrigatório
PIX | BOLETO | CREDIT_CARDForma de cobrança.
card
objetoToken do cartão (quando CREDIT_CARD). Nunca PAN.
couponCode
stringCupom.
startAt
AAAA-MM-DDInício. Vazio = hoje.
POST/v1/subscriptions/:id/pause

Pausa

Escopo subscriptions.manage
POST/v1/subscriptions/:id/resume

Retoma

Escopo subscriptions.manage
POST/v1/subscriptions/:id/cancel

Cancela (reason obrigatório)

Escopo subscriptions.manage
POST/v1/subscriptions/:id/change-plan

Troca de plano

Escopo subscriptions.manage
GET/v1/invoices

Lista faturas

Escopo subscriptions.read
Parâmetros de consulta
page
inteiroPágina (começa em 1).
pageSize
inteiro ≤ 200Itens por página (padrão 25).
GET/v1/invoices/:id

Consulta fatura e tentativas

Escopo subscriptions.read
POST/v1/invoices/:id/retry

Nova tentativa de cobrança

Escopo subscriptions.manageAceita Idempotency-Key
GET/v1/coupons

Lista cupons

Escopo subscriptions.read
GET/v1/coupons/validate

Valida cupom

Escopo subscriptions.read
POST/v1/coupons

Cria cupom

Escopo subscriptions.manage
PATCH/v1/coupons/:id

Atualiza cupom

Escopo subscriptions.manage
DELETE/v1/coupons/:id

Remove cupom (já usado, apenas desativa)

Escopo subscriptions.manage
GET/v1/dunning

Política de retentativa

Escopo subscriptions.read
PUT/v1/dunning

Define política de retentativa

Escopo subscriptions.manage
DELETE/v1/dunning/plans/:id

Remove política específica de um plano

Escopo subscriptions.manage