Account / SharePlan / Bucket Usage / By Service

(API Version v5)

This object provides a view into which services are actively participating in a Share Plan assigned to an Account.

What can you do with ViewSharePlanBucketUsageByService?

GET api/v5/Account/SharePlan/BucketUsage/ByService/
Retrieve all of the ViewSharePlanBucketUsageByService objects.
GET api/v5/Account/SharePlan/BucketUsage/ByService/Paged
Retrieve all of the ViewSharePlanBucketUsageByService objects in a paged fashion.

Properties

Property Details

accountSharePlanId	"accountSharePlanId": 1 Type: Number
accountServiceUsageBucketId READ-ONLY	"accountServiceUsageBucketId": 23 Type: Number The Identity or ID of the bucket that is part of this Account Share Plan.
accountServiceUsageBucketTotalUsageAmount READ-ONLY	"accountServiceUsageBucketTotalUsageAmount": 16 Type: Number The total usage amount for the bucket as part of this Account Share Plan.
accountServiceUsageBucketTotalUsageConsumed READ-ONLY	"accountServiceUsageBucketTotalUsageConsumed": 23 Type: Number The total usage amount consumed from this bucket as part of this Account Share Plan.
accountServiceUsageBucketIsAddOn READ-ONLY	"accountServiceUsageBucketIsAddOn": true Type: Boolean If this bucket is an add-on.
packageId READ-ONLY	"packageId": 6 Type: Number The Identity or ID of the package that is part of this Account Share Plan.
packageName READ-ONLY	"packageName": "Hello World" Type: String The name of the package that is part of this Account Share Plan.
serviceId READ-ONLY	"serviceId": 26 Type: Number The Identity or ID of the service that is part of this Account Share Plan.
serviceName READ-ONLY	"serviceName": "Hello World" Type: String The name of the service that is part of this Account Share Plan.
quantity READ-ONLY	"quantity": 3 Type: Number The number of services defined by serviceId that are part of this Account Share Plan.
usageConsumed READ-ONLY	"usageConsumed": 9 Type: Number How much usage have all the included packages/services consumed.
accountServiceUsageBucketRecurFrequency	"accountServiceUsageBucketRecurFrequency": 5 Type: Number
accountServiceUsageBucketRecurFrequencyTypeId	"accountServiceUsageBucketRecurFrequencyTypeId": 14 Type: Number
accountServiceUsageBucketRecurFrequencyTypeName	"accountServiceUsageBucketRecurFrequencyTypeName": "Hello World" Type: String
accountServiceUsageBucketIsThresholdPerAccountService	"accountServiceUsageBucketIsThresholdPerAccountService": true Type: Boolean
accountServiceUsageBucketIsInfiniteLastTier	"accountServiceUsageBucketIsInfiniteLastTier": true Type: Boolean
usageBucketName READ-ONLY	"usageBucketName": "Hello World" Type: String The name of the bucket participating in the Share Plan.
usageBucketBaseUnitId READ-ONLY	"usageBucketBaseUnitId": 25 Type: Number The identifier that represents the BucketBaseUnit. For example time, data, or count.

End Points

Retrieve all of the ViewSharePlanBucketUsageByService objects.

GET api/v5/Account/SharePlan/BucketUsage/ByService/

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "accountSharePlanId": 9,
            "accountServiceUsageBucketId": 23,
            "accountServiceUsageBucketTotalUsageAmount": 15,
            "accountServiceUsageBucketTotalUsageConsumed": 1,
            "accountServiceUsageBucketIsAddOn": true,
            "packageId": 23,
            "packageName": "Sample Text Data",
            "serviceId": 19,
            "serviceName": "Sample Text Data",
            "quantity": 22,
            "usageConsumed": 17,
            "accountServiceUsageBucketRecurFrequency": 23,
            "accountServiceUsageBucketRecurFrequencyTypeId": 7,
            "accountServiceUsageBucketRecurFrequencyTypeName": "Sample Text Data",
            "accountServiceUsageBucketIsThresholdPerAccountService": true,
            "accountServiceUsageBucketIsInfiniteLastTier": true,
            "usageBucketName": "Sample Text Data",
            "usageBucketBaseUnitId": 7
        }
    ]
}

Retrieve all of the ViewSharePlanBucketUsageByService 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 ViewSharePlanBucketUsageByService objects in a paged fashion.

GET api/v5/Account/SharePlan/BucketUsage/ByService/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": [
            {
                "accountSharePlanId": 7,
                "accountServiceUsageBucketId": 4,
                "accountServiceUsageBucketTotalUsageAmount": 8,
                "accountServiceUsageBucketTotalUsageConsumed": 0,
                "accountServiceUsageBucketIsAddOn": true,
                "packageId": 10,
                "packageName": "Sample Text Data",
                "serviceId": 7,
                "serviceName": "Sample Text Data",
                "quantity": 9,
                "usageConsumed": 23,
                "accountServiceUsageBucketRecurFrequency": 19,
                "accountServiceUsageBucketRecurFrequencyTypeId": 17,
                "accountServiceUsageBucketRecurFrequencyTypeName": "Sample Text Data",
                "accountServiceUsageBucketIsThresholdPerAccountService": true,
                "accountServiceUsageBucketIsInfiniteLastTier": true,
                "usageBucketName": "Sample Text Data",
                "usageBucketBaseUnitId": 9
            }
        ]
    }
}