TAG LINE
TAG LINE
SMALL TITLE

Usage / Bucket / Tier

(API Version v7)


Defines different tiers of pricing and inclusion for a Bucket.


What can you do with UsageBucketTier?


Properties

Property Details
identity
READ-ONLY
"identity": 15
Type: Number
This is the unique numeric identifier for the UsageBucketTier
usageBucketId
"usageBucketId": 16
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": 14
Type: Number
The numerical representation of the threshold based on the Usage Unit assigned to the tier.
flatCharge
"flatCharge": 8
Type: Number
A dollar value to charge when this tier has been entered.
usageUnitId
"usageUnitId": 3
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": 2
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": 0
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": 7
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": 5
Type: Number
priceBookId
"priceBookId": 16
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.


End Points

DELETEUsage/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}
View Sample Response
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"
            }
        ]
    }
}
GETUsage/Bucket/Tier/
Retrieve all of the UsageBucketTier objects.
Retrieve all of the UsageBucketTier objects.
GET Usage/Bucket/Tier/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "usageBucketId": 7,
            "usageBucketName": "Sample Text Data",
            "threshold": 12,
            "flatCharge": 10,
            "usageUnitId": 24,
            "usageUnitName": "Sample Text Data",
            "packageFrequencyId": 26,
            "packageFrequencyName": "Sample Text Data",
            "packageServiceId": 26,
            "packageServiceName": "Sample Text Data",
            "currencyId": 1,
            "currencyName": "Sample Text Data",
            "money": 1,
            "priceBookId": 25,
            "priceBookName": "Sample Text Data"
        }
    ]
}
GETUsage/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
View Sample Response
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": 22,
                "usageBucketName": "Sample Text Data",
                "threshold": 17,
                "flatCharge": 6,
                "usageUnitId": 21,
                "usageUnitName": "Sample Text Data",
                "packageFrequencyId": 23,
                "packageFrequencyName": "Sample Text Data",
                "packageServiceId": 13,
                "packageServiceName": "Sample Text Data",
                "currencyId": 10,
                "currencyName": "Sample Text Data",
                "money": 6,
                "priceBookId": 6,
                "priceBookName": "Sample Text Data"
            }
        ]
    }
}
GETUsage/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}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "usageBucketId": 14,
        "usageBucketName": "Sample Text Data",
        "threshold": 6,
        "flatCharge": 6,
        "usageUnitId": 23,
        "usageUnitName": "Sample Text Data",
        "packageFrequencyId": 1,
        "packageFrequencyName": "Sample Text Data",
        "packageServiceId": 10,
        "packageServiceName": "Sample Text Data",
        "currencyId": 17,
        "currencyName": "Sample Text Data",
        "money": 5,
        "priceBookId": 4,
        "priceBookName": "Sample Text Data"
    }
}
POSTUsage/Bucket/Tier/
Create a new instance of the UsageBucketTier object.
Create a new instance of the UsageBucketTier object.
POST Usage/Bucket/Tier/

{
    "usageBucketId": 6,
    "threshold": 26,
    "flatCharge": 20,
    "usageUnitId": 27,
    "packageFrequencyId": 9,
    "packageServiceId": 5,
    "currencyId": 12,
    "money": 1,
    "priceBookId": 13
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "usageBucketId": 5,
                "usageBucketName": "Sample Text Data",
                "threshold": 10,
                "flatCharge": 20,
                "usageUnitId": 1,
                "usageUnitName": "Sample Text Data",
                "packageFrequencyId": 6,
                "packageFrequencyName": "Sample Text Data",
                "packageServiceId": 23,
                "packageServiceName": "Sample Text Data",
                "currencyId": 10,
                "currencyName": "Sample Text Data",
                "money": 24,
                "priceBookId": 4,
                "priceBookName": "Sample Text Data"
            }
        ]
    }
}
PUTUsage/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": 13,
    "threshold": 16,
    "flatCharge": 8,
    "usageUnitId": 20,
    "packageFrequencyId": 17,
    "packageServiceId": 1,
    "currencyId": 11,
    "money": 13,
    "priceBookId": 22
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "usageBucketId": 27,
                "usageBucketName": "Sample Text Data",
                "threshold": 16,
                "flatCharge": 24,
                "usageUnitId": 25,
                "usageUnitName": "Sample Text Data",
                "packageFrequencyId": 27,
                "packageFrequencyName": "Sample Text Data",
                "packageServiceId": 19,
                "packageServiceName": "Sample Text Data",
                "currencyId": 15,
                "currencyName": "Sample Text Data",
                "money": 12,
                "priceBookId": 3,
                "priceBookName": "Sample Text Data"
            }
        ]
    }
}