Arquivar uma versão de preço
curl --request POST \
--url https://api.sandbox.z2pay.com/v1/plans/{id}/prices/{priceId}/archive \
--header 'x-api-key: <api-key>'const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.z2pay.com/v1/plans/{id}/prices/{priceId}/archive', 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}/prices/{priceId}/archive"
headers = {"x-api-key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text){
"id": "price_l1r8693wk6ksbd9044bwvwu93",
"planItemId": "pli_oaimno59ai3uuqwq0ti7gxs0j",
"planId": "plan_lhutpqeq2ml3stia4vn90xars",
"billingScheme": "fixed",
"amount": 9900,
"currency": "BRL",
"recurrence": {
"interval": 1,
"unit": "month",
"anchor": "subscription_start",
"collectionTiming": "prepaid"
},
"trialSpec": null,
"isCurrent": false,
"publishedAt": "2025-06-29T13:45:30.000Z",
"archivedAt": "2025-06-29T16:30:00.000Z",
"createdAt": "2025-06-29T13:45:30.000Z",
"updatedAt": "2025-06-29T16:30:00.000Z"
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Price not found"
}
}{
"error": "A request with this idempotency key is already being processed"
}{
"error": "Idempotency key already used with a different request body"
}Preços
Arquivar versão de preço
Tira uma versão de circulação. Serve para corrigir um preço criado errado, não para reajustar.
POST
/
plans
/
{id}
/
prices
/
{priceId}
/
archive
Arquivar uma versão de preço
curl --request POST \
--url https://api.sandbox.z2pay.com/v1/plans/{id}/prices/{priceId}/archive \
--header 'x-api-key: <api-key>'const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.z2pay.com/v1/plans/{id}/prices/{priceId}/archive', 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}/prices/{priceId}/archive"
headers = {"x-api-key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text){
"id": "price_l1r8693wk6ksbd9044bwvwu93",
"planItemId": "pli_oaimno59ai3uuqwq0ti7gxs0j",
"planId": "plan_lhutpqeq2ml3stia4vn90xars",
"billingScheme": "fixed",
"amount": 9900,
"currency": "BRL",
"recurrence": {
"interval": 1,
"unit": "month",
"anchor": "subscription_start",
"collectionTiming": "prepaid"
},
"trialSpec": null,
"isCurrent": false,
"publishedAt": "2025-06-29T13:45:30.000Z",
"archivedAt": "2025-06-29T16:30:00.000Z",
"createdAt": "2025-06-29T13:45:30.000Z",
"updatedAt": "2025-06-29T16:30:00.000Z"
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Price not found"
}
}{
"error": "A request with this idempotency key is already being processed"
}{
"error": "Idempotency key already used with a different request body"
}POST /plans/:id/prices/:priceId/archive
Faz parte do recurso Planos e Preços — o item, o preço versionado e
os status estão lá.
Marca a versão com archivedAt e a tira de vigência (isCurrent: false). A resposta é a versão já
arquivada.
Arquivar a versão vigente deixa o item sem preço. Nada é promovido no lugar: o item passa a
responder com
currentPrice nulo em GET /plans/{id}, e uma
assinatura criada nesse estado não encontra o que cobrar.Se a intenção é trocar o valor, crie a versão nova primeiro — ela desbanca a anterior sozinha,
e aí não há por que arquivar. Ver
Criar versão de preço.Isto não é o caminho do reajuste. Reajustar é publicar uma versão nova; arquivar existe para
tirar de circulação uma versão criada errada — o valor digitado com um zero a mais, por exemplo.
Quem contratou a versão continua nela. Arquivar mexe no catálogo, não nos contratos: as
assinaturas que já cobravam nesse preço seguem cobrando. A versão também continua aparecendo na
listagem, agora com
archivedAt preenchido.Arquivar duas vezes responde
409. Diferente do plano, em que repetir o arquivamento é
inofensivo, aqui a segunda chamada é recusada.O plano no caminho é conferido. Um
priceId que existe mas pertence a outro plano responde
404, como se o endereço não existisse. Plano arquivado responde 409.Exemplo
curl -X POST https://api.sandbox.z2pay.com/v1/plans/plan_lhutpqeq2ml3stia4vn90xars/prices/price_c8u3fwq1bnz5vhk60msyxrtae/archive \
-H "x-api-key: SUA_CHAVE_DE_SANDBOX"
Resposta 200
{
"id": "price_c8u3fwq1bnz5vhk60msyxrtae",
"planItemId": "pli_oaimno59ai3uuqwq0ti7gxs0j",
"planId": "plan_lhutpqeq2ml3stia4vn90xars",
"billingScheme": "fixed",
"amount": 11900,
"currency": "BRL",
"isCurrent": false,
"publishedAt": "2026-08-10T16:04:20.000Z",
"archivedAt": "2026-08-10T16:22:03.000Z",
"updatedAt": "2026-08-10T16:22:03.000Z"
}
Authorizations
API Key da Credential (gerada no Backoffice)
Response
Versão de preço arquivada
Identificador único do registro.
ID do componente (plan item) ao qual o preço se refere.
ID do plano ao qual o registro pertence.
Esquema de cobrança do preço: fixed, per_unit, tiered, package ou metered.
Valor do preço ou da linha, em centavos.
Moeda no padrão ISO 4217 (ex.: BRL).
Regra de recorrência (intervalo, unidade e âncora do ciclo).
Configuração do período de teste (trial) do preço; nula se sem trial.
Indica se esta é a versão de preço atualmente vigente.
Data e hora em que a versão de preço foi publicada (ISO 8601).
Data e hora em que a versão de preço foi arquivada; nula se ainda vigente (ISO 8601).
Data e hora de criação do registro (ISO 8601).
Data e hora da última atualização do registro (ISO 8601).