1. Invoicing
  2. Credit notes
  3. Credit note line items

Credit note line items

credit_note_line_items
copy
Click to Copy
Lists the line items of this credit note.

Columns

No match found
id string, null
Uniquely identifies a line item.
subscription_id string, null
Foreign Key subscriptions.id
A unique identifier for the subscription this line item belongs to.
customer_id string, null
Foreign Key customers.id
A unique identifier for the customer this line item belongs to.
credit_note_id string, not null
Foreign Key credit_notes.id
The unique ID of the credit note for this record.
amount long, null
Total amount of this line item. Typically equals unit amount × quantity.
amount_in_decimal string, null
The decimal representation of the amount for the line_item, in major units of the currency. Typically equals unit_amount_in_decimal × quantity_in_decimal. Returned when multi-decimal pricing is enabled.
date_from timestamp, not null
Start date of this line item.
date_to timestamp, not null
End date of this line item.
description string, not null
Detailed description of this line item.
discount_amount long, null
Total discounts for this line.
entity_description string, null
Detailed description of this item.
entity_id string, null
The identifier of the modeled entity this line item is based on. Will be null for 'adhoc' entity type.
entity_type string, not null
Specifies the modeled entity this line item is based on.
is_taxed boolean, not null, default=false
Specifies whether this line item is taxed.
item_level_discount_amount long, null
Line item-level discounts for this line.
pricing_model string, null
The pricing scheme for this item price.
quantity null, default=1
Quantity of the recurring item represented by this line item. For metered line items, this value is updated from usages once when the invoice is generated as pending and finally when the invoice is closed.
quantity_in_decimal string, null
The decimal representation of the quantity of this line item. Returned when the line_item is quantity-based and multi-decimal pricing is enabled.
reference_line_item_id string, null
Invoice reference line item ID.
tax_amount long, null, default=0
The tax amount charged for this item.
tax_exempt_reason string, null
The reason this line item is exempt from tax.
tax_rate double, null
Rate of tax used to calculate tax for this line item.
unit_amount long, not null
Unit amount of the line item.
unit_amount_in_decimal string, null
The decimal representation of the unit amount of the line_item. The value is in major units of the currency. Returned when the line_item is quantity-based and multi-decimal pricing is enabled.