GET/v1/customers/{external_id}/usage

List a customer's usage

Lists the customer's usage reports, newest first, with the current meters. Pages are at most 100 and reach back only as far as the plan's usage history allows. Needs usage:read.

curl 'https://api.entitler.co/v1/customers/ada/usage' \
  -H "Authorization: Bearer $ENTITLER_KEY"

Credentials

Send any one of these:

Bearer token

Path parameters

Name	Type	Description
`external_id`required	string	The customer's external ID, or `me` for the customer a customer token or identity token names.

Query parameters

Name	Type	Description
`target.team_id`	string
`target.project_id`	string
`target.environment_id`	string
`feature_key`	string
`page_size`	integer (int64)
`page_token`	string
`member_id`	string

Responses

`200`The ListCustomerUsageResponse message.

ListCustomerUsageResponse

asOfintegerrequired
at least 0; at most 18446744073709552000
customerEntitledCustomer
- customerIdstring
- externalIdstringrequired
entriesarray of UsageLogEntryrequired
- amountinteger (int64)required
- atMsintegerrequired
  at least 0; at most 18446744073709552000
- benefitThousandthsinteger (int64)
  at least 0; at most 4294967295
- cancelledAtMsinteger
  at least 0; at most 18446744073709552000
- costinteger
  at least 0; at most 18446744073709552000
- countedbooleanrequired
- currencystringrequired
- decidedBycommon.Actor
  - idstringrequired
  - typecommon.ActorTyperequired
    One of ACTOR_TYPE_UNSPECIFIED, ACTOR_TYPE_USER, ACTOR_TYPE_KEY, ACTOR_TYPE_SYSTEM.
- decimalsinteger (int64)required
  at least 0; at most 4294967295
- featureKeystringrequired
- idstringrequired
- kindUsageKindrequired
  One of USAGE_KIND_UNSPECIFIED, USAGE_KIND_USE, USAGE_KIND_ADJUST.
- latebooleanrequired
- memberExternalIdstring
- memberIdstring
- memberRemovedbooleanrequired
- reasonstring
- reportedBycommon.Actor
  - idstringrequired
  - typecommon.ActorTyperequired
    One of ACTOR_TYPE_UNSPECIFIED, ACTOR_TYPE_USER, ACTOR_TYPE_KEY, ACTOR_TYPE_SYSTEM.
- setTointeger
  at least 0; at most 18446744073709552000
- sourceUsageSourcerequired
  One of USAGE_SOURCE_UNSPECIFIED, USAGE_SOURCE_API, USAGE_SOURCE_CLIENT, USAGE_SOURCE_DASHBOARD.
- zonestring
featuresarray of FeatureUsagerequired
- currencystringrequired
- decimalsinteger (int64)required
  at least 0; at most 4294967295
- featureKeystringrequired
- memberMeterMeter
  - bankedintegerrequired
    at least 0; at most 18446744073709552000
  - heldintegerrequired
    at least 0; at most 18446744073709552000
  - remainingcommon.Limit
    - countinteger
      at least 0; at most 18446744073709552000
    - unlimitedcommon.Unlimited
  - resetsAtinteger
    at least 0; at most 18446744073709552000
  - topUpLeftintegerrequired
    at least 0; at most 18446744073709552000
  - topUpSpentintegerrequired
    at least 0; at most 18446744073709552000
  - usedintegerrequired
    at least 0; at most 18446744073709552000
- meterMeter
  - bankedintegerrequired
    at least 0; at most 18446744073709552000
  - heldintegerrequired
    at least 0; at most 18446744073709552000
  - remainingcommon.Limit
    - countinteger
      at least 0; at most 18446744073709552000
    - unlimitedcommon.Unlimited
  - resetsAtinteger
    at least 0; at most 18446744073709552000
  - topUpLeftintegerrequired
    at least 0; at most 18446744073709552000
  - topUpSpentintegerrequired
    at least 0; at most 18446744073709552000
  - usedintegerrequired
    at least 0; at most 18446744073709552000
- sharedBystring
memberEntitledMember
- externalIdstringrequired
- memberIdstringrequired
metersStartAgainAtinteger
at least 0; at most 18446744073709552000
nextPageTokenstring
servedServedCatalogue
- changeIdstring
- nothingNothingServed
- releaseServedRelease
  - idstringrequired
  - numberintegerrequired
    at least 0; at most 18446744073709552000
- trackServedTrack
  - idstringrequired
  - namestringrequired

`Error`A refusal, with the HTTP status of its gRPC code.

Error

errorobjectrequired
- codestringrequired
- parametersobjectrequired
  Each value: string
- reasonstringor nullrequired