TAG LINE
TAG LINE
SMALL TITLE
This object provides a view into which services are actively participating in a Share Plan assigned to an Account.
accountSharePlanId | "accountSharePlanId": 0 Type: Number |
accountServiceUsageBucketId READ-ONLY | "accountServiceUsageBucketId": 24 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": 13 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": 8 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": 21 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": 18 Type: Number The number of services defined by serviceId that are part of this Account Share Plan. |
usageConsumed READ-ONLY | "usageConsumed": 22 Type: Number How much usage have all the included packages/services consumed. |
accountServiceUsageBucketRecurFrequency | "accountServiceUsageBucketRecurFrequency": 9 Type: Number |
accountServiceUsageBucketRecurFrequencyTypeId | "accountServiceUsageBucketRecurFrequencyTypeId": 5 Type: Number |
accountServiceUsageBucketRecurFrequencyTypeName | "accountServiceUsageBucketRecurFrequencyTypeName": "Hello World" Type: String |
accountServiceUsageBucketIsThresholdPerAccountService | "accountServiceUsageBucketIsThresholdPerAccountService": true Type: Boolean |
accountServiceUsageBucketIsInfiniteLastTier | "accountServiceUsageBucketIsInfiniteLastTier": true Type: Boolean |
usageBucketId | "usageBucketId": 7 Type: Number |
usageBucketName READ-ONLY | "usageBucketName": "Hello World" Type: String The name of the bucket participating in the Share Plan. |
usageBucketBaseUnitId READ-ONLY | "usageBucketBaseUnitId": 9 Type: Number The identifier that represents the BucketBaseUnit. For example time, data, or count. |
GET | Account/SharePlan/BucketUsage/ByService/ |
Retrieve all of the ViewSharePlanBucketUsageByService objects. | |
Retrieve all of the ViewSharePlanBucketUsageByService objects. GET Account/SharePlan/BucketUsage/ByService/ HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "totalCount": 1, "items": [ { "accountSharePlanId": 12, "accountServiceUsageBucketId": 19, "accountServiceUsageBucketTotalUsageAmount": 9, "accountServiceUsageBucketTotalUsageConsumed": 27, "accountServiceUsageBucketIsAddOn": true, "packageId": 13, "packageName": "Sample Text Data", "serviceId": 23, "serviceName": "Sample Text Data", "quantity": 8, "usageConsumed": 3, "accountServiceUsageBucketRecurFrequency": 15, "accountServiceUsageBucketRecurFrequencyTypeId": 4, "accountServiceUsageBucketRecurFrequencyTypeName": "Sample Text Data", "accountServiceUsageBucketIsThresholdPerAccountService": true, "accountServiceUsageBucketIsInfiniteLastTier": true, "usageBucketId": 24, "usageBucketName": "Sample Text Data", "usageBucketBaseUnitId": 26 } ] } |
GET | Account/SharePlan/BucketUsage/ByService/Paged |
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 Account/SharePlan/BucketUsage/ByService/Paged HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "pagination": { "pageNumber": 1, "pageSize": 20, "excludeTotalCount": false }, "pagedResults": { "totalCount": 1, "items": [ { "accountSharePlanId": 13, "accountServiceUsageBucketId": 16, "accountServiceUsageBucketTotalUsageAmount": 4, "accountServiceUsageBucketTotalUsageConsumed": 12, "accountServiceUsageBucketIsAddOn": true, "packageId": 25, "packageName": "Sample Text Data", "serviceId": 25, "serviceName": "Sample Text Data", "quantity": 3, "usageConsumed": 23, "accountServiceUsageBucketRecurFrequency": 5, "accountServiceUsageBucketRecurFrequencyTypeId": 16, "accountServiceUsageBucketRecurFrequencyTypeName": "Sample Text Data", "accountServiceUsageBucketIsThresholdPerAccountService": true, "accountServiceUsageBucketIsInfiniteLastTier": true, "usageBucketId": 0, "usageBucketName": "Sample Text Data", "usageBucketBaseUnitId": 14 } ] } } |