AssinaturasPlanos de Assinatura

Crie planos recorrentes para cobrar seus clientes de forma automática.

Criar plano

POST /api/recurrency/plans

Campos

CampoObrigatórioDescrição
tag✅Nome/identificador do plano (único por conta)
amount✅Valor em centavos por ciclo. Ex: 2990 = R$ 29,90
billingCycle✅Frequência de cobrança (ver tabela abaixo)
totalBillingCycles✅Total de cobranças do plano (mínimo 1)
initialGraceCycles❌Ciclos de carência antes da primeira cobrança (padrão 0)
initialFee❌Taxa de adesão nos primeiros ciclos (ver abaixo)

Ciclos de cobrança (billingCycle)

ValorFrequência
DAILYDiária
WEEKLYSemanal
MONTHLYMensal
QUARTERLYTrimestral
BIANNUALSemestral
ANNUALAnual

Exemplo

curl -X POST https://isolutionpay.com/api/recurrency/plans \
  -H "Content-Type: application/json" \
  -H "token: isolutionpay_sk_SUA_CHAVE_AQUI" \
  -d '{
    "tag": "Plano Premium Mensal",
    "amount": 2990,
    "billingCycle": "MONTHLY",
    "totalBillingCycles": 12
  }'

Resposta

{
  "id": "2234ef2f-4e14-4c08-8800-b1e472c997cf",
  "tag": "Plano Premium Mensal",
  "amount": 2990,
  "billingCycle": "MONTHLY",
  "totalBillingCycles": 12,
  "initialGraceCycles": 0,
  "enabled": true,
  "created_at": "2026-07-20T10:00:00Z"
}

Salve o id — você vai usá-lo para criar assinaturas.

Criar plano com taxa de adesão

Use initialFee para cobrar um valor diferente nos primeiros ciclos — útil para taxa de matrícula ou entrada.

CampoTipoDescrição
initialFee.descriptionstringDescrição da taxa. Ex: "Taxa de matrícula"
initialFee.amountinteiroValor em centavos
initialFee.cyclesinteiroQuantas cobranças iniciais terão esse valor

Exemplo

curl -X POST https://isolutionpay.com/api/recurrency/plans \
  -H "Content-Type: application/json" \
  -H "token: isolutionpay_sk_SUA_CHAVE_AQUI" \
  -d '{
    "tag": "Academia VIP",
    "amount": 19990,
    "billingCycle": "MONTHLY",
    "totalBillingCycles": 12,
    "initialFee": {
      "description": "Taxa de matrícula",
      "amount": 9990,
      "cycles": 1
    }
  }'

Neste exemplo: primeira cobrança R$ 99,90 (taxa) + R$ 199,90 (plano) = R$ 299,80. Demais ciclos: R$ 199,90.

Listar planos

GET /api/recurrency/plans

Retorna todos os planos ativos da sua conta.

curl https://isolutionpay.com/api/recurrency/plans \
  -H "token: isolutionpay_sk_SUA_CHAVE_AQUI"

Resposta

{
  "plans": [
    {
      "id": "2234ef2f-4e14-4c08-8800-b1e472c997cf",
      "tag": "Plano Premium Mensal",
      "amount": 2990,
      "billingCycle": "MONTHLY",
      "totalBillingCycles": 12,
      "initialGraceCycles": 0,
      "enabled": true,
      "created_at": "2026-07-20T10:00:00Z"
    }
  ]
}

Buscar plano por ID

GET /api/recurrency/plans/{id}
curl https://isolutionpay.com/api/recurrency/plans/2234ef2f-4e14-4c08-8800-b1e472c997cf \
  -H "token: isolutionpay_sk_SUA_CHAVE_AQUI"

Resposta

{
  "id": "2234ef2f-4e14-4c08-8800-b1e472c997cf",
  "tag": "Plano Premium Mensal",
  "amount": 2990,
  "billingCycle": "MONTHLY",
  "totalBillingCycles": 12,
  "initialGraceCycles": 0,
  "enabled": true,
  "created_at": "2026-07-20T10:00:00Z"
}

Desativar plano

DELETE /api/recurrency/plans/{id}

Desativa o plano. Assinaturas existentes não são canceladas automaticamente — apenas novas assinaturas serão bloqueadas.

curl -X DELETE https://isolutionpay.com/api/recurrency/plans/2234ef2f-4e14-4c08-8800-b1e472c997cf \
  -H "token: isolutionpay_sk_SUA_CHAVE_AQUI"

Resposta

{
  "id": "2234ef2f-4e14-4c08-8800-b1e472c997cf",
  "enabled": false
}
EstornosAssinaturas