Skip to main content
GET
/
subscriptions
/
{subscriptionId}
cURL
curl --request GET \
  --url https://sandbox-api.superpagamentos.com/subscriptions/{subscriptionId} \
  --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"
  },
  "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

Path Parameters

​
subscriptionId
string<uuid>
required

ID da assinatura que deseja consultar

Response

Assinatura encontrada com sucesso

​
data
object
required
​
message
string
required

Mensagem de retorno da operação