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": 27 Type: Number |
accountServiceUsageBucketId READ-ONLY | "accountServiceUsageBucketId": 20 Type: Number The Identity or ID of the bucket that is part of this Account Share Plan. |
accountServiceUsageBucketTotalUsageAmount READ-ONLY | "accountServiceUsageBucketTotalUsageAmount": 11 Type: Number The total usage amount for the bucket as part of this Account Share Plan. |
accountServiceUsageBucketTotalUsageConsumed READ-ONLY | "accountServiceUsageBucketTotalUsageConsumed": 12 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": 10 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": 5 Type: Number The number of services defined by serviceId that are part of this Account Share Plan. |
usageConsumed READ-ONLY | "usageConsumed": 3 Type: Number How much usage have all the included packages/services consumed. |
accountServiceUsageBucketRecurFrequency | "accountServiceUsageBucketRecurFrequency": 24 Type: Number |
accountServiceUsageBucketRecurFrequencyTypeId | "accountServiceUsageBucketRecurFrequencyTypeId": 0 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": 12 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": 24, "accountServiceUsageBucketId": 18, "accountServiceUsageBucketTotalUsageAmount": 20, "accountServiceUsageBucketTotalUsageConsumed": 9, "accountServiceUsageBucketIsAddOn": true, "packageId": 27, "packageName": "Sample Text Data", "serviceId": 19, "serviceName": "Sample Text Data", "quantity": 14, "usageConsumed": 27, "accountServiceUsageBucketRecurFrequency": 16, "accountServiceUsageBucketRecurFrequencyTypeId": 26, "accountServiceUsageBucketRecurFrequencyTypeName": "Sample Text Data", "accountServiceUsageBucketIsThresholdPerAccountService": true, "accountServiceUsageBucketIsInfiniteLastTier": true, "usageBucketName": "Sample Text Data", "usageBucketBaseUnitId": 14 } ] } |
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": 20, "accountServiceUsageBucketId": 19, "accountServiceUsageBucketTotalUsageAmount": 19, "accountServiceUsageBucketTotalUsageConsumed": 19, "accountServiceUsageBucketIsAddOn": true, "packageId": 17, "packageName": "Sample Text Data", "serviceId": 12, "serviceName": "Sample Text Data", "quantity": 16, "usageConsumed": 9, "accountServiceUsageBucketRecurFrequency": 25, "accountServiceUsageBucketRecurFrequencyTypeId": 1, "accountServiceUsageBucketRecurFrequencyTypeName": "Sample Text Data", "accountServiceUsageBucketIsThresholdPerAccountService": true, "accountServiceUsageBucketIsInfiniteLastTier": true, "usageBucketName": "Sample Text Data", "usageBucketBaseUnitId": 25 } ] } |
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": 3, "accountServiceUsageBucketId": 12, "accountServiceUsageBucketTotalUsageAmount": 22, "accountServiceUsageBucketTotalUsageConsumed": 10, "accountServiceUsageBucketIsAddOn": true, "packageId": 24, "packageName": "Sample Text Data", "serviceId": 9, "serviceName": "Sample Text Data", "quantity": 7, "usageConsumed": 9, "accountServiceUsageBucketRecurFrequency": 15, "accountServiceUsageBucketRecurFrequencyTypeId": 2, "accountServiceUsageBucketRecurFrequencyTypeName": "Sample Text Data", "accountServiceUsageBucketIsThresholdPerAccountService": true, "accountServiceUsageBucketIsInfiniteLastTier": true, "usageBucketName": "Sample Text Data", "usageBucketBaseUnitId": 23 } ] } |
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": 24, "accountServiceUsageBucketId": 3, "accountServiceUsageBucketTotalUsageAmount": 20, "accountServiceUsageBucketTotalUsageConsumed": 18, "accountServiceUsageBucketIsAddOn": true, "packageId": 7, "packageName": "Sample Text Data", "serviceId": 23, "serviceName": "Sample Text Data", "quantity": 14, "usageConsumed": 15, "accountServiceUsageBucketRecurFrequency": 2, "accountServiceUsageBucketRecurFrequencyTypeId": 8, "accountServiceUsageBucketRecurFrequencyTypeName": "Sample Text Data", "accountServiceUsageBucketIsThresholdPerAccountService": true, "accountServiceUsageBucketIsInfiniteLastTier": true, "usageBucketName": "Sample Text Data", "usageBucketBaseUnitId": 27 } ] } |
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": 4, "accountServiceUsageBucketId": 3, "accountServiceUsageBucketTotalUsageAmount": 19, "accountServiceUsageBucketTotalUsageConsumed": 10, "accountServiceUsageBucketIsAddOn": true, "packageId": 13, "packageName": "Sample Text Data", "serviceId": 11, "serviceName": "Sample Text Data", "quantity": 27, "usageConsumed": 2, "accountServiceUsageBucketRecurFrequency": 23, "accountServiceUsageBucketRecurFrequencyTypeId": 9, "accountServiceUsageBucketRecurFrequencyTypeName": "Sample Text Data", "accountServiceUsageBucketIsThresholdPerAccountService": true, "accountServiceUsageBucketIsInfiniteLastTier": true, "usageBucketName": "Sample Text Data", "usageBucketBaseUnitId": 16 } ] } |
GET | Account/SharePlan/BucketUsage/ByService/Metadata |
Retrieve all of the ViewSharePlanBucketUsageByService objects. | |
Retrieve all of the ViewSharePlanBucketUsageByService objects. GET Account/SharePlan/BucketUsage/ByService/Metadata HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "totalCount": 1, "items": [ { "accountSharePlanId": 5, "accountServiceUsageBucketId": 15, "accountServiceUsageBucketTotalUsageAmount": 20, "accountServiceUsageBucketTotalUsageConsumed": 3, "accountServiceUsageBucketIsAddOn": true, "packageId": 11, "packageName": "Sample Text Data", "serviceId": 5, "serviceName": "Sample Text Data", "quantity": 25, "usageConsumed": 9, "accountServiceUsageBucketRecurFrequency": 18, "accountServiceUsageBucketRecurFrequencyTypeId": 25, "accountServiceUsageBucketRecurFrequencyTypeName": "Sample Text Data", "accountServiceUsageBucketIsThresholdPerAccountService": true, "accountServiceUsageBucketIsInfiniteLastTier": true, "usageBucketName": "Sample Text Data", "usageBucketBaseUnitId": 6 } ] } |
GET | Account/SharePlan/BucketUsage/ByService/Metadata/sql |
Retrieve all of the ViewSharePlanBucketUsageByService objects. | |
Retrieve all of the ViewSharePlanBucketUsageByService objects. GET Account/SharePlan/BucketUsage/ByService/Metadata/sql HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "totalCount": 1, "items": [ { "accountSharePlanId": 26, "accountServiceUsageBucketId": 7, "accountServiceUsageBucketTotalUsageAmount": 12, "accountServiceUsageBucketTotalUsageConsumed": 25, "accountServiceUsageBucketIsAddOn": true, "packageId": 3, "packageName": "Sample Text Data", "serviceId": 7, "serviceName": "Sample Text Data", "quantity": 4, "usageConsumed": 19, "accountServiceUsageBucketRecurFrequency": 13, "accountServiceUsageBucketRecurFrequencyTypeId": 0, "accountServiceUsageBucketRecurFrequencyTypeName": "Sample Text Data", "accountServiceUsageBucketIsThresholdPerAccountService": true, "accountServiceUsageBucketIsInfiniteLastTier": true, "usageBucketName": "Sample Text Data", "usageBucketBaseUnitId": 22 } ] } |
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": 14, "accountServiceUsageBucketId": 3, "accountServiceUsageBucketTotalUsageAmount": 23, "accountServiceUsageBucketTotalUsageConsumed": 24, "accountServiceUsageBucketIsAddOn": true, "packageId": 14, "packageName": "Sample Text Data", "serviceId": 19, "serviceName": "Sample Text Data", "quantity": 2, "usageConsumed": 24, "accountServiceUsageBucketRecurFrequency": 8, "accountServiceUsageBucketRecurFrequencyTypeId": 16, "accountServiceUsageBucketRecurFrequencyTypeName": "Sample Text Data", "accountServiceUsageBucketIsThresholdPerAccountService": true, "accountServiceUsageBucketIsInfiniteLastTier": true, "usageBucketName": "Sample Text Data", "usageBucketBaseUnitId": 6 } ] } } |
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": 21, "accountServiceUsageBucketId": 20, "accountServiceUsageBucketTotalUsageAmount": 5, "accountServiceUsageBucketTotalUsageConsumed": 18, "accountServiceUsageBucketIsAddOn": true, "packageId": 4, "packageName": "Sample Text Data", "serviceId": 17, "serviceName": "Sample Text Data", "quantity": 22, "usageConsumed": 12, "accountServiceUsageBucketRecurFrequency": 23, "accountServiceUsageBucketRecurFrequencyTypeId": 3, "accountServiceUsageBucketRecurFrequencyTypeName": "Sample Text Data", "accountServiceUsageBucketIsThresholdPerAccountService": true, "accountServiceUsageBucketIsInfiniteLastTier": true, "usageBucketName": "Sample Text Data", "usageBucketBaseUnitId": 7 } ] } } |
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": 10, "accountServiceUsageBucketId": 15, "accountServiceUsageBucketTotalUsageAmount": 25, "accountServiceUsageBucketTotalUsageConsumed": 23, "accountServiceUsageBucketIsAddOn": true, "packageId": 24, "packageName": "Sample Text Data", "serviceId": 18, "serviceName": "Sample Text Data", "quantity": 27, "usageConsumed": 1, "accountServiceUsageBucketRecurFrequency": 8, "accountServiceUsageBucketRecurFrequencyTypeId": 6, "accountServiceUsageBucketRecurFrequencyTypeName": "Sample Text Data", "accountServiceUsageBucketIsThresholdPerAccountService": true, "accountServiceUsageBucketIsInfiniteLastTier": true, "usageBucketName": "Sample Text Data", "usageBucketBaseUnitId": 24 } ] } } |
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": 7, "accountServiceUsageBucketId": 23, "accountServiceUsageBucketTotalUsageAmount": 9, "accountServiceUsageBucketTotalUsageConsumed": 7, "accountServiceUsageBucketIsAddOn": true, "packageId": 8, "packageName": "Sample Text Data", "serviceId": 7, "serviceName": "Sample Text Data", "quantity": 12, "usageConsumed": 7, "accountServiceUsageBucketRecurFrequency": 23, "accountServiceUsageBucketRecurFrequencyTypeId": 8, "accountServiceUsageBucketRecurFrequencyTypeName": "Sample Text Data", "accountServiceUsageBucketIsThresholdPerAccountService": true, "accountServiceUsageBucketIsInfiniteLastTier": true, "usageBucketName": "Sample Text Data", "usageBucketBaseUnitId": 1 } ] } } |
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": 9, "accountServiceUsageBucketId": 22, "accountServiceUsageBucketTotalUsageAmount": 2, "accountServiceUsageBucketTotalUsageConsumed": 5, "accountServiceUsageBucketIsAddOn": true, "packageId": 23, "packageName": "Sample Text Data", "serviceId": 3, "serviceName": "Sample Text Data", "quantity": 27, "usageConsumed": 15, "accountServiceUsageBucketRecurFrequency": 9, "accountServiceUsageBucketRecurFrequencyTypeId": 6, "accountServiceUsageBucketRecurFrequencyTypeName": "Sample Text Data", "accountServiceUsageBucketIsThresholdPerAccountService": true, "accountServiceUsageBucketIsInfiniteLastTier": true, "usageBucketName": "Sample Text Data", "usageBucketBaseUnitId": 14 } ] } } |