Skip to main content
GET
/
subscriptions
Listar Assinaturas
curl --request GET \
  --url https://api.example.com/subscriptions \
  --header 'x-api-key: <x-api-key>'
{
  "data": [
    {
      "partner_id": "pa_10000",
      "start_date": "2023-02-22T06:16:49.584Z",
      "expiry_date": "2024-02-22T06:16:49.584Z",
      "plan_id": "plan_10000",
      "beneficiary": {
        "name": "João Silva",
        "cpf": "34567898233",
        "email": "joao.silva@example.com"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 10,
    "total_items": 1,
    "total_pages": 1,
    "has_next": false,
    "has_previous": false
  }
}

​
Visão Geral

Este endpoint retorna todas as assinaturas ativas do parceiro, com suporte a paginação para facilitar a navegação em grandes volumes de dados.

​
Autenticação

​
x-api-key
string
required
Sua chave de API fornecida pela Zentek.

​
Query Parameters

​
page
number
default:"1"
Número da página a ser exibida.
​
page_size
number
default:"10"
Número de itens por página (máximo: 100).

​
Exemplo de Request

curl -X GET "https://api.partner.zentek.com.br/v1/subscriptions?page=1&page_size=10" \
  -H "x-api-key: SUA_API_KEY" \
  -H "Accept: application/json"

​
Response

​
data
array
Lista de assinaturas.
​
pagination
object
Informações de paginação.
{
  "data": [
    {
      "partner_id": "pa_10000",
      "start_date": "2023-02-22T06:16:49.584Z",
      "expiry_date": "2024-02-22T06:16:49.584Z",
      "plan_id": "plan_10000",
      "beneficiary": {
        "name": "João Silva",
        "cpf": "34567898233",
        "email": "joao.silva@example.com"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 10,
    "total_items": 1,
    "total_pages": 1,
    "has_next": false,
    "has_previous": false
  }
}