Wallet and usage · API

Wallet

GET/v1/wallet

API key requiredSuccess 200

Parameters

Name	Type	Description
`X-Project-ID`header	string	The project to act on; the default project when omitted; nullable

Response 200 application/json

Name	Type	Description
`balance_cents`required	integer
`held_cents`required	integer	Reserved for videos in production; released or charged when each one ends
`available_cents`required	integer
`low_balance_cents`required	integer	nullable
`currency`required	string	Always `HKD`: every amount is in Hong Kong dollar cents
`organization_id`required	string
`mock_left_cents`	integer	Demo payments only: how much more demo credit this organization can top up in total; absent when payments are real; nullable

Example

curl "https://axiomlab.online/v1/wallet" \
  -H "Authorization: Bearer $AZIMO_API_KEY"

Wallet Entries

GET/v1/wallet/entries

API key requiredSuccess 200

Parameters

Name	Type	Description
`after`query	string	length ≤ 64; nullable
`limit`query	integer	Default `50`; range 1–200
`X-Project-ID`header	string	The project to act on; the default project when omitted; nullable

Response 200 application/json

Name	Type	Description
`data`required	array<object>
`data[].id`required	string
`data[].organization_id`required	string
`data[].kind`required	string
`data[].amount_cents`required	integer
`data[].hold_cents`required	integer
`data[].job_id`required	string	nullable
`data[].note`required	string	nullable
`data[].actor`required	string	nullable
`data[].created_at`required	number
`data[].currency`required	string	Unit of amount_cents and hold_cents: `HKD`, or `USD` for entries written before the wallet switched to HKD (the switch itself is an `adjust` entry whose note states the conversion rate)
`next_cursor`	string	Opaque; pass as `cursor` (or the `after` alias) for the next page; nullable
`has_more`	boolean	Default `false`

Example

curl "https://axiomlab.online/v1/wallet/entries" \
  -H "Authorization: Bearer $AZIMO_API_KEY"

Checkout

POST/v1/wallet/checkout

API key requiredSuccess 201

Parameters

Name	Type	Description
`Idempotency-Key`requiredheader	string	A unique value you generate and keep; reuse it when retrying so the request never runs twice; length 1–128
`X-Project-ID`header	string	The project to act on; the default project when omitted; nullable

Request body application/json

Name	Type	Description
`amount_cents`required	integer	HKD cents, HK$20–HK$100,000; range 2000–10000000

Response 201 application/json

Name	Type	Description
`id`required	string
`url`required	string
`amount_cents`required	integer	HKD cents credited to the wallet once paid
`currency`	string	Default `HKD`
`charge_currency`	string	Currency Stripe charges: HKD, the wallet's own currency; Default `HKD`
`charge_amount`	integer	Amount Stripe charges, in charge_currency cents (equal to amount_cents); Default `0`

Example

curl -X POST "https://axiomlab.online/v1/wallet/checkout" \
  -H "Authorization: Bearer $AZIMO_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"amount_cents": 2000}'

Usage

GET/v1/usage

API key requiredSuccess 200

The amount billed to this project's wallet in [from, to) (default: the last 30 days) and its paid calls and job counts, grouped on request. group_by=job pages by job id with after.

Parameters

Name	Type	Description
`from`query	number	range ≥ 0; nullable
`to`query	number	range ≥ 0; nullable
`group_by`query	string	Default `none`
`limit`query	integer	Default `50`; range 1–200
`after`query	string	length ≤ 32; nullable
`X-Project-ID`header	string	The project to act on; the default project when omitted; nullable

Response 200 application/json

Name	Type	Description
`project_id`required	string
`range`required	map<string, number>
`jobs`required	map<string, integer>
`billed_cents`required	integer	Amount charged to the wallet in the range, in cents of `currency`
`currency`required	string	Always `HKD`
`group_by`required	string
`groups`required	array<object>	nullable
`next_cursor`required	string	nullable

Example

curl "https://axiomlab.online/v1/usage" \
  -H "Authorization: Bearer $AZIMO_API_KEY"