POST
/
customers
/
{customer_id}
/
balance_transactions
curl --request POST \
  --url https://api.withorb.com/v1/customers/{customer_id}/balance_transactions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": "<string>",
  "type": "increment",
  "description": "<string>"
}'
{
  "id": "cgZa3SXcsPTVyC4Y",
  "created_at": "2022-05-01T07:01:31+00:00",
  "starting_balance": "33.00",
  "ending_balance": "22.00",
  "amount": "11.00",
  "action": "applied_to_invoice",
  "description": "An optional description",
  "invoice": {
    "id": "gXcsPTVyC4YZa3Sc"
  },
  "type": "increment",
  "credit_note": {
    "id": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

API Keys can be issued in the Orb's web application.

Path Parameters

​
customer_id
string
required

Body

application/json

Response

200
application/json
OK

The response is of type object.