Attributes
- idstring
Unique identifier for the object.
- objectstring
String representing the object’s type. Objects of the same type share the same value.
- amountinteger
The integer amount in cents representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts.
- descriptionnullable string
Description of the item being credited.
- discount_
amountintegerDeprecated The integer amount in cents representing the discount being credited for this line item.
- discount_
amountsarray of objects The amount of discount calculated per discount for this line item
- discount_amounts.
amountinteger The amount, in cents, of the discount.
- discount_amounts.
discountstringExpandable The discount that was applied to get this discount amount.
- invoice_
line_ itemnullable string ID of the invoice line item being credited
- livemodeboolean
Has the value
true
if the object exists in live mode or the valuefalse
if the object exists in test mode. - pretax_
credit_ amountsarray of objects The pretax credit amounts (ex: discount, credit grants, etc) for this line item.
- pretax_credit_amounts.
amountinteger The amount, in cents, of the pretax credit amount.
- pretax_credit_amounts.
credit_ balance_ transactionnullable stringExpandable The credit balance transaction that was applied to get this pretax credit amount.
- pretax_credit_amounts.
discountnullable stringExpandable The discount that was applied to get this pretax credit amount.
- pretax_credit_amounts.
typeenum Type of the pretax credit amount referenced.
Possible enum valuescredit_
balance_ transaction The pretax credit amount is from a credit balance transaction.
discount
The pretax credit amount is from a discount.
- quantitynullable integer
The number of units of product being credited.
- tax_
ratesarray of objects The tax rates which apply to the line item.
- tax_rates.
idstring Unique identifier for the object.
- tax_rates.
objectstring String representing the object’s type. Objects of the same type share the same value.
- tax_rates.
activeboolean Defaults to
true
. When set tofalse
, 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. - tax_rates.
countrynullable string Two-letter country code (ISO 3166-1 alpha-2).
- tax_rates.
createdtimestamp Time at which the object was created. Measured in seconds since the Unix epoch.
- tax_rates.
descriptionnullable string An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
- tax_rates.
display_ namestring The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
- tax_rates.
effective_ percentagenullable float 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.
- tax_rates.
flat_ amountnullable object The amount of the tax rate when the
rate_
istype flat_
. Tax rates withamount rate_
type percentage
can vary based on the transaction, resulting in this field beingnull
. This field exposes the amount and currency of the flat tax rate.- tax_rates.
flat_amount. amountinteger Amount of the tax when the
rate_
istype flat_
. 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).amount - tax_rates.
flat_amount. currencystring Three-letter ISO currency code, in lowercase.
- tax_rates.
inclusiveboolean This specifies if the tax rate is inclusive or exclusive.
- tax_rates.
jurisdictionnullable string The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
- tax_rates.
jurisdiction_ levelnullable enum The level of the jurisdiction that imposes this tax rate. Will be
null
for manually defined tax rates.Possible enum valuescity
country
county
district
multiple
state
- tax_rates.
livemodeboolean Has the value
true
if the object exists in live mode or the valuefalse
if the object exists in test mode. - tax_rates.
metadatanullable object Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- tax_rates.
percentagefloat 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.
- tax_rates.
rate_ typenullable enum 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.Possible enum valuesflat_
amount A fixed amount applied as tax, regardless of the taxable amount, such as a retail delivery fee.
percentage
A tax rate expressed as a percentage of the taxable amount, such as the sales tax rate in California.
- tax_rates.
statenullable string ISO 3166-2 subdivision code, without country prefix. For example, “NY” for New York, United States.
- tax_rates.
tax_ typenullable enum The high-level tax type, such as
vat
orsales_
.tax Possible enum valuesamusement_
tax Amusement Tax
communications_
tax Communications Tax
gst
Goods and Services Tax
hst
Harmonized Sales Tax
igst
Integrated Goods and Services Tax
jct
Japanese Consumption Tax
lease_
tax Chicago Lease Tax
pst
Provincial Sales Tax
qst
Quebec Sales Tax
retail_
delivery_ fee Retail Delivery Fee
Show 4 more
- taxesnullable array of objects
The tax information of the line item.
- taxes.
amountinteger The amount of the tax, in cents.
- taxes.
tax_ behaviorenum Whether this tax is inclusive or exclusive.
Possible enum valuesexclusive
inclusive
- taxes.
tax_ rate_ detailsnullable object Additional details about the tax rate. Only present when
type
istax_
.rate_ details - taxes.
taxability_ reasonenum 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.
Possible enum valuescustomer_
exempt No tax is applied as the customer is exempt from tax.
not_
available The reasoning behind this tax is not available.
not_
collecting No tax is collected either because you are not registered to collect tax in this jurisdiction, or because the non-taxable product tax code (
txcd_
) was used.00000000 not_
subject_ to_ tax No tax is imposed on this transaction.
not_
supported No tax applied. Stripe doesn’t support this jurisdiction, territory, or product.
portion_
product_ exempt A portion of the price is exempt from tax.
portion_
reduced_ rated A portion of the price is taxed at a reduced rate.
portion_
standard_ rated A portion of the price is taxed at the standard rate.
product_
exempt The product or service is nontaxable or exempt from tax.
product_
exempt_ holiday The product or service is not taxed due to a sales tax holiday.
Show 6 more - taxes.
taxable_ amountnullable integer The amount on which tax is calculated, in cents.
- taxes.
typeenum The type of tax information.
- typeenum
The type of the credit note line item, one of
invoice_
orline_ item custom_
. When the type isline_ item invoice_
there is an additionalline_ item invoice_
property on the resource the value of which is the id of the credited line item on the invoice.line_ item Possible enum valuescustom_
line_ item invoice_
line_ item - unit_
amountnullable integer The cost of each unit of product being credited.
- unit_
amount_ decimalnullable decimal string Same as
unit_
, but contains a decimal value with at most 12 decimal places.amount
{ "id": "cnli_1NPtOx2eZvKYlo2CBH1NpUsU", "object": "credit_note_line_item", "amount": 749, "description": "My First Invoice Item (created for API docs)", "discount_amount": 0, "discount_amounts": [], "invoice_line_item": "il_1NPtOx2eZvKYlo2CAUuq0WVl", "livemode": false, "quantity": 1, "taxes": [], "tax_rates": [], "type": "invoice_line_item", "unit_amount": null, "unit_amount_decimal": null}