Preços
Criar um preço
Cria um preço.
Cria um recurso
price para um product existente. Campos de valor são
imutáveis depois da criação: para mudar currency, unit_amount, type,
recurring ou product_id, crie outro preço e desative o antigo.
Obrigatórios: product_id, currency e unit_amount (inteiro 0 ou
≥ 500). Com type: "recurring", recurring.interval também é obrigatório.
Todo o resto tem padrão.
Use metadata para correlacionar o preço com IDs do seu sistema. Qualquer
chave funciona; o objeto inteiro é retornado em todos os webhooks.
Autenticação
A API key da própria organização atua diretamente. A API key de plataforma exige o headerOrganization: <organization_id> apontando para uma organização
conectada ativa dessa plataforma.
Attributes
Preço de referência na menor unidade da moeda (centavos em
brl), maior que unit_amount, ou null para remover.
Exemplo: 149700 com unit_amount=29700 permite exibir “De R$ 1.497 por R$ 297”.
Só aparece quando checkout_experience.show_compare_at_amount=true. Não altera
a cobrança. Pode ser editado; sessões já criadas conservam a referência original.O teto depende da moeda. Em brl, o máximo é 999999999 na menor unidade. Acima do teto, a API retorna 400 amount_too_large com param e maximum_amount. Quando o valor já está associado a uma moeda, a resposta inclui currency.Aceita hoje:
brl. Maiúsculas valem como minúsculas (BRL é lido como brl); outra moeda retorna 400 com code: "unsupported_currency". Veja Moedas.Quando
true, atualiza product.default_price para apontar para este preço
imediatamente após a criação. Padrão: false.Valor unitário em minor units (centavos).
0 é válido para one_time e
recurring (preço gratuito). Valores positivos podem começar em 1. O mínimo da cobrança é validado sobre o total final ao confirmar o pagamento.O teto depende da moeda. Em brl, o máximo é 999999999 na menor unidade. Acima do teto, a API retorna 400 amount_too_large com param e maximum_amount. Quando o valor já está associado a uma moeda, a resposta inclui currency.O que a Chargefy resolve sozinha
type— sem valor explícito, o preço nasceone_time.recurring.interval_count— sem valor explícito,1.is_active— o preço nasce ativo.tax_behavior— sem valor explícito,unspecified.metadata— sem valor explícito,{}.livemode— herdado do produto dono.set_as_default— comtrue, odefault_pricedo produto passa a apontar para o preço recém-criado.
Resposta
200 OK com o objeto price completo. Todo campo declarado pelo DTO público
é sempre retornado; vazio é null ou {}.
Erros comuns
Webhook
A criação disparaprice.created
com o price completo em data.object.
