BillingPortalSession class final
PortalSession
The Billing customer portal is a Stripe-hosted UI for subscription and billing management. A portal configuration describes the functionality and features that you want to provide to your customers through the portal. A portal session describes the instantiation of the customer portal for a particular customer. By visiting the session's URL, the customer can manage their subscriptions and billing details. For security reasons, sessions are short-lived and will expire if the customer does not visit the URL. Create sessions on-demand when customers intend to manage their subscriptions and billing details. Learn more in the [integration guide](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal).
- Implemented types
Constructors
- BillingPortalSession({required BillingPortalConfigurationOrId configuration, required DateTime created, required String customer, BillingPortalSessionFlow? flow, required String id, required bool livemode, BillingPortalSessionLocale? locale, String? onBehalfOf, String? returnUrl, required String url})
-
PortalSession
const
- BillingPortalSession.fromJson(Object? json)
-
factory
Properties
- configuration → BillingPortalConfigurationOrId
-
final
- created → DateTime
-
final
- customer → String
-
final
- flow → BillingPortalSessionFlow?
-
Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → String
-
final
- livemode → bool
-
final
- locale → BillingPortalSessionLocale?
-
final
- object → String
-
The resource's type.
final
- onBehalfOf → String?
-
final
- returnUrl → String?
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- url → String
-
final
Methods
-
encodeWith<
V> (Encoder< V> encoder) → V -
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, Object?> -
override
-
toString(
) → String -
A string representation of this object.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
encode<
V> (BillingPortalSession instance, Encoder< V> encoder) → V