Quotas

Update the transaction quota settings of the organization

Sets what happens when the monthly transaction quota is reached and who receives the alert emails.

  • 422 TRANSACTION_QUOTA_OVERAGE_NOT_ALLOWED: billing mode requested on a plan that does not allow transaction overage
  • 422 TRANSACTION_QUOTA_RECIPIENT_NOT_MEMBER: a recipient is not a member of the organization
patch/v1/quotas/transactions

Request

  • Base URL: https://api.prod.keyban.io
  • URL: https://api.prod.keyban.io/v1/quotas/transactions
  • Auth: X-Api-Key (a scheme the document does not define)

Request body

blockOnQuotaboolean

Refuse agent transactions at the quota (true) or bill the overage (false). Billing requires a plan that allows overage.

alertRecipientIdsstring[]

Ids of the organization members who receive the quota alert emails. Replaces the current list; empty disables the emails.

Response

limitinteger nullable required

Monthly agent wallet transaction quota of the organization. null means unlimited.

usageinteger required

Consumed agent wallet transactions of the current calendar month (UTC), all applications included.

allowOverageboolean required

Whether the plan allows billing transactions beyond the quota. When false, the quota always blocks.

blockOnQuotaboolean required

Whether agent transactions are refused once the quota is reached. When false, the overage is billed.

pricePerThousandInCentsinteger nullable required

Price in cents of each block of 1,000 transactions beyond the quota (500 = 5.00 EUR per 1,000). The monthly overage invoice rounds its total up to the cent. null when the plan has no overage.

alertRecipientIdsstring[] required

Ids of the organization members who receive the quota alert emails. Empty disables the emails.

Example response

{
  "limit": 2000,
  "usage": 342,
  "pricePerThousandInCents": 500
}

Changes

No recorded changes to this operation across all 1 revision of this API.