Buscar plano de assinatura

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

Autenticação: JWT bearer ou chave de API

Retorna o plano de assinatura completo para o vendedor informado. A visão de detalhe anota o plano com contagens de assinantes por status — total, active, overdue, canceled, failed, paid, pending — expostas no campo metrics.

Pré-requisitos

Quem chama precisa estar autenticado contra o vendedor identificado por seller_id.
O plano precisa pertencer a esse vendedor — caso contrário a consulta retorna 404.

Parâmetros de rota

string

required

UUID unificado da conta do vendedor.

string

required

UUID do plano de assinatura.

Resposta

200 OK. Mesmo formato da resposta de criação, com o bloco metrics totalmente preenchido.

{
  "id": "8b0e9f4a-2b7d-4f3f-9d8a-1c2e3a4b5c6d",
  "account": "11111111-2222-3333-4444-555555555555",
  "name": "Clube do Café — Mensal",
  "description": "Receba um pacote de 250g por mês.",
  "amount": "4990",
  "payment_methods": ["credit_card", "pix"],
  "payment_methods_no_tax": ["pix"],
  "end_date": null,
  "frequency": "monthly",
  "is_perpetual": true,
  "notification_config": {
    "id": "c0ffee00-0000-0000-0000-000000000000",
    "notify_new_payment_link": true,
    "days_before_due": 3,
    "notify_on_due_date": true,
    "days_after_overdue": 1,
    "notify_payment_confirmed": true
  },
  "metrics": {
    "total_subscribers": 128,
    "active_subscribers": 112,
    "overdue_subscribers": 6,
    "canceled_subscribers": 5,
    "failed_subscribers": 2,
    "paid_subscribers": 109,
    "pending_subscribers": 3
  },
  "created_at": "2026-01-04T10:00:00-03:00",
  "updated_at": "2026-05-01T09:21:00-03:00"
}

Inconsistência conhecida do campo amount: o valor é exposto como string em centavos, diferente da convenção em centavos inteiros adotada em outros endpoints.

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/ \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import requests

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

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

Início

Autenticação e usuários

Vendedores

Vendas

Planos

Contas unificadas

Eventos

Assinaturas

Contas virtuais

Integrações do vendedor

Buscar plano de assinatura

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