Retrieve a customer's lifetime summary metrics
Experimental

Request

Retrieves lifetime summary metrics for a customer with a specified ID.

Security
SecretApiKey or JWT
Path
customerIdstringrequired

ID of the customer.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/experimental/customers/{customerId}/summary-metrics' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Metrics retrieved.

Bodyapplication/json
currencystring, = 3 charactersread-only

Currency code in ISO 4217 format.

Example:"USD"
refundsAmountnumber, (double)read-only

Total amount of all refunded transactions.

revenueAmountnumber, (double)read-only

Total amount of all approved sales and captures.

disputesAmountnumber, (double)read-only

Total amount of all disputed transactions.

Response
{ "currency": "USD", "refundsAmount": 0.1, "revenueAmount": 0.1, "disputesAmount": 0.1 }