Struct stripe::BillingPortalSession

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

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.

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

impl BillingPortalSession

pub fn create(
    client: &Client,
    params: CreateBillingPortalSession<'_>
) -> Response<BillingPortalSession>

Creates a session of the customer portal.

Trait Implementations

impl Clone for BillingPortalSession

fn clone(&self) -> BillingPortalSession

Returns a copy 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 Default for BillingPortalSession

fn default() -> BillingPortalSession

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BillingPortalSession

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

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 object(&self) -> &'static str

The object’s type, typically represented in wire format as the object property.

impl Serialize for BillingPortalSession

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.