Retrieves the balance state of a metered asset balance.

GET

/api/v1/provision/admin/asset-balances/{balanceId}

curl --request GET \
  --url https://example.com/api/v1/provision/admin/asset-balances/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0

Parameters

Path Parameters

balanceId

required

string format: uuid

Balance id.

Responses

200

OK

Admin view of a prepaid credit balance on a monitored asset: credits available, consumed, quota thresholds, and the automatic re-balance (top-up) schedule.

object

id

string format: uuid

name

string

description

string

creditsUsed

Consumed credits since last deposit. Remaining credits are calculated as TotalCredits - CreditsUsed.

number | string format: double

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

totalCredits

Total available credits.

number | string format: double

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

cumulativeCreditsUsed

The total of all credits used over time.

number | string format: double

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

unfundedCredits

Consumption this balance was asked to pay for and could not: usage the vendor is owed and has not been paid for. Cumulative, and not reduced by a later top-up.

number | string format: double

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

lastUnfundedAt

When this balance last failed to cover consumption that had already happened.

null | string format: date-time

unit

string

numberFormat

string

lastDeposit

string format: date-time

usageQuota

Array<object>

A named quota threshold on a credit balance and the severity level it maps to.

object

endUsage

Remaining-balance threshold for this band: the band applies while the credit balance is below this value, and when several bands match the lowest threshold wins. A matching band at Critical severity blocks further deductions.

number | string format: double

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

name

string

quotaUsageLevel

Severity of consumption relative to the configured quotas.

Allowed values: None Normal Warning Critical OverUsage

suspendedUntilAt

Consumption is suspended until this time (e.g. after an overage); null when not suspended.

null | string format: date-time

overageSeverityStatus

Severity of consumption relative to the configured quotas.

Allowed values: None Normal Warning Critical OverUsage

initialCreditAmount

The credits available when the entitlement is created.

number | string format: double

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

isUnlimitedCredits

Indicates if the resource has unlimited credits.

boolean

autoBalanceCronSchedule

Cron schedule for automatic credit balance. The cron syntax consists of five fields separated by spaces:

• Minute (0-59)
• Hour (0-23)
• Day of the Month (1-31)
• Month (1-12 or Jan-Dec)
• Day of the Week (0-6 or Sun-Sat) Special characters:
• • (asterisk): Represents any value for the field.
• , (comma): Separates multiple values.
• • (hyphen): Specifies a range of values.
• / (slash): Specifies increments. Example: “0 0 * * *” means “at midnight every day.”

null | string

lastAutoBalanceDate

Date and time of the last automatic credit balance.

string format: date-time

shouldAutoBalanceTransferCurrentCredits

Indicates if the current credits should be transferred.

boolean

maxAutoBalanceCreditTransferAmount

Maximum amount of credits that can be transferred automatically.

number | string format: double

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

autoBalanceCreditAmount

Amount of credits to balance automatically.

number | string format: double

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

Admin view of a prepaid credit balance on a monitored asset: credits available, consumed, quota thresholds, and the automatic re-balance (top-up) schedule.

object

id

string format: uuid

name

string

description

string

creditsUsed

Consumed credits since last deposit. Remaining credits are calculated as TotalCredits - CreditsUsed.

number | string format: double

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

totalCredits

Total available credits.

number | string format: double

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

cumulativeCreditsUsed

The total of all credits used over time.

number | string format: double

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

unfundedCredits

Consumption this balance was asked to pay for and could not: usage the vendor is owed and has not been paid for. Cumulative, and not reduced by a later top-up.

number | string format: double

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

lastUnfundedAt

When this balance last failed to cover consumption that had already happened.

null | string format: date-time

unit

string

numberFormat

string

lastDeposit

string format: date-time

usageQuota

Array<object>

A named quota threshold on a credit balance and the severity level it maps to.

object

endUsage

Remaining-balance threshold for this band: the band applies while the credit balance is below this value, and when several bands match the lowest threshold wins. A matching band at Critical severity blocks further deductions.

number | string format: double

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

name

string

quotaUsageLevel

Severity of consumption relative to the configured quotas.

Allowed values: None Normal Warning Critical OverUsage

suspendedUntilAt

Consumption is suspended until this time (e.g. after an overage); null when not suspended.

null | string format: date-time

overageSeverityStatus

Severity of consumption relative to the configured quotas.

Allowed values: None Normal Warning Critical OverUsage

initialCreditAmount

The credits available when the entitlement is created.

number | string format: double

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

isUnlimitedCredits

Indicates if the resource has unlimited credits.

boolean

autoBalanceCronSchedule

Cron schedule for automatic credit balance. The cron syntax consists of five fields separated by spaces:

• Minute (0-59)
• Hour (0-23)
• Day of the Month (1-31)
• Month (1-12 or Jan-Dec)
• Day of the Week (0-6 or Sun-Sat) Special characters:
• • (asterisk): Represents any value for the field.
• , (comma): Separates multiple values.
• • (hyphen): Specifies a range of values.
• / (slash): Specifies increments. Example: “0 0 * * *” means “at midnight every day.”

null | string

lastAutoBalanceDate

Date and time of the last automatic credit balance.

string format: date-time

shouldAutoBalanceTransferCurrentCredits

Indicates if the current credits should be transferred.

boolean

maxAutoBalanceCreditTransferAmount

Maximum amount of credits that can be transferred automatically.

number | string format: double

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

autoBalanceCreditAmount

Amount of credits to balance automatically.

number | string format: double

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

Example

{
  "usageQuota": [
    {
      "quotaUsageLevel": "None"
    }
  ],
  "overageSeverityStatus": "None"
}

Admin view of a prepaid credit balance on a monitored asset: credits available, consumed, quota thresholds, and the automatic re-balance (top-up) schedule.

object

id

string format: uuid

name

string

description

string

creditsUsed

Consumed credits since last deposit. Remaining credits are calculated as TotalCredits - CreditsUsed.

number | string format: double

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

totalCredits

Total available credits.

number | string format: double

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

cumulativeCreditsUsed

The total of all credits used over time.

number | string format: double

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

unfundedCredits

Consumption this balance was asked to pay for and could not: usage the vendor is owed and has not been paid for. Cumulative, and not reduced by a later top-up.

number | string format: double

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

lastUnfundedAt

When this balance last failed to cover consumption that had already happened.

null | string format: date-time

unit

string

numberFormat

string

lastDeposit

string format: date-time

usageQuota

Array<object>

A named quota threshold on a credit balance and the severity level it maps to.

object

endUsage

Remaining-balance threshold for this band: the band applies while the credit balance is below this value, and when several bands match the lowest threshold wins. A matching band at Critical severity blocks further deductions.

number | string format: double

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

name

string

quotaUsageLevel

Severity of consumption relative to the configured quotas.

Allowed values: None Normal Warning Critical OverUsage

suspendedUntilAt

Consumption is suspended until this time (e.g. after an overage); null when not suspended.

null | string format: date-time

overageSeverityStatus

Severity of consumption relative to the configured quotas.

Allowed values: None Normal Warning Critical OverUsage

initialCreditAmount

The credits available when the entitlement is created.

number | string format: double

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

isUnlimitedCredits

Indicates if the resource has unlimited credits.

boolean

autoBalanceCronSchedule

Cron schedule for automatic credit balance. The cron syntax consists of five fields separated by spaces:

• Minute (0-59)
• Hour (0-23)
• Day of the Month (1-31)
• Month (1-12 or Jan-Dec)
• Day of the Week (0-6 or Sun-Sat) Special characters:
• • (asterisk): Represents any value for the field.
• , (comma): Separates multiple values.
• • (hyphen): Specifies a range of values.
• / (slash): Specifies increments. Example: “0 0 * * *” means “at midnight every day.”

null | string

lastAutoBalanceDate

Date and time of the last automatic credit balance.

string format: date-time

shouldAutoBalanceTransferCurrentCredits

Indicates if the current credits should be transferred.

boolean

maxAutoBalanceCreditTransferAmount

Maximum amount of credits that can be transferred automatically.

number | string format: double

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

autoBalanceCreditAmount

Amount of credits to balance automatically.

number | string format: double

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

Example

{
  "usageQuota": [
    {
      "quotaUsageLevel": "None"
    }
  ],
  "overageSeverityStatus": "None"
}

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"
}