Check Balance

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key

string

The idempotency key that will be used to ensure the request is only performed once

Path Parameters

company_id

string

required

The company ID with the prefix 'cmp_'.

customer_id

string

required

customer_id or identifier

Response

200 - application/json

total_amount

object

Show child attributes

total_amount.{key}

object

The amount which has value in cents and a currency

Show child attributes

total_amount.{key}.currency

string

total_amount.{key}.value_in_cents

integer<int64>

total_units

object

Show child attributes

total_units.{key}

number<double>

total_units_with_meta

object

Show child attributes

total_units_with_meta.{key}

object

Show child attributes

total_units_with_meta.{key}.company_id

string

The company ID for the billable item

total_units_with_meta.{key}.created_at

string<date-time>

The date the billable item was created

total_units_with_meta.{key}.description

string

Any description attached to the billable item

total_units_with_meta.{key}.display_type

string

The display type of the billable item which can be one of UNITS, AMOUNT, THOUSAND_UNITS, MILLION_UNITS

total_units_with_meta.{key}.editable

boolean

Whether the billable item can be further edited

total_units_with_meta.{key}.external_name

string

The public name of the billable item

total_units_with_meta.{key}.id

string

The ID of the billable item in Maple

total_units_with_meta.{key}.name

string

The name of the billable item

total_units_with_meta.{key}.standard

boolean

Whether this is a standard billable item in Maple or a custom billable item

total_units_with_meta.{key}.total_units

number<double>

total_units_with_meta.{key}.type

string

The type of the billable item which can be one of CUSTOM_USAGE or CUSTOM_OBJ, based on usage-based item or object-based item

total_units_with_meta.{key}.updated_at

string<date-time>

The date the billable item was last updated

API Features

API Reference

Webhook Reference

Authorizations

Headers

Path Parameters

Response