---
title: "Replace product"
method: PUT
path: "/v1/Products/{id}"
tags: ["Products"]
---

# Replace product

`PUT /v1/Products/{id}`

Replace an existing product.

## Path parameters

- `id` integer, required

## Request body

- RevAppModelsProduct
  - `product_id` integer — Primary identifier for this product.
  - `product_type_id` integer, required — Foreign identifier indicating what kind of product this is.
  - `description` string, required — Short description of the product (i.e. the name).
  - `code_1` string — Primary provisioning code (i.e. USOC).
  - `code_2` string — Secondary provisioning code (i.e. FID).
  - `rate` number, double — Per month charge to the end user.
  - `cost` number, double — Per month cost from provider.
  - `buy_rate` number, double — Per month charge to a reseller.
  - `created_date` string, date-time — Date and time this product was created.
  - `created_by` integer — 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` integer, required — Foreign identifier indicating which underlying provider offers this product.
  - `bills_in_arrears` boolean — 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.
  - `prorates` boolean — Overrides billing behavior, making it prorate on activation.
  - `prorates_on_disconnect` boolean — Overrides billing behavior, making it prorate on disconnect.
  - `customer_class` 'Business' | 'Residential' — Indicates restriction of this product by class, Null indicates no restriction.
  - `long_description` string — Longer description of the product or further details.
  - `ledger_code` string — For accounting purposes, can be displayed on reports.
  - `free_months` integer — Indicates product has no charge for the first number of months given.
  - `automatic_expiration_months` integer — 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` integer — Overrides the tax class associated with the assigned product type.
  - `wholesale_description` string — Additional description used for reporting.
  - `smart_pricing_id` integer — Foreign identifier indicating the assigned smart pricing schedule (if any).
  - `bill_profile_ids` integer[] — Foreign identifiers indicating the bill profiles that are assigned to the product.
  - `service_type_ids` integer[] — Foreign identifiers indicating the service types that are assigned to the product.
  - `fields` RevAppModelsFieldValue[]
    - `field_id` integer — Primary identifier for this custom field.
    - `label` string — User-defined identifier representing the custom field.
    - `value` string — Value of the custom field.
    - `links` RevAppComponentsLink[]
      - `rel` string
      - `href` string
  - `category_id` integer
  - `is_credit_account_type` boolean
  - `links` RevAppComponentsLink[]
    - `rel` string
    - `href` string

## Response `200`

OK

- RevWebAPIModelsSuccess
  - `ok` boolean

## Other responses

- `400` — BadRequest
- `500` — InternalServerError

---

[API](https://skmtc.net/rev-io/apis/rev-io-api.md) · [All operations](https://skmtc.net/rev-io/apis/rev-io-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rev-io/rev-io-api/revisions/135571434f6c/schema)
