Listar planos de assinatura

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

Autenticação: JWT bearer ou chave de API

Lista todos os planos de assinatura cuja account é a conta do vendedor identificada por seller_id, do mais recente para o mais antigo. Cada linha vem anotada com contagens de assinantes, para que o painel possa exibir a saúde do plano em um único olhar.

Pré-requisitos

Quem chama precisa estar autenticado contra o vendedor, seja por um JWT emitido em /user/login/ (com um vínculo de acesso entre usuário e vendedor) ou por uma chave de API com escopo de vendedor.

Parâmetros de rota

string

required

UUID unificado da conta do vendedor dona dos planos.

Parâmetros de query

string

Busca de subsequência sem distinção de maiúsculas/minúsculas em name e description do plano.

Resposta

Retorna um array de objetos de plano, ordenados por created_at decrescente.

string

UUID do plano.

string

Nome do plano.

string

Descrição longa.

string

Valor recorrente em centavos de BRL (armazenado como string).

array

Métodos de pagamento permitidos (credit_card, boleto, pix).

array

Subconjunto de payment_methods em que o vendedor absorve a taxa.

string

Timestamp ISO-8601 em que a cobrança para, ou null.

string

Um dos valores weekly, biweekly, monthly, bimonthly, quarterly, semiannual, annual.

boolean

true quando end_date é null.

integer

Total de assinantes vinculados a este plano (qualquer status).

integer

Total de assinantes em status paid ou pending.

string

Timestamp ISO-8601 de criação do plano.

string

Timestamp ISO-8601 da última atualização do plano.

[
  {
    "id": "8b0e9f4a-2b7d-4f3f-9d8a-1c2e3a4b5c6d",
    "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,
    "total_subscribers": 128,
    "active_subscribers": 112,
    "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. Trate-o como string e converta antes de operar aritmeticamente.

Erros

Status	Quando
`401`	Token ausente ou inválido.
`403`	Chamador autenticado, mas sem vínculo com este vendedor.

Exemplos

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

import requests

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

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

Início

Autenticação e usuários

Vendedores

Vendas

Planos

Contas unificadas

Eventos

Assinaturas

Contas virtuais

Integrações do vendedor

Listar planos de assinatura

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