v1

latestOpenAPI 3.0.02026-07-263403911.5 MB

RequestProducts

View request product

Find a single request product by ID.

get/v1/RequestProducts/{id}

idinteger required

Format - int32. ID of the request product to view.

okboolean

request_product_idinteger

Primary identifier for this request product.

request_service_idinteger required

Foreign identifier indicating which request service it belongs to.

request_idinteger required

Foreign identifier indicating which request it is part of.

product_idinteger required

Foreign identifier indicating the catalog product it is modeled after.

quantityinteger required

How many.

ratenumber double

Per month charge to the end user.

descriptionstring

Short description of the product (i.e. the name).

code_1string

Primary provisioning code (i.e. USOC).

code_2string

Secondary provisioning code (i.e. FID).

contract_startstring date-time

Date service contract starts.

contract_endstring date-time

Date service contract ends.

group_on_billboolean

Indicates product should display grouped with other products on the same package.

tax_includedboolean

Indicates base charge plus tax should be equal to value of rate.

itemizedboolean

Indicates product should itemize, by name only, when group_on_bill = true.

costnumber double

Per month cost from provider.

buy_ratenumber double

Per month charge to a reseller.