Buscar assinatura

Recuperar assinatura

get

Retorna os dados de uma assinatura específica

Autorizações

ApiKeyAuth

Parâmetros de rota

uuidstring · uuidObrigatório

UUID da assinatura

Parâmetros de cabeçalho

X-Token-ApistringObrigatório

Token de autenticação para acesso à API

Content-Typestring · enumOpcional

Tipo de conteúdo da requisição

Valores possíveis:

x-idempotency-keystringOpcional

Chave de idempotência

x-ip-origin-requeststringOpcional

IP de origem da requisição

Respostas

200

Dados da assinatura retornados com sucesso

application/json

400

Erro de validação

application/json

401

Token inativo ou inexistente

application/json

403

Acesso negado

application/json

404

Assinatura não encontrada

application/json

429

Muitas requisições

application/json

500

Erro interno do servidor

application/json

get

HTTPcURLJavaScriptPython

GET /v2/subscriptions/{uuid} HTTP/1.1
Host: api.barte.com
X-Token-Api: text
Accept: */*

{
  "uuid": "text",
  "status": "PENDING",
  "customer": {
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "email": "[e-mail]",
    "document": "text"
  },
  "startDate": "2025-09-26",
  "value": {
    "type": "MONTHLY",
    "valuePerMonth": 1
  },
  "additionalValue": {
    "installments": 1,
    "value": 1
  },
  "paymentMethod": "CREDIT_CARD",
  "charges": [
    {
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "status": "ABANDONED",
      "value": 1,
      "createdAt": "2025-09-26T14:44:01.684Z",
      "updatedAt": "2025-09-26T14:44:01.684Z"
    }
  ]
}