> ## Documentation Index
> Fetch the complete documentation index at: https://docs.z2pay.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Atualizar plano
> Altera nome, descrição e metadados do plano. O que se cobra não se muda por aqui.
`PATCH /plans/:id`
Faz parte do recurso [Planos e Preços](/pt-BR/subscriptions/plans) — o conceito e os status estão
lá.
Atualização parcial: envie só os campos que quer alterar. A resposta é o plano atualizado, na mesma
forma de [`GET /plans/{id}`](/pt-BR/subscriptions/plans/get).
**O que a rota altera é a apresentação do plano, não o que ele cobra.** Valor, cadência, período
de teste e `code` não passam por aqui:
* **valor** — crie uma
[nova versão de preço](/pt-BR/subscriptions/plans/prices-post). O preço é versionado justamente
para que reajustar não mexa em quem já assinou;
* **itens** — [adicione](/pt-BR/subscriptions/plans/items) ou
[arquive](/pt-BR/subscriptions/plans/items-delete) um item;
* **cadência, teste e `code`** — não são editáveis. Assinaturas em curso dependem deles, e mudá-los
reescreveria contratos já fechados. Publique um plano novo.
**Plano arquivado não aceita edição.** A rota responde `409`: arquivar é terminal, e o registro
passa a ser somente leitura.
**`metadata` substitui, não mescla.** O objeto enviado passa a ser o `metadata` inteiro — enviar
`{"plano":"pro"}` num plano que tinha `{"origem":"site"}` apaga a chave anterior. Para acrescentar
uma chave, leia o objeto atual e envie-o completo com a nova.
## Exemplo
```bash theme={null}
curl -X PATCH https://api.sandbox.z2pay.com/v1/plans/plan_lhutpqeq2ml3stia4vn90xars \
-H "x-api-key: SUA_CHAVE_DE_SANDBOX" \
-H "Content-Type: application/json" \
-d '{
"name": "Plano Pro (2026)",
"description": null
}'
```
```json Resposta 200 theme={null}
{
"id": "plan_lhutpqeq2ml3stia4vn90xars",
"code": "pro-monthly",
"name": "Plano Pro (2026)",
"description": null,
"status": "active",
"recurrence": {
"interval": 1,
"unit": "month",
"anchor": "subscription_start",
"collectionTiming": "prepaid"
},
"trialSpec": null,
"metadata": {},
"createdAt": "2026-08-10T13:45:30.000Z",
"updatedAt": "2026-08-10T14:02:11.000Z"
}
```
## OpenAPI
````yaml openapi/billing.json PATCH /plans/{id}
openapi: 3.0.3
info:
title: Z2Pay Billing API
version: 1.0.0
description: Cobrança recorrente da Z2Pay — planos, assinaturas e faturas
servers:
- url: https://api.sandbox.z2pay.com/v1
description: Sandbox
- url: https://api.z2pay.com/v1
description: Produção
security: []
tags:
- name: Invoices
description: Faturas emitidas pelas assinaturas
- name: Plans
description: Planos de cobrança e versões de preço
- name: Subscriptions
description: Assinaturas recorrentes
paths:
/plans/{id}:
patch:
tags:
- Plans
summary: Atualizar plano
description: Atualização parcial — envie apenas os campos que deseja alterar.
operationId: PlanController_update
parameters:
- name: id
in: path
required: true
description: ID do plano
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
minLength: 1
maxLength: 255
description: Novo nome do plano.
description:
type: string
maxLength: 1000
nullable: true
description: Nova descrição. Envie `null` para limpar.
metadata:
type: object
additionalProperties: {}
description: Novo objeto de metadados — substitui o anterior.
responses:
'200':
description: Plano atualizado
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Identificador único do registro.
code:
type: string
description: >-
Código de identificação do recurso (ex.: código do plano
ou do contrato).
name:
type: string
description: Nome de exibição do plano ou do componente.
description:
type: string
nullable: true
description: Descrição do item (item do plano ou linha da fatura).
status:
type: string
description: >-
Status atual do registro (assinatura, fatura, plano ou
slip de pagamento).
recurrence:
type: object
nullable: true
description: >-
Cadência da cobrança: a cada quantas unidades
(`interval`), qual unidade (`unit`), a âncora do ciclo e
se cobra no início ou no fim. Vale para todos os itens
recorrentes.
trialSpec:
type: object
nullable: true
description: >-
Período de teste padrão da oferta. A assinatura pode
sobrescrevê-lo.
metadata:
type: object
description: >-
Metadados livres (pares chave-valor) para uso do
integrador; não afeta o processamento.
createdAt:
type: string
format: date-time
description: Data e hora de criação do registro (ISO 8601).
updatedAt:
type: string
format: date-time
description: Data e hora da última atualização do registro (ISO 8601).
example:
id: plan_lhutpqeq2ml3stia4vn90xars
code: pro-monthly
name: Pro Plan (updated)
description: Pro tier with all features and priority support
status: active
recurrence:
interval: 1
unit: month
anchor: subscription_start
collectionTiming: prepaid
trialSpec: null
metadata:
tier: pro
createdAt: '2025-06-29T13:45:30.000Z'
updatedAt: '2025-06-29T14:10:05.000Z'
'400':
description: >-
Requisição inválida — algum parâmetro ou campo do corpo não passou
na validação
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: >-
Identificador estável do erro. É por ele que você deve
ramificar, não pela mensagem.
message:
type: string
description: >-
Descrição legível. Pode mudar sem aviso e não deve ser
usada em condicional.
issues:
type: array
description: >-
Um item por campo rejeitado. Nunca vem vazio: se há
400 de validação, há pelo menos um.
items:
type: object
properties:
path:
type: string
description: >-
Campo que falhou. Vem vazio quando o erro é do
corpo como um todo.
message:
type: string
description: O que há de errado com esse campo.
example:
error:
code: VALIDATION_ERROR
message: Validation failed
issues:
- path: status
message: >-
Status inválido. Valores aceitos: pending,
waiting_payment, paid, refused, canceled, refunded
- path: startDate
message: >-
Data deve ser ISO 8601 com timezone (ex.:
2026-06-24T00:00:00Z)
'401':
description: Chave de API ausente, malformada ou inválida
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: >-
Identificador estável do erro. É por ele que você deve
ramificar, não pela mensagem.
message:
type: string
description: >-
Descrição legível. Pode mudar sem aviso e não deve ser
usada em condicional.
example:
error:
code: UNAUTHORIZED
message: Invalid API key
'404':
description: Plano não encontrado
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: >-
Identificador estável do erro. É por ele que você deve
ramificar, não pela mensagem.
message:
type: string
description: >-
Descrição legível. Pode mudar sem aviso e não deve ser
usada em condicional.
example:
error:
code: NOT_FOUND
message: Plan not found
'409':
description: >-
Já existe uma requisição em andamento com esta Idempotency-Key. A
API aguarda a primeira concluir por até 5 segundos antes de
responder assim
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: >-
Mensagem do conflito de idempotência. Aqui `error` é
texto, não objeto — ramifique pelo status HTTP.
example:
error: A request with this idempotency key is already being processed
'422':
description: >-
Idempotency-Key já usada com um corpo diferente. Use uma chave nova
para uma operação diferente
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: >-
Mensagem do conflito de idempotência. Aqui `error` é
texto, não objeto — ramifique pelo status HTTP.
example:
error: Idempotency key already used with a different request body
security:
- apiKey: []
components:
securitySchemes:
apiKey:
type: apiKey
in: header
name: x-api-key
description: API Key da Credential (gerada no Backoffice)
````