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

  Show child attributes

• 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

Expand all

• objectstring

• amountinteger

• amount_shippinginteger

• createdtimestamp

• customerstringExpandable

• customer_balance_transactionnullable stringExpandable

• discount_amountintegerDeprecated

• discount_amountsarray of objects

• effective_atnullable timestamp

• livemodeboolean

• numberstring

• out_of_band_amountnullable integer

• pdfstring

• post_payment_amountinteger

• pre_payment_amountinteger

• pretax_credit_amountsarray of objects

• refundsarray of objects

• shipping_costnullable object

• subtotal_excluding_taxnullable integer

• total_excluding_taxnullable integer

• total_taxesnullable array of objects

• typeenum

• voided_atnullable timestamp

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

  Show child attributes

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

  Show child attributes

• quantitynullable integer

  The number of units of product being credited.

• tax_ratesarray of objects

  The tax rates which apply to the line item.

  Show child attributes

• taxesnullable array of objects

  The tax information of the line item.

  Show child attributes

• 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

• unit_amountnullable integer

  The cost of each unit of product being credited.

• unit_amount_decimalnullable decimal string

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

Issue a credit note to adjust the amount of a finalized invoice. A credit note will first reduce the invoice’s amount_remaining (and amount_due), but not below zero. This amount is indicated by the credit note’s pre_payment_amount. The excess amount is indicated by post_payment_amount, and it can result in any combination of the following:

• Refunds: create a new refund (using refund_amount) or link existing refunds (using refunds).
• Customer balance credit: credit the customer’s balance (using credit_amount) which will be automatically applied to their next invoice when it’s finalized.
• Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount).

The sum of refunds, customer balance credits, and outside of Stripe credits must equal the post_payment_amount.

You may issue multiple credit notes for an invoice. Each credit note may increment the invoice’s pre_payment_credit_notes_amount, post_payment_credit_notes_amount, or both, depending on the invoice’s amount_remaining at the time of credit note creation.

Parameters

• invoicestringRequired

  ID of the invoice.

• linesarray of objectsRequired conditionally

  Line items that make up the credit note. One of amount, lines, or shipping_cost must be provided.

  Show child parameters

• memostring

  The credit note’s memo appears on the credit note PDF.

• metadataobject

  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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

• reasonenum

  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

More parameters

Expand all

• amountintegerRequired conditionally

• credit_amountinteger

• effective_attimestamp

• email_typeenum

• out_of_band_amountinteger

• refund_amountinteger

• refundsarray of objects

• shipping_costobjectRequired conditionally

Updates an existing credit note.

Parameters

• memostring

  Credit note memo.

• metadataobject

  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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

When retrieving a credit note, you’ll get a lines property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

Parameters

No parameters.

More parameters

Expand all

• ending_beforestring

• limitinteger

• starting_afterstring