Auto-incrementing number based on the sequence of credit memos for any particular customer.
object
Allocations reduce the unused amount of a credit memo.
Array of objects
List of transactions (typically refunds, credits, and chargebacks) that are allocated to reduce the unused amount of a credit memo.
To delete transaction allocations, send an empty transaction allocation array in the request.
To modify transaction allocations, send a modified transaction allocation array in the request.
If you do not want to modify or delete transaction allocations, do not send a transaction allocation array in the request.
Array
transactionId
string <= 50 characters
ID of the transaction to which the credit memo is allocated.
amount
number <double>
Amount of credit that is allocated from the credit memo to the transaction.
If the amount value is not supplied or exceeds the unused amount of the credit memo or the transaction amount, the lesser of the following two values is used:
The unused amount of the credit memo.
The transaction amount.
currency
string = 3 characters
Currency code in ISO 4217 format.
createdTime
string <date-time> (CreatedTime)
Date and time which is set automatically when the resource is created.
updatedTime
string <date-time> (UpdatedTime)
Date and time which updates automatically when the resource is updated.
Array of objects
List of invoices that the credit memo is allocated to.
To delete invoice allocations, send an empty invoice allocation array in the request.
Paid invoices cannot be modified or deleted.
To modify invoice allocations, send a modified invoice allocation array in the request.
If you do not want to modify or delete invoice allocations, do not send an invoice allocation array in the request.
Array
invoiceId
string <= 50 characters
ID of invoice to which the credit memo is allocated.
amount
number <double>
Amount of credit that is allocated from the credit memo to the invoice.
If the amount value is not supplied or exceeds the unused amount of the credit memo or the invoice due amount, the lesser of the following two values is used:
The unused amount of the credit memo.
The invoice due amount.
currency
string = 3 characters
Currency code in ISO 4217 format.
createdTime
string <date-time>
Date and time at which a credit memo is allocated.
updatedTime
string <date-time> (UpdatedTime)
Date and time which updates automatically when the resource is updated.
Array of objects
Items of the credit memo.
Array
unitPrice
required
number <double>
Price of the credit memo item.
quantity
required
integer
Quantity of the credit memo item.
id
string <= 50 characters
ID of the credit memo item.
invoiceItemId
string or null <= 50 characters
ID of the invoice item to which the credit item is referenced.
description
string
Description of the credit memo item.
price
number <double>
Total price of the credit memo item.
productId
string <= 50 characters
ID of the related product.
planId
string <= 50 characters
ID of the related plan.
object or null
Credit memo item tax.
status
string
Status of the credit memo.
Enum:
Description
issued
The credit memo is available with a full amount to be applied.
applied
The full amount of the credit memo has been applied. No more credit can be created from it.
partially-applied
A partial amount of the credit memo has been applied.
A credit can be created from the remaining amount.
voided
Credit memo has been voided and cannot be used anymore.
