Get a subscription version item

GET

subscriptions

{id}

versions

{vid}

items

{ref}

Get a subscription version item

curl --request GET \
  --url https://api.alguna.io/subscriptions/{id}/versions/{vid}/items/{ref} \
  --header 'Alguna-Version: <alguna-version>' \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.alguna.io/subscriptions/{id}/versions/{vid}/items/{ref}"

headers = {
    "Alguna-Version": "<alguna-version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Alguna-Version': '<alguna-version>', Authorization: 'Bearer <token>'}
};

fetch('https://api.alguna.io/subscriptions/{id}/versions/{vid}/items/{ref}', 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/subscriptions/{id}/versions/{vid}/items/{ref}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Alguna-Version: <alguna-version>",
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.alguna.io/subscriptions/{id}/versions/{vid}/items/{ref}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Alguna-Version", "<alguna-version>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.alguna.io/subscriptions/{id}/versions/{vid}/items/{ref}")
  .header("Alguna-Version", "<alguna-version>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.alguna.io/subscriptions/{id}/versions/{vid}/items/{ref}")

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

request = Net::HTTP::Get.new(url)
request["Alguna-Version"] = '<alguna-version>'
request["Authorization"] = 'Bearer <token>'

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

{
  "bundle_id": "bun_abc123",
  "items": [
    {
      "price": {
        "billing_direction": "arrears",
        "charge_on_contract_start": false,
        "currency": "USD",
        "fee_type": "fixed",
        "type": "fixed",
        "billing_frequency": "recurring",
        "billing_interval": "monthly",
        "billing_interval_count": 3,
        "billing_interval_unit": "month",
        "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",
          "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",
    "charge_on_contract_start": false,
    "currency": "USD",
    "fee_type": "fixed",
    "type": "fixed",
    "billing_frequency": "recurring",
    "billing_interval": "monthly",
    "billing_interval_count": 3,
    "billing_interval_unit": "month",
    "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",
      "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"
}

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

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

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

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

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

Authorizations

Authorization

string

header

required

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

Headers

Alguna-Version

enum<string>

required

Available options:

2026-04-01

Path Parameters

string

required

Unique identifier for the subscription

vid

string

required

Unique identifier for the version

ref

string

required

Unique identifier for the item

Response

Success

bundle_id

string | null

Bundle ID (for bundle items)

Example:

"bun_abc123"

items

object[]

Bundle child items

Show child attributes

price

object | null

Price details (for standalone items)

Show child attributes

product_id

string | null

Product ID (for standalone items)

Example:

"prod_abc123"

Publish a draft subscription versionPublishes a draft version. If `effective_at` is in the past or today the version becomes the current active version immediately. Otherwise it sits as a pending change on the parent subscription until the effective date. See the [Updating a Subscription](/docs/api-reference/v2/examples/updating-a-subscription) examples.

⌘I

Get a subscription version item

curl --request GET \
  --url https://api.alguna.io/subscriptions/{id}/versions/{vid}/items/{ref} \
  --header 'Alguna-Version: <alguna-version>' \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.alguna.io/subscriptions/{id}/versions/{vid}/items/{ref}"

headers = {
    "Alguna-Version": "<alguna-version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Alguna-Version': '<alguna-version>', Authorization: 'Bearer <token>'}
};

fetch('https://api.alguna.io/subscriptions/{id}/versions/{vid}/items/{ref}', 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/subscriptions/{id}/versions/{vid}/items/{ref}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Alguna-Version: <alguna-version>",
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.alguna.io/subscriptions/{id}/versions/{vid}/items/{ref}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Alguna-Version", "<alguna-version>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.alguna.io/subscriptions/{id}/versions/{vid}/items/{ref}")
  .header("Alguna-Version", "<alguna-version>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.alguna.io/subscriptions/{id}/versions/{vid}/items/{ref}")

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

request = Net::HTTP::Get.new(url)
request["Alguna-Version"] = '<alguna-version>'
request["Authorization"] = 'Bearer <token>'

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

{
  "bundle_id": "bun_abc123",
  "items": [
    {
      "price": {
        "billing_direction": "arrears",
        "charge_on_contract_start": false,
        "currency": "USD",
        "fee_type": "fixed",
        "type": "fixed",
        "billing_frequency": "recurring",
        "billing_interval": "monthly",
        "billing_interval_count": 3,
        "billing_interval_unit": "month",
        "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",
          "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",
    "charge_on_contract_start": false,
    "currency": "USD",
    "fee_type": "fixed",
    "type": "fixed",
    "billing_frequency": "recurring",
    "billing_interval": "monthly",
    "billing_interval_count": 3,
    "billing_interval_unit": "month",
    "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",
      "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"
}

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

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

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

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

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

API Reference

Examples

API Reference

Get a subscription version item

Authorizations

Headers

Path Parameters

Response