Skip to main content
POST
Criar Preço de Assinatura

Visão Geral

Crie um preço de assinatura para definir quanto e com que frequência os clientes serão cobrados. Um produto pode ter múltiplos preços (ex: mensal, anual).

Parâmetros

Campos Obrigatórios

string
required
UUID do produto pai (ex: prod_abc123xyz). O produto deve ser do tipo subscription.
string
required
Nome do plano exibido ao cliente (ex: “Plano Mensal”).
number
required
Valor em Reais (ex: 49.90).
string
required
Intervalo de cobrança: daily, weekly, monthly, annually.

Campos Opcionais

integer
default:"0"
Dias de teste gratuito antes da primeira cobrança.
boolean
default:"true"
Se o plano está disponível para novos assinantes.
A moeda padrão é BRL (Real Brasileiro). Não é necessário enviar o campo currency na requisição.

Exemplo de Requisição

Resposta de Sucesso

number
ID interno do preço.
string
Identificador único usado no link de checkout.
string
UUID do produto pai.
string
Nome do plano.
number
Valor em Reais.
string
Intervalo de cobrança.
number
Dias de teste gratuito.
boolean
Se o plano está ativo.

Exemplo de Resposta (201 Created)

Intervalos de Cobrança

Após criar o preço de assinatura, você pode gerar o link de pagamento combinando o UUID do produto com o ID do preço.

Exemplo

Considerando:
  • Produto criado com uuid: c69c63d2-4207-4613-ad69-28e7e902544b
  • Preço criado com id: price_gNgQVRrG5goab0Ql
O link de pagamento será:

Exemplo Completo em Código

Salve o uuid do produto e o id do preço no seu banco de dados para poder gerar links de pagamento a qualquer momento.

Múltiplos Planos

Crie diferentes planos para o mesmo produto:

Próximos Passos

Listar Preços

Consulte todos os preços cadastrados

Listar Assinaturas

Consulte as assinaturas ativas