Stripe.BillingPortal.Session (stripity_stripe v2.17.3) View Source

Work with Stripe Billing (aka Self-serve) Portal Session objects.

You can:

Create a session

Stripe API reference: https://stripe.com/docs/api/customer_portal

Link to this section Summary

Types

create_params()

t()

Functions

create(params, opts \\ [])

Link to this section Types

create_params()

Specs

create_params() :: %{
  :customer => String.t(),
  optional(:configuration) => String.t(),
  optional(:return_url) => String.t(),
  optional(:locale) => String.t()
}

t()

Specs

t() :: %Stripe.BillingPortal.Session{
  configuration: String.t(),
  created: Stripe.timestamp(),
  customer: Stripe.id() | Stripe.Customer.t(),
  id: Stripe.id(),
  livemode: boolean(),
  object: String.t(),
  return_url: String.t(),
  url: String.t()
}

Link to this section Functions

create(params, opts \\ [])

Specs

create(create_params(), Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}