Skip to main content
GET
Esta rota devolve os planos de assinatura cadastrados, página por página. É a base para montar a vitrine de planos no seu site, conferir quais planos estão disponíveis para venda e acompanhar quantas assinaturas ativas cada um tem.

Quando usar

Antes de chamar

  • Tenha uma chave secreta gerada por usuário com a permissão visualizar assinaturas. Nos perfis padrão, são Owner, Manager, Operador e Visualizador. Os perfis Desenvolvedor e Financeiro recebem 403 (veja Permissões por perfil).
  • Saiba como funciona a paginação da API: o parâmetro de tamanho da página é size (Paginação, ordenação e idempotência).
Assinaturas não têm modo de teste: as cobranças são reais mesmo com a chave de teste. Veja como homologar em Assinaturas: visão geral.

Parâmetros de consulta

string
Filtra pelos planos de um merchant específico. Ex.: 2RhQg9M7ZCg3X3nMb9W1kX8Q.
string
Filtra pelo status do plano: active (disponível para novas assinaturas) ou inactive (indisponível para novas assinaturas).
integer
default:"1"
Número da página. A contagem começa em 1.
integer
default:"10"
Quantidade de planos por página.

Respostas

object[]
Planos da página atual.
object
Dados da paginação.
Na requisição o tamanho da página vai em size. Na resposta, o mesmo valor volta no campo meta.limit.
Para o negócio: activeSubscriptionsCount mostra quantos assinantes ativos cada plano tem no momento. Antes de desativar ou reprecificar um plano, consulte esse número para saber quantos clientes já estão nele. Mudanças de preço e desativação não alteram as assinaturas existentes, que continuam com as condições da contratação.

Erros comuns

Veja também

Visão geral de assinaturas

Como planos, clientes, cartões e assinaturas se encaixam.

Planos

Recorrência, trial e status do plano.

Ciclo de vida

Status, renovação, retentativas e cancelamento.

Webhooks de assinatura

Eventos enviados a cada etapa da assinatura.

Registrar cartão

Guarde o cartão no cofre antes de criar a assinatura.

Criar plano

Cadastre um novo plano de assinatura.