Struct stripe::CreateSetupIntent
source · [−]pub struct CreateSetupIntent<'a> {Show 13 fields
pub confirm: Option<bool>,
pub customer: Option<CustomerId>,
pub description: Option<&'a str>,
pub expand: &'a [&'a str],
pub mandate_data: Option<CreateSetupIntentMandateData>,
pub metadata: Option<Metadata>,
pub on_behalf_of: Option<&'a str>,
pub payment_method: Option<PaymentMethodId>,
pub payment_method_data: Option<CreateSetupIntentPaymentMethodData>,
pub payment_method_options: Option<CreateSetupIntentPaymentMethodOptions>,
pub payment_method_types: Option<Vec<String>>,
pub return_url: Option<&'a str>,
pub single_use: Option<CreateSetupIntentSingleUse>,
}
Expand description
The parameters for SetupIntent::create
.
Fields
confirm: Option<bool>
Set to true
to attempt to confirm this SetupIntent immediately.
This parameter defaults to false
.
If the payment method attached is a card, a return_url may be provided in case additional authentication is required.
customer: Option<CustomerId>
ID of the Customer this SetupIntent belongs to, if one exists.
If present, the SetupIntent’s payment method will be attached to the Customer on successful setup.
Payment methods attached to other Customers cannot be used with this SetupIntent.
description: Option<&'a str>
An arbitrary string attached to the object.
Often useful for displaying to users.
expand: &'a [&'a str]
Specifies which fields in the response should be expanded.
mandate_data: Option<CreateSetupIntentMandateData>
This hash contains details about the Mandate to create.
This parameter can only be used with confirm=true
.
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.
Individual keys can be unset by posting an empty value to them.
All keys can be unset by posting an empty value to metadata
.
on_behalf_of: Option<&'a str>
The Stripe account ID for which this SetupIntent is created.
payment_method: Option<PaymentMethodId>
ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent.
payment_method_data: Option<CreateSetupIntentPaymentMethodData>
When included, this hash creates a PaymentMethod that is set as the payment_method
value in the SetupIntent.
payment_method_options: Option<CreateSetupIntentPaymentMethodOptions>
Payment-method-specific configuration for this SetupIntent.
payment_method_types: Option<Vec<String>>
The list of payment method types (e.g.
card) that this SetupIntent is allowed to use. If this is not provided, defaults to [“card”].
return_url: Option<&'a str>
The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method’s app or site.
If you’d prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.
This parameter can only be used with confirm=true
.
single_use: Option<CreateSetupIntentSingleUse>
If this hash is populated, this SetupIntent will generate a single_use Mandate on success.
Implementations
sourceimpl<'a> CreateSetupIntent<'a>
impl<'a> CreateSetupIntent<'a>
Trait Implementations
sourceimpl<'a> Clone for CreateSetupIntent<'a>
impl<'a> Clone for CreateSetupIntent<'a>
sourcefn clone(&self) -> CreateSetupIntent<'a>
fn clone(&self) -> CreateSetupIntent<'a>
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl<'a> Debug for CreateSetupIntent<'a>
impl<'a> Debug for CreateSetupIntent<'a>
sourceimpl<'a> Default for CreateSetupIntent<'a>
impl<'a> Default for CreateSetupIntent<'a>
sourcefn default() -> CreateSetupIntent<'a>
fn default() -> CreateSetupIntent<'a>
Returns the “default value” for a type. Read more
sourceimpl<'a> Serialize for CreateSetupIntent<'a>
impl<'a> Serialize for CreateSetupIntent<'a>
Auto Trait Implementations
impl<'a> RefUnwindSafe for CreateSetupIntent<'a>
impl<'a> Send for CreateSetupIntent<'a>
impl<'a> Sync for CreateSetupIntent<'a>
impl<'a> Unpin for CreateSetupIntent<'a>
impl<'a> UnwindSafe for CreateSetupIntent<'a>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more