Terminology

To understand the integration, you need to know some terminology.

Debitor

A debitor is a person or company that has a subscription to a product.

Product

A product is a service that can be subscribed to. Products cannot have quantity, only components can have quantity.

Component

A component is a part of a product, can also be called "addon". Components can have quantity. For example, a product can have a component "users" with a quantity of 5. This means that the product has 5 users. Components can have variants.

Variant

A variant is a specific version of a component, for example, a variant of the component "users" can be "5 included users", or just "default" for 0,00€. Mostly the variant is used as a placeholder, because carts and subscriptions cannot be created without a variant.

Metered based type

Following calculation behavior is used for metered based type: The variant substract the included quantity from the total quantity of the component. For example, if the variant "5 included users" is selected, the total quantity of the component "users" is 10, the billed users are 5, priced by the price per unit in the component.

Quantity based type

Following calculation behavior is used for quantity based type: The variant included quantity will not be substracted from the total quantity of the component. For example, if the variant "5 included users" is selected, the total quantity of the component "users" is 10, the billed users are 10, priced by the price per unit in the component.

Subscription

A subscription is a subscription to one or multiple products. Each product in a subscription can have different billing, contract and cancellation periods.

So the subscription is some sort of a wrapper for products, could be called contract.

SubscriptionProduct

A subscription product is a subscription to a product. It has a billing, contract and cancellation period. The subscription product can be formerly seen as the real "subscription".