TAG LINE
SMALL TITLE

Usage / Bucket

(API Version v3)


Represents an allocation of usage that can be included in pricing, have tiers of usage and overage charges.


What can you do with UsageBucket?


Properties

Property Details
identity
READ-ONLY
"identity": 7
Type: Number
This is the unique numeric identifier for the UsageBucket
ownerId
READ-ONLY
"ownerId": 26
Type: Number
Unique identifier for the associated Owner object.
ownerName
READ-ONLY
"ownerName": "Sample Name"
Type: String
The name of the object associated with the ownerId property.
usageBucketBaseId
"usageBucketBaseId": 4
Type: Number
Unique identifier for the associated UsageBucketBase object.
usageBucketBaseName
"usageBucketBaseName": "Sample Name"
Type: String
The name of the object associated with the usageBucketBaseId property.
name
"name": "100 minutes"
Type: String
User defined name for this Bucket
prorate
"prorate": true
Type: Boolean
Whether or not to prorate the allocation when added to an account.
isInfiniteLastTier
"isInfiniteLastTier": true
Type: Boolean
Whether or not the last defined tier repeats forever.
isThresholdPerAccountService
"isThresholdPerAccountService": true
Type: Boolean
usageBucketRefillTypeId
"usageBucketRefillTypeId": 11
Type: Number
Unique identifier for the associated UsageBucketRefillType object.
usageBucketRefillTypeName
"usageBucketRefillTypeName": "Sample Name"
Type: String
The name of the object associated with the usageBucketRefillTypeId property.
refillFrequency
"refillFrequency": 15
Type: Number
Number representing how many times this Bucket refills based on its frequency type.
refillFrequencyTypeId
"refillFrequencyTypeId": 8
Type: Number
Unique identifier for the associated FrequencyType object.
refillFrequencyTypeName
"refillFrequencyTypeName": "Sample Name"
Type: String
The name of the object associated with the refillFrequencyTypeId property.
expireAfterFrequency
"expireAfterFrequency": 19
Type: Number
How many times this refills before it expires based on Expire After frequency.
expireAfterFrequencyTypeId
"expireAfterFrequencyTypeId": 9
Type: Number
Unique identifier for the associated FrequencyType object.
expireAfterFrequencyTypeName
"expireAfterFrequencyTypeName": "Sample Name"
Type: String
The name of the object associated with the expireAfterFrequencyTypeId property.
isAssociatedWithSharePlan
"isAssociatedWithSharePlan": true
Type: Boolean
Whether or not this Bucket is included as part of a Share Plan.
expireAfterRecurrence
"expireAfterRecurrence": 16
Type: Number
How many times this refills before it expires if this is a Recurring and Recurring with Rollover Bucket.
accountPackageActivation
"accountPackageActivation": true
Type: Boolean
Whether or not this should trigger billing activation once the allowance, or time, threshold has been met.


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:

  • identity
  • usageBucketBaseId
  • name
  • prorate
  • isInfiniteLastTier
  • isThresholdPerAccountService
  • usageBucketRefillTypeId
  • refillFrequency
  • refillFrequencyTypeId
  • expireAfterFrequency
  • expireAfterFrequencyTypeId
  • expireAfterRecurrence
  • isAssociatedWithSharePlan
  • accountPackageActivation

DataFlow PATCH objects:


End Points

DELETEapi/v3/Usage/Bucket/{id}
Delete an instance of the UsageBucket 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 UsageBucket object.
Delete an instance of the UsageBucket object.
DELETE api/v3/Usage/Bucket/{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": "usageBucket"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v3/Usage/Bucket/
Retrieve all of the UsageBucket objects.
Retrieve all of the UsageBucket objects.
GET api/v3/Usage/Bucket/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 7,
            "ownerName": "Sample Text Data",
            "usageBucketBaseId": 15,
            "usageBucketBaseName": "Sample Text Data",
            "name": "100 minutes",
            "prorate": true,
            "isInfiniteLastTier": true,
            "isThresholdPerAccountService": true,
            "usageBucketRefillTypeId": 15,
            "usageBucketRefillTypeName": "Sample Text Data",
            "refillFrequency": 23,
            "refillFrequencyTypeId": 11,
            "refillFrequencyTypeName": "Sample Text Data",
            "expireAfterFrequency": 23,
            "expireAfterFrequencyTypeId": 21,
            "expireAfterFrequencyTypeName": "Sample Text Data",
            "isAssociatedWithSharePlan": true,
            "expireAfterRecurrence": 25,
            "accountPackageActivation": true
        }
    ]
}
GETapi/v3/Usage/Bucket/Paged
Retrieve all of the UsageBucket 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 UsageBucket objects in a paged fashion.
GET api/v3/Usage/Bucket/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,
                "ownerId": 21,
                "ownerName": "Sample Text Data",
                "usageBucketBaseId": 0,
                "usageBucketBaseName": "Sample Text Data",
                "name": "100 minutes",
                "prorate": true,
                "isInfiniteLastTier": true,
                "isThresholdPerAccountService": true,
                "usageBucketRefillTypeId": 21,
                "usageBucketRefillTypeName": "Sample Text Data",
                "refillFrequency": 12,
                "refillFrequencyTypeId": 0,
                "refillFrequencyTypeName": "Sample Text Data",
                "expireAfterFrequency": 25,
                "expireAfterFrequencyTypeId": 11,
                "expireAfterFrequencyTypeName": "Sample Text Data",
                "isAssociatedWithSharePlan": true,
                "expireAfterRecurrence": 20,
                "accountPackageActivation": true
            }
        ]
    }
}
GETapi/v3/Usage/Bucket/Paged/Detail
Retrieve all of the UsageBucket objects in a paged fashion with all object details. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
Retrieve all of the UsageBucket objects in a paged fashion with all object details.
GET api/v3/Usage/Bucket/Paged/Detail
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,
                "ownerId": 18,
                "ownerName": "Sample Text Data",
                "usageBucketBaseId": 25,
                "usageBucketBaseName": "Sample Text Data",
                "name": "100 minutes",
                "prorate": true,
                "isInfiniteLastTier": true,
                "isThresholdPerAccountService": true,
                "usageBucketRefillTypeId": 3,
                "usageBucketRefillTypeName": "Sample Text Data",
                "refillFrequency": 5,
                "refillFrequencyTypeId": 27,
                "refillFrequencyTypeName": "Sample Text Data",
                "expireAfterFrequency": 17,
                "expireAfterFrequencyTypeId": 3,
                "expireAfterFrequencyTypeName": "Sample Text Data",
                "isAssociatedWithSharePlan": true,
                "expireAfterRecurrence": 5,
                "accountPackageActivation": true,
                "details": {
                    "sampleSingleObject": {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    },
                    "sampleMultipleObjects": {
                        "totalCount": 1,
                        "items": [
                            {
                                "identity": 2,
                                "property1": "Sample Text",
                                "property2": "2021-04-26T15:25:29.117Z",
                                "property3": 2
                            }
                        ]
                    }
                }
            }
        ]
    }
}
GETapi/v3/Usage/Bucket/{id}
Retrieve an instance of the UsageBucket object by its ID.
{id}Unique identifier for the UsageBucket object.
Retrieve an instance of the UsageBucket object by its ID.
GET api/v3/Usage/Bucket/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 6,
        "ownerName": "Sample Text Data",
        "usageBucketBaseId": 10,
        "usageBucketBaseName": "Sample Text Data",
        "name": "100 minutes",
        "prorate": true,
        "isInfiniteLastTier": true,
        "isThresholdPerAccountService": true,
        "usageBucketRefillTypeId": 14,
        "usageBucketRefillTypeName": "Sample Text Data",
        "refillFrequency": 21,
        "refillFrequencyTypeId": 4,
        "refillFrequencyTypeName": "Sample Text Data",
        "expireAfterFrequency": 10,
        "expireAfterFrequencyTypeId": 1,
        "expireAfterFrequencyTypeName": "Sample Text Data",
        "isAssociatedWithSharePlan": true,
        "expireAfterRecurrence": 15,
        "accountPackageActivation": true
    }
}
GETapi/v3/Usage/Bucket/{id}/Detail
Retrieve deep detail of the UsageBucket object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
{id}Unique identifier for the UsageBucket object.
Retrieve deep detail of the UsageBucket object by its ID.
GET api/v3/Usage/Bucket/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 24,
        "ownerName": "Sample Text Data",
        "usageBucketBaseId": 13,
        "usageBucketBaseName": "Sample Text Data",
        "name": "100 minutes",
        "prorate": true,
        "isInfiniteLastTier": true,
        "isThresholdPerAccountService": true,
        "usageBucketRefillTypeId": 24,
        "usageBucketRefillTypeName": "Sample Text Data",
        "refillFrequency": 12,
        "refillFrequencyTypeId": 23,
        "refillFrequencyTypeName": "Sample Text Data",
        "expireAfterFrequency": 23,
        "expireAfterFrequencyTypeId": 23,
        "expireAfterFrequencyTypeName": "Sample Text Data",
        "isAssociatedWithSharePlan": true,
        "expireAfterRecurrence": 6,
        "accountPackageActivation": true,
        "details": {
            "sampleSingleObject": {
                "identity": 2,
                "property1": "Sample Text",
                "property2": "2021-04-26T15:25:29.117Z",
                "property3": 2
            },
            "sampleMultipleObjects": {
                "totalCount": 1,
                "items": [
                    {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    }
                ]
            }
        }
    }
}
PATCHapi/v3/Usage/Bucket/{id}
Update or Add the UsageBucket object and optionally make changes to any child objects. Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array.
{id}Unique identifier for the UsageBucket object.
Update or Add the UsageBucket object and optionally make changes to any child objects.
PATCH api/v3/Usage/Bucket/{id}

{
    "details": {},
    "usageBuckets": {
        "items": [
            {
                "patchType": "create",
                "patchClientId": 1,
                "usageBucketBaseId": 26,
                "name": "100 minutes",
                "prorate": true,
                "isInfiniteLastTier": true,
                "isThresholdPerAccountService": true,
                "usageBucketRefillTypeId": 10,
                "refillFrequency": 27,
                "refillFrequencyTypeId": 8,
                "expireAfterFrequency": 2,
                "expireAfterFrequencyTypeId": 18,
                "isAssociatedWithSharePlan": true,
                "expireAfterRecurrence": 8,
                "accountPackageActivation": true
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "patch",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "action": "created",
                "dtoTypeKey": "usageBucket",
                "instance": {
                    "identity": 1,
                    "ownerId": 0,
                    "ownerName": "Sample Text Data",
                    "usageBucketBaseId": 21,
                    "usageBucketBaseName": "Sample Text Data",
                    "name": "100 minutes",
                    "prorate": true,
                    "isInfiniteLastTier": true,
                    "isThresholdPerAccountService": true,
                    "usageBucketRefillTypeId": 22,
                    "usageBucketRefillTypeName": "Sample Text Data",
                    "refillFrequency": 1,
                    "refillFrequencyTypeId": 26,
                    "refillFrequencyTypeName": "Sample Text Data",
                    "expireAfterFrequency": 2,
                    "expireAfterFrequencyTypeId": 18,
                    "expireAfterFrequencyTypeName": "Sample Text Data",
                    "isAssociatedWithSharePlan": true,
                    "expireAfterRecurrence": 19,
                    "accountPackageActivation": true
                }
            }
        ]
    }
}
POSTapi/v3/Usage/Bucket/
Create a new instance of the UsageBucket object.
Create a new instance of the UsageBucket object.
POST api/v3/Usage/Bucket/

{
    "usageBucketBaseId": 14,
    "name": "100 minutes",
    "prorate": true,
    "isInfiniteLastTier": true,
    "isThresholdPerAccountService": true,
    "usageBucketRefillTypeId": 13,
    "refillFrequency": 12,
    "refillFrequencyTypeId": 24,
    "expireAfterFrequency": 7,
    "expireAfterFrequencyTypeId": 18,
    "isAssociatedWithSharePlan": true,
    "expireAfterRecurrence": 8,
    "accountPackageActivation": true
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 14,
                "ownerName": "Sample Text Data",
                "usageBucketBaseId": 9,
                "usageBucketBaseName": "Sample Text Data",
                "name": "100 minutes",
                "prorate": true,
                "isInfiniteLastTier": true,
                "isThresholdPerAccountService": true,
                "usageBucketRefillTypeId": 7,
                "usageBucketRefillTypeName": "Sample Text Data",
                "refillFrequency": 17,
                "refillFrequencyTypeId": 15,
                "refillFrequencyTypeName": "Sample Text Data",
                "expireAfterFrequency": 6,
                "expireAfterFrequencyTypeId": 21,
                "expireAfterFrequencyTypeName": "Sample Text Data",
                "isAssociatedWithSharePlan": true,
                "expireAfterRecurrence": 21,
                "accountPackageActivation": true
            }
        ]
    }
}
PUTapi/v3/Usage/Bucket/{id}
Update an existing instance of the UsageBucket object.
Update an existing instance of the UsageBucket object.
PUT api/v3/Usage/Bucket/{id}

{
    "identity": 1,
    "usageBucketBaseId": 10,
    "name": "100 minutes",
    "prorate": true,
    "isInfiniteLastTier": true,
    "isThresholdPerAccountService": true,
    "usageBucketRefillTypeId": 21,
    "refillFrequency": 22,
    "refillFrequencyTypeId": 13,
    "expireAfterFrequency": 12,
    "expireAfterFrequencyTypeId": 3,
    "isAssociatedWithSharePlan": true,
    "expireAfterRecurrence": 9,
    "accountPackageActivation": true
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 10,
                "ownerName": "Sample Text Data",
                "usageBucketBaseId": 20,
                "usageBucketBaseName": "Sample Text Data",
                "name": "100 minutes",
                "prorate": true,
                "isInfiniteLastTier": true,
                "isThresholdPerAccountService": true,
                "usageBucketRefillTypeId": 18,
                "usageBucketRefillTypeName": "Sample Text Data",
                "refillFrequency": 21,
                "refillFrequencyTypeId": 2,
                "refillFrequencyTypeName": "Sample Text Data",
                "expireAfterFrequency": 7,
                "expireAfterFrequencyTypeId": 8,
                "expireAfterFrequencyTypeName": "Sample Text Data",
                "isAssociatedWithSharePlan": true,
                "expireAfterRecurrence": 24,
                "accountPackageActivation": true
            }
        ]
    }
}