Customers > Customer Balance > customerBalanceHistory
Commerce APICustomersCustomer BalancecustomerBalanceHistory
customerBalanceHistory
GET:customer_balance/history.json

Description

Get customer balance history. On customer auth "customer_id" is not required and forced to be the id of the customer.

Permission bit: "customer_balance.read"

Topic: Customer Balance

Arguments

currency: String

Filter history by currency

Example: "USD"


customer_id: String!

Unique customer identifier. See also: Unique Identifiers

Example: "cu_EQzGqWoY"


last_key: String

Key of the last item from previous page. See also: Pagination


limit: Int

Return up to N entries (pagination). See also: Pagination


offset: Int

Skip N entries (pagination). See also: Pagination


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


Result

CustomerBalanceHistoryPage

Preview (typescript)

Loading module