Skip to main content
Manja / Stripe
Schema2020-08-27object

credit_note_line_item

Source
openapi/spec3.json
Commit
d70de345383d
Active snapshot
da69df7e6e11

CreditNoteLineItem

object
amount integer
required

The integer amount in %s representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts.

description string
optionalnullable

Description of the item being credited.

maxLength:5000

discount_amount integer
required

The integer amount in %s representing the discount being credited for this line item.

discount_amounts array
required

The amount of discount calculated per discount for this line item

id string
required

Unique identifier for the object.

maxLength:5000

invoice_line_item string
optional

ID of the invoice line item being credited

maxLength:5000

livemode boolean
required

Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

object string
required

String representing the object's type. Objects of the same type share the same value.

Allowed: "credit_note_line_item"

quantity integer
optionalnullable

The number of units of product being credited.

tax_amounts array
required

The amount of tax calculated per tax rate for this line item

tax_rates array
required

The tax rates which apply to the line item.

type string
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.

Allowed: "custom_line_item""invoice_line_item"

unit_amount integer
optionalnullable

The cost of each unit of product being credited.

unit_amount_decimal string (decimal)
optionalnullable

Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.