Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
product

Create a new product

post/v1/product

Request body

namestring required

name of product

skustring required

unique sku of product

salesforceProductIdstring required

corresponding product id in salesforce

stripeProductIdstring required

corresponding product id in stripe

featuresstring[] required

set of features this product has access to

featureOptionsobject

map of options for the feature

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

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 created

idstring

globally unique id

namestring required

name of product

skustring required

unique sku of product

salesforceProductIdstring required

corresponding product id in salesforce

stripeProductIdstring required

corresponding product id in stripe

featuresstring[] required

set of features this product has access to

featureOptionsobject

map of options for the feature

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

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 response

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