GetMeteredAssetBalance

GET

/api/v1/provision/admin/assets/resources/balances/{balanceId}

const url = 'https://api.monetizeit.example/api/v1/provision/admin/assets/resources/balances/example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.monetizeit.example/api/v1/provision/admin/assets/resources/balances/example

Authorizations

oidc
email profile roles

Parameters

Path Parameters

balanceId

required

string format: uuid

Responses

200

object

string format: uuid

name

string

description

string

creditsUsed

number format: double

totalCredits

number format: double

cumulativeCreditsUsed

number format: double

unit

string

numberFormat

string

lastDeposit

string format: date-time

usageQuota

Array<object>

object

endUsage

number format: double

name

string

quotaUsageLevel

integer format: int32

Allowed values: 0 1 2 3

suspendUntilTimeStamp

string format: date-time

overageSeverityStatus

integer format: int32

Allowed values: 0 1 2 3

initialCreditAmount

number format: double

isUnlimitedCredits

boolean

autoBalanceCronSchedule

string

lastAutoBalanceDate

string format: date-time

shouldAutoBalanceTransferCurrentCredits

boolean

maxAutoBalanceCreditTransferAmount

number format: double

autoBalanceCreditAmount

number format: double

object

string format: uuid

name

string

description

string

creditsUsed

number format: double

totalCredits

number format: double

cumulativeCreditsUsed

number format: double

unit

string

numberFormat

string

lastDeposit

string format: date-time

usageQuota

Array<object>

object

endUsage

number format: double

name

string

quotaUsageLevel

integer format: int32

Allowed values: 0 1 2 3

suspendUntilTimeStamp

string format: date-time

overageSeverityStatus

integer format: int32

Allowed values: 0 1 2 3

initialCreditAmount

number format: double

isUnlimitedCredits

boolean

autoBalanceCronSchedule

string

lastAutoBalanceDate

string format: date-time

shouldAutoBalanceTransferCurrentCredits

boolean

maxAutoBalanceCreditTransferAmount

number format: double

autoBalanceCreditAmount

number format: double

Example

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

object

string format: uuid

name

string

description

string

creditsUsed

number format: double

totalCredits

number format: double

cumulativeCreditsUsed

number format: double

unit

string

numberFormat

string

lastDeposit

string format: date-time

usageQuota

Array<object>

object

endUsage

number format: double

name

string

quotaUsageLevel

integer format: int32

Allowed values: 0 1 2 3

suspendUntilTimeStamp

string format: date-time

overageSeverityStatus

integer format: int32

Allowed values: 0 1 2 3

initialCreditAmount

number format: double

isUnlimitedCredits

boolean

autoBalanceCronSchedule

string

lastAutoBalanceDate

string format: date-time

shouldAutoBalanceTransferCurrentCredits

boolean

maxAutoBalanceCreditTransferAmount

number format: double

autoBalanceCreditAmount

number format: double

Example

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