subscription.get
Abfragen der Details eines oder mehrerer Abonnements. Wenn kein Filter gesetzt wird, werden 10 Abonnements zurückgeliefert. (ID-Array möglich)
FILTER
| Tags | Beschreibung |
| SUBSCRIPTION_ID |
Eine von Monsum vergebene bestimmte Abonnementnummer |
| CUSTOMER_ID |
Eine von Monsum vergebene bestimmte Kundennummer |
| CUSTOMER_EXT_UID |
Kunde nach der externen ID |
RESPONSE
| Tags | Beschreibung |
| SUBSCRIPTION_ID |
Eine von Monsum vergebene bestimmte Abonnementnummer |
| SUBSCRIPTION_HASH |
Ein von Monsum fest vergebener Hash zum Verfolgen des Abonnements |
| CUSTOMER_ID |
Eine von Monsum vergebene bestimmte Kundennummer |
| SUBSCRIPTION_TITLE |
Alternativer Titel für das Abo - : Überschreibt Produkteinstellungen(Produkttitel) für das Abo! |
| START |
Start des Abos |
| NEXT_EVENT |
Nächstes Zahlungsziel |
| CANCELLATION_DATE |
Ende des Abos |
| STATUS |
Status |
| HASH |
Hash |
| X_ATTRIBUTES |
Verwendung eigener Felder (Notifications geben die Werte mit zurück) |
| ARTICLE_NUMBER |
Artikelnummer |
| QUANTITY |
Mengenangabe |
| PLAN |
Details zum Basisprodukt |
| SUBSCRIPTION_EXT_UID |
Bestimmtes Abo mit vergebener ID |
| INVOICE_TITLE |
Rechnungstitel |
| LAST_EVENT |
Letztes Event |
| CANCELLATION_NOTE |
Grund der Kündigung eines Abonnements |
| ADDONS |
Zusatzprodukte |
| EXPIRATION_DATE |
Auslaufdatum |
| PLAN_UPCOMING |
Bevorstehendes Downgrade des Abonnements |
subscription.create
Erstellen eines neuen Abonnements.
DATA
| Tags | Beschreibung |
| SUBSCRIPTION_EXT_UID |
Bestimmtes Abo mit vergebener ID |
| ARTICLE_NUMBER Required |
Artikelnummer |
| CUSTOMER_ID Required |
Eine von Monsum vergebene bestimmte Kundennummer |
| QUANTITY |
Mengenangabe |
| COUPON |
Rabattcode |
| TITLE |
Titel |
| UNIT_PRICE |
Alternativer Einzelpreis für das Abo - WARNUNG: Überschreibt Produkteinstellungen(Produktpreis) für das Abo! |
| CURRENCY_CODE |
Währungscode |
| DESCRIPTION |
Alternativer Beschreibungstext für das Abo - WARNUNG: Überschreibt Produkteinstellungen(Beschreibung) für das Abo! |
| INVOICE_TITLE |
Rechnungstitel |
| START_DATE |
Start des Abonnements (relevant für Vertragslaufzeiten) |
| NEXT_EVENT |
Nächstes Zahlungsziel |
| X_ATTRIBUTES |
Verwendung eigener Felder (Notifications geben die Werte mit zurück) |
| CANCELLATION_DATE |
Ende des Abos |
| ADDONS |
Zusatzprodukte |
| FEATURES |
Produktfeatures |
RESPONSE
| Tags | Beschreibung |
| STATUS |
Status |
| SUBSCRIPTION_ID |
Eine von Monsum vergebene bestimmte Abonnementnummer |
| HASH |
Hash |
| INVOICE_ID |
Eine von Monsum vergebene bestimmte Rechnungsnummer |
| PAYPAL_URL |
Paypal-Link zur Zahlung einer Rechnung |
subscription.update
Nächsten Zahlungstermin in der Subscription eines Kunden ändern.
DATA
| Tags | Beschreibung |
| SUBSCRIPTION_ID Required |
Eine von Monsum vergebene bestimmte Abonnementnummer |
| NEXT_EVENT |
Nächstes Zahlungsziel |
| SUBSCRIPTION_EXT_UID |
Bestimmtes Abo mit vergebener ID |
| STATUS |
Status |
| X_ATTRIBUTES |
Verwendung eigener Felder (Notifications geben die Werte mit zurück) |
| FEATURES |
Produktfeatures |
| See action |
invoice.create |
RESPONSE
| Tags | Beschreibung |
| STATUS |
Status |
subscription.changearticle
Artikel in der Subscription eines Kunden ändern.
DATA
| Tags | Beschreibung |
| SUBSCRIPTION_ID Required |
Eine von Monsum vergebene bestimmte Abonnementnummer |
| QUANTITY |
Mengenangabe |
| ARTICLE_NUMBER Required |
Artikelnummer |
| TITLE |
Titel |
| DESCRIPTION |
Alternativer Beschreibungstext für das Abo - WARNUNG: Überschreibt Produkteinstellungen(Beschreibung) für das Abo! |
| UNIT_PRICE |
Alternativer Einzelpreis für das Abo - WARNUNG: Überschreibt Produkteinstellungen(Produktpreis) für das Abo! |
| CURRENCY_CODE |
Währungscode |
| RESET_ADDONS |
Löschen der Addons beim Wechsel zu einem anderen Produkt 0 = nein | 1 = ja |
| COUPON |
Rabattcode |
| ADDONS |
Zusatzprodukte |
| FEATURES |
Produktfeatures |
| SUPPRESS_MAIL |
Verhindert den automatischen Mailversand bei Addon-Buchung |
RESPONSE
| Tags | Beschreibung |
| STATUS |
Status |
| SUBSCRIPTION_ID |
Eine von Monsum vergebene bestimmte Abonnementnummer |
subscription.setaddon
Erstellen eines neuen Addons zu einem bestehenden Produkt.
DATA
| Tags | Beschreibung |
| SUBSCRIPTION_ID Required |
Eine von Monsum vergebene bestimmte Abonnementnummer |
| ARTICLE_NUMBER Required |
Artikelnummer |
| QUANTITY |
Mengenangabe |
| TITLE |
Titel |
| DESCRIPTION |
Alternativer Beschreibungstext für das Abo - WARNUNG: Überschreibt Produkteinstellungen(Beschreibung) für das Abo! |
| UNIT_PRICE |
Alternativer Einzelpreis für das Abo - WARNUNG: Überschreibt Produkteinstellungen(Produktpreis) für das Abo! |
| SUPPRESS_BILL_RUN |
Verhindert eine sofortige Abrechnung bei Addon-Buchung |
| SUPPRESS_MAIL |
Verhindert den automatischen Mailversand bei Addon-Buchung |
RESPONSE
| Tags | Beschreibung |
| STATUS |
Status |
subscription.setusagedata
Verbrauchsabhängige Buchung, welche summiert auf der nächsten Rechnung angegeben wird.
DATA
| Tags | Beschreibung |
| SUBSCRIPTION_ID Required |
Eine von Monsum vergebene bestimmte Abonnementnummer |
| ARTICLE_NUMBER Required |
Artikelnummer |
| QUANTITY |
Mengenangabe |
| UNIT_PRICE |
Alternativer Einzelpreis für das Abo - WARNUNG: Überschreibt Produkteinstellungen(Produktpreis) für das Abo! |
| DESCRIPTION |
Alternativer Beschreibungstext für das Abo - WARNUNG: Überschreibt Produkteinstellungen(Beschreibung) für das Abo! |
| CURRENCY_CODE |
Währungscode |
| USAGE_DATE |
Zeitpunkt der Buchung (z.B.2020-04-24 13:18:07) |
RESPONSE
| Tags | Beschreibung |
| STATUS |
Status |
| USAGEDATA_ID |
Identifikationsmerkmal des eingelieferten Produktes |
subscription.getusagedata
Abfrage nach den verbrauchsabhängigen Buchungen eines Abonnements.
FILTER
| Tags | Beschreibung |
| SUBSCRIPTION_ID Required |
Eine von Monsum vergebene bestimmte Abonnementnummer |
RESPONSE
| Tags | Beschreibung |
| USAGEDATA_ID |
Identifikationsmerkmal des eingelieferten Produktes |
| CUSTOMER_ID |
Eine von Monsum vergebene bestimmte Kundennummer |
| SUBSCRIPTION_ID |
Eine von Monsum vergebene bestimmte Abonnementnummer |
| ARTICLE_ID |
Produkt ID |
| UNIT_PRICE |
Alternativer Einzelpreis für das Abo - WARNUNG: Überschreibt Produkteinstellungen(Produktpreis) für das Abo! |
| DESCRIPTION |
Alternativer Beschreibungstext für das Abo - WARNUNG: Überschreibt Produkteinstellungen(Beschreibung) für das Abo! |
| CURRENCY_CODE |
Währungscode |
| STATUS |
Status |
| USAGE_DATE |
Zeitpunkt der Buchung (z.B.2020-04-24 13:18:07) |
| CREATED |
Erstellt (z.B.2020-04-24 13:18:07) |
| QUANTITY |
Mengenangabe |
subscription.deleteusagedata
Löschen einer verbrauchsabhängigen Buchung.
DATA
| Tags | Beschreibung |
| USAGEDATA_ID Required |
Identifikationsmerkmal des eingelieferten Produktes |
RESPONSE
| Tags | Beschreibung |
| STATUS |
Status |
subscription.cancel
Kündigung eines Abonnements.
DATA
| Tags | Beschreibung |
| SUBSCRIPTION_ID Required |
Eine von Monsum vergebene bestimmte Abonnementnummer |
| CANCELLATION_DATE |
Ende des Abos |
| CANCELLATION_NOTE |
Grund der Kündigung eines Abonnements |
RESPONSE
| Tags | Beschreibung |
| STATUS |
Status |
| CANCELLATION_DATE |
Ende des Abos |
subscription.reactivate
Reaktivierung eines Abonnements.
DATA
| Tags | Beschreibung |
| SUBSCRIPTION_ID |
Eine von Monsum vergebene bestimmte Abonnementnummer |
RESPONSE
| Tags | Beschreibung |
| STATUS |
Status |
subscription.getupcomingamount
Die Höhe der nächsten möglichen Zahlung erhalten.
DATA
| Tags | Beschreibung |
| ARTICLE_NUMBER |
Artikelnummer |
| COUPON |
Rabattcode |
| COUNTRY_CODE |
Ländercode (ISO 3166 ALPHA-2) |
| ADDONS |
Zusatzprodukte |
RESPONSEsubscription.postpone
Versandevent pausieren.
DATA
| Tags | Beschreibung |
| SUBSCRIPTION_ID Required |
Eine von Monsum vergebene bestimmte Abonnementnummer |
| MONTH Required |
Monat |
RESPONSE
| Tags | Beschreibung |
| STATUS |
Status |
subscription.renew
Einzelrechnungslauf für 1 bestimmtes Abo. (Funktioniert nur, wenn das next Event in der Vergangenheit liegt)
DATA
| Tags | Beschreibung |
| SUBSCRIPTION_ID Required |
Eine von Monsum vergebene bestimmte Abonnementnummer |
RESPONSE
| Tags | Beschreibung |
| STATUS |
Status |
subscription.createsecurelink
Erstellen der Links zu den Hosted Pages für das Abonnement
DATA
| Tags | Beschreibung |
| SUBSCRIPTION_ID Required |
Eine von Monsum vergebene bestimmte Abonnementnummer |
RESPONSE
| Tags | Beschreibung |
| ADDONS_URL |
Link zur Addon-Übersicht eines Abonnements |
| CANCEL_URL |
Link zur Kündigungsseite eines Abonnements |
| REACTIVATE_URL |
Link zur Seite für die Reaktivierung eines Abonnements |
subscription.changequantity
Artikelmenge innerhalb eines Abonnements ändern. Bei Ruduktion der Menge erfolgt keine Rechnungsstellung
DATA
| Tags | Beschreibung |
| SUBSCRIPTION_ID Required |
Eine von Monsum vergebene bestimmte Abonnementnummer |
| QUANTITY Required |
Mengenangabe |
| ARTICLE_NUMBER Required |
Artikelnummer |
| ADDONS |
Zusatzprodukte |
RESPONSE
| Tags | Beschreibung |
| STATUS |
Status |
| SUBSCRIPTION_ID |
Eine von Monsum vergebene bestimmte Abonnementnummer |