The Credit Note object
Attributes
id(string) Unique identifier for the object.object(string) String representing the object’s type. Objects of the same type share the same value.amount(integer) The integer amount in the smallest currency unit representing the total amount of the credit note, including tax.amount_shipping(integer) This is the sum of all the shipping amounts.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.customer(string, expandable (can be expanded into an object with theexpandrequest parameter)) ID of the customer.customer_account(string, nullable) ID of the account representing the customer.customer_balance_transaction(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) Customer balance transaction related to this credit note.discount_amount(integer) The integer amount in the smallest currency unit representing the total amount of discount that was credited.discount_amounts(array of objects) The aggregate amounts calculated per discount for all line items.discount_amounts.amount(integer) The amount, in the smallest currency unit, of the discount.discount_amounts.discount(string, expandable (can be expanded into an object with theexpandrequest parameter)) The discount that was applied to get this discount amount.
effective_at(timestamp, nullable) The date when this credit note is in effect. Same ascreatedunless overwritten. When defined, this value replaces the system-generated ‘Date of issue’ printed on the credit note PDF.invoice(string, expandable (can be expanded into an object with theexpandrequest parameter)) ID of the invoice.lines(object) Line items that make up the credit notelines.object(string) String representing the object’s type. Objects of the same type share the same value. Always has the valuelist.lines.data(array of objects) Details about each object.lines.data.id(string) Unique identifier for the object.lines.data.object(string) String representing the object’s type. Objects of the same type share the same value.lines.data.amount(integer) The integer amount in the smallest currency unit representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts.lines.data.description(string, nullable) Description of the item being credited.lines.data.discount_amount(integer) The integer amount in the smallest currency unit representing the discount being credited for this line item.lines.data.discount_amounts(array of objects) The amount of discount calculated per discount for this line itemlines.data.discount_amounts.amount(integer) The amount, in the smallest currency unit, of the discount.lines.data.discount_amounts.discount(string, expandable (can be expanded into an object with theexpandrequest parameter)) The discount that was applied to get this discount amount.
lines.data.invoice_line_item(string, nullable) ID of the invoice line item being creditedlines.data.livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.lines.data.metadata(object, nullable) 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.lines.data.pretax_credit_amounts(array of objects) The pretax credit amounts (ex: discount, credit grants, etc) for this line item.lines.data.pretax_credit_amounts.amount(integer) The amount, in the smallest currency unit, of the pretax credit amount.lines.data.pretax_credit_amounts.credit_balance_transaction(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The credit balance transaction that was applied to get this pretax credit amount.lines.data.pretax_credit_amounts.discount(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The discount that was applied to get this pretax credit amount.lines.data.pretax_credit_amounts.type(enum) Type of the pretax credit amount referenced. Possible enum values:credit_balance_transactionThe pretax credit amount is from a credit balance transaction.discountThe pretax credit amount is from a discount.
lines.data.quantity(integer, nullable) The number of units of product being credited.lines.data.tax_rates(array of objects) The tax rates which apply to the line item.lines.data.tax_rates.id(string) Unique identifier for the object.lines.data.tax_rates.object(string) String representing the object’s type. Objects of the same type share the same value.lines.data.tax_rates.active(boolean) Defaults totrue. 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.lines.data.tax_rates.country(string, nullable) Two-letter country code (ISO 3166-1 alpha-2).lines.data.tax_rates.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.lines.data.tax_rates.description(string, nullable) An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.lines.data.tax_rates.display_name(string) The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.lines.data.tax_rates.effective_percentage(float, 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.lines.data.tax_rates.flat_amount(object, nullable) The amount of the tax rate when therate_typeisflat_amount. Tax rates withrate_typepercentagecan vary based on the transaction, resulting in this field beingnull. This field exposes the amount and currency of the flat tax rate.lines.data.tax_rates.flat_amount.amount(integer) Amount of the tax when therate_typeisflat_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).lines.data.tax_rates.flat_amount.currency(string) Three-letter ISO currency code, in lowercase.
lines.data.tax_rates.inclusive(boolean) This specifies if the tax rate is inclusive or exclusive.lines.data.tax_rates.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.lines.data.tax_rates.jurisdiction_level(enum, nullable) The level of the jurisdiction that imposes this tax rate. Will benullfor manually defined tax rates. Possible enum values:citycountrycountydistrictmultiplestate
lines.data.tax_rates.livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.lines.data.tax_rates.metadata(object, nullable) 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.lines.data.tax_rates.percentage(float) 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.lines.data.tax_rates.rate_type(enum, nullable) Indicates the type of tax rate applied to the taxable amount. This value can benullwhen no tax applies to the location. This field is only present for TaxRates created by Stripe Tax. Possible enum values:flat_amountA fixed amount applied as tax, regardless of the taxable amount, such as a retail delivery fee.percentageA tax rate expressed as a percentage of the taxable amount, such as the sales tax rate in California.
lines.data.tax_rates.state(string, nullable) ISO 3166-2 subdivision code, without country prefix. For example, “NY” for New York, United States.lines.data.tax_rates.tax_type(enum, nullable) The high-level tax type, such asvatorsales_tax. Possible enum values:admissions_taxAdmissions Taxamusement_taxAmusement Taxattendance_taxAttendance Taxcommunications_taxCommunications Taxentertainment_taxEntertainment Taxgross_receipts_taxGross Receipts TaxgstGoods and Services Taxhospitality_taxHospitality TaxhstHarmonized Sales TaxigstIntegrated Goods and Services TaxjctJapanese Consumption Taxlease_taxChicago Lease Taxluxury_taxLuxury TaxpstProvincial Sales TaxqstQuebec Sales Taxresort_taxResort Taxretail_delivery_feeRetail Delivery FeerstRetail Sales Taxsales_taxSales Taxservice_taxService Taxtourism_taxTourism TaxvatValue-Added Tax
lines.data.taxes(array of objects, nullable) The tax information of the line item.lines.data.taxes.amount(integer) The amount of the tax, in the smallest currency unit.lines.data.taxes.tax_behavior(enum) Whether this tax is inclusive or exclusive. Possible enum values:exclusiveinclusive
lines.data.taxes.tax_rate_details(object, nullable) Additional details about the tax rate. Only present whentypeistax_rate_details.lines.data.taxes.tax_rate_details.tax_rate(string, expandable (can be expanded into an object with theexpandrequest parameter)) ID of the tax rate
lines.data.taxes.taxability_reason(enum) 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 values:customer_exemptNo tax is applied as the customer is exempt from tax.not_availableThe reasoning behind this tax is not available.not_collectingNo tax is collected either because you are not registered to collect tax in this jurisdiction, or because the non-taxable product tax code (txcd_00000000) was used.not_subject_to_taxNo tax is imposed on this transaction.not_supportedNo tax applied. Stripe doesn’t support this jurisdiction, territory, or product.portion_product_exemptA portion of the price is exempt from tax.portion_reduced_ratedA portion of the price is taxed at a reduced rate.portion_standard_ratedA portion of the price is taxed at the standard rate.product_exemptThe product or service is nontaxable or exempt from tax.product_exempt_holidayThe product or service is not taxed due to a sales tax holiday.proportionally_ratedThe shipping cost tax rate is calculated as a weighted average of the other line items’ rates, weighted by their amounts.reduced_ratedTaxed at a reduced rate.reverse_chargeNo tax is applied as it is the responsibility of the buyer to account for tax in this case.standard_ratedTaxed at the standard rate.taxable_basis_reducedA reduced amount of the price is subject to tax.zero_ratedThe transaction is taxed at a special rate of 0% or the transaction is exempt (but these exempt transactions still let you deduct the “input VAT” paid on your business purchases).
lines.data.taxes.taxable_amount(integer, nullable) The amount on which tax is calculated, in the smallest currency unit.lines.data.taxes.type(enum) The type of tax information.
lines.data.type(enum) The type of the credit note line item, one ofinvoice_line_itemorcustom_line_item. When the type isinvoice_line_itemthere is an additionalinvoice_line_itemproperty on the resource the value of which is the id of the credited line item on the invoice. Possible enum values:custom_line_iteminvoice_line_item
lines.data.unit_amount(integer, nullable) The cost of each unit of product being credited.lines.data.unit_amount_decimal(decimal string, nullable) Same asunit_amount, but contains a decimal value with at most 12 decimal places.
lines.has_more(boolean) True if this list has another page of items after this one that can be fetched.lines.url(string) The URL where this list can be accessed.
livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.memo(string, nullable) Customer-facing text that appears on the credit note PDF.metadata(object, nullable) 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.number(string) A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.out_of_band_amount(integer, nullable) Amount that was credited outside of Stripe.pdf(string) The link to download the PDF of the credit note.post_payment_amount(integer) The amount of the credit note that was refunded to the customer, credited to the customer’s balance, credited outside of Stripe, or any combination thereof.pre_payment_amount(integer) The amount of the credit note by which the invoice’samount_remainingandamount_duewere reduced.pretax_credit_amounts(array of objects) The pretax credit amounts (ex: discount, credit grants, etc) for all line items.pretax_credit_amounts.amount(integer) The amount, in the smallest currency unit, of the pretax credit amount.pretax_credit_amounts.credit_balance_transaction(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The credit balance transaction that was applied to get this pretax credit amount.pretax_credit_amounts.discount(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The discount that was applied to get this pretax credit amount.pretax_credit_amounts.type(enum) Type of the pretax credit amount referenced. Possible enum values:credit_balance_transactionThe pretax credit amount is from a credit balance transaction.discountThe pretax credit amount is from a discount.
reason(enum, nullable) Reason for issuing this credit note, one ofduplicate,fraudulent,order_change, orproduct_unsatisfactoryPossible enum values:duplicateCredit issued for a duplicate payment or chargefraudulentCredit note issued for fraudulent activityorder_changeCredit note issued for order changeproduct_unsatisfactoryCredit note issued for unsatisfactory product
refunds(array of objects) Refunds related to this credit note.refunds.amount_refunded(integer) Amount of the refund that applies to this credit note, in the smallest currency unit.refunds.payment_record_refund(object, nullable) The PaymentRecord refund details associated with this credit note refund.refunds.payment_record_refund.payment_record(string) ID of the payment record.refunds.payment_record_refund.refund_group(string) ID of the refund group.
refunds.refund(string, expandable (can be expanded into an object with theexpandrequest parameter)) ID of the refund.refunds.type(enum, nullable) Type of the refund, one ofrefundorpayment_record_refund. Possible enum values:payment_record_refundThe refund being linked to this credit note is a payment record refundrefundThe refund being linked to this credit note is a regular refund
shipping_cost(object, nullable) The details of the cost of shipping, including the ShippingRate applied to the invoice.shipping_cost.amount_subtotal(integer) Total shipping cost before any taxes are applied.shipping_cost.amount_tax(integer) Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.shipping_cost.amount_total(integer) Total shipping cost after taxes are applied.shipping_cost.shipping_rate(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The ID of the ShippingRate for this invoice.shipping_cost.taxes(array of objects, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The taxes applied to the shipping rate.shipping_cost.taxes.amount(integer) Amount of tax applied for this rate.shipping_cost.taxes.rate(object) The tax rate applied.shipping_cost.taxes.rate.id(string) Unique identifier for the object.shipping_cost.taxes.rate.object(string) String representing the object’s type. Objects of the same type share the same value.shipping_cost.taxes.rate.active(boolean) Defaults totrue. 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.shipping_cost.taxes.rate.country(string, nullable) Two-letter country code (ISO 3166-1 alpha-2).shipping_cost.taxes.rate.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.shipping_cost.taxes.rate.description(string, nullable) An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.shipping_cost.taxes.rate.display_name(string) The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.shipping_cost.taxes.rate.effective_percentage(float, 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.shipping_cost.taxes.rate.flat_amount(object, nullable) The amount of the tax rate when therate_typeisflat_amount. Tax rates withrate_typepercentagecan vary based on the transaction, resulting in this field beingnull. This field exposes the amount and currency of the flat tax rate.shipping_cost.taxes.rate.flat_amount.amount(integer) Amount of the tax when therate_typeisflat_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).shipping_cost.taxes.rate.flat_amount.currency(string) Three-letter ISO currency code, in lowercase.
shipping_cost.taxes.rate.inclusive(boolean) This specifies if the tax rate is inclusive or exclusive.shipping_cost.taxes.rate.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.shipping_cost.taxes.rate.jurisdiction_level(enum, nullable) The level of the jurisdiction that imposes this tax rate. Will benullfor manually defined tax rates. Possible enum values:citycountrycountydistrictmultiplestate
shipping_cost.taxes.rate.livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.shipping_cost.taxes.rate.metadata(object, nullable) 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.shipping_cost.taxes.rate.percentage(float) 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.shipping_cost.taxes.rate.rate_type(enum, nullable) Indicates the type of tax rate applied to the taxable amount. This value can benullwhen no tax applies to the location. This field is only present for TaxRates created by Stripe Tax. Possible enum values:flat_amountA fixed amount applied as tax, regardless of the taxable amount, such as a retail delivery fee.percentageA tax rate expressed as a percentage of the taxable amount, such as the sales tax rate in California.
shipping_cost.taxes.rate.state(string, nullable) ISO 3166-2 subdivision code, without country prefix. For example, “NY” for New York, United States.shipping_cost.taxes.rate.tax_type(enum, nullable) The high-level tax type, such asvatorsales_tax. Possible enum values:admissions_taxAdmissions Taxamusement_taxAmusement Taxattendance_taxAttendance Taxcommunications_taxCommunications Taxentertainment_taxEntertainment Taxgross_receipts_taxGross Receipts TaxgstGoods and Services Taxhospitality_taxHospitality TaxhstHarmonized Sales TaxigstIntegrated Goods and Services TaxjctJapanese Consumption Taxlease_taxChicago Lease Taxluxury_taxLuxury TaxpstProvincial Sales TaxqstQuebec Sales Taxresort_taxResort Taxretail_delivery_feeRetail Delivery FeerstRetail Sales Taxsales_taxSales Taxservice_taxService Taxtourism_taxTourism TaxvatValue-Added Tax
shipping_cost.taxes.taxability_reason(enum, nullable) 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 values:customer_exemptNo tax is applied as the customer is exempt from tax.not_collectingNo tax is collected either because you are not registered to collect tax in this jurisdiction, or because the non-taxable product tax code (txcd_00000000) was used.not_subject_to_taxNo tax is imposed on this transaction.not_supportedNo tax applied. Stripe doesn’t support this jurisdiction, territory, or product.portion_product_exemptA portion of the price is exempt from tax.portion_reduced_ratedA portion of the price is taxed at a reduced rate.portion_standard_ratedA portion of the price is taxed at the standard rate.product_exemptThe product or service is nontaxable or exempt from tax.product_exempt_holidayThe product or service is not taxed due to a sales tax holiday.proportionally_ratedThe shipping cost tax rate is calculated as a weighted average of the other line items’ rates, weighted by their amounts.reduced_ratedTaxed at a reduced rate.reverse_chargeNo tax is applied as it is the responsibility of the buyer to account for tax in this case.standard_ratedTaxed at the standard rate.taxable_basis_reducedA reduced amount of the price is subject to tax.zero_ratedThe transaction is taxed at a special rate of 0% or the transaction is exempt (but these exempt transactions still let you deduct the “input VAT” paid on your business purchases).
shipping_cost.taxes.taxable_amount(integer, nullable) The amount on which tax is calculated, in the smallest currency unit.
status(enum) Status of this credit note, one ofissuedorvoid. Learn more about voiding credit notes. Possible enum values:issuedThe credit note has been issued.voidThe credit note has been voided.
subtotal(integer) The integer amount in the smallest currency unit representing the amount of the credit note, excluding exclusive tax and invoice level discounts.subtotal_excluding_tax(integer, nullable) The integer amount in the smallest currency unit representing the amount of the credit note, excluding all tax and invoice level discounts.total(integer) The integer amount in the smallest currency unit representing the total amount of the credit note, including tax and all discount.total_excluding_tax(integer, nullable) The integer amount in the smallest currency unit representing the total amount of the credit note, excluding tax, but including discounts.total_taxes(array of objects, nullable) The aggregate tax information for all line items.total_taxes.amount(integer) The amount of the tax, in the smallest currency unit.total_taxes.tax_behavior(enum) Whether this tax is inclusive or exclusive. Possible enum values:exclusiveinclusive
total_taxes.tax_rate_details(object, nullable) Additional details about the tax rate. Only present whentypeistax_rate_details.total_taxes.tax_rate_details.tax_rate(string, expandable (can be expanded into an object with theexpandrequest parameter)) ID of the tax rate
total_taxes.taxability_reason(enum) 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 values:customer_exemptNo tax is applied as the customer is exempt from tax.not_availableThe reasoning behind this tax is not available.not_collectingNo tax is collected either because you are not registered to collect tax in this jurisdiction, or because the non-taxable product tax code (txcd_00000000) was used.not_subject_to_taxNo tax is imposed on this transaction.not_supportedNo tax applied. Stripe doesn’t support this jurisdiction, territory, or product.portion_product_exemptA portion of the price is exempt from tax.portion_reduced_ratedA portion of the price is taxed at a reduced rate.portion_standard_ratedA portion of the price is taxed at the standard rate.product_exemptThe product or service is nontaxable or exempt from tax.product_exempt_holidayThe product or service is not taxed due to a sales tax holiday.proportionally_ratedThe shipping cost tax rate is calculated as a weighted average of the other line items’ rates, weighted by their amounts.reduced_ratedTaxed at a reduced rate.reverse_chargeNo tax is applied as it is the responsibility of the buyer to account for tax in this case.standard_ratedTaxed at the standard rate.taxable_basis_reducedA reduced amount of the price is subject to tax.zero_ratedThe transaction is taxed at a special rate of 0% or the transaction is exempt (but these exempt transactions still let you deduct the “input VAT” paid on your business purchases).
total_taxes.taxable_amount(integer, nullable) The amount on which tax is calculated, in the smallest currency unit.total_taxes.type(enum) The type of tax information.
type(enum) Type of this credit note, one ofpre_paymentorpost_payment. Apre_paymentcredit note means it was issued when the invoice was open. Apost_paymentcredit note means it was issued when the invoice was paid. Possible enum values:mixedpost_paymentpre_payment
voided_at(timestamp, nullable) The time that the credit note was voided.
The Credit Note object
json
{
"id": "cn_1MxvRqLkdIwHu7ixY0xbUcxk",
"object": "credit_note",
"amount": 1099,
"amount_shipping": 0,
"created": 1681750958,
"currency": "usd",
"customer": "cus_NjLgPhUokHubJC",
"customer_balance_transaction": null,
"discount_amount": 0,
"discount_amounts": [],
"invoice": "in_1MxvRkLkdIwHu7ixABNtI99m",
"lines": {
"object": "list",
"data": [
{
"id": "cnli_1MxvRqLkdIwHu7ixFpdhBFQf",
"object": "credit_note_line_item",
"amount": 1099,
"description": "T-shirt",
"discount_amount": 0,
"discount_amounts": [],
"invoice_line_item": "il_1MxvRlLkdIwHu7ixnkbntxUV",
"livemode": false,
"quantity": 1,
"tax_rates": [],
"taxes": [],
"type": "invoice_line_item",
"unit_amount": 1099,
"unit_amount_decimal": "1099"
}
],
"has_more": false,
"url": "/v1/credit_notes/cn_1MxvRqLkdIwHu7ixY0xbUcxk/lines"
},
"livemode": false,
"memo": null,
"metadata": {},
"number": "C9E0C52C-0036-CN-01",
"out_of_band_amount": null,
"pdf": "https://pay.stripe.com/credit_notes/acct_1M2JTkLkdIwHu7ix/test_YWNjdF8xTTJKVGtMa2RJd0h1N2l4LF9Oak9FOUtQNFlPdk52UXhFd2Z4SU45alpEd21kd0Y4LDcyMjkxNzU50200cROQsSK2/pdf?s=ap",
"pre_payment_amount": 1099,
"post_payment_amount": 0,
"reason": null,
"refunds": [],
"shipping_cost": null,
"status": "issued",
"subtotal": 1099,
"subtotal_excluding_tax": 1099,
"total": 1099,
"total_excluding_tax": 1099,
"total_taxes": [],
"type": "pre_payment",
"voided_at": null
}