pub struct BillingPortalSession {
pub id: BillingPortalSessionId,
pub configuration: Expandable<BillingPortalConfiguration>,
pub created: Timestamp,
pub customer: String,
pub flow: Option<PortalFlowsFlow>,
pub livemode: bool,
pub locale: Option<BillingPortalSessionLocale>,
pub on_behalf_of: Option<String>,
pub return_url: Option<String>,
pub url: String,
}
Expand description
The resource representing a Stripe “PortalSession”.
Fields§
§id: BillingPortalSessionId
Unique identifier for the object.
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.
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.
Implementations§
source§impl BillingPortalSession
impl BillingPortalSession
sourcepub fn create(
client: &Client,
params: CreateBillingPortalSession<'_>
) -> Response<BillingPortalSession>
pub fn create( client: &Client, params: CreateBillingPortalSession<'_> ) -> Response<BillingPortalSession>
Creates a session of the customer portal.
Trait Implementations§
source§impl Clone for BillingPortalSession
impl Clone for BillingPortalSession
source§fn clone(&self) -> BillingPortalSession
fn clone(&self) -> BillingPortalSession
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more