subscription.get
Request of details of one ore more subscriptions. If no filter is set, 10 subscriptions will be shown. (ID-array possible)
FILTER
| Tags | Description |
| SUBSCRIPTION_ID |
A specific subscription ID |
| CUSTOMER_ID |
A specific customer ID |
| CUSTOMER_EXT_UID |
External ID of customer |
RESPONSE
| Tags | Description |
| SUBSCRIPTION_ID |
A specific subscription ID |
| SUBSCRIPTION_HASH |
A unique subscription hash |
| CUSTOMER_ID |
A specific customer ID |
| SUBSCRIPTION_TITLE |
Alternative subsription title - : Overwrites product settings (product title) within the subscription! |
| START |
Subscription start |
| NEXT_EVENT |
Next payment event |
| CANCELLATION_DATE |
Cancellation Date |
| STATUS |
Status |
| HASH |
Hash |
| X_ATTRIBUTES |
Using own fields (Notifications will return values) |
| ARTICLE_NUMBER |
Article number |
| QUANTITY |
Quantity |
| PLAN |
Details about the basic product |
| SUBSCRIPTION_EXT_UID |
Provides a particular subscription with the ID you can give |
| INVOICE_TITLE |
Invoice title |
| LAST_EVENT |
Last event |
| CANCELLATION_NOTE |
Reason for Cancellation of a Subscription |
| ADDONS |
Addons |
| EXPIRATION_DATE |
Expiration Date |
| PLAN_UPCOMING |
Upcoming Downgrade of the Subscription |
subscription.create
Creation of a subscription.
DATA
| Tags | Description |
| SUBSCRIPTION_EXT_UID |
Provides a particular subscription with the ID you can give |
| ARTICLE_NUMBER Required |
Article number |
| CUSTOMER_ID Required |
A specific customer ID |
| QUANTITY |
Quantity |
| COUPON |
Coupon |
| TITLE |
Title |
| UNIT_PRICE |
Alternative unit price - WARNING: Overwrites product settings (product price) within the subscription! |
| CURRENCY_CODE |
Currency code |
| DESCRIPTION |
Alternative description text - WARNING: Overwrites product settings (description) within the subscription! |
| INVOICE_TITLE |
Invoice title |
| START_DATE |
Start of subscription |
| NEXT_EVENT |
Next payment event |
| X_ATTRIBUTES |
Using own fields (Notifications will return values) |
| CANCELLATION_DATE |
Cancellation Date |
| ADDONS |
Addons |
| FEATURES |
Product features |
RESPONSE
| Tags | Description |
| STATUS |
Status |
| SUBSCRIPTION_ID |
A specific subscription ID |
| HASH |
Hash |
| INVOICE_ID |
A specific invoice ID |
| PAYPAL_URL |
Paypal payment link |
subscription.update
Change next payment date of a subscription of one customer.
DATA
| Tags | Description |
| SUBSCRIPTION_ID Required |
A specific subscription ID |
| NEXT_EVENT |
Next payment event |
| SUBSCRIPTION_EXT_UID |
Provides a particular subscription with the ID you can give |
| STATUS |
Status |
| X_ATTRIBUTES |
Using own fields (Notifications will return values) |
| FEATURES |
Product features |
| See action |
invoice.create |
RESPONSE
| Tags | Description |
| STATUS |
Status |
subscription.changearticle
Change article in subscription of one customer.
DATA
| Tags | Description |
| SUBSCRIPTION_ID Required |
A specific subscription ID |
| QUANTITY |
Quantity |
| ARTICLE_NUMBER Required |
Article number |
| TITLE |
Title |
| DESCRIPTION |
Alternative description text - WARNING: Overwrites product settings (description) within the subscription! |
| UNIT_PRICE |
Alternative unit price - WARNING: Overwrites product settings (product price) within the subscription! |
| CURRENCY_CODE |
Currency code |
| RESET_ADDONS |
Deletion of addons 0 = no | 1 = yes |
| COUPON |
Coupon |
| ADDONS |
Addons |
| FEATURES |
Product features |
| SUPPRESS_MAIL |
blocks mail being sent automatically when addons are added |
RESPONSE
| Tags | Description |
| STATUS |
Status |
| SUBSCRIPTION_ID |
A specific subscription ID |
subscription.setaddon
Creation of an addon for an existing product.
DATA
| Tags | Description |
| SUBSCRIPTION_ID Required |
A specific subscription ID |
| ARTICLE_NUMBER Required |
Article number |
| QUANTITY |
Quantity |
| TITLE |
Title |
| DESCRIPTION |
Alternative description text - WARNING: Overwrites product settings (description) within the subscription! |
| UNIT_PRICE |
Alternative unit price - WARNING: Overwrites product settings (product price) within the subscription! |
| SUPPRESS_BILL_RUN |
blocks immediate bill-run when addons are added |
| SUPPRESS_MAIL |
blocks mail being sent automatically when addons are added |
RESPONSE
| Tags | Description |
| STATUS |
Status |
subscription.setusagedata
Usage dependent booking, which will be summed to the next invoice.
DATA
| Tags | Description |
| SUBSCRIPTION_ID Required |
A specific subscription ID |
| ARTICLE_NUMBER Required |
Article number |
| QUANTITY |
Quantity |
| UNIT_PRICE |
Alternative unit price - WARNING: Overwrites product settings (product price) within the subscription! |
| DESCRIPTION |
Alternative description text - WARNING: Overwrites product settings (description) within the subscription! |
| CURRENCY_CODE |
Currency code |
| USAGE_DATE |
Date of booking(e.g.2020-04-24 13:18:07) |
RESPONSE
| Tags | Description |
| STATUS |
Status |
| USAGEDATA_ID |
Usagedata ID |
subscription.getusagedata
Request of usage dependent bookings of an abonnement.
FILTER
| Tags | Description |
| SUBSCRIPTION_ID Required |
A specific subscription ID |
RESPONSE
| Tags | Description |
| USAGEDATA_ID |
Usagedata ID |
| CUSTOMER_ID |
A specific customer ID |
| SUBSCRIPTION_ID |
A specific subscription ID |
| ARTICLE_ID |
Article ID |
| UNIT_PRICE |
Alternative unit price - WARNING: Overwrites product settings (product price) within the subscription! |
| DESCRIPTION |
Alternative description text - WARNING: Overwrites product settings (description) within the subscription! |
| CURRENCY_CODE |
Currency code |
| STATUS |
Status |
| USAGE_DATE |
Date of booking(e.g.2020-04-24 13:18:07) |
| CREATED |
Created (e.g.2020-04-24 13:18:07) |
| QUANTITY |
Quantity |
subscription.deleteusagedata
Deletion of a booking dependent of usage.
DATA
| Tags | Description |
| USAGEDATA_ID Required |
Usagedata ID |
RESPONSE
| Tags | Description |
| STATUS |
Status |
subscription.cancel
Cancelation of a Subscription
DATA
| Tags | Description |
| SUBSCRIPTION_ID Required |
A specific subscription ID |
| CANCELLATION_DATE |
Cancellation Date |
| CANCELLATION_NOTE |
Reason for Cancellation of a Subscription |
RESPONSE
| Tags | Description |
| STATUS |
Status |
| CANCELLATION_DATE |
Cancellation Date |
subscription.reactivate
Reactivating subscription.
DATA
| Tags | Description |
| SUBSCRIPTION_ID |
A specific subscription ID |
RESPONSE
| Tags | Description |
| STATUS |
Status |
subscription.getupcomingamount
Receive amount of next possible payment.
DATA
| Tags | Description |
| ARTICLE_NUMBER |
Article number |
| COUPON |
Coupon |
| COUNTRY_CODE |
A country (ISO 3166 ALPHA-2) |
| ADDONS |
Addons |
RESPONSEsubscription.postpone
Postpone shipping.
DATA
| Tags | Description |
| SUBSCRIPTION_ID Required |
A specific subscription ID |
| MONTH Required |
Month |
RESPONSE
| Tags | Description |
| STATUS |
Status |
subscription.renew
Single invoice run for a specific subscription.(Only works if next event is in the past)
DATA
| Tags | Description |
| SUBSCRIPTION_ID Required |
A specific subscription ID |
RESPONSE
| Tags | Description |
| STATUS |
Status |
subscription.createsecurelink
Creation of links to the Hosted Pages of the Subscription
DATA
| Tags | Description |
| SUBSCRIPTION_ID Required |
A specific subscription ID |
RESPONSE
| Tags | Description |
| ADDONS_URL |
Link to the Addon-Overview of a Subscription |
| CANCEL_URL |
Link to Cancelation-Page of a Subscription |
| REACTIVATE_URL |
Link to Reactivation-Page of a Subscription |
subscription.changequantity
Change article quantity within a subscription. Reducing the quantity will not result in invoicing
DATA
| Tags | Description |
| SUBSCRIPTION_ID Required |
A specific subscription ID |
| QUANTITY Required |
Quantity |
| ARTICLE_NUMBER Required |
Article number |
| ADDONS |
Addons |
RESPONSE
| Tags | Description |
| STATUS |
Status |
| SUBSCRIPTION_ID |
A specific subscription ID |