TAG LINE
SMALL TITLE

Usage / Bucket / Tier

(API Version v3)


Defines different tiers of pricing and inclusion for a Bucket.


What can you do with UsageBucketTier?


Properties

Property Details
identity
READ-ONLY
"identity": 24
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.
usageRatePlanId
"usageRatePlanId": 6
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": 27
Type: Number
The numerical representation of the threshold based on the Usage Unit assigned to the tier.
flatCharge
"flatCharge": 17
Type: Number
A dollar value to charge when this tier has been entered.
usageUnitId
"usageUnitId": 13
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.


Update Request Filters

Update Request Filters are no longer required starting with v4 of the LogiSense Billing API.

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:

  • usageBucketId
  • usageRatePlanId
  • threshold
  • flatCharge
  • usageUnitId

End Points

DELETEapi/v3/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/v3/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"
            }
        ]
    }
}
GETapi/v3/Usage/Bucket/Tier/
Retrieve all of the UsageBucketTier objects.
Retrieve all of the UsageBucketTier objects.
GET api/v3/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",
            "usageRatePlanId": 3,
            "usageRatePlanName": "Sample Text Data",
            "threshold": 14,
            "flatCharge": 7,
            "usageUnitId": 3,
            "usageUnitName": "Sample Text Data"
        }
    ]
}
GETapi/v3/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/v3/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": 14,
                "usageBucketName": "Sample Text Data",
                "usageRatePlanId": 25,
                "usageRatePlanName": "Sample Text Data",
                "threshold": 11,
                "flatCharge": 3,
                "usageUnitId": 5,
                "usageUnitName": "Sample Text Data"
            }
        ]
    }
}
GETapi/v3/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/v3/Usage/Bucket/Tier/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "usageBucketId": 4,
        "usageBucketName": "Sample Text Data",
        "usageRatePlanId": 27,
        "usageRatePlanName": "Sample Text Data",
        "threshold": 7,
        "flatCharge": 21,
        "usageUnitId": 26,
        "usageUnitName": "Sample Text Data"
    }
}
POSTapi/v3/Usage/Bucket/Tier/
Create a new instance of the UsageBucketTier object.
Create a new instance of the UsageBucketTier object.
POST api/v3/Usage/Bucket/Tier/

{
    "usageBucketId": 11,
    "usageRatePlanId": 14,
    "threshold": 22,
    "flatCharge": 10,
    "usageUnitId": 24
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "usageBucketId": 21,
                "usageBucketName": "Sample Text Data",
                "usageRatePlanId": 14,
                "usageRatePlanName": "Sample Text Data",
                "threshold": 9,
                "flatCharge": 15,
                "usageUnitId": 13,
                "usageUnitName": "Sample Text Data"
            }
        ]
    }
}
PUTapi/v3/Usage/Bucket/Tier/{id}
Update an existing instance of the UsageBucketTier object.
Update an existing instance of the UsageBucketTier object.
PUT api/v3/Usage/Bucket/Tier/{id}

{
    "identity": 1,
    "usageBucketId": 17,
    "usageRatePlanId": 23,
    "threshold": 23,
    "flatCharge": 22,
    "usageUnitId": 4
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "usageBucketId": 21,
                "usageBucketName": "Sample Text Data",
                "usageRatePlanId": 8,
                "usageRatePlanName": "Sample Text Data",
                "threshold": 16,
                "flatCharge": 23,
                "usageUnitId": 2,
                "usageUnitName": "Sample Text Data"
            }
        ]
    }
}