Skip to main content
POST
Consume Credits

Authorizations

Authorization
string
header
required

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

Scopes

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_'.

Body

application/json
customer_id
string
required

The customer ID to consume credits

type
string
required

The type of the credit to be consumed, can be one of AMOUNT or UNITS

amount
object | null

The amount to be consumed

credit_id
null | string

The specific credit ID to consume

item_id
null | string

The billable item ID whose units are to be consumed

note
null | string

Add any notes attached to the credit consumption

subscription_id
null | string

The specific subscription to consume credits from

units
null | number

The units to consume

Required range: x >= 0

Response

200 - application/json

OK

total_amount
object | null
total_units
object | null
total_units_with_meta
object | null