Sign in
Subscriptions

Resume a paused subscription

Use when reactivating a paused subscription (e.g. end of hold). Billing and access resume from the resume date.

post/subscriptions/{id}/resume

Path parameters

idstring required

Subscription ID

Request body

dry_runboolean

Whether to perform a dry run @Description If true, validates the request and shows impact without actually resuming the subscription @Example false

metadataobject

Additional metadata as key-value pairs @Description Optional metadata for storing additional information about the resume operation @Example {"resumed_by": "admin", "reason": "issue_resolved"}

resume_mode'immediate' | 'scheduled' | 'auto' required

Response

OK

created_atstring
created_bystring
environment_idstring

EnvironmentID is the environment identifier for the pause

idstring

ID is the unique identifier for the subscription pause

metadataTypesMetadata
original_period_endstring

OriginalPeriodEnd is the end of the billing period when the pause was created

original_period_startstring

OriginalPeriodStart is the start of the billing period when the pause was created

pause_endstring

PauseEnd is when the pause will end (null for indefinite)

pause_mode'immediate' | 'scheduled' | 'period_end'
pause_startstring

PauseStart is when the pause actually started

pause_status'none' | 'active' | 'scheduled' | 'completed' | 'cancelled'
reasonstring

Reason is the reason for pausing

resume_mode'immediate' | 'scheduled' | 'auto'
resumed_atstring

ResumedAt is when the pause was actually ended (if manually resumed)

status'published' | 'deleted' | 'archived'
subscription_idstring

SubscriptionID is the identifier for the subscription

tenant_idstring
updated_atstring
updated_bystring

Changes