--- title: "Retrieve a credit note's line items" method: GET path: "/v1/credit_notes/{credit_note}/lines" --- # Retrieve a credit note's line items `GET /v1/credit_notes/{credit_note}/lines` When retrieving a credit note, you’ll get a **lines** property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items. ## Path parameters - `credit_note` string, required ## Query parameters - `ending_before` string - `expand` string[] - `limit` integer - `starting_after` string ## Response `200` Successful response. - object - `data` CreditNoteLineItem[], required — Details about each object. - `amount` integer, required — The integer amount in cents (or local equivalent) representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts. - `description` string, nullable — Description of the item being credited. - `discount_amount` integer, required — The integer amount in cents (or local equivalent) representing the discount being credited for this line item. - `discount_amounts` DiscountsResourceDiscountAmount[], required — The amount of discount calculated per discount for this line item - `amount` integer, required — The amount, in cents (or local equivalent), of the discount. - `discount` union, required — The discount that was applied to get this discount amount. - string - Discount — A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes). It contains information about when the discount began, when it will end, and what it is applied to. Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts) - `checkout_session` string, nullable — The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Not present for subscription mode. - `customer` union — The ID of the customer associated with this discount. - string - Customer — This object represents a customer of your business. Use it to [create recurring charges](https://docs.stripe.com/invoicing/customer), [save payment](https://docs.stripe.com/payments/save-during-payment) and contact information, and track payments that belong to the same customer. - … - DeletedCustomer - … - `customer_account` string, nullable — The ID of the account representing the customer associated with this discount. - `end` integer, nullable — If the coupon has a duration of `repeating`, the date that this discount will end. If the coupon has a duration of `once` or `forever`, this attribute will be null. - `id` string, required — The ID of the discount object. Discounts can't be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array. - `invoice` string, nullable — The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. - `invoice_item` string, nullable — The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item. - `object` 'discount', required — String representing the object's type. Objects of the same type share the same value. - `promotion_code` union — The promotion code applied to create this discount. - string - PromotionCode — A Promotion Code represents a customer-redeemable code for an underlying promotion. You can create multiple codes for a single promotion. If you enable promotion codes in your [customer portal configuration](https://docs.stripe.com/customer-management/configure-portal), then customers can redeem a code themselves when updating a subscription in the portal. Customers can also view the currently active promotion codes and coupons on each of their subscriptions in the portal. - … - `source` DiscountSource, required - `coupon` union — The coupon that was redeemed to create this discount. - … - `type` 'coupon', required — The source type of the discount. - `start` integer, required — Date that the coupon was applied. - `subscription` string, nullable — The subscription that this coupon is applied to, if it is applied to a particular subscription. - `subscription_item` string, nullable — The subscription item that this coupon is applied to, if it is applied to a particular subscription item. - DeletedDiscount - `checkout_session` string, nullable — The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Not present for subscription mode. - `customer` union — The ID of the customer associated with this discount. - string - Customer — This object represents a customer of your business. Use it to [create recurring charges](https://docs.stripe.com/invoicing/customer), [save payment](https://docs.stripe.com/payments/save-during-payment) and contact information, and track payments that belong to the same customer. - … - DeletedCustomer - … - `customer_account` string, nullable — The ID of the account representing the customer associated with this discount. - `deleted` true, required — Always true for a deleted object - `id` string, required — The ID of the discount object. Discounts can't be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array. - `invoice` string, nullable — The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. - `invoice_item` string, nullable — The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item. - `object` 'discount', required — String representing the object's type. Objects of the same type share the same value. - `promotion_code` union — The promotion code applied to create this discount. - string - PromotionCode — A Promotion Code represents a customer-redeemable code for an underlying promotion. You can create multiple codes for a single promotion. If you enable promotion codes in your [customer portal configuration](https://docs.stripe.com/customer-management/configure-portal), then customers can redeem a code themselves when updating a subscription in the portal. Customers can also view the currently active promotion codes and coupons on each of their subscriptions in the portal. - … - `source` DiscountSource, required - `coupon` union — The coupon that was redeemed to create this discount. - … - `type` 'coupon', required — The source type of the discount. - `start` integer, required — Date that the coupon was applied. - `subscription` string, nullable — The subscription that this coupon is applied to, if it is applied to a particular subscription. - `subscription_item` string, nullable — The subscription item that this coupon is applied to, if it is applied to a particular subscription item. - `id` string, required — Unique identifier for the object. - `invoice_line_item` string — ID of the invoice line item being credited - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, nullable — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'credit_note_line_item', required — String representing the object's type. Objects of the same type share the same value. - `pretax_credit_amounts` CreditNotesPretaxCreditAmount[], required — The pretax credit amounts (ex: discount, credit grants, etc) for this line item. - `amount` integer, required — The amount, in cents (or local equivalent), of the pretax credit amount. - `credit_balance_transaction` union — The credit balance transaction that was applied to get this pretax credit amount. - string - BillingCreditBalanceTransaction — A credit balance transaction is a resource representing a transaction (either a credit or a debit) against an existing credit grant. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `credit` BillingCreditGrantsResourceBalanceCredit - `amount` BillingCreditGrantsResourceAmount, required - … - `credits_application_invoice_voided` BillingCreditGrantsResourceBalanceCreditsApplicationInvoiceVoided - … - `type` 'credits_application_invoice_voided' | 'credits_granted', required — The type of credit transaction. - `credit_grant` union, required — The credit grant associated with this credit balance transaction. - string - BillingCreditGrant — A credit grant is an API resource that documents the allocation of some billing credits to a customer. Related guide: [Billing credits](https://docs.stripe.com/billing/subscriptions/usage-based/billing-credits) - … - `debit` BillingCreditGrantsResourceBalanceDebit - `amount` BillingCreditGrantsResourceAmount, required - … - `credits_applied` BillingCreditGrantsResourceBalanceCreditsApplied - … - `type` 'credits_applied' | 'credits_expired' | 'credits_voided', required — The type of debit transaction. - `effective_at` integer, required — The effective time of this credit balance transaction. - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `object` 'billing.credit_balance_transaction', required — String representing the object's type. Objects of the same type share the same value. - `test_clock` union — ID of the test clock this credit balance transaction belongs to. - string - TestHelpersTestClock — A test clock enables deterministic control over objects in testmode. With a test clock, you can create objects at a frozen time in the past or future, and advance to a specific future time to observe webhooks and state changes. After the clock advances, you can either validate the current state of your scenario (and test your assumptions), change the current state of your scenario (and test more complex scenarios), or keep advancing forward in time. - … - `type` 'credit' | 'debit', nullable — The type of credit balance transaction (credit or debit). - `discount` union — The discount that was applied to get this pretax credit amount. - string - Discount — A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes). It contains information about when the discount began, when it will end, and what it is applied to. Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts) - `checkout_session` string, nullable — The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Not present for subscription mode. - `customer` union — The ID of the customer associated with this discount. - string - Customer — This object represents a customer of your business. Use it to [create recurring charges](https://docs.stripe.com/invoicing/customer), [save payment](https://docs.stripe.com/payments/save-during-payment) and contact information, and track payments that belong to the same customer. - … - DeletedCustomer - … - `customer_account` string, nullable — The ID of the account representing the customer associated with this discount. - `end` integer, nullable — If the coupon has a duration of `repeating`, the date that this discount will end. If the coupon has a duration of `once` or `forever`, this attribute will be null. - `id` string, required — The ID of the discount object. Discounts can't be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array. - `invoice` string, nullable — The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. - `invoice_item` string, nullable — The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item. - `object` 'discount', required — String representing the object's type. Objects of the same type share the same value. - `promotion_code` union — The promotion code applied to create this discount. - string - PromotionCode — A Promotion Code represents a customer-redeemable code for an underlying promotion. You can create multiple codes for a single promotion. If you enable promotion codes in your [customer portal configuration](https://docs.stripe.com/customer-management/configure-portal), then customers can redeem a code themselves when updating a subscription in the portal. Customers can also view the currently active promotion codes and coupons on each of their subscriptions in the portal. - … - `source` DiscountSource, required - `coupon` union — The coupon that was redeemed to create this discount. - … - `type` 'coupon', required — The source type of the discount. - `start` integer, required — Date that the coupon was applied. - `subscription` string, nullable — The subscription that this coupon is applied to, if it is applied to a particular subscription. - `subscription_item` string, nullable — The subscription item that this coupon is applied to, if it is applied to a particular subscription item. - DeletedDiscount - `checkout_session` string, nullable — The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Not present for subscription mode. - `customer` union — The ID of the customer associated with this discount. - string - Customer — This object represents a customer of your business. Use it to [create recurring charges](https://docs.stripe.com/invoicing/customer), [save payment](https://docs.stripe.com/payments/save-during-payment) and contact information, and track payments that belong to the same customer. - … - DeletedCustomer - … - `customer_account` string, nullable — The ID of the account representing the customer associated with this discount. - `deleted` true, required — Always true for a deleted object - `id` string, required — The ID of the discount object. Discounts can't be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array. - `invoice` string, nullable — The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. - `invoice_item` string, nullable — The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item. - `object` 'discount', required — String representing the object's type. Objects of the same type share the same value. - `promotion_code` union — The promotion code applied to create this discount. - string - PromotionCode — A Promotion Code represents a customer-redeemable code for an underlying promotion. You can create multiple codes for a single promotion. If you enable promotion codes in your [customer portal configuration](https://docs.stripe.com/customer-management/configure-portal), then customers can redeem a code themselves when updating a subscription in the portal. Customers can also view the currently active promotion codes and coupons on each of their subscriptions in the portal. - … - `source` DiscountSource, required - `coupon` union — The coupon that was redeemed to create this discount. - … - `type` 'coupon', required — The source type of the discount. - `start` integer, required — Date that the coupon was applied. - `subscription` string, nullable — The subscription that this coupon is applied to, if it is applied to a particular subscription. - `subscription_item` string, nullable — The subscription item that this coupon is applied to, if it is applied to a particular subscription item. - `type` 'credit_balance_transaction' | 'discount', required — Type of the pretax credit amount referenced. - `quantity` integer, nullable — The number of units of product being credited. - `tax_rates` TaxRate[], required — The tax rates which apply to the line item. - `active` boolean, required — Defaults to `true`. When set to `false`, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. - `country` string, nullable — Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `description` string, nullable — An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. - `display_name` string, required — The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page. - `effective_percentage` number, nullable — Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage reflects the rate actually used to calculate tax based on the product's taxability and whether the user is registered to collect taxes in the corresponding jurisdiction. - `flat_amount` TaxRateFlatAmount — The amount of the tax rate when the `rate_type`` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate. - `amount` integer, required — Amount of the tax when the `rate_type` is `flat_amount`. This positive integer represents how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). - `currency` string, required — Three-letter ISO currency code, in lowercase. - `id` string, required — Unique identifier for the object. - `inclusive` boolean, required — This specifies if the tax rate is inclusive or exclusive. - `jurisdiction` string, nullable — The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice. - `jurisdiction_level` 'city' | 'country' | 'county' | 'district' | 'multiple' | 'state', nullable — The level of the jurisdiction that imposes this tax rate. Will be `null` for manually defined tax rates. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, nullable — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'tax_rate', required — String representing the object's type. Objects of the same type share the same value. - `percentage` number, required — Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions. - `rate_type` 'flat_amount' | 'percentage', nullable — Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax. - `state` string, nullable — [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States. - `tax_type` 'amusement_tax' | 'communications_tax' | 'gst' | 'hst' | 'igst' | 'jct' | 'lease_tax' | 'mass_transit_parking_tax' | 'parking_tax' | 'pst' | 'qst' | 'retail_delivery_fee' | 'rst' | 'sales_tax' | 'service_tax' | 'vat', nullable — The high-level tax type, such as `vat` or `sales_tax`. - `taxes` BillingBillResourceInvoicingTaxesTax[], nullable — The tax information of the line item. - `amount` integer, required — The amount of the tax, in cents (or local equivalent). - `tax_behavior` 'exclusive' | 'inclusive', required — Whether this tax is inclusive or exclusive. - `tax_rate_details` BillingBillResourceInvoicingTaxesTaxRateDetails - `tax_rate` union, required — ID of the tax rate - string - TaxRate — Tax rates can be applied to [invoices](/invoicing/taxes/tax-rates), [subscriptions](/billing/taxes/tax-rates) and [Checkout Sessions](/payments/checkout/use-manual-tax-rates) to collect tax. Related guide: [Tax rates](/billing/taxes/tax-rates) - `active` boolean, required — Defaults to `true`. When set to `false`, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. - `country` string, nullable — Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `description` string, nullable — An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. - `display_name` string, required — The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page. - `effective_percentage` number, nullable — Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage reflects the rate actually used to calculate tax based on the product's taxability and whether the user is registered to collect taxes in the corresponding jurisdiction. - `flat_amount` TaxRateFlatAmount — The amount of the tax rate when the `rate_type`` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate. - … - `id` string, required — Unique identifier for the object. - `inclusive` boolean, required — This specifies if the tax rate is inclusive or exclusive. - `jurisdiction` string, nullable — The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice. - `jurisdiction_level` 'city' | 'country' | 'county' | 'district' | 'multiple' | 'state', nullable — The level of the jurisdiction that imposes this tax rate. Will be `null` for manually defined tax rates. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, nullable — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'tax_rate', required — String representing the object's type. Objects of the same type share the same value. - `percentage` number, required — Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions. - `rate_type` 'flat_amount' | 'percentage', nullable — Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax. - `state` string, nullable — [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States. - `tax_type` 'amusement_tax' | 'communications_tax' | 'gst' | 'hst' | 'igst' | 'jct' | 'lease_tax' | 'mass_transit_parking_tax' | 'parking_tax' | 'pst' | 'qst' | 'retail_delivery_fee' | 'rst' | 'sales_tax' | 'service_tax' | 'vat', nullable — The high-level tax type, such as `vat` or `sales_tax`. - `taxability_reason` 'customer_exempt' | 'not_available' | 'not_collecting' | 'not_subject_to_tax' | 'not_supported' | 'portion_product_exempt' | 'portion_reduced_rated' | 'portion_standard_rated' | 'product_exempt' | 'product_exempt_holiday' | 'proportionally_rated' | 'reduced_rated' | 'reverse_charge' | 'standard_rated' | 'taxable_basis_reduced' | 'zero_rated', required — The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. - `taxable_amount` integer, nullable — The amount on which tax is calculated, in cents (or local equivalent). - `type` 'tax_rate_details', required — The type of tax information. - `type` 'custom_line_item' | 'invoice_line_item', required — The type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. When the type is `invoice_line_item` there is an additional `invoice_line_item` property on the resource the value of which is the id of the credited line item on the invoice. - `unit_amount` integer, nullable — The cost of each unit of product being credited. - `unit_amount_decimal` string, decimal, nullable — Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. ## Other responses - `default` — Error response. --- [API](https://skmtc.net/stripe/apis/spec3.md) · [All operations](https://skmtc.net/stripe/apis/spec3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/stripe/spec3/revisions/3653ad45bbec/schema)