Pause e retome uma assinatura

Pausar uma assinatura para todas as tentativas de renovação sem cancelá-la, preservando o registro da assinatura e todo o histórico dela. Retomar restaura o faturamento e recalcula a próxima data de faturamento para frente a partir da data atual — o cliente não é cobrado pelo tempo decorrido enquanto esteve pausada.

Pausar uma assinatura

POST /subscription/{id}/pause suspende o faturamento de uma assinatura ativa. Dispara o evento de webhook subscription.paused e move a assinatura para o status paused.

Somente assinaturas no status active, trialing ou past_due podem ser pausadas. Tentar pausar uma assinatura cancelled, completed ou já paused devolve um erro 400.

Exemplo

curl -X POST https://api.therius.io/v1/subscription/sub_abc123def456/pause \
  -H "Authorization: Bearer prv_production_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ "merchantCode": "MERCHANT_001" }'

Retomar uma assinatura

POST /subscription/{id}/resume restaura o faturamento de uma assinatura pausada ou suspensa, com um comportamento ligeiramente diferente conforme o status atual.

Status atual	Comportamento ao retomar
`paused`	Faturamento restaurado. Próxima data de faturamento = hoje + intervalo do plano.
`suspended`	O Therius tenta uma nova cobrança imediata (MIT). Devolve `402` se recusada.

Se retomar a partir de suspended devolver 402 (cartão recusado), você deve primeiro atualizar o método de pagamento usando POST /subscription/{id}/payment-method antes de tentar retomar novamente.

Em caso de sucesso, o Therius dispara subscription.resumed. Se uma assinatura suspended for revivida por uma cobrança bem-sucedida, ele também dispara subscription.reactivated.

Erros

Código	Significado
`400`	A assinatura não está em um estado retomável (p. ex. já `active` ou `cancelled`).
`402`	A retomada a partir de `suspended` falhou — a nova cobrança imediata foi recusada.
`404`	Assinatura não encontrada.

Exemplo

curl -X POST https://api.therius.io/v1/subscription/sub_abc123def456/resume \
  -H "Authorization: Bearer prv_production_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ "merchantCode": "MERCHANT_001" }'

curl -X POST https://api.therius.io/v1/subscription/sub_abc123def456/pause \
  -H "Authorization: Bearer prv_production_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ "merchantCode": "MERCHANT_001" }'

{}

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

string

obrigatório

Corpo

application/json

merchantCode

string

obrigatório

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

Resposta

200 - application/json

Subscription paused

A customer enrollment in a plan. plan is embedded on single-subscription responses. Invoice/event history is not included here - use the invoice endpoints.

string

Subscription UUID.

merchantId

integer

The merchant account that owns the subscription.

planId

integer

ID of the plan this subscription is enrolled in.

customerEmail

string

Subscriber email, used for billing and dunning notifications.

customerName

string

Subscriber name as it appears on invoices.

customerDocument

string

Subscriber national ID / tax document, where a market requires it (e.g. Brazil CPF/CNPJ).

cardBrand

string

Brand of the card on the mandate, e.g. visa.

status

enum<string>

pending - awaiting first charge; trialing - in a free trial; active - billing normally; past_due - a renewal failed and dunning is running; suspended - dunning exhausted, needs a new CIT (POST /subscription/{id}/payment-method in CIT mode) to recover; paused - billing stopped on request, resumable; cancelled - terminated; completed - reached maxBillingCycles.

Opções disponíveis:

pending,

trialing,

active,

past_due,

suspended,

paused,

cancelled,

completed

currentPeriodStart

string<date-time>

Start of the current billing period.

currentPeriodEnd

string<date-time>

End of the current billing period.

nextBillingDate

string<date-time>

When the next renewal charge is scheduled.

trialStart

string<date-time>

Trial start, when the plan has a trial.

trialEnd

string<date-time>

Trial end - the first real charge date.

dunningAttemptCount

integer

Failed-renewal retry attempts made in the current dunning sequence.

activatedAt

string<date-time>

When the subscription first became active.

cancelledAt

string<date-time>

pausedAt

string<date-time>

suspendedAt

string<date-time>

startAt

string<date-time>

Deferred start, when creation set a future startAt.

cyclesCompleted

integer

Number of billing cycles charged so far.

completedAt

string<date-time>

When the subscription reached maxBillingCycles.

parentSubscriptionId

string

Parent subscription UUID, for add-on hierarchies.

propagateLifecycle

boolean

Whether pause/cancel on the parent cascades to this subscription.

pendingPlanId

integer

Plan the subscription will switch to at the next cycle, set by a next_billing change-plan.

createdAt

string<date-time>

updatedAt

string<date-time>

plan

object

A reusable billing plan. amount is a flat integer in the currency minor units (with separate currency + exponent) - not an Amount object.

Show child attributes

Pagamentos

Tokenização

Assinaturas

Planos

Sessão do SDK

Pause e retome uma assinatura

Pausar uma assinatura

Exemplo

Retomar uma assinatura

Erros

Exemplo

Autorizações

Parâmetros de caminho

Corpo

Resposta

​Pausar uma assinatura

​Exemplo

​Retomar uma assinatura

​Erros

​Exemplo

Autorizações

Parâmetros de caminho

Corpo

Resposta

Pausar uma assinatura

Exemplo

Retomar uma assinatura

Erros

Exemplo