Listar assinaturas

Lista as assinaturas do estabelecimento, das mais recentes para as mais antigas, com filtros opcionais e paginação por limit/offset.

Para achar a assinatura de um cliente, filtre por externalRef (não há filtro por CPF: ele iria para os logs de acesso).

Erros — corpo {"errors":[{"code":"...","msg":"..."}]}; msg detalha o campo quando é validação:

codeHTTPQuando aconteceO que fazer
INVALID_INPUT400Campo inválido ou fora do limite; msg diz qual e a regra.Corrija o campo indicado.
MISSING_DOCUMENT_ID400Estabelecimento não informado.Envie o header X-Merchant-Document (ou documentId).
TENANT_REQUIRED400A credencial não identifica o tenant.Gere o token com as credenciais do seu tenant (POST /v1/oauth/token).
FEATURE_DISABLED403O módulo de assinaturas não está habilitado para o tenant.Peça a habilitação à Autra.
MERCHANT_NOT_FOUND404O documento não é de um estabelecimento do seu tenant.Confira o CPF/CNPJ do estabelecimento.
INVALID_DOCUMENT422Documento do estabelecimento malformado.CPF com 11 ou CNPJ com 14 dígitos, só números.
INTERNAL_ERROR500Falha interna.Tente de novo; persistindo, fale com o suporte com o horário da chamada.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

CPF/CNPJ do estabelecimento, quando não usar o header

string

Seu identificador (externalRef exato)

string
enum

Filtra pelo status

Allowed:
uuid

Filtra pelo plano (UUID)

integer
1 to 200
Defaults to 50

Itens por página, 1 a 200 (padrão 50)

integer
≥ 0
Defaults to 0

Quantos itens pular (padrão 0)

Headers
string

CPF/CNPJ do estabelecimento (só números). Preferido; alternativa: documentId na query

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json