RErev-io
Products

Replace product

Changed on

Replace an existing product.

put/v1/Products/{id}

Request

Path parameters

idinteger required

ID of the product to replace.

Request body

product_idinteger

Primary identifier for this product.

product_type_idinteger required

Foreign identifier indicating what kind of product this is.

descriptionstring required

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).

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.

created_datestring date-time

Date and time this product was created.

created_byinteger

Foreign identifier indicating which user created this.

activeboolean

Indicates whether this product can be added to accounts.

creates_orderboolean

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

provider_idinteger required

Foreign identifier indicating which underlying provider offers this product.

bills_in_arrearsboolean

Overrides billing behavior, making it bill in arrears.

bill_every'FOLLOW_BILL_PROFILE' | 'THREE_MONTHS' | 'SIX_MONTHS' | 'ONE_YEAR' | 'TWO_YEARS' | 'THREE_YEARS' | 'FOUR_YEARS' | 'FIVE_YEARS' | 'SIX_YEARS' | 'SEVEN_YEARS' | 'EIGHT_YEARS' | 'NINE_YEARS' | 'TEN_YEARS'

Indicates how often customer is billed.

proratesboolean

Overrides billing behavior, making it prorate on activation.

prorates_on_disconnectboolean

Overrides billing behavior, making it prorate on disconnect.

customer_class'Business' | 'Residential'

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

long_descriptionstring

Longer description of the product or further details.

ledger_codestring

For accounting purposes, can be displayed on reports.

free_monthsinteger

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

automatic_expiration_monthsinteger

Product will disconnect automatically after given number of months.

order_completion_billingboolean

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

tax_class_idinteger

Overrides the tax class associated with the assigned product type.

wholesale_descriptionstring

Additional description used for reporting.

smart_pricing_idinteger

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

bill_profile_idsinteger[]

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

service_type_idsinteger[]

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

category_idinteger
is_credit_account_typeboolean

Response

OK

okboolean

Changes