Skip to content
Proud to collaborate with Microsoft for Startups

stripe.subscriptions.resume_subscription ​

Resume a Stripe subscription or clear a scheduled cancellation

Bring a subscription back to active.

Two different situations share the word "resume", so this workflow handles both explicitly. uncancel (the default) clears a cancel_at_period_end flag on a still-active subscription. unpause resumes a subscription whose collection was paused; Stripe requires a billing cycle anchor, which defaults to now.

Acts on the CUSTOMER'S OWN Stripe account, authenticated via the org-scoped Stripe connection selected by cloud_connection_uuid.

Inputs:

  • cloud_connection_uuid: Org-scoped Stripe connection (customer's own account).
  • subscription_id: Stripe subscription ID (sub_...).
  • resume_mode: uncancel | unpause (default: uncancel) (optional).
  • billing_cycle_anchor: unpause only: now | unchanged (default: now) (optional).

Outputs (terminal state_data):

  • subscription_id: str
  • status: str
  • cancel_at_period_end: bool
  • resume_mode: str

Connection required: cloud_connection_uuid — the organization's own Stripe account credentials; there is no platform-key fallback.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-stripe
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
cloud_connection_uuiduuidYes—Org-scoped Stripe connection (customer's own account)
subscription_idstringYes—Stripe subscription ID (sub_...)
resume_modestringNo—uncancel
billing_cycle_anchorstringNo—unpause only: now

Output Schema ​

FieldTypeRequiredDefaultDescription
subscription_idstringNo——
statusstringNo——
cancel_at_period_endbooleanNo——
resume_modestringNo——
cloud_connection_uuiduuidNo——
billing_cycle_anchorstringNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
errorstringNo——
error_typestringNo——
failed_layerintegerNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "stripe.subscriptions.resume_subscription",
  "initial_data": {
    "cloud_connection_uuid": "value",
    "subscription_id": "value"
  }
}