Abonnements


subscription.get

Abfragen der Details eines oder mehrerer Abonnements. Wenn kein Filter gesetzt wird, werden 10 Abonnements zurückgeliefert. (ID-Array möglich)


FILTER
TagsBeschreibung
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
TagsBeschreibung
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
TagsBeschreibung
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
TagsBeschreibung
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
TagsBeschreibung
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
TagsBeschreibung
STATUS Status

subscription.changearticle

Artikel in der Subscription eines Kunden ändern.


DATA
TagsBeschreibung
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
TagsBeschreibung
STATUS Status
SUBSCRIPTION_ID Eine von Monsum vergebene bestimmte Abonnementnummer

subscription.setaddon

Erstellen eines neuen Addons zu einem bestehenden Produkt.


DATA
TagsBeschreibung
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
TagsBeschreibung
STATUS Status

subscription.setusagedata

Verbrauchsabhängige Buchung, welche summiert auf der nächsten Rechnung angegeben wird.


DATA
TagsBeschreibung
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
TagsBeschreibung
STATUS Status
USAGEDATA_ID Identifikationsmerkmal des eingelieferten Produktes

subscription.getusagedata

Abfrage nach den verbrauchsabhängigen Buchungen eines Abonnements.


FILTER
TagsBeschreibung
SUBSCRIPTION_ID Required Eine von Monsum vergebene bestimmte Abonnementnummer

RESPONSE
TagsBeschreibung
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
TagsBeschreibung
USAGEDATA_ID Required Identifikationsmerkmal des eingelieferten Produktes

RESPONSE
TagsBeschreibung
STATUS Status

subscription.cancel

Kündigung eines Abonnements.


DATA
TagsBeschreibung
SUBSCRIPTION_ID Required Eine von Monsum vergebene bestimmte Abonnementnummer
CANCELLATION_DATE Ende des Abos
CANCELLATION_NOTE Grund der Kündigung eines Abonnements

RESPONSE
TagsBeschreibung
STATUS Status
CANCELLATION_DATE Ende des Abos

subscription.reactivate

Reaktivierung eines Abonnements.


DATA
TagsBeschreibung
SUBSCRIPTION_ID Eine von Monsum vergebene bestimmte Abonnementnummer

RESPONSE
TagsBeschreibung
STATUS Status

subscription.getupcomingamount

Die Höhe der nächsten möglichen Zahlung erhalten.


DATA
TagsBeschreibung
ARTICLE_NUMBER Artikelnummer
COUPON Rabattcode
COUNTRY_CODE Ländercode (ISO 3166 ALPHA-2)
ADDONS Zusatzprodukte

RESPONSE
TagsBeschreibung
TOTAL

subscription.postpone

Versandevent pausieren.


DATA
TagsBeschreibung
SUBSCRIPTION_ID Required Eine von Monsum vergebene bestimmte Abonnementnummer
MONTH Required Monat

RESPONSE
TagsBeschreibung
STATUS Status

subscription.renew

Einzelrechnungslauf für 1 bestimmtes Abo. (Funktioniert nur, wenn das next Event in der Vergangenheit liegt)


DATA
TagsBeschreibung
SUBSCRIPTION_ID Required Eine von Monsum vergebene bestimmte Abonnementnummer

RESPONSE
TagsBeschreibung
STATUS Status

Erstellen der Links zu den Hosted Pages für das Abonnement


DATA
TagsBeschreibung
SUBSCRIPTION_ID Required Eine von Monsum vergebene bestimmte Abonnementnummer

RESPONSE
TagsBeschreibung
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
support@monsum.com
© 2016 FastBill GmbH