Reads whether over-quota consumption may draw on the caller's OWN balance for this metric.

GET

/api/v1/provision/consumer/me/credits/{metric}/spending

curl --request GET \
  --url https://example.com/api/v1/provision/consumer/me/credits/example/spending

Parameters

Path Parameters

metric

required

string

The balance-carrying metric.

Query Parameters

sessionId

string format: uuid

The caller’s own session id.

Responses

200

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

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

Example^generated

{
  "entitlementId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "metric": "example",
  "allowed": true
}

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

Example^generated

{
  "entitlementId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "metric": "example",
  "allowed": true
}

401

Unauthorized

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

403

Forbidden

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

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

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}