Autenticação: JWT bearer ou chave de API
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
UUID unificado da conta do vendedor dona dos planos.
Parâmetros de query
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 porcreated_at decrescente.
UUID do plano.
Nome do plano.
Descrição longa.
Valor recorrente em centavos de BRL (armazenado como string).
Métodos de pagamento permitidos (
credit_card, boleto, pix).Subconjunto de
payment_methods em que o vendedor absorve a taxa.Timestamp ISO-8601 em que a cobrança para, ou
null.Um dos valores
weekly, biweekly, monthly, bimonthly, quarterly, semiannual, annual.true quando end_date é null.Total de assinantes vinculados a este plano (qualquer status).
Total de assinantes em status
paid ou pending.Timestamp ISO-8601 de criação do plano.
Timestamp ISO-8601 da última atualização do plano.
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. |