- Start
- API-Referenz
- API-Dokumentation (XML/ JSON)
- Objekte
Objekt Subscription
Beschreibung
Das Objekt Subscription bildet ein Abonnement ab.
Aufbau
JSON Keyword | XML Keyword | Häufigkeit | Typ | Format | Beschreibung |
|---|---|---|---|---|---|
| created | created | 1 | string | date-time | Datum, an dem das Abonnement angelegt wurde. |
| updated | updated | 1 | string | date-time | Datum, an dem das Abonnement zuletzt aktualisiert wurde. |
| owner | owner | 1 | object | BasicUser | Besitzer des Objektes |
| updater | updater | 1 | object | BasicUser | Benutzer, der das Abonnement zuletzt aktualisiert hat. |
| billing | 1 | object | BasicUser | Benutzer, der die Rechnung erhält | |
| status | status | 1 | enum | BillingStatus | Abrechnungsstatus des Abonnements |
| object | object | 1 | string | Name des Abonnements oder auch die Vertragsnummer | |
| description | 1 | string | Name des Abonnements | ||
| articleTypeLabel | article_type_label | 1 | string | Artikeltyp für den das Abonnement besteht | |
| items | item | 0 - n | string | Die Posten des Abonnements | |
| expire | expire | 1 | string | date-time | Ablaufdatum des Abonnements |
| cancelation | cancelation | 1 | string | date-time | Kündigungsdatum |
| businessCase | identifier | 1 | string | Der Geschäftsfall des Abonnements, z. B. "create". | |
| renew_period | 1 | object | TimePeriod | Gibt an, um wie viele Jahre/Monate/Wochen/Tage verlängert wird | |
| cancelation_term_expire_only | 1 | boolean | Flag, ob nur zum Ablaufdatum des Abonnements gekündigt werden kann. Mögliche Werte:
Vorgabewert = true Für XML können auch 0 (false) und 1 (true) verwendet werden. | ||
| cancelation_term | 1 | object | TimePeriod | Kündigungszeitraum, bevor die nächste Zahlung fällig wird | |
| count | 1 | integer | int32 | Anzahl an Objekten, die das Abonnement umfasst | |
| payable | payable | 1 | string | date-time | Das nächste Zahlungsdatum |
| id | id | 1 | integer | int64 | Eindeutige Identifikationsnummer für dieses Abonnement |
| period | period | 1 | object | TimePeriod | Laufzeit des Abonnements |
| customer | 1 | object | BasicCustomer | Kunde des Abonnements | |
| extensions | ext | 0 - 1 | object | BillingEventExtensions | Zusätzliche Informationen, wie Rechte und Limits |