---
title: "List partner subscriptions"
method: GET
path: "/partnersubscriptions"
---

# List partner subscriptions

`GET /partnersubscriptions`

## Request

- Base URL: `https://api-sandbox.ezypay.com/v2`
- URL: `https://api-sandbox.ezypay.com/v2/partnersubscriptions`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://identity-sandbox.ezypay.com/token`

Retrieve a list of partner subscriptions using the available filter options.

## Query parameters

- `recipientId` string
- `status` string
- `name` string
- `limit` integer
- `cursor` integer

## Headers

- `merchant` string, required

## Response `200`

200

- object
  - `data` object[]
    - `id` string
    - `partnerPlanId` string
    - `issuer` object
      - `id` string
      - `name` string
      - `legalName` string
    - `recipient` object
      - `id` string
      - `name` string
      - `legalName` string
    - `name` string
    - `status` string
    - `amount` object
      - `currency` string
      - `value` integer
      - `type` string
    - `tax` object
      - `rate` integer
    - `accountingCode` string
    - `intervalUnit` string
    - `interval` integer
    - `intervalDayType` string
    - `endType` string
    - `startDate` string
    - `endDate` unknown
    - `nextBillingDate` string
    - `merchantConnectionId` string
    - `endTargetBillingCycles` integer
    - `totalBillingCycles` integer
    - `remainingBillingCycles` integer
    - `createdOn` string
    - `cancellationDate` unknown
    - `setupPayments` unknown
  - `paging` object
    - `nextUrl` unknown
    - `nextCursor` integer
    - `limit` integer
    - `totalCount` integer

## Other responses

- `400`: 400

## Changes

- **2026-11-03** `924be4030f56`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/ezypay/apis/vault/changes/partnersubscriptions/get.md)

---

[API](https://skmtc.dev/ezypay/apis/vault.md) - [All operations](https://skmtc.dev/ezypay/apis/vault/llms.txt) - [OpenAPI document](https://skmtc.dev/ezypay/apis/vault/revisions/924be4030f56?raw)