comecerodocs
Customers

Get a balance transaction

GET
/customers/{customer_id}/balance/transactions/{balance_transaction_id}

Gets one change to a customer's store credit. Use expand=payment or expand=refund to include the payment or refund behind it.

Secret tokens, and limited tokens tied to the customer.

Authorization

headerAuthorizationBearer <token>

A secret, trusted or limited token. See Authentication.

Path Parameters

customer_id*string

The id of the customer. With a limited token from a customer login you can send me instead.

balance_transaction_id*string

The id of the balance transaction (customer_balance_transaction_id).

Response Body

The balance transaction.

application/json
  1. response

One change to a customer's store credit: money added (a positive amount) or taken (a negative amount). Transactions cannot be changed or deleted.

object*"customer_balance_transaction"

The object type. Always customer_balance_transaction.

Value in"customer_balance_transaction"
url*string

The full URL of the transaction.

customer_balance_transaction_id*string

The id of the transaction.

customer_id*string

The id of the customer.

account_id*string

The id of the account.

test*boolean

True for a test transaction.

date_created*string

When the transaction was made.

Formatdate-time
amount*number

The change to the balance, in currency (the balance currency). Positive adds credit, negative takes it.

current_balance*number

The balance right after this transaction, in currency. Can be negative.

currency*string

The balance currency, which amount and current_balance are in.

transaction_amount*number

The change in the currency it was made in (transaction_currency). Positive adds credit, negative takes it.

transaction_currency*string

The currency the payment or refund behind this transaction was in.

memo*|

A note on the transaction, for example why a refund was reversed.

created_by*|

The id of the user who made the transaction by hand, or null.

payment?||

The URL of the payment behind this transaction, the payment when expanded, or null. Only present when your token may read payments.

refund?||

The URL of the refund behind this transaction, the refund when expanded, or null. Only present when your token may read refunds.

formatted?

Only when you send formatted=true. Display text.

Example Request
curl -X GET 'https://api.comecero.com/api/v1/customers/string/balance/transactions/string'
Example Response
{  "object": "customer_balance_transaction",  "url": "https://api.comecero.com/api/v1/customers/0091304300408CuoxY9Pf3/balance/transactions/0093045112207CxAb12Cd3",  "customer_balance_transaction_id": "0093045112207CxAb12Cd3",  "customer_id": "0091304300408CuoxY9Pf3",  "account_id": "AB1234",  "test": true,  "date_created": "2026-11-04T15:02:11Z",  "amount": 25,  "current_balance": 25,  "currency": "USD",  "transaction_amount": 25,  "transaction_currency": "USD",  "memo": null,  "created_by": null,  "payment": null,  "refund": "https://api.comecero.com/api/v1/refunds/0093045112100ReQw34Er5"}

List balance transactions GET

Lists every change to a customer's store credit, oldest first: credit added by refunds and top-up payments, and credit spent or taken back. Each transaction shows the balance right after it. The list is cursor-based: follow `next_page_url`, or send `after_item` or `before_item`. Filter by `date_start` and `date_end` (on `date_created`). Secret tokens, and limited tokens tied to the customer.

List a customer's invoices GET

Lists a customer's invoices, oldest first. The list is offset-based: follow `next_page_url` or send `offset`. Secret tokens, and limited tokens tied to the customer. A limited token never sees draft invoices, whatever `draft` says.