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

cancelSubscription

• cancelSubscription(id: number, reason: undefined | string, reasonCode: undefined | string): Promise<APIErrorResponse | SubscriptionIDResponse>

• Parameters

  • id: number

  • Optional reason: undefined | string

  • Optional reasonCode: undefined | string

  Returns Promise<APIErrorResponse | SubscriptionIDResponse>

  Promise resolving to an object containing the subscriptionID of the canceled subscription. When a cancelation is successful, the appropriate subscription will be updated in subscriptions to have a status of 3.

  On success (resolves)

  {
    "subscriptionID": 1 // subscription id of that was canceled
  }

  On error (throws)

  See documentation for corresponding error codes:
  https://redirector.arcpublishing.com/alc/docs/swagger/?url=./arc-products/arc-sales.json#/Subscription_Interaction/cancel