Skip to main content
Points transactions are records of a customer’s points balance being changed. They can be positive (points added) or negative (points deducted), and act like a bank ledger or audit log.
​
id
integer

Unique identifier for the points transaction.

Example:

825673452

​
customer_id
integer

The ID of the customer whose balance this points transaction applies to.

Example:

304169228

​
points_change
integer

The number of points added or removed from the customer's points balance. The value is positive if points were added to the customer's balance and negative if points were deducted.

Example:

100

​
description
string

A message visible to the customer that describes the reason for the points change.

Example:

"Points correction"

​
internal_note
string

A note that is visible to the merchant. This note should never be visible to customers.

Example:

"Due to issue with order #6834"

​
created_at
string<date-time>

The date and time when the points transaction was created.

Example:

"2024-12-07T20:15:27.893Z"

​
updated_at
string<date-time>

The date and time when the points transaction was last updated.

Example:

"2024-12-07T20:15:27.893Z"