POST
/
companies
/
{company_id}
/
credits
/
consume
curl --request POST \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/credits/consume \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "credit_id": "<string>",
  "customer_id": "<string>",
  "item_id": "<string>",
  "note": "<string>",
  "type": "<string>",
  "units": 1
}'
{
  "total_amount": {},
  "total_units": {},
  "total_units_with_meta": {}
}

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

Company ID. It should have a 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

The amount which has value in cents and a currency

​
credit_id
string | null

The specific credit ID to consume

​
item_id
string | null

The billable item ID whose units are to be consumed

​
note
string | null

Add any notes attached to the credit consumption

​
units
number | null

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