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

# View subscriptions

`GET /subscription/v3`

Returns the payment information and schedule for one or more existing subscriptions (or payment plans) based on the specified filter parameters.

<!-- 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/>You do not have to include any query parameters, but you can include a value for how many results to return (`limit`), which Nexio account ID to limit results to (`accountId`), and whether to return only active subscriptions or payment plans (`active=true`).


<div style="display:none;">

## Request parameters
- limit
- accountId
- active

## Response parameters
- customerRef
- active
- accountId
- id
- payment
- payment.tokenex
- payment.tokenex.token
- payment.tokenex.requestToken
- payment.tokenex.firstSix
- payment.tokenex.lastFour
- payment.data
- payment.data.amount
- payment.data.currency
- payment.data.customer
- payment.data.customer.customerRef
- payment.isPreExistingToken
- payment.isProcessedFromServer
- payment.subscriptionMetadata
- payment.subscriptionMetadata.subscriptionId
- payment.subscriptionMetadata.accountId
- payment.subscriptionMetadata.isSubscriptionService
- payment.clientIp
- 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.gatewayProcessingError
- paymentResult.message
- paymentResult.gatewayResponse
- paymentResult.gatewayResponse.gatewayName
- paymentResult.gatewayResponse.refNumber
- paymentResult.kountResults
- paymentResult.kountResults.result
- paymentResult.kountResults.message
- paymentResult.merchantId
- lastPaymentStatus
- lastSuccessfulPaymentDate
- exp

</div>

## Query parameters

- `limit` integer
- `accountId` string
- `active` boolean

## Response `200`

Success

- object
  - `limit` integer — The maximum number of transactions returned in the API response. For example, if `limit` is `20`, the API returned up to 20 subscriptions and payment plans.
  - `items` object[]
    - `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 — A previously saved [card token](https://docs.nexiopay.com/reference/savecardtoken). Card 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
        - `requestToken` Token — unresolved $ref
        - `firstSix` FirstSix — unresolved $ref
        - `lastFour` LastFour — unresolved $ref
      - `data` object — Transaction and customer data.
        - `amount` Amount — unresolved $ref
        - `currency` Currency — unresolved $ref
        - `customer` object — Customer information returned when checking fraud or from the processing gateway, when applicable.
          - `customerRef` CustomerRef — unresolved $ref
      - `isPreExistingToken` boolean — Will be `true` if the system ran the transaction using a saved card token. Will be `false` if the system ran the transaction with full card information or did not save the card token.
      - `isProcessedFromServer` boolean — Will be `true` if the system ran the transaction through the server, otherwise it will be `false`.
      - `subscriptionMetadata` object — Details on the subscription.
        - `subscriptionId` string — The unique subscription identifier. You may want to save this value to your system for future tracking and management purposes.
        - `accountId` AccountId — unresolved $ref
        - `isSubscriptionService` boolean — Will be `true` if the payment is handled through the Nexio subscription service, otherwise it will be `false`.
      - `clientIp` ClientIp — 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` object — The response from a successful payment. In the case of a subscription, this is the response of the initial transaction.
      - `gatewayProcessingError` boolean — Will be `true` if there was a gateway error the last time the system attempted to run a transaction, otherwise it will be `false`.
      - `message` Message — unresolved $ref
      - `gatewayResponse` GatewayResponse — unresolved $ref
      - `kountResults` object — Fraud data.
        - `result` string — If Kount is enabled, will be one of four possible statuses: `success`, `review`, `decline`, or `error`. See [Kount response status](https://docs.nexiopay.com/docs/understanding-the-kount-response) in Guides for more information. If Kount is not enabled, will be `unavailable`.
        - `message` string — A message describing the results of the Kount request. If Kount is not enabled, this value will be `Kount is not configured or turned off`.
      - `merchantId` MerchantId — unresolved $ref
    - `lastPaymentStatus` LastPaymentStatus — unresolved $ref
    - `lastSuccessfulPaymentDate` LastSuccessfulPaymentDate — unresolved $ref
    - `exp` Exp — unresolved $ref
  - `hasMore` boolean — Will be `true` if there are more records than were included in the current response.

## 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)