Get an Applied Customer Billing Rate by ID
get
/appliedCustomerBillingRate/{id}
Gets the specified applied customer billing rate.
Request
Path Parameters
-
id(required): string
The item number or the ID of the item to get.Examples
Query Parameters
-
@type: string
The type of object to return.Examples
-
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 applied customer billing rate was retrieved successfully.
Root Schema : Applied Customer Billing Rate
Type:
objectTitle:
Applied Customer Billing RateAn applied customer billing rate.
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema LocationThe URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
appliedTax: array
appliedTax
The taxes applied to the applied customer billing rate.
-
bill: object
Bill Ref
Title:
Bill RefA reference to a bill. -
billingAccount: object
Billing Account Ref
Title:
Billing Account RefA billing account is a detailed description of a bill structure. -
characteristic: array
characteristic
The characteristics that define the applied customer billing rate.
-
date: string
(date-time)
Title:
Applied Customer Billing Rate Created DateThe date the applied customer billing rate was created. -
description: string
Title:
DescriptionThe applied customer billing rate's description. -
href(required): string
Title:
Applied Customer Billing Rate HrefThe applied customer billing rate's href. -
id(required): string
Title:
Applied Customer Billing Rate IDThe applied customer billing rate's ID. -
isBilled: boolean
Title:
BilledWhether the applied customer billing rate has been billed (true) or not (false). If true, also provide a value for the bill property. If false, also provide a value for the billingAccount property. -
name: string
Title:
Applied Customer Billing Rate NameThe applied customer billing rate's name. -
periodCoverage: object
TimePeriod
The period of time, either as a deadline (endDateTime only) a startDateTime only, or both.
-
product: object
Product Ref
Title:
Product RefA reference to a product. -
taxExcludedAmount: object
Money
The base / value business entity used to represent money.
-
taxIncludedAmount: object
Money
The base / value business entity used to represent money.
-
type: string
Title:
Applied Billing Rate TypeThe applied customer billing rate's type. For example: appliedBillingCharge (for recurring, one time, and usage charges), appliedBillingCredit (for rebates or product alteration credits), or appliedPenaltyCharge (for penalty charges like late fees or payment rejection fees.)
Nested Schema : appliedTax
Type:
arrayThe taxes applied to the applied customer billing rate.
Show Source
-
Array of:
object Applied Billing Tax Rate
Title:
Applied Billing Tax RateThe tax rate applied to a billing rate.
Nested Schema : Bill Ref
Type:
objectTitle:
Bill RefA reference to a bill.
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@referredType: string
Title:
Referred TypeThe actual type of the target instance when needed for 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:
Bill HrefThe bill's href. -
id: string
Title:
Bill IDThe bill's ID.
Nested Schema : Billing Account Ref
Type:
objectTitle:
Billing Account RefA billing account is a detailed description of a bill structure.
Show Source
-
@baseType: string
The super-class when sub-classing.
-
@referredType: string
The actual type of the target instance when needed for disambiguation.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
The sub-class entity name when sub-classing.
-
accountNumber: string
The account number.
-
href: string
A reference for the billing account.
-
id: string
The billing account ID or billing account number.
-
name: string
The name of the billing account.
Nested Schema : characteristic
Type:
arrayThe characteristics that define the applied customer billing rate.
Show Source
-
Array of:
object Applied Billing Rate Characteristic
Title:
Applied Billing Rate CharacteristicA characteristic of an applied billing rate, based on the service type, line of business, or other parameters.
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 : 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 : Money
Type:
objectThe base / value business entity used to represent money.
Show Source
-
unit: string
The currency (ISO4217 norm uses 3 letters to define the currency).
-
value: number
(float)
The signed floating point number, the meaning of the sign is according to the context of the API that uses this Data type
Nested Schema : Applied Billing Tax Rate
Type:
objectTitle:
Applied Billing Tax RateThe tax rate applied to a billing rate.
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema LocationThe URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
taxAmount: object
Money
The base / value business entity used to represent money.
-
taxCategory: string
Title:
Tax CategoryThe applied billing tax's category. -
taxRate: number
(float)
Title:
Tax RateThe applied billing tax rate.
Nested Schema : Applied Billing Rate Characteristic
Type:
objectTitle:
Applied Billing Rate CharacteristicA characteristic of an applied billing rate, based on the service type, line of business, or other parameters.
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@schemaLocation: string
(uri)
Title:
Scheme LocationThe URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
name(required): string
Title:
Characteristic NameThe characteristic's name. -
value(required): object
Any
-
valueType: string
Title:
Characteristic TypeThe data type of the characteristic's value.
Nested Schema : Any
Type:
object400 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 an Applied Customer Billing Rate by Item POID
The following example shows how to get the applied customer billing rate associated with the specified item POID 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/customerBillManagement/version/appliedCustomerBillingRate/0.0.0.1+-item-cycle_forward+108525'
Example of the Response Body
The following example shows the contents of the response body in JSON format.
{
"id": "0.0.0.1+-item-cycle_forward+108525",
"href": "http://host:port/brm/customerBillManagement/version/appliedCustomerBillingRate/0.0.0.1+-item-cycle_forward+108525",
"date": "2025-05-02T01:14:14-07:00",
"description": null,
"isBilled": false,
"name": "Cycle forward",
"type": "/item/cycle_forward",
"appliedTax": null,
"bill": {
"id": "0.0.0.1+-bill+106861",
"href": "http://host:port/brm/customerBillManagement/version/customerBill/0.0.0.1+-bill+106861",
"@baseType": null,
"@schemaLocation": null,
"@type": "BillRef",
"@referredType": "CustomerBill"
},
"billingAccount": {
"id": "0.0.0.1+-account+107117",
"href": null,
"name": "Jane Smith",
"@baseType": null,
"@schemaLocation": null,
"@type": "BillingAccountRef",
"@referredType": "billingAccount"
},
"characteristic": null,
"periodCoverage": null,
"product": null,
"taxExcludedAmount": {
"unit": "EUR",
"value": 45.0
},
"taxIncludedAmount": {
"unit": "EUR",
"value": 45.0
},
"@baseType": "AppliedCustomerBillingRate",
"@schemaLocation": null,
"@type": "AppliedCustomerBillingRate"
}Example 2: Get an Applied Customer Billing Rate by Item Number
The following example shows how to get the applied customer billing rate associated with the specified item number 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/customerBillManagement/version/appliedCustomerBillingRate/Item-111'
Example of the Response Body
The following example shows the contents of the response body in JSON format.
{
"id": "Item-111",
"href": "http://host:port/brm/customerBillManagement/version/appliedCustomerBillingRate/Item-111",
"date": "2025-05-02T01:14:14-07:00",
"description": null,
"isBilled": false,
"name": "Cycle forward",
"type": "/item/cycle_forward",
"appliedTax": null,
"bill": {
"id": "0.0.0.1+-bill+106861",
"href": "http://host:port/brm/customerBillManagement/version/customerBill/0.0.0.1+-bill+106861",
"@baseType": null,
"@schemaLocation": null,
"@type": "BillRef",
"@referredType": "CustomerBill"
},
"billingAccount": {
"id": "0.0.0.1+-account+107117",
"href": null,
"name": "Mark Davis",
"@baseType": null,
"@schemaLocation": null,
"@type": "BillingAccountRef",
"@referredType": "billingAccount"
},
"characteristic": null,
"periodCoverage": null,
"product": null,
"taxExcludedAmount": {
"unit": "USD",
"value": 12.0
},
"taxIncludedAmount": {
"unit": "USD",
"value": 5.0
},
"@baseType": "AppliedCustomerBillingRate",
"@schemaLocation": null,
"@type": "AppliedCustomerBillingRate"
}