Struct BillingPortalSession 

pub struct BillingPortalSession {
    pub configuration: Expandable<BillingPortalConfiguration>,
    pub created: Timestamp,
    pub customer: String,
    pub flow: Option<PortalFlowsFlow>,
    pub id: BillingPortalSessionId,
    pub livemode: bool,
    pub locale: Option<BillingPortalSessionLocale>,
    pub on_behalf_of: Option<String>,
    pub return_url: Option<String>,
    pub url: String,
}

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.

Related guide: Customer management

Fields

configuration: Expandable<BillingPortalConfiguration>

The configuration used by this session, describing the features available.

created: Timestamp

Time at which the object was created. Measured in seconds since the Unix epoch.

customer: String

The ID of the customer for this session.

flow: Option<PortalFlowsFlow>

Information about a specific flow for the customer to go through. See the docs to learn more about using customer portal deep links and flows.

id: BillingPortalSessionId

Unique identifier for the object.

livemode: bool

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

locale: Option<BillingPortalSessionLocale>

The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer’s preferred_locales or browser’s locale is used.

on_behalf_of: Option<String>

The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this on_behalf_of account appear in the portal. For more information, see the docs. Use the Accounts API to modify the on_behalf_of account’s branding settings, which the portal displays.

return_url: Option<String>

The URL to redirect customers to when they click on the portal’s link to return to your website.

url: String

The short-lived URL of the session that gives customers access to the customer portal.

Trait Implementations

impl Clone for BillingPortalSession

fn clone(&self) -> BillingPortalSession

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BillingPortalSession

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deserialize for BillingPortalSession

fn begin(out: &mut Option<Self>) -> &mut dyn Visitor

The only correct implementation of this method is:

impl FromValueOpt for BillingPortalSession

fn from_value(v: Value) -> Option<Self>

impl Object for BillingPortalSession

type Id = BillingPortalSessionId

The canonical id type for this object.

fn id(&self) -> &Self::Id

The id of the object.

fn into_id(self) -> Self::Id

The owned id of the object.

impl ObjectDeser for BillingPortalSession

type Builder = BillingPortalSessionBuilder