v1

latestOpenAPI 3.0.02026-07-263403911.5 MB

PackageProducts

View package product

Find a single package product by ID.

get/v1/PackageProducts/{id}

Path parameters

idinteger required

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

Response

okboolean

package_product_idinteger

Primary identifier for this package product.

product_idinteger required

Product id for this package product.

package_idinteger required

Package id for this package product.

descriptionstring required

Description for this package product.

code_1string

Primary provisioning code (i.e. USOC).

code_2string

Secondary provisioning code (i.e. FID).

ratenumber double

Per month charge to the end user.

costnumber double

Per month cost from provider.

buy_ratenumber double

Per month charge to a reseller.

quantityinteger

Number of this type of package product provided to end user. This is multiplied by the Rate field when calculating a recurring charge.

tax_includedboolean

Indicates total amount of charge should not exceed the value in rate. The base amount is adjusted dynamically on charges produced each month, to ensure base + tax = rate.

group_on_billboolean

Indicates this package product's rate should be grouped into a sum package amount when displayed on a bill.

itemizeboolean

Indicates that, although their price is grouped, the name of the package product will still show indented underneath on the bill, but with no individual price displayed.

creditboolean

Indicates that this package product is a credit.

state_provincesstring[]

Restricts this package product to a list of states and/or provinces (2-Character abbreviation).

order_type'ALL' | 'NEW' | 'CONVERSION' | 'OTHER'

Restricts this package product to this order type.