TAG LINE
SMALL TITLE

Account / Service / Usage / Bucket

(API Version v2)


What can you do with AccountServiceUsageBucket?


Properties

Property Details
id
"id": 27
Type: Number
This is the unique numeric identifier for the AccountServiceUsageBucket
usageBucketId
"usageBucketId": 22
Type: Number
Unique identifier for the associated UsageBucket object.
accountServiceId
"accountServiceId": "Hello World"
Type: String
Unique identifier for the associated AccountService object.
refillFrequency
"refillFrequency": 20
Type: Number
refillFrequencyTypeId
"refillFrequencyTypeId": 27
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": 25
Type: Number
Unique identifier for the associated UsageBucketRefillType object.
expireAfterFrequency
"expireAfterFrequency": 15
Type: Number
expireAfterFrequencyTypeId
"expireAfterFrequencyTypeId": 24
Type: Number
Unique identifier for the associated FrequencyType object.
expireAfterRecurrence
"expireAfterRecurrence": 21
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:

DataFlow PATCH objects:


End Points

DELETEapi/v2/Account/Service/Usage/Bucket/{id:int}
Delete an instance of the AccountServiceUsageBucket object.
GETapi/v2/Account/Service/Usage/Bucket
Retrieve all of the AccountServiceUsageBucket objects.
GETapi/v2/Account/Service/Usage/Bucket/Paged
Retreive all of the AccountServiceUsageBucket objects in a paged fashion.
GETapi/v2/Account/Service/Usage/Bucket/Paged/Detail
Retreive all of the AccountServiceUsageBucket objects in a paged fashion with all object details.
GETapi/v2/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.
GETapi/v2/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.
PATCHapi/v2/Account/Service/Usage/Bucket/{id:int}
Update the AccountServiceUsageBucket object and optionally make changes to any child objects.
POSTapi/v2/Account/Service/Usage/Bucket
Create a new instance of the AccountServiceUsageBucket object.
PUTapi/v2/Account/Service/Usage/Bucket/{id:int}
Update an existing instance of the AccountServiceUsageBucket object.