Sample - Stripe API
GET/v1/credit_notes/{credit_note}/lines

List credit note line items

Lists the line items associated with a credit note. Use starting_after or ending_before to traverse the paginated results and limit to control the page size. The response includes pagination metadata and the credit note line item objects.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

5 parameters
credit_notestringrequired
The unique identifier of the credit note whose line items to retrieve; maximum 5,000 characters.
ending_beforestringoptional
An object ID cursor that retrieves the page of results before the specified item.
expandarray<string>optional
Fields to expand in the response.
limitintegeroptional
The number of line items to return. Must range from 1 to 100 and defaults to 10 when omitted.
starting_afterstringoptional
An object ID cursor that retrieves the page of results after the specified item.

2 status codes
200Returns a list object containing credit note line items in `data`, a `has_more` pagination flag, the `list` object type, and the list URL.
dataarray<CreditNoteLineItem>required
Details about each object.
has_morebooleanrequired
True if this list has another page of items after this one that can be fetched.
objectstringrequired
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
Allowed:list
urlstringrequired
The URL where this list can be accessed.
defaultError response.
errorobjectrequired

Error handling

credit_note must identify the credit note whose lines you want to retrieve and may contain at most 5,000 characters. limit accepts between 1 and 100 items, and starting_after or ending_before must contain an object ID when used for pagination.