EZezypay

List plans

Changed on

The get list PLANs allow integrators to retrieve all PLANs created for the merchant. PLANs are used as a package option for pricing tiers to accommodate all merchants products and services.

PLANs cannot be deleted and will be filtered from the latest to the oldest created. All PLANs listed will be associated to a Merchant.

get/billing/plans

Request

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

Query parameters

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.

namestring

Filter list of returned plans by name. Partial world search supported. For example, when name=mem, all plans with "mem" as part of the name will be returned.

statusstring

Filter list of returned plans by status. Supported values are active or inactive.

Headers

merchantstring required

Merchant ID

Response

200

Example response

{
  "data": [
    {
      "id": "d35f6384-e5af-4eaf-b4c9-d08511a21921",
      "status": "ACTIVE",
      "name": "high_st_monthly_plan",
      "accountingCode": "customer_plan",
      "amount": {
        "currency": "NZD",
        "value": 200
      },
      "intervalUnit": "MONTH",
      "interval": 1,
      "billingStart": "DAY_OF_MONTH",
      "billingStartValue": "1",
      "billingEnd": "ONGOING",
      "firstBilling": "FULL_AMOUNT",
      "failedPaymentHandling": {
        "initialAction": "STOP",
        "autoRetry": true,
        "retryInDays": 3,
        "maximumFailedAttempts": 4
      },
      "createdOn": "2019-04-01T12:55:04.245"
    }
  ],
  "paging": {
    "totalCount": 1
  }
}

Changes