HomeGuidesAPI ExplorerAnnouncements
API Explorer
AboutContactRev.io
Start typing to search…

Replace service product

put
https://restapi.rev.io/v1/ServiceProduct/

Replace an existing service product.

Body Params

The replacement service product. Status of disconnect is not allowed. Rate and Quantity cannot be changed while status is changed.

date-time

Date when this change will take effect in the billing cycle. If not set, Effective Date will be the date of the change.

boolean
required

Indicates whether billing should take into account the exact effective date and create prorated charges if applicable.

int32

Primary identifier for this service product.

int32

ID of associated customer account.

int32
required
1 to 2147483647

ID of source product from catalog.

int32
0 to 2147483647

ID of the package of which this product is a member.

int32
required
1 to 2147483647

ID of the associated service.

string
length between 0 and 500

Contains the description of the product that will display on the bill.

string
length between 0 and 500

Supports provisioning codes for electronic ordering and provisioning with providers (i.e. USOC). This will be different for all electronic provisioning integrations.

string
length between 0 and 500

Used for ordering and provisioning with providers (i.e. FID). This will be different for all electronic provisioning integrations.

double

Rate that will be passed on to the customer. Please use only positive numbers. Use the credit_flag field to pass a credit product.

date-time

The last day a customer was billed for this product.

date-time

The effective day of cancellation.

string
enum

The current status of the service product.

Allowed:
date-time

The date this service product entered its current status.

int32
0 to 2147483647

ID of the user responsible for the product's current status.

date-time

Date this product became active or billable.

double

Your company's cost for this service product. Used in relation to Rate to calculate margin.

string
length between 0 and 255

A secondary description of the product, typically related to provider-side naming. Not visible to end users through typical means, but may be exposed via reporting at your discretion.

date-time

Notes the start of a time frame for which this product is free.

date-time

Notes the end of a time frame for which this product is free.

int32
1 to 2147483647

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

date-time

Beginning date for a contract to provide this service product.

date-time

Ending date for a contract to provide this service product.

date-time

Ending date for the automatic expiration for this service product.

date-time

The date this service product was added to the system.

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

Applicable only to products that are a part of a package. Indicates this product's rate should be grouped into a sum package amount when displayed on a bill.

boolean

Applicable only to products that are a part of a package and grouped. Indicates that, although their price is grouped, the name of the product will still show indented underneath on the bill, but with no individual price displayed.

boolean

Determines the type of service product.

fields
array of objects

List of custom fields and their values.

fields
Metadata
int32
required

ID of the service product to replace.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 6 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 6 months ago