product

Update an existing product

patch/v1/product/{productId}

Request

  • Base URL: https://localhost
  • URL: https://localhost/v1/product/{productId}
  • Auth: none declared

Path parameters

productIdstring required

Product id

Request body

namestring

name of product

skustring

unique sku of product

salesforceProductIdstring

corresponding product id in salesforce

stripeProductIdstring

corresponding product id in stripe

featuresstring[]

set of features this product has access to

featureOptionsobject

map of options for the feature

status'ACTIVE' | 'LEGACY' | 'INACTIVE'

whether the product is Active (currently being sold), Legacy (in use, but not being sold to new customers), or Inactive (no longer in use by any active customers)

Example request

{
  "name": "Compensation Reviews",
  "sku": "compensation-reviews",
  "salesforceProductId": "01t4T000000RpgKQAS",
  "stripeProductId": "prod_12345ABC"
}

Response

product updated

Changes

No recorded changes to this operation across all 20 revisions of this API.