API Reference
API Reference
- GETList subscription versions
- POSTCreate a new subscription version
- GETGet the current active subscription version
- GETGet a subscription version
- PUTReplace a draft subscription version
- DELDelete a subscription version
- GETGet a subscription version item
- POSTPublish a draft subscription version
- GETGet subscription revenue metrics for a specific version
Subscription Versions
Get a subscription version
Fetches a single version by ID, including its priced items and entitlements.
GET
/
subscriptions
/
{id}
/
versions
/
{vid}
Get a subscription version
curl --request GET \
--url https://api.alguna.io/subscriptions/{id}/versions/{vid} \
--header 'Alguna-Version: <alguna-version>' \
--header 'Authorization: Bearer <token>'{
"created_at": "2025-12-15T10:30:00Z",
"entitlements": [
{
"id": "ent_abc123",
"mode": "static",
"subscription_id": "sub_abc123",
"type": "boolean",
"version_id": "subv_abc123",
"allocation": {
"amount": "100000",
"credit_type": "monetary",
"rollover_enabled": true,
"rollover_max_periods": 3
},
"key": "api_access",
"timing": {
"recurrence": "recurring",
"interval": "monthly"
},
"value": "true"
}
],
"id": "subv_abc123",
"items": [
{
"bundle_id": "bun_abc123",
"items": [
{
"price": {
"billing_direction": "arrears",
"billing_interval": "monthly",
"charge_on_contract_start": false,
"currency": "USD",
"fee_type": "fixed",
"type": "fixed",
"billing_frequency": "recurring",
"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"
}
]
},
"fixed_pricing_model": {
"price_per_unit": "500.00",
"total": "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"
}
]
},
"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"
}
],
"price": {
"billing_direction": "arrears",
"billing_interval": "monthly",
"charge_on_contract_start": false,
"currency": "USD",
"fee_type": "fixed",
"type": "fixed",
"billing_frequency": "recurring",
"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"
}
]
},
"fixed_pricing_model": {
"price_per_unit": "500.00",
"total": "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"
}
]
},
"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"
}
],
"status": "published",
"subscription_id": "sub_abc123",
"updated_at": "2026-01-01T00:00:00Z",
"description": "Q1 2027 enterprise configuration",
"end_date": "2027-01-01T00:00:00Z",
"plan_id": "pln_abc123",
"start_date": "2026-01-01T00:00:00Z"
}Documentation Index
Fetch the complete documentation index at: https://alguna.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
API key authentication. Pass your API key as a Bearer token.
Headers
Available options:
2026-04-01 Path Parameters
Unique identifier for the subscription
Unique identifier for the version
Response
Success
When the version was created
Example:
"2025-12-15T10:30:00Z"
Version entitlements
Show child attributes
Show child attributes
Version ID
Example:
"subv_abc123"
Version items
Show child attributes
Show child attributes
Version status
Example:
"published"
Subscription ID
Example:
"sub_abc123"
When the version was last updated
Example:
"2026-01-01T00:00:00Z"
Change description
Example:
"Q1 2027 enterprise configuration"
Version end date
Example:
"2027-01-01T00:00:00Z"
Plan ID
Example:
"pln_abc123"
Version start date
Example:
"2026-01-01T00:00:00Z"
Previous
Replace a draft subscription versionReplaces the contents of a draft version in place. Snapshot-based: send the full intended item set. Items you omit are removed. Only draft versions can be replaced, published versions are immutable. See the [Updating a Subscription](/docs/api-reference/v2/examples/updating-a-subscription) examples.
Next
⌘I
Get a subscription version
curl --request GET \
--url https://api.alguna.io/subscriptions/{id}/versions/{vid} \
--header 'Alguna-Version: <alguna-version>' \
--header 'Authorization: Bearer <token>'{
"created_at": "2025-12-15T10:30:00Z",
"entitlements": [
{
"id": "ent_abc123",
"mode": "static",
"subscription_id": "sub_abc123",
"type": "boolean",
"version_id": "subv_abc123",
"allocation": {
"amount": "100000",
"credit_type": "monetary",
"rollover_enabled": true,
"rollover_max_periods": 3
},
"key": "api_access",
"timing": {
"recurrence": "recurring",
"interval": "monthly"
},
"value": "true"
}
],
"id": "subv_abc123",
"items": [
{
"bundle_id": "bun_abc123",
"items": [
{
"price": {
"billing_direction": "arrears",
"billing_interval": "monthly",
"charge_on_contract_start": false,
"currency": "USD",
"fee_type": "fixed",
"type": "fixed",
"billing_frequency": "recurring",
"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"
}
]
},
"fixed_pricing_model": {
"price_per_unit": "500.00",
"total": "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"
}
]
},
"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"
}
],
"price": {
"billing_direction": "arrears",
"billing_interval": "monthly",
"charge_on_contract_start": false,
"currency": "USD",
"fee_type": "fixed",
"type": "fixed",
"billing_frequency": "recurring",
"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"
}
]
},
"fixed_pricing_model": {
"price_per_unit": "500.00",
"total": "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"
}
]
},
"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"
}
],
"status": "published",
"subscription_id": "sub_abc123",
"updated_at": "2026-01-01T00:00:00Z",
"description": "Q1 2027 enterprise configuration",
"end_date": "2027-01-01T00:00:00Z",
"plan_id": "pln_abc123",
"start_date": "2026-01-01T00:00:00Z"
}Assistant
Responses are generated using AI and may contain mistakes.