EZezypay

List future invoices

Changed on

Retrieve a list of future invoices. The results can then be filtered using the available filter options. Must provide at least the customerId or subscriptionId.

get/billing/futureinvoices

Request

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

Query parameters

subscriptionIdstring

Auto-generated unique identifier of the subscription.

customerIdstring

Auto-generated unique identifier of the customer.

limitinteger

Maximum records to return per pagination call. Limit can range between 1 to 100 records. Default value is set to 10

fromstring required

Start date for range of future invoices to view. Supported format is YYYY-MM-DD.

untilstring required

End date for range of future invoices to view. Supported format is YYYY-MM-DD.

cursorinteger

Minimum offset value to determine the range of values to be fetched. This is default to 0.

Headers

merchantstring required

Merchant ID

Response

200

Example response

{
  "data": [
    {
      "subscriptionId": "fef9bef0-2081-445d-8a4e-b50a5d9eb2b7",
      "date": "2019-07-01",
      "cycleStartDate": "2019-07-01",
      "cycleEndDate": "2019-07-31",
      "items": [
        {
          "description": "high_st_monthly_plan",
          "amount": {
            "currency": "NZD",
            "value": 200
          },
          "type": "subscription_payment",
          "accountingCode": "customer_plan"
        }
      ],
      "amount": {
        "currency": "NZD",
        "value": 200
      },
      "totalTax": {
        "currency": "NZD"
      }
    }
  ],
  "paging": {
    "totalCount": 2
  }
}

Changes