ProductMeterBindings

Endpointhttps://api.kontorion.eu/v1

List a product's bindings

GET

https://api.kontorion.eu/v1

/products/{productID}/meter-bindings

List a product's bindings › path Parameters

productID

string · required

Product UUID

List a product's bindings › Responses

200

Wrapped in data envelope

object[]

created_at

string

head_version_id

string

id

string

included_quantity_source

string · enum

Enum values:

PLAN_PIN

METER_WINDOW

NONE

object

meter_id

string

organization_id

string

overlay_dimensions_keyed

string[]

object

pricing_var_name

string

product_id

string

role

string · enum

Enum values:

BILLABLE_QUANTITY

PRICING_VAR

INFORMATIONAL

rollover_eligible

boolean

updated_at

string

workspace_id

string

GET/products/{productID}/meter-bindings

curl --request GET \
  --url https://api.kontorion.eu/v1/products/:productID/meter-bindings

shell

Example Responses

{
  "key": [
    {
      "created_at": "created_at",
      "head_version_id": "head_version_id",
      "id": "id",
      "included_quantity_source": "PLAN_PIN",
      "meter": {
        "function": "SUM",
        "id": "id",
        "key": "key",
        "name": "name",
        "unit_label": "unit_label"
      },
      "meter_id": "meter_id",
      "organization_id": "organization_id",
      "overlay_dimensions_keyed": [
        "string"
      ],
      "overlay_filters": {
        "root": {
          "children": [
            null
          ],
          "field": "field",
          "op": "AND",
          "value": {}
        }
      },
      "pricing_var_name": "pricing_var_name",
      "product_id": "product_id",
      "role": "BILLABLE_QUANTITY",
      "rollover_eligible": true,
      "updated_at": "updated_at",
      "workspace_id": "workspace_id"
    }
  ]
}

json

application/json

Create a product-meter binding

POST

https://api.kontorion.eu/v1

/products/{productID}/meter-bindings

Wires a meter to a product with a named pricing variable. At most one BILLABLE_QUANTITY binding per product.

Create a product-meter binding › path Parameters

productID

string · required

Product UUID

Create a product-meter binding › Request Body

included_quantity_source

string · enum

Enum values:

PLAN_PIN

METER_WINDOW

NONE

meter_id

string

overlay_dimensions_keyed

string[]

object

pricing_var_name

string

role

string · enum

Enum values:

BILLABLE_QUANTITY

PRICING_VAR

INFORMATIONAL

rollover_eligible

boolean

Create a product-meter binding › Responses

Wrapped in data envelope

created_at

string

head_version_id

string

id

string

included_quantity_source

string · enum

Enum values:

PLAN_PIN

METER_WINDOW

NONE

object

meter_id

string

organization_id

string

overlay_dimensions_keyed

string[]

object

pricing_var_name

string

product_id

string

role

string · enum

Enum values:

BILLABLE_QUANTITY

PRICING_VAR

INFORMATIONAL

rollover_eligible

boolean

updated_at

string

workspace_id

string

POST/products/{productID}/meter-bindings

curl --request POST \
  --url https://api.kontorion.eu/v1/products/:productID/meter-bindings \
  --header 'Content-Type: application/json' \
  --data '
{
  "included_quantity_source": "PLAN_PIN",
  "meter_id": "meter_id",
  "overlay_dimensions_keyed": [
    "string"
  ],
  "overlay_filters": {
    "root": {
      "children": [
        null
      ],
      "field": "field",
      "op": "AND",
      "value": {}
    }
  },
  "pricing_var_name": "pricing_var_name",
  "role": "BILLABLE_QUANTITY",
  "rollover_eligible": true
}
'

shell

Example Request Body

{
  "included_quantity_source": "PLAN_PIN",
  "meter_id": "meter_id",
  "overlay_dimensions_keyed": [
    "string"
  ],
  "overlay_filters": {
    "root": {
      "children": [
        null
      ],
      "field": "field",
      "op": "AND",
      "value": {}
    }
  },
  "pricing_var_name": "pricing_var_name",
  "role": "BILLABLE_QUANTITY",
  "rollover_eligible": true
}

json

Example Responses

{
  "key": {
    "created_at": "created_at",
    "head_version_id": "head_version_id",
    "id": "id",
    "included_quantity_source": "PLAN_PIN",
    "meter": {
      "function": "SUM",
      "id": "id",
      "key": "key",
      "name": "name",
      "unit_label": "unit_label"
    },
    "meter_id": "meter_id",
    "organization_id": "organization_id",
    "overlay_dimensions_keyed": [
      "string"
    ],
    "overlay_filters": {
      "root": {
        "children": [
          null
        ],
        "field": "field",
        "op": "AND",
        "value": {}
      }
    },
    "pricing_var_name": "pricing_var_name",
    "product_id": "product_id",
    "role": "BILLABLE_QUANTITY",
    "rollover_eligible": true,
    "updated_at": "updated_at",
    "workspace_id": "workspace_id"
  }
}

json

application/json

Get a binding

GET

https://api.kontorion.eu/v1

/products/{productID}/meter-bindings/{id}

Get a binding › path Parameters

productID

string · required

Product UUID

id

string · required

Binding UUID

Get a binding › Responses

Wrapped in data envelope

created_at

string

head_version_id

string

id

string

included_quantity_source

string · enum

Enum values:

PLAN_PIN

METER_WINDOW

NONE

object

meter_id

string

organization_id

string

overlay_dimensions_keyed

string[]

object

pricing_var_name

string

product_id

string

role

string · enum

Enum values:

BILLABLE_QUANTITY

PRICING_VAR

INFORMATIONAL

rollover_eligible

boolean

updated_at

string

workspace_id

string

GET/products/{productID}/meter-bindings/{id}

curl --request GET \
  --url https://api.kontorion.eu/v1/products/:productID/meter-bindings/:id

shell

Example Responses

{
  "key": {
    "created_at": "created_at",
    "head_version_id": "head_version_id",
    "id": "id",
    "included_quantity_source": "PLAN_PIN",
    "meter": {
      "function": "SUM",
      "id": "id",
      "key": "key",
      "name": "name",
      "unit_label": "unit_label"
    },
    "meter_id": "meter_id",
    "organization_id": "organization_id",
    "overlay_dimensions_keyed": [
      "string"
    ],
    "overlay_filters": {
      "root": {
        "children": [
          null
        ],
        "field": "field",
        "op": "AND",
        "value": {}
      }
    },
    "pricing_var_name": "pricing_var_name",
    "product_id": "product_id",
    "role": "BILLABLE_QUANTITY",
    "rollover_eligible": true,
    "updated_at": "updated_at",
    "workspace_id": "workspace_id"
  }
}

json

application/json

Update a binding

PUT

https://api.kontorion.eu/v1

/products/{productID}/meter-bindings/{id}

Update a binding › path Parameters

productID

string · required

Product UUID

id

string · required

Binding UUID

Update a binding › Request Body

effective_at

string

ADR-0006 edit-as-publish controls.

included_quantity_source

string · enum

Enum values:

PLAN_PIN

METER_WINDOW

NONE

overlay_dimensions_keyed

string[]

object

pricing_var_name

string

role

string · enum

Enum values:

BILLABLE_QUANTITY

PRICING_VAR

INFORMATIONAL

rollover_eligible

boolean

save_as_draft

boolean

Update a binding › Responses

Wrapped in data envelope

created_at

string

head_version_id

string

id

string

included_quantity_source

string · enum

Enum values:

PLAN_PIN

METER_WINDOW

NONE

object

meter_id

string

organization_id

string

overlay_dimensions_keyed

string[]

object

pricing_var_name

string

product_id

string

role

string · enum

Enum values:

BILLABLE_QUANTITY

PRICING_VAR

INFORMATIONAL

rollover_eligible

boolean

updated_at

string

workspace_id

string

PUT/products/{productID}/meter-bindings/{id}

curl --request PUT \
  --url https://api.kontorion.eu/v1/products/:productID/meter-bindings/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "effective_at": "effective_at",
  "included_quantity_source": "PLAN_PIN",
  "overlay_dimensions_keyed": [
    "string"
  ],
  "overlay_filters": {
    "root": {
      "children": [
        null
      ],
      "field": "field",
      "op": "AND",
      "value": {}
    }
  },
  "pricing_var_name": "pricing_var_name",
  "role": "BILLABLE_QUANTITY",
  "rollover_eligible": true,
  "save_as_draft": true
}
'

shell

Example Request Body

{
  "effective_at": "effective_at",
  "included_quantity_source": "PLAN_PIN",
  "overlay_dimensions_keyed": [
    "string"
  ],
  "overlay_filters": {
    "root": {
      "children": [
        null
      ],
      "field": "field",
      "op": "AND",
      "value": {}
    }
  },
  "pricing_var_name": "pricing_var_name",
  "role": "BILLABLE_QUANTITY",
  "rollover_eligible": true,
  "save_as_draft": true
}

json

Example Responses

{
  "key": {
    "created_at": "created_at",
    "head_version_id": "head_version_id",
    "id": "id",
    "included_quantity_source": "PLAN_PIN",
    "meter": {
      "function": "SUM",
      "id": "id",
      "key": "key",
      "name": "name",
      "unit_label": "unit_label"
    },
    "meter_id": "meter_id",
    "organization_id": "organization_id",
    "overlay_dimensions_keyed": [
      "string"
    ],
    "overlay_filters": {
      "root": {
        "children": [
          null
        ],
        "field": "field",
        "op": "AND",
        "value": {}
      }
    },
    "pricing_var_name": "pricing_var_name",
    "product_id": "product_id",
    "role": "BILLABLE_QUANTITY",
    "rollover_eligible": true,
    "updated_at": "updated_at",
    "workspace_id": "workspace_id"
  }
}

json

application/json

Delete a binding

DELETE

https://api.kontorion.eu/v1

/products/{productID}/meter-bindings/{id}

Delete a binding › path Parameters

productID

string · required

Product UUID

id

string · required

Binding UUID

Delete a binding › Responses

No content

No data returned

Scheduling/Products Scheduling/Promotions

List a product's bindings

GET

https://api.kontorion.eu/v1

/products/{productID}/meter-bindings

List a product's bindings › path Parameters

productID

string · required

Product UUID

List a product's bindings › Responses

200

Wrapped in data envelope

object[]

created_at

string

head_version_id

string

id

string

included_quantity_source

string · enum

Enum values:

PLAN_PIN

METER_WINDOW

NONE

object

meter_id

string

organization_id

string

overlay_dimensions_keyed

string[]

object

pricing_var_name

string

product_id

string

role

string · enum

Enum values:

BILLABLE_QUANTITY

PRICING_VAR

INFORMATIONAL

rollover_eligible

boolean

updated_at

string

workspace_id

string

Create a product-meter binding

POST

https://api.kontorion.eu/v1

/products/{productID}/meter-bindings

Wires a meter to a product with a named pricing variable. At most one BILLABLE_QUANTITY binding per product.

Create a product-meter binding › path Parameters

productID

string · required

Product UUID

Create a product-meter binding › Request Body

included_quantity_source

string · enum

Enum values:

PLAN_PIN

METER_WINDOW

NONE

meter_id

string

overlay_dimensions_keyed

string[]

object

pricing_var_name

string

role

string · enum

Enum values:

BILLABLE_QUANTITY

PRICING_VAR

INFORMATIONAL

rollover_eligible

boolean

Create a product-meter binding › Responses

Wrapped in data envelope

created_at

string

head_version_id

string

id

string

included_quantity_source

string · enum

Enum values:

PLAN_PIN

METER_WINDOW

NONE

object

meter_id

string

organization_id

string

overlay_dimensions_keyed

string[]

object

pricing_var_name

string

product_id

string

role

string · enum

Enum values:

BILLABLE_QUANTITY

PRICING_VAR

INFORMATIONAL

rollover_eligible

boolean

updated_at

string

workspace_id

string

Get a binding

GET

https://api.kontorion.eu/v1

/products/{productID}/meter-bindings/{id}

Get a binding › path Parameters

productID

string · required

Product UUID

id

string · required

Binding UUID

Get a binding › Responses

Wrapped in data envelope

created_at

string

head_version_id

string

id

string

included_quantity_source

string · enum

Enum values:

PLAN_PIN

METER_WINDOW

NONE

object

meter_id

string

organization_id

string

overlay_dimensions_keyed

string[]

object

pricing_var_name

string

product_id

string

role

string · enum

Enum values:

BILLABLE_QUANTITY

PRICING_VAR

INFORMATIONAL

rollover_eligible

boolean

updated_at

string

workspace_id

string

Update a binding

PUT

https://api.kontorion.eu/v1

/products/{productID}/meter-bindings/{id}

Update a binding › path Parameters

productID

string · required

Product UUID

id

string · required

Binding UUID

Update a binding › Request Body

effective_at

string

ADR-0006 edit-as-publish controls.

included_quantity_source

string · enum

Enum values:

PLAN_PIN

METER_WINDOW

NONE

overlay_dimensions_keyed

string[]

object

pricing_var_name

string

role

string · enum

Enum values:

BILLABLE_QUANTITY

PRICING_VAR

INFORMATIONAL

rollover_eligible

boolean

save_as_draft

boolean

Update a binding › Responses

Wrapped in data envelope

created_at

string

head_version_id

string

id

string

included_quantity_source

string · enum

Enum values:

PLAN_PIN

METER_WINDOW

NONE

object

meter_id

string

organization_id

string

overlay_dimensions_keyed

string[]

object

pricing_var_name

string

product_id

string

role

string · enum

Enum values:

BILLABLE_QUANTITY

PRICING_VAR

INFORMATIONAL

rollover_eligible

boolean

updated_at

string

workspace_id

string