TAG LINE
SMALL TITLE
System defined options for tiered pricing such as not-tiered, bracketed, or progressive.
identity READ-ONLY | "identity": 8 Type: Number This is the unique numeric identifier for the PricePlanTierType |
name READ-ONLY | "name": "Tiered Bracketed" Type: String System defined name for the Tier Type. |
sortOrder READ-ONLY | "sortOrder": 0 Type: Number Unused |
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:
| GET | api/v2/PricePlan/TierType/ |
| Retrieve all of the PricePlanTierType objects. | |
Retrieve all of the PricePlanTierType objects. GET api/v2/PricePlan/TierType/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Tiered Bracketed",
"sortOrder": 2
}
]
} | |
| GET | api/v2/PricePlan/TierType/Paged |
| Retrieve all of the PricePlanTierType 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 PricePlanTierType objects in a paged fashion. GET api/v2/PricePlan/TierType/Paged 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": "Tiered Bracketed",
"sortOrder": 1
}
]
}
} | |
| GET | api/v2/PricePlan/TierType/{id} |
| Retrieve an instance of the PricePlanTierType object by its ID. | |
| {id} | Unique identifier for the PricePlanTierType object. |
Retrieve an instance of the PricePlanTierType object by its ID. GET api/v2/PricePlan/TierType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Tiered Bracketed",
"sortOrder": 14
}
} | |