Get Bucket Balances by ID
get
/bucket/{id}
Gets the specified bucket balance.
Request
Path Parameters
-
id(required): string
The internal ID or external ID of the bucket object.Examples
Query Parameters
-
@type: string
The type of object to return. Use @type=Bucket for a base object or @type=BucketOracle for an extended object.
-
fields: string
The list of comma-separated fields to return in the response.Examples
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json;charset=utf-8
200 Response
The specified bucket was retrieved successfully.
Root Schema : Bucket
Type:
objectTitle:
BucketA bucket that tracks a quantity of usage (remaining or consumed) for currency or noncurrency resources (such as messages, minutes, data).
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON schema file that defines additional attributes and relationships. (BRM does not use this property.) -
@type: string
Title:
TypeThe object's subclass. -
description: string
The bucket's description. (BRM does not use this property.)
-
href(required): string
Title:
Bucket HrefThe bucket's href. (BRM does not use this property.) -
id(required): string
Title:
Bucket IDThe bucket's ID. - isShared: boolean
-
logicalResource: array
logicalResource
Logical resources associated with the bucket.
-
name: string
Title:
Bucket NameThe bucket's name. -
partyAccount: object
Party Account Ref
Title:
Party Account RefA reference to a party account. -
product: array
product
Products associated with the bucket.
- relatedParty: array relatedParty
-
remainingValue: object
Quantity
The amount in a given unit.
-
remainingValueName: string
Title:
Remaining ValueA string, including value and unit, representing the remaining amount in the bucket, used for display purposes. For example, 1.9 GB. -
reservedValue: object
Quantity
The amount in a given unit.
-
status(required): string
The bucket's status. For example: active, expired, or suspended.
-
usageType: string
The bucket's usage type.
-
validFor(required): object
TimePeriod
The period of time, either as a deadline (endDateTime only) a startDateTime only, or both.
Nested Schema : logicalResource
Type:
arrayLogical resources associated with the bucket.
Show Source
-
Array of:
object Logical Resource Ref
Title:
Logical Resource RefA reference to a logical resource.
Nested Schema : Party Account Ref
Type:
objectTitle:
Party Account RefA reference to a party account.
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@referredType: string
Title:
Referred TypeThe object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
description: string
Title:
DescriptionThe party account's description. -
href: string
Title:
HrefThe party account's href. -
id(required): string
Title:
Account IDThe party account's ID. -
name: string
Title:
NameThe party account's name. -
status: string
Title:
StatusThe overall status of the account. For example: due, paid, or in arrears.
Nested Schema : product
Type:
arrayProducts associated with the bucket.
Show Source
-
Array of:
object Product Ref
Title:
Product RefA reference to a product.
Nested Schema : Quantity
Type:
objectThe amount in a given unit.
Show Source
-
amount: number
(float)
Default Value:
1The numeric value in a given unit. -
units: string
The unit.
Nested Schema : TimePeriod
Type:
objectThe period of time, either as a deadline (endDateTime only) a startDateTime only, or both.
Show Source
-
endDateTime: string
(date-time)
The end of the time period, using IETC-RFC-3339 format.Example:
1985-04-12T23:20:50.52Z -
startDateTime: string
(date-time)
The start of the time period, using IETC-RFC-3339 format.Example:
1985-04-12T23:20:50.52Z
Nested Schema : Logical Resource Ref
Type:
objectTitle:
Logical Resource RefA reference to a logical resource.
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@referredType: string
Title:
Referred TypeThe object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
href: string
Title:
HrefThe resource's href. -
id(required): string
Title:
IDThe resource's ID. -
name: string
Title:
NameThe resource's name. -
value: string
The device number(PIN_FLD_ALIAS_LIST) or the login (PIN_FLD_LOGIN).
Nested Schema : Product Ref
Type:
objectTitle:
Product RefA reference to a product.
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@referredType: string
Title:
Referred TypeThe object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
href: string
Title:
Product HrefThe product's href. -
id(required): string
Title:
Product IDThe product's ID. -
name: string
Title:
Product NameThe product's name.
Nested Schema : Related Party
Type:
objectTitle:
Related PartyA party related to another object.
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@referredType(required): string
Title:
Referred TypeThe object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
href: string
(uri)
Title:
HrefThe party's href. -
id(required): string
Title:
Party IDThe party's ID. -
name: string
Title:
Party NameThe party's name. -
role: string
Title:
Party RoleThe party's role.
400 Response
The request isn't valid.
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
object
Extensible
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
-
object
Error-allOf[1]
Nested Schema : Extensible
Type:
objectThe Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
-
@baseType: string
The defines the super-class when sub-classing.
-
@schemaLocation: string
The URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
The definition of the sub-class extensible name, when sub-classing.
Nested Schema : Error-allOf[1]
Type:
Show Source
object-
code(required): string
The application relevant detail, defined in the API or a common list.
-
message: string
The details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
The URI of documentation describing the error.
-
status: string
The HTTP Error code extension
401 Response
The client doesn't have the correct privileges.
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
object
Extensible
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
-
object
Error-allOf[1]
Nested Schema : Extensible
Type:
objectThe Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
-
@baseType: string
The defines the super-class when sub-classing.
-
@schemaLocation: string
The URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
The definition of the sub-class extensible name, when sub-classing.
Nested Schema : Error-allOf[1]
Type:
Show Source
object-
code(required): string
The application relevant detail, defined in the API or a common list.
-
message: string
The details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
The URI of documentation describing the error.
-
status: string
The HTTP Error code extension
403 Response
The request wasn't authorized.
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
object
Extensible
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
-
object
Error-allOf[1]
Nested Schema : Extensible
Type:
objectThe Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
-
@baseType: string
The defines the super-class when sub-classing.
-
@schemaLocation: string
The URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
The definition of the sub-class extensible name, when sub-classing.
Nested Schema : Error-allOf[1]
Type:
Show Source
object-
code(required): string
The application relevant detail, defined in the API or a common list.
-
message: string
The details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
The URI of documentation describing the error.
-
status: string
The HTTP Error code extension
404 Response
The requested resource couldn't be found.
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
object
Extensible
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
-
object
Error-allOf[1]
Nested Schema : Extensible
Type:
objectThe Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
-
@baseType: string
The defines the super-class when sub-classing.
-
@schemaLocation: string
The URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
The definition of the sub-class extensible name, when sub-classing.
Nested Schema : Error-allOf[1]
Type:
Show Source
object-
code(required): string
The application relevant detail, defined in the API or a common list.
-
message: string
The details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
The URI of documentation describing the error.
-
status: string
The HTTP Error code extension
405 Response
This method is not allowed.
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
object
Extensible
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
-
object
Error-allOf[1]
Nested Schema : Extensible
Type:
objectThe Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
-
@baseType: string
The defines the super-class when sub-classing.
-
@schemaLocation: string
The URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
The definition of the sub-class extensible name, when sub-classing.
Nested Schema : Error-allOf[1]
Type:
Show Source
object-
code(required): string
The application relevant detail, defined in the API or a common list.
-
message: string
The details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
The URI of documentation describing the error.
-
status: string
The HTTP Error code extension
409 Response
The request could not be processed due to the conflict with the existing state of the resource.
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
object
Extensible
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
-
object
Error-allOf[1]
Nested Schema : Extensible
Type:
objectThe Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
-
@baseType: string
The defines the super-class when sub-classing.
-
@schemaLocation: string
The URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
The definition of the sub-class extensible name, when sub-classing.
Nested Schema : Error-allOf[1]
Type:
Show Source
object-
code(required): string
The application relevant detail, defined in the API or a common list.
-
message: string
The details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
The URI of documentation describing the error.
-
status: string
The HTTP Error code extension
500 Response
The system encountered an internal error.
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
object
Extensible
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
-
object
Error-allOf[1]
Nested Schema : Extensible
Type:
objectThe Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
-
@baseType: string
The defines the super-class when sub-classing.
-
@schemaLocation: string
The URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
The definition of the sub-class extensible name, when sub-classing.
Nested Schema : Error-allOf[1]
Type:
Show Source
object-
code(required): string
The application relevant detail, defined in the API or a common list.
-
message: string
The details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
The URI of documentation describing the error.
-
status: string
The HTTP Error code extension
Examples
Example 1: Get Bucket Balances by POID
The following example shows how to get a bucket balance with a specified ID by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.
curl -X GET 'http://host:port/brm/prepayBalanceManagement/version/bucket/0.0.0.1+-balance_group+109933'
Example of the Response Body
The following example shows the contents of the response body in JSON format.
{
"id": "0.0.0.1+-balance_group+109933",
"href": "http://host:port/brm/prepayBalanceManagement/version/bucket/0.0.0.1+-balance_group+109933",
"confirmationDate": null,
"description": null,
"isShared": null,
"name": "Account Balance Group",
"remainingValueName": null,
"requestedDate": null,
"logicalResource": null,
"partyAccount": {
"id": "0.0.0.1+-account+107117",
"href": null,
"description": null,
"name": "Adam Baker",
"status": "active",
"@baseType": null,
"@schemaLocation": null,
"@type": "PartyAccountRef",
"@referredType": null
},
"product": [
{
"id": "0.0.0.1+-service-telco-gsm-sms+106733",
"href": null,
"name": "ServiceTelcoGsmSms",
"@baseType": null,
"@schemaLocation": null,
"@type": "ProductRef",
"@referredType": null
},
{
"id": "0.0.0.1+-service-telco-gsm-telephony+108013",
"href": null,
"name": "ServiceTelcoGsmTelephony",
"@baseType": null,
"@schemaLocation": null,
"@type": "ProductRef",
"@referredType": null
}
],
"relatedParty": null,
"remainingValue": {
"amount": 45.0,
"units": "EUR",
"@baseType": null,
"@schemaLocation": null,
"@type": "Quantity"
},
"reservedValue": {
"amount": 0.0,
"units": "EUR",
"@baseType": null,
"@schemaLocation": null,
"@type": "Quantity"
},
"status": "ACTIVE",
"usageType": null,
"validFor": {
"endDateTime": null,
"startDateTime": "2025-05-02T00:00:00-07:00"
},
"@baseType": "Bucket",
"@schemaLocation": null,
"@type": "Bucket"
}Example 1: Get Bucket Balances by External ID
The following example shows how to get a bucket balance with a specified external ID by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.
curl -X GET 'http://host:port/brm/prepayBalanceManagement/version/bucket/7c3981c5-5f8c-4800-a1b3-19cfcd3a44da'
Example of the Response Body
The following example shows the contents of the response body in JSON format.
{
"id": "7c3981c5-5f8c-4800-a1b3-19cfcd3a44da",
"href": "http://host:port/brm/prepayBalanceManagement/version/bucket/7c3981c5-5f8c-4800-a1b3-19cfcd3a44da",
"confirmationDate": null,
"description": null,
"isShared": null,
"name": "Account Balance Group",
"remainingValueName": null,
"requestedDate": null,
"logicalResource": null,
"partyAccount": {
"id": "0.0.0.1+-account+107117",
"href": null,
"description": null,
"name": "Adam Baker",
"status": "active",
"@baseType": null,
"@schemaLocation": null,
"@type": "PartyAccountRef",
"@referredType": null
},
"product": [
{
"id": "0.0.0.1+-service-telco-gsm-sms+106733",
"href": null,
"name": "ServiceTelcoGsmSms",
"@baseType": null,
"@schemaLocation": null,
"@type": "ProductRef",
"@referredType": null
},
{
"id": "0.0.0.1+-service-telco-gsm-telephony+108013",
"href": null,
"name": "ServiceTelcoGsmTelephony",
"@baseType": null,
"@schemaLocation": null,
"@type": "ProductRef",
"@referredType": null
}
],
"relatedParty": null,
"remainingValue": {
"amount": 45.0,
"units": "EUR",
"@baseType": null,
"@schemaLocation": null,
"@type": "Quantity"
},
"reservedValue": {
"amount": 0.0,
"units": "EUR",
"@baseType": null,
"@schemaLocation": null,
"@type": "Quantity"
},
"status": "ACTIVE",
"usageType": null,
"validFor": {
"endDateTime": null,
"startDateTime": "2025-05-02T00:00:00-07:00"
},
"@baseType": "Bucket",
"@schemaLocation": null,
"@type": "Bucket"
}