TAG LINE
TAG LINE
SMALL TITLE

Rate Plan

(API Version v8)


Rate plans contain rate groups and rate groups contain rates.


What can you do with RatePlan?

  • DELETE RatePlan/{id}
    Delete an instance of the RatePlan object.

  • GET RatePlan/
    Retrieve all of the RatePlan objects.

  • GET RatePlan/Paged
    Retrieve all of the RatePlan objects in a paged fashion.

  • GET RatePlan/Paged/Detail
    Retrieve all of the RatePlan objects in a paged fashion with all object details.

  • GET RatePlan/{id}
    Retrieve an instance of the RatePlan object by its ID.

  • GET RatePlan/{id}/Detail
    Retrieve deep detail of the RatePlan object by its ID.

  • PATCH RatePlan/{id}
    Update or Add the RatePlan object and optionally make changes to any child objects.

  • POST RatePlan/
    Create a new instance of the RatePlan object.

  • PUT RatePlan/{id}
    Update an existing instance of the RatePlan object.


Properties

Property Details
identity
READ-ONLY
"identity": 4
Type: Number
This is the unique numeric identifier for the RatePlan
ownerId
READ-ONLY
"ownerId": 23
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": "Gold Rate Plan"
Type: String
User defined name for the Rate Plan.
displayName
"displayName": "Hello World"
Type: String
updated
READ-ONLY
"updated": "2021-04-26T15:25:27.587Z"
Type: Date
The date time stamp when this record was updated. Date and time values are specified in the ISO 8601 format.


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

Standard PATCH objects:

  • viewUsageRateGroupForRatePlan - create, update, delete

DataFlow PATCH objects:

  • ratePlan - create, update, delete
  • viewUsageRateGroupForRatePlan - create, update, delete

End Points

DELETERatePlan/{id}
Delete an instance of the RatePlan object. Upon successful delete, this API will return a record of all of the related 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 RatePlan object.
Delete an instance of the RatePlan object.
DELETE RatePlan/{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": "ratePlan"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETRatePlan/
Retrieve all of the RatePlan objects.
Retrieve all of the RatePlan objects.
GET RatePlan/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 16,
            "ownerName": "Sample Text Data",
            "name": "Gold Rate Plan",
            "displayName": "Sample Text Data",
            "updated": "2021-04-26T15:25:27.587Z"
        }
    ]
}
GETRatePlan/Paged
Retrieve all of the RatePlan 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 RatePlan objects in a paged fashion.
GET RatePlan/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": 10,
                "ownerName": "Sample Text Data",
                "name": "Gold Rate Plan",
                "displayName": "Sample Text Data",
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
GETRatePlan/Paged/Detail
Retrieve all of the RatePlan 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 RatePlan objects in a paged fashion with all object details.
GET RatePlan/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": 17,
                "ownerName": "Sample Text Data",
                "name": "Gold Rate Plan",
                "displayName": "Sample Text Data",
                "updated": "2021-04-26T15:25:27.587Z",
                "details": {
                    "usageRateGroups": [
                        {
                            "identity": 33,
                            "name": "Sample Text Data",
                            "start": "2021-04-26T15:25:27.587Z",
                            "end": "2021-04-26T15:25:27.587Z",
                            "useForCost": true,
                            "timePeriodId": 21,
                            "timePeriodName": "Sample Text Data",
                            "displayName": "Sample Text Data",
                            "currencyId": 52,
                            "currencyName": "Sample Text Data",
                            "currencyCode": "Sample Text Data",
                            "isAggregated": true,
                            "isPassThrough": true,
                            "amountPrecision": 44,
                            "roundingMethodTypeId": 52,
                            "roundingMethodTypeName": "Sample Text Data",
                            "usageRatePlanId": 78,
                            "usageRatePlanName": "Sample Text Data",
                            "priority": 59,
                            "generalLedgerId": 43,
                            "generalLedgerName": "Sample Text Data",
                            "isTaxInclusive": true,
                            "details": {
                                "rateGroupFilters": [
                                    {
                                        "identity": 24,
                                        "usageRateGroupId": 75,
                                        "usageRateGroupName": "Sample Text Data",
                                        "field": "Sample Text Data",
                                        "value": "Sample Text Data",
                                        "operatorTypeId": 58,
                                        "operatorTypeName": "Sample Text Data",
                                        "sortOrder": 44
                                    }
                                ],
                                "rates": [
                                    {
                                        "identity": 99,
                                        "usageRateGroupId": 61,
                                        "usageRateGroupName": "Sample Text Data",
                                        "usageClassId": 45,
                                        "usageClassName": "Sample Text Data",
                                        "amount": 30.89,
                                        "geoTreeLocationId": 32,
                                        "geoTreeLocationName": "Sample Text Data",
                                        "additional": true,
                                        "retired": true,
                                        "usageRoundingId": 65,
                                        "usageRoundingName": "Sample Text Data",
                                        "displayName": "Sample Text Data",
                                        "geoTreeLocationGroupId": 44,
                                        "geoTreeLocationGroupName": "Sample Text Data",
                                        "minimumCharge": 97.58,
                                        "usageUnitId": 68,
                                        "usageUnitName": "Sample Text Data",
                                        "usageRateCalculationTypeId": 47,
                                        "usageRateCalculationTypeName": "Sample Text Data",
                                        "created": "2021-04-26T15:25:27.587Z",
                                        "updated": "2021-04-26T15:25:27.587Z",
                                        "generalLedgerId": 19,
                                        "generalLedgerName": "Sample Text Data",
                                        "serviceTaxCategoryId": 62,
                                        "serviceTaxCategoryName": "Sample Text Data",
                                        "usageBaseUnitId": 15,
                                        "usageBaseUnitName": "Sample Text Data",
                                        "isAggregated": true,
                                        "details": {
                                            "usageRateTierConfiguration": {
                                                "identity": 59,
                                                "usageRateId": 26,
                                                "pricePlanTierTypeId": 22,
                                                "pricePlanTierTypeName": "Sample Text Data",
                                                "countingRuleId": 41,
                                                "countingRuleName": "Sample Text Data",
                                                "details": {
                                                    "usageRateTiers": [
                                                        {
                                                            "identity": 92,
                                                            "usageUnitId": 45,
                                                            "usageUnitName": "Sample Text Data",
                                                            "usageRateTierConfigurationId": 93,
                                                            "threshold": 0,
                                                            "amount": 99.01,
                                                            "created": "2021-04-26T15:25:27.587Z",
                                                            "updated": "2021-04-26T15:25:27.587Z"
                                                        }
                                                    ]
                                                }
                                            }
                                        }
                                    }
                                ]
                            }
                        }
                    ]
                }
            }
        ]
    }
}
GETRatePlan/{id}
Retrieve an instance of the RatePlan object by its ID.
{id}Unique identifier for the RatePlan object.
Retrieve an instance of the RatePlan object by its ID.
GET RatePlan/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 9,
        "ownerName": "Sample Text Data",
        "name": "Gold Rate Plan",
        "displayName": "Sample Text Data",
        "updated": "2021-04-26T15:25:27.587Z"
    }
}
GETRatePlan/{id}/Detail
Retrieve deep detail of the RatePlan 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 RatePlan object.
Retrieve deep detail of the RatePlan object by its ID.
GET RatePlan/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 18,
        "ownerName": "Sample Text Data",
        "name": "Gold Rate Plan",
        "displayName": "Sample Text Data",
        "updated": "2021-04-26T15:25:27.587Z",
        "details": {
            "usageRateGroups": [
                {
                    "identity": 33,
                    "name": "Sample Text Data",
                    "start": "2021-04-26T15:25:27.587Z",
                    "end": "2021-04-26T15:25:27.587Z",
                    "useForCost": true,
                    "timePeriodId": 21,
                    "timePeriodName": "Sample Text Data",
                    "displayName": "Sample Text Data",
                    "currencyId": 52,
                    "currencyName": "Sample Text Data",
                    "currencyCode": "Sample Text Data",
                    "isAggregated": true,
                    "isPassThrough": true,
                    "amountPrecision": 44,
                    "roundingMethodTypeId": 52,
                    "roundingMethodTypeName": "Sample Text Data",
                    "usageRatePlanId": 78,
                    "usageRatePlanName": "Sample Text Data",
                    "priority": 59,
                    "generalLedgerId": 43,
                    "generalLedgerName": "Sample Text Data",
                    "isTaxInclusive": true,
                    "details": {
                        "rateGroupFilters": [
                            {
                                "identity": 24,
                                "usageRateGroupId": 75,
                                "usageRateGroupName": "Sample Text Data",
                                "field": "Sample Text Data",
                                "value": "Sample Text Data",
                                "operatorTypeId": 58,
                                "operatorTypeName": "Sample Text Data",
                                "sortOrder": 44
                            }
                        ],
                        "rates": [
                            {
                                "identity": 99,
                                "usageRateGroupId": 61,
                                "usageRateGroupName": "Sample Text Data",
                                "usageClassId": 45,
                                "usageClassName": "Sample Text Data",
                                "amount": 30.89,
                                "geoTreeLocationId": 32,
                                "geoTreeLocationName": "Sample Text Data",
                                "additional": true,
                                "retired": true,
                                "usageRoundingId": 65,
                                "usageRoundingName": "Sample Text Data",
                                "displayName": "Sample Text Data",
                                "geoTreeLocationGroupId": 44,
                                "geoTreeLocationGroupName": "Sample Text Data",
                                "minimumCharge": 97.58,
                                "usageUnitId": 68,
                                "usageUnitName": "Sample Text Data",
                                "usageRateCalculationTypeId": 47,
                                "usageRateCalculationTypeName": "Sample Text Data",
                                "created": "2021-04-26T15:25:27.587Z",
                                "updated": "2021-04-26T15:25:27.587Z",
                                "generalLedgerId": 19,
                                "generalLedgerName": "Sample Text Data",
                                "serviceTaxCategoryId": 62,
                                "serviceTaxCategoryName": "Sample Text Data",
                                "usageBaseUnitId": 15,
                                "usageBaseUnitName": "Sample Text Data",
                                "isAggregated": true,
                                "details": {
                                    "usageRateTierConfiguration": {
                                        "identity": 59,
                                        "usageRateId": 26,
                                        "pricePlanTierTypeId": 22,
                                        "pricePlanTierTypeName": "Sample Text Data",
                                        "countingRuleId": 41,
                                        "countingRuleName": "Sample Text Data",
                                        "details": {
                                            "usageRateTiers": [
                                                {
                                                    "identity": 92,
                                                    "usageUnitId": 45,
                                                    "usageUnitName": "Sample Text Data",
                                                    "usageRateTierConfigurationId": 93,
                                                    "threshold": 0,
                                                    "amount": 99.01,
                                                    "created": "2021-04-26T15:25:27.587Z",
                                                    "updated": "2021-04-26T15:25:27.587Z"
                                                }
                                            ]
                                        }
                                    }
                                }
                            }
                        ]
                    }
                }
            ]
        }
    }
}
PATCHRatePlan/{id}
Update or Add the RatePlan 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 RatePlan object.
Update or Add the RatePlan object and optionally make changes to any child objects.
PATCH RatePlan/{id}

{
    "details": {},
    "ratePlans": {
        "items": [
            {
                "patchType": "create",
                "patchClientId": 1,
                "name": "Gold Rate Plan",
                "displayName": "Sample Text Data",
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
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": "ratePlan",
                "instance": {
                    "identity": 1,
                    "ownerId": 1,
                    "ownerName": "Sample Text Data",
                    "name": "Gold Rate Plan",
                    "displayName": "Sample Text Data",
                    "updated": "2021-04-26T15:25:27.587Z"
                }
            }
        ]
    }
}
POSTRatePlan/
Create a new instance of the RatePlan object.
Create a new instance of the RatePlan object.
POST RatePlan/

{
    "name": "Gold Rate Plan",
    "displayName": "Sample Text Data",
    "updated": "2021-04-26T15:25:27.587Z"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 13,
                "ownerName": "Sample Text Data",
                "name": "Gold Rate Plan",
                "displayName": "Sample Text Data",
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
PUTRatePlan/{id}
Update an existing instance of the RatePlan object.
Update an existing instance of the RatePlan object.
PUT RatePlan/{id}

{
    "identity": 1,
    "name": "Gold Rate Plan",
    "displayName": "Sample Text Data",
    "updated": "2021-04-26T15:25:27.587Z"
}
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": "Gold Rate Plan",
                "displayName": "Sample Text Data",
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}