Tags

Endpointhttps://api.kontorion.eu/v1

GET

https://api.kontorion.eu/v1

/credit-notes/{id}/tags

Returns the set of tags currently applied to the resource. Each entry is a Tag with id, name and color.

id

string · required

Resource ID

object[]

archived_at

string

color

string

created_at

string

deleted_at

string

description

string

entity_type

string · enum

Enum values:

CUSTOMER

SUBSCRIPTION

PRODUCT

PLAN

INVOICE

CREDIT_NOTE

id

string

name

string

organization_id

string

updated_at

string

usage_count

integer

Replace tags on an entity (full overwrite)

PUT

https://api.kontorion.eu/v1

/credit-notes/{id}/tags

Sets the tag IDs on the resource to exactly the supplied list. Existing tags not in the list are removed; missing ones are added.

Replace tags on an entity (full overwrite) › path Parameters

id

string · required

Resource ID

Replace tags on an entity (full overwrite) › Request Body

tag_ids

string[]

Replace tags on an entity (full overwrite) › Responses

Resulting set of tags

object[]

archived_at

string

color

string

created_at

string

deleted_at

string

description

string

entity_type

string · enum

Enum values:

CUSTOMER

SUBSCRIPTION

PRODUCT

PLAN

INVOICE

CREDIT_NOTE

id

string

name

string

organization_id

string

updated_at

string

usage_count

integer

Add tags to an entity (additive)

POST

https://api.kontorion.eu/v1

/credit-notes/{id}/tags

Applies the given tag IDs to the resource without removing existing tags. Returns the resulting set of tags.

Add tags to an entity (additive) › path Parameters

id

string · required

Resource ID

Add tags to an entity (additive) › Request Body

tag_ids

string[]

Add tags to an entity (additive) › Responses

Tags after the merge

object[]

archived_at

string

color

string

created_at

string

deleted_at

string

description

string

entity_type

string · enum

Enum values:

CUSTOMER

SUBSCRIPTION

PRODUCT

PLAN

INVOICE

CREDIT_NOTE

id

string

name

string

organization_id

string

updated_at

string

usage_count

integer

Remove a single tag from an entity

DELETE

https://api.kontorion.eu/v1

/credit-notes/{id}/tags/{tag_id}

Detaches the specified tag from the resource. Other tags on the entity are unaffected.

Remove a single tag from an entity › path Parameters

id

string · required

Resource ID

tag_id

string · required

Tag ID to remove

Remove a single tag from an entity › Responses

Tag detached

No data returned

GET

https://api.kontorion.eu/v1

/customers/{id}/tags

Returns the set of tags currently applied to the resource. Each entry is a Tag with id, name and color.

id

string · required

Resource ID

object[]

archived_at

string

color

string

created_at

string

deleted_at

string

description

string

entity_type

string · enum

Enum values:

CUSTOMER

SUBSCRIPTION

PRODUCT

PLAN

INVOICE

CREDIT_NOTE

id

string

name

string

organization_id

string

updated_at

string

usage_count

integer

Replace tags on an entity (full overwrite)

PUT

https://api.kontorion.eu/v1

/customers/{id}/tags

Sets the tag IDs on the resource to exactly the supplied list. Existing tags not in the list are removed; missing ones are added.

Replace tags on an entity (full overwrite) › path Parameters

id

string · required

Resource ID

Replace tags on an entity (full overwrite) › Request Body

tag_ids

string[]

Replace tags on an entity (full overwrite) › Responses

Resulting set of tags

object[]

archived_at

string

color

string

created_at

string

deleted_at

string

description

string

entity_type

string · enum

Enum values:

CUSTOMER

SUBSCRIPTION

PRODUCT

PLAN

INVOICE

CREDIT_NOTE

id

string

name

string

organization_id

string

updated_at

string

usage_count

integer

Add tags to an entity (additive)

POST

https://api.kontorion.eu/v1

/customers/{id}/tags

Applies the given tag IDs to the resource without removing existing tags. Returns the resulting set of tags.

Add tags to an entity (additive) › path Parameters

id

string · required

Resource ID

Add tags to an entity (additive) › Request Body

tag_ids

string[]

Add tags to an entity (additive) › Responses

Tags after the merge

object[]

archived_at

string

color

string

created_at

string

deleted_at

string

description

string

entity_type

string · enum

Enum values:

CUSTOMER

SUBSCRIPTION

PRODUCT

PLAN

INVOICE

CREDIT_NOTE

id

string

name

string

organization_id

string

updated_at

string

usage_count

integer

Remove a single tag from an entity

DELETE

https://api.kontorion.eu/v1

/customers/{id}/tags/{tag_id}

Detaches the specified tag from the resource. Other tags on the entity are unaffected.

Remove a single tag from an entity › path Parameters

id

string · required

Resource ID

tag_id

string · required

Tag ID to remove

Remove a single tag from an entity › Responses

Tag detached

No data returned

GET

https://api.kontorion.eu/v1

/invoices/{id}/tags

Returns the set of tags currently applied to the resource. Each entry is a Tag with id, name and color.

id

string · required

Resource ID

object[]

archived_at

string

color

string

created_at

string

deleted_at

string

description

string

entity_type

string · enum

Enum values:

CUSTOMER

SUBSCRIPTION

PRODUCT

PLAN

INVOICE

CREDIT_NOTE

id

string

name

string

organization_id

string

updated_at

string

usage_count

integer

Replace tags on an entity (full overwrite)

PUT

https://api.kontorion.eu/v1

/invoices/{id}/tags

Sets the tag IDs on the resource to exactly the supplied list. Existing tags not in the list are removed; missing ones are added.

Replace tags on an entity (full overwrite) › path Parameters

id

string · required

Resource ID

Replace tags on an entity (full overwrite) › Request Body

tag_ids

string[]

Replace tags on an entity (full overwrite) › Responses

Resulting set of tags

object[]

archived_at

string

color

string

created_at

string

deleted_at

string

description

string

entity_type

string · enum

Enum values:

CUSTOMER

SUBSCRIPTION

PRODUCT

PLAN

INVOICE

CREDIT_NOTE

id

string

name

string

organization_id

string

updated_at

string

usage_count

integer

Add tags to an entity (additive)

POST

https://api.kontorion.eu/v1

/invoices/{id}/tags

Applies the given tag IDs to the resource without removing existing tags. Returns the resulting set of tags.

Add tags to an entity (additive) › path Parameters

id

string · required

Resource ID

Add tags to an entity (additive) › Request Body

tag_ids

string[]

Add tags to an entity (additive) › Responses

Tags after the merge

object[]

archived_at

string

color

string

created_at

string

deleted_at

string

description

string

entity_type

string · enum

Enum values:

CUSTOMER

SUBSCRIPTION

PRODUCT

PLAN

INVOICE

CREDIT_NOTE

id

string

name

string

organization_id

string

updated_at

string

usage_count

integer

Remove a single tag from an entity

DELETE

https://api.kontorion.eu/v1

/invoices/{id}/tags/{tag_id}

Detaches the specified tag from the resource. Other tags on the entity are unaffected.

Remove a single tag from an entity › path Parameters

id

string · required

Resource ID

tag_id

string · required

Tag ID to remove

Remove a single tag from an entity › Responses

Tag detached

No data returned

GET

https://api.kontorion.eu/v1

/plans/{id}/tags

Returns the set of tags currently applied to the resource. Each entry is a Tag with id, name and color.

id

string · required

Resource ID

object[]

archived_at

string

color

string

created_at

string

deleted_at

string

description

string

entity_type

string · enum

Enum values:

CUSTOMER

SUBSCRIPTION

PRODUCT

PLAN

INVOICE

CREDIT_NOTE

id

string

name

string

organization_id

string

updated_at

string

usage_count

integer

Replace tags on an entity (full overwrite)

PUT

https://api.kontorion.eu/v1

/plans/{id}/tags

Sets the tag IDs on the resource to exactly the supplied list. Existing tags not in the list are removed; missing ones are added.

Replace tags on an entity (full overwrite) › path Parameters

id

string · required

Resource ID

Replace tags on an entity (full overwrite) › Request Body

tag_ids

string[]

Replace tags on an entity (full overwrite) › Responses

Resulting set of tags

object[]

archived_at

string

color

string

created_at

string

deleted_at

string

description

string

entity_type

string · enum

Enum values:

CUSTOMER

SUBSCRIPTION

PRODUCT

PLAN

INVOICE

CREDIT_NOTE

id

string

name

string

organization_id

string

updated_at

string

usage_count

integer

Add tags to an entity (additive)

POST

https://api.kontorion.eu/v1

/plans/{id}/tags

Applies the given tag IDs to the resource without removing existing tags. Returns the resulting set of tags.

Add tags to an entity (additive) › path Parameters

id

string · required

Resource ID

Add tags to an entity (additive) › Request Body

tag_ids

string[]

Add tags to an entity (additive) › Responses

Tags after the merge

object[]

archived_at

string

color

string

created_at

string

deleted_at

string

description

string

entity_type

string · enum

Enum values:

CUSTOMER

SUBSCRIPTION

PRODUCT

PLAN

INVOICE

CREDIT_NOTE

id

string

name

string

organization_id

string

updated_at

string

usage_count

integer

Remove a single tag from an entity

DELETE

https://api.kontorion.eu/v1

/plans/{id}/tags/{tag_id}

Detaches the specified tag from the resource. Other tags on the entity are unaffected.

Remove a single tag from an entity › path Parameters

id

string · required

Resource ID

tag_id

string · required

Tag ID to remove

Remove a single tag from an entity › Responses

Tag detached

No data returned

GET

https://api.kontorion.eu/v1

/products/{id}/tags

Returns the set of tags currently applied to the resource. Each entry is a Tag with id, name and color.

id

string · required

Resource ID

object[]

archived_at

string

color

string

created_at

string

deleted_at

string

description

string

entity_type

string · enum

Enum values:

CUSTOMER

SUBSCRIPTION

PRODUCT

PLAN

INVOICE

CREDIT_NOTE

id

string

name

string

organization_id

string

updated_at

string

usage_count

integer

Replace tags on an entity (full overwrite)

PUT

https://api.kontorion.eu/v1

/products/{id}/tags

Sets the tag IDs on the resource to exactly the supplied list. Existing tags not in the list are removed; missing ones are added.

Replace tags on an entity (full overwrite) › path Parameters

id

string · required

Resource ID

Replace tags on an entity (full overwrite) › Request Body

tag_ids

string[]

Replace tags on an entity (full overwrite) › Responses

Resulting set of tags

object[]

archived_at

string

color

string

created_at

string

deleted_at

string

description

string

entity_type

string · enum

Enum values:

CUSTOMER

SUBSCRIPTION

PRODUCT

PLAN

INVOICE

CREDIT_NOTE

id

string

name

string

organization_id

string

updated_at

string

usage_count

integer

Add tags to an entity (additive)

POST

https://api.kontorion.eu/v1

/products/{id}/tags

Applies the given tag IDs to the resource without removing existing tags. Returns the resulting set of tags.

Add tags to an entity (additive) › path Parameters

id

string · required

Resource ID

Add tags to an entity (additive) › Request Body

tag_ids

string[]

Add tags to an entity (additive) › Responses

Tags after the merge

object[]

archived_at

string

color

string

created_at

string

deleted_at

string

description

string

entity_type

string · enum

Enum values:

CUSTOMER

SUBSCRIPTION

PRODUCT

PLAN

INVOICE

CREDIT_NOTE

id

string

name

string

organization_id

string

updated_at

string

usage_count

integer

Remove a single tag from an entity

DELETE

https://api.kontorion.eu/v1

/products/{id}/tags/{tag_id}

Detaches the specified tag from the resource. Other tags on the entity are unaffected.

Remove a single tag from an entity › path Parameters

id

string · required

Resource ID

tag_id

string · required

Tag ID to remove

Remove a single tag from an entity › Responses

Tag detached

No data returned

GET

https://api.kontorion.eu/v1

/subscriptions/{id}/tags

Returns the set of tags currently applied to the resource. Each entry is a Tag with id, name and color.

id

string · required

Resource ID

object[]

archived_at

string

color

string

created_at

string

deleted_at

string

description

string

entity_type

string · enum

Enum values:

CUSTOMER

SUBSCRIPTION

PRODUCT

PLAN

INVOICE

CREDIT_NOTE

id

string

name

string

organization_id

string

updated_at

string

usage_count

integer

Replace tags on an entity (full overwrite)

PUT

https://api.kontorion.eu/v1

/subscriptions/{id}/tags

Sets the tag IDs on the resource to exactly the supplied list. Existing tags not in the list are removed; missing ones are added.

Replace tags on an entity (full overwrite) › path Parameters

id

string · required

Resource ID

Replace tags on an entity (full overwrite) › Request Body

tag_ids

string[]

Replace tags on an entity (full overwrite) › Responses

Resulting set of tags

object[]

archived_at

string

color

string

created_at

string

deleted_at

string

description

string

entity_type

string · enum

Enum values:

CUSTOMER

SUBSCRIPTION

PRODUCT

PLAN

INVOICE

CREDIT_NOTE

id

string

name

string

organization_id

string

updated_at

string

usage_count

integer

Add tags to an entity (additive)

POST

https://api.kontorion.eu/v1

/subscriptions/{id}/tags

Applies the given tag IDs to the resource without removing existing tags. Returns the resulting set of tags.

Add tags to an entity (additive) › path Parameters

id

string · required

Resource ID

Add tags to an entity (additive) › Request Body

tag_ids

string[]

Add tags to an entity (additive) › Responses

Tags after the merge

object[]

archived_at

string

color

string

created_at

string

deleted_at

string

description

string

entity_type

string · enum

Enum values:

CUSTOMER

SUBSCRIPTION

PRODUCT

PLAN

INVOICE

CREDIT_NOTE

id

string

name

string

organization_id

string

updated_at

string

usage_count

integer

Remove a single tag from an entity

DELETE

https://api.kontorion.eu/v1

/subscriptions/{id}/tags/{tag_id}

Detaches the specified tag from the resource. Other tags on the entity are unaffected.

Remove a single tag from an entity › path Parameters

id

string · required

Resource ID

tag_id

string · required

Tag ID to remove

Remove a single tag from an entity › Responses

Tag detached

No data returned

GET

https://api.kontorion.eu/v1

/tags

Returns a paginated list of tags. Filters use the unified field.op=value grammar; see /docs/pagination for the operator set. The archived state and usage-count toggle stay outside the grammar as control flags (see Param descriptions).

limit

integer

Page size (default 50, max 200)

cursor

string

Pagination cursor

name

string

Filter by name; supports .eq and .contains operators

color

string

Filter by color; supports .eq and .in operators

created_at

string

Filter by created_at; supports .eq, .gt, .gte, .lt, .lte operators

updated_at

string

Filter by updated_at; supports .eq, .gt, .gte, .lt, .lte operators

archived

string

Tri-mode archived flag: true (include archived), only (only archived). Default returns active rows only.

include

string

Comma-separated includes. Currently supports usage_count to add the count of taggings per tag via a LATERAL join.

Paginated list with data and pagination envelope

object[]

archived_at

string

color

string

created_at

string

deleted_at

string

description

string

entity_type

string · enum

Enum values:

CUSTOMER

SUBSCRIPTION

PRODUCT

PLAN

INVOICE

CREDIT_NOTE

id

string

name

string

organization_id

string

updated_at

string

usage_count

integer

Create a tag

POST

https://api.kontorion.eu/v1

/tags

Creates a new tag scoped to the calling organization.

Create a tag › Request Body

color

string

description

string

entity_type

string · enum

Enum values:

CUSTOMER

SUBSCRIPTION

PRODUCT

PLAN

INVOICE

CREDIT_NOTE

name

string

Create a tag › Responses

Wrapped in data envelope

archived_at

string

color

string

created_at

string

deleted_at

string

description

string

entity_type

string · enum

Enum values:

CUSTOMER

SUBSCRIPTION

PRODUCT

PLAN

INVOICE

CREDIT_NOTE

id

string

name

string

organization_id

string

updated_at

string

usage_count

integer

POST/tags

curl --request POST \
  --url https://api.kontorion.eu/v1/tags \
  --header 'Content-Type: application/json' \
  --data '
{
  "color": "color",
  "description": "description",
  "entity_type": "CUSTOMER",
  "name": "name"
}
'

shell

Example Request Body

{
  "color": "color",
  "description": "description",
  "entity_type": "CUSTOMER",
  "name": "name"
}

json

Example Responses

{
  "key": {
    "archived_at": "archived_at",
    "color": "color",
    "created_at": "created_at",
    "deleted_at": "deleted_at",
    "description": "description",
    "entity_type": "CUSTOMER",
    "id": "id",
    "name": "name",
    "organization_id": "organization_id",
    "updated_at": "updated_at",
    "usage_count": 0
  }
}

json

application/json

Get a tag

GET

https://api.kontorion.eu/v1

/tags/{id}

Returns a single tag by UUID.

Get a tag › path Parameters

id

string · required

Tag UUID

Get a tag › Responses

Wrapped in data envelope

archived_at

string

color

string

created_at

string

deleted_at

string

description

string

entity_type

string · enum

Enum values:

CUSTOMER

SUBSCRIPTION

PRODUCT

PLAN

INVOICE

CREDIT_NOTE

id

string

name

string

organization_id

string

updated_at

string

usage_count

integer

Soft-delete a tag

DELETE

https://api.kontorion.eu/v1

/tags/{id}

Marks the tag deleted and cascades to drop all taggings that referenced it. Fails with 409 when the tag is still referenced by segment rules or promotion conditions - remove those references first.

Soft-delete a tag › path Parameters

id

string · required

Tag UUID

Soft-delete a tag › Responses

No Content

No data returned

Update a tag

PATCH

https://api.kontorion.eu/v1

/tags/{id}

Applies partial updates to a tag. Setting archived: true archives the tag; passing archived: false un-archives. Setting description or color to an empty string clears the column.

Update a tag › path Parameters

id

string · required

Tag UUID

Update a tag › Request Body

archived

boolean

color

string

description

string

name

string

Update a tag › Responses

Wrapped in data envelope

archived_at

string

color

string

created_at

string

deleted_at

string

description

string

entity_type

string · enum

Enum values:

CUSTOMER

SUBSCRIPTION

PRODUCT

PLAN

INVOICE

CREDIT_NOTE

id

string

name

string

organization_id

string

updated_at

string

usage_count

integer

PATCH/tags/{id}

curl --request PATCH \
  --url https://api.kontorion.eu/v1/tags/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "archived": true,
  "color": "color",
  "description": "description",
  "name": "name"
}
'

shell

Example Request Body

{
  "archived": true,
  "color": "color",
  "description": "description",
  "name": "name"
}

json

Example Responses

{
  "key": {
    "archived_at": "archived_at",
    "color": "color",
    "created_at": "created_at",
    "deleted_at": "deleted_at",
    "description": "description",
    "entity_type": "CUSTOMER",
    "id": "id",
    "name": "name",
    "organization_id": "organization_id",
    "updated_at": "updated_at",
    "usage_count": 0
  }
}

json

application/json

CreditNotes Currencies

Tags

List tags applied to an entity

List tags applied to an entity › path Parameters

List tags applied to an entity › Responses

Replace tags on an entity (full overwrite)

Replace tags on an entity (full overwrite) › path Parameters

Replace tags on an entity (full overwrite) › Request Body

Replace tags on an entity (full overwrite) › Responses

Add tags to an entity (additive)

Add tags to an entity (additive) › path Parameters

Add tags to an entity (additive) › Request Body

Add tags to an entity (additive) › Responses

Remove a single tag from an entity

Remove a single tag from an entity › path Parameters

Remove a single tag from an entity › Responses

List tags applied to an entity

List tags applied to an entity › path Parameters

List tags applied to an entity › Responses

Replace tags on an entity (full overwrite)

Replace tags on an entity (full overwrite) › path Parameters

Replace tags on an entity (full overwrite) › Request Body

Replace tags on an entity (full overwrite) › Responses

Add tags to an entity (additive)

Add tags to an entity (additive) › path Parameters

Add tags to an entity (additive) › Request Body

Add tags to an entity (additive) › Responses

Remove a single tag from an entity

Remove a single tag from an entity › path Parameters

Remove a single tag from an entity › Responses

List tags applied to an entity

List tags applied to an entity › path Parameters

List tags applied to an entity › Responses

Replace tags on an entity (full overwrite)

Replace tags on an entity (full overwrite) › path Parameters

Replace tags on an entity (full overwrite) › Request Body

Replace tags on an entity (full overwrite) › Responses

Add tags to an entity (additive)

Add tags to an entity (additive) › path Parameters

Add tags to an entity (additive) › Request Body

Add tags to an entity (additive) › Responses

Remove a single tag from an entity

Remove a single tag from an entity › path Parameters

Remove a single tag from an entity › Responses

List tags applied to an entity

List tags applied to an entity › path Parameters

List tags applied to an entity › Responses

Replace tags on an entity (full overwrite)

Replace tags on an entity (full overwrite) › path Parameters

Replace tags on an entity (full overwrite) › Request Body

Replace tags on an entity (full overwrite) › Responses

Add tags to an entity (additive)

Add tags to an entity (additive) › path Parameters

Add tags to an entity (additive) › Request Body

Add tags to an entity (additive) › Responses

Remove a single tag from an entity

Remove a single tag from an entity › path Parameters

Remove a single tag from an entity › Responses

List tags applied to an entity

List tags applied to an entity › path Parameters

List tags applied to an entity › Responses

Replace tags on an entity (full overwrite)

Replace tags on an entity (full overwrite) › path Parameters

Replace tags on an entity (full overwrite) › Request Body

Replace tags on an entity (full overwrite) › Responses

Add tags to an entity (additive)

Add tags to an entity (additive) › path Parameters

Add tags to an entity (additive) › Request Body

Add tags to an entity (additive) › Responses

Remove a single tag from an entity

Remove a single tag from an entity › path Parameters

Remove a single tag from an entity › Responses

List tags applied to an entity

List tags applied to an entity › path Parameters

List tags applied to an entity › Responses

Replace tags on an entity (full overwrite)

Replace tags on an entity (full overwrite) › path Parameters

Replace tags on an entity (full overwrite) › Request Body

Replace tags on an entity (full overwrite) › Responses

Add tags to an entity (additive)

Add tags to an entity (additive) › path Parameters