Usage: This is only used for Recharge. This is used to be able to apply offers or cancel all subscriptions under a single address.
addressId:'234897sdjknf',
mode
Type: String
Options: live, test
Default: live
Usage: Test mode will utilise the data available while using Upzelo's test mode. This means that it will use Flows, Audiences, and payment provider data that has been imported using your test key.
mode:'test',
type
Type: String
Options: full, minimal
Default: full if hash supplied, otherwise minimal
Usage: This determines if you want Upzelo to action things on your behalf with your payment provider. If set to minimal, offboarding requests will appear in the Requests section of the dashboard for you to action yourself.
type:'minimal',
selector
Type: String
Default: button#cancel, a#cancel
Usage: A CSS selector to select which elements on the page should launch Upzelo when clicked.
selector:'button#cancelButton, a.endSubscription
provider
Type: String
Usage: Only set this if you have been advised by Upzelo support to do so.
provider:'stripe',
Callbacks
There are some available callbacks that you can use to further extend the functionality of Upzelo. They run alongside what Upzelo does and do not replace that functionality, therefore they are optional.
Where a callback has the responses argument, it will be an array of Actions that the user saw (not all of the actions in the Flow), and whether an Action was accepted or not.
You should always check if it is defined before using it as there are a small number of cases where it might not be.