Create product

post

https://restapi.rev.io/v1/Products

Create a new product.

Body Params

The product to create.

currency_code

string

enum

The three-letter currency code for this product. Defaults to USD.

product_id

int32

Primary identifier for this product.

product_type_id

int32

required

Foreign identifier indicating what kind of product this is.

description

string

required

length between 0 and 255

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

code_1

string

length between 0 and 4000

Primary provisioning code (i.e. USOC).

code_2

string

length between 0 and 1024

Secondary provisioning code (i.e. FID).

rate

double

Per month charge to the end user.

cost

double

Per month cost from provider.

buy_rate

double

Per month charge to a reseller.

created_date

date-time

Date and time this product was created.

created_by

int32

Foreign identifier indicating which user created this.

active

boolean

Indicates whether this product can be added to accounts.

creates_order

boolean

Indicates whether the work flow of adding or changing should be tracked with an order.

provider_id

int32

required

Foreign identifier indicating which underlying provider offers this product.

bills_in_arrears

boolean

Overrides billing behavior, making it bill in arrears.

bill_every

string

enum

Indicates how often customer is billed.

prorates

boolean

Overrides billing behavior, making it prorate on activation.

prorates_on_disconnect

boolean

Overrides billing behavior, making it prorate on disconnect.

customer_class

string

enum

Indicates restriction of this product by class, Null indicates no restriction.

Allowed:

long_description

string

Longer description of the product or further details.

ledger_code

string

For accounting purposes, can be displayed on reports.

free_months

int32

Indicates product has no charge for the first number of months given.

automatic_expiration_months

int32

Product will disconnect automatically after given number of months.

order_completion_billing

boolean

Indicates product should wait for it's order to complete before billing.

tax_class_id

int32

Overrides the tax class associated with the assigned product type.

wholesale_description

string

Additional description used for reporting.

smart_pricing_id

int32

Foreign identifier indicating the assigned smart pricing schedule (if any).

bill_profile_ids

array of int32s

Foreign identifiers indicating the bill profiles that are assigned to the product.

bill_profile_ids

service_type_ids

array of int32s

Foreign identifiers indicating the service types that are assigned to the product.

service_type_ids

fields

array of objects

fields

category_id

int32

0 to 2147483647

is_credit_account_type

boolean

Metadata

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

201Created

400BadRequest

500InternalServerError