Listar assinaturas
GET
/v1/subscriptions
Lista as assinaturas de um cliente, identificado pelo e-mail, com paginação e filtro por status. Retorna 10 itens por página.
Formato de data na listagem
Nesta rota next_charge_at e charges[].charged_at vêm no formato
dd/mm/aaaa. No detalhe da assinatura, next_charge_at vem como
aaaa-mm-dd hh:mm:ss.
Autorizações
bearerAuth
Token Bearer do merchant obtido via POST /oauth2/token usando as
credenciais do merchant (não do app). Veja
Autenticação.
Tipo
HTTP (bearer)
Parâmetros
Parâmetros de Consulta
email*
E-mail do cliente.
status
Filtra pelo status da assinatura. Aceita apenas ACTIVE, PAUSED e
CANCELLED. Sem filtro, a listagem devolve todos os status, incluindo
OVERDUE, SUSPENDED e FINISHED — veja status no item da listagem.
Tipo
string
Valores válidos
"ACTIVE""PAUSED""CANCELLED"Exemplo
"ACTIVE"page
Página da listagem.
Tipo
integer
Exemplo
1Mínimo
1Padrão
1Respostas
Lista de assinaturas retornada com sucesso.
application/json
JSON "data": { "subscriptions": [ { "subscription_id": 10, "status": "ACTIVE", "products": [ { "name": "Camiseta Preta", "price": 199.9, "quantity": 1, "shopify_product_id": null, "variant_id": null, "product_id": 55, "image_url": null, "compare_at_price": null } ], "value": 199.9, "freight_value": 19.9, "current_cycle": 3, "customer": { "name": "Maria Silva", "document": "12345678909", "phone": "11999999999", "address": { "street": "Rua São Bento", "number": "111", "complement": "Bloco 7", "district": "Centro", "city": "São Paulo", "state": "SP", "postcode": "01010000" } }, "payment": { "payment_info": { "brand": "visa", "final": "1234", "expiration": null } }, "charges": [ { "cycle": 1, "order_id": 12346, "shopify_order_id": null, "charged_at": "15/07/2026", "value": 199.9, "status": "paid" } ], "next_charge_at": "15/08/2026" } ], "pagination": { "total": 1, "per_page": 10, "current_page": 1, "last_page": 1 } }
{
}
GET
/v1/subscriptions