Developer Docs

Developer Docs

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

›Component subscriptions

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 components

Override for components is a feature that allows you to overwrite both the price and the description for the component used when you pass a component to billwerk. This gives you more flexibility in structuring your product catalog. For security reasons components can only be overridden via REST API. Overriding of components only works if the underlying component has a simple price model.

Sample request

POST /Contracts/{contractId}/componentSubscriptions

{
  "ComponentId": "5ca70a5b50abb74c34daf308",
  "Quantity": 1,
  "ProductOverride": {
      "PricePerUnit": 23,
      "Name": "Component_v2.0",
      "Description": "Hey, I'm an overridden component"
  }
}

Sample response

{
    "Id": "5ca70a7b50abb74c34daf315",
    "ContractId": "5ca4b06750abb730802f9e91",
    "CustomerId": "5ca4b06750abb730802f9e90",
    "ComponentId": "5ca70a5b50abb74c34daf308",
    "Quantity": 1,
    "StartDate": "2019-04-05T07:57:47.9008963Z",
    "ProductOverride": {
        "PricePerUnit": 23,
        "Name": "Component_v2.0",
        "Description": "Hey, I'm an overridden component"
    }
}
Last updated on 4/5/2021 by Andrei Asmykovich
← In-/decreasing quantityConcept →
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