Zum Hauptinhalt springen
Verkauft wird eine Tarifstufe über einen Checkout-Link. Der Link erzeugt einen Warenkorb mit den Positionen der Tarifstufe und führt den Käufer durch den Checkout.
curl -X POST https://coreapi.io/api/plans/PLAN_ID/checkout-links \
  -H "Authorization: Bearer api_DEIN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "planTierId": "TIER_PRO_ID",
    "couponsAllowed": false,
    "isEnabled": true,
    "salesChannel": "default"
  }'
FeldPflichtBeschreibung
planTierIdjaDie Tarifstufe, die der Link verkauft. Muss zum Plan gehören.
slugneinEigener URL-Slug. Ohne Angabe wird automatisch einer erzeugt.
couponsAllowedneinOb Käufer im Checkout einen Gutschein eingeben dürfen. Standard false.
isEnabledneinOb der Link aktiv ist. Standard true.
salesChannelneinSales-Channel als UUID oder technischer Name (zum Beispiel default). Ohne Angabe greift der aktive Kanal der Anfrage, sonst der Standardkanal.
Die Antwort enthält eine url. Das ist der öffentliche Einstiegspunkt: Er erzeugt einen Warenkorb und leitet den Käufer zur Customerfront des Sales-Channels weiter. Alle Felder und Antworten: Checkout-Link erstellen und Checkout-Links listen. Jeder Checkout-Link gehört zu einem Sales-Channel. Der Kanal bestimmt Branding, die Customerfront-Domain und Standardeinstellungen des Checkouts. Vertriebskanäle sind ein plattformweiter Standard und gelten für V1 und V2 gleichermaßen, sie haben keine eigene V2-Variante.
Was ein Sales-Channel ist, wie du Domain, Branding und Standards einrichtest und wie die Customerfront-Domain aufgelöst wird, beschreibt die kanonische Anleitung Vertriebskanäle. Für Pläne genügt es zu wissen: gib bei Bedarf salesChannel an, sonst greift der Standardkanal.
1

Warenkorb

Der Aufruf der url erstellt einen Warenkorb. Die Positionen stammen aus der gewählten Tarifstufe.
2

Zahlung

Der Käufer schließt den Checkout in der Customerfront ab.
3

Abonnement mit Tarifstufe

Nach der Zahlung entsteht ein Abonnement, das fest an die gewählte Tarifstufe gebunden ist. Ab hier laufen weitere Wechsel über den Tarifwechsel im Kundenbereich, nicht über einen neuen Checkout.
Die Mengen einer Tarifstufe sind beim Plan-Checkout nicht editierbar. Es gelten die Standardmengen der Positionen. Mengenanpassungen sind erst beim Tarifwechsel im Kundenbereich möglich, sofern die Position das erlaubt.