TAG LINE
TAG LINE
SMALL TITLE
Represents an allocation of usage that can be included in pricing, have tiers of usage and overage charges.
identity READ-ONLY | "identity": 21 Type: Number This is the unique numeric identifier for the UsageBucket |
ownerId READ-ONLY | "ownerId": 21 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. |
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 Whether or not the bucket threshold is per account service. |
usageBucketRefillTypeId | "usageBucketRefillTypeId": 18 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": 26 Type: Number Number representing how many times this Bucket refills based on its frequency type. |
refillFrequencyTypeId | "refillFrequencyTypeId": 5 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": 1 Type: Number How many times this refills before it expires based on Expire After frequency. |
expireAfterFrequencyTypeId | "expireAfterFrequencyTypeId": 17 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": 5 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. |
usageBucketBaseUnitId | "usageBucketBaseUnitId": 1 Type: Number Unique identifier for the associated UsageBucketBaseUnit object. |
usageBucketBaseUnitName | "usageBucketBaseUnitName": "Sample Name" Type: String The name of the object associated with the usageBucketBaseUnitId property. |
overageUsageRatePlanId | "overageUsageRatePlanId": 6 Type: Number Unique identifier for the associated UsageRatePlan object. |
overageUsageRatePlanName | "overageUsageRatePlanName": "Sample Name" Type: String The name of the object associated with the overageUsageRatePlanId property. |
DataFlow PATCH objects:
| DELETE | Usage/Bucket/{id} |
| Delete an instance of the UsageBucket 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 UsageBucket object. |
Delete an instance of the UsageBucket object. DELETE Usage/Bucket/{id}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"
}
]
}
} | |
| GET | Usage/Bucket/ |
| Retrieve all of the UsageBucket objects. | |
Retrieve all of the UsageBucket objects. GET Usage/Bucket/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 11,
"ownerName": "Sample Text Data",
"name": "100 minutes",
"prorate": true,
"isInfiniteLastTier": true,
"isThresholdPerAccountService": true,
"usageBucketRefillTypeId": 21,
"usageBucketRefillTypeName": "Sample Text Data",
"refillFrequency": 13,
"refillFrequencyTypeId": 19,
"refillFrequencyTypeName": "Sample Text Data",
"expireAfterFrequency": 26,
"expireAfterFrequencyTypeId": 14,
"expireAfterFrequencyTypeName": "Sample Text Data",
"isAssociatedWithSharePlan": true,
"expireAfterRecurrence": 14,
"accountPackageActivation": true,
"usageBucketBaseUnitId": 1,
"usageBucketBaseUnitName": "Sample Text Data",
"overageUsageRatePlanId": 3,
"overageUsageRatePlanName": "Sample Text Data"
}
]
} | |
| GET | 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 Usage/Bucket/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,
"ownerId": 2,
"ownerName": "Sample Text Data",
"name": "100 minutes",
"prorate": true,
"isInfiniteLastTier": true,
"isThresholdPerAccountService": true,
"usageBucketRefillTypeId": 7,
"usageBucketRefillTypeName": "Sample Text Data",
"refillFrequency": 9,
"refillFrequencyTypeId": 23,
"refillFrequencyTypeName": "Sample Text Data",
"expireAfterFrequency": 13,
"expireAfterFrequencyTypeId": 27,
"expireAfterFrequencyTypeName": "Sample Text Data",
"isAssociatedWithSharePlan": true,
"expireAfterRecurrence": 17,
"accountPackageActivation": true,
"usageBucketBaseUnitId": 26,
"usageBucketBaseUnitName": "Sample Text Data",
"overageUsageRatePlanId": 0,
"overageUsageRatePlanName": "Sample Text Data"
}
]
}
} | |
| GET | 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 Usage/Bucket/Paged/Detail 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": 3,
"ownerName": "Sample Text Data",
"name": "100 minutes",
"prorate": true,
"isInfiniteLastTier": true,
"isThresholdPerAccountService": true,
"usageBucketRefillTypeId": 8,
"usageBucketRefillTypeName": "Sample Text Data",
"refillFrequency": 16,
"refillFrequencyTypeId": 10,
"refillFrequencyTypeName": "Sample Text Data",
"expireAfterFrequency": 3,
"expireAfterFrequencyTypeId": 9,
"expireAfterFrequencyTypeName": "Sample Text Data",
"isAssociatedWithSharePlan": true,
"expireAfterRecurrence": 13,
"accountPackageActivation": true,
"usageBucketBaseUnitId": 19,
"usageBucketBaseUnitName": "Sample Text Data",
"overageUsageRatePlanId": 6,
"overageUsageRatePlanName": "Sample Text Data",
"details": {
"tiers": [
{
"identity": 81,
"usageBucketId": 61,
"usageBucketName": "Sample Text Data",
"threshold": 66.89,
"flatCharge": 95,
"usageUnitId": 0,
"usageUnitName": "Sample Text Data",
"packageFrequencyId": 42,
"packageFrequencyName": "Sample Text Data",
"packageServiceId": 25,
"currencyId": 11,
"currencyName": "Sample Text Data",
"money": 77.71,
"priceBookId": 99,
"priceBookName": "Sample Text Data",
"tierOverride": true
}
],
"contributions": [
{
"identity": 89,
"usageBucketSharePlanParticipationId": 21,
"usageBucketId": 98,
"usageBucketName": "Sample Text Data",
"isContributing": true,
"contributingAmount": 11.5,
"contributingUsageUnitId": 46,
"contributingUsageUnitName": "Sample Text Data",
"moneyCurrencyId": 29,
"serviceId": 93,
"serviceName": "Sample Text Data",
"packageId": 20,
"packageName": "Sample Text Data"
}
],
"usageBucketNotifications": [
{
"identity": 18,
"usageBucketServiceId": 90,
"emailConfigurationId": 53,
"emailConfigurationName": "Sample Text Data",
"webhookConfigurationId": 19,
"webhookConfigurationName": "Sample Text Data",
"thresholdPercent": 3,
"details": {
"emailConfiguration": {
"identity": 37,
"name": "Sample Text Data",
"eventSubscriptionId": 45,
"eventSubscriptionName": "Sample Text Data",
"emailTemplateId": 19,
"emailTemplateName": "Sample Text Data",
"details": {
"emailToAddresses": [
{
"identity": 16,
"emailConfigurationId": 5,
"emailConfigurationName": "Sample Text Data",
"userId": 59,
"userName": "Sample Text Data",
"contactTypeTypeId": 63,
"contactTypeTypeName": "Sample Text Data",
"email": "Sample Text Data"
}
]
}
},
"webhookConfiguration": {
"identity": 13,
"name": "Sample Text Data",
"url": "Sample Text Data",
"requestVerb": "Sample Text Data",
"webhookTemplateId": 11,
"webhookTemplateName": "Sample Text Data",
"keyValuePairAuthorizationTokenKey": "Sample Text Data",
"keyValuePairAuthorizationTokenValue": "Sample Text Data",
"eventSubscriptionId": 8,
"eventSubscriptionName": "Sample Text Data",
"webhookAuthorizationTypeId": 85,
"webhookAuthorizationTypeName": "Sample Text Data",
"oAuthUsername": "Sample Text Data",
"oAuthPassword": "Sample Text Data",
"oAuthClientId": "Sample Text Data",
"oAuthAuthorizationURL": "Sample Text Data",
"hasCredentialsSet": true,
"webhookFormatTypeId": 82,
"webhookFormatTypeName": "Sample Text Data",
"oAuthClientSecret": "Sample Text Data"
}
}
}
],
"usageBucketBase": [
{
"identity": 23,
"name": "Sample Text Data",
"start": "2021-04-26T15:25:27.587Z",
"end": "2021-04-26T15:25:27.587Z",
"retired": true,
"usageBucketBaseUnitId": 44,
"usageBucketBaseUnitName": "Sample Text Data"
}
]
}
}
]
}
} | |
| GET | 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 Usage/Bucket/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 13,
"ownerName": "Sample Text Data",
"name": "100 minutes",
"prorate": true,
"isInfiniteLastTier": true,
"isThresholdPerAccountService": true,
"usageBucketRefillTypeId": 14,
"usageBucketRefillTypeName": "Sample Text Data",
"refillFrequency": 22,
"refillFrequencyTypeId": 8,
"refillFrequencyTypeName": "Sample Text Data",
"expireAfterFrequency": 3,
"expireAfterFrequencyTypeId": 2,
"expireAfterFrequencyTypeName": "Sample Text Data",
"isAssociatedWithSharePlan": true,
"expireAfterRecurrence": 4,
"accountPackageActivation": true,
"usageBucketBaseUnitId": 9,
"usageBucketBaseUnitName": "Sample Text Data",
"overageUsageRatePlanId": 5,
"overageUsageRatePlanName": "Sample Text Data"
}
} | |
| GET | 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 Usage/Bucket/{id}/DetailHTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 18,
"ownerName": "Sample Text Data",
"name": "100 minutes",
"prorate": true,
"isInfiniteLastTier": true,
"isThresholdPerAccountService": true,
"usageBucketRefillTypeId": 25,
"usageBucketRefillTypeName": "Sample Text Data",
"refillFrequency": 18,
"refillFrequencyTypeId": 6,
"refillFrequencyTypeName": "Sample Text Data",
"expireAfterFrequency": 18,
"expireAfterFrequencyTypeId": 22,
"expireAfterFrequencyTypeName": "Sample Text Data",
"isAssociatedWithSharePlan": true,
"expireAfterRecurrence": 24,
"accountPackageActivation": true,
"usageBucketBaseUnitId": 11,
"usageBucketBaseUnitName": "Sample Text Data",
"overageUsageRatePlanId": 14,
"overageUsageRatePlanName": "Sample Text Data",
"details": {
"tiers": [
{
"identity": 81,
"usageBucketId": 61,
"usageBucketName": "Sample Text Data",
"threshold": 66.89,
"flatCharge": 95,
"usageUnitId": 0,
"usageUnitName": "Sample Text Data",
"packageFrequencyId": 42,
"packageFrequencyName": "Sample Text Data",
"packageServiceId": 25,
"currencyId": 11,
"currencyName": "Sample Text Data",
"money": 77.71,
"priceBookId": 99,
"priceBookName": "Sample Text Data",
"tierOverride": true
}
],
"contributions": [
{
"identity": 89,
"usageBucketSharePlanParticipationId": 21,
"usageBucketId": 98,
"usageBucketName": "Sample Text Data",
"isContributing": true,
"contributingAmount": 11.5,
"contributingUsageUnitId": 46,
"contributingUsageUnitName": "Sample Text Data",
"moneyCurrencyId": 29,
"serviceId": 93,
"serviceName": "Sample Text Data",
"packageId": 20,
"packageName": "Sample Text Data"
}
],
"usageBucketNotifications": [
{
"identity": 18,
"usageBucketServiceId": 90,
"emailConfigurationId": 53,
"emailConfigurationName": "Sample Text Data",
"webhookConfigurationId": 19,
"webhookConfigurationName": "Sample Text Data",
"thresholdPercent": 3,
"details": {
"emailConfiguration": {
"identity": 37,
"name": "Sample Text Data",
"eventSubscriptionId": 45,
"eventSubscriptionName": "Sample Text Data",
"emailTemplateId": 19,
"emailTemplateName": "Sample Text Data",
"details": {
"emailToAddresses": [
{
"identity": 16,
"emailConfigurationId": 5,
"emailConfigurationName": "Sample Text Data",
"userId": 59,
"userName": "Sample Text Data",
"contactTypeTypeId": 63,
"contactTypeTypeName": "Sample Text Data",
"email": "Sample Text Data"
}
]
}
},
"webhookConfiguration": {
"identity": 13,
"name": "Sample Text Data",
"url": "Sample Text Data",
"requestVerb": "Sample Text Data",
"webhookTemplateId": 11,
"webhookTemplateName": "Sample Text Data",
"keyValuePairAuthorizationTokenKey": "Sample Text Data",
"keyValuePairAuthorizationTokenValue": "Sample Text Data",
"eventSubscriptionId": 8,
"eventSubscriptionName": "Sample Text Data",
"webhookAuthorizationTypeId": 85,
"webhookAuthorizationTypeName": "Sample Text Data",
"oAuthUsername": "Sample Text Data",
"oAuthPassword": "Sample Text Data",
"oAuthClientId": "Sample Text Data",
"oAuthAuthorizationURL": "Sample Text Data",
"hasCredentialsSet": true,
"webhookFormatTypeId": 82,
"webhookFormatTypeName": "Sample Text Data",
"oAuthClientSecret": "Sample Text Data"
}
}
}
],
"usageBucketBase": [
{
"identity": 23,
"name": "Sample Text Data",
"start": "2021-04-26T15:25:27.587Z",
"end": "2021-04-26T15:25:27.587Z",
"retired": true,
"usageBucketBaseUnitId": 44,
"usageBucketBaseUnitName": "Sample Text Data"
}
]
}
}
} | |
| PATCH | 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 Usage/Bucket/{id}
{
"details": {},
"usageBuckets": {
"items": [
{
"patchType": "create",
"patchClientId": 1,
"name": "100 minutes",
"prorate": true,
"isInfiniteLastTier": true,
"isThresholdPerAccountService": true,
"usageBucketRefillTypeId": 5,
"refillFrequency": 22,
"refillFrequencyTypeId": 20,
"expireAfterFrequency": 5,
"expireAfterFrequencyTypeId": 12,
"isAssociatedWithSharePlan": true,
"expireAfterRecurrence": 15,
"accountPackageActivation": true,
"usageBucketBaseUnitId": 20,
"overageUsageRatePlanId": 15
}
]
}
}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": 27,
"ownerName": "Sample Text Data",
"name": "100 minutes",
"prorate": true,
"isInfiniteLastTier": true,
"isThresholdPerAccountService": true,
"usageBucketRefillTypeId": 10,
"usageBucketRefillTypeName": "Sample Text Data",
"refillFrequency": 3,
"refillFrequencyTypeId": 23,
"refillFrequencyTypeName": "Sample Text Data",
"expireAfterFrequency": 2,
"expireAfterFrequencyTypeId": 20,
"expireAfterFrequencyTypeName": "Sample Text Data",
"isAssociatedWithSharePlan": true,
"expireAfterRecurrence": 20,
"accountPackageActivation": true,
"usageBucketBaseUnitId": 2,
"usageBucketBaseUnitName": "Sample Text Data",
"overageUsageRatePlanId": 24,
"overageUsageRatePlanName": "Sample Text Data"
}
}
]
}
} | |
| POST | Usage/Bucket/ |
| Create a new instance of the UsageBucket object. | |
Create a new instance of the UsageBucket object. POST Usage/Bucket/
{
"name": "100 minutes",
"prorate": true,
"isInfiniteLastTier": true,
"isThresholdPerAccountService": true,
"usageBucketRefillTypeId": 2,
"refillFrequency": 13,
"refillFrequencyTypeId": 16,
"expireAfterFrequency": 14,
"expireAfterFrequencyTypeId": 27,
"isAssociatedWithSharePlan": true,
"expireAfterRecurrence": 0,
"accountPackageActivation": true,
"usageBucketBaseUnitId": 25,
"overageUsageRatePlanId": 25
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 17,
"ownerName": "Sample Text Data",
"name": "100 minutes",
"prorate": true,
"isInfiniteLastTier": true,
"isThresholdPerAccountService": true,
"usageBucketRefillTypeId": 16,
"usageBucketRefillTypeName": "Sample Text Data",
"refillFrequency": 24,
"refillFrequencyTypeId": 10,
"refillFrequencyTypeName": "Sample Text Data",
"expireAfterFrequency": 19,
"expireAfterFrequencyTypeId": 2,
"expireAfterFrequencyTypeName": "Sample Text Data",
"isAssociatedWithSharePlan": true,
"expireAfterRecurrence": 22,
"accountPackageActivation": true,
"usageBucketBaseUnitId": 19,
"usageBucketBaseUnitName": "Sample Text Data",
"overageUsageRatePlanId": 15,
"overageUsageRatePlanName": "Sample Text Data"
}
]
}
} | |
| PUT | Usage/Bucket/{id} |
| Update an existing instance of the UsageBucket object. | |
Update an existing instance of the UsageBucket object. PUT Usage/Bucket/{id}
{
"identity": 1,
"name": "100 minutes",
"prorate": true,
"isInfiniteLastTier": true,
"isThresholdPerAccountService": true,
"usageBucketRefillTypeId": 3,
"refillFrequency": 5,
"refillFrequencyTypeId": 21,
"expireAfterFrequency": 15,
"expireAfterFrequencyTypeId": 9,
"isAssociatedWithSharePlan": true,
"expireAfterRecurrence": 23,
"accountPackageActivation": true,
"usageBucketBaseUnitId": 16,
"overageUsageRatePlanId": 8
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 7,
"ownerName": "Sample Text Data",
"name": "100 minutes",
"prorate": true,
"isInfiniteLastTier": true,
"isThresholdPerAccountService": true,
"usageBucketRefillTypeId": 25,
"usageBucketRefillTypeName": "Sample Text Data",
"refillFrequency": 22,
"refillFrequencyTypeId": 27,
"refillFrequencyTypeName": "Sample Text Data",
"expireAfterFrequency": 1,
"expireAfterFrequencyTypeId": 19,
"expireAfterFrequencyTypeName": "Sample Text Data",
"isAssociatedWithSharePlan": true,
"expireAfterRecurrence": 11,
"accountPackageActivation": true,
"usageBucketBaseUnitId": 16,
"usageBucketBaseUnitName": "Sample Text Data",
"overageUsageRatePlanId": 18,
"overageUsageRatePlanName": "Sample Text Data"
}
]
}
} | |