Billing price list entry line tiers

A billing price list entry line tier defines the starting quantity and price for a single tier in a billing price list entry line.

List billing price list entry line tiers

get/objects/contracts/billing-price-list-entry-line-tier

Returns up to 100 object references from the collection with a key, ID, and link for each tier. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "1",
      • "href": "/objects/contracts/billing-price-list-entry-line-tier/1"
      },
    • {
      • "key": "2",
      • "id": "2",
      • "href": "/objects/contracts/billing-price-list-entry-line-tier/2"
      },
    • {
      • "key": "3",
      • "id": "3",
      • "href": "/objects/contracts/billing-price-list-entry-line-tier/3"
      },
    • {
      • "key": "4",
      • "id": "4",
      • "href": "/objects/contracts/billing-price-list-entry-line-tier/4"
      }
    ],
  • "ia::meta": {
    • "totalCount": 4,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a billing price list entry line tier
post/objects/contracts/billing-price-list-entry-line-tier
Creates a new billing price list entry line tier.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
Billing price list entry tier to create


beginQuantity
required
string
Begin quantity. Use 0 for the first tier.


 
 Example:  "0"
tierRate
required
string
Tier rate.


 
 Example:  "850"
object
The billing-price-list-entry-line object that this tier is owned by.


 
key
string
Billing price list entry line key.


 
 Example:  "1"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "billingPriceListEntryLine": {
    • "key": "4"
    },
  • "beginQuantity": "0",
  • "tierRate": "860"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "22",
    • "id": "22",
    • "href": "/objects/contracts/billing-price-list-entry-line-tier/22"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a billing price list entry line tier
get/objects/contracts/billing-price-list-entry-line-tier/{key}
Returns detailed information for a specified billing price list entry line tier.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for a billing price list entry line tier.


 
 Example:  32195
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1",
    • "id": "1",
    • "billingPriceListEntryLine": {
      • "key": "4",
      • "id": "4",
      • "href": "/objects/billing-price-list-entry-line/4"
      },
    • "beginQuantity": "0",
    • "tierRate": "850",
    • "audit": {
      • "modifiedDateTime": "2025-01-16T23:12:22Z",
      • "createdDateTime": "2024-05-13T18:22:36Z",
      • "createdByUser": {
        },
      • "createdBy": "1",
      • "modifiedByUser": {
        },
      • "modifiedBy": "109"
      },
    • "href": "/objects/contracts/billing-price-list-entry-line-tier/1"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a billing price list entry line tier
patch/objects/contracts/billing-price-list-entry-line-tier/{key}
Updates an existing billing price list entry line tier by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for a billing price list entry line tier.


 
 Example:  32195
Request Body schema: application/json
beginQuantity
string
Begin quantity. Use 0 for the first tier.


 
 Example:  "0"
tierRate
string
Tier rate.


 
 Example:  "850"
object
The billing-price-list-entry-line object that this tier is owned by.


 
key
string
Billing price list entry line key.


 
 Example:  "1"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "beginQuantity": "0",
  • "tierRate": "850"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "32069",
    • "id": "32069",
    • "href": "/objects/contracts/billing-price-list-entry-line/32069"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a billing price list entry line tier
delete/objects/contracts/billing-price-list-entry-line-tier/{key}
Deletes a billing price list entry line tier.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for a billing price list entry line tier.


 
 Example:  32195
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}
Query billing price list entry line tiers
post/services/core/query
Use the query service to find billing price list entry line tiers that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}