PauseSubscription
This action pauses a subscription using its ID.
Action Settings
| Setting | Description |
|---|---|
| SubscriptionId | Paddle identifier of the subscription to be paused. |
| EffectiveFrom | Moment when this subscription change should take effect from. Valid values are next_billing_period and immediately |
| ResumeAt | Optional. Datetime string when the paused subscription should resume. Omit to pause indefinitely until resumed |
| OnResume | How Paddle should set the billing period for the subscription when resuming. Valid values are: continue_existing_billing_period and start_new_billing_period. If omitted, is set to start_new_billing_period by default. |
Action Parameters
PauseSubscription action parameters correspond to the fields of the target object.
Result
The subscription is paused.