Plans
Create a plan
Creates a new plan with its full pricing template — name, currency, contract configuration, and the items (standalone priced products and/or bundles) that subscriptions will inherit. Optional fields cover plan-level discount, spend thresholds, price escalation, entitlements, tags, and invoice/email behavior.
POST
/
plans
Create a plan
curl --request POST \
--url https://api.alguna.io/plans \
--header 'Alguna-Version: <alguna-version>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"currency": "USD",
"name": "Enterprise Plan",
"additional_terms": "<string>",
"auto_activate": false,
"auto_renew": true,
"contract_duration": 12,
"contract_period_type": "fixed",
"description": "Full-featured enterprise plan",
"discount": {
"amount": "10",
"duration_type": "fixed",
"type": "percentage",
"duration_unit": "months",
"duration_value": 6
},
"entitlements": [
{
"entitlement_key": "api_access",
"mode": "static",
"type": "boolean",
"allocation": {
"amount": "100000",
"credit_type": "monetary",
"rollover_enabled": true,
"rollover_max_periods": 3
},
"timing": {
"recurrence": "recurring",
"interval": "monthly"
},
"value": "true"
}
],
"invoice_settings": {
"auto_issue_invoices": true,
"auto_pay_invoices": false,
"invoice_footer_text": "Questions? support@example.com",
"invoice_memo_template": "Thanks for your business",
"send_activation_email": true,
"send_invoices_to_customer": true,
"send_receipts_to_customer": true
},
"items": [
{
"bundle_description": "Premium support and SSO",
"bundle_id": "bun_abc123",
"items": [
{
"price": {
"billing_direction": "arrears",
"fee_type": "fixed",
"type": "fixed",
"billing_frequency": "recurring",
"billing_interval": "monthly",
"billing_interval_count": 3,
"billing_interval_unit": "month",
"charge_on_contract_start": false,
"discount": {
"amount": "10",
"duration_type": "fixed",
"type": "percentage",
"duration_unit": "months",
"duration_value": 6
},
"display_order": 1,
"expression_pricing_model": {
"charges": [
{
"billing_direction": "arrears",
"description": "API usage charge",
"quantity_expression": "usage.api_calls",
"unit_price_expression": "0.01"
}
],
"metric_bindings": [
{
"alias": "api_calls",
"metric_id": "<string>"
}
]
},
"fixed_pricing_model": {
"price_per_unit": "500.00",
"units": 1
},
"graduated_percentage_pricing_model": {
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"percentage": "2.5"
}
]
},
"graduated_tiered_pricing_model": {
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"price_per_unit": "0.02"
}
],
"units": 10
},
"maximum_spend": {
"amount": "500.00",
"period": "monthly"
},
"metric_ids": [
"<string>"
],
"minimum_spend": {
"amount": "500.00",
"period": "monthly"
},
"prepaid_fixed_tiered_pricing_model": {
"overages_charge_interval": "monthly",
"prepaid_units": 50000,
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"price_per_unit": "0.02"
}
]
},
"prepaid_tiered_pricing_model": {
"prepaid_units": 50000,
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"price_per_unit": "0.02"
}
]
},
"recurring_instalment_interval_count": 1,
"recurring_instalment_interval_unit": "month",
"tiered_percentage_pricing_model": {
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"percentage": "2.5"
}
]
},
"tiered_pricing_model": {
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"price_per_unit": "0.02"
}
],
"units": 10
},
"trial_period_days": 30,
"unit_pricing_model": {
"price_per_unit": "0.05"
},
"volume_percentage_pricing_model": {
"percentage": "2.0",
"price_per_unit": "0.05",
"fixed_fee": "5.00"
}
},
"product_id": "prod_abc123"
}
],
"name": "Enterprise Add-ons",
"price": {
"billing_direction": "arrears",
"fee_type": "fixed",
"type": "fixed",
"billing_frequency": "recurring",
"billing_interval": "monthly",
"billing_interval_count": 3,
"billing_interval_unit": "month",
"charge_on_contract_start": false,
"discount": {
"amount": "10",
"duration_type": "fixed",
"type": "percentage",
"duration_unit": "months",
"duration_value": 6
},
"display_order": 1,
"expression_pricing_model": {
"charges": [
{
"billing_direction": "arrears",
"description": "API usage charge",
"quantity_expression": "usage.api_calls",
"unit_price_expression": "0.01"
}
],
"metric_bindings": [
{
"alias": "api_calls",
"metric_id": "<string>"
}
]
},
"fixed_pricing_model": {
"price_per_unit": "500.00",
"units": 1
},
"graduated_percentage_pricing_model": {
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"percentage": "2.5"
}
]
},
"graduated_tiered_pricing_model": {
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"price_per_unit": "0.02"
}
],
"units": 10
},
"maximum_spend": {
"amount": "500.00",
"period": "monthly"
},
"metric_ids": [
"<string>"
],
"minimum_spend": {
"amount": "500.00",
"period": "monthly"
},
"prepaid_fixed_tiered_pricing_model": {
"overages_charge_interval": "monthly",
"prepaid_units": 50000,
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"price_per_unit": "0.02"
}
]
},
"prepaid_tiered_pricing_model": {
"prepaid_units": 50000,
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"price_per_unit": "0.02"
}
]
},
"recurring_instalment_interval_count": 1,
"recurring_instalment_interval_unit": "month",
"tiered_percentage_pricing_model": {
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"percentage": "2.5"
}
]
},
"tiered_pricing_model": {
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"price_per_unit": "0.02"
}
],
"units": 10
},
"trial_period_days": 30,
"unit_pricing_model": {
"price_per_unit": "0.05"
},
"volume_percentage_pricing_model": {
"percentage": "2.0",
"price_per_unit": "0.05",
"fixed_fee": "5.00"
}
},
"product_id": "prod_abc123"
}
],
"maximum_spend": {
"amount": "500.00",
"period": "monthly"
},
"minimum_spend": {
"amount": "500.00",
"period": "monthly"
},
"payment_terms": "net_30",
"price_escalation": {
"enabled": true,
"interval_months": 12,
"type": "percentage",
"escalate_metered_unit_rates": false,
"percentage": "5.00"
},
"renewal_duration": 12,
"tags": [
"tag_abc123"
],
"trial_period_days": 14
}
'import requests
url = "https://api.alguna.io/plans"
payload = {
"currency": "USD",
"name": "Enterprise Plan",
"additional_terms": "<string>",
"auto_activate": False,
"auto_renew": True,
"contract_duration": 12,
"contract_period_type": "fixed",
"description": "Full-featured enterprise plan",
"discount": {
"amount": "10",
"duration_type": "fixed",
"type": "percentage",
"duration_unit": "months",
"duration_value": 6
},
"entitlements": [
{
"entitlement_key": "api_access",
"mode": "static",
"type": "boolean",
"allocation": {
"amount": "100000",
"credit_type": "monetary",
"rollover_enabled": True,
"rollover_max_periods": 3
},
"timing": {
"recurrence": "recurring",
"interval": "monthly"
},
"value": "true"
}
],
"invoice_settings": {
"auto_issue_invoices": True,
"auto_pay_invoices": False,
"invoice_footer_text": "Questions? support@example.com",
"invoice_memo_template": "Thanks for your business",
"send_activation_email": True,
"send_invoices_to_customer": True,
"send_receipts_to_customer": True
},
"items": [
{
"bundle_description": "Premium support and SSO",
"bundle_id": "bun_abc123",
"items": [
{
"price": {
"billing_direction": "arrears",
"fee_type": "fixed",
"type": "fixed",
"billing_frequency": "recurring",
"billing_interval": "monthly",
"billing_interval_count": 3,
"billing_interval_unit": "month",
"charge_on_contract_start": False,
"discount": {
"amount": "10",
"duration_type": "fixed",
"type": "percentage",
"duration_unit": "months",
"duration_value": 6
},
"display_order": 1,
"expression_pricing_model": {
"charges": [
{
"billing_direction": "arrears",
"description": "API usage charge",
"quantity_expression": "usage.api_calls",
"unit_price_expression": "0.01"
}
],
"metric_bindings": [
{
"alias": "api_calls",
"metric_id": "<string>"
}
]
},
"fixed_pricing_model": {
"price_per_unit": "500.00",
"units": 1
},
"graduated_percentage_pricing_model": { "tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"percentage": "2.5"
}
] },
"graduated_tiered_pricing_model": {
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"price_per_unit": "0.02"
}
],
"units": 10
},
"maximum_spend": {
"amount": "500.00",
"period": "monthly"
},
"metric_ids": ["<string>"],
"minimum_spend": {
"amount": "500.00",
"period": "monthly"
},
"prepaid_fixed_tiered_pricing_model": {
"overages_charge_interval": "monthly",
"prepaid_units": 50000,
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"price_per_unit": "0.02"
}
]
},
"prepaid_tiered_pricing_model": {
"prepaid_units": 50000,
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"price_per_unit": "0.02"
}
]
},
"recurring_instalment_interval_count": 1,
"recurring_instalment_interval_unit": "month",
"tiered_percentage_pricing_model": { "tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"percentage": "2.5"
}
] },
"tiered_pricing_model": {
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"price_per_unit": "0.02"
}
],
"units": 10
},
"trial_period_days": 30,
"unit_pricing_model": { "price_per_unit": "0.05" },
"volume_percentage_pricing_model": {
"percentage": "2.0",
"price_per_unit": "0.05",
"fixed_fee": "5.00"
}
},
"product_id": "prod_abc123"
}
],
"name": "Enterprise Add-ons",
"price": {
"billing_direction": "arrears",
"fee_type": "fixed",
"type": "fixed",
"billing_frequency": "recurring",
"billing_interval": "monthly",
"billing_interval_count": 3,
"billing_interval_unit": "month",
"charge_on_contract_start": False,
"discount": {
"amount": "10",
"duration_type": "fixed",
"type": "percentage",
"duration_unit": "months",
"duration_value": 6
},
"display_order": 1,
"expression_pricing_model": {
"charges": [
{
"billing_direction": "arrears",
"description": "API usage charge",
"quantity_expression": "usage.api_calls",
"unit_price_expression": "0.01"
}
],
"metric_bindings": [
{
"alias": "api_calls",
"metric_id": "<string>"
}
]
},
"fixed_pricing_model": {
"price_per_unit": "500.00",
"units": 1
},
"graduated_percentage_pricing_model": { "tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"percentage": "2.5"
}
] },
"graduated_tiered_pricing_model": {
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"price_per_unit": "0.02"
}
],
"units": 10
},
"maximum_spend": {
"amount": "500.00",
"period": "monthly"
},
"metric_ids": ["<string>"],
"minimum_spend": {
"amount": "500.00",
"period": "monthly"
},
"prepaid_fixed_tiered_pricing_model": {
"overages_charge_interval": "monthly",
"prepaid_units": 50000,
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"price_per_unit": "0.02"
}
]
},
"prepaid_tiered_pricing_model": {
"prepaid_units": 50000,
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"price_per_unit": "0.02"
}
]
},
"recurring_instalment_interval_count": 1,
"recurring_instalment_interval_unit": "month",
"tiered_percentage_pricing_model": { "tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"percentage": "2.5"
}
] },
"tiered_pricing_model": {
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"price_per_unit": "0.02"
}
],
"units": 10
},
"trial_period_days": 30,
"unit_pricing_model": { "price_per_unit": "0.05" },
"volume_percentage_pricing_model": {
"percentage": "2.0",
"price_per_unit": "0.05",
"fixed_fee": "5.00"
}
},
"product_id": "prod_abc123"
}
],
"maximum_spend": {
"amount": "500.00",
"period": "monthly"
},
"minimum_spend": {
"amount": "500.00",
"period": "monthly"
},
"payment_terms": "net_30",
"price_escalation": {
"enabled": True,
"interval_months": 12,
"type": "percentage",
"escalate_metered_unit_rates": False,
"percentage": "5.00"
},
"renewal_duration": 12,
"tags": ["tag_abc123"],
"trial_period_days": 14
}
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({
currency: 'USD',
name: 'Enterprise Plan',
additional_terms: '<string>',
auto_activate: false,
auto_renew: true,
contract_duration: 12,
contract_period_type: 'fixed',
description: 'Full-featured enterprise plan',
discount: {
amount: '10',
duration_type: 'fixed',
type: 'percentage',
duration_unit: 'months',
duration_value: 6
},
entitlements: [
{
entitlement_key: 'api_access',
mode: 'static',
type: 'boolean',
allocation: {
amount: '100000',
credit_type: 'monetary',
rollover_enabled: true,
rollover_max_periods: 3
},
timing: {recurrence: 'recurring', interval: 'monthly'},
value: 'true'
}
],
invoice_settings: {
auto_issue_invoices: true,
auto_pay_invoices: false,
invoice_footer_text: 'Questions? support@example.com',
invoice_memo_template: 'Thanks for your business',
send_activation_email: true,
send_invoices_to_customer: true,
send_receipts_to_customer: true
},
items: [
{
bundle_description: 'Premium support and SSO',
bundle_id: 'bun_abc123',
items: [
{
price: {
billing_direction: 'arrears',
fee_type: 'fixed',
type: 'fixed',
billing_frequency: 'recurring',
billing_interval: 'monthly',
billing_interval_count: 3,
billing_interval_unit: 'month',
charge_on_contract_start: false,
discount: {
amount: '10',
duration_type: 'fixed',
type: 'percentage',
duration_unit: 'months',
duration_value: 6
},
display_order: 1,
expression_pricing_model: {
charges: [
{
billing_direction: 'arrears',
description: 'API usage charge',
quantity_expression: 'usage.api_calls',
unit_price_expression: '0.01'
}
],
metric_bindings: [{alias: 'api_calls', metric_id: '<string>'}]
},
fixed_pricing_model: {price_per_unit: '500.00', units: 1},
graduated_percentage_pricing_model: {
tiers: [{min_units: 0, fixed_fee: '10.00', max_units: 10000, percentage: '2.5'}]
},
graduated_tiered_pricing_model: {
tiers: [{min_units: 0, fixed_fee: '10.00', max_units: 10000, price_per_unit: '0.02'}],
units: 10
},
maximum_spend: {amount: '500.00', period: 'monthly'},
metric_ids: ['<string>'],
minimum_spend: {amount: '500.00', period: 'monthly'},
prepaid_fixed_tiered_pricing_model: {
overages_charge_interval: 'monthly',
prepaid_units: 50000,
tiers: [{min_units: 0, fixed_fee: '10.00', max_units: 10000, price_per_unit: '0.02'}]
},
prepaid_tiered_pricing_model: {
prepaid_units: 50000,
tiers: [{min_units: 0, fixed_fee: '10.00', max_units: 10000, price_per_unit: '0.02'}]
},
recurring_instalment_interval_count: 1,
recurring_instalment_interval_unit: 'month',
tiered_percentage_pricing_model: {
tiers: [{min_units: 0, fixed_fee: '10.00', max_units: 10000, percentage: '2.5'}]
},
tiered_pricing_model: {
tiers: [{min_units: 0, fixed_fee: '10.00', max_units: 10000, price_per_unit: '0.02'}],
units: 10
},
trial_period_days: 30,
unit_pricing_model: {price_per_unit: '0.05'},
volume_percentage_pricing_model: {percentage: '2.0', price_per_unit: '0.05', fixed_fee: '5.00'}
},
product_id: 'prod_abc123'
}
],
name: 'Enterprise Add-ons',
price: {
billing_direction: 'arrears',
fee_type: 'fixed',
type: 'fixed',
billing_frequency: 'recurring',
billing_interval: 'monthly',
billing_interval_count: 3,
billing_interval_unit: 'month',
charge_on_contract_start: false,
discount: {
amount: '10',
duration_type: 'fixed',
type: 'percentage',
duration_unit: 'months',
duration_value: 6
},
display_order: 1,
expression_pricing_model: {
charges: [
{
billing_direction: 'arrears',
description: 'API usage charge',
quantity_expression: 'usage.api_calls',
unit_price_expression: '0.01'
}
],
metric_bindings: [{alias: 'api_calls', metric_id: '<string>'}]
},
fixed_pricing_model: {price_per_unit: '500.00', units: 1},
graduated_percentage_pricing_model: {
tiers: [{min_units: 0, fixed_fee: '10.00', max_units: 10000, percentage: '2.5'}]
},
graduated_tiered_pricing_model: {
tiers: [{min_units: 0, fixed_fee: '10.00', max_units: 10000, price_per_unit: '0.02'}],
units: 10
},
maximum_spend: {amount: '500.00', period: 'monthly'},
metric_ids: ['<string>'],
minimum_spend: {amount: '500.00', period: 'monthly'},
prepaid_fixed_tiered_pricing_model: {
overages_charge_interval: 'monthly',
prepaid_units: 50000,
tiers: [{min_units: 0, fixed_fee: '10.00', max_units: 10000, price_per_unit: '0.02'}]
},
prepaid_tiered_pricing_model: {
prepaid_units: 50000,
tiers: [{min_units: 0, fixed_fee: '10.00', max_units: 10000, price_per_unit: '0.02'}]
},
recurring_instalment_interval_count: 1,
recurring_instalment_interval_unit: 'month',
tiered_percentage_pricing_model: {
tiers: [{min_units: 0, fixed_fee: '10.00', max_units: 10000, percentage: '2.5'}]
},
tiered_pricing_model: {
tiers: [{min_units: 0, fixed_fee: '10.00', max_units: 10000, price_per_unit: '0.02'}],
units: 10
},
trial_period_days: 30,
unit_pricing_model: {price_per_unit: '0.05'},
volume_percentage_pricing_model: {percentage: '2.0', price_per_unit: '0.05', fixed_fee: '5.00'}
},
product_id: 'prod_abc123'
}
],
maximum_spend: {amount: '500.00', period: 'monthly'},
minimum_spend: {amount: '500.00', period: 'monthly'},
payment_terms: 'net_30',
price_escalation: {
enabled: true,
interval_months: 12,
type: 'percentage',
escalate_metered_unit_rates: false,
percentage: '5.00'
},
renewal_duration: 12,
tags: ['tag_abc123'],
trial_period_days: 14
})
};
fetch('https://api.alguna.io/plans', 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/plans",
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([
'currency' => 'USD',
'name' => 'Enterprise Plan',
'additional_terms' => '<string>',
'auto_activate' => false,
'auto_renew' => true,
'contract_duration' => 12,
'contract_period_type' => 'fixed',
'description' => 'Full-featured enterprise plan',
'discount' => [
'amount' => '10',
'duration_type' => 'fixed',
'type' => 'percentage',
'duration_unit' => 'months',
'duration_value' => 6
],
'entitlements' => [
[
'entitlement_key' => 'api_access',
'mode' => 'static',
'type' => 'boolean',
'allocation' => [
'amount' => '100000',
'credit_type' => 'monetary',
'rollover_enabled' => true,
'rollover_max_periods' => 3
],
'timing' => [
'recurrence' => 'recurring',
'interval' => 'monthly'
],
'value' => 'true'
]
],
'invoice_settings' => [
'auto_issue_invoices' => true,
'auto_pay_invoices' => false,
'invoice_footer_text' => 'Questions? support@example.com',
'invoice_memo_template' => 'Thanks for your business',
'send_activation_email' => true,
'send_invoices_to_customer' => true,
'send_receipts_to_customer' => true
],
'items' => [
[
'bundle_description' => 'Premium support and SSO',
'bundle_id' => 'bun_abc123',
'items' => [
[
'price' => [
'billing_direction' => 'arrears',
'fee_type' => 'fixed',
'type' => 'fixed',
'billing_frequency' => 'recurring',
'billing_interval' => 'monthly',
'billing_interval_count' => 3,
'billing_interval_unit' => 'month',
'charge_on_contract_start' => false,
'discount' => [
'amount' => '10',
'duration_type' => 'fixed',
'type' => 'percentage',
'duration_unit' => 'months',
'duration_value' => 6
],
'display_order' => 1,
'expression_pricing_model' => [
'charges' => [
[
'billing_direction' => 'arrears',
'description' => 'API usage charge',
'quantity_expression' => 'usage.api_calls',
'unit_price_expression' => '0.01'
]
],
'metric_bindings' => [
[
'alias' => 'api_calls',
'metric_id' => '<string>'
]
]
],
'fixed_pricing_model' => [
'price_per_unit' => '500.00',
'units' => 1
],
'graduated_percentage_pricing_model' => [
'tiers' => [
[
'min_units' => 0,
'fixed_fee' => '10.00',
'max_units' => 10000,
'percentage' => '2.5'
]
]
],
'graduated_tiered_pricing_model' => [
'tiers' => [
[
'min_units' => 0,
'fixed_fee' => '10.00',
'max_units' => 10000,
'price_per_unit' => '0.02'
]
],
'units' => 10
],
'maximum_spend' => [
'amount' => '500.00',
'period' => 'monthly'
],
'metric_ids' => [
'<string>'
],
'minimum_spend' => [
'amount' => '500.00',
'period' => 'monthly'
],
'prepaid_fixed_tiered_pricing_model' => [
'overages_charge_interval' => 'monthly',
'prepaid_units' => 50000,
'tiers' => [
[
'min_units' => 0,
'fixed_fee' => '10.00',
'max_units' => 10000,
'price_per_unit' => '0.02'
]
]
],
'prepaid_tiered_pricing_model' => [
'prepaid_units' => 50000,
'tiers' => [
[
'min_units' => 0,
'fixed_fee' => '10.00',
'max_units' => 10000,
'price_per_unit' => '0.02'
]
]
],
'recurring_instalment_interval_count' => 1,
'recurring_instalment_interval_unit' => 'month',
'tiered_percentage_pricing_model' => [
'tiers' => [
[
'min_units' => 0,
'fixed_fee' => '10.00',
'max_units' => 10000,
'percentage' => '2.5'
]
]
],
'tiered_pricing_model' => [
'tiers' => [
[
'min_units' => 0,
'fixed_fee' => '10.00',
'max_units' => 10000,
'price_per_unit' => '0.02'
]
],
'units' => 10
],
'trial_period_days' => 30,
'unit_pricing_model' => [
'price_per_unit' => '0.05'
],
'volume_percentage_pricing_model' => [
'percentage' => '2.0',
'price_per_unit' => '0.05',
'fixed_fee' => '5.00'
]
],
'product_id' => 'prod_abc123'
]
],
'name' => 'Enterprise Add-ons',
'price' => [
'billing_direction' => 'arrears',
'fee_type' => 'fixed',
'type' => 'fixed',
'billing_frequency' => 'recurring',
'billing_interval' => 'monthly',
'billing_interval_count' => 3,
'billing_interval_unit' => 'month',
'charge_on_contract_start' => false,
'discount' => [
'amount' => '10',
'duration_type' => 'fixed',
'type' => 'percentage',
'duration_unit' => 'months',
'duration_value' => 6
],
'display_order' => 1,
'expression_pricing_model' => [
'charges' => [
[
'billing_direction' => 'arrears',
'description' => 'API usage charge',
'quantity_expression' => 'usage.api_calls',
'unit_price_expression' => '0.01'
]
],
'metric_bindings' => [
[
'alias' => 'api_calls',
'metric_id' => '<string>'
]
]
],
'fixed_pricing_model' => [
'price_per_unit' => '500.00',
'units' => 1
],
'graduated_percentage_pricing_model' => [
'tiers' => [
[
'min_units' => 0,
'fixed_fee' => '10.00',
'max_units' => 10000,
'percentage' => '2.5'
]
]
],
'graduated_tiered_pricing_model' => [
'tiers' => [
[
'min_units' => 0,
'fixed_fee' => '10.00',
'max_units' => 10000,
'price_per_unit' => '0.02'
]
],
'units' => 10
],
'maximum_spend' => [
'amount' => '500.00',
'period' => 'monthly'
],
'metric_ids' => [
'<string>'
],
'minimum_spend' => [
'amount' => '500.00',
'period' => 'monthly'
],
'prepaid_fixed_tiered_pricing_model' => [
'overages_charge_interval' => 'monthly',
'prepaid_units' => 50000,
'tiers' => [
[
'min_units' => 0,
'fixed_fee' => '10.00',
'max_units' => 10000,
'price_per_unit' => '0.02'
]
]
],
'prepaid_tiered_pricing_model' => [
'prepaid_units' => 50000,
'tiers' => [
[
'min_units' => 0,
'fixed_fee' => '10.00',
'max_units' => 10000,
'price_per_unit' => '0.02'
]
]
],
'recurring_instalment_interval_count' => 1,
'recurring_instalment_interval_unit' => 'month',
'tiered_percentage_pricing_model' => [
'tiers' => [
[
'min_units' => 0,
'fixed_fee' => '10.00',
'max_units' => 10000,
'percentage' => '2.5'
]
]
],
'tiered_pricing_model' => [
'tiers' => [
[
'min_units' => 0,
'fixed_fee' => '10.00',
'max_units' => 10000,
'price_per_unit' => '0.02'
]
],
'units' => 10
],
'trial_period_days' => 30,
'unit_pricing_model' => [
'price_per_unit' => '0.05'
],
'volume_percentage_pricing_model' => [
'percentage' => '2.0',
'price_per_unit' => '0.05',
'fixed_fee' => '5.00'
]
],
'product_id' => 'prod_abc123'
]
],
'maximum_spend' => [
'amount' => '500.00',
'period' => 'monthly'
],
'minimum_spend' => [
'amount' => '500.00',
'period' => 'monthly'
],
'payment_terms' => 'net_30',
'price_escalation' => [
'enabled' => true,
'interval_months' => 12,
'type' => 'percentage',
'escalate_metered_unit_rates' => false,
'percentage' => '5.00'
],
'renewal_duration' => 12,
'tags' => [
'tag_abc123'
],
'trial_period_days' => 14
]),
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/plans"
payload := strings.NewReader("{\n \"currency\": \"USD\",\n \"name\": \"Enterprise Plan\",\n \"additional_terms\": \"<string>\",\n \"auto_activate\": false,\n \"auto_renew\": true,\n \"contract_duration\": 12,\n \"contract_period_type\": \"fixed\",\n \"description\": \"Full-featured enterprise plan\",\n \"discount\": {\n \"amount\": \"10\",\n \"duration_type\": \"fixed\",\n \"type\": \"percentage\",\n \"duration_unit\": \"months\",\n \"duration_value\": 6\n },\n \"entitlements\": [\n {\n \"entitlement_key\": \"api_access\",\n \"mode\": \"static\",\n \"type\": \"boolean\",\n \"allocation\": {\n \"amount\": \"100000\",\n \"credit_type\": \"monetary\",\n \"rollover_enabled\": true,\n \"rollover_max_periods\": 3\n },\n \"timing\": {\n \"recurrence\": \"recurring\",\n \"interval\": \"monthly\"\n },\n \"value\": \"true\"\n }\n ],\n \"invoice_settings\": {\n \"auto_issue_invoices\": true,\n \"auto_pay_invoices\": false,\n \"invoice_footer_text\": \"Questions? support@example.com\",\n \"invoice_memo_template\": \"Thanks for your business\",\n \"send_activation_email\": true,\n \"send_invoices_to_customer\": true,\n \"send_receipts_to_customer\": true\n },\n \"items\": [\n {\n \"bundle_description\": \"Premium support and SSO\",\n \"bundle_id\": \"bun_abc123\",\n \"items\": [\n {\n \"price\": {\n \"billing_direction\": \"arrears\",\n \"fee_type\": \"fixed\",\n \"type\": \"fixed\",\n \"billing_frequency\": \"recurring\",\n \"billing_interval\": \"monthly\",\n \"billing_interval_count\": 3,\n \"billing_interval_unit\": \"month\",\n \"charge_on_contract_start\": false,\n \"discount\": {\n \"amount\": \"10\",\n \"duration_type\": \"fixed\",\n \"type\": \"percentage\",\n \"duration_unit\": \"months\",\n \"duration_value\": 6\n },\n \"display_order\": 1,\n \"expression_pricing_model\": {\n \"charges\": [\n {\n \"billing_direction\": \"arrears\",\n \"description\": \"API usage charge\",\n \"quantity_expression\": \"usage.api_calls\",\n \"unit_price_expression\": \"0.01\"\n }\n ],\n \"metric_bindings\": [\n {\n \"alias\": \"api_calls\",\n \"metric_id\": \"<string>\"\n }\n ]\n },\n \"fixed_pricing_model\": {\n \"price_per_unit\": \"500.00\",\n \"units\": 1\n },\n \"graduated_percentage_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"percentage\": \"2.5\"\n }\n ]\n },\n \"graduated_tiered_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ],\n \"units\": 10\n },\n \"maximum_spend\": {\n \"amount\": \"500.00\",\n \"period\": \"monthly\"\n },\n \"metric_ids\": [\n \"<string>\"\n ],\n \"minimum_spend\": {\n \"amount\": \"500.00\",\n \"period\": \"monthly\"\n },\n \"prepaid_fixed_tiered_pricing_model\": {\n \"overages_charge_interval\": \"monthly\",\n \"prepaid_units\": 50000,\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ]\n },\n \"prepaid_tiered_pricing_model\": {\n \"prepaid_units\": 50000,\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ]\n },\n \"recurring_instalment_interval_count\": 1,\n \"recurring_instalment_interval_unit\": \"month\",\n \"tiered_percentage_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"percentage\": \"2.5\"\n }\n ]\n },\n \"tiered_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ],\n \"units\": 10\n },\n \"trial_period_days\": 30,\n \"unit_pricing_model\": {\n \"price_per_unit\": \"0.05\"\n },\n \"volume_percentage_pricing_model\": {\n \"percentage\": \"2.0\",\n \"price_per_unit\": \"0.05\",\n \"fixed_fee\": \"5.00\"\n }\n },\n \"product_id\": \"prod_abc123\"\n }\n ],\n \"name\": \"Enterprise Add-ons\",\n \"price\": {\n \"billing_direction\": \"arrears\",\n \"fee_type\": \"fixed\",\n \"type\": \"fixed\",\n \"billing_frequency\": \"recurring\",\n \"billing_interval\": \"monthly\",\n \"billing_interval_count\": 3,\n \"billing_interval_unit\": \"month\",\n \"charge_on_contract_start\": false,\n \"discount\": {\n \"amount\": \"10\",\n \"duration_type\": \"fixed\",\n \"type\": \"percentage\",\n \"duration_unit\": \"months\",\n \"duration_value\": 6\n },\n \"display_order\": 1,\n \"expression_pricing_model\": {\n \"charges\": [\n {\n \"billing_direction\": \"arrears\",\n \"description\": \"API usage charge\",\n \"quantity_expression\": \"usage.api_calls\",\n \"unit_price_expression\": \"0.01\"\n }\n ],\n \"metric_bindings\": [\n {\n \"alias\": \"api_calls\",\n \"metric_id\": \"<string>\"\n }\n ]\n },\n \"fixed_pricing_model\": {\n \"price_per_unit\": \"500.00\",\n \"units\": 1\n },\n \"graduated_percentage_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"percentage\": \"2.5\"\n }\n ]\n },\n \"graduated_tiered_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ],\n \"units\": 10\n },\n \"maximum_spend\": {\n \"amount\": \"500.00\",\n \"period\": \"monthly\"\n },\n \"metric_ids\": [\n \"<string>\"\n ],\n \"minimum_spend\": {\n \"amount\": \"500.00\",\n \"period\": \"monthly\"\n },\n \"prepaid_fixed_tiered_pricing_model\": {\n \"overages_charge_interval\": \"monthly\",\n \"prepaid_units\": 50000,\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ]\n },\n \"prepaid_tiered_pricing_model\": {\n \"prepaid_units\": 50000,\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ]\n },\n \"recurring_instalment_interval_count\": 1,\n \"recurring_instalment_interval_unit\": \"month\",\n \"tiered_percentage_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"percentage\": \"2.5\"\n }\n ]\n },\n \"tiered_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ],\n \"units\": 10\n },\n \"trial_period_days\": 30,\n \"unit_pricing_model\": {\n \"price_per_unit\": \"0.05\"\n },\n \"volume_percentage_pricing_model\": {\n \"percentage\": \"2.0\",\n \"price_per_unit\": \"0.05\",\n \"fixed_fee\": \"5.00\"\n }\n },\n \"product_id\": \"prod_abc123\"\n }\n ],\n \"maximum_spend\": {\n \"amount\": \"500.00\",\n \"period\": \"monthly\"\n },\n \"minimum_spend\": {\n \"amount\": \"500.00\",\n \"period\": \"monthly\"\n },\n \"payment_terms\": \"net_30\",\n \"price_escalation\": {\n \"enabled\": true,\n \"interval_months\": 12,\n \"type\": \"percentage\",\n \"escalate_metered_unit_rates\": false,\n \"percentage\": \"5.00\"\n },\n \"renewal_duration\": 12,\n \"tags\": [\n \"tag_abc123\"\n ],\n \"trial_period_days\": 14\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/plans")
.header("Alguna-Version", "<alguna-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"currency\": \"USD\",\n \"name\": \"Enterprise Plan\",\n \"additional_terms\": \"<string>\",\n \"auto_activate\": false,\n \"auto_renew\": true,\n \"contract_duration\": 12,\n \"contract_period_type\": \"fixed\",\n \"description\": \"Full-featured enterprise plan\",\n \"discount\": {\n \"amount\": \"10\",\n \"duration_type\": \"fixed\",\n \"type\": \"percentage\",\n \"duration_unit\": \"months\",\n \"duration_value\": 6\n },\n \"entitlements\": [\n {\n \"entitlement_key\": \"api_access\",\n \"mode\": \"static\",\n \"type\": \"boolean\",\n \"allocation\": {\n \"amount\": \"100000\",\n \"credit_type\": \"monetary\",\n \"rollover_enabled\": true,\n \"rollover_max_periods\": 3\n },\n \"timing\": {\n \"recurrence\": \"recurring\",\n \"interval\": \"monthly\"\n },\n \"value\": \"true\"\n }\n ],\n \"invoice_settings\": {\n \"auto_issue_invoices\": true,\n \"auto_pay_invoices\": false,\n \"invoice_footer_text\": \"Questions? support@example.com\",\n \"invoice_memo_template\": \"Thanks for your business\",\n \"send_activation_email\": true,\n \"send_invoices_to_customer\": true,\n \"send_receipts_to_customer\": true\n },\n \"items\": [\n {\n \"bundle_description\": \"Premium support and SSO\",\n \"bundle_id\": \"bun_abc123\",\n \"items\": [\n {\n \"price\": {\n \"billing_direction\": \"arrears\",\n \"fee_type\": \"fixed\",\n \"type\": \"fixed\",\n \"billing_frequency\": \"recurring\",\n \"billing_interval\": \"monthly\",\n \"billing_interval_count\": 3,\n \"billing_interval_unit\": \"month\",\n \"charge_on_contract_start\": false,\n \"discount\": {\n \"amount\": \"10\",\n \"duration_type\": \"fixed\",\n \"type\": \"percentage\",\n \"duration_unit\": \"months\",\n \"duration_value\": 6\n },\n \"display_order\": 1,\n \"expression_pricing_model\": {\n \"charges\": [\n {\n \"billing_direction\": \"arrears\",\n \"description\": \"API usage charge\",\n \"quantity_expression\": \"usage.api_calls\",\n \"unit_price_expression\": \"0.01\"\n }\n ],\n \"metric_bindings\": [\n {\n \"alias\": \"api_calls\",\n \"metric_id\": \"<string>\"\n }\n ]\n },\n \"fixed_pricing_model\": {\n \"price_per_unit\": \"500.00\",\n \"units\": 1\n },\n \"graduated_percentage_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"percentage\": \"2.5\"\n }\n ]\n },\n \"graduated_tiered_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ],\n \"units\": 10\n },\n \"maximum_spend\": {\n \"amount\": \"500.00\",\n \"period\": \"monthly\"\n },\n \"metric_ids\": [\n \"<string>\"\n ],\n \"minimum_spend\": {\n \"amount\": \"500.00\",\n \"period\": \"monthly\"\n },\n \"prepaid_fixed_tiered_pricing_model\": {\n \"overages_charge_interval\": \"monthly\",\n \"prepaid_units\": 50000,\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ]\n },\n \"prepaid_tiered_pricing_model\": {\n \"prepaid_units\": 50000,\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ]\n },\n \"recurring_instalment_interval_count\": 1,\n \"recurring_instalment_interval_unit\": \"month\",\n \"tiered_percentage_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"percentage\": \"2.5\"\n }\n ]\n },\n \"tiered_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ],\n \"units\": 10\n },\n \"trial_period_days\": 30,\n \"unit_pricing_model\": {\n \"price_per_unit\": \"0.05\"\n },\n \"volume_percentage_pricing_model\": {\n \"percentage\": \"2.0\",\n \"price_per_unit\": \"0.05\",\n \"fixed_fee\": \"5.00\"\n }\n },\n \"product_id\": \"prod_abc123\"\n }\n ],\n \"name\": \"Enterprise Add-ons\",\n \"price\": {\n \"billing_direction\": \"arrears\",\n \"fee_type\": \"fixed\",\n \"type\": \"fixed\",\n \"billing_frequency\": \"recurring\",\n \"billing_interval\": \"monthly\",\n \"billing_interval_count\": 3,\n \"billing_interval_unit\": \"month\",\n \"charge_on_contract_start\": false,\n \"discount\": {\n \"amount\": \"10\",\n \"duration_type\": \"fixed\",\n \"type\": \"percentage\",\n \"duration_unit\": \"months\",\n \"duration_value\": 6\n },\n \"display_order\": 1,\n \"expression_pricing_model\": {\n \"charges\": [\n {\n \"billing_direction\": \"arrears\",\n \"description\": \"API usage charge\",\n \"quantity_expression\": \"usage.api_calls\",\n \"unit_price_expression\": \"0.01\"\n }\n ],\n \"metric_bindings\": [\n {\n \"alias\": \"api_calls\",\n \"metric_id\": \"<string>\"\n }\n ]\n },\n \"fixed_pricing_model\": {\n \"price_per_unit\": \"500.00\",\n \"units\": 1\n },\n \"graduated_percentage_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"percentage\": \"2.5\"\n }\n ]\n },\n \"graduated_tiered_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ],\n \"units\": 10\n },\n \"maximum_spend\": {\n \"amount\": \"500.00\",\n \"period\": \"monthly\"\n },\n \"metric_ids\": [\n \"<string>\"\n ],\n \"minimum_spend\": {\n \"amount\": \"500.00\",\n \"period\": \"monthly\"\n },\n \"prepaid_fixed_tiered_pricing_model\": {\n \"overages_charge_interval\": \"monthly\",\n \"prepaid_units\": 50000,\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ]\n },\n \"prepaid_tiered_pricing_model\": {\n \"prepaid_units\": 50000,\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ]\n },\n \"recurring_instalment_interval_count\": 1,\n \"recurring_instalment_interval_unit\": \"month\",\n \"tiered_percentage_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"percentage\": \"2.5\"\n }\n ]\n },\n \"tiered_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ],\n \"units\": 10\n },\n \"trial_period_days\": 30,\n \"unit_pricing_model\": {\n \"price_per_unit\": \"0.05\"\n },\n \"volume_percentage_pricing_model\": {\n \"percentage\": \"2.0\",\n \"price_per_unit\": \"0.05\",\n \"fixed_fee\": \"5.00\"\n }\n },\n \"product_id\": \"prod_abc123\"\n }\n ],\n \"maximum_spend\": {\n \"amount\": \"500.00\",\n \"period\": \"monthly\"\n },\n \"minimum_spend\": {\n \"amount\": \"500.00\",\n \"period\": \"monthly\"\n },\n \"payment_terms\": \"net_30\",\n \"price_escalation\": {\n \"enabled\": true,\n \"interval_months\": 12,\n \"type\": \"percentage\",\n \"escalate_metered_unit_rates\": false,\n \"percentage\": \"5.00\"\n },\n \"renewal_duration\": 12,\n \"tags\": [\n \"tag_abc123\"\n ],\n \"trial_period_days\": 14\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.alguna.io/plans")
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 \"currency\": \"USD\",\n \"name\": \"Enterprise Plan\",\n \"additional_terms\": \"<string>\",\n \"auto_activate\": false,\n \"auto_renew\": true,\n \"contract_duration\": 12,\n \"contract_period_type\": \"fixed\",\n \"description\": \"Full-featured enterprise plan\",\n \"discount\": {\n \"amount\": \"10\",\n \"duration_type\": \"fixed\",\n \"type\": \"percentage\",\n \"duration_unit\": \"months\",\n \"duration_value\": 6\n },\n \"entitlements\": [\n {\n \"entitlement_key\": \"api_access\",\n \"mode\": \"static\",\n \"type\": \"boolean\",\n \"allocation\": {\n \"amount\": \"100000\",\n \"credit_type\": \"monetary\",\n \"rollover_enabled\": true,\n \"rollover_max_periods\": 3\n },\n \"timing\": {\n \"recurrence\": \"recurring\",\n \"interval\": \"monthly\"\n },\n \"value\": \"true\"\n }\n ],\n \"invoice_settings\": {\n \"auto_issue_invoices\": true,\n \"auto_pay_invoices\": false,\n \"invoice_footer_text\": \"Questions? support@example.com\",\n \"invoice_memo_template\": \"Thanks for your business\",\n \"send_activation_email\": true,\n \"send_invoices_to_customer\": true,\n \"send_receipts_to_customer\": true\n },\n \"items\": [\n {\n \"bundle_description\": \"Premium support and SSO\",\n \"bundle_id\": \"bun_abc123\",\n \"items\": [\n {\n \"price\": {\n \"billing_direction\": \"arrears\",\n \"fee_type\": \"fixed\",\n \"type\": \"fixed\",\n \"billing_frequency\": \"recurring\",\n \"billing_interval\": \"monthly\",\n \"billing_interval_count\": 3,\n \"billing_interval_unit\": \"month\",\n \"charge_on_contract_start\": false,\n \"discount\": {\n \"amount\": \"10\",\n \"duration_type\": \"fixed\",\n \"type\": \"percentage\",\n \"duration_unit\": \"months\",\n \"duration_value\": 6\n },\n \"display_order\": 1,\n \"expression_pricing_model\": {\n \"charges\": [\n {\n \"billing_direction\": \"arrears\",\n \"description\": \"API usage charge\",\n \"quantity_expression\": \"usage.api_calls\",\n \"unit_price_expression\": \"0.01\"\n }\n ],\n \"metric_bindings\": [\n {\n \"alias\": \"api_calls\",\n \"metric_id\": \"<string>\"\n }\n ]\n },\n \"fixed_pricing_model\": {\n \"price_per_unit\": \"500.00\",\n \"units\": 1\n },\n \"graduated_percentage_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"percentage\": \"2.5\"\n }\n ]\n },\n \"graduated_tiered_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ],\n \"units\": 10\n },\n \"maximum_spend\": {\n \"amount\": \"500.00\",\n \"period\": \"monthly\"\n },\n \"metric_ids\": [\n \"<string>\"\n ],\n \"minimum_spend\": {\n \"amount\": \"500.00\",\n \"period\": \"monthly\"\n },\n \"prepaid_fixed_tiered_pricing_model\": {\n \"overages_charge_interval\": \"monthly\",\n \"prepaid_units\": 50000,\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ]\n },\n \"prepaid_tiered_pricing_model\": {\n \"prepaid_units\": 50000,\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ]\n },\n \"recurring_instalment_interval_count\": 1,\n \"recurring_instalment_interval_unit\": \"month\",\n \"tiered_percentage_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"percentage\": \"2.5\"\n }\n ]\n },\n \"tiered_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ],\n \"units\": 10\n },\n \"trial_period_days\": 30,\n \"unit_pricing_model\": {\n \"price_per_unit\": \"0.05\"\n },\n \"volume_percentage_pricing_model\": {\n \"percentage\": \"2.0\",\n \"price_per_unit\": \"0.05\",\n \"fixed_fee\": \"5.00\"\n }\n },\n \"product_id\": \"prod_abc123\"\n }\n ],\n \"name\": \"Enterprise Add-ons\",\n \"price\": {\n \"billing_direction\": \"arrears\",\n \"fee_type\": \"fixed\",\n \"type\": \"fixed\",\n \"billing_frequency\": \"recurring\",\n \"billing_interval\": \"monthly\",\n \"billing_interval_count\": 3,\n \"billing_interval_unit\": \"month\",\n \"charge_on_contract_start\": false,\n \"discount\": {\n \"amount\": \"10\",\n \"duration_type\": \"fixed\",\n \"type\": \"percentage\",\n \"duration_unit\": \"months\",\n \"duration_value\": 6\n },\n \"display_order\": 1,\n \"expression_pricing_model\": {\n \"charges\": [\n {\n \"billing_direction\": \"arrears\",\n \"description\": \"API usage charge\",\n \"quantity_expression\": \"usage.api_calls\",\n \"unit_price_expression\": \"0.01\"\n }\n ],\n \"metric_bindings\": [\n {\n \"alias\": \"api_calls\",\n \"metric_id\": \"<string>\"\n }\n ]\n },\n \"fixed_pricing_model\": {\n \"price_per_unit\": \"500.00\",\n \"units\": 1\n },\n \"graduated_percentage_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"percentage\": \"2.5\"\n }\n ]\n },\n \"graduated_tiered_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ],\n \"units\": 10\n },\n \"maximum_spend\": {\n \"amount\": \"500.00\",\n \"period\": \"monthly\"\n },\n \"metric_ids\": [\n \"<string>\"\n ],\n \"minimum_spend\": {\n \"amount\": \"500.00\",\n \"period\": \"monthly\"\n },\n \"prepaid_fixed_tiered_pricing_model\": {\n \"overages_charge_interval\": \"monthly\",\n \"prepaid_units\": 50000,\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ]\n },\n \"prepaid_tiered_pricing_model\": {\n \"prepaid_units\": 50000,\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ]\n },\n \"recurring_instalment_interval_count\": 1,\n \"recurring_instalment_interval_unit\": \"month\",\n \"tiered_percentage_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"percentage\": \"2.5\"\n }\n ]\n },\n \"tiered_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ],\n \"units\": 10\n },\n \"trial_period_days\": 30,\n \"unit_pricing_model\": {\n \"price_per_unit\": \"0.05\"\n },\n \"volume_percentage_pricing_model\": {\n \"percentage\": \"2.0\",\n \"price_per_unit\": \"0.05\",\n \"fixed_fee\": \"5.00\"\n }\n },\n \"product_id\": \"prod_abc123\"\n }\n ],\n \"maximum_spend\": {\n \"amount\": \"500.00\",\n \"period\": \"monthly\"\n },\n \"minimum_spend\": {\n \"amount\": \"500.00\",\n \"period\": \"monthly\"\n },\n \"payment_terms\": \"net_30\",\n \"price_escalation\": {\n \"enabled\": true,\n \"interval_months\": 12,\n \"type\": \"percentage\",\n \"escalate_metered_unit_rates\": false,\n \"percentage\": \"5.00\"\n },\n \"renewal_duration\": 12,\n \"tags\": [\n \"tag_abc123\"\n ],\n \"trial_period_days\": 14\n}"
response = http.request(request)
puts response.read_body{
"created_at": "2026-04-01T10:00:00Z",
"currency": "USD",
"id": "pln_01H1VECT",
"name": "Enterprise Plan",
"updated_at": "2026-04-01T12:30:00Z",
"description": "Full-featured enterprise plan"
}{
"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
API key authentication. Pass your API key as a Bearer token.
Headers
Available options:
2026-04-01 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:
255Example:
"ik_a1b2c3d4e5f6"
Body
application/json
ISO 4217 currency code
Example:
"USD"
Plan name
Example:
"Enterprise Plan"
Markdown additional terms appended to the contract
Auto-activate subscriptions created from this plan
Example:
false
Whether the plan auto-renews
Example:
true
Contract duration in months
Example:
12
Contract period type
Available options:
fixed, monthly_rolling Example:
"fixed"
Plan description
Example:
"Full-featured enterprise plan"
Plan-level discount applied across the price set
Show child attributes
Show child attributes
Entitlement configs to provision with the plan
Show child attributes
Show child attributes
Invoice/email behavior overrides for the plan
Show child attributes
Show child attributes
Items that make up the plan's pricing template. Each item is either a standalone product (product_id + price) or a bundle (bundle_id + name + items).
Show child attributes
Show child attributes
Maximum spend per period
Show child attributes
Show child attributes
Minimum spend per period
Show child attributes
Show child attributes
Invoice payment terms
Example:
"net_30"
Price escalation config
Show child attributes
Show child attributes
Renewal duration in months
Example:
12
Renewal period type
Available options:
fixed, monthly_rolling Tag IDs to associate with the plan
Example:
["tag_abc123"]
Trial period in days
Example:
14
Response
Success
Timestamp when the plan was created
Example:
"2026-04-01T10:00:00Z"
The currency in which the plan is billed
Example:
"USD"
Unique identifier for the plan
Example:
"pln_01H1VECT"
The name of the plan
Example:
"Enterprise Plan"
Timestamp when the plan was last updated
Example:
"2026-04-01T12:30:00Z"
A brief description of the plan
Example:
"Full-featured enterprise plan"
⌘I
Create a plan
curl --request POST \
--url https://api.alguna.io/plans \
--header 'Alguna-Version: <alguna-version>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"currency": "USD",
"name": "Enterprise Plan",
"additional_terms": "<string>",
"auto_activate": false,
"auto_renew": true,
"contract_duration": 12,
"contract_period_type": "fixed",
"description": "Full-featured enterprise plan",
"discount": {
"amount": "10",
"duration_type": "fixed",
"type": "percentage",
"duration_unit": "months",
"duration_value": 6
},
"entitlements": [
{
"entitlement_key": "api_access",
"mode": "static",
"type": "boolean",
"allocation": {
"amount": "100000",
"credit_type": "monetary",
"rollover_enabled": true,
"rollover_max_periods": 3
},
"timing": {
"recurrence": "recurring",
"interval": "monthly"
},
"value": "true"
}
],
"invoice_settings": {
"auto_issue_invoices": true,
"auto_pay_invoices": false,
"invoice_footer_text": "Questions? support@example.com",
"invoice_memo_template": "Thanks for your business",
"send_activation_email": true,
"send_invoices_to_customer": true,
"send_receipts_to_customer": true
},
"items": [
{
"bundle_description": "Premium support and SSO",
"bundle_id": "bun_abc123",
"items": [
{
"price": {
"billing_direction": "arrears",
"fee_type": "fixed",
"type": "fixed",
"billing_frequency": "recurring",
"billing_interval": "monthly",
"billing_interval_count": 3,
"billing_interval_unit": "month",
"charge_on_contract_start": false,
"discount": {
"amount": "10",
"duration_type": "fixed",
"type": "percentage",
"duration_unit": "months",
"duration_value": 6
},
"display_order": 1,
"expression_pricing_model": {
"charges": [
{
"billing_direction": "arrears",
"description": "API usage charge",
"quantity_expression": "usage.api_calls",
"unit_price_expression": "0.01"
}
],
"metric_bindings": [
{
"alias": "api_calls",
"metric_id": "<string>"
}
]
},
"fixed_pricing_model": {
"price_per_unit": "500.00",
"units": 1
},
"graduated_percentage_pricing_model": {
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"percentage": "2.5"
}
]
},
"graduated_tiered_pricing_model": {
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"price_per_unit": "0.02"
}
],
"units": 10
},
"maximum_spend": {
"amount": "500.00",
"period": "monthly"
},
"metric_ids": [
"<string>"
],
"minimum_spend": {
"amount": "500.00",
"period": "monthly"
},
"prepaid_fixed_tiered_pricing_model": {
"overages_charge_interval": "monthly",
"prepaid_units": 50000,
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"price_per_unit": "0.02"
}
]
},
"prepaid_tiered_pricing_model": {
"prepaid_units": 50000,
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"price_per_unit": "0.02"
}
]
},
"recurring_instalment_interval_count": 1,
"recurring_instalment_interval_unit": "month",
"tiered_percentage_pricing_model": {
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"percentage": "2.5"
}
]
},
"tiered_pricing_model": {
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"price_per_unit": "0.02"
}
],
"units": 10
},
"trial_period_days": 30,
"unit_pricing_model": {
"price_per_unit": "0.05"
},
"volume_percentage_pricing_model": {
"percentage": "2.0",
"price_per_unit": "0.05",
"fixed_fee": "5.00"
}
},
"product_id": "prod_abc123"
}
],
"name": "Enterprise Add-ons",
"price": {
"billing_direction": "arrears",
"fee_type": "fixed",
"type": "fixed",
"billing_frequency": "recurring",
"billing_interval": "monthly",
"billing_interval_count": 3,
"billing_interval_unit": "month",
"charge_on_contract_start": false,
"discount": {
"amount": "10",
"duration_type": "fixed",
"type": "percentage",
"duration_unit": "months",
"duration_value": 6
},
"display_order": 1,
"expression_pricing_model": {
"charges": [
{
"billing_direction": "arrears",
"description": "API usage charge",
"quantity_expression": "usage.api_calls",
"unit_price_expression": "0.01"
}
],
"metric_bindings": [
{
"alias": "api_calls",
"metric_id": "<string>"
}
]
},
"fixed_pricing_model": {
"price_per_unit": "500.00",
"units": 1
},
"graduated_percentage_pricing_model": {
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"percentage": "2.5"
}
]
},
"graduated_tiered_pricing_model": {
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"price_per_unit": "0.02"
}
],
"units": 10
},
"maximum_spend": {
"amount": "500.00",
"period": "monthly"
},
"metric_ids": [
"<string>"
],
"minimum_spend": {
"amount": "500.00",
"period": "monthly"
},
"prepaid_fixed_tiered_pricing_model": {
"overages_charge_interval": "monthly",
"prepaid_units": 50000,
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"price_per_unit": "0.02"
}
]
},
"prepaid_tiered_pricing_model": {
"prepaid_units": 50000,
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"price_per_unit": "0.02"
}
]
},
"recurring_instalment_interval_count": 1,
"recurring_instalment_interval_unit": "month",
"tiered_percentage_pricing_model": {
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"percentage": "2.5"
}
]
},
"tiered_pricing_model": {
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"price_per_unit": "0.02"
}
],
"units": 10
},
"trial_period_days": 30,
"unit_pricing_model": {
"price_per_unit": "0.05"
},
"volume_percentage_pricing_model": {
"percentage": "2.0",
"price_per_unit": "0.05",
"fixed_fee": "5.00"
}
},
"product_id": "prod_abc123"
}
],
"maximum_spend": {
"amount": "500.00",
"period": "monthly"
},
"minimum_spend": {
"amount": "500.00",
"period": "monthly"
},
"payment_terms": "net_30",
"price_escalation": {
"enabled": true,
"interval_months": 12,
"type": "percentage",
"escalate_metered_unit_rates": false,
"percentage": "5.00"
},
"renewal_duration": 12,
"tags": [
"tag_abc123"
],
"trial_period_days": 14
}
'import requests
url = "https://api.alguna.io/plans"
payload = {
"currency": "USD",
"name": "Enterprise Plan",
"additional_terms": "<string>",
"auto_activate": False,
"auto_renew": True,
"contract_duration": 12,
"contract_period_type": "fixed",
"description": "Full-featured enterprise plan",
"discount": {
"amount": "10",
"duration_type": "fixed",
"type": "percentage",
"duration_unit": "months",
"duration_value": 6
},
"entitlements": [
{
"entitlement_key": "api_access",
"mode": "static",
"type": "boolean",
"allocation": {
"amount": "100000",
"credit_type": "monetary",
"rollover_enabled": True,
"rollover_max_periods": 3
},
"timing": {
"recurrence": "recurring",
"interval": "monthly"
},
"value": "true"
}
],
"invoice_settings": {
"auto_issue_invoices": True,
"auto_pay_invoices": False,
"invoice_footer_text": "Questions? support@example.com",
"invoice_memo_template": "Thanks for your business",
"send_activation_email": True,
"send_invoices_to_customer": True,
"send_receipts_to_customer": True
},
"items": [
{
"bundle_description": "Premium support and SSO",
"bundle_id": "bun_abc123",
"items": [
{
"price": {
"billing_direction": "arrears",
"fee_type": "fixed",
"type": "fixed",
"billing_frequency": "recurring",
"billing_interval": "monthly",
"billing_interval_count": 3,
"billing_interval_unit": "month",
"charge_on_contract_start": False,
"discount": {
"amount": "10",
"duration_type": "fixed",
"type": "percentage",
"duration_unit": "months",
"duration_value": 6
},
"display_order": 1,
"expression_pricing_model": {
"charges": [
{
"billing_direction": "arrears",
"description": "API usage charge",
"quantity_expression": "usage.api_calls",
"unit_price_expression": "0.01"
}
],
"metric_bindings": [
{
"alias": "api_calls",
"metric_id": "<string>"
}
]
},
"fixed_pricing_model": {
"price_per_unit": "500.00",
"units": 1
},
"graduated_percentage_pricing_model": { "tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"percentage": "2.5"
}
] },
"graduated_tiered_pricing_model": {
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"price_per_unit": "0.02"
}
],
"units": 10
},
"maximum_spend": {
"amount": "500.00",
"period": "monthly"
},
"metric_ids": ["<string>"],
"minimum_spend": {
"amount": "500.00",
"period": "monthly"
},
"prepaid_fixed_tiered_pricing_model": {
"overages_charge_interval": "monthly",
"prepaid_units": 50000,
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"price_per_unit": "0.02"
}
]
},
"prepaid_tiered_pricing_model": {
"prepaid_units": 50000,
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"price_per_unit": "0.02"
}
]
},
"recurring_instalment_interval_count": 1,
"recurring_instalment_interval_unit": "month",
"tiered_percentage_pricing_model": { "tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"percentage": "2.5"
}
] },
"tiered_pricing_model": {
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"price_per_unit": "0.02"
}
],
"units": 10
},
"trial_period_days": 30,
"unit_pricing_model": { "price_per_unit": "0.05" },
"volume_percentage_pricing_model": {
"percentage": "2.0",
"price_per_unit": "0.05",
"fixed_fee": "5.00"
}
},
"product_id": "prod_abc123"
}
],
"name": "Enterprise Add-ons",
"price": {
"billing_direction": "arrears",
"fee_type": "fixed",
"type": "fixed",
"billing_frequency": "recurring",
"billing_interval": "monthly",
"billing_interval_count": 3,
"billing_interval_unit": "month",
"charge_on_contract_start": False,
"discount": {
"amount": "10",
"duration_type": "fixed",
"type": "percentage",
"duration_unit": "months",
"duration_value": 6
},
"display_order": 1,
"expression_pricing_model": {
"charges": [
{
"billing_direction": "arrears",
"description": "API usage charge",
"quantity_expression": "usage.api_calls",
"unit_price_expression": "0.01"
}
],
"metric_bindings": [
{
"alias": "api_calls",
"metric_id": "<string>"
}
]
},
"fixed_pricing_model": {
"price_per_unit": "500.00",
"units": 1
},
"graduated_percentage_pricing_model": { "tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"percentage": "2.5"
}
] },
"graduated_tiered_pricing_model": {
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"price_per_unit": "0.02"
}
],
"units": 10
},
"maximum_spend": {
"amount": "500.00",
"period": "monthly"
},
"metric_ids": ["<string>"],
"minimum_spend": {
"amount": "500.00",
"period": "monthly"
},
"prepaid_fixed_tiered_pricing_model": {
"overages_charge_interval": "monthly",
"prepaid_units": 50000,
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"price_per_unit": "0.02"
}
]
},
"prepaid_tiered_pricing_model": {
"prepaid_units": 50000,
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"price_per_unit": "0.02"
}
]
},
"recurring_instalment_interval_count": 1,
"recurring_instalment_interval_unit": "month",
"tiered_percentage_pricing_model": { "tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"percentage": "2.5"
}
] },
"tiered_pricing_model": {
"tiers": [
{
"min_units": 0,
"fixed_fee": "10.00",
"max_units": 10000,
"price_per_unit": "0.02"
}
],
"units": 10
},
"trial_period_days": 30,
"unit_pricing_model": { "price_per_unit": "0.05" },
"volume_percentage_pricing_model": {
"percentage": "2.0",
"price_per_unit": "0.05",
"fixed_fee": "5.00"
}
},
"product_id": "prod_abc123"
}
],
"maximum_spend": {
"amount": "500.00",
"period": "monthly"
},
"minimum_spend": {
"amount": "500.00",
"period": "monthly"
},
"payment_terms": "net_30",
"price_escalation": {
"enabled": True,
"interval_months": 12,
"type": "percentage",
"escalate_metered_unit_rates": False,
"percentage": "5.00"
},
"renewal_duration": 12,
"tags": ["tag_abc123"],
"trial_period_days": 14
}
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({
currency: 'USD',
name: 'Enterprise Plan',
additional_terms: '<string>',
auto_activate: false,
auto_renew: true,
contract_duration: 12,
contract_period_type: 'fixed',
description: 'Full-featured enterprise plan',
discount: {
amount: '10',
duration_type: 'fixed',
type: 'percentage',
duration_unit: 'months',
duration_value: 6
},
entitlements: [
{
entitlement_key: 'api_access',
mode: 'static',
type: 'boolean',
allocation: {
amount: '100000',
credit_type: 'monetary',
rollover_enabled: true,
rollover_max_periods: 3
},
timing: {recurrence: 'recurring', interval: 'monthly'},
value: 'true'
}
],
invoice_settings: {
auto_issue_invoices: true,
auto_pay_invoices: false,
invoice_footer_text: 'Questions? support@example.com',
invoice_memo_template: 'Thanks for your business',
send_activation_email: true,
send_invoices_to_customer: true,
send_receipts_to_customer: true
},
items: [
{
bundle_description: 'Premium support and SSO',
bundle_id: 'bun_abc123',
items: [
{
price: {
billing_direction: 'arrears',
fee_type: 'fixed',
type: 'fixed',
billing_frequency: 'recurring',
billing_interval: 'monthly',
billing_interval_count: 3,
billing_interval_unit: 'month',
charge_on_contract_start: false,
discount: {
amount: '10',
duration_type: 'fixed',
type: 'percentage',
duration_unit: 'months',
duration_value: 6
},
display_order: 1,
expression_pricing_model: {
charges: [
{
billing_direction: 'arrears',
description: 'API usage charge',
quantity_expression: 'usage.api_calls',
unit_price_expression: '0.01'
}
],
metric_bindings: [{alias: 'api_calls', metric_id: '<string>'}]
},
fixed_pricing_model: {price_per_unit: '500.00', units: 1},
graduated_percentage_pricing_model: {
tiers: [{min_units: 0, fixed_fee: '10.00', max_units: 10000, percentage: '2.5'}]
},
graduated_tiered_pricing_model: {
tiers: [{min_units: 0, fixed_fee: '10.00', max_units: 10000, price_per_unit: '0.02'}],
units: 10
},
maximum_spend: {amount: '500.00', period: 'monthly'},
metric_ids: ['<string>'],
minimum_spend: {amount: '500.00', period: 'monthly'},
prepaid_fixed_tiered_pricing_model: {
overages_charge_interval: 'monthly',
prepaid_units: 50000,
tiers: [{min_units: 0, fixed_fee: '10.00', max_units: 10000, price_per_unit: '0.02'}]
},
prepaid_tiered_pricing_model: {
prepaid_units: 50000,
tiers: [{min_units: 0, fixed_fee: '10.00', max_units: 10000, price_per_unit: '0.02'}]
},
recurring_instalment_interval_count: 1,
recurring_instalment_interval_unit: 'month',
tiered_percentage_pricing_model: {
tiers: [{min_units: 0, fixed_fee: '10.00', max_units: 10000, percentage: '2.5'}]
},
tiered_pricing_model: {
tiers: [{min_units: 0, fixed_fee: '10.00', max_units: 10000, price_per_unit: '0.02'}],
units: 10
},
trial_period_days: 30,
unit_pricing_model: {price_per_unit: '0.05'},
volume_percentage_pricing_model: {percentage: '2.0', price_per_unit: '0.05', fixed_fee: '5.00'}
},
product_id: 'prod_abc123'
}
],
name: 'Enterprise Add-ons',
price: {
billing_direction: 'arrears',
fee_type: 'fixed',
type: 'fixed',
billing_frequency: 'recurring',
billing_interval: 'monthly',
billing_interval_count: 3,
billing_interval_unit: 'month',
charge_on_contract_start: false,
discount: {
amount: '10',
duration_type: 'fixed',
type: 'percentage',
duration_unit: 'months',
duration_value: 6
},
display_order: 1,
expression_pricing_model: {
charges: [
{
billing_direction: 'arrears',
description: 'API usage charge',
quantity_expression: 'usage.api_calls',
unit_price_expression: '0.01'
}
],
metric_bindings: [{alias: 'api_calls', metric_id: '<string>'}]
},
fixed_pricing_model: {price_per_unit: '500.00', units: 1},
graduated_percentage_pricing_model: {
tiers: [{min_units: 0, fixed_fee: '10.00', max_units: 10000, percentage: '2.5'}]
},
graduated_tiered_pricing_model: {
tiers: [{min_units: 0, fixed_fee: '10.00', max_units: 10000, price_per_unit: '0.02'}],
units: 10
},
maximum_spend: {amount: '500.00', period: 'monthly'},
metric_ids: ['<string>'],
minimum_spend: {amount: '500.00', period: 'monthly'},
prepaid_fixed_tiered_pricing_model: {
overages_charge_interval: 'monthly',
prepaid_units: 50000,
tiers: [{min_units: 0, fixed_fee: '10.00', max_units: 10000, price_per_unit: '0.02'}]
},
prepaid_tiered_pricing_model: {
prepaid_units: 50000,
tiers: [{min_units: 0, fixed_fee: '10.00', max_units: 10000, price_per_unit: '0.02'}]
},
recurring_instalment_interval_count: 1,
recurring_instalment_interval_unit: 'month',
tiered_percentage_pricing_model: {
tiers: [{min_units: 0, fixed_fee: '10.00', max_units: 10000, percentage: '2.5'}]
},
tiered_pricing_model: {
tiers: [{min_units: 0, fixed_fee: '10.00', max_units: 10000, price_per_unit: '0.02'}],
units: 10
},
trial_period_days: 30,
unit_pricing_model: {price_per_unit: '0.05'},
volume_percentage_pricing_model: {percentage: '2.0', price_per_unit: '0.05', fixed_fee: '5.00'}
},
product_id: 'prod_abc123'
}
],
maximum_spend: {amount: '500.00', period: 'monthly'},
minimum_spend: {amount: '500.00', period: 'monthly'},
payment_terms: 'net_30',
price_escalation: {
enabled: true,
interval_months: 12,
type: 'percentage',
escalate_metered_unit_rates: false,
percentage: '5.00'
},
renewal_duration: 12,
tags: ['tag_abc123'],
trial_period_days: 14
})
};
fetch('https://api.alguna.io/plans', 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/plans",
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([
'currency' => 'USD',
'name' => 'Enterprise Plan',
'additional_terms' => '<string>',
'auto_activate' => false,
'auto_renew' => true,
'contract_duration' => 12,
'contract_period_type' => 'fixed',
'description' => 'Full-featured enterprise plan',
'discount' => [
'amount' => '10',
'duration_type' => 'fixed',
'type' => 'percentage',
'duration_unit' => 'months',
'duration_value' => 6
],
'entitlements' => [
[
'entitlement_key' => 'api_access',
'mode' => 'static',
'type' => 'boolean',
'allocation' => [
'amount' => '100000',
'credit_type' => 'monetary',
'rollover_enabled' => true,
'rollover_max_periods' => 3
],
'timing' => [
'recurrence' => 'recurring',
'interval' => 'monthly'
],
'value' => 'true'
]
],
'invoice_settings' => [
'auto_issue_invoices' => true,
'auto_pay_invoices' => false,
'invoice_footer_text' => 'Questions? support@example.com',
'invoice_memo_template' => 'Thanks for your business',
'send_activation_email' => true,
'send_invoices_to_customer' => true,
'send_receipts_to_customer' => true
],
'items' => [
[
'bundle_description' => 'Premium support and SSO',
'bundle_id' => 'bun_abc123',
'items' => [
[
'price' => [
'billing_direction' => 'arrears',
'fee_type' => 'fixed',
'type' => 'fixed',
'billing_frequency' => 'recurring',
'billing_interval' => 'monthly',
'billing_interval_count' => 3,
'billing_interval_unit' => 'month',
'charge_on_contract_start' => false,
'discount' => [
'amount' => '10',
'duration_type' => 'fixed',
'type' => 'percentage',
'duration_unit' => 'months',
'duration_value' => 6
],
'display_order' => 1,
'expression_pricing_model' => [
'charges' => [
[
'billing_direction' => 'arrears',
'description' => 'API usage charge',
'quantity_expression' => 'usage.api_calls',
'unit_price_expression' => '0.01'
]
],
'metric_bindings' => [
[
'alias' => 'api_calls',
'metric_id' => '<string>'
]
]
],
'fixed_pricing_model' => [
'price_per_unit' => '500.00',
'units' => 1
],
'graduated_percentage_pricing_model' => [
'tiers' => [
[
'min_units' => 0,
'fixed_fee' => '10.00',
'max_units' => 10000,
'percentage' => '2.5'
]
]
],
'graduated_tiered_pricing_model' => [
'tiers' => [
[
'min_units' => 0,
'fixed_fee' => '10.00',
'max_units' => 10000,
'price_per_unit' => '0.02'
]
],
'units' => 10
],
'maximum_spend' => [
'amount' => '500.00',
'period' => 'monthly'
],
'metric_ids' => [
'<string>'
],
'minimum_spend' => [
'amount' => '500.00',
'period' => 'monthly'
],
'prepaid_fixed_tiered_pricing_model' => [
'overages_charge_interval' => 'monthly',
'prepaid_units' => 50000,
'tiers' => [
[
'min_units' => 0,
'fixed_fee' => '10.00',
'max_units' => 10000,
'price_per_unit' => '0.02'
]
]
],
'prepaid_tiered_pricing_model' => [
'prepaid_units' => 50000,
'tiers' => [
[
'min_units' => 0,
'fixed_fee' => '10.00',
'max_units' => 10000,
'price_per_unit' => '0.02'
]
]
],
'recurring_instalment_interval_count' => 1,
'recurring_instalment_interval_unit' => 'month',
'tiered_percentage_pricing_model' => [
'tiers' => [
[
'min_units' => 0,
'fixed_fee' => '10.00',
'max_units' => 10000,
'percentage' => '2.5'
]
]
],
'tiered_pricing_model' => [
'tiers' => [
[
'min_units' => 0,
'fixed_fee' => '10.00',
'max_units' => 10000,
'price_per_unit' => '0.02'
]
],
'units' => 10
],
'trial_period_days' => 30,
'unit_pricing_model' => [
'price_per_unit' => '0.05'
],
'volume_percentage_pricing_model' => [
'percentage' => '2.0',
'price_per_unit' => '0.05',
'fixed_fee' => '5.00'
]
],
'product_id' => 'prod_abc123'
]
],
'name' => 'Enterprise Add-ons',
'price' => [
'billing_direction' => 'arrears',
'fee_type' => 'fixed',
'type' => 'fixed',
'billing_frequency' => 'recurring',
'billing_interval' => 'monthly',
'billing_interval_count' => 3,
'billing_interval_unit' => 'month',
'charge_on_contract_start' => false,
'discount' => [
'amount' => '10',
'duration_type' => 'fixed',
'type' => 'percentage',
'duration_unit' => 'months',
'duration_value' => 6
],
'display_order' => 1,
'expression_pricing_model' => [
'charges' => [
[
'billing_direction' => 'arrears',
'description' => 'API usage charge',
'quantity_expression' => 'usage.api_calls',
'unit_price_expression' => '0.01'
]
],
'metric_bindings' => [
[
'alias' => 'api_calls',
'metric_id' => '<string>'
]
]
],
'fixed_pricing_model' => [
'price_per_unit' => '500.00',
'units' => 1
],
'graduated_percentage_pricing_model' => [
'tiers' => [
[
'min_units' => 0,
'fixed_fee' => '10.00',
'max_units' => 10000,
'percentage' => '2.5'
]
]
],
'graduated_tiered_pricing_model' => [
'tiers' => [
[
'min_units' => 0,
'fixed_fee' => '10.00',
'max_units' => 10000,
'price_per_unit' => '0.02'
]
],
'units' => 10
],
'maximum_spend' => [
'amount' => '500.00',
'period' => 'monthly'
],
'metric_ids' => [
'<string>'
],
'minimum_spend' => [
'amount' => '500.00',
'period' => 'monthly'
],
'prepaid_fixed_tiered_pricing_model' => [
'overages_charge_interval' => 'monthly',
'prepaid_units' => 50000,
'tiers' => [
[
'min_units' => 0,
'fixed_fee' => '10.00',
'max_units' => 10000,
'price_per_unit' => '0.02'
]
]
],
'prepaid_tiered_pricing_model' => [
'prepaid_units' => 50000,
'tiers' => [
[
'min_units' => 0,
'fixed_fee' => '10.00',
'max_units' => 10000,
'price_per_unit' => '0.02'
]
]
],
'recurring_instalment_interval_count' => 1,
'recurring_instalment_interval_unit' => 'month',
'tiered_percentage_pricing_model' => [
'tiers' => [
[
'min_units' => 0,
'fixed_fee' => '10.00',
'max_units' => 10000,
'percentage' => '2.5'
]
]
],
'tiered_pricing_model' => [
'tiers' => [
[
'min_units' => 0,
'fixed_fee' => '10.00',
'max_units' => 10000,
'price_per_unit' => '0.02'
]
],
'units' => 10
],
'trial_period_days' => 30,
'unit_pricing_model' => [
'price_per_unit' => '0.05'
],
'volume_percentage_pricing_model' => [
'percentage' => '2.0',
'price_per_unit' => '0.05',
'fixed_fee' => '5.00'
]
],
'product_id' => 'prod_abc123'
]
],
'maximum_spend' => [
'amount' => '500.00',
'period' => 'monthly'
],
'minimum_spend' => [
'amount' => '500.00',
'period' => 'monthly'
],
'payment_terms' => 'net_30',
'price_escalation' => [
'enabled' => true,
'interval_months' => 12,
'type' => 'percentage',
'escalate_metered_unit_rates' => false,
'percentage' => '5.00'
],
'renewal_duration' => 12,
'tags' => [
'tag_abc123'
],
'trial_period_days' => 14
]),
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/plans"
payload := strings.NewReader("{\n \"currency\": \"USD\",\n \"name\": \"Enterprise Plan\",\n \"additional_terms\": \"<string>\",\n \"auto_activate\": false,\n \"auto_renew\": true,\n \"contract_duration\": 12,\n \"contract_period_type\": \"fixed\",\n \"description\": \"Full-featured enterprise plan\",\n \"discount\": {\n \"amount\": \"10\",\n \"duration_type\": \"fixed\",\n \"type\": \"percentage\",\n \"duration_unit\": \"months\",\n \"duration_value\": 6\n },\n \"entitlements\": [\n {\n \"entitlement_key\": \"api_access\",\n \"mode\": \"static\",\n \"type\": \"boolean\",\n \"allocation\": {\n \"amount\": \"100000\",\n \"credit_type\": \"monetary\",\n \"rollover_enabled\": true,\n \"rollover_max_periods\": 3\n },\n \"timing\": {\n \"recurrence\": \"recurring\",\n \"interval\": \"monthly\"\n },\n \"value\": \"true\"\n }\n ],\n \"invoice_settings\": {\n \"auto_issue_invoices\": true,\n \"auto_pay_invoices\": false,\n \"invoice_footer_text\": \"Questions? support@example.com\",\n \"invoice_memo_template\": \"Thanks for your business\",\n \"send_activation_email\": true,\n \"send_invoices_to_customer\": true,\n \"send_receipts_to_customer\": true\n },\n \"items\": [\n {\n \"bundle_description\": \"Premium support and SSO\",\n \"bundle_id\": \"bun_abc123\",\n \"items\": [\n {\n \"price\": {\n \"billing_direction\": \"arrears\",\n \"fee_type\": \"fixed\",\n \"type\": \"fixed\",\n \"billing_frequency\": \"recurring\",\n \"billing_interval\": \"monthly\",\n \"billing_interval_count\": 3,\n \"billing_interval_unit\": \"month\",\n \"charge_on_contract_start\": false,\n \"discount\": {\n \"amount\": \"10\",\n \"duration_type\": \"fixed\",\n \"type\": \"percentage\",\n \"duration_unit\": \"months\",\n \"duration_value\": 6\n },\n \"display_order\": 1,\n \"expression_pricing_model\": {\n \"charges\": [\n {\n \"billing_direction\": \"arrears\",\n \"description\": \"API usage charge\",\n \"quantity_expression\": \"usage.api_calls\",\n \"unit_price_expression\": \"0.01\"\n }\n ],\n \"metric_bindings\": [\n {\n \"alias\": \"api_calls\",\n \"metric_id\": \"<string>\"\n }\n ]\n },\n \"fixed_pricing_model\": {\n \"price_per_unit\": \"500.00\",\n \"units\": 1\n },\n \"graduated_percentage_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"percentage\": \"2.5\"\n }\n ]\n },\n \"graduated_tiered_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ],\n \"units\": 10\n },\n \"maximum_spend\": {\n \"amount\": \"500.00\",\n \"period\": \"monthly\"\n },\n \"metric_ids\": [\n \"<string>\"\n ],\n \"minimum_spend\": {\n \"amount\": \"500.00\",\n \"period\": \"monthly\"\n },\n \"prepaid_fixed_tiered_pricing_model\": {\n \"overages_charge_interval\": \"monthly\",\n \"prepaid_units\": 50000,\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ]\n },\n \"prepaid_tiered_pricing_model\": {\n \"prepaid_units\": 50000,\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ]\n },\n \"recurring_instalment_interval_count\": 1,\n \"recurring_instalment_interval_unit\": \"month\",\n \"tiered_percentage_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"percentage\": \"2.5\"\n }\n ]\n },\n \"tiered_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ],\n \"units\": 10\n },\n \"trial_period_days\": 30,\n \"unit_pricing_model\": {\n \"price_per_unit\": \"0.05\"\n },\n \"volume_percentage_pricing_model\": {\n \"percentage\": \"2.0\",\n \"price_per_unit\": \"0.05\",\n \"fixed_fee\": \"5.00\"\n }\n },\n \"product_id\": \"prod_abc123\"\n }\n ],\n \"name\": \"Enterprise Add-ons\",\n \"price\": {\n \"billing_direction\": \"arrears\",\n \"fee_type\": \"fixed\",\n \"type\": \"fixed\",\n \"billing_frequency\": \"recurring\",\n \"billing_interval\": \"monthly\",\n \"billing_interval_count\": 3,\n \"billing_interval_unit\": \"month\",\n \"charge_on_contract_start\": false,\n \"discount\": {\n \"amount\": \"10\",\n \"duration_type\": \"fixed\",\n \"type\": \"percentage\",\n \"duration_unit\": \"months\",\n \"duration_value\": 6\n },\n \"display_order\": 1,\n \"expression_pricing_model\": {\n \"charges\": [\n {\n \"billing_direction\": \"arrears\",\n \"description\": \"API usage charge\",\n \"quantity_expression\": \"usage.api_calls\",\n \"unit_price_expression\": \"0.01\"\n }\n ],\n \"metric_bindings\": [\n {\n \"alias\": \"api_calls\",\n \"metric_id\": \"<string>\"\n }\n ]\n },\n \"fixed_pricing_model\": {\n \"price_per_unit\": \"500.00\",\n \"units\": 1\n },\n \"graduated_percentage_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"percentage\": \"2.5\"\n }\n ]\n },\n \"graduated_tiered_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ],\n \"units\": 10\n },\n \"maximum_spend\": {\n \"amount\": \"500.00\",\n \"period\": \"monthly\"\n },\n \"metric_ids\": [\n \"<string>\"\n ],\n \"minimum_spend\": {\n \"amount\": \"500.00\",\n \"period\": \"monthly\"\n },\n \"prepaid_fixed_tiered_pricing_model\": {\n \"overages_charge_interval\": \"monthly\",\n \"prepaid_units\": 50000,\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ]\n },\n \"prepaid_tiered_pricing_model\": {\n \"prepaid_units\": 50000,\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ]\n },\n \"recurring_instalment_interval_count\": 1,\n \"recurring_instalment_interval_unit\": \"month\",\n \"tiered_percentage_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"percentage\": \"2.5\"\n }\n ]\n },\n \"tiered_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ],\n \"units\": 10\n },\n \"trial_period_days\": 30,\n \"unit_pricing_model\": {\n \"price_per_unit\": \"0.05\"\n },\n \"volume_percentage_pricing_model\": {\n \"percentage\": \"2.0\",\n \"price_per_unit\": \"0.05\",\n \"fixed_fee\": \"5.00\"\n }\n },\n \"product_id\": \"prod_abc123\"\n }\n ],\n \"maximum_spend\": {\n \"amount\": \"500.00\",\n \"period\": \"monthly\"\n },\n \"minimum_spend\": {\n \"amount\": \"500.00\",\n \"period\": \"monthly\"\n },\n \"payment_terms\": \"net_30\",\n \"price_escalation\": {\n \"enabled\": true,\n \"interval_months\": 12,\n \"type\": \"percentage\",\n \"escalate_metered_unit_rates\": false,\n \"percentage\": \"5.00\"\n },\n \"renewal_duration\": 12,\n \"tags\": [\n \"tag_abc123\"\n ],\n \"trial_period_days\": 14\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/plans")
.header("Alguna-Version", "<alguna-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"currency\": \"USD\",\n \"name\": \"Enterprise Plan\",\n \"additional_terms\": \"<string>\",\n \"auto_activate\": false,\n \"auto_renew\": true,\n \"contract_duration\": 12,\n \"contract_period_type\": \"fixed\",\n \"description\": \"Full-featured enterprise plan\",\n \"discount\": {\n \"amount\": \"10\",\n \"duration_type\": \"fixed\",\n \"type\": \"percentage\",\n \"duration_unit\": \"months\",\n \"duration_value\": 6\n },\n \"entitlements\": [\n {\n \"entitlement_key\": \"api_access\",\n \"mode\": \"static\",\n \"type\": \"boolean\",\n \"allocation\": {\n \"amount\": \"100000\",\n \"credit_type\": \"monetary\",\n \"rollover_enabled\": true,\n \"rollover_max_periods\": 3\n },\n \"timing\": {\n \"recurrence\": \"recurring\",\n \"interval\": \"monthly\"\n },\n \"value\": \"true\"\n }\n ],\n \"invoice_settings\": {\n \"auto_issue_invoices\": true,\n \"auto_pay_invoices\": false,\n \"invoice_footer_text\": \"Questions? support@example.com\",\n \"invoice_memo_template\": \"Thanks for your business\",\n \"send_activation_email\": true,\n \"send_invoices_to_customer\": true,\n \"send_receipts_to_customer\": true\n },\n \"items\": [\n {\n \"bundle_description\": \"Premium support and SSO\",\n \"bundle_id\": \"bun_abc123\",\n \"items\": [\n {\n \"price\": {\n \"billing_direction\": \"arrears\",\n \"fee_type\": \"fixed\",\n \"type\": \"fixed\",\n \"billing_frequency\": \"recurring\",\n \"billing_interval\": \"monthly\",\n \"billing_interval_count\": 3,\n \"billing_interval_unit\": \"month\",\n \"charge_on_contract_start\": false,\n \"discount\": {\n \"amount\": \"10\",\n \"duration_type\": \"fixed\",\n \"type\": \"percentage\",\n \"duration_unit\": \"months\",\n \"duration_value\": 6\n },\n \"display_order\": 1,\n \"expression_pricing_model\": {\n \"charges\": [\n {\n \"billing_direction\": \"arrears\",\n \"description\": \"API usage charge\",\n \"quantity_expression\": \"usage.api_calls\",\n \"unit_price_expression\": \"0.01\"\n }\n ],\n \"metric_bindings\": [\n {\n \"alias\": \"api_calls\",\n \"metric_id\": \"<string>\"\n }\n ]\n },\n \"fixed_pricing_model\": {\n \"price_per_unit\": \"500.00\",\n \"units\": 1\n },\n \"graduated_percentage_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"percentage\": \"2.5\"\n }\n ]\n },\n \"graduated_tiered_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ],\n \"units\": 10\n },\n \"maximum_spend\": {\n \"amount\": \"500.00\",\n \"period\": \"monthly\"\n },\n \"metric_ids\": [\n \"<string>\"\n ],\n \"minimum_spend\": {\n \"amount\": \"500.00\",\n \"period\": \"monthly\"\n },\n \"prepaid_fixed_tiered_pricing_model\": {\n \"overages_charge_interval\": \"monthly\",\n \"prepaid_units\": 50000,\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ]\n },\n \"prepaid_tiered_pricing_model\": {\n \"prepaid_units\": 50000,\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ]\n },\n \"recurring_instalment_interval_count\": 1,\n \"recurring_instalment_interval_unit\": \"month\",\n \"tiered_percentage_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"percentage\": \"2.5\"\n }\n ]\n },\n \"tiered_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ],\n \"units\": 10\n },\n \"trial_period_days\": 30,\n \"unit_pricing_model\": {\n \"price_per_unit\": \"0.05\"\n },\n \"volume_percentage_pricing_model\": {\n \"percentage\": \"2.0\",\n \"price_per_unit\": \"0.05\",\n \"fixed_fee\": \"5.00\"\n }\n },\n \"product_id\": \"prod_abc123\"\n }\n ],\n \"name\": \"Enterprise Add-ons\",\n \"price\": {\n \"billing_direction\": \"arrears\",\n \"fee_type\": \"fixed\",\n \"type\": \"fixed\",\n \"billing_frequency\": \"recurring\",\n \"billing_interval\": \"monthly\",\n \"billing_interval_count\": 3,\n \"billing_interval_unit\": \"month\",\n \"charge_on_contract_start\": false,\n \"discount\": {\n \"amount\": \"10\",\n \"duration_type\": \"fixed\",\n \"type\": \"percentage\",\n \"duration_unit\": \"months\",\n \"duration_value\": 6\n },\n \"display_order\": 1,\n \"expression_pricing_model\": {\n \"charges\": [\n {\n \"billing_direction\": \"arrears\",\n \"description\": \"API usage charge\",\n \"quantity_expression\": \"usage.api_calls\",\n \"unit_price_expression\": \"0.01\"\n }\n ],\n \"metric_bindings\": [\n {\n \"alias\": \"api_calls\",\n \"metric_id\": \"<string>\"\n }\n ]\n },\n \"fixed_pricing_model\": {\n \"price_per_unit\": \"500.00\",\n \"units\": 1\n },\n \"graduated_percentage_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"percentage\": \"2.5\"\n }\n ]\n },\n \"graduated_tiered_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ],\n \"units\": 10\n },\n \"maximum_spend\": {\n \"amount\": \"500.00\",\n \"period\": \"monthly\"\n },\n \"metric_ids\": [\n \"<string>\"\n ],\n \"minimum_spend\": {\n \"amount\": \"500.00\",\n \"period\": \"monthly\"\n },\n \"prepaid_fixed_tiered_pricing_model\": {\n \"overages_charge_interval\": \"monthly\",\n \"prepaid_units\": 50000,\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ]\n },\n \"prepaid_tiered_pricing_model\": {\n \"prepaid_units\": 50000,\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ]\n },\n \"recurring_instalment_interval_count\": 1,\n \"recurring_instalment_interval_unit\": \"month\",\n \"tiered_percentage_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"percentage\": \"2.5\"\n }\n ]\n },\n \"tiered_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ],\n \"units\": 10\n },\n \"trial_period_days\": 30,\n \"unit_pricing_model\": {\n \"price_per_unit\": \"0.05\"\n },\n \"volume_percentage_pricing_model\": {\n \"percentage\": \"2.0\",\n \"price_per_unit\": \"0.05\",\n \"fixed_fee\": \"5.00\"\n }\n },\n \"product_id\": \"prod_abc123\"\n }\n ],\n \"maximum_spend\": {\n \"amount\": \"500.00\",\n \"period\": \"monthly\"\n },\n \"minimum_spend\": {\n \"amount\": \"500.00\",\n \"period\": \"monthly\"\n },\n \"payment_terms\": \"net_30\",\n \"price_escalation\": {\n \"enabled\": true,\n \"interval_months\": 12,\n \"type\": \"percentage\",\n \"escalate_metered_unit_rates\": false,\n \"percentage\": \"5.00\"\n },\n \"renewal_duration\": 12,\n \"tags\": [\n \"tag_abc123\"\n ],\n \"trial_period_days\": 14\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.alguna.io/plans")
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 \"currency\": \"USD\",\n \"name\": \"Enterprise Plan\",\n \"additional_terms\": \"<string>\",\n \"auto_activate\": false,\n \"auto_renew\": true,\n \"contract_duration\": 12,\n \"contract_period_type\": \"fixed\",\n \"description\": \"Full-featured enterprise plan\",\n \"discount\": {\n \"amount\": \"10\",\n \"duration_type\": \"fixed\",\n \"type\": \"percentage\",\n \"duration_unit\": \"months\",\n \"duration_value\": 6\n },\n \"entitlements\": [\n {\n \"entitlement_key\": \"api_access\",\n \"mode\": \"static\",\n \"type\": \"boolean\",\n \"allocation\": {\n \"amount\": \"100000\",\n \"credit_type\": \"monetary\",\n \"rollover_enabled\": true,\n \"rollover_max_periods\": 3\n },\n \"timing\": {\n \"recurrence\": \"recurring\",\n \"interval\": \"monthly\"\n },\n \"value\": \"true\"\n }\n ],\n \"invoice_settings\": {\n \"auto_issue_invoices\": true,\n \"auto_pay_invoices\": false,\n \"invoice_footer_text\": \"Questions? support@example.com\",\n \"invoice_memo_template\": \"Thanks for your business\",\n \"send_activation_email\": true,\n \"send_invoices_to_customer\": true,\n \"send_receipts_to_customer\": true\n },\n \"items\": [\n {\n \"bundle_description\": \"Premium support and SSO\",\n \"bundle_id\": \"bun_abc123\",\n \"items\": [\n {\n \"price\": {\n \"billing_direction\": \"arrears\",\n \"fee_type\": \"fixed\",\n \"type\": \"fixed\",\n \"billing_frequency\": \"recurring\",\n \"billing_interval\": \"monthly\",\n \"billing_interval_count\": 3,\n \"billing_interval_unit\": \"month\",\n \"charge_on_contract_start\": false,\n \"discount\": {\n \"amount\": \"10\",\n \"duration_type\": \"fixed\",\n \"type\": \"percentage\",\n \"duration_unit\": \"months\",\n \"duration_value\": 6\n },\n \"display_order\": 1,\n \"expression_pricing_model\": {\n \"charges\": [\n {\n \"billing_direction\": \"arrears\",\n \"description\": \"API usage charge\",\n \"quantity_expression\": \"usage.api_calls\",\n \"unit_price_expression\": \"0.01\"\n }\n ],\n \"metric_bindings\": [\n {\n \"alias\": \"api_calls\",\n \"metric_id\": \"<string>\"\n }\n ]\n },\n \"fixed_pricing_model\": {\n \"price_per_unit\": \"500.00\",\n \"units\": 1\n },\n \"graduated_percentage_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"percentage\": \"2.5\"\n }\n ]\n },\n \"graduated_tiered_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ],\n \"units\": 10\n },\n \"maximum_spend\": {\n \"amount\": \"500.00\",\n \"period\": \"monthly\"\n },\n \"metric_ids\": [\n \"<string>\"\n ],\n \"minimum_spend\": {\n \"amount\": \"500.00\",\n \"period\": \"monthly\"\n },\n \"prepaid_fixed_tiered_pricing_model\": {\n \"overages_charge_interval\": \"monthly\",\n \"prepaid_units\": 50000,\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ]\n },\n \"prepaid_tiered_pricing_model\": {\n \"prepaid_units\": 50000,\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ]\n },\n \"recurring_instalment_interval_count\": 1,\n \"recurring_instalment_interval_unit\": \"month\",\n \"tiered_percentage_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"percentage\": \"2.5\"\n }\n ]\n },\n \"tiered_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ],\n \"units\": 10\n },\n \"trial_period_days\": 30,\n \"unit_pricing_model\": {\n \"price_per_unit\": \"0.05\"\n },\n \"volume_percentage_pricing_model\": {\n \"percentage\": \"2.0\",\n \"price_per_unit\": \"0.05\",\n \"fixed_fee\": \"5.00\"\n }\n },\n \"product_id\": \"prod_abc123\"\n }\n ],\n \"name\": \"Enterprise Add-ons\",\n \"price\": {\n \"billing_direction\": \"arrears\",\n \"fee_type\": \"fixed\",\n \"type\": \"fixed\",\n \"billing_frequency\": \"recurring\",\n \"billing_interval\": \"monthly\",\n \"billing_interval_count\": 3,\n \"billing_interval_unit\": \"month\",\n \"charge_on_contract_start\": false,\n \"discount\": {\n \"amount\": \"10\",\n \"duration_type\": \"fixed\",\n \"type\": \"percentage\",\n \"duration_unit\": \"months\",\n \"duration_value\": 6\n },\n \"display_order\": 1,\n \"expression_pricing_model\": {\n \"charges\": [\n {\n \"billing_direction\": \"arrears\",\n \"description\": \"API usage charge\",\n \"quantity_expression\": \"usage.api_calls\",\n \"unit_price_expression\": \"0.01\"\n }\n ],\n \"metric_bindings\": [\n {\n \"alias\": \"api_calls\",\n \"metric_id\": \"<string>\"\n }\n ]\n },\n \"fixed_pricing_model\": {\n \"price_per_unit\": \"500.00\",\n \"units\": 1\n },\n \"graduated_percentage_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"percentage\": \"2.5\"\n }\n ]\n },\n \"graduated_tiered_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ],\n \"units\": 10\n },\n \"maximum_spend\": {\n \"amount\": \"500.00\",\n \"period\": \"monthly\"\n },\n \"metric_ids\": [\n \"<string>\"\n ],\n \"minimum_spend\": {\n \"amount\": \"500.00\",\n \"period\": \"monthly\"\n },\n \"prepaid_fixed_tiered_pricing_model\": {\n \"overages_charge_interval\": \"monthly\",\n \"prepaid_units\": 50000,\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ]\n },\n \"prepaid_tiered_pricing_model\": {\n \"prepaid_units\": 50000,\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ]\n },\n \"recurring_instalment_interval_count\": 1,\n \"recurring_instalment_interval_unit\": \"month\",\n \"tiered_percentage_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"percentage\": \"2.5\"\n }\n ]\n },\n \"tiered_pricing_model\": {\n \"tiers\": [\n {\n \"min_units\": 0,\n \"fixed_fee\": \"10.00\",\n \"max_units\": 10000,\n \"price_per_unit\": \"0.02\"\n }\n ],\n \"units\": 10\n },\n \"trial_period_days\": 30,\n \"unit_pricing_model\": {\n \"price_per_unit\": \"0.05\"\n },\n \"volume_percentage_pricing_model\": {\n \"percentage\": \"2.0\",\n \"price_per_unit\": \"0.05\",\n \"fixed_fee\": \"5.00\"\n }\n },\n \"product_id\": \"prod_abc123\"\n }\n ],\n \"maximum_spend\": {\n \"amount\": \"500.00\",\n \"period\": \"monthly\"\n },\n \"minimum_spend\": {\n \"amount\": \"500.00\",\n \"period\": \"monthly\"\n },\n \"payment_terms\": \"net_30\",\n \"price_escalation\": {\n \"enabled\": true,\n \"interval_months\": 12,\n \"type\": \"percentage\",\n \"escalate_metered_unit_rates\": false,\n \"percentage\": \"5.00\"\n },\n \"renewal_duration\": 12,\n \"tags\": [\n \"tag_abc123\"\n ],\n \"trial_period_days\": 14\n}"
response = http.request(request)
puts response.read_body{
"created_at": "2026-04-01T10:00:00Z",
"currency": "USD",
"id": "pln_01H1VECT",
"name": "Enterprise Plan",
"updated_at": "2026-04-01T12:30:00Z",
"description": "Full-featured enterprise plan"
}{
"detail": "<string>",
"status": 123
}{
"detail": "<string>",
"status": 123
}{
"detail": "<string>",
"status": 123
}{
"detail": "<string>",
"status": 123
}{
"detail": "<string>",
"status": 123
}{
"detail": "<string>",
"status": 123
}