Updates the descriptive fields of a metered asset balance; balance amounts are not touched.

PATCH

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

const url = 'https://example.com/api/v1/provision/admin/asset-balances/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: '{"id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","name":"example","description":"example","unit":"example","numberFormat":"example"}'
};

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

curl --request PATCH \
  --url https://example.com/api/v1/provision/admin/asset-balances/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --data '{ "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "example", "description": "example", "unit": "example", "numberFormat": "example" }'

Parameters

Path Parameters

balanceId

required

string format: uuid

Balance id.

Request Body^required

Patch payload with the descriptive fields.

object

string format: uuid

name

string

description

string

unit

string

numberFormat

string

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "name": "example",
  "description": "example",
  "unit": "example",
  "numberFormat": "example"
}

object

string format: uuid

name

string

description

string

unit

string

numberFormat

string

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "name": "example",
  "description": "example",
  "unit": "example",
  "numberFormat": "example"
}

object

string format: uuid

name

string

description

string

unit

string

numberFormat

string

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "name": "example",
  "description": "example",
  "unit": "example",
  "numberFormat": "example"
}

Responses

200

object

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+)?$/

unit

string

numberFormat

string

lastDeposit

string format: date-time

usageQuota

Array<object>

object

endUsage

number | string format: double

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

name

string

quotaUsageLevel

integer

suspendedUntilAt

null | string format: date-time

overageSeverityStatus

integer

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+)?$/

object

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+)?$/

unit

string

numberFormat

string

lastDeposit

string format: date-time

usageQuota

Array<object>

object

endUsage

number | string format: double

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

name

string

quotaUsageLevel

integer

suspendedUntilAt

null | string format: date-time

overageSeverityStatus

integer

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 ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "name": "example",
  "description": "example",
  "creditsUsed": 1,
  "totalCredits": 1,
  "cumulativeCreditsUsed": 1,
  "unit": "example",
  "numberFormat": "example",
  "lastDeposit": "2026-04-15T12:00:00Z",
  "usageQuota": [
    {
      "endUsage": 1,
      "name": "example",
      "quotaUsageLevel": 1
    }
  ],
  "suspendedUntilAt": "2026-04-15T12:00:00Z",
  "overageSeverityStatus": 1,
  "initialCreditAmount": 1,
  "isUnlimitedCredits": true,
  "autoBalanceCronSchedule": "example",
  "lastAutoBalanceDate": "2026-04-15T12:00:00Z",
  "shouldAutoBalanceTransferCurrentCredits": true,
  "maxAutoBalanceCreditTransferAmount": 1,
  "autoBalanceCreditAmount": 1
}

object

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+)?$/

unit

string

numberFormat

string

lastDeposit

string format: date-time

usageQuota

Array<object>

object

endUsage

number | string format: double

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

name

string

quotaUsageLevel

integer

suspendedUntilAt

null | string format: date-time

overageSeverityStatus

integer

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 ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "name": "example",
  "description": "example",
  "creditsUsed": 1,
  "totalCredits": 1,
  "cumulativeCreditsUsed": 1,
  "unit": "example",
  "numberFormat": "example",
  "lastDeposit": "2026-04-15T12:00:00Z",
  "usageQuota": [
    {
      "endUsage": 1,
      "name": "example",
      "quotaUsageLevel": 1
    }
  ],
  "suspendedUntilAt": "2026-04-15T12:00:00Z",
  "overageSeverityStatus": 1,
  "initialCreditAmount": 1,
  "isUnlimitedCredits": true,
  "autoBalanceCronSchedule": "example",
  "lastAutoBalanceDate": "2026-04-15T12:00:00Z",
  "shouldAutoBalanceTransferCurrentCredits": true,
  "maxAutoBalanceCreditTransferAmount": 1,
  "autoBalanceCreditAmount": 1
}

400

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

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

Updates the descriptive fields of a metered asset balance; balance amounts are not touched.

Parameters

Path Parameters

Request Body required

Example generated

Example generated

Example generated

Responses

200

Example generated

Example generated

400

Example generated

Example generated

404

Example generated

Example generated

Request Body^required

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated