Retrieve a credit memo

Retrieve a credit memo with specified identifier string.

SecuritySecretApiKey or JWT or ApplicationJWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

query Parameters
expand
string

Expand a response to get a full related object included inside of the _embedded path in the response. It accepts a comma-separated list of objects to expand. See the expand guide for more info.

Responses
200

Credit memo was retrieved successfully.

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

The customer resource ID. Defaults to UUID v4.

currency
required
string (CurrencyCode) = 3 characters

ISO 4217 alphabetic currency code.

id
string <= 50 characters

Credit memo ID.

invoiceId
string or null <= 50 characters

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

number
integer

An auto-incrementing number based on the sequence of credit memos for any particular customer.

Array of objects
Array
unitPrice
required
number <double>

Credit memo item's price.

quantity
required
integer

Credit memo item's quantity.

id
string <= 50 characters

Credit memo item ID.

invoiceItemId
string or null <= 50 characters

An invoice item's ID that the credit item is referenced to.

description
string

Credit memo item's description.

price
number <double>

Credit memo item's total price.

productId
string or null <= 50 characters

The related product's ID.

planId
string or null <= 50 characters

The related plan's ID.

status
string

Status of the credit memo.

Enum: Description
issued

The credit memo is available with a full amount to be applied.

applied

All the amount of the credit memo has been applied, no more credit can be created from it.

partially-applied

Some amount of the credit memo has been applied, credit of amount unusedAmount can be created from it.

voided

Some credit has or hasn't been created from the credit memo, but the credit memo cannot be used anymore.

reason
string

Credit memo reason code.

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

A public description (visible to customers) clarifying the purpose of the credit memo.

shippingAmount
number <double>
Default: 0

The (invoice's) shipping amount to credit.

taxAmount
number <double>
Default: 0

The (invoice's) tax amount to credit.

totalAmount
number <double>
Default: 0

The sum of all credits in the credit memo (items, shipping, tax).

unusedAmount
number <double>
Default: 0

The amount of totalAmount which hasn't been allocated anywhere yet.

revision
integer

Increments when the credit memo is modified.

createdTime
string <date-time>

Credit memo created time.

updatedTime
string <date-time> (UpdatedTime)

Read-only timestamp updates when the resource is updated.

Array of Self (object) or CustomerLink (object) or InvoiceLink (object)

The links related to resource.

Array
Any of:
href
required
string

The link URL.

rel
required
string

The link type.

Value: "self"
401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

get/credit-memos/{id}
Request samples
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "invoiceId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "number": 0,
  • "items": [
    ],
  • "status": "issued",
  • "reason": "return",
  • "description": "string",
  • "currency": "USD",
  • "shippingAmount": 0,
  • "taxAmount": 0,
  • "totalAmount": 0,
  • "unusedAmount": 0,
  • "revision": 0,
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}