A credit ledger entry.
| Field | Type | Required | Description |
|---|---|---|---|
object |
String | ✔️ | String representing the object's type. Always "commerce_credit_ledger". |
id |
String | ✔️ | Unique identifier for the ledger entry. |
payerId |
String | ✔️ | The ID of the payer whose balance was adjusted. |
amount |
long | ✔️ | The signed credit amount. Positive for increases, negative for decreases. |
currency |
String | ✔️ | The currency code of the credit adjustment. |
sourceType |
String | ✔️ | The type of source that originated the adjustment (e.g. "grant"). |
sourceId |
String | ✔️ | The ID of the source that originated the adjustment. |
note |
JsonNullable<String> | ➖ | An optional note attached to the ledger entry. |
createdAt |
OffsetDateTime | ✔️ | Timestamp when the ledger entry was created. |