GuiasReferência da APIWebhooksVoltar para a Dashboard
Planos

Editar oferta de plano

Edita campos comerciais de uma oferta de plano já criada. Envie apenas os campos que deseja atualizar (edição parcial) — o corpo não pode vir vazio.

Não é possível alterar product_id ou is_default por aqui — a troca de oferta padrão continua sendo feita apenas pelo painel.

Sem campo de autorização: o portal autentica por você com a sua chave de Homologação e as requisições rodam só no ambiente de testes.

PATCH
/plan-offers/{id}

Authorization

AuthorizationBearer <token>

Token de acesso devolvido por POST /auth/token. Envie como "Authorization: Bearer ". Vale 24 horas.

In: header

Path Parameters

idstring
Formatuuid

Request Body

price?integer

Preço da oferta em centavos, número inteiro — a mesma unidade de offer.value. 4990 = R$ 49,90. Valor com casas decimais retorna 400.

Range0 <= value
cycle?string
Value in"WEEKLY" | "MONTHLY" | "YEARLY"
cycle_interval?integer
Range1 <= value
title?string | null
is_active?boolean
is_enabled_pix?boolean

PIX. Mínimo de R$ 5,00. Os três meios começam ligados, mas cada um só fica ligado se o preço atinge o mínimo dele: PIX R$ 5,00, cartão R$ 5,00 e boleto R$ 10,00. Abaixo do mínimo, o meio é desligado ao salvar, mesmo enviando true. Envie false para desligar um meio acima do mínimo. Na edição sem price, só os meios enviados são recalculados; com price, os três são recalculados.

Defaulttrue
is_enabled_credit_card?boolean

Cartão de crédito. Mínimo de R$ 5,00. Os três meios começam ligados, mas cada um só fica ligado se o preço atinge o mínimo dele: PIX R$ 5,00, cartão R$ 5,00 e boleto R$ 10,00. Abaixo do mínimo, o meio é desligado ao salvar, mesmo enviando true. Envie false para desligar um meio acima do mínimo. Na edição sem price, só os meios enviados são recalculados; com price, os três são recalculados.

Defaulttrue
is_enabled_billet?boolean

Boleto. Mínimo de R$ 10,00. Os três meios começam ligados, mas cada um só fica ligado se o preço atinge o mínimo dele: PIX R$ 5,00, cartão R$ 5,00 e boleto R$ 10,00. Abaixo do mínimo, o meio é desligado ao salvar, mesmo enviando true. Envie false para desligar um meio acima do mínimo. Na edição sem price, só os meios enviados são recalculados; com price, os três são recalculados.

Defaulttrue
max_credit_card_installments?integer

Ofertas de plano não podem ser parceladas no cartão de crédito — envie 1 ou omita o campo (default). Valores acima de 1 retornam 400.

Response Body

curl -X PATCH "https://pagpolar-api.creativecode.dev.br/v1/plan-offers/b9c0d1e2-f3a4-4b5c-6d7e-8f9a0b1c2d3e" \  -H "Content-Type: application/json" \  -d '{    "price": 11790  }'

{
  "data": {
    "id": "b9c0d1e2-f3a4-4b5c-6d7e-8f9a0b1c2d3e",
    "identifier": "PPP1234567890",
    "title": "Plano Mensal",
    "price": 117.9,
    "is_active": true,
    "is_default": true,
    "product_id": "a8b9c0d1-e2f3-4a4b-5c6d-7e8f9a0b1c2d",
    "payment_methods": {
      "pix": true,
      "credit_card": true,
      "billet": false
    },
    "max_credit_card_installments": 1,
    "cycle": "MONTHLY",
    "cycle_interval": 1,
    "cycle_interval_limit": null,
    "allow_purchase_quantity": false,
    "purchase_quantity_limit": null,
    "purchase_quantity_min": 1,
    "expires_at": null,
    "created_at": "2026-01-15T12:00:00.000Z"
  }
}
{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "request_id": "string"
  }
}
{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "request_id": "string"
  }
}
{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "request_id": "string"
  }
}
{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "request_id": "string"
  }
}
{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "request_id": "string"
  }
}

Listar planos GET

Um plano é um produto do tipo `SUBSCRIPTION` — aparece aqui, não em `GET /products`.

Editar plano PATCH

Edita campos básicos de um plano já criado. Só `name`, `description` e `is_active` podem ser alterados por aqui — envie apenas os campos que deseja atualizar (edição parcial). O corpo não pode vir vazio: pelo menos um dos três campos precisa ser enviado.