API Reference

Pause subscription

post
https://api.loopsubscriptions.com/storefront/2023-10/subscription//pause

This endpoint allows you to pause an active subscription, halting future billing and deliveries until it is resumed.

Things to keep in mind:

  1. The pauseDuration object can only be used if the Pause subscription interval preference is enabled in Customer Portal > Preferences > Pause subscription.
    1. Only the duration options configured in this preference can be passed in the pauseDuration object.
    2. For a custom pause, set intervalType to CUSTOM and ensure that the custom duration preference is enabled.
Path Params
int64
required

The unique identifier of the subscription in Loop.

Body Params
pauseDuration
object

Optional object used to specify a fixed duration for pausing the subscription. If not provided, the subscription will remain paused indefinitely until manually resumed.

int32

This parameter is used to log the cancellation reason performance.

Response

Updated 3 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?