Skip to main content
DELETE
DELETE /subscription/plan/{id} arquiva de forma suave um plano definindo o timestamp deletedAt dele. As assinaturas existentes no plano arquivado continuam faturando normalmente. Na próxima data de renovação de cada assinante, o Therius cancelará essas assinaturas em vez de renová-las. Nenhum assinante novo pode se inscrever em um plano arquivado.
Isto é um soft-delete — a linha do plano não é removida de forma permanente, então ela permanece no banco de dados para fins de auditoria. No entanto, ela é excluída dos resultados de lista de GET /subscription/plan assim que arquivada (esse endpoint filtra os planos excluídos); consulte-a diretamente via GET /subscription/plan/{id} se precisar inspecionar um plano arquivado.
Devolve 200 OK com { "deleted": true }.

​
Erros

Assim que um plano é arquivado, os assinantes existentes serão cancelados automaticamente na próxima renovação deles. Migre os assinantes para um novo plano usando change-plan antes de arquivar se você quiser que eles continuem faturando sem interrupção.

Autorizações

​
Authorization
string
header
obrigatório

Your secret API key: Bearer prv_production_xxx (production) or Bearer prv_sandbox_xxx (sandbox).

Parâmetros de caminho

​
id
string
obrigatório

Parâmetros de consulta

​
merchantCode
string
obrigatório

Your merchant account identifier. Validated against the Bearer key's merchant.

Resposta

200 - application/json

Plan archived

​
deleted
boolean
Exemplo:

true