Sign in

Void a credit note

Marks a credit note as void. Learn more about voiding credit notes.

post/v1/credit_notes/{id}/void

Path parameters

idstring required

Response

Successful response.

amountinteger required

The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax.

amount_shippinginteger required

This is the sum of all the shipping amounts.

createdinteger required

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

currencystring currency required

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

discount_amountinteger required

The integer amount in cents (or local equivalent) representing the total amount of discount that was credited.

effective_atinteger nullable

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.

idstring required

Unique identifier for the object.

livemodeboolean required

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

memostring nullable

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

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

numberstring required

A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.

object'credit_note' required

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

out_of_band_amountinteger nullable

Amount that was credited outside of Stripe.

pdfstring required

The link to download the PDF of the credit note.

reason'duplicate' | 'fraudulent' | 'order_change' | 'product_unsatisfactory' nullable

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

status'issued' | 'void' required

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

subtotalinteger required

The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts.

subtotal_excluding_taxinteger nullable

The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts.

totalinteger required

The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount.

total_excluding_taxinteger nullable

The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts.

type'post_payment' | 'pre_payment' required

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.

voided_atinteger nullable

The time that the credit note was voided.

Changes