Retrieve a credit note

Try in API Explorer

Retrieves the Credit Note identified by the specified Credit Note number.

Sample Request

URL Format

GET https://[site].chargebee.com/api/v2/credit_notes/{credit-note-id}

Input Parameters

line_items_limit

optional, integer, default=100, min=1, max=300

Specify the maximum number of line items to include in the response.

Note:

Applicable only when Enterprise-scale Invoicing is enabled.
Enterprise-scale Invoicing is currently in Private Beta. Please reach out to Chargebee Support to enable this feature.

line_items_offset

optional, string, max chars=1000

Specify the starting point for retrieving line items. Use the value from the line_items_next_offset attribute of the previous retrieve API response.

Note:

Applicable only when Enterprise-scale Invoicing is enabled.
Enterprise-scale Invoicing is currently in Private Beta. Please reach out to Chargebee Support to enable this feature.

Returns

credit_noteCredit note object

Resource object representing credit_note