Sign in

v1

latestOpenAPI 3.1.0AGPL-3.0-only2026-07-1773264353.7 KB
Products

Update a product

Partially update product fields. The fee_type is immutable and cannot be changed.

patch/api/v1/products/{product_id}

Path parameters

product_idstring MeteroidId required
Example:prd_7n42DGM5Tflk9n8mt7Fhc7

Product ID

Request body

descriptionstring nullable
namestring nullable

Example request

{
  "fee_structure": {
    "metric_id": "bm_7n42DGM5Tflk9n8mt7Fhc7"
  }
}

Response

Product updated

archived_atstring date-time nullable
catalogboolean required
created_atstring date-time required
descriptionstring nullable
fee_type'RATE' | 'SLOT' | 'CAPACITY' | 'USAGE' | 'EXTRA_RECURRING' | 'ONE_TIME' required
idstring MeteroidId required
namestring required
product_family_idstring MeteroidId required

Example response

{
  "fee_structure": {
    "metric_id": "bm_7n42DGM5Tflk9n8mt7Fhc7"
  },
  "id": "prd_7n42DGM5Tflk9n8mt7Fhc7",
  "product_family_id": "pf_7n42DGM5Tflk9n8mt7Fhc7"
}