Apply Scheduled Pause

POST

/api/:account_id/subscriptions/:subscription_id/apply-scheduled-pause

Apply a scheduled pause (pause_at_end).

This endpoint is INTERNAL and only callable by Restate workflows. It transitions a subscription with pause_at_end=True to PAUSED state at period end.

Workflow calls this when APPLY_SCHEDULED_PAUSE action is returned by evaluate endpoint.

Returns ApplyScheduledPauseResponse with status:

“activated”: Pause activated successfully
“skipped”: No scheduled pause to apply

Apply a scheduled pause (pause_at_end). This endpoint is INTERNAL and only callable by Restate workflows. It transitions a subscription with pause_at_end=True to PAUSED state at period end. Workflow calls this when APPLY_SCHEDULED_PAUSE action is returned by evaluate endpoint. Returns ApplyScheduledPauseResponse with status: - "activated": Pause activated successfully - "skipped": No scheduled pause to apply

Authentication

AuthorizationBearer

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

Path parameters

subscription_idstringRequired

account_idstringRequired

Response

Successful Response

statusenum

subscription_idstring or nullOptional

reasonstring or nullOptional

Errors

422

Unprocessable Entity Error

$	curl -X POST https://app.paymentkit.com/api/account_id/subscriptions/subscription_id/apply-scheduled-pause \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

Authentication

Path parameters

Headers

Response

Errors