Agency
Add Top-Up Credits
Adds top-up message credits to a client workspace
POST
Available on agency plans. The API token must belong to the agency owner.
Top-up credits sit in a separate bucket next to the client’s monthly allowance. The client’s AI agents draw on them only after the monthly
message_limit is used up, and the bucket carries over: it never expires at the monthly renewal or on reset_credits. Credits take effect within seconds.
Pairs with the client.credits_exhausted webhook for automated replenishment: charge the client in your own billing system when the event arrives, then call this endpoint with the event’s delivery id as your Idempotency-Key.
Top-ups require the client to have their own
message_limit of at least 1. Clients without one draw on your agency-wide pool and have no per-client budget to top up; the API returns 422 for them.Top-up credits freeze while a client is paused or suspended and come back untouched on resume. A soft pause drains only the remaining monthly allowance.
If messages were served past the monthly limit shortly before the client ran dry, that small overflow is charged against the next top-up.
messages_remaining in the response is the exact balance the client can serve.Path Parameters
Headers
Body
Response
Returns the client workspace with the updated balances.topup_credits_remaining is the bucket balance and messages_remaining is the total the client can serve (monthly remaining plus top-up, capped by your agency pool).
- 200 Success
- 422 No message limit
- 403 Not an agency account
- 404 Not found
Last modified on August 19, 2026