HomeGuidesAPI ExplorerAnnouncements
API Explorer
AboutContactRev.io

Create package product

post
https://restapi.rev.io/v1/PackageProducts

Create a new package product.

Body Params

The package product to create.

int32

Primary identifier for this package product.

int32
required
1 to 2147483647

Product id for this package product.

int32
required
1 to 2147483647

Package id for this package product.

string
required
length between 0 and 255

Description for this package product.

string
length between 0 and 4000

Primary provisioning code (i.e. USOC).

string
length between 0 and 4000

Secondary provisioning code (i.e. FID).

double
≥ 0

Per month charge to the end user.

double
≥ 0

Per month cost from provider.

double
≥ 0

Per month charge to a reseller.

int32
1 to 2147483647

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

boolean

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.

boolean

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

boolean

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.

boolean

Indicates that this package product is a credit.

state_provinces
array of strings

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

state_provinces
string
enum

Restricts this package product to this order type.

Allowed:
Metadata
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 7 months ago

Language
Credentials
Basic
base64
:
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json
text/html
Updated 7 months ago