Dokumentation

Blog

Authorization

Fynn Docs

Integrationen

API Referenz

Changelog

App Login

Termin buchen

Support

The url of the button "Zurück zum Anbieter". If none is provided, the button is hidden.

The confirmation message to display after checkout. If none is set, the default confirmation message will be used.

The url to redirect to after checkout. This is required for action "redirect".

This is required when the type is "plan".

This is required when the type is "product", "plan".

This is required when the type is "product".

The type of the checkout link item.

Possible values:
 * `product`: A product will be added to the cart, with the given quantity.
 * `plan`: A plan will be added to the cart, and can be configured by the customer.

Whether coupons can be applied to the checkout link or not.

Whether the quantity of the item can be edited or not.

The number of days as trial period. If a price has the flag "applyTrial" set to false, the price will be charged immediately.

The date and time when the resource was created.

The date and time when the resource was last updated.

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.

Define the behaviour when a plan change will be applied. If null the default behaviour will be used.

Define the allowed actions after subscription by customer, for upgrade / downgrade.

The code of the plan. This is used to identify the plan e.g. in the checkout url.

The description of the plan shown in the checkout. If a product is provided, this value is not required.

The name of the plan. If a product is provided, this value is not required.

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 checkout link IDs related to this price plan.

If this price plan is a custom price plan. A price plan is custom if it is defined specific for a plan addon, plan charge, customer or sales channel.

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 product set option related to this price plan.

This price is only available for a specific sales channel.
If this is set, the price is only available for the sales channel with the given ID.
All other price plans will be ignored.

The status of the price plan.

Possible values:
 * `active`: The price is active and can be used.
 * `archived`: The price is archived and cannot be used anymore. It will be not shown in any lists until explicitly requested.

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 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.

Update a checkout link by its ID

<sup>Required permissions: `checkout-link:write`</sup>

Update a checkout link

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

Customer

Billing

Dunning

Subscription

Offers

Catalogue

Checkout

Accounting

Taxes

Update a checkout link

Authorizations

Path Parameters

Body

Response