Pause and Resume a Subscription

Pausing a subscription stops all renewal attempts without cancelling it, preserving the subscription record and all its history. Resuming restores billing and recalculates the next billing date forward from the current date — the customer is not charged for time elapsed while paused.

Pause a Subscription

POST /subscription/{id}/pause suspends billing on an active subscription. It fires the subscription.paused webhook event and moves the subscription to paused status.

Only subscriptions in active, trialing, or past_due status can be paused. Attempting to pause a cancelled, completed, or already paused subscription returns a 400 error.

Example

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" }'

Resume a Subscription

POST /subscription/{id}/resume restores billing on a paused or suspended subscription, with slightly different behavior depending on the current status.

Current status	Behavior on resume
`paused`	Billing restored. Next billing date = today + plan interval.
`suspended`	Therius attempts an immediate re-charge (MIT). Returns `402` if declined.

If resuming from suspended returns 402 (card declined), you must first update the payment method using POST /subscription/{id}/payment-method before retrying the resume.

On success, Therius fires subscription.resumed. If a suspended subscription is revived by a successful charge, it also fires subscription.reactivated.

Errors

Code	Meaning
`400`	Subscription is not in a resumable state (e.g. already `active` or `cancelled`).
`402`	Resume from `suspended` failed — immediate re-charge was declined.
`404`	Subscription not found.

Example

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" }'

{}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Body

application/json

merchantCode

string

required

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

Response

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.

Available options:

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

Payments

Tokenization

Subscriptions

Subscription Plans

SDK Session

Pause and Resume a Subscription

Pause a Subscription

Example

Resume a Subscription

Errors

Example

Authorizations

Path Parameters

Body

Response

​Pause a Subscription

​Example

​Resume a Subscription

​Errors

​Example

Authorizations

Path Parameters

Body

Response

Pause a Subscription

Example

Resume a Subscription

Errors

Example