GuiasReferência da APIWebhooksVoltar para a Dashboard
Planos

Editar plano

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.

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
/plans/{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

name?string
Lengthlength <= 255
description?string | null
is_active?boolean

Response Body

curl -X PATCH "https://pagpolar-api.creativecode.dev.br/v1/plans/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "name": "Assinatura Premium",    "description": "Acesso completo à plataforma, renovação mensal"  }'

{
  "data": {
    "id": "a8b9c0d1-e2f3-4a4b-5c6d-7e8f9a0b1c2d",
    "name": "Assinatura Premium",
    "description": "Acesso completo à plataforma, renovação mensal",
    "author": null,
    "promotional_text": null,
    "is_active": true,
    "image": null,
    "type": "SUBSCRIPTION",
    "content_type": "DEFAULT",
    "warranty_time": 7,
    "category": null,
    "created_at": "2026-01-15T12:00:00.000Z",
    "updated_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"
  }
}

Editar oferta de plano PATCH

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.

Vendas

Cobre por PIX, boleto ou cartão e consulte as vendas.