Manage Billing Portal
Follow these steps in order. Each step names the API call it makes; open it in the API Reference to try it out in the API playground.
Manage Billing Portal
Introduction
This is a guided walkthrough showcasing Billing Portal Management in Maxio.
Subscriptions can also be updated, by the subscriber, via the Billing Portal. The Billing Portal serves as a method to allow your subscribers to perform certain managerial actions against their current subscription. As a merchant, you have the ability to also restrict what actions can be performed by a subscriber.
Here are a few examples of actions that can be performed via the Billing Portal:
- Plan changes
- Subscription cancellation
- Credit card updates
- Component purchase / allocation updates
For more information on the Billing Portal, read this help article.
As a prerequisite for this walkthrough, your site must have Billing Portal enabled. To enable this, navigate to the settings of your Advanced Billing Site, then select Billing Portal. Select Enabled for this site and fill in any additional settings as necessary.
Step 1: Enable Billing Portal for Specific Customer
Enter the ID of the customer you want to enable billing portal access for. If you've completed a \
API call: enableBillingPortalForCustomer
Example arguments:
{}Step 2: Read Billing Portal Invite
If your customer has been invited to the Billing Portal, they will receive a link to manage their subscription automatically at the bottom of their statements, invoices, and receipts. This link changes periodically for security reasons and is only valid for 65 days.
If you need to provide your customer with their Management URL through other means, you can retrieve it via the API using this endpoint.
API call: readBillingPortalLink
Example arguments:
{
customer_id: step1State?.data["customer"]?.id,
}Step 3: Resend Billing Portal Invitation
If the portal invitation has been lost, you can use the following endpoint to resend the invitation.
API call: resendBillingPortalInvitation
Example arguments:
{
customer_id: step1State?.data["customer"]?.id,
}If you decide to no longer provide self-service access to your customer, you can revoke their access using the following endpoint.
API call: revokeBillingPortalAccess
Example arguments:
{
customer_id: step1State?.data["customer"]?.id,
}