Jump to

• Request
• Response
• Examples

Update a Bucket Threshold for an Account

put

/adjustThreshold/{accountId}

Updates a bucket threshold for the specified account.

Request

Path Parameters

• accountId(required): string
  The ID or account number of the billing account to adjust the threshold for.

  Example:

  0.0.0.1+-account+102879

Supported Media Types

• application/json;charset=utf-8

Request Body - application/json;charset=utf-8 ()

Root Schema : Adjust Threshold

Type: object

Title: Adjust Threshold

A threshold adjustment.

Show Source

• @type: string
  Title: Type

  The object's subclass.
• accountId(required): string
  Title: Account Id

  The ID or account number of the billing account to adjust the threshold for.
• bucket: object Bucket Ref
  Title: Bucket Ref

  A reference to a bucket.
• product: object Product Ref
  Title: Product Ref

  A reference to a product.
• resourceType: string
  Title: Resource Type

  The resource type of the balance element with the adjusted threshold.
• thresholds: array thresholds
  The new threshold amount.

{
    "required":[
        "accountId"
    ],
    "title":"Adjust Threshold",
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "title":"Account Id",
            "description":"The ID or account number of the billing account to adjust the threshold for."
        },
        "bucket":{
            "description":"The bucket to adjust the threshold for.",
            "$ref":"#/components/schemas/BucketRef"
        },
        "product":{
            "description":"A product associated with the bucket being adjusted.",
            "$ref":"#/components/schemas/ProductRef"
        },
        "resourceType":{
            "type":"string",
            "title":"Resource Type",
            "description":"The resource type of the balance element with the adjusted threshold."
        },
        "thresholds":{
            "type":"array",
            "description":"The new threshold amount.",
            "items":{
                "$ref":"#/components/schemas/Quantity"
            }
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        }
    },
    "description":"A threshold adjustment."
}

Nested Schema : Bucket Ref

Type: object

Title: Bucket Ref

A reference to a bucket.

Show Source

• @baseType: string
  Title: Base Type

  The object's superclass.
• @referredType: string
  Title: Referred Type

  The object's type in the target system, if baseType and type need further disambiguation.
• @schemaLocation: string (uri)
  Title: Schema Location

  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  Title: Type

  The object's subclass.
• href: string
  Title: Bucket Href

  The bucket's href.
• id(required): string
  Title: Bucket ID

  The bucket's ID.
• name: string
  Title: Bucket Name

  The bucket's name.

{
    "required":[
        "id"
    ],
    "type":"object",
    "title":"Bucket Ref",
    "properties":{
        "id":{
            "type":"string",
            "title":"Bucket ID",
            "description":"The bucket's ID."
        },
        "href":{
            "type":"string",
            "title":"Bucket Href",
            "description":"The bucket's href."
        },
        "name":{
            "type":"string",
            "title":"Bucket Name",
            "description":"The bucket's name."
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        }
    },
    "description":"A reference to a bucket."
}

Nested Schema : Product Ref

Type: object

Title: Product Ref

A reference to a product.

Show Source

• @baseType: string
  Title: Base Type

  The object's superclass.
• @referredType: string
  Title: Referred Type

  The object's type in the target system, if baseType and type need further disambiguation.
• @schemaLocation: string (uri)
  Title: Schema Location

  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  Title: Type

  The object's subclass.
• href: string
  Title: Product Href

  The product's href.
• id(required): string
  Title: Product ID

  The product's ID.
• name: string
  Title: Product Name

  The product's name.

{
    "required":[
        "id"
    ],
    "type":"object",
    "title":"Product Ref",
    "description":"A reference to a product.",
    "properties":{
        "id":{
            "type":"string",
            "title":"Product ID",
            "description":"The product's ID."
        },
        "href":{
            "type":"string",
            "title":"Product Href",
            "description":"The product's href."
        },
        "name":{
            "type":"string",
            "title":"Product Name",
            "description":"The product's name."
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        }
    }
}

Nested Schema : thresholds

Type: array

The new threshold amount.

Show Source

• Array of: object Quantity
  An amount in a given unit.

{
    "type":"array",
    "description":"The new threshold amount.",
    "items":{
        "$ref":"#/components/schemas/Quantity"
    }
}

Nested Schema : Quantity

Type: object

An amount in a given unit.

Show Source

• amount: number (float)
  Default Value: 1

  Numeric value in a given unit.
• units: string
  Unit

{
    "type":"object",
    "description":"An amount in a given unit.",
    "properties":{
        "amount":{
            "default":1,
            "type":"number",
            "format":"float",
            "description":"Numeric value in a given unit."
        },
        "units":{
            "type":"string",
            "description":"Unit"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json;charset=utf-8

200 Response

Success

400 Response

Bad Request

Body ()

Root Schema : Error

Type: object

This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

• @baseType: string
  This defines the super-class when sub-classing.
• @schemaLocation: string (uri)
  A URI to a JSON-schema file that defines additional attributes and relationships.
• @type: string
  This defines the sub-class entity name when sub-classing.
• code(required): string
  Refers to application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  Displays the HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Refers to application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"Displays the HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"This defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"This defines the sub-class entity name when sub-classing."
        }
    },
    "description":"This is used when an API throws an error, typically with a HTTP error response-code (<b>3xx, 4xx, 5xx</b>)."
}

401 Response

Unauthorized

Body ()

Root Schema : Error

Type: object

This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

• @baseType: string
  This defines the super-class when sub-classing.
• @schemaLocation: string (uri)
  A URI to a JSON-schema file that defines additional attributes and relationships.
• @type: string
  This defines the sub-class entity name when sub-classing.
• code(required): string
  Refers to application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  Displays the HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Refers to application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"Displays the HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"This defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"This defines the sub-class entity name when sub-classing."
        }
    },
    "description":"This is used when an API throws an error, typically with a HTTP error response-code (<b>3xx, 4xx, 5xx</b>)."
}

403 Response

Forbidden

Body ()

Root Schema : Error

Type: object

This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

• @baseType: string
  This defines the super-class when sub-classing.
• @schemaLocation: string (uri)
  A URI to a JSON-schema file that defines additional attributes and relationships.
• @type: string
  This defines the sub-class entity name when sub-classing.
• code(required): string
  Refers to application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  Displays the HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Refers to application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"Displays the HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"This defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"This defines the sub-class entity name when sub-classing."
        }
    },
    "description":"This is used when an API throws an error, typically with a HTTP error response-code (<b>3xx, 4xx, 5xx</b>)."
}

404 Response

Not Found

Body ()

Root Schema : Error

Type: object

This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

• @baseType: string
  This defines the super-class when sub-classing.
• @schemaLocation: string (uri)
  A URI to a JSON-schema file that defines additional attributes and relationships.
• @type: string
  This defines the sub-class entity name when sub-classing.
• code(required): string
  Refers to application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  Displays the HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Refers to application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"Displays the HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"This defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"This defines the sub-class entity name when sub-classing."
        }
    },
    "description":"This is used when an API throws an error, typically with a HTTP error response-code (<b>3xx, 4xx, 5xx</b>)."
}

405 Response

Method Not Allowed

Body ()

Root Schema : Error

Type: object

This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

• @baseType: string
  This defines the super-class when sub-classing.
• @schemaLocation: string (uri)
  A URI to a JSON-schema file that defines additional attributes and relationships.
• @type: string
  This defines the sub-class entity name when sub-classing.
• code(required): string
  Refers to application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  Displays the HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Refers to application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"Displays the HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"This defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"This defines the sub-class entity name when sub-classing."
        }
    },
    "description":"This is used when an API throws an error, typically with a HTTP error response-code (<b>3xx, 4xx, 5xx</b>)."
}

409 Response

Conflict

Body ()

Root Schema : Error

Type: object

This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

• @baseType: string
  This defines the super-class when sub-classing.
• @schemaLocation: string (uri)
  A URI to a JSON-schema file that defines additional attributes and relationships.
• @type: string
  This defines the sub-class entity name when sub-classing.
• code(required): string
  Refers to application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  Displays the HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Refers to application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"Displays the HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"This defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"This defines the sub-class entity name when sub-classing."
        }
    },
    "description":"This is used when an API throws an error, typically with a HTTP error response-code (<b>3xx, 4xx, 5xx</b>)."
}

500 Response

Internal Server Error

Body ()

Root Schema : Error

Type: object

This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

• @baseType: string
  This defines the super-class when sub-classing.
• @schemaLocation: string (uri)
  A URI to a JSON-schema file that defines additional attributes and relationships.
• @type: string
  This defines the sub-class entity name when sub-classing.
• code(required): string
  Refers to application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  Displays the HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Refers to application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"Displays the HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"This defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"This defines the sub-class entity name when sub-classing."
        }
    },
    "description":"This is used when an API throws an error, typically with a HTTP error response-code (<b>3xx, 4xx, 5xx</b>)."
}

Back to Top

Examples

The following example shows how to update an account's balance threshold by submitting a PUT request on the REST resource using cURL. For more information about cURL, see Use cURL.

The -d option specifies the file to attach as the request body.

curl -X PUT 'http://host:port/brm/prepayBalanceManagement/version/bucket/adjustThreshold/0.0.0.1+-account+111864' -d @thresholdUpdate.json

Example of Request Body

The following is an example of the contents of the thresholdUpdate.json file sent as the request body. You can specify the bucket ID instead of the product ID. You must specify details for all existing thresholds; if there are three thresholds defined, but you only specify two in the request, the third will be removed.

{
   "@type" : "AdjustThreshold",
   "product" : {
      "id" : "313123231"
   },
   "thresholds": [
      {
         "amount": 3,
         "units" : "fixed"
      },
      {
         "amount": 5,
         "units" : "fixed"
      }
   ],
   "resourceType": "USD"
}

Example of Request Body for Removing Thresholds

The following is an example of the contents of the thresholdUpdate.json file sent as the request body to remove thresholds.

{
   "@type" : "AdjustThreshold",
   "thresholds": [],
   "resourceType": "USD"
}

Example of Response Body

When the thresholds are updated successfully, the only response is a 200 status code.

Back to Top