Products

Update a product

Changed on

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

patch/api/v1/products/{product_id}

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

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

Changes

  • v1ee465c53a423Revision changes
    • info

      request discriminator property name changed for //// request property from fee_type to type

    • info

      response discriminator property name changed for response property from fee_type to type for the response status

  • v1560215310a09Revision changes
    • breaking

      removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 from the //// request property oneOf list

    • breaking

      added to the response property oneOf list for the response status

    • info

      added discriminator to //// request property

    • info

      added to the //// request property oneOf list

    • info

      added discriminator to response property for the response status

    • info

      removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 from the response property oneOf list for the response status