v1

latestOpenAPI 3.1.02026-07-241120379.1 KB

Read subscriptions for customer

This endpoint allows you to retrieve all subscriptions associated with a specific customer.

get/2023-10/customer/{customerIdentifier}/subscription

Path parameters

customerIdentifierstring required

The unique identifier of the customer either customerShopifyId or emailAddress of the customer.

Query parameters

status'ACTIVE' | 'CANCELLED' | 'PAUSED' | 'EXPIRED'

Response

200

successboolean
messagestring
codestring
pageInfostring

Example response

{
  "success": true,
  "message": "Subscriptions fetched successfully",
  "data": [
    {
      "id": 2180,
      "shopifyId": 13921059062,
      "totalLineItemPrice": 45,
      "totalLineItemDiscountedPrice": 45,
      "currencyCode": "USD",
      "nextBillingDateEpoch": 1716537920,
      "status": "ACTIVE",
      "billingAttemptSuccessCount": 3,
      "paymentMethodId": 358,
      "createdAt": "2024-04-18T08:41:07.000Z",
      "billingPolicy": {
        "interval": "MONTH",
        "intervalCount": 1
      },
      "deliveryPolicy": {
        "interval": "MONTH",
        "intervalCount": 1
      }
    }
  ],
  "code": "SUCCESS"
}