List credit notes

get

https://api-sandbox.ezypay.com/v2/billing/creditnotes

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.

Query Params

customerId

string

Filter by unique identifier of the customer.

subscriptionId

string

Filter by unique identifier of the subscription.

invoiceId

string

Filter by unique identifier of the invoice.

status

string

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

reason

string

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

from

string

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

until

string

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

limit

int32

Defaults to 100

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.

cursor

string

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

merchant

string

required

Merchant ID

Responses

Language

Response

Choose an example:

application/json

200200

400400