Dokumentation

Blog

Authorization

Fynn Docs

Integrationen

API Referenz

Changelog

App Login

Termin buchen

Support

The customer email which is used for the cart.

The invoice of the cart. If the cart total amount is zero, no invoice will be created.

The payment method which should be used for the cart.

The status of the cart.

Possible values:
 * `open`: The cart is open and can be edited.
 * `confirming`: The cart is confirming and cannot be edited.

The subscription of the cart. If the cart has no recurring items (has only one-time fees), no subscription will be created.

Can be empty. In this case the default currency of the tenant is used.

Can be empty if the customer is a company.

Additional address information, which will be shown on generated documents like invoices, reminders, etc.

Company name, which will be used to bill to.

Cost centre, which will be shown on generated documents like invoices, reminders, etc.

First name, which will be shown on generated documents like invoices, reminders, etc.

Last name, which will be shown on generated documents like invoices, reminders, etc.

VAT ID, which will be used to bill to. If not provided, we will use the customer vat id.

The date and time when the resource was created.

The date and time when the resource was last updated.

The currency code of the invoice. If multiple currency codes will be used in the positions, they will be converted to that base currency.

The amount as big integer, e.g. 1000 = 10.00 (precision = 2), 10000 = 10.000 (precision = 3)

Amount which can be used as input value, e.g. 10.00, 10.000.

The precision of the amount, which is the number of digits after the decimal separator, e.g. 2 = 10.00, 3 = 10.000

The document id of the invoice. This will be generated, when the invoice will be finalized.

The payment method which should be used to fullfill the payment of the invoice.

Customer address id, from which this invoice address was created.

VAT ID, which will be shown on generated documents like invoices, reminders, etc.

The card data of the payment method, if the type is "card"

The paypal data of the payment method, if the type is "paypal"

The billing agreement id of the paypal account

The sepa mandate data of the payment method, if the type is "sepa_debit"

The mandate reference of the sepa mandate

The fixed amount that is charged per unit, metered in the billing period. E.g. on pushing 1000 units, the fixed amount is charged 1000 times * percentage

The amount that is not subject to the charge rate.

The number of units that are not subject to the fixed fee.

The percentage of the total amount that is charged.

If this is set to true, the price plan can be applied on a trial. If the product is in trial, and this is false, the price will be charged on subscription start, otherwise after trial.

The billing interval of the price plan. If null, this is a one-time charge.
Billing intervals of null cannot be prorated.

The amount of free units. If null, no free units are available. Free units will be applied before passed to the price calculation and are available prorated.
If the customer does not uses the free units during a billing period, they are not carried over to the next billing period.
If the customer cancels the subscription before ending the billing period, the free units are only available prorated for the remaining billing period.


**Example**: You offer 2400 free units for 12 months and your price has a billing interval for 1 month. The customer cancels after 6 months. Only 1200 free units are available.

**A price plan for a recurring product cannot have free units. Use a metered product instead.**

**A price plan related to a product of type charge cannot have free units.**

If this is set to true, the price will be charged in advance. If this is false, the price will be charged at the end of the billing interval.

The price in the defined billing interval.

If this is set to true, the price will be charged prorated when a partial billing interval is billed. This applies to measurements of type "recurring" or non-one-time billing intervals. For other measurements this parameter will be ignored.

The type of the charge. This defines how the price is calculated.

Possible values:
 * `flat_fee`: A flat fee is charged, e.g. 10€ per month independent of the number of units.
 * `volume`: A volume based price is charged, e.g. 10€ for the first 10 units and 9€ for all units when the number of units is above 10. Useful for volume discounts.
 * `percentage`: A percentage of the total price is charged, e.g. 10% of the total price multiplied by the number of units. Useful for provisions.
 * `per_unit`: A price per unit is charged, e.g. 10€ per unit per billing interval. Useful for per seat based pricing.
 * `tiered`: A tiered price is charged. E.g. 10€ per unit for the first 10 units, 9€ per unit for the next 10 units and 8€ per unit for all units above 20.
 * `stair_step`: A stair step price is charged. E.g. 10€ per unit for the first 10 units, 9€ per unit for all units above 10.

The description of the product based on the current tenant language.

Defines when the product should be displayed in the invoice.
 - `always`: The product is always displayed in the invoice.
 - `only_if_charged`: The product is only displayed in the invoice if it is charged.


The name of the product based on the current tenant language. This will be displayed on customer communication.

The type of the product.
 - `product`: recurring billed product
 - `charge`: one-time billing
 - `plan`: plan specific product, which cannot be used as a normal product. Will be filtered out in any product lists.


The billing group defines the billing cycle of the subscription.

The contract details of the subscription.

The last billing date of the subscription.

The name of the subscription. Defaults to the name of the plan. This will be used in the invoice for the grouping headers.

The next billing date of the subscription.

The status of the subscription.

Possible values:
 * `draft`: The subscription is in draft mode and not active yet.
 * `active`: The subscription is active and will be billed.
 * `paused`: The subscription is paused and will not be billed.
 * `cancelled`: The subscription is cancelled and will not be billed anymore.
 * `terminated`: The subscription is terminated and will not be billed anymore.
 * `offer`: The subscription is an offer and waiting for acceptance.


The billing interval describes when the item is billed.
If the value is null, the item is billed only once (one-time).
If the value is not null, the item is billed periodically.
The value is a string in the following format: [number][unit]
The unit can be one of the following: H, D, W, M, Y


The flat amount of the tier, billed once in addition to the amount per unit in a billing period

The upper bound of the tier. If null, the tier is unbounded.

Retrieves completed the carts of the current tenant.

<sup>Required permissions: `cart:read`</sup>

Retrieves completed carts of the current tenant.

Willkommen bei Fynn! Hier findest du alles, was du brauchst, um loszulegen.

Willkommen 👋

Richte deine Organisation ein, um mit der Abonnementabrechnung zu beginnen.

Erste Einrichtung

Organisation einrichten

Benutzer verwalten

Nummernkreise

Passe das Aussehen an deine Unternehmensfarben und Design an.

Aussehen

Währungen verwalten und automatisch umrechnen

Währungen

Zahlungsmethoden

Konfiguriere Benachrichtigungen und E-Mails.

Benachrichtigungen

Passe die Web-Oberfläche an, um Arbeitsprozesse zu optimieren.

Web-Oberfläche

Web-Oberfläche anpassen

Erstelle benutzerdefinierte Attribute für verschiedene Objekte.

Benutzerdefinierte Attribute

Welcome to the API reference documentation for the Fynn API.

Getting started

All API endpoints are authenticated using Bearer tokens and picked up from the specification file.

Authentication

Learn how to manage payment methods on your own payment page.

Manage payment methods on your own payment page

Collect usage data

Learn how to enable manual invoice checks for all customers.

Enable manual invoice checks

Wir bieten dir eine Vielzahl von Integrationen zu 3rd-Party-Tools und -Services, um die Funktionalität der Fynn-Plattform zu erweitern.

API documentation

User

Tenant

User & permissions

Settings

Payment

Analytics

Customer

Billing

Dunning

Subscription

Offers

Catalogue

Checkout

Accounting

Taxes

Retrieves completed carts of the current tenant

Authorizations

Query Parameters

Response