Criar uma oferta

POST /v1/products/{productId}/offers · Requer o escopo products:write

Uma oferta é um preço específico de um produto — avulso ou recorrente. Um produto pode ter várias; exatamente uma é a padrão.

A nova oferta vira a padrão do produto se você passar is_default: true, ou se o produto não tiver nenhuma padrão ativa no momento. Promover uma oferta a padrão rebaixa a anterior.

Parâmetros de caminho

string

obrigatório

Produto ao qual anexar a oferta. Se não for um ID prod_ válido → 400 (invalid_product_id).

Parâmetros do corpo

integer

obrigatório

Preço em unidades menores (centavos). De 1 a 99999999999.

string

obrigatório

ISO 4217 em maiúsculas, ex. BRL.

string

Rótulo da oferta, de 1 a 160 caracteres. Padrão: "Padrão".

integer

Um preço de referência riscado. Deve ser ≥ amount_minor.

string

padrão:"one_time"

one_time ou recurring.

string

day, week, month ou year. Obrigatório quando type é recurring; rejeitado quando one_time.

integer

Número de intervalos entre cobranças, de 1 a 999. Só para recorrente; padrão 1.

boolean

Passe true para tornar esta a oferta padrão do produto.

Requisição

cURL

curl --request POST \
  https://api.moneydev.com.br/v1/products/prod_4d5e6f7a-8b9c-4d0e-1f2a-3b4c5d6e7f8a/offers \
  --header "Authorization: Bearer $ACCESS_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "Mensal",
    "amount_minor": 4990,
    "currency": "BRL",
    "type": "recurring",
    "billing_interval": "month"
  }'

Resposta

201 Created com o objeto de oferta.

Erros

Status	`code`	Causa
`400`	`invalid_product_id`	O trecho do caminho não é um ID `prod_` válido
`400`	`invalid_request`	Validação falhou; `param` indica o campo
`400`	`invalid_compare_at_amount`	`compare_at_amount_minor` é menor que `amount_minor`
`400`	`billing_interval_required`	`type` é `recurring` sem `billing_interval`
`400`	`invalid_one_time_billing`	Uma oferta `one_time` informou `billing_interval` ou `interval_count`
`404`	`product_not_found`	Não existe esse produto, ou ele está arquivado

Objeto de oferta

string

ID da oferta, com prefixo offer_.

string

Sempre "offer".

string

ID do produto pai.

string

Rótulo da oferta.

string

Uma chave estável, gerada pelo sistema, para a oferta.

integer

Preço em unidades menores.

integer | null

Preço de referência, ou null.

string

Moeda ISO 4217.

string

one_time ou recurring.

string | null

day / week / month / year, ou null para avulso.

integer | null

Intervalos entre cobranças, ou null para avulso.

boolean

Se esta é a oferta padrão do produto.

boolean

Se a oferta pode ser usada em novos checkouts.

string

Data/hora de criação em ISO 8601.

string

Data/hora da última alteração em ISO 8601.

Introdução

Conta

Clientes

Produtos

Ofertas

Checkouts

Parâmetros de caminho

Parâmetros do corpo

Requisição

Resposta

Erros

Objeto de oferta

​Parâmetros de caminho

​Parâmetros do corpo

​Requisição

​Resposta

​Erros

​Objeto de oferta

Parâmetros de caminho

Parâmetros do corpo

Requisição

Resposta

Erros

Objeto de oferta