Skip to main content
POST
Arquivar uma versão de preço
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

Resposta 200

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Path Parameters

priceId
string
required

ID da versão de preço a arquivar

id
string
required

ID do plano

Response

Versão de preço arquivada

id
string

Identificador único do registro.

planItemId
string

ID do componente (plan item) ao qual o preço se refere.

planId
string

ID do plano ao qual o registro pertence.

billingScheme
string

Esquema de cobrança do preço: fixed, per_unit, tiered, package ou metered.

amount
integer

Valor do preço ou da linha, em centavos.

currency
string

Moeda no padrão ISO 4217 (ex.: BRL).

recurrence
object

Regra de recorrência (intervalo, unidade e âncora do ciclo).

trialSpec
object | null

Configuração do período de teste (trial) do preço; nula se sem trial.

isCurrent
boolean

Indica se esta é a versão de preço atualmente vigente.

publishedAt
string<date-time> | null

Data e hora em que a versão de preço foi publicada (ISO 8601).

archivedAt
string<date-time> | null

Data e hora em que a versão de preço foi arquivada; nula se ainda vigente (ISO 8601).

createdAt
string<date-time>

Data e hora de criação do registro (ISO 8601).

updatedAt
string<date-time>

Data e hora da última atualização do registro (ISO 8601).