The Credit Note object 

Attributes

• idstring

  Unique identifier for the object.

• currencyenum

  Three-letter ISO currency code, in lowercase. Must be a supported currency.

• invoicestringExpandable

  ID of the invoice.

• linesobject

  Line items that make up the credit note

  Hide child attributes

  • lines.objectstring

    String representing the object’s type. Objects of the same type share the same value. Always has the value list.

  • lines.dataarray of objects

    Details about each object.

    Hide child attributes

    • lines.data.idstring

      Unique identifier for the object.

    • lines.data.objectstring

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

    • lines.data.amountinteger

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

    • lines.data.descriptionnullable string

      Description of the item being credited.

    • lines.data.discount_amountintegerDeprecated

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

    • lines.data.discount_amountsarray of objects

      The amount of discount calculated per discount for this line item

      Hide child attributes

      • lines.data.discount_amounts.amountinteger

        The amount, in cents, of the discount.

      • lines.data.discount_amounts.discountstringExpandable

        The discount that was applied to get this discount amount.

    • lines.data.invoice_line_itemnullable string

      ID of the invoice line item being credited

    • lines.data.livemodeboolean

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

    • lines.data.pretax_credit_amountsarray of objects

      The pretax credit amounts (ex: discount, credit grants, etc) for this line item.

      Hide child attributes

      • lines.data.pretax_credit_amounts.amountinteger

        The amount, in cents, of the pretax credit amount.

      • lines.data.pretax_credit_amounts.credit_balance_transactionnullable stringExpandable

        The credit balance transaction that was applied to get this pretax credit amount.

      • lines.data.pretax_credit_amounts.discountnullable stringExpandable

        The discount that was applied to get this pretax credit amount.

      • lines.data.pretax_credit_amounts.typeenum

        Type of the pretax credit amount referenced.

        Possible enum values

        credit_balance_transaction The pretax credit amount is from a credit balance transaction.

        discount The pretax credit amount is from a discount.

    • lines.data.quantitynullable integer

      The number of units of product being credited.

    • lines.data.tax_ratesarray of objects

      The tax rates which apply to the line item.

      Hide child attributes

      • lines.data.tax_rates.idstring

        Unique identifier for the object.

      • lines.data.tax_rates.objectstring

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

      • lines.data.tax_rates.activeboolean

        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.

      • lines.data.tax_rates.countrynullable string

        Two-letter country code (ISO 3166-1 alpha-2).

      • lines.data.tax_rates.createdtimestamp

        Time at which the object was created. Measured in seconds since the Unix epoch.

      • lines.data.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.

      • lines.data.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.

      • lines.data.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.

      • lines.data.tax_rates.flat_amountnullable object

        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.

        Hide child attributes

        • lines.data.tax_rates.flat_amount.amountinteger

          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).

        • lines.data.tax_rates.flat_amount.currencystring

          Three-letter ISO currency code, in lowercase.

      • lines.data.tax_rates.inclusiveboolean

        This specifies if the tax rate is inclusive or exclusive.

      • lines.data.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.

      • lines.data.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 values

        city

        country

        county

        district

        multiple

        state

      • lines.data.tax_rates.livemodeboolean

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

      • lines.data.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.

      • lines.data.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.

      • lines.data.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 values

        flat_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.

      • lines.data.tax_rates.statenullable string

        ISO 3166-2 subdivision code, without country prefix. For example, “NY” for New York, United States.

      • lines.data.tax_rates.tax_typenullable enum

        The high-level tax type, such as vat or sales_tax.

        Possible enum values

        amusement_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

    • lines.data.taxesnullable array of objects

      The tax information of the line item.

      Hide child attributes

      • lines.data.taxes.amountinteger

        The amount of the tax, in cents.

      • lines.data.taxes.tax_behaviorenum

        Whether this tax is inclusive or exclusive.

        Possible enum values

        exclusive

        inclusive

      • lines.data.taxes.tax_rate_detailsnullable object

        Additional details about the tax rate. Only present when type is tax_rate_details.

      • lines.data.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 values

        customer_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_00000000) was used.

        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

      • lines.data.taxes.taxable_amountnullable integer

        The amount on which tax is calculated, in cents.

      • lines.data.taxes.typeenum

        The type of tax information.

    • lines.data.typeenum

      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.

      Possible enum values

      custom_line_item

      invoice_line_item

    • lines.data.unit_amountnullable integer

      The cost of each unit of product being credited.

    • lines.data.unit_amount_decimalnullable decimal string

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

  • lines.has_moreboolean

    True if this list has another page of items after this one that can be fetched.

  • lines.urlstring

    The URL where this list can be accessed.

• memonullable string

  Customer-facing text that appears on the credit note PDF.

• 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.

• reasonnullable enum

  Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory

  Possible enum values

  duplicate Credit issued for a duplicate payment or charge

  fraudulent Credit note issued for fraudulent activity

  order_change Credit note issued for order change

  product_unsatisfactory Credit note issued for unsatisfactory product

• statusenum

  Status of this credit note, one of issued or void. Learn more about voiding credit notes.

  Possible enum values

  issued The credit note has been issued.

  void The credit note has been voided.

• subtotalinteger

  The integer amount in cents representing the amount of the credit note, excluding exclusive tax and invoice level discounts.

• totalinteger

  The integer amount in cents representing the total amount of the credit note, including tax and all discount.

More attributes

Collapse all

• objectstring

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

• amountinteger

  The integer amount in cents representing the total amount of the credit note, including tax.

• amount_shippinginteger

  This is the sum of all the shipping amounts.

• createdtimestamp

  Time at which the object was created. Measured in seconds since the Unix epoch.

• customerstringExpandable

  ID of the customer.

• customer_balance_transactionnullable stringExpandable

  Customer balance transaction related to this credit note.

• discount_amountintegerDeprecated

  The integer amount in cents representing the total amount of discount that was credited.

• discount_amountsarray of objects

  The aggregate amounts calculated per discount for all line items.

  Hide child attributes

  • discount_amounts.amountinteger

    The amount, in cents, of the discount.

  • discount_amounts.discountstringExpandable

    The discount that was applied to get this discount amount.

• effective_atnullable timestamp

  The date when this credit note is in effect. Same as created unless overwritten. When defined, this value replaces the system-generated ‘Date of issue’ printed on the credit note PDF.

• livemodeboolean

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

• numberstring

  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_amountnullable integer

  Amount that was credited outside of Stripe.

• pdfstring

  The link to download the PDF of the credit note.

• post_payment_amountinteger

  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_amountinteger

  The amount of the credit note by which the invoice’s amount_remaining and amount_due were reduced.

• pretax_credit_amountsarray of objects

  The pretax credit amounts (ex: discount, credit grants, etc) for all line items.

  Hide child attributes

  • 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 values

    credit_balance_transaction The pretax credit amount is from a credit balance transaction.

    discount The pretax credit amount is from a discount.

• refundsarray of objects

  Refunds related to this credit note.

  Hide child attributes

  • refunds.amount_refundedinteger

    Amount of the refund that applies to this credit note, in cents.

  • refunds.refundstringExpandable

    ID of the refund.

• shipping_costnullable object

  The details of the cost of shipping, including the ShippingRate applied to the invoice.

  Hide child attributes

  • shipping_cost.amount_subtotalinteger

    Total shipping cost before any taxes are applied.

  • shipping_cost.amount_taxinteger

    Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.

  • shipping_cost.amount_totalinteger

    Total shipping cost after taxes are applied.

  • shipping_cost.shipping_ratenullable stringExpandable

    The ID of the ShippingRate for this invoice.

  • shipping_cost.taxesnullable array of objectsExpandable

    The taxes applied to the shipping rate.

    Hide child attributes

    • shipping_cost.taxes.amountinteger

      Amount of tax applied for this rate.

    • shipping_cost.taxes.rateobject

      The tax rate applied.

      Hide child attributes

      • shipping_cost.taxes.rate.idstring

        Unique identifier for the object.

      • shipping_cost.taxes.rate.objectstring

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

      • shipping_cost.taxes.rate.activeboolean

        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.

      • shipping_cost.taxes.rate.countrynullable string

        Two-letter country code (ISO 3166-1 alpha-2).

      • shipping_cost.taxes.rate.createdtimestamp

        Time at which the object was created. Measured in seconds since the Unix epoch.

      • shipping_cost.taxes.rate.descriptionnullable string

        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_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.

      • shipping_cost.taxes.rate.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.

      • shipping_cost.taxes.rate.flat_amountnullable object

        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.

        Hide child attributes

        • shipping_cost.taxes.rate.flat_amount.amountinteger

          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).

        • shipping_cost.taxes.rate.flat_amount.currencystring

          Three-letter ISO currency code, in lowercase.

      • shipping_cost.taxes.rate.inclusiveboolean

        This specifies if the tax rate is inclusive or exclusive.

      • shipping_cost.taxes.rate.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.

      • shipping_cost.taxes.rate.jurisdiction_levelnullable enum

        The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates.

        Possible enum values

        city

        country

        county

        district

        multiple

        state

      • shipping_cost.taxes.rate.livemodeboolean

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

      • shipping_cost.taxes.rate.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.

      • shipping_cost.taxes.rate.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.

      • shipping_cost.taxes.rate.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 values

        flat_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.

      • shipping_cost.taxes.rate.statenullable string

        ISO 3166-2 subdivision code, without country prefix. For example, “NY” for New York, United States.

      • shipping_cost.taxes.rate.tax_typenullable enum

        The high-level tax type, such as vat or sales_tax.

        Possible enum values

        amusement_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

    • shipping_cost.taxes.taxability_reasonnullable 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_exempt No tax is applied as the customer is exempt from tax.

      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_00000000) was used.

      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.

      proportionally_rated The shipping cost tax rate is calculated as a weighted average of the other line items’ rates, weighted by their amounts.

      Show 5 more

    • shipping_cost.taxes.taxable_amountnullable integer

      The amount on which tax is calculated, in cents.

• subtotal_excluding_taxnullable integer

  The integer amount in cents representing the amount of the credit note, excluding all tax and invoice level discounts.

• total_excluding_taxnullable integer

  The integer amount in cents representing the total amount of the credit note, excluding tax, but including discounts.

• total_taxesnullable array of objects

  The aggregate tax information for all line items.

  Hide child attributes

  • total_taxes.amountinteger

    The amount of the tax, in cents.

  • total_taxes.tax_behaviorenum

    Whether this tax is inclusive or exclusive.

    Possible enum values

    exclusive

    inclusive

  • total_taxes.tax_rate_detailsnullable object

    Additional details about the tax rate. Only present when type is tax_rate_details.

  • total_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 values

    customer_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_00000000) was used.

    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

  • total_taxes.taxable_amountnullable integer

    The amount on which tax is calculated, in cents.

  • total_taxes.typeenum

    The type of tax information.

• typeenum

  Type of this credit note, one of pre_payment or post_payment. A pre_payment credit note means it was issued when the invoice was open. A post_payment credit note means it was issued when the invoice was paid.

  Possible enum values

  mixed

  post_payment

  pre_payment

• voided_atnullable timestamp

  The time that the credit note was voided.