GET/v1/customers/{external_id}/charges

List a customer's charges

Lists the customer's charges, a page at a time, optionally filtered by productId, state and source. Needs customers:read.

curl 'https://api.entitler.co/v1/customers/ada/charges' \
  -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
`product_id`	string
`state`	ChargeState
`page_size`	integer (int64)
`page_token`	string
`source`	ChargeSource

Responses

`200`The ListChargesResponse message.

ListChargesResponse

chargesarray of Chargerequired
- amountAmount
  - amountintegerrequired
    at least 0; at most 18446744073709552000
  - currencystringrequired
  - displaystringrequired
- directionFeeDirectionrequired
  One of FEE_DIRECTION_UNSPECIFIED, FEE_DIRECTION_DEBIT, FEE_DIRECTION_CREDIT.
- discountsarray of ChargeDiscountrequired
  - amountAmount
    - amountintegerrequired
      at least 0; at most 18446744073709552000
    - currencystringrequired
    - displaystringrequired
  - offerIdstringrequired
- feeKeystring
- idstringrequired
- linesarray of UsageChargeLinerequired
  - amountAmount
    - amountintegerrequired
      at least 0; at most 18446744073709552000
    - currencystringrequired
    - displaystringrequired
  - decimalsinteger (int64)
    at least 0; at most 4294967295
  - featureKeystring
  - listAmountAmount
    - amountintegerrequired
      at least 0; at most 18446744073709552000
    - currencystringrequired
    - displaystringrequired
  - offsetAmount
    - amountintegerrequired
      at least 0; at most 18446744073709552000
    - currencystringrequired
    - displaystringrequired
  - planIdstringrequired
  - quantityintegerrequired
    at least 0; at most 18446744073709552000
  - usagePeriodChargeUsagePeriod
    - endsAtintegerrequired
      at least 0; at most 18446744073709552000
    - startsAtintegerrequired
      at least 0; at most 18446744073709552000
  - usagePriceKeystringrequired
  - versionintegerrequired
    at least 0; at most 18446744073709552000
- listAmountAmount
  - amountintegerrequired
    at least 0; at most 18446744073709552000
  - currencystringrequired
  - displaystringrequired
- offerIdstring
- packPurchaseIdstring
- paidAtinteger
  at least 0; at most 18446744073709552000
- payerIdstring
- planIdstring
- productIdstring
- raisedAtintegerrequired
  at least 0; at most 18446744073709552000
- reversedAtinteger
  at least 0; at most 18446744073709552000
- sourceChargeSourcerequired
  One of CHARGE_SOURCE_UNSPECIFIED, CHARGE_SOURCE_FEE, CHARGE_SOURCE_CHARGE_BACK, CHARGE_SOURCE_EXIT_FEE, CHARGE_SOURCE_PRORATION, CHARGE_SOURCE_PAYER_SHARE, CHARGE_SOURCE_GIFT, CHARGE_SOURCE_USAGE, CHARGE_SOURCE_USAGE_CORRECTION, CHARGE_SOURCE_PACK.
- stateChargeStaterequired
  One of CHARGE_STATE_UNSPECIFIED, CHARGE_STATE_AWAITING, CHARGE_STATE_PAID, CHARGE_STATE_REVERSED, CHARGE_STATE_WITHDRAWN, CHARGE_STATE_EXPIRED.
- subscriptionIdstringrequired
- usagePeriodChargeUsagePeriod
  - endsAtintegerrequired
    at least 0; at most 18446744073709552000
  - startsAtintegerrequired
    at least 0; at most 18446744073709552000
- versionNumberinteger
  at least 0; at most 18446744073709552000
- voucherIdstring
nextPageTokenstring

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

Error

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