Account / Service / Usage / Bucket

What can you do with AccountServiceUsageBucket?

DELETE api/v1/Account/Service/Usage/Bucket/{id:int}
GET api/v1/Account/Service/Usage/Bucket
GET api/v1/Account/Service/Usage/Bucket/Metadata
GET api/v1/Account/Service/Usage/Bucket/Metadata/{option}
GET api/v1/Account/Service/Usage/Bucket/Paged
GET api/v1/Account/Service/Usage/Bucket/Paged/Detail
GET api/v1/Account/Service/Usage/Bucket/{id:int}
GET api/v1/Account/Service/Usage/Bucket/{id:int}/Detail
PATCH api/v1/Account/Service/Usage/Bucket/{id:int}
POST api/v1/Account/Service/Usage/Bucket
PUT api/v1/Account/Service/Usage/Bucket/{id:int}

Properties

Property Details

id	"id": 651 Type: Number This is the unique numeric identifier for the AccountServiceUsageBucket
usageBucketId	"usageBucketId": 44 Type: Number Unique identifier for the associated UsageBucket object.
accountServiceId	"accountServiceId": "Hello World" Type: String Unique identifier for the associated AccountService object.
refillFrequency	"refillFrequency": 795 Type: Number
refillFrequencyTypeId	"refillFrequencyTypeId": 738 Type: Number Unique identifier for the associated FrequencyType object.
effective	"effective": "2005-04-11T14:56:24" Type: Date
effectiveCancel	"effectiveCancel": "2005-04-11T14:56:24" Type: Date
prorate	"prorate": true Type: Boolean
isInfiniteLastTier	"isInfiniteLastTier": true Type: Boolean
isThresholdPerAccountService	"isThresholdPerAccountService": true Type: Boolean
usageBucketRefillTypeId	"usageBucketRefillTypeId": 374 Type: Number Unique identifier for the associated UsageBucketRefillType object.
expireAfterFrequency	"expireAfterFrequency": 918 Type: Number
expireAfterFrequencyTypeId	"expireAfterFrequencyTypeId": 417 Type: Number Unique identifier for the associated FrequencyType object.
expireAfterRecurrence	"expireAfterRecurrence": 389 Type: Number
accountPackageActivation	"accountPackageActivation": true Type: Boolean
isSharedAcrossPackage	"isSharedAcrossPackage": true Type: Boolean

Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

usageBucketId
accountServiceId
refillFrequency
refillFrequencyTypeId
effective
effectiveCancel
prorate
isInfiniteLastTier
isThresholdPerAccountService
usageBucketRefillTypeId
expireAfterFrequency
expireAfterFrequencyTypeId
expireAfterRecurrence
accountPackageActivation
isSharedAcrossPackage

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the AccountServiceUsageBucket object.

Standard PATCH objects:

accountServiceUsageBucketTier - create, update, delete
accountSharePlanContribution - create, update, delete

DataFlow PATCH objects:

accountServiceUsageBucket - create, update, delete
accountServiceUsageBucketTier - create, update, delete
accountSharePlanContribution - create, update, delete

End Points

DELETE	api/v1/Account/Service/Usage/Bucket/{id:int}
Delete an instance of the AccountServiceUsageBucket object.

GET	api/v1/Account/Service/Usage/Bucket
Retrieve all of the AccountServiceUsageBucket objects.

GET	api/v1/Account/Service/Usage/Bucket/Metadata
Retrieve all of the meta data details of the AccountServiceUsageBucket object.

GET	api/v1/Account/Service/Usage/Bucket/Metadata/{option}
Retrieve all the meta data details of the AccountServiceUsageBucket object based on provided options.
{option}	Metadata options for the AccountServiceUsageBucket object.

GET	api/v1/Account/Service/Usage/Bucket/Paged
Retreive all of the AccountServiceUsageBucket objects in a paged fashion.

GET	api/v1/Account/Service/Usage/Bucket/Paged/Detail
Retreive all of the AccountServiceUsageBucket objects in a paged fashion with all object details.

GET	api/v1/Account/Service/Usage/Bucket/{id:int}
Retrieve an instance of the AccountServiceUsageBucket object by it's ID.
{id:int}	Unique identifier for the AccountServiceUsageBucket object.

GET	api/v1/Account/Service/Usage/Bucket/{id:int}/Detail
Retreive all of the Detail objects for the specified AccountServiceUsageBucket.
{id:int}	Unique identifier for the AccountServiceUsageBucket object.

PATCH	api/v1/Account/Service/Usage/Bucket/{id:int}
Update the AccountServiceUsageBucket object and optionally make changes to any child objects.

POST	api/v1/Account/Service/Usage/Bucket
Create a new instance of the AccountServiceUsageBucket object.

PUT	api/v1/Account/Service/Usage/Bucket/{id:int}
Update an existing instance of the AccountServiceUsageBucket object.