Preços de oferta do Merchant

Um preço de oferta (offer price) é o valor de uma oferta em uma moeda: um valor em unidades menores inteiras (integer minor units) mais sua moeda ISO 4217. Uma oferta pode ter vários preços para que o mesmo plano seja vendido em vários mercados.

Um preço por oferta é o padrão (default) — o usado quando uma cobrança não indica um preço específico. Os preços são excluídos de forma reversível (soft-deleted), então um preço ainda referenciado por uma assinatura ativa pode ser restaurado em vez de perdido.

O objeto offer price

Retornado pelos endpoints de listagem e consulta desta página.

Endpoints

DELETE/api/v1/merchant/offer-prices/:id

Exclui um preço de oferta de forma reversível (soft-delete).

Parâmetros de caminho

Exemplo de requisição

curl -X DELETE https://api.tokeflow.com/api/v1/merchant/offer-prices/obj_1a2b3c4d \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9…" \
  -H "x-merchant-id: mrc_8a3f12d9"

Exemplo de resposta — 204 No Content

Um corpo vazio é retornado em caso de sucesso.

GET/api/v1/merchant/offer-prices/:id

Obtém um preço de oferta pelo ID.

Parâmetros de caminho

Exemplo de requisição

curl https://api.tokeflow.com/api/v1/merchant/offer-prices/obj_1a2b3c4d \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9…" \
  -H "x-merchant-id: mrc_8a3f12d9"

Exemplo de resposta — 200

{
  "id": "opr_b1c2d3e4f5",
  "offer_id": "ofr_a1b2c3d4e5",
  "currency": "BRL",
  "amount": 9900,
  "first_charge_amount": 0,
  "is_default": true,
  "created_at": "2026-05-19T12:00:00Z",
  "updated_at": "2026-05-19T12:00:00Z"
}

PATCH/api/v1/merchant/offer-prices/:id

Atualiza um preço de oferta.

Parâmetros de caminho

Exemplo de requisição

curl -X PATCH https://api.tokeflow.com/api/v1/merchant/offer-prices/obj_1a2b3c4d \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9…" \
  -H "x-merchant-id: mrc_8a3f12d9" \
  -H "Content-Type: application/json" \
  -d '{}'

Exemplo de resposta — 200

{
  "id": "opr_b1c2d3e4f5",
  "offer_id": "ofr_a1b2c3d4e5",
  "currency": "BRL",
  "amount": 9900,
  "first_charge_amount": 0,
  "is_default": true,
  "created_at": "2026-05-19T12:00:00Z",
  "updated_at": "2026-05-19T12:00:00Z"
}

POST/api/v1/merchant/offer-prices/:id/restore

Restaura um preço de oferta excluído de forma reversível.

Parâmetros de caminho

Exemplo de requisição

curl -X POST https://api.tokeflow.com/api/v1/merchant/offer-prices/obj_1a2b3c4d/restore \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9…" \
  -H "x-merchant-id: mrc_8a3f12d9"

Exemplo de resposta — 201

{
  "id": "opr_b1c2d3e4f5",
  "offer_id": "ofr_a1b2c3d4e5",
  "currency": "BRL",
  "amount": 9900,
  "first_charge_amount": 0,
  "is_default": true,
  "created_at": "2026-05-19T12:00:00Z",
  "updated_at": "2026-05-19T12:00:00Z"
}

GET/api/v1/merchant/offers/:offerId/prices

Lista os preços de uma oferta.

Parâmetros de caminho

Parâmetros de consulta

Exemplo de requisição

curl -G https://api.tokeflow.com/api/v1/merchant/offers/ofr_5e2b8c14/prices \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9…" \
  -H "x-merchant-id: mrc_8a3f12d9" \
  --data-urlencode "page=1" \
  --data-urlencode "limit=20" \
  --data-urlencode "currency=BRL" \
  --data-urlencode "is_default=True"

Exemplo de resposta — 200

{
  "data": [
    {
      "id": "opr_b1c2d3e4f5",
      "offer_id": "ofr_a1b2c3d4e5",
      "currency": "BRL",
      "amount": 9900,
      "first_charge_amount": 0,
      "is_default": true,
      "created_at": "2026-05-19T12:00:00Z",
      "updated_at": "2026-05-19T12:00:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 42,
    "total_pages": 3,
    "has_next": true,
    "has_prev": false
  }
}

POST/api/v1/merchant/offers/:offerId/prices

Adiciona um preço a uma oferta.

Parâmetros de caminho

Campos da requisição

Exemplo de requisição

curl -X POST https://api.tokeflow.com/api/v1/merchant/offers/ofr_5e2b8c14/prices \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9…" \
  -H "x-merchant-id: mrc_8a3f12d9" \
  -H "Content-Type: application/json" \
  -d '{
    "currency": "BRL",
    "amount": 9900,
    "first_charge_amount": 0,
    "is_default": true
  }'

Exemplo de resposta — 201

{
  "id": "opr_b1c2d3e4f5",
  "offer_id": "ofr_a1b2c3d4e5",
  "currency": "BRL",
  "amount": 9900,
  "first_charge_amount": 0,
  "is_default": true,
  "created_at": "2026-05-19T12:00:00Z",
  "updated_at": "2026-05-19T12:00:00Z"
}

Erros

Os erros usam o envelope padrão. Os casos mais comuns aqui:

Relacionados

• Ofertas do Merchant
• Preços de oferta (API pública)
• Assinaturas do Merchant