Updates a product

put

https://api.rillet.com/products/{product_id}

Updates a single product or bundle definition in the catalog.
IMPORTANT: This is a full-replace operation (PUT semantics). Include every field expected by ProductRequest;
omitted fields may be cleared. Call retrieve-a-product first, merge your changes, then submit the full body.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

product_id

string

required

UUID of the product to update.

Body Params

type

string

enum

Defaults to PRODUCT

Defaults to PRODUCT. Can't be changed after the product is created.

Allowed:

name

string

required

length between 1 and 250

description

string

required

price

required

include_in_arr_mrr

boolean

required

include_in_ssp

boolean | null

Whether this product participates in SSP revenue allocation. Requires stored product SSP to be enabled. Not allowed for bundles. Omission or null preserves the flag on update; on create it defaults to true. Usage-priced products remain excluded from SSP allocation.

revenue_pattern

string

enum

How revenue from this product is recognized. Required for standalone products. Not allowed for bundles.

Allowed:

progress_plan_template

Required when creating a PROGRESS product; measure must be MILESTONES and milestone revenue recognition must be enabled for the organization. Only accepted with revenue_pattern PROGRESS and a ONE_TIME price. On update, omission or null preserves the existing template; an object replaces the entire template. Milestone identifiers are retained for matching keys ignoring case, and generated for new keys. Changing revenue_pattern away from PROGRESS clears the template.

account_code

string

The code of the account this product's revenue posts to. Required for standalone products. Not allowed for bundles.

status

string

enum

Defaults to ACTIVE

Allowed:

external_references

array of objects, unique

References to this product in external systems. Must be omitted or empty for bundles.

external_references

fields

array of objects

Custom field values. On update, omitting this property or sending an empty array clears all fields. Must be omitted or empty for bundles.

fields

bundle

object

Required when type is BUNDLE. Not allowed for other types.

Responses

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

defaultError