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 (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
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 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": [
    ]
}