GET/api/v1/subscriptions

Assinaturas

Bearer tokenImplementadoescopo read:subscriptions

Contrato OpenAPI

operationId: listSubscriptions · Implementada

Parâmetros

Nome	Local	Obrigatório	Tipo
`limit`	query	não	integer
`offset`	query	não	integer

Respostas

HTTP	Significado
`200`	Assinaturas do usuário
`default`	Erro padronizado

Lista as assinaturas do usuário associado ao Bearer token (a mais recente primeiro). Suporta paginação. Responde 200 OK.

Escopo necessário: read:subscriptions (ver Escopos).

Para criar uma assinatura use POST /api/v1/subscriptions (escopo create:subscriptions). Upgrade, migração de plano e cancelamento não são self-service via API — fale com o suporte.

Query params

Param	Tipo	Padrão	Restrições
`limit`	inteiro	`20`	máximo `100`
`offset`	inteiro	`0`	deslocamento para paginação (máximo `10000`)

Ver Paginação.

Exemplo de request

cURL

curl "https://avatrix.io/api/v1/subscriptions?limit=20&offset=0" \
  -H "Authorization: Bearer av_xxxxxxxxxxxxxxxx"

Resposta — 200

A lista vem dentro do envelope padrão:

JSON

{
  "success": true,
  "data": {
    "subscriptions": [
      {
        "planId": "pro",
        "status": "active",
        "interval": "monthly",
        "startedAt": "2026-05-16T12:00:00.000Z",
        "renewsAt": "2026-06-16T12:00:00.000Z",
        "canceledAt": null
      }
    ],
    "limit": 20,
    "offset": 0
  }
}

O data traz as assinaturas vinculadas ao seu token (restritas à sua conta) e os metadados de paginação.

Erros relevantes

Código	HTTP	Quando
`UNAUTHORIZED`	401	token ausente, inválido, expirado ou revogado
`FORBIDDEN`	403	token sem `read:subscriptions`
`RATE_LIMITED`	429	rate limit (60 req/min por token), com `Retry-After`

Ver Erros.