Backend API

Fields
idobjectId

Unique identifier for the credit.

amountcurrencyrequired

Credit amount denominated in currency. Minimum of 0.01.

parent_idobjectIdrequired

The ID of the parent customer.

creditCredit memo

Expandable list of the customer’s credit transactions.

credit_idobjectId

ID of the credit applied to the customer's account.

currencystring

Three-letter ISO currency code in uppercase. Defaults to the store's base currency.

date_createddateauto

Date and time the credit was created.

date_updateddateauto

Date and time the credit was last updated.

giftcard_idobjectId

ID of the gift card used to make the payment, if applicable.

giftcardGift Card

Expandable link to the gift card that generated the credit, if applicable.

invoiceInvoice

Expandable link to the invoice the credit was applied to, if applicable.

invoice_idobjectId

ID of the invoice the credit was applied to, if applicable.

numberstringauto

Unique incremental number assigned automatically each time an account credit is created.

parentAccount

Expandable link to the parent customer.

paymentPayment

Expandable link to the payment.

payment_idobjectId

Unique identifier for the payment.

reasonstring

The reason for the refund.

reason_messagestring

A brief message describing the reason for the refund.

refundRefund

Expandable list of refunds that apply to the credit.

refund_idobjectId

ID of the refund the credit was applied to.

The account credit model
{
  "parent_id": "5ffd413300b58e2a4a017831",
  "payment_id": "61e78cbed7e71014da0f1b2c",
  "amount": 100,
  "reason": "promo",
  "reason_message": "Found a bag of gold in a tree stump."
  "currency": "USD",
  "date_created": "2022-01-19T03:59:58.816Z",
  "number": "101082",
  "id": "61e78cbed7e71014da0f1b87"
}