TAG LINE
TAG LINE
SMALL TITLE

Usage / Rate / Plan

(API Version v6)


Defines a container that holds multiple Rate Groups. These are assigned to Packages within the system.


What can you do with UsageRatePlan?


Properties

Property Details
identity
READ-ONLY
"identity": 25
Type: Number
This is the unique numeric identifier for the UsageRatePlan
ownerId
READ-ONLY
"ownerId": 8
Type: Number
Unique identifier for the associated Owner object.
ownerName
READ-ONLY
"ownerName": "Sample Name"
Type: String
The name of the object associated with the ownerId property.
name
"name": "All Data Rates"
Type: String
The user defined name for the Rate Plan
displayName
"displayName": "Gold Rates"
Type: String
The user defined "friendly" name for this Rate Plan to display on reports etc.
amountPrecision
"amountPrecision": 15
Type: Number
The number of decimal places to round. Maximum of 11.


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. Below you will find the child objects that can be updated as part of PATCH operations for the UsageRatePlan object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEUsage/Rate/Plan/{id}
Delete an instance of the UsageRatePlan object. Upon successful delete, this API will return a record of all of the reelated objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system.
{id}Unique identifier for the UsageRatePlan object.
Delete an instance of the UsageRatePlan object.
DELETE Usage/Rate/Plan/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "delete",
    "results": {
        "totalCount": 4,
        "items": [
            {
                "identity": 1,
                "action": "deleted",
                "dtoTypeKey": "usageRatePlan"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETUsage/Rate/Plan/
Retrieve all of the UsageRatePlan objects.
Retrieve all of the UsageRatePlan objects.
GET Usage/Rate/Plan/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 20,
            "ownerName": "Sample Text Data",
            "name": "All Data Rates",
            "displayName": "Gold Rates",
            "amountPrecision": 25
        }
    ]
}
GETUsage/Rate/Plan/Paged
Retrieve all of the UsageRatePlan 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 UsageRatePlan objects in a paged fashion.
GET Usage/Rate/Plan/Paged
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 19,
                "ownerName": "Sample Text Data",
                "name": "All Data Rates",
                "displayName": "Gold Rates",
                "amountPrecision": 0
            }
        ]
    }
}
GETUsage/Rate/Plan/Paged/Detail
Retrieve all of the UsageRatePlan objects in a paged fashion with all object details. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
Retrieve all of the UsageRatePlan objects in a paged fashion with all object details.
GET Usage/Rate/Plan/Paged/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 23,
                "ownerName": "Sample Text Data",
                "name": "All Data Rates",
                "displayName": "Gold Rates",
                "amountPrecision": 9,
                "details": {
                    "usageRateGroups": [
                        {
                            "identity": 14,
                            "name": "Sample Text Data",
                            "start": "2021-04-26T15:25:27.587Z",
                            "end": "2021-04-26T15:25:27.587Z",
                            "useForCost": true,
                            "timePeriodId": 80,
                            "timePeriodName": "Sample Text Data",
                            "displayName": "Sample Text Data",
                            "currencyId": 37,
                            "currencyName": "Sample Text Data",
                            "isAggregated": true,
                            "priority": 67,
                            "isPassThrough": true,
                            "amountPrecision": 21,
                            "roundingMethodTypeId": 2,
                            "roundingMethodTypeName": "Sample Text Data",
                            "created": "2021-04-26T15:25:27.587Z",
                            "updated": "2021-04-26T15:25:27.587Z",
                            "currencyCode": "Sample Text Data"
                        }
                    ]
                }
            }
        ]
    }
}
GETUsage/Rate/Plan/{id}
Retrieve an instance of the UsageRatePlan object by its ID.
{id}Unique identifier for the UsageRatePlan object.
Retrieve an instance of the UsageRatePlan object by its ID.
GET Usage/Rate/Plan/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 11,
        "ownerName": "Sample Text Data",
        "name": "All Data Rates",
        "displayName": "Gold Rates",
        "amountPrecision": 17
    }
}
GETUsage/Rate/Plan/{id}/Detail
Retrieve deep detail of the UsageRatePlan object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
{id}Unique identifier for the UsageRatePlan object.
Retrieve deep detail of the UsageRatePlan object by its ID.
GET Usage/Rate/Plan/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 16,
        "ownerName": "Sample Text Data",
        "name": "All Data Rates",
        "displayName": "Gold Rates",
        "amountPrecision": 12,
        "details": {
            "usageRateGroups": [
                {
                    "identity": 14,
                    "name": "Sample Text Data",
                    "start": "2021-04-26T15:25:27.587Z",
                    "end": "2021-04-26T15:25:27.587Z",
                    "useForCost": true,
                    "timePeriodId": 80,
                    "timePeriodName": "Sample Text Data",
                    "displayName": "Sample Text Data",
                    "currencyId": 37,
                    "currencyName": "Sample Text Data",
                    "isAggregated": true,
                    "priority": 67,
                    "isPassThrough": true,
                    "amountPrecision": 21,
                    "roundingMethodTypeId": 2,
                    "roundingMethodTypeName": "Sample Text Data",
                    "created": "2021-04-26T15:25:27.587Z",
                    "updated": "2021-04-26T15:25:27.587Z",
                    "currencyCode": "Sample Text Data"
                }
            ]
        }
    }
}
PATCHUsage/Rate/Plan/{id}
Update or Add the UsageRatePlan object and optionally make changes to any child objects. Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array.
{id}Unique identifier for the UsageRatePlan object.
Update or Add the UsageRatePlan object and optionally make changes to any child objects.
PATCH Usage/Rate/Plan/{id}

{
    "details": {},
    "usageRatePlans": {
        "items": [
            {
                "patchType": "create",
                "patchClientId": 1,
                "name": "All Data Rates",
                "displayName": "Gold Rates",
                "amountPrecision": 2
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "patch",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "action": "created",
                "dtoTypeKey": "usageRatePlan",
                "instance": {
                    "identity": 1,
                    "ownerId": 19,
                    "ownerName": "Sample Text Data",
                    "name": "All Data Rates",
                    "displayName": "Gold Rates",
                    "amountPrecision": 17
                }
            }
        ]
    }
}
POSTUsage/Rate/Plan/
Create a new instance of the UsageRatePlan object.
Create a new instance of the UsageRatePlan object.
POST Usage/Rate/Plan/

{
    "name": "All Data Rates",
    "displayName": "Gold Rates",
    "amountPrecision": 5
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 7,
                "ownerName": "Sample Text Data",
                "name": "All Data Rates",
                "displayName": "Gold Rates",
                "amountPrecision": 24
            }
        ]
    }
}
PUTUsage/Rate/Plan/{id}
Update an existing instance of the UsageRatePlan object.
Update an existing instance of the UsageRatePlan object.
PUT Usage/Rate/Plan/{id}

{
    "identity": 1,
    "name": "All Data Rates",
    "displayName": "Gold Rates",
    "amountPrecision": 2
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 11,
                "ownerName": "Sample Text Data",
                "name": "All Data Rates",
                "displayName": "Gold Rates",
                "amountPrecision": 13
            }
        ]
    }
}