API atual/Referência completa/Assinaturas e compras programadas

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.

GET/api/v1/vendor/subscriptionsSeller

Assinaturas dos produtos do seller no sistema antigo

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário seller (veja Tokens).

Parâmetros de consulta

statusstring

Filtra pela situação, texto exato (por exemplo active, past_due, cancelled).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/vendor/subscriptions?status=active" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Assinaturas

json

{
  "subscriptions": [
    {
      "id": "31b0a331-b267-4980-98cb-dbde2e9cba4b",
      "customer_id": "201519b4-6200-48ce-bfab-b313aa24f72b",
      "product_id": "152b9905-c91a-4a01-9ad7-ee5a3dd54960",
      "quantity": 1,
      "interval_days": 15,
      "discount_percent": 10,
      "status": "cancelled",
      "next_charge_at": "2026-08-27T09:00:00Z",
      "cancelled_at": "2026-07-13T17:25:07Z",
      "created_at": "2026-07-12T20:22:59Z",
      "updated_at": "2026-07-13T17:25:07Z"
    }
  ]
}

Campos da resposta

subscriptionsobject[]

Assinaturas.

iduuid

Id da assinatura.

customer_iduuid

Cliente.

product_iduuid

Produto.

variant_iduuid

Variação. Omitido se não há.

quantityinteger

Quantidade por ciclo.

interval_daysinteger

Dias entre cobranças.

discount_percentinteger

Desconto percentual inteiro.

statusstring

Situação por extenso (active, past_due, cancelled...).

next_charge_atstring

Próxima cobrança, RFC 3339.

cancelled_atstring

Cancelamento. Omitido se ativa.

shipping_addressobject

Endereço de entrega. Omitido se não há.

created_atstring

Criação, RFC 3339.

updated_atstring

Última alteração, RFC 3339.

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"}`

Indicadores (painel antigo)

Receita recorrente mensal, ativas, em atraso e cancelamento dos últimos 30 dias, só dos produtos do seller.

GET/api/v1/vendor/subscriptions/statsSeller

Indicadores do sistema antigo de assinaturas

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário seller (veja Tokens).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/vendor/subscriptions/stats" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Indicadores

json

{
  "mrr_cents": 28410,
  "active": 3,
  "past_due": 1,
  "churn_30d": 0.1,
  "unpriced_active": 0
}

Campos da resposta

mrr_centsinteger

Receita mensal recorrente, em centavos, normalizada para 30 dias.

activeinteger

Assinaturas active.

past_dueinteger

Assinaturas past_due.

churn_30dnumber

Cancelamentos dos últimos 30 dias divididos por todas as assinaturas (fração, 0.1 = 10%).

unpriced_activeinteger

Ativas sem preço resolvido (produto apagado ou sem preço), que ficam fora do MRR. -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"}`

Veja também

API atual/Referência completa/Assinaturas e compras programadas

Assinaturas (painel antigo)

Leitura das assinaturas e dos indicadores do sistema original de assinaturas.

Listar assinaturas (painel antigo)

GET/api/v1/vendor/subscriptionsSeller

Assinaturas dos produtos do seller no sistema antigo

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário seller (veja Tokens).

Parâmetros de consulta

statusstring

Filtra pela situação, texto exato (por exemplo active, past_due, cancelled).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/vendor/subscriptions?status=active" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Assinaturas

json

{
  "subscriptions": [
    {
      "id": "31b0a331-b267-4980-98cb-dbde2e9cba4b",
      "customer_id": "201519b4-6200-48ce-bfab-b313aa24f72b",
      "product_id": "152b9905-c91a-4a01-9ad7-ee5a3dd54960",
      "quantity": 1,
      "interval_days": 15,
      "discount_percent": 10,
      "status": "cancelled",
      "next_charge_at": "2026-08-27T09:00:00Z",
      "cancelled_at": "2026-07-13T17:25:07Z",
      "created_at": "2026-07-12T20:22:59Z",
      "updated_at": "2026-07-13T17:25:07Z"
    }
  ]
}

Campos da resposta

subscriptionsobject[]

Assinaturas.

iduuid

Id da assinatura.

customer_iduuid

Cliente.

product_iduuid

Produto.

variant_iduuid

Variação. Omitido se não há.

quantityinteger

Quantidade por ciclo.

interval_daysinteger

Dias entre cobranças.

discount_percentinteger

Desconto percentual inteiro.

statusstring

Situação por extenso (active, past_due, cancelled...).

next_charge_atstring

Próxima cobrança, RFC 3339.

cancelled_atstring

Cancelamento. Omitido se ativa.

shipping_addressobject

Endereço de entrega. Omitido se não há.

created_atstring

Criação, RFC 3339.

updated_atstring

Última alteração, RFC 3339.

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"}`

Indicadores (painel antigo)

Receita recorrente mensal, ativas, em atraso e cancelamento dos últimos 30 dias, só dos produtos do seller.

GET/api/v1/vendor/subscriptions/statsSeller

Indicadores do sistema antigo de assinaturas

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário seller (veja Tokens).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/vendor/subscriptions/stats" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Indicadores

json

{
  "mrr_cents": 28410,
  "active": 3,
  "past_due": 1,
  "churn_30d": 0.1,
  "unpriced_active": 0
}

Campos da resposta

mrr_centsinteger

Receita mensal recorrente, em centavos, normalizada para 30 dias.

activeinteger

Assinaturas active.

past_dueinteger

Assinaturas past_due.

churn_30dnumber

Cancelamentos dos últimos 30 dias divididos por todas as assinaturas (fração, 0.1 = 10%).

unpriced_activeinteger

Ativas sem preço resolvido (produto apagado ou sem preço), que ficam fora do MRR. -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"}`