Retrieve credit memos

Retrieves a list of credit memos.

SecuritySecretApiKey or JWT or ApplicationJWT
Request
query Parameters
filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

q
string

Use this field to perform a partial search of text fields.

Responses
200

List of credit memos retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
customerId
required
string (CustomerId) <= 50 characters

Customer resource ID.

currency
required
string (CurrencyCode) = 3 characters

Currency code in ISO 4217 format.

id
string <= 50 characters

ID of the credit memo.

number
integer

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

reason
string

Reason for the credit memo.

Enum: "return" "product-unsatisfactory" "order-change" "order-cancellation" "chargeback" "write-off" "waiver" "customer-credit" "other"
description
string

Public description, that is visible to customers, which describes the purpose of the credit memo.

shippingAmount
number <double>
Default: 0

Shipping amount of an invoice to credit.

taxAmount
number <double>
Default: 0

Sum of items tax amount of an invoice to credit.

totalAmount
number <double>
Default: 0

Total amount of all credits in the credit memo, including items, shipping, and tax.

unusedAmount
number <double>
Default: 0

Unused credit memo amount that has not been allocated.

revision
integer

Number of times the credit memo has been modified.

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

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Enum: "self" "customer" "invoice"
invoiceId
string or null <= 50 characters

ID of the invoice to which the credit memo is issued.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/credit-memos
Request samples
Response samples
application/json
[
  • {
    }
]