Skip to main content
POST
/
v1
/
organizations
/
credits
Add Credits
curl --request POST \
  --url https://api.mixpeek.com/v1/organizations/credits \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "credits": 123
}'
{
  "previous_balance": 123,
  "credits_added": 123,
  "new_balance": 123,
  "previous_tier": "free",
  "new_tier": "free",
  "tier_upgraded": true
}

Headers

​
Authorization
string
required

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Body

application/json

Request to add credits to an organization.

​
credits
integer
required

Number of credits to add. Must be positive.

Response

Successful Response

Response after adding credits.

​
previous_balance
integer
required

Credit balance before addition

​
credits_added
integer
required

Number of credits added

​
new_balance
integer
required

Credit balance after addition

​
previous_tier
enum<string>
required

Account tier before addition

Available options:
free,
pro,
team,
enterprise
​
new_tier
enum<string>
required

Account tier after addition (may auto-upgrade)

Available options:
free,
pro,
team,
enterprise
​
tier_upgraded
boolean
required

Whether tier was automatically upgraded