Abonnement-Webhook

Payload-Struktur für Abonnement-Webhooks.

Inhalt

KeyTypeDescription
idintNumerische Kennung
uuidstring
  • Textuelle Kennung
  • 8–40 Zeichen lang
statusstringStatus des Abonnements
startstringStartdatum im Format 1970-01-01
endstring|nullEnddatum im Format 1970-01-01 oder null
valid_untilstring|nullNächstes Zahlungsdatum im Format 1970-01-01 oder null
paymentIntervalstringIntervallangabe wie der Parameter duration von DateInterval
invoiceInvoiceInvoice
contactContactContact

Statuswerte

StatusDescription
activeDas Abonnement ist aktiv. Weitere Belastungen folgen.
failedDie Abonnement-Erstellung ist fehlgeschlagen, oder eine Belastung ist fehlgeschlagen (Status war overdue) und der Wiederholungsversuch ebenfalls.
cancelledDas Abonnement wurde vom Händler gekündigt und ist sofort beendet. Es folgen keine weiteren Belastungen.
in_noticeDer Käufer hat vor dem Enddatum gekündigt. Die verbleibenden Belastungen werden noch ausgeführt.
overdueEine Belastung ist fehlgeschlagen. Das Abonnement wird erneut belastet. Nach einem zweiten Fehlschlag wechselt der Status zu failed.

Beispiel

{
  "id": 1234,
  "uuid": "aabb1122",
  "status": "active",
  "start": "2026-01-01",
  "end": null,
  "valid_until": "2026-12-31",
  "paymentInterval": "P1M",
  "invoice": {
    "number": "Test",
    "products": [
      {
        "name": "Test",
        "description": "",
        "price": 5000,
        "quantity": 1,
        "sku": null,
        "vatRate": "8.10"
      }
    ],
    "discount": {
      "code": null,
      "amount": 0,
      "percentage": null
    },
    "shippingAmount": null,
    "currency": "CHF",
    "test": 1,
    "referenceId": "",
    "purpose": "",
    "paymentRequestId": null,
    "paymentLink": null,
    "googleAnalyticProducts": [
      {
        "item_id": 1324,
        "item_name": "Test",
        "price": 50,
        "quantity": 1
      }
    ],
    "originalAmount": 5000,
    "refundedAmount": 0,
    "custom_fields": [
      {
        "type": "email",
        "name": "Email",
        "value": "subscription@test.com"
      }
    ]
  },
  "contact": {
    "id": 1234,
    "uuid": "aabb1122",
    "title": "female",
    "firstname": "zahls.ch",
    "lastname": "Test",
    "company": "Company Name",
    "street": "Burgstrasse 20",
    "zip": "3600",
    "place": "Thun",
    "country": "",
    "countryISO": "",
    "phone": "0335500010",
    "email": "subscription@test.com",
    "date_of_birth": "01.01.1970",
    "delivery_title": "",
    "delivery_firstname": "",
    "delivery_lastname": "",
    "delivery_company": "",
    "delivery_street": "",
    "delivery_zip": "",
    "delivery_place": "",
    "delivery_country": "",
    "delivery_countryISO": ""
  }
}