Sign in

v1

latestOpenAPI 3.1.02026-07-24111224223.3 KB
Products

Updates a product

Updates a single product 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.

put/products/{product_id}

Path parameters

product_idstring required

UUID of the product to update.

Request body

namestring required
descriptionstring required
include_in_arr_mrrboolean required
revenue_pattern'DAILY' | 'EVEN_PERIOD' required

DAILY means that the revenue is divided equally per day in the revenue period. EVEN_PERIOD means that the revenue is divided equally for each calendar month in the revenue period.

account_codestring required

The account code found in the Chart of Accounts

status'ACTIVE' | 'INACTIVE'

Example request

{
  "name": "English subscription",
  "description": "Subscription to english classes",
  "price": {
    "amount": {
      "amount": "1.01",
      "currency": "USD"
    },
    "interval_months": 1
  },
  "account_code": "11112",
  "external_references": [
    {
      "type": "xyzSystemId",
      "id": "234",
      "url": "https://xyzsystempage.com/ids/234"
    }
  ]
}

Response

OK

idstring uuid required
namestring required
descriptionstring required
include_in_arr_mrrboolean required
revenue_pattern'DAILY' | 'EVEN_PERIOD' required

DAILY means that the revenue is divided equally per day in the revenue period. EVEN_PERIOD means that the revenue is divided equally for each calendar month in the revenue period.

status'ACTIVE' | 'INACTIVE' required
account_codestring required

The account code found in the Chart of Accounts

Example response

{
  "name": "English subscription",
  "description": "Subscription to english classes",
  "price": {
    "amount": {
      "amount": "1.01",
      "currency": "USD"
    },
    "interval_months": 1
  },
  "external_references": [
    {
      "type": "xyzSystemId",
      "id": "234",
      "url": "https://xyzsystempage.com/ids/234"
    }
  ],
  "account_code": "11112"
}