v1

latestOpenAPI 3.0.02026-07-263403911.5 MB

Packages

View package

Find a single package by ID.

get/v1/Packages/{id}

idinteger required

Format - int32. ID of the package to view.

okboolean

package_idinteger

Primary identifier for a specific package.

provider_idinteger required

Foreign key identifier for associated provider.

descriptionstring required

Short descriptive text that only appears within Rev.io and is not intended to be public facing.

description_on_billstring required

Descriptive text that will appear on the bill, or in other words, customers can see this.

long_descriptionstring

Longer descriptive text for further details about the package.

created_datestring date-time

The date and time this package was added to Rev.io.

created_byinteger

Foreign key identifier for the user who created this package.

activeboolean

Indicates whether this package is active or not.

usage_plan_group_idinteger required

Foreign key identifier for the usage plan group associated with this package.

service_type_idinteger

Foreign key identifier for the associated service type.

package_category_idinteger

Foreign key identifier for the package category.

exempt_from_spiff_commissionboolean

Indicates package is exempt from Spiff Commission.

state_provincesstring[]

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

postal_codesstring[]

Restricts this package to a list of postal codes.

restrict_class_flagboolean

Indicates package has a customer class restriction.

class'Business' | 'Residential'

Customer class package is restricted to.

restrict_bill_profile_flagboolean

Indicates package has a bill profile restriction.

bill_profile_idinteger

Bill profile package is restricted to.