Create billing portal session

Changed on

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Creates a link to the Stripe customer portal for your workspace. The link opens a hosted page: open it in a browser, and the workspace owner updates the card, downloads invoices, or manages the plan there. Nothing in the portal can be completed through the API. Only the workspace owner can create the link.

When the person leaves the portal, Stripe sends them back to the Base44 billing page.

Set flow_type to choose what the portal offers. A workspace billed through Wix, or one still on a free migration trial, always gets manage_no_cancel unless you ask for payment_method_update. Manage a Wix-billed plan with Change Wix plan, and its card with Create payment method update session.

The base rate limit is 20 requests per hour per user. See Rate limits for the multiplier your plan gets.

post/api/billing/create-portal-session

Request

  • Base URL
    https://app.base44.com
  • URL
    https://app.base44.com/api/billing/create-portal-session
  • Auth
    HTTP bearer

Query parameters

flow_typestring

What the portal offers. default opens the full portal, payment_method_update goes straight to updating the card, and manage_no_cancel hides cancelling and changing the plan. Any other value acts like default.

Response

A link to the Stripe customer portal.

urlstring required

Link to a hosted page. Open it in a browser for a person to finish there. Some links work only once or expire, so open it right away and don't store it.

Example response

{
  "url": "https://billing.stripe.com/p/session/live_YWNjdF8xTjNYcm1EcjU2TDg5ZGtL"
}

Changes