Zum Hauptinhalt springen
Dieser Schnellstart führt dich einmal durch den gesamten Ablauf: einen Plan anlegen, ihn aktivieren, einen Checkout-Link erstellen und im Kundenbereich einen Tarifwechsel ausführen. Alle Beispiele nutzen die Sandbox unter https://preview.coreapi.io. Die vollständigen Parameter und Antwortfelder findest du jeweils auf der verlinkten Referenzseite.
1

Plan anlegen

Lege einen Plan mit drei Stufen an. Die Stufe Starter ist die niedrigste, Business die höchste. Der Plan startet als draft.
curl -X POST https://preview.coreapi.io/api/plans \
  -H "Authorization: Bearer api_DEIN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "code": "pro-plan",
    "name": "Pro Plan",
    "tiers": [
      {
        "position": 0,
        "name": "Starter",
        "upgradeable": true,
        "downgradeable": false,
        "changeTiming": "immediately",
        "creditType": "pro_rata",
        "items": [
          { "productId": "PRODUCT_STARTER", "pricePlanId": "PRICEPLAN_STARTER", "defaultQuantity": 1 }
        ]
      },
      {
        "position": 1,
        "name": "Pro",
        "upgradeable": true,
        "downgradeable": true,
        "changeTiming": "immediately",
        "creditType": "pro_rata",
        "items": [
          { "productId": "PRODUCT_PRO", "pricePlanId": "PRICEPLAN_PRO", "defaultQuantity": 1 },
          { "productId": "PRODUCT_ADDON", "pricePlanId": "PRICEPLAN_ADDON", "defaultQuantity": 1, "minQuantity": 0, "maxQuantity": 50 }
        ]
      },
      {
        "position": 2,
        "name": "Business",
        "upgradeable": false,
        "downgradeable": true,
        "changeTiming": "end_of_period",
        "creditType": "none",
        "items": [
          { "productId": "PRODUCT_BUSINESS", "pricePlanId": "PRICEPLAN_BUSINESS", "defaultQuantity": 1 }
        ]
      }
    ]
  }'
Die Antwort enthält den Plan mit generierten IDs. Notiere dir die id des Plans und die id der Tarifstufe Pro, beides brauchst du gleich.Alle Felder und Antworten: Plan anlegen.
2

Plan aktivieren

Ein Plan muss aktiv sein, bevor du ihn verkaufen kannst.
curl -X POST https://preview.coreapi.io/api/plans/PLAN_ID/activate \
  -H "Authorization: Bearer api_DEIN_TOKEN"
Die Antwort zeigt den Plan mit "status": "active".Referenz: Plan aktivieren.
3

Checkout-Link erstellen

Erstelle einen Checkout-Link für die Tarifstufe, mit der neue Kunden starten sollen, hier die Stufe Pro.
curl -X POST https://preview.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"
  }'
In der Antwort steht eine url. Über diese URL schließt ein Kunde sein Abonnement ab. Nach der Zahlung entsteht ein Abonnement, das fest an die gewählte Tarifstufe gebunden ist.Alle Felder und Antworten: Checkout-Link erstellen.
4

Tarifoptionen im Kundenbereich abrufen

Ab jetzt arbeitest du im Kundenkontext mit einem Kunden-Token. Ein solches Token erzeugst du serverseitig über POST /customers/{id}/authenticate, siehe Authentifizierung. Frage damit die erreichbaren Stufen für das Abonnement des Kunden ab.
curl https://preview.coreapi.io/api/customer/subscriptions/SUBSCRIPTION_ID/plan-options \
  -H "Authorization: Bearer CUSTOMER_TOKEN"
Die Antwort enthält die aktuelle Stufe und alle erreichbaren Optionen, jeweils mit einer Kostenvorschau.Referenz: Tarifoptionen abrufen.
5

Wechsel vorab prüfen

Zeige dem Kunden, was ein Wechsel kostet, bevor er ihn bestätigt. Die Vorschau ändert nichts.
curl -X POST https://preview.coreapi.io/api/customer/subscriptions/SUBSCRIPTION_ID/plan-tier-preview \
  -H "Authorization: Bearer CUSTOMER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "planTierId": "TIER_BUSINESS_ID" }'
Referenz: Wechsel-Vorschau.
6

Wechsel ausführen

Bestätigt der Kunde, führst du den Wechsel aus.
curl -X POST https://preview.coreapi.io/api/customer/subscriptions/SUBSCRIPTION_ID/switch-plan-tier \
  -H "Authorization: Bearer CUSTOMER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "planTierId": "TIER_BUSINESS_ID" }'
Die Antwort bestätigt die neue Tarifstufe. Eine eventuelle Gutschrift oder Nachberechnung landet in der nächsten Rechnung, siehe Abrechnung.Referenz: Tarif wechseln.

​
Nächste Schritte

Up- und Downgrades

Erreichbarkeit, Vorschau und die anteilige Berechnung im Detail.

API-Referenz

Alle Felder und Antworten der einzelnen Endpunkte.