Pular para o conteúdo

Listar assinaturas

Para consultar as assinaturas (vendas recorrentes) no sistema, faça uma requisição para o endpoint abaixo:

Endpoint
GET /api/v1/subscriber/
NameTypeDescription
pageIntegerInforma número da página em caso de paginação disponível.
next_chargeDateFiltro pela data de próxima cobranca.
statusStringStatus disponíveis para filtro das assinaturas: subscriber_canceled, subscriber_overdue e subscriber_active.
checkout_idStringInforme o checkout para pesquisar assinaturas realizadas deste plano.
tokenStringInforme o token da assinatura para pesquisar.
emailStringInforme o e-mail do assinante para pesquisar.
{
"data": [
{
"token": "8750f9c5-4e3a-4d59-be25-657cff0e9a34",
"status": "subscriber_active",
"link_to_pay": null,
"customer": {
"token": "68b75988-a3a9-4951-8325-eb81026f822a",
"email": "carlos46@example.com",
"telephone": "958896971"
},
"subscription": {
"from": "2022-06-01",
"to": "2022-07-01",
"next_charge": "2022-07-01"
},
"checkout": {
"slug": "plano-one",
"title": "Checkout Software SaaS",
"total": "99.00"
},
"created_at": "2022-06-01 19:40:55"
}
],
"links": {
"first": "https://sandbox.azpag.dev/api/v1/subscriber?page=1",
"last": "https://sandbox.azpag.dev/api/v1/subscriber?page=2",
"prev": null,
"next": "https://sandbox.azpag.dev/api/v1/subscriber?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 30,
"links": [
{
"url": null,
"label": "Anterior",
"active": false
},
{
"url": "https://sandbox.azpag.dev/api/v1/subscriber?page=1",
"label": "1",
"active": true
},
{
"url": "https://sandbox.azpag.dev/api/v1/subscriber?page=2",
"label": "Próximo",
"active": false
}
],
"path": "https://sandbox.azpag.dev/api/v1/subscriber",
"per_page": 10,
"to": 2,
"total": 2
}
}