VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa

Assinaturas e compras programadas

Como oferecer, criar e cancelar assinaturas e compras programadas de um produto.

Produtos de consumo recorrente (café, ração, refil, higiene) vendem mais quando o cliente não precisa lembrar de comprar. A plataforma oferece duas formas: a assinatura, que cobra o cliente a cada ciclo, e a compra programada, uma recompra com desconto numa frequência escolhida. Esta seção cobre o lado do cliente: descobrir o que o produto aceita, criar e cancelar.

Pontos-chave
  • Tudo depende do módulo recurring-payments. Módulo desligado devolve 403 module_disabled.
  • Criar e cancelar exige o token do cliente; a consulta de oferta e termos é pública.
  • O desconto é uma porcentagem inteira por frequência; preços em centavos.
  • Criar não cobra nada. As cobranças acontecem depois, a cada ciclo.
  • Cancelar com um id inexistente devolve ok: true; confirme relendo a lista.

Como funciona

Assinatura x compra programada:

AssinaturaCompra programada
IdeiaPago e entregue a cada ciclo até cancelarRecompra com desconto numa frequência
TermosO cliente aceita os termos do produtoSem termos
Rota de criaçãoPOST /recurring/subscriptionsPOST /recurring/scheduled
mode na ofertasubscriptioncustom, allows ou mandatory

O fluxo típico:

  1. Perguntar o que o produto aceita

    Oferta de recorrência. Se enabled for false, não mostre o botão.

  2. Mostrar o preço com desconto e os termos

    Aplique discounts[frequência] ao preço de tabela. Para assinatura, mostre os termos.

  3. Criar

    Assinar ou programar a compra, com o cliente logado.

  4. Gerenciar

    Liste e cancele quando o cliente pedir.

Tabela de frequências (cycle_days e nome do desconto):

cycle_daysFrequência
7semanal
14 (ou 15)quinzenal
30mensal
60bimestral
90trimestral
120quadrimestral
180semestral
365anual

Conceitos-chave

A regra em cascata

A oferta de um produto vem da primeira camada que a define: o produto, depois a categoria, depois o seller. Qualquer camada pode estar disabled, e então o produto não oferece recorrência. O campo source diz de qual camada veio.

Preço do ciclo

preço do ciclo = preço base x (100 - desconto) / 100, com o desconto da frequência. O preço base é o preço atual do produto.

Assinatura e cartão

A cobrança de cada ciclo usa um cartão salvo (carteira) ligado à assinatura. A rota de criação desta seção não envia cartão: card_last_four só aparece quando há um cartão vinculado.

Endpoints

Método e caminhoPara quêAutenticaçãoPágina
GET /api/v1/storefront/recurring/configDiz se o produto aceita recorrência e com que descontosPúblicaOferta de recorrência
GET /api/v1/storefront/recurring/terms/{productId}Termos de assinatura vigentes de um produtoPúblicaOferta de recorrência
GET /api/v1/storefront/recurring/subscriptionsLista as assinaturas do clienteToken do clienteAssinaturas
POST /api/v1/storefront/recurring/subscriptionsCria uma assinaturaToken do clienteAssinaturas
POST /api/v1/storefront/recurring/subscriptions/{id}/cancelCancela uma assinaturaToken do clienteAssinaturas
GET /api/v1/storefront/recurring/scheduledLista as compras programadas do clienteToken do clienteCompras programadas
POST /api/v1/storefront/recurring/scheduledCria uma compra programadaToken do clienteCompras programadas
POST /api/v1/storefront/recurring/scheduled/{id}/cancelCancela uma compra programadaToken do clienteCompras programadas

Erros comuns

O que costuma dar errado
  1. Mostrar "Assinar" sem consultar a oferta: o produto pode não aceitar recorrência.
  2. Usar cycle_days fora da tabela de frequências: o desconto cai na frequência mensal.
  3. Enviar price_cents por conta própria. Omita e deixe a plataforma usar o preço atual do produto.
  4. Presumir que cancelou só porque veio ok: true. Releia a lista.
  5. Não tratar 403 module_disabled: muitas lojas não usam recorrência.
  6. Esperar cobrança imediata ao criar. A primeira cobrança é só no próximo ciclo.

Próximos passos

Oferta de recorrência
O que o produto aceita e os termos.
Assinaturas
Assinar, listar e cancelar.
Compras programadas
Recompra com desconto.
Anterior
Controlar uma grade
Próxima
Oferta de recorrência
Nesta página
  • Como funciona
  • Conceitos-chave
  • A regra em cascata
  • Preço do ciclo
  • Assinatura e cartão
  • Endpoints
  • Erros comuns
  • Próximos passos