Customer portal sessions: a Stripe-hosted page where customers update payment methods, view invoices, and change or cancel subscriptions. Configure what the portal allows in the Dashboard (or /v1/billing_portal/configurations via ::stripe::api/call). See https://docs.stripe.com/api/customer_portal/sessions.

Functions

create-portal-session

fn (request: CreatePortalSessionRequest): Map
fn (request: CreatePortalSessionRequest, options: ::stripe::api/RequestOptions | Map): Map

POST /v1/billing_portal/sessions - Create a customer portal session and redirect the customer to its short-lived url. flow_data deep-links into one flow, e.g. {type: "payment_method_update"} or {type: "subscription_cancel", subscription_cancel: {subscription: "sub_..."}}.

Example

::portal ::stripe::billing-portal

session ::portal/create-portal-session(::portal/CreatePortalSessionRequest({
  customer: "cus_...",
  return_url: "https://example.com/account"
}))
session.url  // => "https://billing.stripe.com/p/session/..."

Types

CreatePortalSessionRequest

CreatePortalSessionRequest type {
    customer: Str,
    return_url: Str?,
    configuration: Str?,
    flow_data: Map?,
    locale: Str?,
    on_behalf_of: Str?,
    expand: Vec<Str>?
}