EZezypay

List credit notes

Changed on

Retrieve a list of credit notes. The results can be filtered using the available filter options. Must provide at least the customerId, subscriptionId or invoiceId.

get/billing/creditnotes

Request

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

Query parameters

customerIdstring

Filter by unique identifier of the customer.

subscriptionIdstring

Filter by unique identifier of the subscription.

invoiceIdstring

Filter by unique identifier of the invoice.

statusstring

Filter by credit notes status. Supported values are paid, processing, and failed.

reasonstring

Filter by action taken on the invoice associated to the credit note. Supported values are chargeback and refund.

fromstring

Start date for range of credit notes to view. Filter by date defined in creditNoteDate.

untilstring

End date for range of credit notes to view. Filter by date defined in creditNoteDate.

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.

cursorstring

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

Changes