Search
K
clearinghouse-usage

Query own metered usage for an app

Returns OpenMeter rows for the authenticated actor only. Authenticate with Bearer Auth0 user JWT (via Kong Gateway or Railway) or sk_* API key (Railway direct only). Path clientId must match the credential app. Optional externalUserId must equal the actor when set. Meters and groupBy dimensions are constrained to the provisioned catalog.

get

Query Parameters

meterstringrequired

Allowed values:network_fee_usd_microsbillable_usd_microssigned_ticket_countfee_weibillable_secsnetwork_fee_usd_micros_by_manifest

externalUserIdstring

Optional. When set must equal the authenticated actor.

fromstring(date-time)
tostring(date-time)
groupByarray[string]

Extra catalog dimensions. client_id and external_user_id are always included server-side.

Path Parameters

clientIdstringrequired

Response

Actor-scoped usage rows

get/api/v1/apps/{clientId}/usage
 

CreateUserRequest

object
externalUserIdstringrequired
emailstring(email)
connectionstring
issueApiKeyboolean

Default:true

Example

CreateUserResponse

object
idstring
clientIdstring
externalUserIdstring
emailstring
statusstring
apiKeystring

Returned once when issueApiKey is true

Example

TokenExchangeRequest

object
grant_typestringrequired

Allowed values:urn:ietf:params:oauth:grant-type:token-exchange

subject_tokenstringrequired

Auth0 user access token (JWT) or end-user API key (sk_*)

subject_token_typestringrequired

Allowed values:urn:ietf:params:oauth:token-type:access_token

requested_token_typestring

Allowed values:urn:ietf:params:oauth:token-type:access_token

audiencestring

Must match configured signer audience when provided

resourcestring

Must match configured signer audience when provided

Example

SignerSession

object
access_tokenstringrequired
token_typestringrequired

Allowed values:Bearer

expires_inintegerrequired
scopestringrequired
signer_urlstring(uri)
discovery_urlstring(uri)
issued_token_typestring
correlation_idstring
has_accessbooleanrequired

Whether the customer currently has allowance. Always present.

balance_usd_microsinteger(int64)required

Allowance balance in USD micros. Always present.

Example