Read subscription details

This endpoint allows you to retrieve comprehensive details of a specific subscription, including billing, delivery, products, and status.

get/2023-10/subscription/{subscriptionId}

Request

  • Base URL
    https://api.loopsubscriptions.com/admin
  • URL
    https://api.loopsubscriptions.com/admin/2023-10/subscription/{subscriptionId}
  • Auth
    API key in header X-Loop-Token

Path parameters

subscriptionIdstring required

Response

200

successboolean
messagestring
codestring
pageInfounknown

Example response

{
  "success": true,
  "message": "Subscription fetched successfully",
  "data": {
    "id": 2184,
    "shopifyId": 13921517814,
    "originOrderShopifyId": 5730064072950,
    "createdAt": "2024-04-18T10:15:26.000Z",
    "updatedAt": "2024-04-23T09:27:01.000Z",
    "totalLineItemPrice": 8.09,
    "deliveryPrice": 10,
    "currencyCode": "USD",
    "status": "CANCELLED",
    "cancellationReason": "CANCEL IT",
    "completedOrdersCount": 1,
    "cancelledAt": "2024-04-23T09:27:01.000Z",
    "nextBillingDateEpoch": 1715475900,
    "deliveryMethod": {
      "code": "Express",
      "title": "Express"
    },
    "billingPolicy": {
      "interval": "MONTH",
      "intervalCount": 1
    },
    "deliveryPolicy": {
      "interval": "MONTH",
      "intervalCount": 1
    },
    "shippingAddress": {
      "firstName": "Manas",
      "lastName": "Oswal",
      "address1": "2685 California Street",
      "city": "Mountain View",
      "zip": "94040",
      "countryCode": "US",
      "provinceCode": "CA"
    },
    "lines": [
      {
        "id": 15098,
        "productShopifyId": 8480436519158,
        "variantShopifyId": 46354889900278,
        "productTitle": "Every-1",
        "name": "Every-1",
        "price": "8.09",
        "basePrice": 8.99,
        "quantity": 1,
        "attributes": [
          {
            "key": "_ZapietId",
            "value": "M=S&D=2024-04-18T00:00:00Z"
          }
        ],
        "weightInGrams": 1000
      }
    ],
    "customer": {
      "id": 303,
      "shopifyId": 7383577985270
    },
    "discounts": [
      {
        "shopifyId": "72467851-8140-4b42-9ac6-47ca671a75d0",
        "title": "Subscription discountttt by flow",
        "isActive": true,
        "type": "MANUAL",
        "value": {
          "amount": {
            "amount": "10.0",
            "currencyCode": "USD"
          }
        }
      }
    ]
  },
  "code": "SUCCESS"
}

Changes

No recorded changes to this operation across all 1 revision of this API.