Sets whether over-quota consumption may draw on the caller's OWN balance. Switching it off stops consumption at the included quota and leaves the credits unspent — it does not refund or expire them. An operator suspension is a separate control and overrides this either way.
const url = 'https://example.com/api/v1/provision/consumer/me/credits/example/spending';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"sessionId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","allowed":true}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/v1/provision/consumer/me/credits/example/spending \ --header 'Content-Type: application/json' \ --data '{ "sessionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "allowed": true }'Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”The caller’s session, the balance-carrying metric, and the desired state.
The consumer’s own choice about whether their renders may draw on extra credits once the included quota is used up. This is the customer’s switch, not the vendor’s: an operator suspension is a separate control and takes precedence over it.
object
The caller’s own session id (must match the license token).
true to let over-quota consumption draw on the balance, false to stop at the
included quota and leave the credits unspent.
Examplegenerated
{ "sessionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "allowed": true}The consumer’s own choice about whether their renders may draw on extra credits once the included quota is used up. This is the customer’s switch, not the vendor’s: an operator suspension is a separate control and takes precedence over it.
object
The caller’s own session id (must match the license token).
true to let over-quota consumption draw on the balance, false to stop at the
included quota and leave the credits unspent.
Examplegenerated
{ "sessionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "allowed": true}The consumer’s own choice about whether their renders may draw on extra credits once the included quota is used up. This is the customer’s switch, not the vendor’s: an operator suspension is a separate control and takes precedence over it.
object
The caller’s own session id (must match the license token).
true to let over-quota consumption draw on the balance, false to stop at the
included quota and leave the credits unspent.
Examplegenerated
{ "sessionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "allowed": true}Responses
Section titled “Responses”OK
The current state of a balance’s consumer spending switch.
object
true when over-quota consumption may draw on this balance.
The current state of a balance’s consumer spending switch.
object
true when over-quota consumption may draw on this balance.
Examplegenerated
{ "entitlementId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "metric": "example", "allowed": true}The current state of a balance’s consumer spending switch.
object
true when over-quota consumption may draw on this balance.
Examplegenerated
{ "entitlementId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "metric": "example", "allowed": true}Bad Request
object
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Unauthorized
object
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Forbidden
object
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Not Found
object
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Conflict
object
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}