Credit memos

A credit memo is a means of providing a customer with store credit. A common use case for using a credit memo is to provide a customer with store credit, rather than a refund, if the customer pays more than they owe or returns a product.

Retrieve a list of credit memos

Retrieve a list of credit memos.

SecuritySecretApiKey or JWT or ApplicationJWT
Request
query Parameters
filter
string

The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format.

sort
Array of strings

The collection items sort field and order (prefix with "-" for descending sort).

limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

q
string

The partial search of the text fields.

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

A list of credit memos was retrieved successfully.

Response Headers
Pagination-Total
integer

Total items count.

Pagination-Limit
integer

Items per page limit.

Pagination-Offset
integer

Pagination offset.

Response Schema: application/json
Array
customerId
required
string <= 50 characters

The resource ID. Defaults to UUID v4.

currency
required
string (CurrencyCode) = 3 characters

ISO 4217 alphabetic currency code.

id
string <= 50 characters

The resource ID. Defaults to UUID v4.

invoiceId
string or null <= 50 characters

The resource ID. Defaults to UUID v4.

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 Recursive

The resource ID. Defaults to UUID v4.

invoiceItemId
string or null <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

description
string

Credit memo item's description.

price
number <double>

Credit memo item's total price.

productId
string or null <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

planId
string or null <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

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>

Read-only timestamp, automatically assigned on back-end.

updatedTime
string <date-time>

Read-only timestamp, automatically assigned on back-end.

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

The links related to resource.

Array
Any of:
rel
required
string

The link type.

Value: "self"
href
required
string

The link URL.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/credit-memos
Request samples
curl -i -X GET \
  'https://api-sandbox.rebilly.com/organizations/unknown/credit-memos?filter=string&sort=string&limit=1000&offset=0&q=string&expand=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Create a credit memo

Create a credit memo.

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json
customerId
required
string <= 50 characters

The resource ID. Defaults to UUID v4.

currency
required
string (CurrencyCode) = 3 characters

ISO 4217 alphabetic currency code.

invoiceId
string or null <= 50 characters

The resource ID. Defaults to UUID v4.

Array of objects
Array
unitPrice
required
number <double>

Credit memo item's price.

quantity
required
integer

Credit memo item's quantity.

invoiceItemId
string or null <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

description
string

Credit memo item's description.

productId
string or null <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

planId
string or null <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

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.

Responses
201

CreditMemo was created.

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

The resource ID. Defaults to UUID v4.

currency
required
string (CurrencyCode) = 3 characters

ISO 4217 alphabetic currency code.

id
string <= 50 characters

The resource ID. Defaults to UUID v4.

invoiceId
string or null <= 50 characters

The resource ID. Defaults to UUID v4.

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 Recursive

The resource ID. Defaults to UUID v4.

invoiceItemId
string or null <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

description
string

Credit memo item's description.

price
number <double>

Credit memo item's total price.

productId
string or null <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

planId
string or null <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

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>

Read-only timestamp, automatically assigned on back-end.

updatedTime
string <date-time>

Read-only timestamp, automatically assigned on back-end.

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

The links related to resource.

Array
Any of:
rel
required
string

The link type.

Value: "self"
href
required
string

The link URL.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

422

Invalid data was sent.

post/credit-memos
Request samples
application/json
{
  • "invoiceId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "items": [
    ],
  • "reason": "return",
  • "description": "string",
  • "currency": "USD",
  • "shippingAmount": 0,
  • "taxAmount": 0
}
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": [
    ]
}

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 <= 50 characters

The resource ID. Defaults to UUID v4.

currency
required
string (CurrencyCode) = 3 characters

ISO 4217 alphabetic currency code.

id
string <= 50 characters

The resource ID. Defaults to UUID v4.

invoiceId
string or null <= 50 characters

The resource ID. Defaults to UUID v4.

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 Recursive

The resource ID. Defaults to UUID v4.

invoiceItemId
string or null <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

description
string

Credit memo item's description.

price
number <double>

Credit memo item's total price.

productId
string or null <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

planId
string or null <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

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>

Read-only timestamp, automatically assigned on back-end.

updatedTime
string <date-time>

Read-only timestamp, automatically assigned on back-end.

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

The links related to resource.

Array
Any of:
rel
required
string

The link type.

Value: "self"
href
required
string

The link URL.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

get/credit-memos/{id}
Request samples
curl -i -X GET \
  'https://api-sandbox.rebilly.com/organizations/unknown/credit-memos/{id}?expand=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
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": [
    ]
}

Create or update a credit memo with predefined ID

Create or update a credit memo with predefined identifier string.

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

The resource identifier string.

Request Body schema: application/json
customerId
required
string <= 50 characters

The resource ID. Defaults to UUID v4.

currency
required
string (CurrencyCode) = 3 characters

ISO 4217 alphabetic currency code.

invoiceId
string or null <= 50 characters

The resource ID. Defaults to UUID v4.

Array of objects
Array
unitPrice
required
number <double>

Credit memo item's price.

quantity
required
integer

Credit memo item's quantity.

invoiceItemId
string or null <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

description
string

Credit memo item's description.

productId
string or null <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

planId
string or null <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

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.

Responses
200

CreditMemo was updated.

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

The resource ID. Defaults to UUID v4.

currency
required
string (CurrencyCode) = 3 characters

ISO 4217 alphabetic currency code.

id
string <= 50 characters

The resource ID. Defaults to UUID v4.

invoiceId
string or null <= 50 characters

The resource ID. Defaults to UUID v4.

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 Recursive

The resource ID. Defaults to UUID v4.

invoiceItemId
string or null <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

description
string

Credit memo item's description.

price
number <double>

Credit memo item's total price.

productId
string or null <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

planId
string or null <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

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>

Read-only timestamp, automatically assigned on back-end.

updatedTime
string <date-time>

Read-only timestamp, automatically assigned on back-end.

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

The links related to resource.

Array
Any of:
rel
required
string

The link type.

Value: "self"
href
required
string

The link URL.

201

CreditMemo was created.

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

The resource ID. Defaults to UUID v4.

currency
required
string (CurrencyCode) = 3 characters

ISO 4217 alphabetic currency code.

id
string <= 50 characters

The resource ID. Defaults to UUID v4.

invoiceId
string or null <= 50 characters

The resource ID. Defaults to UUID v4.

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 Recursive

The resource ID. Defaults to UUID v4.

invoiceItemId
string or null <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

description
string

Credit memo item's description.

price
number <double>

Credit memo item's total price.

productId
string or null <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

planId
string or null <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

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>

Read-only timestamp, automatically assigned on back-end.

updatedTime
string <date-time>

Read-only timestamp, automatically assigned on back-end.

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

The links related to resource.

Array
Any of:
rel
required
string

The link type.

Value: "self"
href
required
string

The link URL.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

422

Invalid data was sent.

put/credit-memos/{id}
Request samples
application/json
{
  • "invoiceId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "items": [
    ],
  • "reason": "return",
  • "description": "string",
  • "currency": "USD",
  • "shippingAmount": 0,
  • "taxAmount": 0
}
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": [
    ]
}

Void a credit memo

Void a credit memo with a specified identifier string.

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

The resource identifier string.

Responses
201

Credit memo successfully voided .

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

The resource ID. Defaults to UUID v4.

currency
required
string (CurrencyCode) = 3 characters

ISO 4217 alphabetic currency code.

id
string <= 50 characters

The resource ID. Defaults to UUID v4.

invoiceId
string or null <= 50 characters

The resource ID. Defaults to UUID v4.

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 Recursive

The resource ID. Defaults to UUID v4.

invoiceItemId
string or null <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

description
string

Credit memo item's description.

price
number <double>

Credit memo item's total price.

productId
string or null <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

planId
string or null <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

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>

Read-only timestamp, automatically assigned on back-end.

updatedTime
string <date-time>

Read-only timestamp, automatically assigned on back-end.

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

The links related to resource.

Array
Any of:
rel
required
string

The link type.

Value: "self"
href
required
string

The link URL.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

post/credit-memos/{id}/void
Request samples
curl -i -X POST \
  'https://api-sandbox.rebilly.com/organizations/unknown/credit-memos/{id}/void' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
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": [
    ]
}

Credit memo appliedWebhook

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

Credit memo webhook request body resource.

creditMemoId
string

The credit memo ID.

eventType
string

Rebilly webhooks event type.

Enum: "credit-memo-applied" "credit-memo-created" "credit-memo-modified" "credit-memo-partially-applied" "credit-memo-voided"
object
object (CreditMemo)

Credit memo object.

customerId
required
string <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

currency
required
string (CurrencyCode) = 3 characters

ISO 4217 alphabetic currency code.

id
string <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

invoiceId
string or null <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

number
integer

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

Array of objects
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>

Read-only timestamp, automatically assigned on back-end.

updatedTime
string <date-time>

Read-only timestamp, automatically assigned on back-end.

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

The links related to resource.

Array of CreditMemoLink (object) non-empty

The links related to resource.

Array (non-empty)
Any of:
rel
required
string

The link type.

Value: "creditMemo"
href
required
string

The link URL.

Responses
2xx

Return any 2xx status to indicate that the data was received successfully.

Request samples
application/json
{
  • "creditMemoId": "string",
  • "eventType": "credit-memo-applied",
  • "_embedded": {
    },
  • "_links": [
    ]
}

Credit memo createdWebhook

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

Credit memo webhook request body resource.

creditMemoId
string

The credit memo ID.

eventType
string

Rebilly webhooks event type.

Enum: "credit-memo-applied" "credit-memo-created" "credit-memo-modified" "credit-memo-partially-applied" "credit-memo-voided"
object
object (CreditMemo)

Credit memo object.

customerId
required
string <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

currency
required
string (CurrencyCode) = 3 characters

ISO 4217 alphabetic currency code.

id
string <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

invoiceId
string or null <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

number
integer

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

Array of objects
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>

Read-only timestamp, automatically assigned on back-end.

updatedTime
string <date-time>

Read-only timestamp, automatically assigned on back-end.

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

The links related to resource.

Array of CreditMemoLink (object) non-empty

The links related to resource.

Array (non-empty)
Any of:
rel
required
string

The link type.

Value: "creditMemo"
href
required
string

The link URL.

Responses
2xx

Return any 2xx status to indicate that the data was received successfully.

Request samples
application/json
{
  • "creditMemoId": "string",
  • "eventType": "credit-memo-applied",
  • "_embedded": {
    },
  • "_links": [
    ]
}

Credit memo modifiedWebhook

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

Credit memo webhook request body resource.

creditMemoId
string

The credit memo ID.

eventType
string

Rebilly webhooks event type.

Enum: "credit-memo-applied" "credit-memo-created" "credit-memo-modified" "credit-memo-partially-applied" "credit-memo-voided"
object
object (CreditMemo)

Credit memo object.

customerId
required
string <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

currency
required
string (CurrencyCode) = 3 characters

ISO 4217 alphabetic currency code.

id
string <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

invoiceId
string or null <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

number
integer

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

Array of objects
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>

Read-only timestamp, automatically assigned on back-end.

updatedTime
string <date-time>

Read-only timestamp, automatically assigned on back-end.

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

The links related to resource.

Array of CreditMemoLink (object) non-empty

The links related to resource.

Array (non-empty)
Any of:
rel
required
string

The link type.

Value: "creditMemo"
href
required
string

The link URL.

Responses
2xx

Return any 2xx status to indicate that the data was received successfully.

Request samples
application/json
{
  • "creditMemoId": "string",
  • "eventType": "credit-memo-applied",
  • "_embedded": {
    },
  • "_links": [
    ]
}

Credit memo partially appliedWebhook

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

Credit memo webhook request body resource.

creditMemoId
string

The credit memo ID.

eventType
string

Rebilly webhooks event type.

Enum: "credit-memo-applied" "credit-memo-created" "credit-memo-modified" "credit-memo-partially-applied" "credit-memo-voided"
object
object (CreditMemo)

Credit memo object.

customerId
required
string <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

currency
required
string (CurrencyCode) = 3 characters

ISO 4217 alphabetic currency code.

id
string <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

invoiceId
string or null <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

number
integer

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

Array of objects
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>

Read-only timestamp, automatically assigned on back-end.

updatedTime
string <date-time>

Read-only timestamp, automatically assigned on back-end.

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

The links related to resource.

Array of CreditMemoLink (object) non-empty

The links related to resource.

Array (non-empty)
Any of:
rel
required
string

The link type.

Value: "creditMemo"
href
required
string

The link URL.

Responses
2xx

Return any 2xx status to indicate that the data was received successfully.

Request samples
application/json
{
  • "creditMemoId": "string",
  • "eventType": "credit-memo-applied",
  • "_embedded": {
    },
  • "_links": [
    ]
}

Credit memo voidedWebhook

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

Credit memo webhook request body resource.

creditMemoId
string

The credit memo ID.

eventType
string

Rebilly webhooks event type.

Enum: "credit-memo-applied" "credit-memo-created" "credit-memo-modified" "credit-memo-partially-applied" "credit-memo-voided"
object
object (CreditMemo)

Credit memo object.

customerId
required
string <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

currency
required
string (CurrencyCode) = 3 characters

ISO 4217 alphabetic currency code.

id
string <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

invoiceId
string or null <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

number
integer

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

Array of objects
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>

Read-only timestamp, automatically assigned on back-end.

updatedTime
string <date-time>

Read-only timestamp, automatically assigned on back-end.

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

The links related to resource.

Array of CreditMemoLink (object) non-empty

The links related to resource.

Array (non-empty)
Any of:
rel
required
string

The link type.

Value: "creditMemo"
href
required
string

The link URL.

Responses
2xx

Return any 2xx status to indicate that the data was received successfully.

Request samples
application/json
{
  • "creditMemoId": "string",
  • "eventType": "credit-memo-applied",
  • "_embedded": {
    },
  • "_links": [
    ]
}