Subscription Add-Ons

Endpointhttps://api.kontorion.eu/v1

Add-ons are additional products attached to an existing subscription outside of the base plan. Use add-ons for optional features, premium support tiers, or one-time charges that apply to a specific subscription.

Add-ons are billed alongside the subscription's regular charges and appear as separate line items on the invoice.

List add-ons for a subscription

GET

https://api.kontorion.eu/v1

/subscriptions/{id}/add-ons

Returns all active add-ons attached to a subscription.

List add-ons for a subscription › path Parameters

id

string · uuid · required

Subscription UUID

List add-ons for a subscription › Headers

X-Workspace-Id

string

Selects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.

Workspace UUID or slug.

List add-ons for a subscription › Responses

array | null · required

object · required

GET/subscriptions/{id}/add-ons

curl --request GET \
  --url https://api.kontorion.eu/v1/subscriptions/:id/add-ons

shell

Example Responses

{
  "data": [
    {
      "added_at": "2024-08-25T15:00:00Z",
      "created_at": "2024-08-25T15:00:00Z",
      "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "organization_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "product_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "quantity": 0,
      "removed_at": "2024-08-25T15:00:00Z",
      "subscription_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "updated_at": "2024-08-25T15:00:00Z"
    }
  ],
  "pagination": {
    "counts": {
      "key": {
        "key": 0
      }
    },
    "cursor": "cursor",
    "has_more": true,
    "total_count": 0
  }
}

json

application/json

Attach an add-on to a subscription

POST

https://api.kontorion.eu/v1

/subscriptions/{id}/add-ons

Attaches an add-on product (product_id plus optional quantity, default 1) to the subscription. The subscription must be ACTIVE and the product active; when the product declares required products, each must already be present in the plan snapshot or as an active add-on, otherwise 409.

Attach an add-on to a subscription › path Parameters

id

string · uuid · required

Subscription UUID

Attach an add-on to a subscription › Headers

Idempotency-Key

string · required

Unique key that makes this POST safe to retry: repeats with the same key replay the first response instead of re-executing. Replays are scoped to the retrying principal (same API key / user) and kept for 24 hours. Required on every POST.

Client-generated idempotency key (e.g. a UUID).

X-Workspace-Id

string

Workspace UUID or slug.

Attach an add-on to a subscription › Request Body

product_id

string · uuid

quantity

integer · int64

Attach an add-on to a subscription › Responses

Created

object · required

POST/subscriptions/{id}/add-ons

curl --request POST \
  --url https://api.kontorion.eu/v1/subscriptions/:id/add-ons \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <string>' \
  --data '
{
  "product_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
  "quantity": 0
}
'

shell

Example Request Body

{
  "product_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
  "quantity": 0
}

json

Example Responses

{
  "data": {
    "added_at": "2024-08-25T15:00:00Z",
    "created_at": "2024-08-25T15:00:00Z",
    "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "organization_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "product_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "quantity": 0,
    "removed_at": "2024-08-25T15:00:00Z",
    "subscription_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Remove an add-on from a subscription

DELETE

https://api.kontorion.eu/v1

/subscriptions/{id}/add-ons/{addonId}

Soft-removes the add-on (stamps removed_at): it stops counting as active but remains in history. Responds 404 when the add-on does not belong to the subscription in the URL.

Remove an add-on from a subscription › path Parameters

id

string · uuid · required

Subscription UUID

addonId

string · uuid · required

Add-on UUID

Remove an add-on from a subscription › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Remove an add-on from a subscription › Responses

No Content

No data returned

E-Invoicing Scheduled Changes

List add-ons for a subscription

GET

https://api.kontorion.eu/v1

/subscriptions/{id}/add-ons

Returns all active add-ons attached to a subscription.

List add-ons for a subscription › path Parameters

id

string · uuid · required

Subscription UUID

List add-ons for a subscription › Headers

X-Workspace-Id

string

Workspace UUID or slug.

List add-ons for a subscription › Responses

array | null · required

object · required

Attach an add-on to a subscription

POST

https://api.kontorion.eu/v1

/subscriptions/{id}/add-ons

Attach an add-on to a subscription › path Parameters

id

string · uuid · required

Subscription UUID

Attach an add-on to a subscription › Headers

Idempotency-Key

string · required

Client-generated idempotency key (e.g. a UUID).

X-Workspace-Id

string

Workspace UUID or slug.

Attach an add-on to a subscription › Request Body

product_id

string · uuid

quantity

integer · int64

Attach an add-on to a subscription › Responses

Created

object · required

Remove an add-on from a subscription

DELETE

https://api.kontorion.eu/v1

/subscriptions/{id}/add-ons/{addonId}

Soft-removes the add-on (stamps removed_at): it stops counting as active but remains in history. Responds 404 when the add-on does not belong to the subscription in the URL.

Remove an add-on from a subscription › path Parameters

id

string · uuid · required

Subscription UUID

addonId

string · uuid · required

Add-on UUID

Remove an add-on from a subscription › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Remove an add-on from a subscription › Responses

No Content

No data returned