The API reference isn't available right now
This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.
Back to the API reference
No such model
This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.
Back to the API reference
This reference may be out of date
This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-23 00:19 UTC.
API reference
/
Models
UsageBudgetExceededResponseA model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
The body a sandbox request is refused with when its merchant has spent the plan's transaction
allowance.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
Field
Type
Description error
required string
The refusal class. Always `TooManyRequests`.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
code
required string
The machine-readable refusal code. Always `USAGE_BUDGET_EXCEEDED`.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
message
required string
What ran out and what to do about it: when the allowance resets, or that it does not reset and
retrying won't help.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
limit
required integer (int64)
The number of sandbox transactions the plan allows in the window that refused.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
used
required integer (int64)
The number already used in that window. Zero when the plan refuses sandbox transactions
outright, since nothing was spent.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
This model has no documented fields.
Next steps