Listar assinantes

Endpoint: GET /subscriptions/seller/{seller_id}/plans/{plans_pk}/subscribers/

Autenticação: JWT bearer ou chave de API

Lista todos os assinantes cujo plano é o identificado por plans_pk, ordenados por subscribed_at decrescente. A listagem usa uma projeção mais enxuta sem as métricas de pagamento.

Pré-requisitos

Quem chama precisa estar autenticado contra o vendedor identificado por seller_id.
O plano referenciado por plans_pk precisa pertencer a esse vendedor.

Parâmetros de rota

string

required

UUID unificado da conta do vendedor.

string

required

UUID do plano de assinatura pai.

Parâmetros de query

string

Busca de subsequência sem distinção de maiúsculas/minúsculas em name, email e taxpayer_id.

Resposta

Retorna um array de linhas resumidas de assinante, do mais recente para o mais antigo.

string

UUID do assinante.

string

Nome completo.

string

E-mail do assinante.

string

CPF ou CNPJ.

string

Um dos valores pending, paid, failed, overdue, canceled.

string

Timestamp ISO-8601 da próxima cobrança programada.

string

Timestamp ISO-8601 do último pagamento confirmado, ou null.

string

Timestamp ISO-8601 em que o assinante foi criado.

string

Timestamp ISO-8601 em que o assinante foi cancelado, ou null.

[
  {
    "id": "f4b1c7a9-8c2d-4d4f-9c3a-5e6f7a8b9c0d",
    "name": "Maria Souza",
    "email": "maria@example.com",
    "taxpayer_id": "12345678901",
    "status": "paid",
    "next_billing_date": "2026-06-14T12:30:00-03:00",
    "last_payment_date": "2026-05-14T12:30:04-03:00",
    "subscribed_at": "2026-05-14T12:30:00-03:00",
    "canceled_at": null
  }
]

Erros

Status	Quando
`401`	Token ausente ou inválido.
`403`	Chamador sem vínculo com este vendedor.
`404`	O plano não existe ou não pertence a este vendedor.

Exemplos

curl https://api.dlpay.cloud/subscriptions/seller/SELLER_ID/plans/PLAN_ID/subscribers/ \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import requests

response = requests.get(
    f"https://api.dlpay.cloud/subscriptions/seller/{seller_id}/plans/{plan_id}/subscribers/",
    headers={"Authorization": f"Bearer {access_token}"},
    params={"search": "maria"},
)
subscribers = response.json()

const response = await fetch(
  `https://api.dlpay.cloud/subscriptions/seller/${sellerId}/plans/${planId}/subscribers/?search=maria`,
  { headers: { Authorization: `Bearer ${accessToken}` } },
);
const subscribers = await response.json();

Início

Autenticação e usuários

Vendedores

Vendas

Planos

Contas unificadas

Eventos

Assinaturas

Contas virtuais

Integrações do vendedor

Pré-requisitos

Parâmetros de rota

Parâmetros de query

Resposta

Erros

Exemplos

​Pré-requisitos

​Parâmetros de rota

​Parâmetros de query

​Resposta

​Erros

​Exemplos

Pré-requisitos

Parâmetros de rota

Parâmetros de query

Resposta

Erros

Exemplos