---
title: "Create a partner subscription"
method: POST
path: "/partnersubscriptions"
---

# Create a partner subscription

`POST /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`

Partner subscriptions provides the means for partner merchants to collect payments from another merchant on a recurring basis. Before creating a partner subscription, you must have a merchant connection with the merchant that will subscribe to the partner subscription.

## Headers

- `merchant` string, required

## Request body

- object
  - `partnerPlanId` string, required: Auto-generated unique identifier of the partner plan.
  - `recipientId` string, required: Auto-generated unique identifier of the merchant that will subscribe and make payments to the subscription.
  - `startDate` string: The preferred start date of the partner subscription. The partner subscription start date cannot be back-dated. The default value follows the partner plan's start date. Supported format is YYYY-MM-DD.
  - `metadata` object: Store additional data about the partner subscription object using key/value pairs format. Max of 40 characters for key name and 255 characters for key value.

## Response `200`

200

- 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

## Other responses

- `400`: 400

## Changes

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

[Operation history](https://skmtc.dev/ezypay/apis/vault/changes/partnersubscriptions/post.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)