Manages Stripe customer portal configurations controlling branding, features, and business info.

A portal configuration defines the appearance and available actions for your customers' self-service billing portal (the page returned by LatticeStripe.BillingPortal.Session.create/3).

Lifecycle

Configurations cannot be deleted — only deactivated via update(client, id, %{"active" => false}). Once deactivated, the configuration can be re-activated by setting active back to true.

A configuration marked is_default: true is Stripe's account default and cannot be deactivated. Attempting to deactivate the default configuration returns a Stripe error; no client-side guard is applied — let Stripe enforce this invariant.

Usage

client = LatticeStripe.Client.new!(api_key: "sk_live_...", finch: MyApp.Finch)

# Create a custom portal configuration
{:ok, config} = LatticeStripe.BillingPortal.Configuration.create(client, %{
  "business_profile" => %{
    "headline" => "Manage your subscription",
    "privacy_policy_url" => "https://example.com/privacy",
    "terms_of_service_url" => "https://example.com/terms"
  },
  "features" => %{
    "invoice_history" => %{"enabled" => true}
  }
})

# Retrieve a configuration
{:ok, config} = LatticeStripe.BillingPortal.Configuration.retrieve(client, "bpc_123")

# Deactivate a configuration (cannot delete)
{:ok, _config} = LatticeStripe.BillingPortal.Configuration.update(
  client, config.id, %{"active" => false}
)

# List all configurations
{:ok, resp} = LatticeStripe.BillingPortal.Configuration.list(client)
configs = resp.data.data  # [%Configuration{}, ...]

# Stream all configurations lazily (auto-pagination)
client
|> LatticeStripe.BillingPortal.Configuration.stream!()
|> Enum.each(&process_config/1)

Stripe API Reference

See the Stripe Portal Configuration API for the full object reference and available parameters.