Add rated usage

Path Params
string
required
length between 1 and 100

The ident of the rated usage aggregation. Must not be blank.

Body Params

Rated Usage describes the usage of a service supplied with a price.

string
length ≤ 64

Used as an aggregation criterion. If not provided it will be filled by option.itemGroup. Will be mapped into lineItem.itemGroup during billing. Size must be between 0 and 64.

string
required
length between 1 and 100

Ident of the contract the usage belongs to. Must not be blank. Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

string
length ≤ 255

Additional description providing more details regarding the usage. Not relevant for aggregation. Description of option is used for the aggregation result. Size must be between 0 and 255.

string
required
length between 1 and 100

Unique identifier. Must not be blank. Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_-]*'.

period
object
required

Period defined by date time of start and end each. In case the period is not exactly known start and end can be the same value.

price
object
required

Price for the usage metered.

string
required
length between 1 and 100

External key that identifies a product. Must match the product reference key of a usage option of the contract. Must not be blank. Size must be between 1 and 100.

properties
array of objects
length ≤ 50

Properties allow adding client specific additional data to a resource in form of a key-value-mapping with unique keys and values mapped being of type string. Size must be between 0 and 50.

properties
quantity
object
required

Quantity described by an amount and unit, e.g. 10.5 kWh.

serviceLocation
object
required

Location where a service was used.

string
required

Type of the line item. Determines if this item was provided as a service to your customer (sales) or by your customer (self-billing). Must not be null. Must be one of:

SELF_BILLINGService provided by a customer. Results in a line item on a self-billing invoice.
SALESServices provided to a customer. Results in a line item on an invoice.
Responses

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Choose an example:
application/json