A URL redirection at the end of a Customer Workflow replaces the last page of the workflow with a page of the merchant’s web application. It is set in Settings / Hosted Pages / Customer Workflows.
The from and outcome parameters added to the URL tell which workflow ended, and how.
This redirection has two purposes:
- Fluidify the customer experience, for example by sending new subscribers to a specific page.
- Perform customized actions whenever a subscription-billing process ends, like refreshing the user’s rights.
Querystring parameters
Section titled “Querystring parameters”Here are the parameters added to the redirection URL.
| Parameter | Description | Detail |
|---|---|---|
| from | See the list below for all the possible values. | Always present |
| outcome | See the list below for all the possible values. | Always present |
| idc | (for idCustomer) Internal identifier of the Customer in ProAbono. For security reasons, the shared identifier (ReferenceCustomer) is not used. | Always present |
| refo | (for ReferenceOffer) Reference of the related Offer. | Only if relevant |
| idsub | (for idSubscription) Internal identifier of the Subscription in ProAbono. | Only if relevant |
For example, the customer cust-42 subscribes to the offer offer-premium and pays by card. With https://my-app.com/billing set as the redirection URL, the customer is sent to:
https://my-app.com/billing?from=subscribe&outcome=paid&idc=133700&refo=offer-premium&idsub=44088In that URL, from=subscribe says a subscription was just taken out and outcome=paid that its payment is complete. idc=133700 is the internal identifier of cust-42, whose reference is not passed. refo=offer-premium is the reference of the offer, and idsub=44088 the internal identifier of the new subscription.
Values of the ‘from’ parameter
Section titled “Values of the ‘from’ parameter”This parameter indicates what workflow the customer just completed. It’s useful to display the right message or perform the correct post-processing.
| Value | Description |
|---|---|
| subscribe | The customer just subscribed. |
| upgrade | The customer changed its plan. |
| restart | The customer restarted its suspended subscription. |
| options | The customer changed the options of its subscription. |
| terminate | The customer terminated its subscription. The termination takes effect at the end of the billing period; until then, the customer can cancel it. |
| permission | The customer changed its registered payment method. |
| invoice | The customer paid a due invoice. |
| portal | The user was not redirected from a Customer Workflow but from the Customer Portal. See this article to know more. |
Values of the ‘outcome’ parameter
Section titled “Values of the ‘outcome’ parameter”This parameter indicates how the workflow ended.
| Value | Description |
|---|---|
| nocharge | The customer was not charged. Either the operation is free or the payment is due later. |
| paid | A payment was processed and complete. |
| pending | A payment was processed and is pending. |
| due | A payment is expected for a customer with an offline payment method. |
| registered | The customer registered its payment method, but no payment was processed. |
Use cases
Section titled “Use cases”The most standard use-case for this redirection is refreshing the user’s permission at the end of a subscription-billing process. This is recommended in this article about rights management.
Another use case is to fluidify the customer experience by sending customers directly to the right page of the merchant’s application, skipping a needless ‘payment success’ page.