Create a product

POST

products

Create a product

curl --request POST \
  --url https://api.alguna.io/products \
  --header 'Alguna-Version: <alguna-version>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fee_type": "fixed",
  "name": "Platform Fee",
  "payment_terms": "arrears",
  "billing_frequency": "recurring",
  "description": "Monthly platform access fee",
  "metric_ids": [
    "<string>"
  ],
  "revenue_allocation_method": "straight_line",
  "sku": "PLATFORM_FEE",
  "tag_ids": [
    "<string>"
  ],
  "unit_label_plural": "API calls",
  "unit_label_singular": "API call"
}
'

import requests

url = "https://api.alguna.io/products"

payload = {
    "fee_type": "fixed",
    "name": "Platform Fee",
    "payment_terms": "arrears",
    "billing_frequency": "recurring",
    "description": "Monthly platform access fee",
    "metric_ids": ["<string>"],
    "revenue_allocation_method": "straight_line",
    "sku": "PLATFORM_FEE",
    "tag_ids": ["<string>"],
    "unit_label_plural": "API calls",
    "unit_label_singular": "API call"
}
headers = {
    "Alguna-Version": "<alguna-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Alguna-Version': '<alguna-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    fee_type: 'fixed',
    name: 'Platform Fee',
    payment_terms: 'arrears',
    billing_frequency: 'recurring',
    description: 'Monthly platform access fee',
    metric_ids: ['<string>'],
    revenue_allocation_method: 'straight_line',
    sku: 'PLATFORM_FEE',
    tag_ids: ['<string>'],
    unit_label_plural: 'API calls',
    unit_label_singular: 'API call'
  })
};

fetch('https://api.alguna.io/products', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.alguna.io/products",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'fee_type' => 'fixed',
    'name' => 'Platform Fee',
    'payment_terms' => 'arrears',
    'billing_frequency' => 'recurring',
    'description' => 'Monthly platform access fee',
    'metric_ids' => [
        '<string>'
    ],
    'revenue_allocation_method' => 'straight_line',
    'sku' => 'PLATFORM_FEE',
    'tag_ids' => [
        '<string>'
    ],
    'unit_label_plural' => 'API calls',
    'unit_label_singular' => 'API call'
  ]),
  CURLOPT_HTTPHEADER => [
    "Alguna-Version: <alguna-version>",
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.alguna.io/products"

	payload := strings.NewReader("{\n  \"fee_type\": \"fixed\",\n  \"name\": \"Platform Fee\",\n  \"payment_terms\": \"arrears\",\n  \"billing_frequency\": \"recurring\",\n  \"description\": \"Monthly platform access fee\",\n  \"metric_ids\": [\n    \"<string>\"\n  ],\n  \"revenue_allocation_method\": \"straight_line\",\n  \"sku\": \"PLATFORM_FEE\",\n  \"tag_ids\": [\n    \"<string>\"\n  ],\n  \"unit_label_plural\": \"API calls\",\n  \"unit_label_singular\": \"API call\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Alguna-Version", "<alguna-version>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.alguna.io/products")
  .header("Alguna-Version", "<alguna-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fee_type\": \"fixed\",\n  \"name\": \"Platform Fee\",\n  \"payment_terms\": \"arrears\",\n  \"billing_frequency\": \"recurring\",\n  \"description\": \"Monthly platform access fee\",\n  \"metric_ids\": [\n    \"<string>\"\n  ],\n  \"revenue_allocation_method\": \"straight_line\",\n  \"sku\": \"PLATFORM_FEE\",\n  \"tag_ids\": [\n    \"<string>\"\n  ],\n  \"unit_label_plural\": \"API calls\",\n  \"unit_label_singular\": \"API call\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.alguna.io/products")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Alguna-Version"] = '<alguna-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"fee_type\": \"fixed\",\n  \"name\": \"Platform Fee\",\n  \"payment_terms\": \"arrears\",\n  \"billing_frequency\": \"recurring\",\n  \"description\": \"Monthly platform access fee\",\n  \"metric_ids\": [\n    \"<string>\"\n  ],\n  \"revenue_allocation_method\": \"straight_line\",\n  \"sku\": \"PLATFORM_FEE\",\n  \"tag_ids\": [\n    \"<string>\"\n  ],\n  \"unit_label_plural\": \"API calls\",\n  \"unit_label_singular\": \"API call\"\n}"

response = http.request(request)
puts response.read_body

{
  "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"
  ],
  "unit_label_plural": "API calls",
  "unit_label_singular": "API call"
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

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"

Body

application/json

fee_type

enum<string>

required

Whether the product is fixed-price or usage-based

Available options:

fixed,

metered

Example:

"fixed"

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"

billing_frequency

enum<string> | null

How often the product is billed. Required for fixed products; metered products are always recurring

Available options:

recurring,

one-off

Example:

"recurring"

description

string

A brief description of the product

Example:

"Monthly platform access fee"

metric_ids

string[]

Identifiers for metrics to associate with a metered product

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

Example:

"straight_line"

sku

string | null

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

Example:

"PLATFORM_FEE"

tag_ids

string[]

Identifiers for tags to associate with this product

unit_label_plural

string | null

Custom plural term for multiple units of the product (e.g. 'API calls'). Falls back to 'units' when omitted

Example:

"API calls"

unit_label_singular

string | null

Custom singular term for one unit of the product (e.g. 'API call'). Falls back to 'unit' when omitted

Example:

"API call"

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"

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

unit_label_plural

string | null

Custom plural term for multiple units of the product (e.g. 'API calls'). Falls back to 'units' when omitted

Example:

"API calls"

unit_label_singular

string | null

Custom singular term for one unit of the product (e.g. 'API call'). Falls back to 'unit' when omitted

Example:

"API call"

Get a productFetches a single product by ID.

⌘I

Create a product

curl --request POST \
  --url https://api.alguna.io/products \
  --header 'Alguna-Version: <alguna-version>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fee_type": "fixed",
  "name": "Platform Fee",
  "payment_terms": "arrears",
  "billing_frequency": "recurring",
  "description": "Monthly platform access fee",
  "metric_ids": [
    "<string>"
  ],
  "revenue_allocation_method": "straight_line",
  "sku": "PLATFORM_FEE",
  "tag_ids": [
    "<string>"
  ],
  "unit_label_plural": "API calls",
  "unit_label_singular": "API call"
}
'

import requests

url = "https://api.alguna.io/products"

payload = {
    "fee_type": "fixed",
    "name": "Platform Fee",
    "payment_terms": "arrears",
    "billing_frequency": "recurring",
    "description": "Monthly platform access fee",
    "metric_ids": ["<string>"],
    "revenue_allocation_method": "straight_line",
    "sku": "PLATFORM_FEE",
    "tag_ids": ["<string>"],
    "unit_label_plural": "API calls",
    "unit_label_singular": "API call"
}
headers = {
    "Alguna-Version": "<alguna-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Alguna-Version': '<alguna-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    fee_type: 'fixed',
    name: 'Platform Fee',
    payment_terms: 'arrears',
    billing_frequency: 'recurring',
    description: 'Monthly platform access fee',
    metric_ids: ['<string>'],
    revenue_allocation_method: 'straight_line',
    sku: 'PLATFORM_FEE',
    tag_ids: ['<string>'],
    unit_label_plural: 'API calls',
    unit_label_singular: 'API call'
  })
};

fetch('https://api.alguna.io/products', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.alguna.io/products",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'fee_type' => 'fixed',
    'name' => 'Platform Fee',
    'payment_terms' => 'arrears',
    'billing_frequency' => 'recurring',
    'description' => 'Monthly platform access fee',
    'metric_ids' => [
        '<string>'
    ],
    'revenue_allocation_method' => 'straight_line',
    'sku' => 'PLATFORM_FEE',
    'tag_ids' => [
        '<string>'
    ],
    'unit_label_plural' => 'API calls',
    'unit_label_singular' => 'API call'
  ]),
  CURLOPT_HTTPHEADER => [
    "Alguna-Version: <alguna-version>",
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.alguna.io/products"

	payload := strings.NewReader("{\n  \"fee_type\": \"fixed\",\n  \"name\": \"Platform Fee\",\n  \"payment_terms\": \"arrears\",\n  \"billing_frequency\": \"recurring\",\n  \"description\": \"Monthly platform access fee\",\n  \"metric_ids\": [\n    \"<string>\"\n  ],\n  \"revenue_allocation_method\": \"straight_line\",\n  \"sku\": \"PLATFORM_FEE\",\n  \"tag_ids\": [\n    \"<string>\"\n  ],\n  \"unit_label_plural\": \"API calls\",\n  \"unit_label_singular\": \"API call\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Alguna-Version", "<alguna-version>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.alguna.io/products")
  .header("Alguna-Version", "<alguna-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fee_type\": \"fixed\",\n  \"name\": \"Platform Fee\",\n  \"payment_terms\": \"arrears\",\n  \"billing_frequency\": \"recurring\",\n  \"description\": \"Monthly platform access fee\",\n  \"metric_ids\": [\n    \"<string>\"\n  ],\n  \"revenue_allocation_method\": \"straight_line\",\n  \"sku\": \"PLATFORM_FEE\",\n  \"tag_ids\": [\n    \"<string>\"\n  ],\n  \"unit_label_plural\": \"API calls\",\n  \"unit_label_singular\": \"API call\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.alguna.io/products")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Alguna-Version"] = '<alguna-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"fee_type\": \"fixed\",\n  \"name\": \"Platform Fee\",\n  \"payment_terms\": \"arrears\",\n  \"billing_frequency\": \"recurring\",\n  \"description\": \"Monthly platform access fee\",\n  \"metric_ids\": [\n    \"<string>\"\n  ],\n  \"revenue_allocation_method\": \"straight_line\",\n  \"sku\": \"PLATFORM_FEE\",\n  \"tag_ids\": [\n    \"<string>\"\n  ],\n  \"unit_label_plural\": \"API calls\",\n  \"unit_label_singular\": \"API call\"\n}"

response = http.request(request)
puts response.read_body

{
  "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"
  ],
  "unit_label_plural": "API calls",
  "unit_label_singular": "API call"
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

API Reference

Examples

API Reference

Authorizations

Headers

Body

Response