Customer Portal
The Customer Portal is a hosted, branded page where your customers can manage their own card subscriptions. Depending on your settings, customers can view invoices, update their billing information, change plans and cancel.
The Customer Portal settings are available when card payments are enabled on your account.
How Customers Open the Portal
Portal links are created through the API for a specific customer (and optionally a specific subscription). Each link is a secure session link that expires. Send the link to your customer, or redirect them to it from your website or app.
See the Customer Portal API documentation for details. Settings sent with the API request override the defaults on this page.
Portal Settings
| Setting | Description | Default |
|---|---|---|
| Show invoices | Allow customers to view their invoices. | On |
| Billing information | Controls access to billing information. See below. | Update |
| Cancellations | Controls whether and when customers can cancel. See below. | End Of Period |
| Plan changes | Controls whether and how customers can change plans. See below. | Smart |
| Select available plans | The recurring (monthly or yearly) products customers can switch between. Select Manage products to create more. | None selected |
| Back to site link | Where the portal's back link takes the customer. | Your business website |
| Page title | Heading shown on the portal. | Manage my subscription |
Billing Information
| Option | Description |
|---|---|
| None | Billing information is not shown. |
| View | Customers can view their billing information. |
| Update | Customers can view and update their billing information. |
Cancellations
| Option | Description |
|---|---|
| None | Customers cannot cancel from the portal. |
| Immediate | The subscription is cancelled immediately. |
| End Of Period | The subscription is cancelled when the current billing period ends. |
Plan Changes
| Option | Description |
|---|---|
| None | Customers cannot change plans. |
| Immediate | Any plan change takes effect immediately. |
| End Of Period | Any plan change takes effect when the current billing period ends. |
| Smart | Upgrades take effect immediately with prorated billing. Downgrades take effect when the current billing period ends. |
Scheduled plan changes show as a Change plan badge on the subscription.
Preview
The preview on the right shows how the portal will look to your customers, using your Branding logo and colours. It updates as you change the settings.
Click Update Details to save your settings.
Related Sections
- Subscriptions
- Products
- Branding
- Access Tokens (the Customer Portal section is required to create portal links)