Struct stripe::CreateBillingPortalSession

pub struct CreateBillingPortalSession<'a> {
    pub configuration: Option<&'a str>,
    pub customer: CustomerId,
    pub expand: &'a [&'a str],
    pub flow_data: Option<CreateBillingPortalSessionFlowData>,
    pub locale: Option<BillingPortalSessionLocale>,
    pub on_behalf_of: Option<&'a str>,
    pub return_url: Option<&'a str>,
}

The parameters for BillingPortalSession::create.

Fields

configuration: Option<&'a str>

The ID of an existing configuration to use for this session, describing its functionality and features.

If not specified, the session uses the default configuration.

customer: CustomerId

The ID of an existing customer.

expand: &'a [&'a str]

Specifies which fields in the response should be expanded.

flow_data: Option<CreateBillingPortalSessionFlowData>

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.

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<&'a str>

The on_behalf_of account to use for this session.

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<&'a str>

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

Implementations

impl<'a> CreateBillingPortalSession<'a>

pub fn new(customer: CustomerId) -> Self

Trait Implementations

impl<'a> Clone for CreateBillingPortalSession<'a>

fn clone(&self) -> CreateBillingPortalSession<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CreateBillingPortalSession<'a>

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

Formats the value using the given formatter.

impl<'a> Serialize for CreateBillingPortalSession<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.