EZezypay

Update a future invoice

Changed on

Update the future invoice.

put/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

Headers

merchantstring required

Merchant ID

Request body

subscriptionIdstring required

Auto-generated unique identifier of the subscription.

cycleStartDatestring required

The billing cycle start date. Supported format is YYYY-MM-DD.

datestring required

The date the invoice will be issued to the customer. New date must be within cycleStartDate and cycleEndDate but cannot be today's date or more than one year (365 days) after the cycleStartDate. Supported format is YYYY-MM-DD.

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