Skip to content

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.

POST
/api/v1/provision/consumer/me/credits/{metric}/spending
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 }'
metric
required
string

Consumer spending-switch commands.

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
sessionId

The caller’s own session id (must match the license token).

string format: uuid
allowed

true to let over-quota consumption draw on the balance, false to stop at the included quota and leave the credits unspent.

boolean
Examplegenerated
{
"sessionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"allowed": true
}

OK

The current state of a balance’s consumer spending switch.

object
entitlementId
string format: uuid
metric
string
allowed

true when over-quota consumption may draw on this balance.

boolean

Bad Request

object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string

Unauthorized

object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string

Forbidden

object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string

Not Found

object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string