Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "sdk-sales/src/sdk/rescueSubscription"

Index

Functions

Functions

rescueSubscription

  • Parameters

    • id: number

    Returns Promise<APIErrorResponse | SubscriptionIDResponse>

    Promise resolving to an object containing the subscriptionID of the rescued subscription. When a rescue is successful, the appropriate subscription will be updated in Sales.subscriptions to have a status of 1.

    On success (resolves)
    {
      "subscriptionID": 1 // subscription id of the sub that was rescued
    }
    On error (throws)
     See documentation for corresponding error codes:
     https://redirector.arcpublishing.com/alc/docs/swagger/?url=./arc-products/arc-sales.json#operations-Subscription%20Interaction-Rescue-subscription