Get Product

GET /products/{id}

Get Product

cURL

curl --request GET \
  --url https://api.alguna.io/products/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "sku": "<string>",
  "feeType": "<string>",
  "paymentTerms": "<string>",
  "billingFrequency": "<string>",
  "metricIds": {},
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Response

id · string

The unique identifier for the product.

name · string

The name of the product.

description · string

A brief description of the product.

sku · string

A product code used in external ERP solutions of revenue recognition.

feeType · string

The fee type of the product, indicating whether the cost is fixed or based on usage (metered).

paymentTerms · string

The payment terms for the product, such as arrears.

billingFrequency · string

The frequency at which the product is billed, e.g., recurring.

metricIds · []string

The identifiers for the associated metrics. This field is applicable for metered products.

createdAt · date

The timestamp when the product was created.

updatedAt · date

The timestamp when the product was last updated.