# Retrieve a credit note preview's line items When retrieving a credit note preview, you’ll get a **lines** property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items. ## Prerequisites Before you can run the following code snippet, you need to call these APIs with the provided parameters to set up the prerequisite API object(s). 1. createCustomer POST /v1/customers {"name":"Jenny Rosen","email":"jennyrosen@example.com"} 2. createInvoice POST /v1/invoices {"customer":"${node.prerequisites.createCustomer.createCustomer:id}"} ## Request ```curl curl -G https://api.stripe.com/v1/credit_notes/preview/lines \ -u "<>" \ -H "Stripe-Version: 2026-10-28.endive" \ -d invoice={{INVOICE_ID}} ``` ### Response ```json { "object": "list", "data": [ { "id": "cn_1Nn7fB2eZvKYlo2CuJ0wZBlA", "object": "credit_note", "amount": 1451, "amount_shipping": 0, "created": 1693952641, "currency": "usd", "customer": "cus_9s6XKzkNRiz8i3", "customer_balance_transaction": null, "discount_amount": 0, "discount_amounts": [], "effective_at": null, "invoice": "in_1Nn7fB2eZvKYlo2C7meA67Xp", "lines": { "object": "list", "data": [ { "id": "cnli_1Nn7fB2eZvKYlo2Cp8nLMci9", "object": "credit_note_line_item", "amount": 951, "description": "My First Invoice Item (created for API docs)", "discount_amount": 0, "discount_amounts": [], "invoice_line_item": "il_1Nn7fB2eZvKYlo2ChKG2H1tv", "livemode": false, "quantity": 1, "tax_rates": [ { "id": "txr_1Nn7fB2eZvKYlo2CcbF7zzmD", "object": "tax_rate", "active": true, "country": "DE", "created": 1693952641, "description": "VAT Germany", "display_name": "VAT", "effective_percentage": null, "inclusive": false, "jurisdiction": "DE", "livemode": false, "metadata": {}, "percentage": 19, "state": null, "tax_type": "vat" } ], "taxes": [ { "amount": 152, "tax_behavior": "exclusive", "tax_rate_details": { "tax_rate": "txr_1Nn7fB2eZvKYlo2CcbF7zzmD" }, "taxability_reason": "not_available", "taxable_amount": 799, "type": "tax_rate_details" } ], "type": "invoice_line_item", "unit_amount": null, "unit_amount_decimal": null }, { "id": "cnli_1Nn7fB2eZvKYlo2C7OxQLHdz", "object": "credit_note_line_item", "amount": 500, "description": "Service credit", "discount_amount": 0, "discount_amounts": [], "livemode": false, "quantity": 1, "tax_rates": [], "taxes": [], "type": "custom_line_item", "unit_amount": 500, "unit_amount_decimal": "500" } ], "has_more": false, "url": "/v1/credit_notes/cn_1Nn7fB2eZvKYlo2CuJ0wZBlA/lines" }, "livemode": false, "memo": null, "metadata": {}, "number": "ABCD-1234-CN-01", "out_of_band_amount": null, "pdf": "https://pay.stripe.com/credit_notes/acct_1032D82eZvKYlo2C/cnst_123456789/pdf?s=ap", "reason": null, "refund": null, "shipping_cost": null, "status": "issued", "subtotal": 1451, "subtotal_excluding_tax": 1451, "total": 1451, "total_excluding_tax": null, "total_taxes": [ { "amount": 152, "tax_behavior": "exclusive", "tax_rate_details": { "tax_rate": "txr_1Nn7fB2eZvKYlo2CcbF7zzmD" }, "taxability_reason": "not_available", "taxable_amount": 799, "type": "tax_rate_details" } ], "type": "pre_payment", "voided_at": null } ], "has_more": false, "url": "/v1/credit_notes/preview/lines" } ``` ## Parameters - `invoice` (string, required) ID of the invoice. - `amount` (integer, required conditionally) The integer amount in the smallest currency unit representing the total amount of the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided. - `credit_amount` (integer, optional) The integer amount in the smallest currency unit representing the amount to credit the customer’s balance, which will be automatically applied to their next invoice. - `effective_at` (timestamp, optional) The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated ‘Date of issue’ printed on the credit note PDF. - `email_type` (enum, optional) Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`. Possible enum values: - `credit_note` credit note email - `none` no email - `ending_before` (string, optional) A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. - `limit` (integer, optional) A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. - [`lines`](https://docs.stripe.com/api/credit_notes/preview_lines.md?query=lines) (array of objects, required conditionally) Line items that make up the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided. - `memo` (string, optional) The credit note’s memo appears on the credit note PDF. - `metadata` (map, optional) Set of [key-value pairs](https://docs.stripe.com/api/metadata.md) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. - `out_of_band_amount` (integer, optional) The integer amount in the smallest currency unit representing the amount that is credited outside of Stripe. - `reason` (enum, optional) Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` Possible enum values: - `duplicate` Credit issued for a duplicate payment or charge - `fraudulent` Credit note issued for fraudulent activity - `order_change` Credit note issued for order change - `product_unsatisfactory` Credit note issued for unsatisfactory product - `refund_amount` (integer, optional) The integer amount in the smallest currency unit representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. - [`refunds`](https://docs.stripe.com/api/credit_notes/preview_lines.md?query=refunds) (array of objects, optional) Refunds to link to this credit note. - [`shipping_cost`](https://docs.stripe.com/api/credit_notes/preview_lines.md?query=shipping_cost) (object, required conditionally) When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided. - `starting_after` (string, optional) A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. ## Returns Returns a list of [line_item objects](https://docs.stripe.com/api/credit_notes/preview_lines.md#credit_note_line_item_object).