> ## 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 item do plano
> Altera nome, quantidade padrão, ordem, descrição e metadados do item. O valor não se muda por aqui.
`PATCH /plans/:id/items/:itemId`
Faz parte do recurso [Planos e Preços](/pt-BR/subscriptions/plans) — o item, o preço versionado e
os status estão lá.
Atualização parcial: envie só os campos que quer alterar. A resposta é o item atualizado.
**O valor cobrado não passa por aqui.** Para mudar quanto o item custa, crie uma
[nova versão de preço](/pt-BR/subscriptions/plans/prices-post) — o preço é versionado justamente
para que o reajuste não alcance quem já assinou. Alterar o valor no lugar reescreveria contratos
fechados.
**`key` e `kind` não são editáveis.** A `key` é a referência estável do item, e mudá-la quebraria
quem a usa; `kind` decide se a cobrança recorre ou acontece uma vez, e virar um no outro mudaria a
natureza do que já foi contratado. Para trocar qualquer um dos dois,
[arquive o item](/pt-BR/subscriptions/plans/items-delete) e crie outro.
**`quantityDefault` só vale para as assinaturas seguintes.** É a quantidade com que o item nasce
quando alguém assina — quem já assinou tem a sua quantidade gravada na assinatura, e ela não muda.
**Plano arquivado não aceita edição de item.** A rota responde `409`. O item de um plano
arquivado é somente leitura, como o plano.
**`metadata` substitui, não mescla.** O objeto enviado passa a ser o `metadata` inteiro. 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/items/pli_x0hn9c2eqp7wl4tzka8m3vgdi \
-H "x-api-key: SUA_CHAVE_DE_SANDBOX" \
-H "Content-Type: application/json" \
-d '{
"name": "Suporte premium 24/7",
"displayOrder": 1
}'
```
```json Resposta 200 theme={null}
{
"id": "pli_x0hn9c2eqp7wl4tzka8m3vgdi",
"planId": "plan_lhutpqeq2ml3stia4vn90xars",
"key": "suporte-premium",
"name": "Suporte premium 24/7",
"kind": "recurring",
"quantityDefault": 1,
"displayOrder": 1,
"description": null,
"metadata": {},
"createdAt": "2026-08-10T15:10:00.000Z",
"updatedAt": "2026-08-10T15:32:44.000Z"
}
```
## OpenAPI
````yaml openapi/billing.json PATCH /plans/{id}/items/{itemId}
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}/items/{itemId}:
patch:
tags:
- Plans
summary: Atualizar item do plano
description: >-
Altera os dados do item. Para mudar o valor cobrado, crie uma nova
versão de preço — o preço é versionado justamente para não alterar o que
as assinaturas em curso contrataram.
operationId: PlanController_updateItem
parameters:
- name: itemId
in: path
required: true
description: ID do item do plano
schema:
type: string
- 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 item.
quantityDefault:
type: integer
minimum: 0
exclusiveMinimum: true
description: Nova quantidade padrão.
displayOrder:
type: integer
minimum: 0
description: Nova ordem de exibição na consulta 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.
responses:
'200':
description: Item atualizado
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Identificador único do registro.
planId:
type: string
description: ID do plano ao qual o registro pertence.
key:
type: string
description: >-
Chave única e legível (slug) do componente dentro do
plano.
name:
type: string
description: Nome de exibição do plano ou do componente.
kind:
type: string
enum:
- recurring
- activation
description: >-
Natureza da cobrança: `recurring` cobra a cada ciclo;
`activation` cobra uma única vez, na fatura de adesão.
quantityDefault:
type: integer
description: >-
Quantidade padrão do componente ao instanciar a
assinatura.
displayOrder:
type: integer
description: Ordem de exibição do componente na listagem do plano.
description:
type: string
nullable: true
description: Descrição do item (item do plano ou linha da fatura).
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: pli_lggs2vulsryis0t35qbqfpjyg
planId: plan_lhutpqeq2ml3stia4vn90xars
key: welcome-kit
name: Welcome Kit (Premium)
kind: recurring
quantityDefault: 1
displayOrder: 1
description: One-time premium onboarding kit
metadata: {}
createdAt: '2025-06-29T14:30:00.000Z'
updatedAt: '2025-06-29T14:45:00.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 ou item 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: Item 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)
````