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": 13 Type: Number |
accountServiceUsageBucketId READ-ONLY | "accountServiceUsageBucketId": 27 Type: Number The Identity or ID of the bucket that is part of this Account Share Plan. |
accountServiceUsageBucketTotalUsageAmount READ-ONLY | "accountServiceUsageBucketTotalUsageAmount": 10 Type: Number The total usage amount for the bucket as part of this Account Share Plan. |
accountServiceUsageBucketTotalUsageConsumed READ-ONLY | "accountServiceUsageBucketTotalUsageConsumed": 20 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": 20 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": 2 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": 2 Type: Number The number of services defined by serviceId that are part of this Account Share Plan. |
usageConsumed READ-ONLY | "usageConsumed": "Hello World" Type: String How much usage have all the included packages/services consumed. |
accountServiceUsageBucketRecurFrequency | "accountServiceUsageBucketRecurFrequency": 2 Type: Number The frequency of the usage bucket, e.g. 6. |
accountServiceUsageBucketRecurFrequencyTypeId | "accountServiceUsageBucketRecurFrequencyTypeId": 18 Type: Number The frequency type ID of the usage bucket. |
accountServiceUsageBucketRecurFrequencyTypeName | "accountServiceUsageBucketRecurFrequencyTypeName": "Hello World" Type: String The frequency type name of the usage bucket, e.g. Month. |
accountServiceUsageBucketIsThresholdPerAccountService | "accountServiceUsageBucketIsThresholdPerAccountService": true Type: Boolean Whether or not the bucket threshold is per account service. |
accountServiceUsageBucketIsInfiniteLastTier | "accountServiceUsageBucketIsInfiniteLastTier": true Type: Boolean Whether or not the bucket has an infinite final tier. |
usageBucketId | "usageBucketId": 19 Type: Number The ID of the Bucket. |
usageBucketName READ-ONLY | "usageBucketName": "Hello World" Type: String The name of the bucket participating in the Share Plan. |
usageBucketBaseUnitId READ-ONLY | "usageBucketBaseUnitId": 1 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": 16, "accountServiceUsageBucketId": 26, "accountServiceUsageBucketTotalUsageAmount": 11, "accountServiceUsageBucketTotalUsageConsumed": 26, "accountServiceUsageBucketIsAddOn": true, "packageId": 5, "packageName": "Sample Text Data", "serviceId": 0, "serviceName": "Sample Text Data", "quantity": 14, "usageConsumed": "Sample Text Data", "accountServiceUsageBucketRecurFrequency": 11, "accountServiceUsageBucketRecurFrequencyTypeId": 19, "accountServiceUsageBucketRecurFrequencyTypeName": "Sample Text Data", "accountServiceUsageBucketIsThresholdPerAccountService": true, "accountServiceUsageBucketIsInfiniteLastTier": true, "usageBucketId": 26, "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": 6, "accountServiceUsageBucketId": 15, "accountServiceUsageBucketTotalUsageAmount": 9, "accountServiceUsageBucketTotalUsageConsumed": 17, "accountServiceUsageBucketIsAddOn": true, "packageId": 11, "packageName": "Sample Text Data", "serviceId": 16, "serviceName": "Sample Text Data", "quantity": 22, "usageConsumed": "Sample Text Data", "accountServiceUsageBucketRecurFrequency": 18, "accountServiceUsageBucketRecurFrequencyTypeId": 26, "accountServiceUsageBucketRecurFrequencyTypeName": "Sample Text Data", "accountServiceUsageBucketIsThresholdPerAccountService": true, "accountServiceUsageBucketIsInfiniteLastTier": true, "usageBucketId": 7, "usageBucketName": "Sample Text Data", "usageBucketBaseUnitId": 25 } ] } } |