Skip to main content
POST
Arquivar plano
POST /plans/:id/archive Faz parte do recurso Planos e Preços — o conceito e os status estão lá. Move o plano para archived: ele deixa de aceitar novas assinaturas e passa a ser somente leitura. A resposta é o plano já arquivado.
Não há como desarquivar. archived é terminal — nenhuma rota volta atrás, e o painel também não. Para pausar as vendas de forma reversível, o caminho é deixar o plano inactive pelo painel; a API não expõe essa transição.
Quem já assinou continua sendo cobrado. Arquivar fecha o catálogo, não os contratos: as assinaturas em curso seguem emitindo faturas nos preços que contrataram. Para encerrar uma delas, use POST /subscriptions/{id}/cancel.
O code continua ocupado. Arquivar não libera o código para reúso — criar um plano novo com o mesmo code responde 409. Use um código diferente, como um sufixo de ano ou de versão.
Arquivar de novo não é erro. A rota devolve 200 com o plano já arquivado — repetir a chamada é seguro, e não há um 409 para o caso.

Exemplo

Resposta 200

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Path Parameters

id
string
required

ID do plano

Response

Plano arquivado

id
string

Identificador único do registro.

code
string

Código de identificação do recurso (ex.: código do plano ou do contrato).

name
string

Nome de exibição do plano ou do componente.

description
string | null

Descrição do item (item do plano ou linha da fatura).

status
string

Status atual do registro (assinatura, fatura, plano ou slip de pagamento).

recurrence
object | null

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
object | null

Período de teste padrão da oferta. A assinatura pode sobrescrevê-lo.

metadata
object

Metadados livres (pares chave-valor) para uso do integrador; não afeta o processamento.

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).