PauseSubscription
Schedules a PAUSE action to pause an active subscription.
Stored Procedure Specific Information
Execute
You need to provide the SubscriptionId of the active subscription to pause.
EXECUTE PauseSubscription SubscriptionId = 'fd9d6200-bb12-43c5-9973-070bfc6f5e05'
You can optionally provide a PauseCycleDuration to control how many billing cycles the subscription remains paused for, and PauseReason to document why the subscription is being paused.
EXECUTE PauseSubscription SubscriptionId = 'fd9d6200-bb12-43c5-9973-070bfc6f5e05', PauseCycleDuration = 1, PauseReason = 'Customer requested temporary pause'
Input
| Name | Type | Required | Description |
| SubscriptionId | String | True | The ID of the subscription to pause. |
| PauseEffectiveDate | Date | False | The date, in YYYY-MM-DD format, to pause the subscription. When unspecified or within the current billing cycle, the subscription is paused on the starting date of the next billing cycle. |
| PauseCycleDuration | Integer | False | The number of billing cycles the subscription is paused for. When set, a RESUME action is also scheduled. Cannot be used with ResumeEffectiveDate or ResumeChangeTiming. |
| ResumeEffectiveDate | Date | False | The date, in YYYY-MM-DD format, to resume the subscription. Only used when PauseCycleDuration is not set. Must be at least one billing cycle after PauseEffectiveDate. |
| ResumeChangeTiming | String | False | The timing to resume a subscription, either IMMEDIATE or END_OF_BILLING_PERIOD. |
| PauseReason | String | False | The user-provided reason to pause the subscription. |
Result Set Columns
| Name | Type | Description |
| Success | Boolean | Whether the pause request was successfully sent to the Square API. |
| CurrentStatus | String | The current status of the subscription at the moment the pause was scheduled. Note: The subscription may remain ACTIVE until the pause takes effect on the specified date or the next billing cycle. A PAUSE action is scheduled asynchronously to take effect at the specified time. |