Struct stripe::PaymentLink

pub struct PaymentLink {

    pub id: PaymentLinkId,
    pub active: bool,
    pub after_completion: PaymentLinksResourceAfterCompletion,
    pub allow_promotion_codes: bool,
    pub application_fee_amount: Option<i64>,
    pub application_fee_percent: Option<f64>,
    pub automatic_tax: PaymentLinksResourceAutomaticTax,
    pub billing_address_collection: PaymentLinkBillingAddressCollection,
    pub line_items: List<CheckoutSessionItem>,
    pub livemode: bool,
    pub metadata: Metadata,
    pub on_behalf_of: Option<Expandable<Account>>,
    pub payment_method_types: Option<Vec<PaymentLinkPaymentMethodTypes>>,
    pub phone_number_collection: PaymentLinksResourcePhoneNumberCollection,
    pub shipping_address_collection: Option<PaymentLinksResourceShippingAddressCollection>,
    pub subscription_data: Option<PaymentLinksResourceSubscriptionData>,
    pub transfer_data: Option<PaymentLinksResourceTransferData>,
    pub url: String,
}

The resource representing a Stripe “PaymentLink”.

For more details see https://stripe.com/docs/api/payment_links/object

Fields

id: PaymentLinkId

Unique identifier for the object.

active: bool

Whether the payment link’s url is active.

If false, customers visiting the URL will be shown a page saying that the link has been deactivated.

after_completion: PaymentLinksResourceAfterCompletion

allow_promotion_codes: bool

Whether user redeemable promotion codes are enabled.

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.

application_fee_percent: Option<f64>

This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner’s Stripe account.

automatic_tax: PaymentLinksResourceAutomaticTax

billing_address_collection: PaymentLinkBillingAddressCollection

Configuration for collecting the customer’s billing address.

line_items: List<CheckoutSessionItem>

The line items representing what is being sold.

livemode: bool

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

metadata: 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.

on_behalf_of: Option<Expandable<Account>>

The account on behalf of which to charge.

See the Connect documentation for details.

payment_method_types: Option<Vec<PaymentLinkPaymentMethodTypes>>

The list of payment method types that customers can use.

When null, Stripe will dynamically show relevant payment methods you’ve enabled in your payment method settings.

phone_number_collection: PaymentLinksResourcePhoneNumberCollection

shipping_address_collection: Option<PaymentLinksResourceShippingAddressCollection>

Configuration for collecting the customer’s shipping address.

subscription_data: Option<PaymentLinksResourceSubscriptionData>

When creating a subscription, the specified configuration data will be used.

There must be at least one line item with a recurring price to use subscription_data.

transfer_data: Option<PaymentLinksResourceTransferData>

The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.

url: String

The public URL that can be shared with customers.

Implementations

impl PaymentLink

pub fn list(
    client: &Client,
    params: ListPaymentLinks<'_>
) -> Response<List<PaymentLink>>

Returns a list of your payment links.

pub fn create(
    client: &Client,
    params: CreatePaymentLink<'_>
) -> Response<PaymentLink>

Creates a payment link.

Examples found in repository

examples/payment-link.rs (lines 46-53)

↕

async fn main() {
    let secret_key = std::env::var("STRIPE_SECRET_KEY").expect("Missing STRIPE_SECRET_KEY in env");
    let client = Client::new(secret_key);

    // create a new exmaple project
    let product = {
        let mut create_product = CreateProduct::new("T-Shirt");
        create_product.metadata =
            Some([("async-stripe".to_string(), "true".to_string())].iter().cloned().collect());
        Product::create(&client, create_product).await.unwrap()
    };

    // and add a price for it in USD
    let price = {
        let mut create_price = CreatePrice::new(Currency::USD);
        create_price.product = Some(IdOrCreate::Id(&product.id));
        create_price.metadata =
            Some([("async-stripe".to_string(), "true".to_string())].iter().cloned().collect());
        create_price.unit_amount = Some(1000);
        create_price.expand = &["product"];
        Price::create(&client, create_price).await.unwrap()
    };

    println!(
        "created a product {:?} at price {} {}",
        product.name.unwrap(),
        price.unit_amount.unwrap() / 100,
        price.currency.unwrap()
    );

    let payment_link = PaymentLink::create(
        &client,
        CreatePaymentLink::new(vec![CreatePaymentLinkLineItems {
            quantity: 3,
            price: price.id.to_string(),
            ..Default::default()
        }]),
    )
    .await
    .unwrap();

    println!("created a payment link {}", payment_link.url);
}

pub fn retrieve(
    client: &Client,
    id: &PaymentLinkId,
    expand: &[&str]
) -> Response<PaymentLink>

Retrieve a payment link.

pub fn update(
    client: &Client,
    id: &PaymentLinkId,
    params: UpdatePaymentLink<'_>
) -> Response<PaymentLink>

Updates a payment link.

Trait Implementations

impl Clone for PaymentLink

fn clone(&self) -> PaymentLink

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PaymentLink

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

Formats the value using the given formatter.

impl Default for PaymentLink

fn default() -> PaymentLink

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PaymentLink

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Object for PaymentLink

type Id = PaymentLinkId

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 PaymentLink

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

Serialize this value into the given Serde serializer.