Buscar assinante

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

Autenticação: JWT Bearer ou chave de API do vendedor.

Retorna um assinante do plano informado, com um bloco metrics adicional contendo a contagem de pagamentos (total / pagos / pendentes / atrasados / falhos). As métricas são calculadas apenas na ação de detalhe.

Pré-requisitos

O chamador precisa estar autenticado contra o vendedor identificado por seller_id.
O plano deve pertencer a esse vendedor e o assinante deve pertencer ao plano.

Parâmetros de rota

string

required

UUID da conta unificada do vendedor.

string

required

UUID do plano de assinatura pai.

string

required

UUID do assinante.

Resposta

string

UUID do assinante.

string

UUID do plano pai.

string

Nome completo.

string

E-mail do assinante.

string

CPF ou CNPJ.

string

Um dos valores pending (pendente), paid (pago), failed (falhou), overdue (atrasado), canceled (cancelado).

string

Data/hora ISO 8601 da próxima cobrança agendada.

string

Data/hora ISO 8601 do pagamento confirmado mais recente, ou null.

string

Data/hora ISO 8601 em que o assinante foi criado.

string

Data/hora ISO 8601 em que o assinante foi cancelado, ou null.

object

Métricas de pagamento calculadas dinamicamente:

total_payments — total de pagamentos do assinante.
paid_payments — pagamentos com payment_status='paid'.
pending_payments — pagamentos com payment_status='pending'.
overdue_payments — pagamentos cujo due_date já passou e ainda não foram pagos.
failed_payments — pagamentos com payment_status='failed'.

{
  "id": "f4b1c7a9-8c2d-4d4f-9c3a-5e6f7a8b9c0d",
  "subscription_plan": "8b0e9f4a-2b7d-4f3f-9d8a-1c2e3a4b5c6d",
  "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,
  "metrics": {
    "total_payments": 4,
    "paid_payments": 4,
    "pending_payments": 0,
    "overdue_payments": 0,
    "failed_payments": 0
  }
}

Erros

Status	Quando
`401`	Token ausente ou inválido.
`403`	O chamador não está vinculado a este vendedor.
`404`	O assinante não existe ou não pertence a este plano/vendedor.

Exemplos

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

import requests

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

const response = await fetch(
  `https://api.dlpay.cloud/subscriptions/seller/${sellerId}/plans/${planId}/subscribers/${subscriberId}/`,
  { headers: { Authorization: `Bearer ${accessToken}` } },
);
const subscriber = 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

Resposta

Erros

Exemplos

​Pré-requisitos

​Parâmetros de rota

​Resposta

​Erros

​Exemplos

Pré-requisitos

Parâmetros de rota

Resposta

Erros

Exemplos