TAG LINE
TAG LINE
SMALL TITLE

Tier Charge Type

(API Version v10)


Allows the charge types configured on pricing tiers to be retrieved ('Fixed Amount' or 'Percentage Off of Base Price'). As of 10.8.5.0 a new percentage based tier type has been introduced which allows a base price to be defined along with percentage discounts per each tier.


What can you do with TierChargeType?


Properties

Property Details
identity
READ-ONLY
"identity": 16
Type: Number
This is the unique numeric identifier for the TierChargeType
name
"name": "My Tier Charge Type"
Type: String


End Points

GETTierChargeType/
Retrieve all of the TierChargeType objects.
Retrieve all of the TierChargeType objects.
GET TierChargeType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "My Tier Charge Type"
        }
    ]
}
GETTierChargeType/Paged
Retrieve all of the TierChargeType 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 TierChargeType objects in a paged fashion.
GET TierChargeType/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,
                "name": "My Tier Charge Type"
            }
        ]
    }
}
GETTierChargeType/{id}
Retrieve an instance of the TierChargeType object by its ID.
{id}Unique identifier for the TierChargeType object.
Retrieve an instance of the TierChargeType object by its ID.
GET TierChargeType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "My Tier Charge Type"
    }
}