PUT/api/v1/products/{id}

Update product

Updates a product catalog entry by UUID.

RBAC · service

Path parameters

idstring <uuid>Required

Product UUID.

Request body

Content type: application/json

service_namestring

min length 1 · max length 255

custom_service_type_idstring <uuid>

billing_methodstring

default "usage"

Enum: usage

default_ratenumber

default 0 · ≥ 0

currency_codestring

default "USD" · min length 3 · max length 3

unit_of_measurestring

min length 1 · max length 128

category_idanyOf

anyOf (option 1)string <uuid>

anyOf (option 2)null

anyOf (option 3)null

tax_rate_idanyOf

anyOf (option 1)string <uuid>

anyOf (option 2)null

anyOf (option 3)null

descriptionanyOf

anyOf (option 1)string

max length 2048

anyOf (option 2)null

anyOf (option 3)null

skuanyOf

anyOf (option 1)string

max length 128

anyOf (option 2)null

anyOf (option 3)null

costanyOf

anyOf (option 1)number

≥ 0

anyOf (option 2)null

anyOf (option 3)null

cost_currencyanyOf

anyOf (option 1)string

min length 3 · max length 3

anyOf (option 2)null

anyOf (option 3)null

vendoranyOf

anyOf (option 1)string

max length 255

anyOf (option 2)null

anyOf (option 3)null

manufactureranyOf

anyOf (option 1)string

max length 255

anyOf (option 2)null

anyOf (option 3)null

product_categoryanyOf

anyOf (option 1)string

max length 255

anyOf (option 2)null

anyOf (option 3)null

is_licenseboolean

default false

license_termanyOf

anyOf (option 1)string

max length 64

anyOf (option 2)null

anyOf (option 3)null

license_billing_cadenceanyOf

anyOf (option 1)string

max length 64

anyOf (option 2)null

anyOf (option 3)null

is_activeboolean

default true

pricesarray of object

itemsobject

currency_codestringRequired

min length 3 · max length 3

ratenumberRequired

≥ 0

Response body

Success response 200 · schema ProductEnvelope

dataobjectRequired

Product catalog entry.

service_idstring <uuid>Required

tenantstring <uuid>Required

service_namestringRequired

custom_service_type_idstring <uuid>Required

billing_methodstringRequired

Enum: usage

default_ratenumberRequired

unit_of_measurestringRequired

category_idstring <uuid>Nullable

tax_rate_idstring <uuid>Nullable

descriptionstringNullable

item_kindstringRequired

Enum: product

is_activeboolean

skustringNullable

costnumberNullable

cost_currencystringNullable

min length 3 · max length 3

vendorstringNullable

manufacturerstringNullable

product_categorystringNullable

is_licenseboolean

license_termstringNullable

license_billing_cadencestringNullable

service_type_namestring

pricesarray of ProductPrice

itemsobject

currency_codestringRequired

min length 3 · max length 3

ratenumberRequired

metaobject

Response codes

200

Product updated successfully.

400

Validation error.

401

Authentication failed.

403

Authenticated user lacks the required permission.

404

Product not found.

PUT /api/v1/products/{id}

cURL

curl -X PUT "https://algapsa.com/api/v1/products/{id}" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "service_name": "x",
  "custom_service_type_id": "01HN2K7VRB9PQ3Y0000000000",
  "billing_method": "usage",
  "default_rate": 0,
  "currency_code": "USD",
  "unit_of_measure": "x",
  "category_id": "01HN2K7VRB9PQ3Y0000000000",
  "tax_rate_id": "01HN2K7VRB9PQ3Y0000000000",
  "description": "string",
  "sku": "string",
  "cost": 0,
  "cost_currency": "USD",
  "vendor": "string",
  "manufacturer": "string",
  "product_category": "string",
  "is_license": false,
  "license_term": "string",
  "license_billing_cadence": "string",
  "is_active": true,
  "prices": [
    {
      "currency_code": "xxx",
      "rate": 0
    }
  ]
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/products/{id}", {
  method: "PUT",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "service_name": "x",
    "custom_service_type_id": "01HN2K7VRB9PQ3Y0000000000",
    "billing_method": "usage",
    "default_rate": 0,
    "currency_code": "USD",
    "unit_of_measure": "x",
    "category_id": "01HN2K7VRB9PQ3Y0000000000",
    "tax_rate_id": "01HN2K7VRB9PQ3Y0000000000",
    "description": "string",
    "sku": "string",
    "cost": 0,
    "cost_currency": "USD",
    "vendor": "string",
    "manufacturer": "string",
    "product_category": "string",
    "is_license": false,
    "license_term": "string",
    "license_billing_cadence": "string",
    "is_active": true,
    "prices": [
      {
        "currency_code": "xxx",
        "rate": 0
      }
    ]
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Put, "https://algapsa.com/api/v1/products/{id}");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""service_name"": ""x"",
  ""custom_service_type_id"": ""01HN2K7VRB9PQ3Y0000000000"",
  ""billing_method"": ""usage"",
  ""default_rate"": 0,
  ""currency_code"": ""USD"",
  ""unit_of_measure"": ""x"",
  ""category_id"": ""01HN2K7VRB9PQ3Y0000000000"",
  ""tax_rate_id"": ""01HN2K7VRB9PQ3Y0000000000"",
  ""description"": ""string"",
  ""sku"": ""string"",
  ""cost"": 0,
  ""cost_currency"": ""USD"",
  ""vendor"": ""string"",
  ""manufacturer"": ""string"",
  ""product_category"": ""string"",
  ""is_license"": false,
  ""license_term"": ""string"",
  ""license_billing_cadence"": ""string"",
  ""is_active"": true,
  ""prices"": [
    {
      ""currency_code"": ""xxx"",
      ""rate"": 0
    }
  ]
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": {
    "service_id": "01HN2K7VRB9PQ3Y0000000000",
    "tenant": "01HN2K7VRB9PQ3Y0000000000",
    "service_name": "string",
    "custom_service_type_id": "01HN2K7VRB9PQ3Y0000000000",
    "billing_method": "usage",
    "default_rate": 0,
    "unit_of_measure": "string",
    "category_id": "01HN2K7VRB9PQ3Y0000000000",
    "tax_rate_id": "01HN2K7VRB9PQ3Y0000000000",
    "description": "string",
    "item_kind": "product",
    "is_active": false,
    "sku": "string",
    "cost": 0,
    "cost_currency": "xxx",
    "vendor": "string",
    "manufacturer": "string",
    "product_category": "string",
    "is_license": false,
    "license_term": "string",
    "license_billing_cadence": "string",
    "service_type_name": "string",
    "prices": [
      {
        "currency_code": "xxx",
        "rate": 0
      }
    ]
  },
  "meta": {}
}