Retrieve a credit note

Important For sites where both Product Catalog versions 1.0 and 2.0 are active, add the header chargebee-response-schema-type: compat to this API request to receive the response in a format compatible with both Product Catalog 2.0 and Product Catalog 1.0. Note:

If the header is not passed, and your site supports coexistence of legacy and latest product catalogs, the value compat is used by default.

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