cURL

curl --request POST \
  --url https://sandbox-api.superpagamentos.com/subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customerId": "536feaf7-014b-4ad3-a2db-f14897bc2275",
  "tokenizedCardId": "10aaa074-dd95-4bdb-9618-f81e6fdc1e17",
  "title": "Plano Premium Mensal",
  "amount": 2990,
  "frequency": 30,
  "dueDate": "2025-06-04",
  "setupAmount": 1000,
  "duration": 12,
  "expirationDate": "2026-06-04",
  "tolerancePeriod": 5,
  "split": [
    {
      "subaccountId": "c873d310-d2eb-41da-adaa-36fc8900fb99",
      "splitType": "percentage",
      "chargebackLiable": true,
      "splitPercentage": 80,
      "splitAmount": 80
    }
  ]
}
'

{
  "data": {
    "id": "0b756e37-d852-4aa6-ae10-80e4b35e5cd7",
    "customerId": "536feaf7-014b-4ad3-a2db-f14897bc2275",
    "cardId": "10aaa074-dd95-4bdb-9618-f81e6fdc1e17",
    "title": "Plano Premium Mensal",
    "amount": 2990,
    "setupAmount": 1000,
    "frequency": 30,
    "duration": 12,
    "dueDate": "2025-06-04",
    "expirationDate": "2026-06-04",
    "tolerancePeriod": 5,
    "status": "ACTIVE",
    "createdAt": "2025-06-04T23:00:54.887Z",
    "updatedAt": "2025-06-04T23:00:54.887Z",
    "canceledAt": null,
    "splits": [
      {
        "subaccountId": "c873d310-d2eb-41da-adaa-36fc8900fb99",
        "splitType": "percentage",
        "splitPercentage": 80,
        "splitAmount": null,
        "liquidAmount": 2392,
        "chargebackLiable": true
      }
    ]
  },
  "message": "Assinatura criada com sucesso"
}

Assinaturas de Recorrência

Adicionar assinatura

Cria uma nova assinatura recorrente para um cliente. As assinaturas recorrentes permitem cobrar automaticamente um valor fixo em intervalos regulares, facilitando a gestão de pagamentos recorrentes.

Fluxo de funcionamento:

A assinatura é criada com os dados do cliente, cartão, valores e frequência
No dia especificado em dueDate, é realizada a primeira cobrança
As cobranças subsequentes ocorrem automaticamente de acordo com a frequency definida
O sistema respeita o tolerancePeriod para tentativas de cobrança em caso de falha
A assinatura pode ter duração limitada (duration) ou ser vitalícia
É possível definir uma data de expiração (expirationDate) para encerramento automático

Vantagens:

Automatização de cobranças recorrentes
Gestão simplificada de assinaturas
Suporte a diferentes frequências de cobrança
Possibilidade de split entre subcontas
Período de tolerância para tentativas de cobrança
Flexibilidade na duração e expiração

Validações importantes:

O cliente e o cartão devem existir e estar ativos
A data de início (dueDate) não pode ser no passado
O valor total dos splits deve somar 100% ou o valor total da assinatura
Apenas uma subconta pode ser responsável por chargebacks
O período de tolerância é opcional e deve ser maior que 0
O valor de setup é opcional e deve ser maior que 100 (R$ 1,00) quando informado

POST

subscriptions

cURL

curl --request POST \
  --url https://sandbox-api.superpagamentos.com/subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customerId": "536feaf7-014b-4ad3-a2db-f14897bc2275",
  "tokenizedCardId": "10aaa074-dd95-4bdb-9618-f81e6fdc1e17",
  "title": "Plano Premium Mensal",
  "amount": 2990,
  "frequency": 30,
  "dueDate": "2025-06-04",
  "setupAmount": 1000,
  "duration": 12,
  "expirationDate": "2026-06-04",
  "tolerancePeriod": 5,
  "split": [
    {
      "subaccountId": "c873d310-d2eb-41da-adaa-36fc8900fb99",
      "splitType": "percentage",
      "chargebackLiable": true,
      "splitPercentage": 80,
      "splitAmount": 80
    }
  ]
}
'

{
  "data": {
    "id": "0b756e37-d852-4aa6-ae10-80e4b35e5cd7",
    "customerId": "536feaf7-014b-4ad3-a2db-f14897bc2275",
    "cardId": "10aaa074-dd95-4bdb-9618-f81e6fdc1e17",
    "title": "Plano Premium Mensal",
    "amount": 2990,
    "setupAmount": 1000,
    "frequency": 30,
    "duration": 12,
    "dueDate": "2025-06-04",
    "expirationDate": "2026-06-04",
    "tolerancePeriod": 5,
    "status": "ACTIVE",
    "createdAt": "2025-06-04T23:00:54.887Z",
    "updatedAt": "2025-06-04T23:00:54.887Z",
    "canceledAt": null,
    "splits": [
      {
        "subaccountId": "c873d310-d2eb-41da-adaa-36fc8900fb99",
        "splitType": "percentage",
        "splitPercentage": 80,
        "splitAmount": null,
        "liquidAmount": 2392,
        "chargebackLiable": true
      }
    ]
  },
  "message": "Assinatura criada com sucesso"
}

Authorizations

Authorization

string

header

required

Token JWT gerado na rota de autenticação (/auth). Deve ser enviado no formato: Bearer

Body

application/json

customerId

string<uuid>

required

Identificador único do cliente que terá a assinatura

Example:

"536feaf7-014b-4ad3-a2db-f14897bc2275"

tokenizedCardId

string<uuid>

required

Identificador único do cartão tokenizado que será utilizado para as cobranças

Example:

"10aaa074-dd95-4bdb-9618-f81e6fdc1e17"

title

string

required

Título/descrição da assinatura

Example:

"Plano Premium Mensal"

amount

integer

required

Valor da assinatura em centavos

Example:

2990

frequency

integer

required

Frequência em dias que será cobrado (ex: 7 para semanal, 30 para mensal)

Example:

30

dueDate

string<date>

required

Data de início da cobrança. Não pode ser uma data que já passou.

Example:

"2025-06-04"

setupAmount

integer

Valor de setup do plano em centavos. Opcional. Se preenchido, deve ser maior que 100 (R$ 1,00).

Example:

1000

duration

integer

Duração em ciclos (quantas vezes será cobrado). Opcional, se não informado será vitalício.

Example:

12

expirationDate

string<date>

Data que expira a cobrança. Opcional, se não informado não expira.

Example:

"2026-06-04"

tolerancePeriod

integer

Período de tolerância para atrasos em dias. Opcional.

Example:

5

split

object[]

Array para divisão dos valores entre subcontas. Pode ser feito até 20 splits por pagamento.

Maximum array length: 20

Show child attributes

Response

Assinatura criada com sucesso

data

object

Show child attributes

message

string

Example:

"Assinatura criada com sucesso"

Estornar transação Listar assinaturas