Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Functions

getSubscriptionDetails

  • getSubscriptionDetails(id: number): Promise<APIErrorResponse | Subscription>
  • Parameters

    • id: number

    Returns Promise<APIErrorResponse | Subscription>

    Promise resolving to an object with subscription details. When successful, the data will be merged into the subscriptions array.

    On success (resolves)
    {
      "subscriptionID": 1,
      "sku": "123",
      "nextEventDateUTC": "2018-06-22T15:27:43.606Z",
      "subscriptionType": 1,
      "status": 1,
      "events": [
        {
          "typeID": 1,
          "eventDateUTC": "2018-06-22T15:27:43.606Z",
          "details": "string"
        }
      ],
      "salesOrders": [
        {
          "id": 1,
          "orderDateUTC": "1529924092000",
          "orderNumber": "1",
          "status": 1,
          "tax": 1,
          "shipping": 1,
          "total": 1
        }
      ]
    }
    On error (throws)
    See documentation for corresponding error codes:
    https://redirector.arcpublishing.com/alc/docs/swagger/?url=./arc-products/arc-sales.json#/Subscription_Interaction/getSubscriptionDetails