| Name | Type | Description | Notes |
|---|---|---|---|
| created | datetime | { "description" : "The UTC DateTime when the object was created.", "verbs":[] } | [optional] |
| changed_by | str | { "description" : "ID of the user who last updated the entity.", "verbs":[] } | [optional] |
| updated | datetime | { "description" : "The UTC DateTime when the object was last updated.", "verbs":[] } | [optional] |
| id | str | {"description":"Unique ID by which the AggregatingComponent can be looked up.","verbs":["GET"]} | [optional] |
| organization_id | str | {"default":"(Auto-populated using your authentication credentials)","description":"ID of the BillForward Organization within which the requested pricing component should be created. If omitted: this will be auto-populated using your authentication credentials.","verbs":["POST","GET"]} | [optional] |
| product_rate_plan_id | str | {"description":"ID of the rate plan upon which this AggregatingComponent is defined.","verbs":["POST","GET"]} | [optional] |
| product_rate_plan_name | str | {"description":"Name of the rate plan upon which this AggregatingComponent is defined.","verbs":["POST","GET"]} | [optional] |
| pricing_component_id | str | {"description":"ID of the pricing component to which this AggregatingComponent's aggregation applies. The subscriber to the aggregating rate plan (which contains this AggregatingComponent), will consult its children at the end of each billing period, and collect from those children all charges whose pricing component matches this ID. Those charges' quantities will be counted, and used when calculating the price of consuming this AggregatingComponent. The aggregating subscription then raises a discount charge — to account for the more favourable price tiering that emerges when aggregating.","verbs":["POST"]} | |
| pricing_component_name | str | {"description":"Name of the pricing component to which this AggregatingComponent's aggregation applies. The subscriber to the aggregating rate plan (which contains this AggregatingComponent), will consult its children at the end of each billing period, and collect from those children all charges whose pricing component matches this ID. Those charges' quantities will be counted, and used when calculating the price of consuming this AggregatingComponent. The aggregating subscription then raises a discount charge — to account for the more favourable price tiering that emerges when aggregating.","verbs":["POST"]} | |
| deleted | bool | {"default":false,"description":"Whether the AggregatingComponent has been retired.","verbs":["GET"]} | [optional] [default to False] |
This repository was archived by the owner on Oct 17, 2023. It is now read-only.