Sign in

v1

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

Create a product

post/api/v1/products

Request body

catalogboolean
descriptionstring nullable
namestring required
product_family_idstring MeteroidId required

Example request

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

Response

Product created

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"
}