FRfrisbii
subscription

POST /v1/subscription/{handle}/metered_billing_product

Add metered billing product to subscription

Request

  • Base URL
    https://customer-portal-api.frisbii.com
  • URL
    https://customer-portal-api.frisbii.com/v1/subscription/{handle}/metered_billing_product
  • Auth
    none declared

Path parameters

handlestring required

Subscription handle

Request body

metered_billing_product_handlestring required

Handle of the metered billing product to add

Response

Successful operation

handlestring

Per subscription unique handle for the attached metered billing product

namestring

Product name

descriptionstring

Product description

uuidstring

Product uuid

statusstring

Status of the attached product

pricing_strategystring

Pricing strategy

billing_periodstring

Billing period

billing_interval_lengthinteger

Billing interval length

current_period_startstring date-time

Current period start

next_period_startstring date-time

Next period start

Example response

{
  "pricing": {
    "vat": 0.25,
    "currency": "DKK",
    "unit_label": "GB",
    "unit_label_plural": "GBs",
    "unit_handle": "gb",
    "included_units": 10,
    "minimum_fee": "100",
    "amount_incl_vat": true,
    "tax_policy": "tp_handle",
    "pricing_model": "per_unit",
    "unit_ranges": [
      {
        "to": 100,
        "price_per_unit": "10.0"
      }
    ]
  },
  "metered_billing_product": {
    "handle": "storage",
    "pricing": {
      "vat": 0.25,
      "currency": "DKK",
      "unit_label": "GB",
      "unit_label_plural": "GBs",
      "unit_handle": "gb",
      "included_units": 10,
      "minimum_fee": "100",
      "amount_incl_vat": true,
      "tax_policy": "tp_handle",
      "pricing_model": "per_unit",
      "unit_ranges": [
        {
          "to": 100,
          "price_per_unit": "10.0"
        }
      ]
    },
    "name": "Storage",
    "description": "usage-based billing product for storage",
    "entitlements": [
      "['entitlement1', 'entitlement2']"
    ],
    "metadata": {
      "key": "value"
    },
    "state": "active",
    "usage_capture_method": "max",
    "auto_add_to_sub_on_usage": true,
    "invoice_period_source": "record_periods",
    "cost_object": "KT-4711"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.