Skip to navigation

Activate Subscription

View as Markdown

Activate a subscription.

When from_workflow=true (Restate calls):

  • Returns ActivateSubscriptionResponse with status field
  • Returns “skipped” if trial still active (no error)
  • This prevents premature activation if trial was extended after scheduling

When from_workflow=false (public API calls):

  • Returns SubscriptionResponse
  • Raises 400 error if trial still active

Requires the initial invoice (billing_reason=‘subscription_create’) to be paid. Works for both User and API Key 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
X-System-Reasonstring or nullOptional
Idempotency-Keystring or nullOptional>=8 characters
A unique key for this request. A retry with the same key returns the first response instead of running again, for 24 hours. Keys are per caller.

Query parameters

from_workflowbooleanOptionalDefaults to false

Response

Successful Response
SubscriptionResponseobject
OR
ActivateSubscriptionResponseobject

Errors

422
Unprocessable Entity Error