TAG LINE
TAG LINE
SMALL TITLE

View Account Service Usage Bucket Consumption

(API Version v10)


Returns the details of the buckets attached to services on an account. Paramaters that can be passed in are AccountServiceName, AccountServiceId, UdrUsageIdentifier and FromDate.


What can you do with AccountServiceUsageBucketConsumption?



End Points

GETAccount/Service/Usage/Bucket/Consumption/Paged
Retrieve consumption details for an account's bucket for a particular service.Retreive all the consumption details for a bucket attached to an account's service by providing different parameters. An example of calling this API would be Account/Service/Usage/Bucket/Paged?UdrUsageIdentifier=CCCC
Retrieve consumption details for an account's bucket for a particular service.
GET Account/Service/Usage/Bucket/Consumption/Paged
View Sample Response
HTTP/1.1 200 OK
{
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "accountServiceUsageBucketId": 6,
                "accountId": 10000003,
                "accountPackageId": 3176,
                "accountServiceId": 20121,
                "accountServiceName": "A service non Ex (7FA7DA21)",
                "bucketId": 6,
                "catalogBucketId": 1306,
                "bucketName": "A Simple Bucket 6",
                "bucketSize": 500.000000,
                "usageConsumed": 500.000000000000000000000,
                "udrUsageIdentifier": "CCCC",
                "isProrated": false,
                "isLastTierRepeating": false,
                "refillTypeId": 7,
                "refillTypeName": "Nonrecurring",
                "expireAfterFrequency": 2,
                "expireAfterFrequencyTypeId": 3,
                "expireAfterFrequencyTypeName": "Month",
                "isSharedAcrossPackage": false,
                "effectiveDate": "2021-07-23T21:30:05Z",
                "effectiveCancelDate": "2021-09-23T21:30:05Z",
                "expiryDate": "2021-09-23T21:30:05Z",
                "startDate": "2021-07-23T21:30:05Z",
                "endDate": "2021-09-23T21:30:05Z",
                "usageUnitId": 5,
                "usageUnitName": "B",
                "details": {
                    "viewAccountServiceUsageBucketConsumption": {
                        "totalCount": 2,
                        "items": [
                            {
                                "udrUsageBucketId": 5,
                                "accountServiceUsageBucketId": 6,
                                "accountServiceUsageBucketTierId": 9,
                                "catalogBucketTierId": 1289,
                                "thresholdFrom": 0.000000,
                                "thresholdTo": 250.000000,
                                "usageConsumed": 250.000000,
                                "usageUnitId": 5,
                                "usageUnitName": "B",
                                "startDate": "2021-07-23T21:30:05Z",
                                "endDate": "2021-09-23T21:30:05Z"
                            },
                            {
                                "udrUsageBucketId": 5,
                                "accountServiceUsageBucketId": 6,
                                "accountServiceUsageBucketTierId": 10,
                                "catalogBucketTierId": 1290,
                                "thresholdFrom": 250.000000,
                                "thresholdTo": 500.000000,
                                "usageConsumed": 250.000000,
                                "usageUnitId": 5,
                                "usageUnitName": "B",
                                "startDate": "2021-07-23T21:30:05Z",
                                "endDate": "2021-09-23T21:30:05Z"
                            }
                        ]
                    },
                    "usageBucketBase": {
                        "totalCount": 1,
                        "items": [
                            {
                                "identity": 20100,
                                "name": "Data - USA",
                                "start": "2018-10-17T00:00:00Z",
                                "retired": false,
                                "usageBucketBaseUnitId": 2,
                                "usageBucketBaseUnitName": "Data"
                            }
                        ]
                    }
                }
            }
        ]
    }
}