---
title: "Get Subscriptions for Customer"
method: GET
path: "/subscription/getsubscriptionsforcustomer"
tags: ["Subscription API"]
---

# Get Subscriptions for Customer

`GET /subscription/getsubscriptionsforcustomer`

Retrieves the subscriptions, including all subscription items, for a particular customer using the customer ID, the customer reference ID , or the customer's email address. Subscription items contain the current status and a list of all related purchases.<br /> For XML examples and schemas, see the [Additional Examples - Get Subscriptions for Customer](https://dev.cleverbridge.com/page/additional-examples-get-subscription-for-customer).

## Query parameters

- `customerEmail` string
- `customerId` string
- `customerReferenceId` string
- `subscriptionstatus` string
- `isCurrent` boolean

## Headers

- `Accept` 'application/json' | 'application/xml'

## Response `200`

OK

- CleverbridgeBackEndRestApiSubscriptionClassesGetSubscriptionsForCustomerResponse
  - `Subscriptions` CleverbridgeBackEndRestApiSubscriptionClassesSubscription[] — List of subscriptions.
    - `CustomerCurrencyId` string — Currency code in capital letters, see [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). This was selected by the customer during the checkout process.
    - `CustomerId` integer — Cleverbridge's unique ID for a customer.
    - `CustomerReferenceId` string — Your unique ID for the customer. This value is submitted by you when the customer initially purchases the subscription and is stored by Cleverbridge. Corresponds to the <b>Internal customer ID</b> in the Cleverbridge platform. For more information, see [Customer Data](https://docs.cleverbridge.com/public/all/using-the-platform/list-of-checkout-process-parameters.htm#Customer_Data?utm_source=developer-docs&amp;utm_medium=api-reference).
    - `CustomerReferenceNo` string — Internal purchase order number submitted by the customer during checkout.
    - `EndDate` string, date-time — Date and time when subscription ends. For example, this is when the number of specified billing intervals is reached.
    - `GracePeriodDays` integer — Number of grace period days that the customer has before the subscription is put on hold.
    - `Id` integer — Unique ID of the subscription.
    - `IntervalDayCount` integer — Number of days between renewal events. This is equivalent to the length of subsequent subscription intervals.
    - `IntervalMonthCount` integer — Number of months between renewal events. This is equivalent to the length of subsequent subscription intervals.
    - `BillingIntervalDayCount` integer — Number of days between billing events. This is equivalent to the length of subsequent billing intervals.
    - `BillingIntervalMonthCount` integer — Number of months between billing events. This is equivalent to the length of subsequent billing intervals.
    - `Items` CleverbridgeBackEndRestApiSubscriptionClassesSubscriptionItem[] — List of subscription items.
      - `Couponcode` string — Coupon code applied to this version of the subscription item. This indicates a discount was applied to the customer’s subscription at the initial purchase, on renewal of the subscription or via <code>/subscription/updatesubscriptionitem</code>.
      - `DeactivationDate` string, date-time — Date and time when an item is deactivated. Format according to [RFC3339](https://www.rfc-editor.org/info/rfc3339).
      - `EndDate` string, date-time — Date and time when item is deactivated or number of specified billing intervals is reached. Format according to [RFC3339](https://www.rfc-editor.org/info/rfc3339).
      - `IsCurrent` boolean — Indicates whether this subscription item is the latest version. If <code>true</code>, the item is current. If <code>false</code>, the item is not current.
      - `LastIntervalNo` integer — Number of the last successfully paid interval of the subscription item. Counting starts at 0. For each successfully paid interval, the number is increased by one.
      - `NextBillingCurrencyId` string — Currency code the next billing in capital letters, see [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
      - `NextBillingCustomerGrossPrice` number, double — Amount that will be charged on the next billing date, with taxes.
      - `NextBillingCustomerNetPrice` number, double — Amount that will be charged on the next billing date, without taxes.
      - `NextBillingCustomerVatPrice` number, double — Tax that will be charged on the next billing date.
      - `NextRenewalCustomerGrossPrice` number, double — Amount that will be charged on the next renewal date, with taxes.
      - `NextRenewalCustomerNetPrice` number, double — Amount that will be charged on the next renewal date, without taxes.
      - `NextRenewalCustomerVatPrice` number, double — Tax that will be charged on the next renewal date.
      - `ProductId` integer — ID of the product in the subscription.
      - `ProductName` string — Product name used in customer communication.
      - `ProductNameExtension` string — Product description. Corresponds to the <b>Additional name information</b> in the Cleverbridge platform.
      - `PromotionId` integer — ID of the promotion to which the coupon code belongs. Promotions are set up in the Cleverbridge platform.
      - `Quantity` integer — Current number of items.
      - `RecurrenceCount` integer — Maximum number of billings that can occur for the item.
      - `RunningNo` integer — Running number of the item in the subscription.
      - `StartDate` string, date-time — Date and time when item is paid. If a purchase order is used, this is the date and time when the item is processed for the first time. Format according to [RFC3339](https://www.rfc-editor.org/info/rfc3339).
      - `Status` 'Undefined' | 'Active' | 'Deactivated' | 'AwaitingReinstate' | 'Finished' | 'Removed' — Status of subscription item. For a JSON response, the data type is integer. Possible values are: <br />0 - Undefined<br />1 - Active<br />2 - Deactivated<br />3 - AwaitingReinstate<br />4 - Finished<br />5 - Removed<br />For more information, see [Subscription Statuses in Combination](https://docs.cleverbridge.com/public/all/using-the-platform/subscription-statuses-and-update-options.htm#Statuses).
      - `SubscriptionId` integer — Unique ID of the subscription, with or without an initial 'S'.
      - `SubscriptionPurchaseItems` CleverbridgeBackEndRestApiSubscriptionClassesSubscriptionPurchaseItem[] — List of transactions where the item can be found. For descriptions of the response items, see [Additional Subscription Response Items](https://dev.cleverbridge.com/page/additional-subscription-response-items).
        - `PurchaseId` integer
        - `PurchaseItemRunningNo` integer
        - `SubscriptionIntervalNo` integer
        - `BillingIntervalNo` integer
      - `Version` integer — Version of the item. If a subscription item is updated, for example using <code>/subscription/increasesubscriptionitemquantity</code>, the entire subscription item is versioned.
      - `VersionActiveDate` string, date-time — Date and time when the item version became active. Corresponds to the date and time when payment was received or, for purchase orders, when the purchase order was processed. <code>null</code> indicates that the item version is not active yet, for example because the customer upgraded the subscription item starting from the next renewal date.
    - `LastIntervalNo` integer — Number of the last successfully paid interval of the subscription. Counting starts at 0. For each successfully paid interval, the number is increased by one.
    - `LastBillingIntervalNo` integer — Number of the last successfully paid billing interval of the subscription. Counting starts at 0. For each successfully paid interval, the number is increased by one. With a renewal, the billing interval is reset to 0.
    - `NextBillingCurrencyId` string — Currency code for the next billing in capital letters, see [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
    - `NextBillingCustomerGrossPrice` number, double — Total amount that will be charged on the next billing date, with taxes.
    - `NextBillingCustomerNetPrice` number, double — Total amount that will be charged on the next billing date, without taxes.
    - `NextBillingCustomerVatPrice` number, double — Total taxes that will be charged on the next billing date.
    - `NextRenewalCustomerGrossPrice` number, double — Total amount that will be charged on the next renewal date, with taxes.
    - `NextRenewalCustomerNetPrice` number, double — Total amount that will be charged on the next renewal date, without taxes.
    - `NextRenewalCustomerVatPrice` number, double — Total taxes that will be charged on the next renewal date.
    - `NextBillingDate` string, date-time — Next billing date and time according to [RFC3339](https://www.rfc-editor.org/info/rfc3339). Specified in UTC.
    - `NextRenewalDate` string, date-time — Next renewal date and time according to [RFC3339](https://www.rfc-editor.org/info/rfc3339). Specified in UTC.
    - `NextBillingDateReminder` string, date-time — Date on which the reminder of the next billing date is sent to the customer.
    - `PaymentInfo` CleverbridgeBackEndRestApiSubscriptionClassesPaymentInfoModel — Information about the payments. For descriptions of the response items, see [Additional Purchase Response Items](https://dev.cleverbridge.com/page/additional-purchase-response-items).
      - `CardExpirationDate` CleverbridgeBackEndRestApiSubscriptionClassesCardExpirationDateModel — Expiration date of the card. For descriptions of the response items, see [Additional Subscription Response Items](https://dev.cleverbridge.com/page/additional-subscription-response-items).
        - `Month` integer — Expiration month.
        - `Year` integer — Expiration year.
      - `CardLastFourDigits` string — Last four digits of the card number.
      - `Currency` string — The currency of the defined price.
      - `CurrencyId` string — Currency code in capital letters, see [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
      - `IsPurchaseOrder` string — Whether or not a purchase order was used.
      - `PaymentType` string — Payment method used. For a list of values, see [Payment Type](https://dev.cleverbridge.com/reference/payment-type).
      - `PaymentTypeId` string — ID of the payment method. For a list of values, see [Payment Type](https://dev.cleverbridge.com/reference/payment-type).
    - `RenewalType` string — Renewal type of the subscription. Possible values are <code>Automatic</code> or <code>Manual</code>.
    - `StartDate` string, date-time — Date and time when subscription is paid. If a purchase order is used, this is the date when the subscription is processed for the first time.
    - `StartIntervalDayCount` integer — Number of days after initial purchase until the first billing event. This is equivalent to the length of first interval of the subscription.
    - `StartIntervalMonthCount` integer — Number of months after initial purchase until the first billing event. This is equivalent to the length of first interval of the subscription.
    - `Subscriptionstatus` 'All' | 'Active' | 'AwaitingReinstate' | 'Deactivated' | 'Finished' | 'Grace' | 'Hold' | 'New' — Status of the subscription. For a XML response, the data type is string. Possible values are: <br />1 - Active<br />3 - Deactivated<br />4 - Finished<br />5 - Grace<br />6 - Hold<br />7 - New
    - `ManagementModel` 'One' | 'Two' — Management model of the subscription. Possible values are: <br />One <br />Two
    - `SelfServiceUrl` string — URL to the self-service area where customers can update or upgrade their subscriptions (available for Subscription Management 2.0).
  - `ResultMessage` string — Optional result or error message.

## Other responses

- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.net/cleverbridge/apis/backend-rest-apis.md) · [All operations](https://skmtc.net/cleverbridge/apis/backend-rest-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cleverbridge/backend-rest-apis/versions/b7007b62f4c0/schema)