Assinaturas (painel antigo)
Leitura das assinaturas e dos indicadores do sistema original de assinaturas.
Antes do módulo de pagamentos recorrentes, a plataforma já tinha um sistema próprio de assinaturas. Ele continua no ar, e estas duas rotas leem os dados dele. Diferente das assinaturas recorrentes, aqui não há módulo a ligar, mas é preciso o privilégio financeiro.
Listar assinaturas (painel antigo)
Devolve as assinaturas do sistema de assinaturas original, em modo leitura: o cliente assina um produto com intervalo em dias e desconto percentual. As ações (assinar, cancelar) são do cliente, pelo lado da loja. Máximo de 500, as mais novas primeiro, sem paginação.
/api/v1/vendor/subscriptionsSellerAssinaturas dos produtos do seller no sistema antigo
Cabeçalhos
AuthorizationstringobrigatórioBearer $TOKEN. Token de acesso de um usuário seller (veja Tokens).Parâmetros de consulta
statusstringactive, past_due, cancelled).Exemplo de requisição
Resposta
Campos da resposta
subscriptionsobject[]Assinaturas.
iduuidcustomer_iduuidproduct_iduuidvariant_iduuidquantityintegerinterval_daysintegerdiscount_percentintegerstatusstringactive, past_due, cancelled...).next_charge_atstringcancelled_atstringshipping_addressobjectcreated_atstringupdated_atstringErros
| Status | Quando | Corpo de exemplo |
|---|---|---|
| 401 | Token ausente, inválido, expirado ou revogado. | {"error":"missing authorization header"} |
| 403 | O token não é de um usuário seller (por exemplo, é de administrador), ou o usuário não está vinculado a nenhum seller. | {"error":"insufficient permissions"} |
| 403 | Sub-conta do seller sem nenhum dos privilégios financeiro (a lista completa vem em privilege_required_any; o exemplo está cortado). O dono da loja passa sempre. | {"error":"insufficient vendor privileges","privilege_required_any":["vendor_financial","vendor_view_financial"]} |
| 403 | O usuário não está vinculado a nenhum seller. | {"error":"no vendor account"} |
Indicadores (painel antigo)
Receita recorrente mensal, ativas, em atraso e cancelamento dos últimos 30 dias, só dos produtos do seller.
/api/v1/vendor/subscriptions/statsSellerIndicadores do sistema antigo de assinaturas
Cabeçalhos
AuthorizationstringobrigatórioBearer $TOKEN. Token de acesso de um usuário seller (veja Tokens).Exemplo de requisição
Resposta
Campos da resposta
mrr_centsintegeractiveintegeractive.past_dueintegerpast_due.churn_30dnumber0.1 = 10%).unpriced_activeinteger-1 = a consulta falhou.Erros
| Status | Quando | Corpo de exemplo |
|---|---|---|
| 401 | Token ausente, inválido, expirado ou revogado. | {"error":"missing authorization header"} |
| 403 | O token não é de um usuário seller (por exemplo, é de administrador), ou o usuário não está vinculado a nenhum seller. | {"error":"insufficient permissions"} |
| 403 | Sub-conta do seller sem nenhum dos privilégios financeiro (a lista completa vem em privilege_required_any; o exemplo está cortado). O dono da loja passa sempre. | {"error":"insufficient vendor privileges","privilege_required_any":["vendor_financial","vendor_view_financial"]} |
| 403 | O usuário não está vinculado a nenhum seller. | {"error":"no vendor account"} |