Subscription

Subscription entity allows you fetch information about the subscription and take subscription level actions such as pause subscription, resume subscription, swap line items, etc.

Subscription object

JSON

{
  "success": true,
  "message": "Subscription fetched successfully",
  "data": {
    "id": 7896541,
    "shopifyId": 19238475621,
    "originOrderShopifyId": 7643982734512,
    "createdAt": "2025-03-15T14:12:00.000Z",
    "updatedAt": "2025-05-20T10:25:00.000Z",
    "orderNote": "Customer prefers morning deliveries",
    "totalLineItemPrice": 120.00,
    "totalLineItemDiscountedPrice": 108.00,
    "deliveryPrice": 5.00,
    "currencyCode": "USD",
    "status": "ACTIVE",
    "cancellationReason": null,
    "cancellationComment": null,
    "completedOrdersCount": 5,
    "pausedAt": null,
    "cancelledAt": null,
    "attributes": [],
    "isPrepaid": false,
    "nextBillingDateEpoch": 1809465600,
    "lastPaymentStatus": "SUCCESS",
    "lastInventoryAction": null,
    "deliveryMethod": {
      "code": "Delivery [9901221]",
      "title": "Home Delivery [9901221]"
    },
    "billingPolicy": {
      "maxCycles": null,
      "minCycles": null,
      "interval": "MONTH",
      "intervalCount": 1,
      "anchorDay": null,
      "anchorMonth": null,
      "anchorType": null
    },
    "deliveryPolicy": {
      "interval": "MONTH",
      "intervalCount": 1
    },
    "shippingAddress": {
      "firstName": "Emily",
      "lastName": "Carter",
      "phone": "2025557890",
      "company": null,
      "address1": "742 Evergreen Terrace",
      "address2": "Apt 3A",
      "city": "Springfield",
      "zip": "62704",
      "countryCode": "US",
      "provinceCode": "IL"
    },
    "lines": [
      {
        "id": 45231890,
        "productShopifyId": 9988776655443,
        "variantShopifyId": 56789345678901,
        "sellingPlanShopifyId": 4455332211,
        "variantTitle": "Monthly Box",
        "productTitle": "Wellness Kit",
        "name": "Wellness Kit - Monthly Box",
        "price": "120.00",
        "basePrice": 120.00,
        "discountedPrice": 108.00,
        "quantity": 1,
        "sku": "WELL-MONTH-001",
        "isOneTimeAdded": false,
        "isOneTimeRemoved": false,
        "bundleTransactionId": null,
        "loopBundleId": null,
        "attributes": [],
        "weightInGrams": 800,
        "discounts": [
          {
            "shopifyId": "a9f765bb-4da1-4bb2-9e5d-d2d789334fed",
            "title": "10% Spring Discount",
            "isActive": true,
            "type": "AUTOMATIC_DISCOUNT",
            "value": {
              "percentage": 10
            },
            "orderLimit": null,
            "usageCount": 5
          }
        ],
        "variantImage": "https://cdn.shopify.com/s/files/1/0000/1111/2222/products/wellness-kit.jpg"
      }
    ],
    "customer": {
      "id": 41020394,
      "shopifyId": 8729301837291
    },
    "discounts": [
      {
        "shopifyId": "a9f765bb-4da1-4bb2-9e5d-d2d789334fed",
        "title": "10% Spring Discount",
        "isActive": true,
        "type": "AUTOMATIC_DISCOUNT",
        "value": {
          "percentage": 10
        },
        "orderLimit": null,
        "usageCount": 5
      }
    ],
    "prepaidCredits": null,
    "customerPaymentMethodId": 6019283
  },
  "code": "SUCCESS",
  "pageInfo": null
}