stopRebilling
Syntax
stopRebilling( purchase_id, force=false,
ignore_refund_possibility=false )
Stops the recurring payments (for subscription and installment payments)
Access rights
Full access required.
Arguments
purchase_id – the Digistore24 order ID
force – if possible, a rebilling is canceled immediately. If a minimum duration is specified, this will be adhered to by default (for force ==false – that is the default), meaning that it will be canceled at the end of the minimum duration. If force ==true, it will be canceled immediately.
ignore_refund_possibility – if false (default), an the purchase is cancelled effective immediately, if a refund is possible. If true, the cancellation becomes effective at the end of the regular cancallation period. The parameter is ignored, if force == true.
Return data
- modified: ‘Y’ or ‘N’
- note: Note text on the outcome
-
code:A code indicating the outcome. In case of success,
codes are:
- stopped_now - the payments have been stopped effective immediately
- stopped_later - the payments have been stopped effective at the given date in the future
- stopped_manual_rebilling - the payments have been stopped, before the first payment has been done for a manual rebilling purchase
- billing_status: ‘paying’, ‘aborted’, ‘unpaid‘, ‘paying’, ‘reminding’, ‘completed’
- billing_status_msg: ditto, only in plain text in the set language e.g. “payment aborted” for “aborted”
- next_payment_at: date of the next payment e.g. “2015-12-31 14:47:00” or empty
- rebilling_active: ‘Y’ or ‘N’
- is_cancelled_now: ‘Y’ or ‘N’
- is_cancelled_later: ‘Y’ or ‘N’. For Y, the order is canceled on the date can_cancel_before.
- can_cancel_before: for minimum duration: earliest possible regular cancelation date, e.g. ‘2017-12-03’. Otherwise: empty (“)