TAG LINE
TAG LINE
SMALL TITLE
Defines different tiers of pricing and inclusion for a Bucket.
identity READ-ONLY | "identity": 9 Type: Number This is the unique numeric identifier for the UsageBucketTier |
usageBucketId | "usageBucketId": 26 Type: Number Unique identifier for the associated UsageBucket object. |
usageBucketName | "usageBucketName": "Sample Name" Type: String The name of the object associated with the usageBucketId property. |
threshold | "threshold": 9 Type: Number The numerical representation of the threshold based on the Usage Unit assigned to the tier. |
flatCharge | "flatCharge": 0 Type: Number A dollar value to charge when this tier has been entered. |
usageUnitId | "usageUnitId": 25 Type: Number Unique identifier for the associated UsageUnit object. |
usageUnitName | "usageUnitName": "Sample Name" Type: String The name of the object associated with the usageUnitId property. |
packageFrequencyId | "packageFrequencyId": 13 Type: Number Unique identifier for the associated PackageFrequency object. |
packageFrequencyName | "packageFrequencyName": "Sample Name" Type: String The name of the object associated with the packageFrequencyId property. |
packageServiceId | "packageServiceId": 15 Type: Number Unique identifier for the associated PackageService object. |
packageServiceName | "packageServiceName": "Sample Name" Type: String The name of the object associated with the packageServiceId property. |
currencyId | "currencyId": 21 Type: Number Unique identifier for the associated Currency object. |
currencyName | "currencyName": "Sample Name" Type: String The name of the object associated with the currencyId property. |
money | "money": 17 Type: Number TBC. |
priceBookId | "priceBookId": 18 Type: Number Unique identifier for the associated PriceBook object. |
priceBookName | "priceBookName": "Sample Name" Type: String The name of the object associated with the priceBookId property. |
| DELETE | Usage/Bucket/Tier/{id} |
| Delete an instance of the UsageBucketTier object. Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system. | |
| {id} | Unique identifier for the UsageBucketTier object. |
Delete an instance of the UsageBucketTier object. DELETE Usage/Bucket/Tier/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "delete",
"results": {
"totalCount": 4,
"items": [
{
"identity": 1,
"action": "deleted",
"dtoTypeKey": "usageBucketTier"
},
{
"lhsId": 2,
"rhsId": 2,
"action": "detached",
"dtoTypeKey": "sampleObjectConnector"
},
{
"foreignKeyIdentity": 2,
"action": "deleted",
"dtoTypeKey": "sampleObject"
}
]
}
} | |
| GET | Usage/Bucket/Tier/ |
| Retrieve all of the UsageBucketTier objects. | |
Retrieve all of the UsageBucketTier objects. GET Usage/Bucket/Tier/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"usageBucketId": 15,
"usageBucketName": "Sample Text Data",
"threshold": 11,
"flatCharge": 26,
"usageUnitId": 9,
"usageUnitName": "Sample Text Data",
"packageFrequencyId": 18,
"packageFrequencyName": "Sample Text Data",
"packageServiceId": 16,
"packageServiceName": "Sample Text Data",
"currencyId": 27,
"currencyName": "Sample Text Data",
"money": 14,
"priceBookId": 27,
"priceBookName": "Sample Text Data"
}
]
} | |
| GET | Usage/Bucket/Tier/Paged |
| Retrieve all of the UsageBucketTier objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints. | |
Retrieve all of the UsageBucketTier objects in a paged fashion. GET Usage/Bucket/Tier/Paged HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"usageBucketId": 23,
"usageBucketName": "Sample Text Data",
"threshold": 8,
"flatCharge": 14,
"usageUnitId": 9,
"usageUnitName": "Sample Text Data",
"packageFrequencyId": 5,
"packageFrequencyName": "Sample Text Data",
"packageServiceId": 2,
"packageServiceName": "Sample Text Data",
"currencyId": 15,
"currencyName": "Sample Text Data",
"money": 17,
"priceBookId": 9,
"priceBookName": "Sample Text Data"
}
]
}
} | |
| GET | Usage/Bucket/Tier/{id} |
| Retrieve an instance of the UsageBucketTier object by its ID. | |
| {id} | Unique identifier for the UsageBucketTier object. |
Retrieve an instance of the UsageBucketTier object by its ID. GET Usage/Bucket/Tier/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"usageBucketId": 17,
"usageBucketName": "Sample Text Data",
"threshold": 6,
"flatCharge": 0,
"usageUnitId": 21,
"usageUnitName": "Sample Text Data",
"packageFrequencyId": 16,
"packageFrequencyName": "Sample Text Data",
"packageServiceId": 20,
"packageServiceName": "Sample Text Data",
"currencyId": 16,
"currencyName": "Sample Text Data",
"money": 9,
"priceBookId": 24,
"priceBookName": "Sample Text Data"
}
} | |
| POST | Usage/Bucket/Tier/ |
| Create a new instance of the UsageBucketTier object. | |
Create a new instance of the UsageBucketTier object. POST Usage/Bucket/Tier/
{
"usageBucketId": 3,
"threshold": 11,
"flatCharge": 11,
"usageUnitId": 17,
"packageFrequencyId": 11,
"packageServiceId": 2,
"currencyId": 25,
"money": 13,
"priceBookId": 26
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"usageBucketId": 12,
"usageBucketName": "Sample Text Data",
"threshold": 4,
"flatCharge": 11,
"usageUnitId": 25,
"usageUnitName": "Sample Text Data",
"packageFrequencyId": 8,
"packageFrequencyName": "Sample Text Data",
"packageServiceId": 9,
"packageServiceName": "Sample Text Data",
"currencyId": 22,
"currencyName": "Sample Text Data",
"money": 24,
"priceBookId": 23,
"priceBookName": "Sample Text Data"
}
]
}
} | |
| PUT | Usage/Bucket/Tier/{id} |
| Update an existing instance of the UsageBucketTier object. | |
Update an existing instance of the UsageBucketTier object. PUT Usage/Bucket/Tier/{id}
{
"identity": 1,
"usageBucketId": 14,
"threshold": 6,
"flatCharge": 20,
"usageUnitId": 6,
"packageFrequencyId": 17,
"packageServiceId": 19,
"currencyId": 10,
"money": 6,
"priceBookId": 1
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"usageBucketId": 20,
"usageBucketName": "Sample Text Data",
"threshold": 19,
"flatCharge": 11,
"usageUnitId": 13,
"usageUnitName": "Sample Text Data",
"packageFrequencyId": 11,
"packageFrequencyName": "Sample Text Data",
"packageServiceId": 14,
"packageServiceName": "Sample Text Data",
"currencyId": 12,
"currencyName": "Sample Text Data",
"money": 20,
"priceBookId": 6,
"priceBookName": "Sample Text Data"
}
]
}
} | |