Struct CreateCheckoutSessionPaymentIntentData

pub struct CreateCheckoutSessionPaymentIntentData {
    pub application_fee_amount: Option<i64>,
    pub capture_method: Option<CreateCheckoutSessionPaymentIntentDataCaptureMethod>,
    pub description: Option<String>,
    pub metadata: Option<Metadata>,
    pub on_behalf_of: Option<String>,
    pub receipt_email: Option<String>,
    pub setup_future_usage: Option<CreateCheckoutSessionPaymentIntentDataSetupFutureUsage>,
    pub shipping: Option<CreateCheckoutSessionPaymentIntentDataShipping>,
    pub statement_descriptor: Option<String>,
    pub statement_descriptor_suffix: Option<String>,
    pub transfer_data: Option<CreateCheckoutSessionPaymentIntentDataTransferData>,
    pub transfer_group: Option<String>,
}

Available on crate feature checkout only.

Fields

application_fee_amount: Option<i64>

The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner’s Stripe account.

The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents use case for connected accounts.

capture_method: Option<CreateCheckoutSessionPaymentIntentDataCaptureMethod>

Controls when the funds will be captured from the customer’s account.

description: Option<String>

An arbitrary string attached to the object.

Often useful for displaying to users.

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<String>

The Stripe account ID for which these funds are intended.

For details, see the PaymentIntents use case for connected accounts.

receipt_email: Option<String>

Email address that the receipt for the resulting payment will be sent to.

If receipt_email is specified for a payment in live mode, a receipt will be sent regardless of your email settings.

setup_future_usage: Option<CreateCheckoutSessionPaymentIntentDataSetupFutureUsage>

Indicates that you intend to make future payments with the payment method collected by this Checkout Session.

When setting this to on_session, Checkout will show a notice to the customer that their payment details will be saved.

When setting this to off_session, Checkout will show a notice to the customer that their payment details will be saved and used for future payments.

If a Customer has been provided or Checkout creates a new Customer, Checkout will attach the payment method to the Customer.

If Checkout does not create a Customer, the payment method is not attached to a Customer.

To reuse the payment method, you can retrieve it from the Checkout Session’s PaymentIntent. When processing card payments, Checkout also uses setup_future_usage to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.

shipping: Option<CreateCheckoutSessionPaymentIntentDataShipping>

Shipping information for this payment.

statement_descriptor: Option<String>

Extra information about the payment.

This will appear on your customer’s statement when this payment succeeds in creating a charge.

statement_descriptor_suffix: Option<String>

Provides information about the charge that customers see on their statements.

Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.

transfer_data: Option<CreateCheckoutSessionPaymentIntentDataTransferData>

The parameters used to automatically create a Transfer when the payment succeeds. For more information, see the PaymentIntents use case for connected accounts.

transfer_group: Option<String>

A string that identifies the resulting payment as part of a group.

See the PaymentIntents use case for connected accounts for details.

Trait Implementations

impl Clone for CreateCheckoutSessionPaymentIntentData

fn clone(&self) -> CreateCheckoutSessionPaymentIntentData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateCheckoutSessionPaymentIntentData

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

Formats the value using the given formatter.

impl Default for CreateCheckoutSessionPaymentIntentData

fn default() -> CreateCheckoutSessionPaymentIntentData

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CreateCheckoutSessionPaymentIntentData

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CreateCheckoutSessionPaymentIntentData

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

where __S: Serializer,

Serialize this value into the given Serde serializer.