Skip to main content
PATCH
/
products
/
{id}
Update a product
curl --request PATCH \
  --url https://api.alguna.io/products/{id} \
  --header 'Alguna-Version: <alguna-version>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "name": "Updated Platform Fee",
  "revenue_allocation_method": "straight_line",
  "sku": "<string>",
  "tag_ids": [
    "<string>"
  ]
}
'
{
  "created_at": "2026-04-01T10:00:00Z",
  "description": "Monthly platform access fee",
  "fee_type": "fixed",
  "id": "prod_01H1VECT",
  "name": "Platform Fee",
  "payment_terms": "arrears",
  "revenue_allocation_method": "straight_line",
  "updated_at": "2026-04-01T12:30:00Z",
  "billing_frequency": "recurring",
  "metric_ids": [
    "mtr_01H2ABC"
  ],
  "sku": "PLATFORM_FEE",
  "tag_ids": [
    "tag_01H3DEF"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://alguna.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key authentication. Pass your API key as a Bearer token.

Headers

​
Alguna-Version
enum<string>
required
Available options:
2026-04-01
​
Idempotency-Key
string

A unique string used to ensure the request is processed exactly once. If you retry a request with the same idempotency key within 24 hours, the original response is returned without re-executing the operation.

Maximum string length: 255
Example:

"ik_a1b2c3d4e5f6"

Path Parameters

​
id
string
required

Unique identifier for the product

Body

application/json
​
description
string | null

A brief description of the product

​
name
string | null

The name of the product

Example:

"Updated Platform Fee"

​
revenue_allocation_method
enum<string> | null

How revenue is allocated across time periods within a billing cycle

Available options:
straight_line,
usage_based,
contract_level_straight_line
​
sku
string | null

Stock keeping unit code used in external ERP or revenue recognition systems

​
tag_ids
string[]

Identifiers for tags to associate with this product

Response

Success

​
created_at
string<date-time>
required

Timestamp when the product was created

Example:

"2026-04-01T10:00:00Z"

​
description
string
required

A brief description of the product

Example:

"Monthly platform access fee"

​
fee_type
enum<string>
required

Whether the product is fixed-price or usage-based

Available options:
fixed,
metered
Example:

"fixed"

​
id
string
required

Unique identifier for the product

Example:

"prod_01H1VECT"

​
name
string
required

The name of the product

Example:

"Platform Fee"

​
payment_terms
enum<string>
required

When the product is billed relative to the billing period

Available options:
advance,
arrears
Example:

"arrears"

​
revenue_allocation_method
enum<string>
required

How revenue is allocated across time periods within a billing cycle

Available options:
straight_line,
usage_based,
contract_level_straight_line
Example:

"straight_line"

​
updated_at
string<date-time>
required

Timestamp when the product was last updated

Example:

"2026-04-01T12:30:00Z"

​
billing_frequency
enum<string> | null

How often the product is billed

Available options:
recurring,
one-off
Example:

"recurring"

​
metric_ids
string[]

Identifiers for associated metrics. Applicable for metered products

Example:
["mtr_01H2ABC"]
​
sku
string | null

Stock keeping unit code used in external ERP or revenue recognition systems

Example:

"PLATFORM_FEE"

​
tag_ids
string[]

Identifiers for tags associated with this product

Example:
["tag_01H3DEF"]