---
title: "Get All Subscription By Shopper Id or External Reference Id"
method: GET
path: "/v1/subscriptions"
tags: ["Retrieve Subscription"]
---

# Get All Subscription By Shopper Id or External Reference Id

`GET /v1/subscriptions`

Get all subscriptions by shopper id or external reference Id

## Query parameters

- `Shopper Id` string, required

## Headers

- `token` string, required

## Response `200`

OK

- SubscriptionInfoList
  - `subscriptions` SubscriptionInfo[]
    - `id` string — Subscription id
    - `billingAgreementId` string — Billing agreement id
    - `externalReferenceId` string — External reference id
    - `creationDate` string, date-time — Subscription creation date
    - `activationDate` string, date-time — Subscription activation date
    - `nextRenewalDate` string, date-time — Subscription next renewal date
    - `nextBillingDate` string, date-time — Subscription next billing date
    - `expirationDate` string, date-time — Subscription expiration date
    - `graceDate` string, date-time — Subscription grace date
    - `cancellationDate` string, date-time — Subscription cancellation date
    - `currentQuantity` integer — Subscription current quantity
    - `renewalQuantity` integer — Subscription renewal quantity
    - `autoRenewal` boolean — Subscription auto renewal flag
    - `locale` string — Subscription locale
    - `state` State — All possible subscription states
      - `Subscribed` string
      - `PendingActivation` string
      - `Cancelled` string
      - `FreeTrial` string
      - `PendingRenewal` string
    - `duration` integer — Subscription duration
    - `frequency` integer — Subscription frequency
    - `currentBillingCycleNumber` integer — Subscription current billing cycle
    - `totalNumberOfBillingCycle` integer — Subscription total billing cycle
    - `siteId` string — Site id
    - `shopper` ShopperInfo
      - `id` string, required — User Id
      - `externalReferenceId` string — External reference Id
    - `renewalPrice` ProbableRenewalPriceBean
      - `unitPrice` number, double, required — Unit price
      - `locked` boolean, required — true if Hold price present. false if hold price not present
      - `currency` string, required — Currency for Unit price
    - `term` Term
      - `termUnit` string — Term unit
      - `termLength` integer — Term length
    - `product` Product
      - `id` string — Product id
      - `externalReferenceId` string — Product external reference id
      - `displayName` string — Product display name
      - `sku` string — Product SKU
    - `shipToAddress` Address
      - `id` string — Address id
      - `firstName` string — First name
      - `lastName` string — Last name
      - `companyName` string — Company name
      - `line1` string — Address line 1
      - `line2` string — Address line 2
      - `line3` string — Address line 3
      - `city` string — City
      - `postalCode` string — Postal code
      - `countrySubdivision` string — Country sub division
      - `country` string — Country code
      - `countryName` string — Country name
      - `phoneNumber` string — Phone number
      - `emailAddress` string — Email address
      - `countyName` string — County name
    - `paymentOption` PaymentOption
      - `nickName` string — Nick name
      - `id` string — Payment id
      - `isDefault` string — Is default payment method
      - `type` string — Payment type
      - `sourceId` string — Payment source id
      - `creditCard` CreditCard
        - `expirationMonth` string — Card expiration month
        - `expirationYear` string — Card expiration year
        - `displayableNumber` string — Card displayable number
        - `type` string — Card tyoe
        - `displayName` string — Card display name
        - `brand` string — Card brand
        - `lastFourDigits` string — Last four digits of card
      - `sourceClientSecret` string — Payment source client secret
      - `address` Address
        - `id` string — Address id
        - `firstName` string — First name
        - `lastName` string — Last name
        - `companyName` string — Company name
        - `line1` string — Address line 1
        - `line2` string — Address line 2
        - `line3` string — Address line 3
        - `city` string — City
        - `postalCode` string — Postal code
        - `countrySubdivision` string — Country sub division
        - `country` string — Country code
        - `countryName` string — Country name
        - `phoneNumber` string — Phone number
        - `emailAddress` string — Email address
        - `countyName` string — County name
    - `addOns` SubAddOn[]
      - `product` Product, required
        - `id` string — Product id
        - `externalReferenceId` string — Product external reference id
        - `displayName` string — Product display name
        - `sku` string — Product SKU
      - `quantity` integer, required — Addon product quantity
      - `proratedUnitPrice` number — If “proratedUnitPrice” attribute is present then it overrides all other prices and skip normal proration.
      - `renewalPrice` ProbableRenewalPriceBean
        - `unitPrice` number, double, required — Unit price
        - `locked` boolean, required — true if Hold price present. false if hold price not present
        - `currency` string, required — Currency for Unit price

## Other responses

- `400` — * Bad request
- `401` — * Please verify your API key and secret (if applicable) is correct.
- `404` — * Not found
- `409` — * Conflict

---

[API](https://skmtc.net/digitalriver/apis/commerce-api-suite-shopper-apis.md) · [All operations](https://skmtc.net/digitalriver/apis/commerce-api-suite-shopper-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/digitalriver/commerce-api-suite-shopper-apis/revisions/4b69392f93b9/schema)