TAG LINE
SMALL TITLE
Defines different tiers of pricing and inclusion for a Bucket.
identity READ-ONLY | "identity": 12 Type: Number This is the unique numeric identifier for the UsageBucketTier |
usageBucketId | "usageBucketId": 15 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. |
usageRatePlanId | "usageRatePlanId": 15 Type: Number Unique identifier for the associated UsageRatePlan object. |
usageRatePlanName | "usageRatePlanName": "Sample Name" Type: String The name of the object associated with the usageRatePlanId property. |
threshold | "threshold": 2 Type: Number The numerical representation of the threshold based on the Usage Unit assigned to the tier. |
flatCharge | "flatCharge": 10 Type: Number A dollar value to charge when this tier has been entered. |
usageUnitId | "usageUnitId": 17 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. |
When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.
Field List:
| DELETE | api/v2/Usage/Bucket/Tier/{id} |
| Delete an instance of the UsageBucketTier object. Upon successful delete, this API will return a record of all of the reelated 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 api/v2/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 | api/v2/Usage/Bucket/Tier/ |
| Retrieve all of the UsageBucketTier objects. | |
Retrieve all of the UsageBucketTier objects. GET api/v2/Usage/Bucket/Tier/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"usageBucketId": 24,
"usageBucketName": "Sample Text Data",
"usageRatePlanId": 24,
"usageRatePlanName": "Sample Text Data",
"threshold": 21,
"flatCharge": 27,
"usageUnitId": 8,
"usageUnitName": "Sample Text Data"
}
]
} | |
| GET | api/v2/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 api/v2/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": 2,
"usageBucketName": "Sample Text Data",
"usageRatePlanId": 11,
"usageRatePlanName": "Sample Text Data",
"threshold": 18,
"flatCharge": 14,
"usageUnitId": 6,
"usageUnitName": "Sample Text Data"
}
]
}
} | |
| GET | api/v2/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 api/v2/Usage/Bucket/Tier/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"usageBucketId": 17,
"usageBucketName": "Sample Text Data",
"usageRatePlanId": 27,
"usageRatePlanName": "Sample Text Data",
"threshold": 0,
"flatCharge": 26,
"usageUnitId": 11,
"usageUnitName": "Sample Text Data"
}
} | |
| POST | api/v2/Usage/Bucket/Tier/ |
| Create a new instance of the UsageBucketTier object. | |
Create a new instance of the UsageBucketTier object. POST api/v2/Usage/Bucket/Tier/
{
"usageBucketId": 1,
"usageRatePlanId": 17,
"threshold": 5,
"flatCharge": 22,
"usageUnitId": 24
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"usageBucketId": 25,
"usageBucketName": "Sample Text Data",
"usageRatePlanId": 17,
"usageRatePlanName": "Sample Text Data",
"threshold": 2,
"flatCharge": 24,
"usageUnitId": 23,
"usageUnitName": "Sample Text Data"
}
]
}
} | |
| PUT | api/v2/Usage/Bucket/Tier/{id} |
| Update an existing instance of the UsageBucketTier object. | |
Update an existing instance of the UsageBucketTier object. PUT api/v2/Usage/Bucket/Tier/{id}
{
"identity": 1,
"usageBucketId": 0,
"usageRatePlanId": 17,
"threshold": 14,
"flatCharge": 3,
"usageUnitId": 15
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"usageBucketId": 3,
"usageBucketName": "Sample Text Data",
"usageRatePlanId": 7,
"usageRatePlanName": "Sample Text Data",
"threshold": 22,
"flatCharge": 11,
"usageUnitId": 4,
"usageUnitName": "Sample Text Data"
}
]
}
} | |