---
title: "View customer subscriptions"
method: GET
path: "/subscription/v3/customerRef/{customerRef}"
tags: ["Subscriptions"]
---

# View customer subscriptions

`GET /subscription/v3/customerRef/{customerRef}`

Returns a list of subscriptions and payment plans for a given customer reference number. This `customerRef` must have been used when creating the subscription or payment plan (see the [Create a subscription](https://docs.nexiopay.com/reference/createsubscription) endpoint).

<!-- theme: warning -->
> ⚠️ Try It
> 
> To use the Try It feature for this endpoint, you can use the credentials for your [Sandbox API user](https://docs.nexiopay.com/docs/sandbox-environments).<br/><br/>You can also use the following test account. Copy the value and paste it into the appropriate space in the Try It section to the right.
> username: `docs@nexiopay.com`
> password: `JZdzoXpdDeH6VA`<br/><br/>Include a customer reference number in the path parameter of the request for a subscription created by the test account.

<div style="display:none;">

## Request parameters
- customerRef

## Response parameters
- customerRef
- active
- accountId
- id
- payment
- payment.tokenex
- payment.tokenex.token
- payment.tokenex.firstSix
- payment.tokenex.lastFour
- payment.shouldUpdateCard
- payment.isAuthOnly
- payment.processingOptions
- payment.processingOptions.saveCardToken
- payment.processingOptions.retryOnSoftDecline
- payment.processingOptions.checkFraud
- payment.processingOptions.shouldUseFingerprint
- payment.processingOptions.check3ds
- payment.processingOptions.verboseResponse
- payment.processingOptions.paymentType
- payment.processingOptions.paymentOptionTag
- payment.processingOptions.merchantId
- payment.processingOptions.customerRedirectUrl
- payment.data
- payment.data.amount
- payment.data.currency
- payment.data.settlementCurrency
- payment.data.customer
- payment.data.customer.customerRef
- payment.data.customer.invoice
- payment.data.customer.orderNumber
- payment.data.customer.orderDate
- payment.data.customer.birthDate
- payment.data.customer.nationalIdentificationNumber
- payment.data.customer.companyName
- payment.data.customer.firstName
- payment.data.customer.lastName
- payment.data.customer.email
- payment.data.customer.phone
- payment.data.customer.billToAddressOne
- payment.data.customer.billToAddressTwo
- payment.data.customer.billToCity
- payment.data.customer.billToState
- payment.data.customer.billToPostal
- payment.data.customer.billToCountry
- payment.data.customer.billToPhone
- payment.data.customer.shipToAddressOne
- payment.data.customer.shipToAddressTwo
- payment.data.customer.shipToCity
- payment.data.customer.shipToState
- payment.data.customer.shipToPostal
- payment.data.customer.shipToCountry
- payment.data.customer.shipToPhone
- payment.data.customer.createdAtDate
- schedule
- schedule.interval
- schedule.intervalCount
- schedule.initialBalance
- schedule.balance
- schedule.duration
- schedule.dateInitialBillingEnd
- schedule.intialBillingAmount
- schedule.dateCancelAfter
- schedule.scheduleType
- userName
- dateCreated
- dateLastModified
- dateLastRun
- dateNextRun
- paymentResult
- paymentResult.amount
- paymentResult.authCode
- paymentResult.transactionStatus
- paymentResult.transactionDate
- paymentResult.transactionType
- paymentResult.merchantId
- paymentResult.currency
- paymentResult.id
- paymentResult.asyncTraceId
- paymentResult.redirectUrl
- paymentResult.message
- paymentResult.status
- paymentResult.gatewayResponse
- paymentResult.gatewayResponse.gatewayName
- paymentResult.gatewayResponse.refNumber
- paymentResult.data
- paymentResult.data.amount
- paymentResult.data.currency
- paymentResult.data.settlementCurrency
- paymentResult.data.customer
- paymentResult.data.customer.customerRef
- paymentResult.data.customer.orderNumber
- paymentResult.data.customer.orderDate
- paymentResult.data.customer.invoice
- paymentResult.data.customer.birthDate
- paymentResult.data.customer.nationalIdentificationNumber
- paymentResult.data.customer.companyName
- paymentResult.data.customer.firstName
- paymentResult.data.customer.lastName
- paymentResult.data.customer.email
- paymentResult.data.customer.phone
- paymentResult.data.customer.billToAddressOne
- paymentResult.data.customer.billToAddressTwo
- paymentResult.data.customer.billToCity
- paymentResult.data.customer.billToState
- paymentResult.data.customer.billToPostal
- paymentResult.data.customer.billToCountry
- paymentResult.data.customer.billToPhone
- paymentResult.data.customer.shipToAddressOne
- paymentResult.data.customer.shipToAddressTwo
- paymentResult.data.customer.shipToCity
- paymentResult.data.customer.shipToState
- paymentResult.data.customer.shipToPostal
- paymentResult.data.customer.shipToCountry
- paymentResult.data.customer.shipToPhone
- paymentResult.data.customer.createdAt
- paymentResult.card
- paymentResult.card.cardHolder
- paymentResult.card.cardNumber
- paymentResult.card.expirationMonth
- paymentResult.card.expirationYear
- paymentResult.token
- paymentResult.token.firstSix
- paymentResult.token.lastFour
- paymentResult.token.token
- paymentResult.kountResponse
- paymentResult.kountResponse.status
- paymentResult.kountResponse.rules
- lastPaymentStatus
- lastSuccessfulPaymentDate
- exp

</div>

## Path parameters

- `customerRef` string, required

## Response `200`

Success

- object[] — An array of subscription objects for the `customerRef`.
  - `customerRef` CustomerRef — unresolved $ref
  - `active` Active — unresolved $ref
  - `accountId` AccountId — unresolved $ref
  - `id` Id — unresolved $ref
  - `payment` object — Payment information for future payments. To update this information, send a request to the [Update Subscription](https://docs.nexiopay.com/reference/updatesubscription) endpoint
    - `tokenex` object — Card or echeck token information. Card or echeck tokens can be used to process through any MID on your account. They are not restricted to a specific merchant account or currency.
      - `token` Token — unresolved $ref
      - `firstSix` FirstSix — unresolved $ref
      - `lastFour` LastFour — unresolved $ref
    - `data` Data — unresolved $ref
    - `shouldUpdateCard` ShouldUpdateCard — unresolved $ref
    - `isAuthOnly` IsAuthOnly — unresolved $ref
    - `processingOptions` ProcessingOptions — unresolved $ref
  - `schedule` Schedule — unresolved $ref
  - `userName` UserName — unresolved $ref
  - `dateCreated` DateCreated — unresolved $ref
  - `dateLastModified` DateLastModified — unresolved $ref
  - `dateLastRun` DateLastRun — unresolved $ref
  - `dateNextRun` DateNextRun — unresolved $ref
  - `paymentResult` PaymentResult — unresolved $ref
  - `lastPaymentStatus` LastPaymentStatus — unresolved $ref
  - `lastSuccessfulPaymentDate` LastSuccessfulPaymentDate — unresolved $ref
  - `exp` Exp — unresolved $ref
  - `random` RandomNnnn — unresolved $ref

## Other responses

- `401` — Unauthorized. For help with this error and other error codes, see [Common errors](https://docs.nexiopay.com/docs/common-errors) in the Guides area.

---

[API](https://skmtc.dev/nexiopay/apis/payments-api-reference.md) · [All operations](https://skmtc.dev/nexiopay/apis/payments-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nexiopay/payments-api-reference/revisions/b414b73979e5/schema)