Usage / Rate / Plan

(API Version v2)

What can you do with UsageRatePlan?

DELETE api/v2/Usage/Rate/Plan/{id:int}
GET api/v2/Usage/Rate/Plan
GET api/v2/Usage/Rate/Plan/Paged
GET api/v2/Usage/Rate/Plan/Paged/Detail
GET api/v2/Usage/Rate/Plan/{id:int}
GET api/v2/Usage/Rate/Plan/{id:int}/Detail
PATCH api/v2/Usage/Rate/Plan/{id:int}
POST api/v2/Usage/Rate/Plan
PUT api/v2/Usage/Rate/Plan/{id:int}

Properties

Property Details

id	"id": 15 Type: Number This is the unique numeric identifier for the UsageRatePlan
ownerId	"ownerId": 4 Type: Number Unique identifier for the associated Owner object.
name	"name": "Hello World" Type: String
displayName	"displayName": "Hello World" Type: String
amountPrecision	"amountPrecision": 11 Type: Number

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:

name
displayName
amountPrecision

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 UsageRatePlan object.

Standard PATCH objects:

usageRateGroup - attach, detach, update

DataFlow PATCH objects:

usageRatePlan - create, update, delete
usageRateGroup - attach, detach, update

End Points

DELETE	api/v2/Usage/Rate/Plan/{id:int}
Delete an instance of the UsageRatePlan object.

GET	api/v2/Usage/Rate/Plan
Retrieve all of the UsageRatePlan objects.

GET	api/v2/Usage/Rate/Plan/Paged
Retreive all of the UsageRatePlan objects in a paged fashion.

GET	api/v2/Usage/Rate/Plan/Paged/Detail
Retreive all of the UsageRatePlan objects in a paged fashion with all object details.

GET	api/v2/Usage/Rate/Plan/{id:int}
Retrieve an instance of the UsageRatePlan object by it's ID.
{id:int}	Unique identifier for the UsageRatePlan object.

GET	api/v2/Usage/Rate/Plan/{id:int}/Detail
Retreive all of the Detail objects for the specified UsageRatePlan.
{id:int}	Unique identifier for the UsageRatePlan object.

PATCH	api/v2/Usage/Rate/Plan/{id:int}
Update the UsageRatePlan object and optionally make changes to any child objects.

POST	api/v2/Usage/Rate/Plan
Create a new instance of the UsageRatePlan object.

PUT	api/v2/Usage/Rate/Plan/{id:int}
Update an existing instance of the UsageRatePlan object.