Developer Docs

Developer Docs

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

›Miscellaneous

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

Rated items

Rated items can be used to transfer invoice items to billwerk that have been named and priced in other systems. The invoice items transferred in this way are taken into account in the next settlement and included in the invoice together with the items generated by billwerk. Use this method to bill products and services for which there is no standard pricing and which are not part of the product catalog in your billwerk account.

Rated items can be passed to billwerk explicitly via POST /Contracts/{contractId}/ratedItems. Alternatively a rated item can be billed via an order, by adding RatedItems to the cart of the Order. This will result in the rated item being billed immediately after the Order/{id}/commit.

Create rated item

Sample request

POST /Contracts/{contractId}/ratedItems

{
  "Description": "I'm a RatedItem",
  "Quantity": 1,
  "PricePerUnit": 300,
  "TaxPolicyId": "5b61ba5081b1f012b0f14d21",
  "PeriodStart": "2020-03-04T06:44:24.7711657Z",
  "PeriodEnd": "2020-04-04T06:44:24.7711657Z"
}

The PeriodStart and PeriodEnd mark the beginning and end of the service period posted on the invoice lineitem created based on this Rated Item.

Sample response

{
    "Id": "5e663e5d443e55256c60a435",
    "Description": "I'm a RatedItem",
    "Quantity": 1,
    "PricePerUnit": 300,
    "TaxPolicyId": "5b61ba5081b1f012b0f14d21",
    "PeriodStart": "2020-03-04T06:44:24.7710000Z",
    "PeriodEnd": "2020-04-04T06:44:24.7710000Z",
    "TransferredAt": "2020-03-09T13:02:21.0000000Z"
}
Last updated on 8/5/2020 by AxelDuenninger
← Adding discounts via couponEmail Notification Template →
  • Create rated item
    • Sample request
    • Sample response
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