Developer Area

Customer Portal vs Customer Workflows

The Hosted Pages are a set of interconnected pages generated by ProAbono, created to cover all aspects of your subscription-billing processes. The Hosted Pages are splitted into Customer Portal and Customer Workflows.

The Customer Portal is the ‘billing’ section that exists in all the subscription-based products. It’s where you can see your current plan, download invoices, change billing settings, etc.

The Customer Workflows are the multi-steps forms that allows your customer to subscribe, change plan, pays invoices etc.

All Customer Workflows end with a payment step where the user can, depending on the case:

• pay immediately
• register a payment method
• be notified or a later payment
• be informed that the operation is free

URL Redirection

In some cases, you will need a specific page to be displayed at the end of a customer workflow.

For example, if a customer subscribes, you may want to send them directly to a specific page.

This is handled through URL redirection and can be set up here.

Check this article to know more about URL redirections.

Opening a Customer Workflow

Customer Workflows can be opened in three ways:

• When a customer browses the portal and selects a workflow action
  • ex: Change plan, Change options, Restart a subscription, Change payment method, …
• When a customer follows a link sent by email
  • ex: Pay an invoice, Restart a subscription
• When you opened the hosted pages in a given workflow
  • Check this article to see how you can open a specific workflow

Customer Workflows list

Here are all the customer workflows and how to access it.

Anonymous user

Workflow	What it does	How to open
Anonymous subscription	Anonymous user (not recommended). When an anonymous user clicks a plan in the catalog to subscribe.	Static link in the Catalog

Authenticated user

Workflow	What it does	How to open
Choose a plan	Displays the catalog. The user can choose a plan and subscribe.	API Live Customer: rel=hosted-collection-offers Customer Portal ‘Choose a plan’ button from an ended subscription
Subscribe to a plan	Opens the process to subscribe to a given plan.	API Live Customer: rel=hosted-subscribe Offer: rel=hosted-subscribe
Subscribe to a custom subscription	Opens the process to subscribe to a custom subscription.	API Live Subscription: rel=hosted-subscribe
Change plan	Displays the catalog. The user can choose a plan to change the plan of a given subscription.	API Live Customer: rel=hosted-collection-upgrade Subscription: rel=hosted-collection-upgrade
Change to a plan	Opens the process to change the plan of a given subscription to a new plan.	API Live Customer: rel=hosted-upgrade Subscription: rel=hosted-upgrade Offer: rel=hosted-upgrade Customer Portal ‘Change plan’ button from a subscription
Change to a subscription	Opens the process to change the plan of a given subscription to a new custom subscription.	API Live Subscription: rel=hosted-upgrade
Restart a subscription	Opens the process to restart a suspended subscription.	API Live Subscription: rel=hosted-restart Customer Portal ‘Restart subscription’ button from a suspended subscription
Change option	Opens the process to change the updatable options of a subscription.	Customer Portal ‘Change options’ button from a subscription
Terminate subscription	Opens the process to terminate a subscription SPECIAL: Not a customer workflow unless termination fees apply.	Customer Portal ‘Terminate subscription’ button from an active subscription
Register billing info	Opens the process to fill or update the customer’s contact information and payment method.	API Live Customer: rel=hosted-register Subscription: rel=hosted-register
Register payment method	Opens the process to fill or update the customer’s payment method.	Customer Portal ‘Change’ button in the Payment tab
Pay invoice	Opens the process to pay a due invoice	API Live Invoice: rel=hosted-charge Customer Portal ‘Pay’ button in the Invoices tab