EZezypay

List partner subscriptions

Changed on

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

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

Query parameters

recipientIdstring

Auto-generated unique identifier of the merchant that will subscribe and make payments to the subscription.

statusstring

The status of the partner subscription. Supported values are: active - Merchants can subscribe to the plan. Default value. inactive - Merchants are unable to subscribe to the plan

namestring

The name of the partner plan that was subscribed.

limitinteger

To paginate a large result set, use the 'limit' argument to limit the number of results returned per page up to a maximum of 100 records. For example, limit = 10 shows results 1-10. The default returned result would be 100.

cursorinteger

An cursor for use in pagination. Specify the number of objects to skip to fetch the next page of objects. For example, limit=10 and cursor=10 will show results for record 11 - 20.

Headers

merchantstring required

Merchant ID

Response

200

Example response

{
  "data": [
    {
      "id": "315107b6-e341-45c6-ad47-8d0bce9e0b25",
      "partnerPlanId": "26b4bb23-e6cd-401b-8014-5b20093ac7ee",
      "issuer": {
        "id": "eab7bfc6-113a-4e51-aedd-f6a807420656",
        "name": "pnb_ibjl NameNZ",
        "legalName": "pnb_ibjl LegalNameNZ"
      },
      "recipient": {
        "id": "c74437ba-e204-46fc-9b16-0062f896e01e",
        "name": "high_st NameNZ",
        "legalName": "high_st LegalNameNZ"
      },
      "name": "PNB_IBJL_Equipment_Leasing",
      "status": "ACTIVE",
      "amount": {
        "currency": "NZD",
        "value": 10,
        "type": "PERCENTAGE"
      },
      "accountingCode": "EquipmentLeasing",
      "intervalUnit": "MONTH",
      "interval": 1,
      "intervalDayType": "business",
      "endType": "ONGOING",
      "startDate": "2019-04-04",
      "nextBillingDate": "2019-06-06",
      "merchantConnectionId": "dae89c35-246c-4551-83b6-addd94853afb",
      "createdOn": "2019-03-11T07:23:33.851"
    }
  ],
  "paging": {
    "totalCount": 1
  }
}

Changes