Struct stripe::generated::billing::billing_portal_configuration::BillingPortalConfiguration

pub struct BillingPortalConfiguration {
    pub id: BillingPortalConfigurationId,
    pub active: bool,
    pub application: Option<Expandable<Application>>,
    pub business_profile: PortalBusinessProfile,
    pub created: Timestamp,
    pub default_return_url: Option<String>,
    pub features: PortalFeatures,
    pub is_default: bool,
    pub livemode: bool,
    pub login_page: PortalLoginPage,
    pub metadata: Option<Metadata>,
    pub updated: Timestamp,
}

The resource representing a Stripe “PortalConfiguration”.

Fields

id: BillingPortalConfigurationId

Unique identifier for the object.

active: bool

Whether the configuration is active and can be used to create portal sessions.

application: Option<Expandable<Application>>

ID of the Connect Application that created the configuration.

business_profile: PortalBusinessProfile

created: Timestamp

Time at which the object was created.

Measured in seconds since the Unix epoch.

default_return_url: Option<String>

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

This can be overriden when creating the session.

features: PortalFeatures

is_default: bool

Whether the configuration is the default.

If true, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the 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.

login_page: PortalLoginPage

metadata: Option<Metadata>

Set of key-value pairs that you can attach to an object.

This can be useful for storing additional information about the object in a structured format.

updated: Timestamp

Time at which the object was last updated.

Measured in seconds since the Unix epoch.

Trait Implementations

impl Clone for BillingPortalConfiguration

fn clone(&self) -> BillingPortalConfiguration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BillingPortalConfiguration

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

Formats the value using the given formatter.

impl Default for BillingPortalConfiguration

fn default() -> BillingPortalConfiguration

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BillingPortalConfiguration

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Object for BillingPortalConfiguration

type Id = BillingPortalConfigurationId

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 BillingPortalConfiguration

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

where __S: Serializer,

Serialize this value into the given Serde serializer.