On this page
No Headings
objectbilling_entity_coderequiredstring^[a-zA-Z0-9_-]*$Unique code used to identify the billing entity. Must contain only alphanumeric characters, underscores, and hyphens.
sequential_idrequiredintegerThe sequential identifier of the credit note, specifically scoped on the associated invoice. It provides a unique numerical identifier for the credit note within the context of the invoice.
numberrequiredstringThe credit note unique number.
invoice_idrequiredstringuuidUnique identifier assigned to the invoice that the credit note belongs to
invoice_numberrequiredstringThe invoice unique number, related to the credit note.
issuing_daterequiredstringdate^(?:[1-9]\d{3}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|02-(?:0[1-9]|1\d|2[0-8]))|(?:(?:\d{2}(?:0[48]|[2468][048]|[13579][26]))|(?:[02468][048]00|[13579][26]00))-02-29)$The date of creation of the credit note. It follows the ISO 8601 date format and provides the specific date when the credit note was created.
credit_statusstring"AVAILABLE", "CONSUMED", "VOIDED"The status of the credit portion of the credit note
refund_statusstring"PENDING", "SUCCEEDED", "FAILED"The status of the refund portion of the credit note
reasonrequiredstring"DUPLICATED_CHARGE", "PRODUCT_UNSATISFACTORY", "ORDER_CHANGE", "ORDER_CANCELLATION", "FRAUDULENT_CHARGE", "OTHER"The reason for credit note creation
descriptionstring | nullThe description of the credit note.
total_amountrequiredobjectThe total amount of the credit note.
valuerequirednumberdecimal0The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
currency_coderequiredstring^[A-Z]{3}$Currency code in ISO 4217 format.
taxes_amountrequiredobjectThe tax amount of the credit note.
valuerequirednumberdecimal0The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
currency_coderequiredstring^[A-Z]{3}$Currency code in ISO 4217 format.
taxes_raterequirednumberThe tax rate associated with this specific credit note.
sub_total_excluding_taxes_amountrequiredobjectThe subtotal of the credit note excluding any applicable taxes.
valuerequirednumberdecimal0The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
currency_coderequiredstring^[A-Z]{3}$Currency code in ISO 4217 format.
balance_amountrequiredobjectThe remaining credit note amount.
valuerequirednumberdecimal0The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
currency_coderequiredstring^[A-Z]{3}$Currency code in ISO 4217 format.
credit_amountrequiredobjectThe credited amount of the credit note.
valuerequirednumberdecimal0The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
currency_coderequiredstring^[A-Z]{3}$Currency code in ISO 4217 format.
refund_amountrequiredobjectThe refunded amount of the credit note.
valuerequirednumberdecimal0The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
currency_coderequiredstring^[A-Z]{3}$Currency code in ISO 4217 format.
created_atrequiredstringdate-timeThe date when the credit note was created. It is expressed in Coordinated Universal Time (UTC).
updated_atrequiredstringdate-timeThe date when the credit note was last updated. It is expressed in Coordinated Universal Time (UTC).
itemsarrayArray of credit note's items.
itemsobjectidrequiredstringuuidThe credit note's item unique identifier.
amountrequiredobjectThe credit note's item amount.
valuerequirednumberdecimal0The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
currency_coderequiredstring^[A-Z]{3}$Currency code in ISO 4217 format.
feerequiredobjectThe fee object related to the credit note item.
idstring | nulluuidUnique identifier assigned to the fee. This ID is exclusively and serves as a unique identifier for the fee's record.
total_amountobjectThe cost of this specific fee, including any applicable taxes.
valuerequirednumberdecimal0The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
currency_coderequiredstring^[A-Z]{3}$Currency code in ISO 4217 format.
namestring | nullThe the name of the fee associated to any one of the charge, the credit, the subscription or the commitment
applied_taxesarrayitemsobjectidstringuuidUnique identifier of the applied tax.
tax_idstringuuidUnique identifier of the tax.
tax_namestringName of the tax.
tax_codestringUnique code used to identify the tax associated with the API request.
tax_ratenumberThe percentage rate of the tax
tax_descriptionstringInternal description of the taxes
amountobjectAmount of the tax
valuerequirednumberdecimal0The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
currency_coderequiredstring^[A-Z]{3}$Currency code in ISO 4217 format.
created_atstringdate-timeThe date and time when the applied tax was created. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the applied tax was initially created.
credit_note_idstringuuidUnique identifier of the credit note.
base_amountobjectvaluerequirednumberdecimal0The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
currency_coderequiredstring^[A-Z]{3}$Currency code in ISO 4217 format.