Resume Subscription

View as Markdown
Resume a paused subscription, immediately or on a specific future date. Resume timing (public API calls only, via the optional request body): - **immediately** (default): Clears pause fields and transitions the subscription back to TRIALING (if trial hasn't expired) or ACTIVE. - **on_date**: Keeps the subscription PAUSED and (re)schedules an automatic resume for `resume_date`. Use this to set a future resume date on an already-paused subscription, or to update an existing scheduled date. The lifecycle auto-resumes the subscription when that date arrives. Returns the still-paused SubscriptionResponse (with resumes_at set). Emits `subscription.resumed` (immediate) or `subscription.resume_scheduled` (on_date) webhook event. When from_workflow=true (Restate calls): always resumes immediately and returns ResumeSubscriptionResponse with a status field ("skipped" if the subscription is not paused). The request body is ignored for workflow calls. When from_workflow=false (public API calls): returns SubscriptionResponse. Works for User, API Key, and Restate workflow authentication. Account access is automatically validated via endpoint dependency.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

subscription_idstringRequired
account_idstringRequired

Headers

X-Restate-Secret-Keystring or nullOptional

Query parameters

from_workflowbooleanOptionalDefaults to false

Request

This endpoint expects a nullable object.
resume_timingenumOptional

When to resume the subscription (immediately or on a specific date)

resume_datedatetime or nullOptional

Specific datetime for auto-resume. Required when resume_timing is ‘on_date’.

Response

Successful Response
SubscriptionResponseobject
OR
ResumeSubscriptionResponseobject

Errors

422
Unprocessable Entity Error