Developer Docs

Developer Docs

  • Getting Started
  • SubscriptionJS
  • REST API
  • Webhooks
  • Code Samples
  • UseCases
  • Request a Demo

›Metered usage components

Introduction

  • Introduction

Contracts

  • Adding contract for new customer
  • Adding contract for existing customer
  • Adding future contract without invoicing
  • Up/-downgrading to a plan variant
  • Terminate a contract with notice
  • Terminate a contract without notice

Components

    Component subscriptions

    • Concept
    • Adding/removing
    • In-/decreasing quantity
    • Override for components

    Metered usage components

    • Concept
    • Bill metered usage
    • Override for metered usage

Discounts

  • Adding discounts
  • Adding discounts via coupon

Miscellaneous

  • Rated items
  • Email Notification Template

Override for metered usage

Override for metered usage is a feature that allows you to overwrite both the price and the description for the metered usage used when you pass a metered usage to billwerk. This gives you more flexibility in structuring your product catalog. Due to security reasons this is REST-API exclusive.

Sample request

POST /Contracts/{contractId}/usage

{
  "ComponentId": "5ce53069443e551b9caccc64",
  "Quantity": 1,
  "DueDate": "2019-05-21T06:11:34.0000000Z",
  "ProductOverride": {
      "PricePerUnit": 100,
      "Name": "MeteredUsage2.0",
      "Description": "Hey, I'm an overridden metered usage"
  }
}

Sample response

{
    "Id": "5ce530b9443e5522685f2e93",
    "ContractId": "5cd186af443e551fe8e4f5dd",
    "TransferredAt": "2019-05-22T11:21:29.0000000Z",
    "ComponentId": "5ce53069443e551b9caccc64",
    "Quantity": 1,
    "Key": "",
    "DueDate": "2019-05-21T06:11:34.0000000Z",
    "ProductOverride": {
        "PricePerUnit": 100,
        "Name": "MeteredUsage2.0",
        "Description": "Hey, I'm an overridden metered usage"
    }
}
Last updated on 3/17/2020 by Stollemax
← Bill metered usageAdding discounts →
Docs
Getting StartedAPI Reference
Resource
Help CenterSupportBlogTutorials
Start with billwerk
Test for free
Request a Demo
Already started?
billwerk Sandboxbillwerk Production
billwerk GmbH
© Made with ❤ in Germany for Europe by billwerk GmbH | 2022
Imprint
|
Data Privacy Rules
|
Disclaimer