Struct CreateBillingPortalConfiguration 

pub struct CreateBillingPortalConfiguration { /* private fields */ }

Creates a configuration that describes the functionality and behavior of a PortalSession

Implementations

impl CreateBillingPortalConfiguration

pub fn new( features: impl Into<CreateBillingPortalConfigurationFeatures>, ) -> Self

Construct a new CreateBillingPortalConfiguration.

pub fn business_profile( self, business_profile: impl Into<CreateBillingPortalConfigurationBusinessProfile>, ) -> Self

The business information shown to customers in the portal.

pub fn default_return_url(self, default_return_url: impl Into<String>) -> Self

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.

pub fn expand(self, expand: impl Into<Vec<String>>) -> Self

Specifies which fields in the response should be expanded.

pub fn login_page( self, login_page: impl Into<CreateBillingPortalConfigurationLoginPage>, ) -> Self

The hosted login page for this configuration. Learn more about the portal login page in our integration docs.

pub fn metadata(self, metadata: impl Into<HashMap<String, String>>) -> Self

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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

pub fn name(self, name: impl Into<String>) -> Self

The name of the configuration.

impl CreateBillingPortalConfiguration

pub async fn send<C: StripeClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>

Send the request and return the deserialized response.

pub fn send_blocking<C: StripeBlockingClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>

Send the request and return the deserialized response, blocking until completion.

Trait Implementations

impl Clone for CreateBillingPortalConfiguration

fn clone(&self) -> CreateBillingPortalConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateBillingPortalConfiguration

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

Formats the value using the given formatter.

impl Serialize for CreateBillingPortalConfiguration

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StripeRequest for CreateBillingPortalConfiguration

type Output = BillingPortalConfiguration

The data returned from the eventual API call.

fn build(&self) -> RequestBuilder

Convert the struct into library-agnostic data that can be used by compatible clients to make API calls.

fn customize(&self) -> CustomizableStripeRequest<Self::Output>

Convert to a builder allowing per-request customization.