Skip to main content
GET
/
subscriptions
cURL
curl --request GET \
  --url https://sandbox-api.superpagamentos.com/subscriptions \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "cardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "amount": 123,
      "setupAmount": 123,
      "frequency": 123,
      "duration": 123,
      "dueDate": "2023-12-25",
      "expirationDate": "2023-12-25",
      "tolerancePeriod": 123,
      "status": "ACTIVE",
      "splits": [
        {
          "subaccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "splitType": "PERCENTAGE",
          "liquidAmount": 123,
          "chargebackLiable": true,
          "splitPercentage": 123,
          "splitAmount": 123
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "canceledAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "total": 123,
    "page": 123,
    "limit": 123,
    "totalPages": 123
  },
  "message": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.superpagamentos.com/llms.txt

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

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
limit
integer
default:10

Limite de itens por página

Required range: 1 <= x <= 100
​
page
integer
default:1

Página atual

Required range: x >= 1
​
title
string

Filtrar pelo título

​
amount
number

Filtrar pelo valor do plano

​
setupAmount
number

Filtrar pelo valor do setup do plano

​
frequency
integer

Filtrar pela frequência

​
dueDate
string<date>

Filtrar pela data de início

​
status
enum<string>

Filtrar pelo status

Available options:
ACTIVE,
DELETED,
EXPIRED,
SUSPENDED
​
subaccountId
string<uuid>

Subconta presente no split

Response

200 - application/json

Listagem de assinaturas

​
data
object[]
​
meta
object
​
message
string | null