logo

Customers

Customers are your customers, sometimes known as accounts, clients, members, patrons, or players in other systems.

Retrieve customer lifetime summary metrics

Retrieve customer lifetime summary metrics.

SecuritySecretApiKey or JWT
Request
path Parameters
customerId
required
string

Customer's ID.

Responses
200

Metrics were retrieved successfully.

Response Schema: application/json
currency
string

Currency (three letter ISO 4217 alpha code). For example, USD, EUR.

refundsAmount
number <double>

Sum of all refunded transactions.

revenueAmount
number <double>

Sum of overall sales and captures that were approved.

disputesAmount
number <double>

Sum of all disputed transactions.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/customers/{customerId}/summary-metrics
Request samples
const metrics = await api.customers.getCustomerLifetimeSummaryMetrics({id: 'foobar-0001'});
console.log(metrics.fields.revenueAmount);
Response samples
application/json
{
  • "currency": "string",
  • "refundsAmount": 0,
  • "revenueAmount": 0,
  • "disputesAmount": 0
}