Skip to main content
GET
Get the account plan usage of an account

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

organization_id
string
required

Organization ID (UUID)

ledger_id
string
required

Ledger ID (UUID)

account_id
string
required

Account ID (UUID)

Query Parameters

period
string

Period to read, in the YYYY-MM format and the plan timezone. Defaults to the current period; a future period is refused.

Response

OK

accountId
string
required
Example:

"00000000-0000-0000-0000-000000000000"

accountPlanId
string
required
Example:

"00000000-0000-0000-0000-000000000000"

accountPlanVersion
integer<int64>
required

Version of the plan in effect now, whose fees and free quotas are listed.

Example:

1

items
object[] | null
required

One item per fee and quota trigger. A transaction fee counts its free quota per scheme, so it lists one item per scheme.

period
object
required

Period the consumption is counted in.