Guia
Assinaturas
Planos recorrentes com período de teste, cupons, faturas e retentativa automática.
1. Crie o plano
Intervalos: WEEK, MONTH, QUARTER, SEMESTER, YEAR ou CUSTOM com intervalCount.
POST /v1/plans
curl -X POST https://api2.bosspay.io/v1/plans \
-H "Authorization: Bearer bp_test_SUA_CHAVE" \
-H "Content-Type: application/json" \
-d '{ "name": "Pro mensal", "amount": "9900", "interval": "MONTH", "trialDays": 7, "methods": ["PIX", "CREDIT_CARD"] }'2. Assine o cliente
Informe customerId ou os dados de um cliente novo. Em cartão, envie o token (nunca o número).
POST /v1/subscriptions
curl -X POST https://api2.bosspay.io/v1/subscriptions \
-H "Authorization: Bearer bp_test_SUA_CHAVE" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: assinatura-cliente-88" \
-d '{ "planId": "PLAN_ID", "method": "PIX", "customer": { "name": "Bruno Vasconcelos", "email": "bruno@exemplo.com" } }'3. Ciclos e retentativas
Cada ciclo gera uma fatura. Falhas seguem a política de retentativa (GET/PUT /v1/dunning). Pause, retome, troque de plano ou cancele pelas rotas da assinatura.
Webhooks relevantes
subscription.createdsubscription.paidsubscription.failed