GET:customer_balance/history.json
Commerce APIGET:customer_balance/history.json

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

Query Parameters

currency: String

Filter history by currency

Example: ?currency=USD


customer_id: String, required

Unique customer identifier. See also: Unique Identifiers

Example: ?customer_id=cu_EQzGqWoY


last_key: String

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

Example: ?last_key=str


limit: Int

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

Example: ?limit=5


offset: Int

Skip N entries (pagination). See also: Pagination

Example: ?offset=5


shop_id: String, required

Unique shop identifier. See also: Unique Identifiers

Example: ?shop_id=sh_EQzGqWoY

Response Body

CustomerBalanceHistoryPage

Response Body Type

Loading module