Billing price list entry lines

Billing price list entry lines define pricing details for an item specified in a billing price list entry. Details include the starting date for a price, the flat amount, and usage rates.

List billing price list entry lines

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

Returns up to 100 object references from the collection with a key, ID, and link for each entry line. 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": "304",
      • "id": "304",
      • "href": "/objects/contracts/billing-price-list-entry-line/304"
      },
    • {
      • "key": "301",
      • "id": "301",
      • "href": "/objects/contracts/billing-price-list-entry-line/301"
      },
    • {
      • "key": "302",
      • "id": "302",
      • "href": "/objects/contracts/billing-price-list-entry-line/302"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Get a billing price list entry line
get/objects/contracts/billing-price-list-entry-line/{key}
Returns detailed information for a specified billing price list entry line.


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


 
 Example:  10295
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "572",
    • "id": "572",
    • "billingPriceListEntry": {
      • "key": "525",
      • "id": "525",
      • "href": "/objects/billing-price-list-entry/525"
      },
    • "startDate": "2024-01-01",
    • "flatAmount": "0",
    • "variableUnitRate": "0",
    • "includedUnits": "9",
    • "memo": "Annual price increase",
    • "audit": {
      • "createdDateTime": "2023-06-15T06:01:21Z",
      • "modifiedDateTime": "2023-06-15T06:01:21Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "tiers": [
      • {
        }
      ],
    • "href": "/objects/contracts/billing-price-list-entry-line/572"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a billing price list entry line
patch/objects/contracts/billing-price-list-entry-line/{key}
Updates an existing billing price list entry line by setting field values. Any fields not provided remain unchanged.


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


 
 Example:  10295
Request Body schema: application/json
startDate
string <date> 
The date on which the price becomes effective.


 
 Example:  "2024-01-01"
flatAmount
string <decimal-precision-2> 
Flat amount.


    

  • The established amount to bill each period. For example, if the item is text message, 5,000 text messages are included for a Flat amount of 10.00. Set this field to 0 to price the item only by the contracted quantity or quantity used.
    • 

  • The fixed price for items that don't include pricing by contracted quantity or quantity used. For example, the item is a service plan that is 300.00 for a one-year term.
    • 



 
 Example:  "999.99"
variableUnitRate
string or null
The amount to charge for each quantity range beyond the included units. Only applicable if priceType = range.


 
 Example:  "11.99"
includedUnits
string or null
The item quantity included in the flatAmount.


Enter 0 in this field to:


    

  • Price the item only by the contracted quantity or quantity used
    • 

  • Set a fixed fee
    • 

  • Use the item with committed quantity billing. Included units must be 0.00 to save a committed quantity contract line.
    • 



 
 Example:  "2000"
memo
string or null
Notes.


 
 Example:  "note to save"
Array of objects
Pricing tiers. Only applicable if priceType = tiered.


 
 Array 
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.


 
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "startDate": "2024-01-01",
  • "flatAmount": "0",
  • "variableUnitRate": "1",
  • "includedUnits": "9",
  • "memo": null,
  • "tiers": [
    • {
      • "key": "121",
      • "beginQuantity": "0",
      • "tierRate": "850"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "572",
    • "id": "572",
    • "href": "/objects/contracts/billing-price-list-entry-line/572"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a billing price list entry line
delete/objects/contracts/billing-price-list-entry-line/{key}
Deletes a billing price list entry line.


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


 
 Example:  10295
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 lines
post/services/core/query
Use the query service to find billing price list entry lines 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
    }
}