Enable Billing Portal for Customer
Enables Billing Portal access for a customer, with an option to send an invitation email at the same time.
Billing Portal Security
If your customer has been invited to the Billing Portal, they receive a link to manage their subscription (the “Management URL”) automatically at the bottom of their statements, invoices, and receipts. This link changes periodically for security and is only valid for 65 days.
If you need to provide your customer their Management URL through other means, you can retrieve it via the API. Because the URL is cryptographically signed with a timestamp, merchants cannot generate the URL without requesting it through the API.
To prevent abuse and overuse, request a new URL only when absolutely necessary. Management URLs are good for 65 days, so you should re-use a previously generated one as much as possible. If you use the URL frequently (such as to display on your website), do not make an API request every time.
For more information configuring the Billing Portal, see Billing Portal Overview.
Authorization
BasicAuth The username is a Maxio Chargify API key. The password is x.
In: header
Path Parameters
The Chargify id of the customer
Query Parameters
When set to 1, an Invitation email will be sent to the Customer.
When set to 0, or not sent, an email will not be sent.
Use in query: auto_invite=1.
Value in
- 0
- 1
Response Body
application/json
application/json
curl -X POST "https://example.com/portal/customers/0/enable.json"{ "customer": { "first_name": "string", "last_name": "string", "email": "string", "cc_emails": "string", "organization": "string", "reference": "string", "id": 0, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "address": "string", "address_2": "string", "city": "string", "state": "string", "state_name": "string", "zip": "string", "country": "string", "country_name": "string", "phone": "string", "verified": true, "portal_customer_created_at": "2019-08-24T14:15:22Z", "portal_invite_last_sent_at": "2019-08-24T14:15:22Z", "portal_invite_last_accepted_at": "2019-08-24T14:15:22Z", "tax_exempt": true, "surcharging": true, "vat_number": "string", "vat_country": "string", "entity_identifier_kind": "vat_eu", "entity_identifier_value": "string", "parent_id": 0, "locale": "string", "default_subscription_group_uid": "string", "salesforce_id": "string", "tax_exempt_reason": "string", "default_auto_renewal_profile_id": 0, "maxioid": "string", "branding_theme_id": 0 }}List Customer Subscriptions GET
Lists all subscriptions that belong to a customer. If you have the new [Catalog experience](https://maxio-test-wp.pages.dev/support/announcements/2026-announcements#new-catalog-experience-and-terminology) enabled, subscriptions no longer require an associated product. For subscriptions without an associated product, 'product', 'product_price_point_id', and 'product_price_point_type' are returned as 'null'.
Read Billing Portal Management Link GET
Returns the exact URL required for a subscriber to access the Billing Portal. ## Management Link Request Rules + When retrieving a management URL, multiple requests for the same customer in a short period return the **same** URL + A new URL is not generated for 15 days + You must cache and remember this URL if you are going to need it again within 15 days + Only request a new URL after the `new_link_available_at` date + You are limited to 15 requests for the same URL. If you make more than 15 requests before `new_link_available_at`, you are blocked from further Management URL requests (with a response code `429`).