Tamio

Create an add-on

POST https://api.tamio.com/v2/subscriptions/addons/create/{uuid}

Attaches a new add-on to a subscription with flexible billing (one-time, limited payments, or recurring) and optional tax configuration.

Path Parameters

uuid string*

UUID of the subscription.

Body Parameters

description string*

Add-on name/description.

cost integer*

Price in smallest currency unit (must be greater than 0).

duration string*

once — one-time charge; limited — specific number of payments (requires number_of_payments); recurring — ongoing with the subscription.

oncelimitedrecurring
number_of_payments integer

Total payments for limited-duration add-ons (required when duration is limited, must be > 0).

vat_classification string

VAT classification for tax calculation.

digitalphysicalnotax
tax_calculation string

exclusive — tax added to price; inclusive — tax included in price.

exclusiveinclusive
tax_rate object

Custom tax rate (alternative to VAT classification).

JSON
{ "tax_rate": { "label": "VAT 21%", "rate": 21 } }
label string*

Tax rate display label.

rate number*

Tax percentage (must be > 0, max 100).

Responses

200 Add-on created

Add-on created

status integer
subscription Subscription
upcoming_invoice object

Updated upcoming invoice preview.

addon Addon
400 Validation or business-logic error.
401 Missing or invalid API key
/subscriptions/addons/create/{uuid}
1const response = await fetch("https://api.tamio.com/v2/subscriptions/addons/create/{uuid}", {
2 method: "POST",
3 headers: {
4 "Authorization": "Bearer YOUR_API_KEY",
5 "Content-Type": "application/json"
6 },
7 body: JSON.stringify({
8 "description": "Premium Support Package",
9 "cost": 1500,
10 "duration": "recurring",
11 "number_of_payments": null,
12 "vat_classification": "digital",
13 "tax_calculation": "exclusive",
14 "tax_rate": {
15 "label": "VAT 21%",
16 "rate": 21
17 }
18 })
19});
20const data = await response.json();
Responses
{
  "status": 200,
  "subscription": {
    "id": "999e4567-e89b-12d3-a456-426614174000",
    "object": "subscription",
    "next_billing_date": 1735689600,
    "cancellation_date": null,
    "completion_date": null,
    "resumes_at": null,
    "products": [
      {
        "id": "bbb24567-e89b-12d3-a456-426614174000",
        "name": "Pro Plan"
      }
    ],
    "payment_count": 12,
    "status": "active",
    "has_discount": false,
    "gateway_subscription_id": "sub_1PaBcDeFgHiJkLmN",
    "type": "subscription",
    "gateway": "stripe",
    "billing_cycle": "month",
    "interval": 1,
    "currency": "EUR",
    "invoice_id": "aaa14567-e89b-12d3-a456-426614174000",
    "price": 2990,
    "lifetime_revenue": 35880,
    "management_link": "https://billing.example.com",
    "instalments_count": 0,
    "customer": {
      "id": "ccc34567-e89b-12d3-a456-426614174000",
      "name": "John",
      "first_name": "John",
      "last_name": "Doe",
      "email": "[email protected]",
      "locale": "en",
      "client_id": null,
      "address_id": null
    },
    "imported": false,
    "has_notes": false
  },
  "upcoming_invoice": {},
  "addon": {
    "id": "fff64567-e89b-12d3-a456-426614174000",
    "object": "addon",
    "description": "Premium Support Package",
    "amount": 1500,
    "currency": "eur",
    "duration": "recurring",
    "type": "subscription_addon",
    "subscription_id": "999e4567-e89b-12d3-a456-426614174000",
    "payment_count": 3,
    "number_of_payments": null
  }
}