Skip to main content

Visão geral

Este endpoint retorna uma lista paginada de todas as assinaturas criadas na sua conta, com suporte a filtros por status, cliente e período.

Endpoint

Parâmetros de consulta

string
Filtra pelo status da assinatura: active, paused, canceled ou past_due.
string
Filtra as assinaturas de um cliente específico.
integer
default:"1"
Número da página de resultados.
integer
default:"20"
Quantidade de itens por página. Máximo de 100.

Resposta

array
Lista de objetos de assinatura.
object
Informações de paginação, incluindo página atual, total de páginas e total de registros.

Exemplo de resposta

Use o filtro status=past_due para identificar assinaturas com pagamento em atraso e acionar fluxos de cobrança.

Próximos passos

Criar assinatura

Crie uma nova assinatura recorrente.

Cancelar assinatura

Cancele uma assinatura existente.