TAG LINE
SMALL TITLE

Account / Service / Usage / Bucket

(API Version v2)


A Usage Bucket associated with an Account Service. This typically will hold any inclusions of usage for the Account Service.


What can you do with AccountServiceUsageBucket?


Properties

Property Details
identity
READ-ONLY
"identity": 15
Type: Number
This is the unique numeric identifier for the AccountServiceUsageBucket
usageBucketId
"usageBucketId": 11
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.
accountServiceId
"accountServiceId": "Hello World"
Type: String
Unique identifier for the associated AccountService object.
accountServiceName
"accountServiceName": "Sample Name"
Type: String
The name of the object associated with the accountServiceId property.
refillFrequency
READ-ONLY
"refillFrequency": 26
Type: Number
The number of times the bucket will refill based on the refillFrequencyTypeId. For example 1 month.
refillFrequencyTypeId
"refillFrequencyTypeId": 23
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.
effective
READ-ONLY
"effective": "2021-04-26T15:25:27.587Z"
Type: Date
The date in which this bucket becomes enabled. This is inherited from the Account Service.

Date and time values are specified in the ISO 8601 format.
effectiveCancel
READ-ONLY
"effectiveCancel": "2021-04-26T15:25:27.587Z"
Type: Date
The date in which this bucket should be cancelled. This is inherited from the Account Service.

Date and time values are specified in the ISO 8601 format.
prorate
READ-ONLY
"prorate": true
Type: Boolean
Whether or not the amount defined for this Bucket will be prorated. This is inherited from the Account Service.
isInfiniteLastTier
READ-ONLY
"isInfiniteLastTier": true
Type: Boolean
Whether or not the last tier of the bucket repeats. This is inherited from the Bucket definition.
isThresholdPerAccountService
"isThresholdPerAccountService": true
Type: Boolean
usageBucketRefillTypeId
"usageBucketRefillTypeId": 10
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.
expireAfterFrequency
READ-ONLY
"expireAfterFrequency": 6
Type: Number
Whether or not the bucket will expire after the defined period. This is inherited from the Bucket definition.
expireAfterFrequencyTypeId
"expireAfterFrequencyTypeId": 11
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.
expireAfterRecurrence
READ-ONLY
"expireAfterRecurrence": 9
Type: Number
Whether or not the bucket will expire after the defined period. This is for recurring buckets and buckets with roll over. This is inherited from the Bucket definition.
accountPackageActivation
READ-ONLY
"accountPackageActivation": true
Type: Boolean
Whether or not the bucket is used for billing activation. This is inherited from the Bucket definition.
isSharedAcrossPackage
READ-ONLY
"isSharedAcrossPackage": true
Type: Boolean
Whether or not the bucket is shared across all services assigned within this Account Package.


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
  • accountServiceId
  • refillFrequency
  • refillFrequencyTypeId
  • effective
  • effectiveCancel
  • prorate
  • isInfiniteLastTier
  • isThresholdPerAccountService
  • usageBucketRefillTypeId
  • expireAfterFrequency
  • expireAfterFrequencyTypeId
  • expireAfterRecurrence
  • accountPackageActivation
  • isSharedAcrossPackage

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the AccountServiceUsageBucket object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v2/Account/Service/Usage/Bucket/{id}
Delete an instance of the AccountServiceUsageBucket 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 AccountServiceUsageBucket object.
Delete an instance of the AccountServiceUsageBucket object.
DELETE api/v2/Account/Service/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": "accountServiceUsageBucket"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v2/Account/Service/Usage/Bucket/
Retrieve all of the AccountServiceUsageBucket objects.
Retrieve all of the AccountServiceUsageBucket objects.
GET api/v2/Account/Service/Usage/Bucket/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "usageBucketId": 14,
            "usageBucketName": "Sample Text Data",
            "accountServiceId": "Sample Text Data",
            "accountServiceName": "Sample Text Data",
            "refillFrequency": 26,
            "refillFrequencyTypeId": 18,
            "refillFrequencyTypeName": "Sample Text Data",
            "effective": "2021-04-26T15:25:27.587Z",
            "effectiveCancel": "2021-04-26T15:25:27.587Z",
            "prorate": true,
            "isInfiniteLastTier": true,
            "isThresholdPerAccountService": true,
            "usageBucketRefillTypeId": 16,
            "usageBucketRefillTypeName": "Sample Text Data",
            "expireAfterFrequency": 9,
            "expireAfterFrequencyTypeId": 22,
            "expireAfterFrequencyTypeName": "Sample Text Data",
            "expireAfterRecurrence": 11,
            "accountPackageActivation": true,
            "isSharedAcrossPackage": true
        }
    ]
}
GETapi/v2/Account/Service/Usage/Bucket/Paged
Retrieve all of the AccountServiceUsageBucket 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 AccountServiceUsageBucket objects in a paged fashion.
GET api/v2/Account/Service/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,
                "usageBucketId": 9,
                "usageBucketName": "Sample Text Data",
                "accountServiceId": "Sample Text Data",
                "accountServiceName": "Sample Text Data",
                "refillFrequency": 0,
                "refillFrequencyTypeId": 27,
                "refillFrequencyTypeName": "Sample Text Data",
                "effective": "2021-04-26T15:25:27.587Z",
                "effectiveCancel": "2021-04-26T15:25:27.587Z",
                "prorate": true,
                "isInfiniteLastTier": true,
                "isThresholdPerAccountService": true,
                "usageBucketRefillTypeId": 20,
                "usageBucketRefillTypeName": "Sample Text Data",
                "expireAfterFrequency": 3,
                "expireAfterFrequencyTypeId": 26,
                "expireAfterFrequencyTypeName": "Sample Text Data",
                "expireAfterRecurrence": 21,
                "accountPackageActivation": true,
                "isSharedAcrossPackage": true
            }
        ]
    }
}
GETapi/v2/Account/Service/Usage/Bucket/Paged/Detail
Retrieve all of the AccountServiceUsageBucket 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 AccountServiceUsageBucket objects in a paged fashion with all object details.
GET api/v2/Account/Service/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,
                "usageBucketId": 26,
                "usageBucketName": "Sample Text Data",
                "accountServiceId": "Sample Text Data",
                "accountServiceName": "Sample Text Data",
                "refillFrequency": 14,
                "refillFrequencyTypeId": 1,
                "refillFrequencyTypeName": "Sample Text Data",
                "effective": "2021-04-26T15:25:27.587Z",
                "effectiveCancel": "2021-04-26T15:25:27.587Z",
                "prorate": true,
                "isInfiniteLastTier": true,
                "isThresholdPerAccountService": true,
                "usageBucketRefillTypeId": 20,
                "usageBucketRefillTypeName": "Sample Text Data",
                "expireAfterFrequency": 9,
                "expireAfterFrequencyTypeId": 4,
                "expireAfterFrequencyTypeName": "Sample Text Data",
                "expireAfterRecurrence": 13,
                "accountPackageActivation": true,
                "isSharedAcrossPackage": 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/v2/Account/Service/Usage/Bucket/{id}
Retrieve an instance of the AccountServiceUsageBucket object by its ID.
{id}Unique identifier for the AccountServiceUsageBucket object.
Retrieve an instance of the AccountServiceUsageBucket object by its ID.
GET api/v2/Account/Service/Usage/Bucket/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "usageBucketId": 12,
        "usageBucketName": "Sample Text Data",
        "accountServiceId": "Sample Text Data",
        "accountServiceName": "Sample Text Data",
        "refillFrequency": 18,
        "refillFrequencyTypeId": 15,
        "refillFrequencyTypeName": "Sample Text Data",
        "effective": "2021-04-26T15:25:27.587Z",
        "effectiveCancel": "2021-04-26T15:25:27.587Z",
        "prorate": true,
        "isInfiniteLastTier": true,
        "isThresholdPerAccountService": true,
        "usageBucketRefillTypeId": 7,
        "usageBucketRefillTypeName": "Sample Text Data",
        "expireAfterFrequency": 11,
        "expireAfterFrequencyTypeId": 9,
        "expireAfterFrequencyTypeName": "Sample Text Data",
        "expireAfterRecurrence": 10,
        "accountPackageActivation": true,
        "isSharedAcrossPackage": true
    }
}
GETapi/v2/Account/Service/Usage/Bucket/{id}/Detail
Retrieve deep detail of the AccountServiceUsageBucket 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 AccountServiceUsageBucket object.
Retrieve deep detail of the AccountServiceUsageBucket object by its ID.
GET api/v2/Account/Service/Usage/Bucket/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "usageBucketId": 21,
        "usageBucketName": "Sample Text Data",
        "accountServiceId": "Sample Text Data",
        "accountServiceName": "Sample Text Data",
        "refillFrequency": 2,
        "refillFrequencyTypeId": 26,
        "refillFrequencyTypeName": "Sample Text Data",
        "effective": "2021-04-26T15:25:27.587Z",
        "effectiveCancel": "2021-04-26T15:25:27.587Z",
        "prorate": true,
        "isInfiniteLastTier": true,
        "isThresholdPerAccountService": true,
        "usageBucketRefillTypeId": 6,
        "usageBucketRefillTypeName": "Sample Text Data",
        "expireAfterFrequency": 8,
        "expireAfterFrequencyTypeId": 19,
        "expireAfterFrequencyTypeName": "Sample Text Data",
        "expireAfterRecurrence": 11,
        "accountPackageActivation": true,
        "isSharedAcrossPackage": 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/v2/Account/Service/Usage/Bucket/{id}
Update or Add the AccountServiceUsageBucket 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 AccountServiceUsageBucket object.
Update or Add the AccountServiceUsageBucket object and optionally make changes to any child objects.
PATCH api/v2/Account/Service/Usage/Bucket/{id}

{
    "details": {},
    "accountServiceUsageBuckets": {
        "items": [
            {
                "patchType": "create",
                "patchClientId": 1,
                "usageBucketId": 3,
                "accountServiceId": "Sample Text Data",
                "refillFrequencyTypeId": 17,
                "isThresholdPerAccountService": true,
                "usageBucketRefillTypeId": 5,
                "expireAfterFrequencyTypeId": 9
            }
        ]
    }
}
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": "accountServiceUsageBucket",
                "instance": {
                    "identity": 1,
                    "usageBucketId": 22,
                    "usageBucketName": "Sample Text Data",
                    "accountServiceId": "Sample Text Data",
                    "accountServiceName": "Sample Text Data",
                    "refillFrequency": 19,
                    "refillFrequencyTypeId": 14,
                    "refillFrequencyTypeName": "Sample Text Data",
                    "effective": "2021-04-26T15:25:27.587Z",
                    "effectiveCancel": "2021-04-26T15:25:27.587Z",
                    "prorate": true,
                    "isInfiniteLastTier": true,
                    "isThresholdPerAccountService": true,
                    "usageBucketRefillTypeId": 15,
                    "usageBucketRefillTypeName": "Sample Text Data",
                    "expireAfterFrequency": 27,
                    "expireAfterFrequencyTypeId": 19,
                    "expireAfterFrequencyTypeName": "Sample Text Data",
                    "expireAfterRecurrence": 5,
                    "accountPackageActivation": true,
                    "isSharedAcrossPackage": true
                }
            }
        ]
    }
}
POSTapi/v2/Account/Service/Usage/Bucket/
Create a new instance of the AccountServiceUsageBucket object.
Create a new instance of the AccountServiceUsageBucket object.
POST api/v2/Account/Service/Usage/Bucket/

{
    "usageBucketId": 16,
    "accountServiceId": "Sample Text Data",
    "refillFrequencyTypeId": 14,
    "isThresholdPerAccountService": true,
    "usageBucketRefillTypeId": 14,
    "expireAfterFrequencyTypeId": 17
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "usageBucketId": 16,
                "usageBucketName": "Sample Text Data",
                "accountServiceId": "Sample Text Data",
                "accountServiceName": "Sample Text Data",
                "refillFrequency": 3,
                "refillFrequencyTypeId": 16,
                "refillFrequencyTypeName": "Sample Text Data",
                "effective": "2021-04-26T15:25:27.587Z",
                "effectiveCancel": "2021-04-26T15:25:27.587Z",
                "prorate": true,
                "isInfiniteLastTier": true,
                "isThresholdPerAccountService": true,
                "usageBucketRefillTypeId": 3,
                "usageBucketRefillTypeName": "Sample Text Data",
                "expireAfterFrequency": 11,
                "expireAfterFrequencyTypeId": 13,
                "expireAfterFrequencyTypeName": "Sample Text Data",
                "expireAfterRecurrence": 23,
                "accountPackageActivation": true,
                "isSharedAcrossPackage": true
            }
        ]
    }
}
PUTapi/v2/Account/Service/Usage/Bucket/{id}
Update an existing instance of the AccountServiceUsageBucket object.
Update an existing instance of the AccountServiceUsageBucket object.
PUT api/v2/Account/Service/Usage/Bucket/{id}

{
    "identity": 1,
    "usageBucketId": 8,
    "accountServiceId": "Sample Text Data",
    "refillFrequencyTypeId": 3,
    "isThresholdPerAccountService": true,
    "usageBucketRefillTypeId": 0,
    "expireAfterFrequencyTypeId": 16
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "usageBucketId": 6,
                "usageBucketName": "Sample Text Data",
                "accountServiceId": "Sample Text Data",
                "accountServiceName": "Sample Text Data",
                "refillFrequency": 3,
                "refillFrequencyTypeId": 27,
                "refillFrequencyTypeName": "Sample Text Data",
                "effective": "2021-04-26T15:25:27.587Z",
                "effectiveCancel": "2021-04-26T15:25:27.587Z",
                "prorate": true,
                "isInfiniteLastTier": true,
                "isThresholdPerAccountService": true,
                "usageBucketRefillTypeId": 15,
                "usageBucketRefillTypeName": "Sample Text Data",
                "expireAfterFrequency": 10,
                "expireAfterFrequencyTypeId": 11,
                "expireAfterFrequencyTypeName": "Sample Text Data",
                "expireAfterRecurrence": 25,
                "accountPackageActivation": true,
                "isSharedAcrossPackage": true
            }
        ]
    }
}