curl --request DELETE \
--url https://api.sandbox.z2pay.com/v1/plans/{id}/items/{itemId} \
--header 'x-api-key: <api-key>'const options = {method: 'DELETE', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.z2pay.com/v1/plans/{id}/items/{itemId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sandbox.z2pay.com/v1/plans/{id}/items/{itemId}"
headers = {"x-api-key": "<api-key>"}
response = requests.delete(url, headers=headers)
print(response.text){
"id": "pli_lggs2vulsryis0t35qbqfpjyg",
"planId": "plan_lhutpqeq2ml3stia4vn90xars",
"key": "welcome-kit",
"name": "Welcome Kit",
"kind": "recurring",
"quantityDefault": 1,
"displayOrder": 1,
"description": "One-time onboarding kit",
"metadata": {},
"createdAt": "2025-06-29T14:30:00.000Z",
"updatedAt": "2025-06-29T15:10:00.000Z",
"deletedAt": "2025-06-29T15:10:00.000Z"
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Item not found"
}
}{
"error": {
"code": "CONFLICT",
"message": "No refundable payment found"
}
}{
"error": "Idempotency key already used with a different request body"
}Arquivar item do plano
Retira o item do catálogo. Quem já assinou continua sendo cobrado por ele.
curl --request DELETE \
--url https://api.sandbox.z2pay.com/v1/plans/{id}/items/{itemId} \
--header 'x-api-key: <api-key>'const options = {method: 'DELETE', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.z2pay.com/v1/plans/{id}/items/{itemId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sandbox.z2pay.com/v1/plans/{id}/items/{itemId}"
headers = {"x-api-key": "<api-key>"}
response = requests.delete(url, headers=headers)
print(response.text){
"id": "pli_lggs2vulsryis0t35qbqfpjyg",
"planId": "plan_lhutpqeq2ml3stia4vn90xars",
"key": "welcome-kit",
"name": "Welcome Kit",
"kind": "recurring",
"quantityDefault": 1,
"displayOrder": 1,
"description": "One-time onboarding kit",
"metadata": {},
"createdAt": "2025-06-29T14:30:00.000Z",
"updatedAt": "2025-06-29T15:10:00.000Z",
"deletedAt": "2025-06-29T15:10:00.000Z"
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Item not found"
}
}{
"error": {
"code": "CONFLICT",
"message": "No refundable payment found"
}
}{
"error": "Idempotency key already used with a different request body"
}DELETE /plans/:id/items/:itemId
Faz parte do recurso Planos e Preços — o item, o preço versionado e
os status estão lá.
Tira o item do plano. Ele deixa de aparecer em GET /plans/{id} e
não entra em nenhuma assinatura nova. A resposta é o item, já com deletedAt preenchido.
default não pode ser arquivado. É o item que sustenta o plano; sem ele não sobraria o
que cobrar. A rota responde 409.409 — no plano arquivado nada mais muda,
nem os itens.key volta a ficar livre. Arquivar é remoção lógica, e um item novo pode reusar a mesma
key depois. Ver Adicionar item.Exemplo
curl -X DELETE https://api.sandbox.z2pay.com/v1/plans/plan_lhutpqeq2ml3stia4vn90xars/items/pli_x0hn9c2eqp7wl4tzka8m3vgdi \
-H "x-api-key: SUA_CHAVE_DE_SANDBOX"
{
"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:48:12.000Z"
}
Authorizations
API Key da Credential (gerada no Backoffice)
Response
Item arquivado
Identificador único do registro.
ID do plano ao qual o registro pertence.
Chave única e legível (slug) do componente dentro do plano.
Nome de exibição do plano ou do componente.
Natureza da cobrança: recurring cobra a cada ciclo; activation cobra uma única vez, na fatura de adesão.
recurring, activation Quantidade padrão do componente ao instanciar a assinatura.
Ordem de exibição do componente na listagem do plano.
Descrição do item (item do plano ou linha da fatura).
Metadados livres (pares chave-valor) para uso do integrador; não afeta o processamento.
Data e hora de criação do registro (ISO 8601).
Data e hora da última atualização do registro (ISO 8601).
Data e hora de exclusão (soft delete); nulo se ativo.