getSubscriptions

List the customer’s active subscriptions from the subscription app connected in Mage (Loop Subscriptions, Stay.ai or Skio). Use the returned id with redeemFlexibleToSubscription or redeemRewardToSubscription.

Usage

MageSDK.getSubscriptions().then(function(resp) {
  if (resp.success) {
    console.log(resp.data.subscriptions);
  } else {
    console.log('Error:', resp.error);
  }
});

Response

boolean

Whether the request was successful.

string | null

The connected subscription app: "loop", "stay" or "skio". null when none is connected.

array

The customer’s active subscriptions. Paused and cancelled subscriptions are not included. Empty when the customer is logged out or no subscription app is connected.

Show Subscription properties

string

The subscription ID. Pass this to the redeem methods.

string

The subscription’s currency, for example "USD".

number

The price of each renewal in major currency units, including delivery.

string | null

ISO date of the next order.

string

"DAY", "WEEK", "MONTH" or "YEAR".

number

How many intervals between orders.

array

The products on the subscription, each with productTitle, variantTitle, quantity and isOneTimeAdded. The first line with isOneTimeAdded: false is the main product.

Sample response

{
  "success": true,
  "data": {
    "provider": "skio",
    "subscriptions": [
      {
        "id": "7d993128-2570-4386-97a8-a04e074fc7ff",
        "shopifyContractId": "147824017456",
        "status": "ACTIVE",
        "currencyCode": "USD",
        "totalPerRenewal": 49.99,
        "nextBillingDate": "2026-10-24T20:23:15.234Z",
        "interval": "MONTH",
        "intervalCount": 1,
        "lines": [
          {
            "productShopifyId": "7888863756336",
            "variantShopifyId": "42751679725616",
            "productTitle": "Coffee Subscription",
            "variantTitle": "Whole bean",
            "quantity": 1,
            "isOneTimeAdded": false
          }
        ],
        "provider": "skio"
      }
    ]
  }
}

JavaScript SDK

Methods

Recipes

Usage

Response

Sample response

​Usage

​Response

​Sample response

Usage

Response

Sample response