Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Stripe Provider
  4. API Docs
  5. PaymentLink
Viewing docs for Stripe 0.3.0
published on Friday, Aug 14, 2026 by Pulumi
Schema (JSON)
stripe/terraform-provider-stripe

stripe.PaymentLink

Viewing docs for Stripe 0.3.0
published on Friday, Aug 14, 2026 by Pulumi
Schema (JSON)
stripe/terraform-provider-stripe

    A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times.

    When a customer opens a payment link it will open a new checkout session to render the payment page. You can use checkout session events to track payments through payment links.

    Related guide: Payment Links API

    Create PaymentLink Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PaymentLink(name: string, args: PaymentLinkArgs, opts?: CustomResourceOptions);
    @overload
def PaymentLink(resource_name: str,
                args: PaymentLinkArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def PaymentLink(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                line_items: Optional[Sequence[PaymentLinkLineItemArgs]] = None,
                metadata: Optional[Mapping[str, str]] = None,
                name_collection: Optional[PaymentLinkNameCollectionArgs] = None,
                application_fee_amount: Optional[float] = None,
                application_fee_percent: Optional[float] = None,
                automatic_tax: Optional[PaymentLinkAutomaticTaxArgs] = None,
                billing_address_collection: Optional[str] = None,
                consent_collection: Optional[PaymentLinkConsentCollectionArgs] = None,
                currency: Optional[str] = None,
                custom_fields: Optional[Sequence[PaymentLinkCustomFieldArgs]] = None,
                custom_text: Optional[PaymentLinkCustomTextArgs] = None,
                customer_creation: Optional[str] = None,
                inactive_message: Optional[str] = None,
                invoice_creation: Optional[PaymentLinkInvoiceCreationArgs] = None,
                after_completion: Optional[PaymentLinkAfterCompletionArgs] = None,
                allow_promotion_codes: Optional[bool] = None,
                managed_payments: Optional[PaymentLinkManagedPaymentsArgs] = None,
                optional_items: Optional[Sequence[PaymentLinkOptionalItemArgs]] = None,
                on_behalf_of: Optional[str] = None,
                active: Optional[bool] = None,
                payment_intent_data: Optional[PaymentLinkPaymentIntentDataArgs] = None,
                payment_method_collection: Optional[str] = None,
                payment_method_options: Optional[PaymentLinkPaymentMethodOptionsArgs] = None,
                payment_method_types: Optional[Sequence[str]] = None,
                phone_number_collection: Optional[PaymentLinkPhoneNumberCollectionArgs] = None,
                restrictions: Optional[PaymentLinkRestrictionsArgs] = None,
                shipping_address_collection: Optional[PaymentLinkShippingAddressCollectionArgs] = None,
                shipping_options: Optional[Sequence[PaymentLinkShippingOptionArgs]] = None,
                submit_type: Optional[str] = None,
                subscription_data: Optional[PaymentLinkSubscriptionDataArgs] = None,
                tax_id_collection: Optional[PaymentLinkTaxIdCollectionArgs] = None,
                transfer_data: Optional[PaymentLinkTransferDataArgs] = None)
    func NewPaymentLink(ctx *Context, name string, args PaymentLinkArgs, opts ...ResourceOption) (*PaymentLink, error)
    public PaymentLink(string name, PaymentLinkArgs args, CustomResourceOptions? opts = null)
    public PaymentLink(String name, PaymentLinkArgs args)
public PaymentLink(String name, PaymentLinkArgs args, CustomResourceOptions options)

    type: stripe:PaymentLink
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "stripe_payment_link" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args PaymentLinkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PaymentLinkArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PaymentLinkArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PaymentLinkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PaymentLinkArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var paymentLinkResource = new Stripe.PaymentLink("paymentLinkResource", new()
{
    LineItems = new[]
    {
        new Stripe.Inputs.PaymentLinkLineItemArgs
        {
            Quantity = 0.0,
            AdjustableQuantity = new Stripe.Inputs.PaymentLinkLineItemAdjustableQuantityArgs
            {
                Enabled = false,
                Maximum = 0.0,
                Minimum = 0.0,
            },
            Id = "string",
            Price = "string",
            PriceData = new Stripe.Inputs.PaymentLinkLineItemPriceDataArgs
            {
                Currency = "string",
                Product = "string",
                ProductData = new Stripe.Inputs.PaymentLinkLineItemPriceDataProductDataArgs
                {
                    Name = "string",
                    Description = "string",
                    Images = new[]
                    {
                        "string",
                    },
                    Metadata = 
                    {
                        { "string", "string" },
                    },
                    TaxCode = "string",
                    UnitLabel = "string",
                },
                Recurring = new Stripe.Inputs.PaymentLinkLineItemPriceDataRecurringArgs
                {
                    Interval = "string",
                    IntervalCount = 0.0,
                },
                TaxBehavior = "string",
                UnitAmount = 0.0,
                UnitAmountDecimal = 0.0,
            },
        },
    },
    Metadata = 
    {
        { "string", "string" },
    },
    NameCollection = new Stripe.Inputs.PaymentLinkNameCollectionArgs
    {
        Business = new Stripe.Inputs.PaymentLinkNameCollectionBusinessArgs
        {
            Enabled = false,
            Optional = false,
        },
        Individual = new Stripe.Inputs.PaymentLinkNameCollectionIndividualArgs
        {
            Enabled = false,
            Optional = false,
        },
    },
    ApplicationFeeAmount = 0.0,
    ApplicationFeePercent = 0.0,
    AutomaticTax = new Stripe.Inputs.PaymentLinkAutomaticTaxArgs
    {
        Enabled = false,
        Liability = new Stripe.Inputs.PaymentLinkAutomaticTaxLiabilityArgs
        {
            Type = "string",
            Account = "string",
        },
    },
    BillingAddressCollection = "string",
    ConsentCollection = new Stripe.Inputs.PaymentLinkConsentCollectionArgs
    {
        PaymentMethodReuseAgreement = new Stripe.Inputs.PaymentLinkConsentCollectionPaymentMethodReuseAgreementArgs
        {
            Position = "string",
        },
        Promotions = "string",
        TermsOfService = "string",
    },
    Currency = "string",
    CustomFields = new[]
    {
        new Stripe.Inputs.PaymentLinkCustomFieldArgs
        {
            Key = "string",
            Label = new Stripe.Inputs.PaymentLinkCustomFieldLabelArgs
            {
                Custom = "string",
                Type = "string",
            },
            Type = "string",
            Dropdown = new Stripe.Inputs.PaymentLinkCustomFieldDropdownArgs
            {
                Options = new[]
                {
                    new Stripe.Inputs.PaymentLinkCustomFieldDropdownOptionArgs
                    {
                        Label = "string",
                        Value = "string",
                    },
                },
                DefaultValue = "string",
            },
            Numeric = new Stripe.Inputs.PaymentLinkCustomFieldNumericArgs
            {
                DefaultValue = "string",
                MaximumLength = 0.0,
                MinimumLength = 0.0,
            },
            Optional = false,
            Text = new Stripe.Inputs.PaymentLinkCustomFieldTextArgs
            {
                DefaultValue = "string",
                MaximumLength = 0.0,
                MinimumLength = 0.0,
            },
        },
    },
    CustomText = new Stripe.Inputs.PaymentLinkCustomTextArgs
    {
        AfterSubmit = new Stripe.Inputs.PaymentLinkCustomTextAfterSubmitArgs
        {
            Message = "string",
        },
        ShippingAddress = new Stripe.Inputs.PaymentLinkCustomTextShippingAddressArgs
        {
            Message = "string",
        },
        Submit = new Stripe.Inputs.PaymentLinkCustomTextSubmitArgs
        {
            Message = "string",
        },
        TermsOfServiceAcceptance = new Stripe.Inputs.PaymentLinkCustomTextTermsOfServiceAcceptanceArgs
        {
            Message = "string",
        },
    },
    CustomerCreation = "string",
    InactiveMessage = "string",
    InvoiceCreation = new Stripe.Inputs.PaymentLinkInvoiceCreationArgs
    {
        Enabled = false,
        InvoiceData = new Stripe.Inputs.PaymentLinkInvoiceCreationInvoiceDataArgs
        {
            AccountTaxIds = new[]
            {
                "string",
            },
            CustomFields = new[]
            {
                new Stripe.Inputs.PaymentLinkInvoiceCreationInvoiceDataCustomFieldArgs
                {
                    Name = "string",
                    Value = "string",
                },
            },
            Description = "string",
            Footer = "string",
            Issuer = new Stripe.Inputs.PaymentLinkInvoiceCreationInvoiceDataIssuerArgs
            {
                Type = "string",
                Account = "string",
            },
            Metadata = 
            {
                { "string", "string" },
            },
            RenderingOptions = new Stripe.Inputs.PaymentLinkInvoiceCreationInvoiceDataRenderingOptionsArgs
            {
                AmountTaxDisplay = "string",
                Template = "string",
            },
        },
    },
    AfterCompletion = new Stripe.Inputs.PaymentLinkAfterCompletionArgs
    {
        Type = "string",
        HostedConfirmation = new Stripe.Inputs.PaymentLinkAfterCompletionHostedConfirmationArgs
        {
            CustomMessage = "string",
        },
        Redirect = new Stripe.Inputs.PaymentLinkAfterCompletionRedirectArgs
        {
            Url = "string",
        },
    },
    AllowPromotionCodes = false,
    ManagedPayments = new Stripe.Inputs.PaymentLinkManagedPaymentsArgs
    {
        Enabled = false,
    },
    OptionalItems = new[]
    {
        new Stripe.Inputs.PaymentLinkOptionalItemArgs
        {
            Price = "string",
            Quantity = 0.0,
            AdjustableQuantity = new Stripe.Inputs.PaymentLinkOptionalItemAdjustableQuantityArgs
            {
                Enabled = false,
                Maximum = 0.0,
                Minimum = 0.0,
            },
        },
    },
    OnBehalfOf = "string",
    Active = false,
    PaymentIntentData = new Stripe.Inputs.PaymentLinkPaymentIntentDataArgs
    {
        CaptureMethod = "string",
        Description = "string",
        Metadata = 
        {
            { "string", "string" },
        },
        SetupFutureUsage = "string",
        StatementDescriptor = "string",
        StatementDescriptorSuffix = "string",
        TransferGroup = "string",
    },
    PaymentMethodCollection = "string",
    PaymentMethodOptions = new Stripe.Inputs.PaymentLinkPaymentMethodOptionsArgs
    {
        Card = new Stripe.Inputs.PaymentLinkPaymentMethodOptionsCardArgs
        {
            Restrictions = new Stripe.Inputs.PaymentLinkPaymentMethodOptionsCardRestrictionsArgs
            {
                BrandsBlockeds = new[]
                {
                    "string",
                },
            },
        },
    },
    PaymentMethodTypes = new[]
    {
        "string",
    },
    PhoneNumberCollection = new Stripe.Inputs.PaymentLinkPhoneNumberCollectionArgs
    {
        Enabled = false,
    },
    Restrictions = new Stripe.Inputs.PaymentLinkRestrictionsArgs
    {
        CompletedSessions = new Stripe.Inputs.PaymentLinkRestrictionsCompletedSessionsArgs
        {
            Limit = 0.0,
            Count = 0.0,
        },
    },
    ShippingAddressCollection = new Stripe.Inputs.PaymentLinkShippingAddressCollectionArgs
    {
        AllowedCountries = new[]
        {
            "string",
        },
    },
    ShippingOptions = new[]
    {
        new Stripe.Inputs.PaymentLinkShippingOptionArgs
        {
            ShippingAmount = 0.0,
            ShippingRate = "string",
        },
    },
    SubmitType = "string",
    SubscriptionData = new Stripe.Inputs.PaymentLinkSubscriptionDataArgs
    {
        Description = "string",
        InvoiceSettings = new Stripe.Inputs.PaymentLinkSubscriptionDataInvoiceSettingsArgs
        {
            Issuer = new Stripe.Inputs.PaymentLinkSubscriptionDataInvoiceSettingsIssuerArgs
            {
                Type = "string",
                Account = "string",
            },
        },
        Metadata = 
        {
            { "string", "string" },
        },
        TrialPeriodDays = 0.0,
        TrialSettings = new Stripe.Inputs.PaymentLinkSubscriptionDataTrialSettingsArgs
        {
            EndBehavior = new Stripe.Inputs.PaymentLinkSubscriptionDataTrialSettingsEndBehaviorArgs
            {
                MissingPaymentMethod = "string",
            },
        },
    },
    TaxIdCollection = new Stripe.Inputs.PaymentLinkTaxIdCollectionArgs
    {
        Enabled = false,
        Required = "string",
    },
    TransferData = new Stripe.Inputs.PaymentLinkTransferDataArgs
    {
        Destination = "string",
        Amount = 0.0,
    },
});

    example, err := stripe.NewPaymentLink(ctx, "paymentLinkResource", &stripe.PaymentLinkArgs{
	LineItems: stripe.PaymentLinkLineItemArray{
		&stripe.PaymentLinkLineItemArgs{
			Quantity: pulumi.Float64(0),
			AdjustableQuantity: &stripe.PaymentLinkLineItemAdjustableQuantityArgs{
				Enabled: pulumi.Bool(false),
				Maximum: pulumi.Float64(0),
				Minimum: pulumi.Float64(0),
			},
			Id:    pulumi.String("string"),
			Price: pulumi.String("string"),
			PriceData: &stripe.PaymentLinkLineItemPriceDataArgs{
				Currency: pulumi.String("string"),
				Product:  pulumi.String("string"),
				ProductData: &stripe.PaymentLinkLineItemPriceDataProductDataArgs{
					Name:        pulumi.String("string"),
					Description: pulumi.String("string"),
					Images: pulumi.StringArray{
						pulumi.String("string"),
					},
					Metadata: pulumi.StringMap{
						"string": pulumi.String("string"),
					},
					TaxCode:   pulumi.String("string"),
					UnitLabel: pulumi.String("string"),
				},
				Recurring: &stripe.PaymentLinkLineItemPriceDataRecurringArgs{
					Interval:      pulumi.String("string"),
					IntervalCount: pulumi.Float64(0),
				},
				TaxBehavior:       pulumi.String("string"),
				UnitAmount:        pulumi.Float64(0),
				UnitAmountDecimal: pulumi.Float64(0),
			},
		},
	},
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	NameCollection: &stripe.PaymentLinkNameCollectionArgs{
		Business: &stripe.PaymentLinkNameCollectionBusinessArgs{
			Enabled:  pulumi.Bool(false),
			Optional: pulumi.Bool(false),
		},
		Individual: &stripe.PaymentLinkNameCollectionIndividualArgs{
			Enabled:  pulumi.Bool(false),
			Optional: pulumi.Bool(false),
		},
	},
	ApplicationFeeAmount:  pulumi.Float64(0),
	ApplicationFeePercent: pulumi.Float64(0),
	AutomaticTax: &stripe.PaymentLinkAutomaticTaxArgs{
		Enabled: pulumi.Bool(false),
		Liability: &stripe.PaymentLinkAutomaticTaxLiabilityArgs{
			Type:    pulumi.String("string"),
			Account: pulumi.String("string"),
		},
	},
	BillingAddressCollection: pulumi.String("string"),
	ConsentCollection: &stripe.PaymentLinkConsentCollectionArgs{
		PaymentMethodReuseAgreement: &stripe.PaymentLinkConsentCollectionPaymentMethodReuseAgreementArgs{
			Position: pulumi.String("string"),
		},
		Promotions:     pulumi.String("string"),
		TermsOfService: pulumi.String("string"),
	},
	Currency: pulumi.String("string"),
	CustomFields: stripe.PaymentLinkCustomFieldArray{
		&stripe.PaymentLinkCustomFieldArgs{
			Key: pulumi.String("string"),
			Label: &stripe.PaymentLinkCustomFieldLabelArgs{
				Custom: pulumi.String("string"),
				Type:   pulumi.String("string"),
			},
			Type: pulumi.String("string"),
			Dropdown: &stripe.PaymentLinkCustomFieldDropdownArgs{
				Options: stripe.PaymentLinkCustomFieldDropdownOptionArray{
					&stripe.PaymentLinkCustomFieldDropdownOptionArgs{
						Label: pulumi.String("string"),
						Value: pulumi.String("string"),
					},
				},
				DefaultValue: pulumi.String("string"),
			},
			Numeric: &stripe.PaymentLinkCustomFieldNumericArgs{
				DefaultValue:  pulumi.String("string"),
				MaximumLength: pulumi.Float64(0),
				MinimumLength: pulumi.Float64(0),
			},
			Optional: pulumi.Bool(false),
			Text: &stripe.PaymentLinkCustomFieldTextArgs{
				DefaultValue:  pulumi.String("string"),
				MaximumLength: pulumi.Float64(0),
				MinimumLength: pulumi.Float64(0),
			},
		},
	},
	CustomText: &stripe.PaymentLinkCustomTextArgs{
		AfterSubmit: &stripe.PaymentLinkCustomTextAfterSubmitArgs{
			Message: pulumi.String("string"),
		},
		ShippingAddress: &stripe.PaymentLinkCustomTextShippingAddressArgs{
			Message: pulumi.String("string"),
		},
		Submit: &stripe.PaymentLinkCustomTextSubmitArgs{
			Message: pulumi.String("string"),
		},
		TermsOfServiceAcceptance: &stripe.PaymentLinkCustomTextTermsOfServiceAcceptanceArgs{
			Message: pulumi.String("string"),
		},
	},
	CustomerCreation: pulumi.String("string"),
	InactiveMessage:  pulumi.String("string"),
	InvoiceCreation: &stripe.PaymentLinkInvoiceCreationArgs{
		Enabled: pulumi.Bool(false),
		InvoiceData: &stripe.PaymentLinkInvoiceCreationInvoiceDataArgs{
			AccountTaxIds: pulumi.StringArray{
				pulumi.String("string"),
			},
			CustomFields: stripe.PaymentLinkInvoiceCreationInvoiceDataCustomFieldArray{
				&stripe.PaymentLinkInvoiceCreationInvoiceDataCustomFieldArgs{
					Name:  pulumi.String("string"),
					Value: pulumi.String("string"),
				},
			},
			Description: pulumi.String("string"),
			Footer:      pulumi.String("string"),
			Issuer: &stripe.PaymentLinkInvoiceCreationInvoiceDataIssuerArgs{
				Type:    pulumi.String("string"),
				Account: pulumi.String("string"),
			},
			Metadata: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			RenderingOptions: &stripe.PaymentLinkInvoiceCreationInvoiceDataRenderingOptionsArgs{
				AmountTaxDisplay: pulumi.String("string"),
				Template:         pulumi.String("string"),
			},
		},
	},
	AfterCompletion: &stripe.PaymentLinkAfterCompletionArgs{
		Type: pulumi.String("string"),
		HostedConfirmation: &stripe.PaymentLinkAfterCompletionHostedConfirmationArgs{
			CustomMessage: pulumi.String("string"),
		},
		Redirect: &stripe.PaymentLinkAfterCompletionRedirectArgs{
			Url: pulumi.String("string"),
		},
	},
	AllowPromotionCodes: pulumi.Bool(false),
	ManagedPayments: &stripe.PaymentLinkManagedPaymentsArgs{
		Enabled: pulumi.Bool(false),
	},
	OptionalItems: stripe.PaymentLinkOptionalItemArray{
		&stripe.PaymentLinkOptionalItemArgs{
			Price:    pulumi.String("string"),
			Quantity: pulumi.Float64(0),
			AdjustableQuantity: &stripe.PaymentLinkOptionalItemAdjustableQuantityArgs{
				Enabled: pulumi.Bool(false),
				Maximum: pulumi.Float64(0),
				Minimum: pulumi.Float64(0),
			},
		},
	},
	OnBehalfOf: pulumi.String("string"),
	Active:     pulumi.Bool(false),
	PaymentIntentData: &stripe.PaymentLinkPaymentIntentDataArgs{
		CaptureMethod: pulumi.String("string"),
		Description:   pulumi.String("string"),
		Metadata: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		SetupFutureUsage:          pulumi.String("string"),
		StatementDescriptor:       pulumi.String("string"),
		StatementDescriptorSuffix: pulumi.String("string"),
		TransferGroup:             pulumi.String("string"),
	},
	PaymentMethodCollection: pulumi.String("string"),
	PaymentMethodOptions: &stripe.PaymentLinkPaymentMethodOptionsArgs{
		Card: &stripe.PaymentLinkPaymentMethodOptionsCardArgs{
			Restrictions: &stripe.PaymentLinkPaymentMethodOptionsCardRestrictionsArgs{
				BrandsBlockeds: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
		},
	},
	PaymentMethodTypes: pulumi.StringArray{
		pulumi.String("string"),
	},
	PhoneNumberCollection: &stripe.PaymentLinkPhoneNumberCollectionArgs{
		Enabled: pulumi.Bool(false),
	},
	Restrictions: &stripe.PaymentLinkRestrictionsArgs{
		CompletedSessions: &stripe.PaymentLinkRestrictionsCompletedSessionsArgs{
			Limit: pulumi.Float64(0),
			Count: pulumi.Float64(0),
		},
	},
	ShippingAddressCollection: &stripe.PaymentLinkShippingAddressCollectionArgs{
		AllowedCountries: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	ShippingOptions: stripe.PaymentLinkShippingOptionArray{
		&stripe.PaymentLinkShippingOptionArgs{
			ShippingAmount: pulumi.Float64(0),
			ShippingRate:   pulumi.String("string"),
		},
	},
	SubmitType: pulumi.String("string"),
	SubscriptionData: &stripe.PaymentLinkSubscriptionDataArgs{
		Description: pulumi.String("string"),
		InvoiceSettings: &stripe.PaymentLinkSubscriptionDataInvoiceSettingsArgs{
			Issuer: &stripe.PaymentLinkSubscriptionDataInvoiceSettingsIssuerArgs{
				Type:    pulumi.String("string"),
				Account: pulumi.String("string"),
			},
		},
		Metadata: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		TrialPeriodDays: pulumi.Float64(0),
		TrialSettings: &stripe.PaymentLinkSubscriptionDataTrialSettingsArgs{
			EndBehavior: &stripe.PaymentLinkSubscriptionDataTrialSettingsEndBehaviorArgs{
				MissingPaymentMethod: pulumi.String("string"),
			},
		},
	},
	TaxIdCollection: &stripe.PaymentLinkTaxIdCollectionArgs{
		Enabled:  pulumi.Bool(false),
		Required: pulumi.String("string"),
	},
	TransferData: &stripe.PaymentLinkTransferDataArgs{
		Destination: pulumi.String("string"),
		Amount:      pulumi.Float64(0),
	},
})

    resource "stripe_payment_link" "paymentLinkResource" {
  lifecycle {
    create_before_destroy = true
  }
  line_items {
    quantity = 0
    adjustable_quantity = {
      enabled = false
      maximum = 0
      minimum = 0
    }
    id    = "string"
    price = "string"
    price_data = {
      currency = "string"
      product  = "string"
      product_data = {
        name        = "string"
        description = "string"
        images      = ["string"]
        metadata = {
          "string" = "string"
        }
        tax_code   = "string"
        unit_label = "string"
      }
      recurring = {
        interval       = "string"
        interval_count = 0
      }
      tax_behavior        = "string"
      unit_amount         = 0
      unit_amount_decimal = 0
    }
  }
  metadata = {
    "string" = "string"
  }
  name_collection = {
    business = {
      enabled  = false
      optional = false
    }
    individual = {
      enabled  = false
      optional = false
    }
  }
  application_fee_amount  = 0
  application_fee_percent = 0
  automatic_tax = {
    enabled = false
    liability = {
      type    = "string"
      account = "string"
    }
  }
  billing_address_collection = "string"
  consent_collection = {
    payment_method_reuse_agreement = {
      position = "string"
    }
    promotions       = "string"
    terms_of_service = "string"
  }
  currency = "string"
  custom_fields {
    key = "string"
    label = {
      custom = "string"
      type   = "string"
    }
    type = "string"
    dropdown = {
      options = [{
        label = "string"
        value = "string"
      }]
      default_value = "string"
    }
    numeric = {
      default_value  = "string"
      maximum_length = 0
      minimum_length = 0
    }
    optional = false
    text = {
      default_value  = "string"
      maximum_length = 0
      minimum_length = 0
    }
  }
  custom_text = {
    after_submit = {
      message = "string"
    }
    shipping_address = {
      message = "string"
    }
    submit = {
      message = "string"
    }
    terms_of_service_acceptance = {
      message = "string"
    }
  }
  customer_creation = "string"
  inactive_message  = "string"
  invoice_creation = {
    enabled = false
    invoice_data = {
      account_tax_ids = ["string"]
      custom_fields = [{
        name  = "string"
        value = "string"
      }]
      description = "string"
      footer      = "string"
      issuer = {
        type    = "string"
        account = "string"
      }
      metadata = {
        "string" = "string"
      }
      rendering_options = {
        amount_tax_display = "string"
        template           = "string"
      }
    }
  }
  after_completion = {
    type = "string"
    hosted_confirmation = {
      custom_message = "string"
    }
    redirect = {
      url = "string"
    }
  }
  allow_promotion_codes = false
  managed_payments = {
    enabled = false
  }
  optional_items {
    price    = "string"
    quantity = 0
    adjustable_quantity = {
      enabled = false
      maximum = 0
      minimum = 0
    }
  }
  on_behalf_of = "string"
  active       = false
  payment_intent_data = {
    capture_method = "string"
    description    = "string"
    metadata = {
      "string" = "string"
    }
    setup_future_usage          = "string"
    statement_descriptor        = "string"
    statement_descriptor_suffix = "string"
    transfer_group              = "string"
  }
  payment_method_collection = "string"
  payment_method_options = {
    card = {
      restrictions = {
        brands_blockeds = ["string"]
      }
    }
  }
  payment_method_types = ["string"]
  phone_number_collection = {
    enabled = false
  }
  restrictions = {
    completed_sessions = {
      limit = 0
      count = 0
    }
  }
  shipping_address_collection = {
    allowed_countries = ["string"]
  }
  shipping_options {
    shipping_amount = 0
    shipping_rate   = "string"
  }
  submit_type = "string"
  subscription_data = {
    description = "string"
    invoice_settings = {
      issuer = {
        type    = "string"
        account = "string"
      }
    }
    metadata = {
      "string" = "string"
    }
    trial_period_days = 0
    trial_settings = {
      end_behavior = {
        missing_payment_method = "string"
      }
    }
  }
  tax_id_collection = {
    enabled  = false
    required = "string"
  }
  transfer_data = {
    destination = "string"
    amount      = 0
  }
}

    var paymentLinkResource = new PaymentLink("paymentLinkResource", PaymentLinkArgs.builder()
    .lineItems(PaymentLinkLineItemArgs.builder()
        .quantity(0.0)
        .adjustableQuantity(PaymentLinkLineItemAdjustableQuantityArgs.builder()
            .enabled(false)
            .maximum(0.0)
            .minimum(0.0)
            .build())
        .id("string")
        .price("string")
        .priceData(PaymentLinkLineItemPriceDataArgs.builder()
            .currency("string")
            .product("string")
            .productData(PaymentLinkLineItemPriceDataProductDataArgs.builder()
                .name("string")
                .description("string")
                .images("string")
                .metadata(Map.of("string", "string"))
                .taxCode("string")
                .unitLabel("string")
                .build())
            .recurring(PaymentLinkLineItemPriceDataRecurringArgs.builder()
                .interval("string")
                .intervalCount(0.0)
                .build())
            .taxBehavior("string")
            .unitAmount(0.0)
            .unitAmountDecimal(0.0)
            .build())
        .build())
    .metadata(Map.of("string", "string"))
    .nameCollection(PaymentLinkNameCollectionArgs.builder()
        .business(PaymentLinkNameCollectionBusinessArgs.builder()
            .enabled(false)
            .optional(false)
            .build())
        .individual(PaymentLinkNameCollectionIndividualArgs.builder()
            .enabled(false)
            .optional(false)
            .build())
        .build())
    .applicationFeeAmount(0.0)
    .applicationFeePercent(0.0)
    .automaticTax(PaymentLinkAutomaticTaxArgs.builder()
        .enabled(false)
        .liability(PaymentLinkAutomaticTaxLiabilityArgs.builder()
            .type("string")
            .account("string")
            .build())
        .build())
    .billingAddressCollection("string")
    .consentCollection(PaymentLinkConsentCollectionArgs.builder()
        .paymentMethodReuseAgreement(PaymentLinkConsentCollectionPaymentMethodReuseAgreementArgs.builder()
            .position("string")
            .build())
        .promotions("string")
        .termsOfService("string")
        .build())
    .currency("string")
    .customFields(PaymentLinkCustomFieldArgs.builder()
        .key("string")
        .label(PaymentLinkCustomFieldLabelArgs.builder()
            .custom("string")
            .type("string")
            .build())
        .type("string")
        .dropdown(PaymentLinkCustomFieldDropdownArgs.builder()
            .options(PaymentLinkCustomFieldDropdownOptionArgs.builder()
                .label("string")
                .value("string")
                .build())
            .defaultValue("string")
            .build())
        .numeric(PaymentLinkCustomFieldNumericArgs.builder()
            .defaultValue("string")
            .maximumLength(0.0)
            .minimumLength(0.0)
            .build())
        .optional(false)
        .text(PaymentLinkCustomFieldTextArgs.builder()
            .defaultValue("string")
            .maximumLength(0.0)
            .minimumLength(0.0)
            .build())
        .build())
    .customText(PaymentLinkCustomTextArgs.builder()
        .afterSubmit(PaymentLinkCustomTextAfterSubmitArgs.builder()
            .message("string")
            .build())
        .shippingAddress(PaymentLinkCustomTextShippingAddressArgs.builder()
            .message("string")
            .build())
        .submit(PaymentLinkCustomTextSubmitArgs.builder()
            .message("string")
            .build())
        .termsOfServiceAcceptance(PaymentLinkCustomTextTermsOfServiceAcceptanceArgs.builder()
            .message("string")
            .build())
        .build())
    .customerCreation("string")
    .inactiveMessage("string")
    .invoiceCreation(PaymentLinkInvoiceCreationArgs.builder()
        .enabled(false)
        .invoiceData(PaymentLinkInvoiceCreationInvoiceDataArgs.builder()
            .accountTaxIds("string")
            .customFields(PaymentLinkInvoiceCreationInvoiceDataCustomFieldArgs.builder()
                .name("string")
                .value("string")
                .build())
            .description("string")
            .footer("string")
            .issuer(PaymentLinkInvoiceCreationInvoiceDataIssuerArgs.builder()
                .type("string")
                .account("string")
                .build())
            .metadata(Map.of("string", "string"))
            .renderingOptions(PaymentLinkInvoiceCreationInvoiceDataRenderingOptionsArgs.builder()
                .amountTaxDisplay("string")
                .template("string")
                .build())
            .build())
        .build())
    .afterCompletion(PaymentLinkAfterCompletionArgs.builder()
        .type("string")
        .hostedConfirmation(PaymentLinkAfterCompletionHostedConfirmationArgs.builder()
            .customMessage("string")
            .build())
        .redirect(PaymentLinkAfterCompletionRedirectArgs.builder()
            .url("string")
            .build())
        .build())
    .allowPromotionCodes(false)
    .managedPayments(PaymentLinkManagedPaymentsArgs.builder()
        .enabled(false)
        .build())
    .optionalItems(PaymentLinkOptionalItemArgs.builder()
        .price("string")
        .quantity(0.0)
        .adjustableQuantity(PaymentLinkOptionalItemAdjustableQuantityArgs.builder()
            .enabled(false)
            .maximum(0.0)
            .minimum(0.0)
            .build())
        .build())
    .onBehalfOf("string")
    .active(false)
    .paymentIntentData(PaymentLinkPaymentIntentDataArgs.builder()
        .captureMethod("string")
        .description("string")
        .metadata(Map.of("string", "string"))
        .setupFutureUsage("string")
        .statementDescriptor("string")
        .statementDescriptorSuffix("string")
        .transferGroup("string")
        .build())
    .paymentMethodCollection("string")
    .paymentMethodOptions(PaymentLinkPaymentMethodOptionsArgs.builder()
        .card(PaymentLinkPaymentMethodOptionsCardArgs.builder()
            .restrictions(PaymentLinkPaymentMethodOptionsCardRestrictionsArgs.builder()
                .brandsBlockeds("string")
                .build())
            .build())
        .build())
    .paymentMethodTypes("string")
    .phoneNumberCollection(PaymentLinkPhoneNumberCollectionArgs.builder()
        .enabled(false)
        .build())
    .restrictions(PaymentLinkRestrictionsArgs.builder()
        .completedSessions(PaymentLinkRestrictionsCompletedSessionsArgs.builder()
            .limit(0.0)
            .count(0.0)
            .build())
        .build())
    .shippingAddressCollection(PaymentLinkShippingAddressCollectionArgs.builder()
        .allowedCountries("string")
        .build())
    .shippingOptions(PaymentLinkShippingOptionArgs.builder()
        .shippingAmount(0.0)
        .shippingRate("string")
        .build())
    .submitType("string")
    .subscriptionData(PaymentLinkSubscriptionDataArgs.builder()
        .description("string")
        .invoiceSettings(PaymentLinkSubscriptionDataInvoiceSettingsArgs.builder()
            .issuer(PaymentLinkSubscriptionDataInvoiceSettingsIssuerArgs.builder()
                .type("string")
                .account("string")
                .build())
            .build())
        .metadata(Map.of("string", "string"))
        .trialPeriodDays(0.0)
        .trialSettings(PaymentLinkSubscriptionDataTrialSettingsArgs.builder()
            .endBehavior(PaymentLinkSubscriptionDataTrialSettingsEndBehaviorArgs.builder()
                .missingPaymentMethod("string")
                .build())
            .build())
        .build())
    .taxIdCollection(PaymentLinkTaxIdCollectionArgs.builder()
        .enabled(false)
        .required("string")
        .build())
    .transferData(PaymentLinkTransferDataArgs.builder()
        .destination("string")
        .amount(0.0)
        .build())
    .build());

    payment_link_resource = stripe.PaymentLink("paymentLinkResource",
    line_items=[{
        "quantity": float(0),
        "adjustable_quantity": {
            "enabled": False,
            "maximum": float(0),
            "minimum": float(0),
        },
        "id": "string",
        "price": "string",
        "price_data": {
            "currency": "string",
            "product": "string",
            "product_data": {
                "name": "string",
                "description": "string",
                "images": ["string"],
                "metadata": {
                    "string": "string",
                },
                "tax_code": "string",
                "unit_label": "string",
            },
            "recurring": {
                "interval": "string",
                "interval_count": float(0),
            },
            "tax_behavior": "string",
            "unit_amount": float(0),
            "unit_amount_decimal": float(0),
        },
    }],
    metadata={
        "string": "string",
    },
    name_collection={
        "business": {
            "enabled": False,
            "optional": False,
        },
        "individual": {
            "enabled": False,
            "optional": False,
        },
    },
    application_fee_amount=float(0),
    application_fee_percent=float(0),
    automatic_tax={
        "enabled": False,
        "liability": {
            "type": "string",
            "account": "string",
        },
    },
    billing_address_collection="string",
    consent_collection={
        "payment_method_reuse_agreement": {
            "position": "string",
        },
        "promotions": "string",
        "terms_of_service": "string",
    },
    currency="string",
    custom_fields=[{
        "key": "string",
        "label": {
            "custom": "string",
            "type": "string",
        },
        "type": "string",
        "dropdown": {
            "options": [{
                "label": "string",
                "value": "string",
            }],
            "default_value": "string",
        },
        "numeric": {
            "default_value": "string",
            "maximum_length": float(0),
            "minimum_length": float(0),
        },
        "optional": False,
        "text": {
            "default_value": "string",
            "maximum_length": float(0),
            "minimum_length": float(0),
        },
    }],
    custom_text={
        "after_submit": {
            "message": "string",
        },
        "shipping_address": {
            "message": "string",
        },
        "submit": {
            "message": "string",
        },
        "terms_of_service_acceptance": {
            "message": "string",
        },
    },
    customer_creation="string",
    inactive_message="string",
    invoice_creation={
        "enabled": False,
        "invoice_data": {
            "account_tax_ids": ["string"],
            "custom_fields": [{
                "name": "string",
                "value": "string",
            }],
            "description": "string",
            "footer": "string",
            "issuer": {
                "type": "string",
                "account": "string",
            },
            "metadata": {
                "string": "string",
            },
            "rendering_options": {
                "amount_tax_display": "string",
                "template": "string",
            },
        },
    },
    after_completion={
        "type": "string",
        "hosted_confirmation": {
            "custom_message": "string",
        },
        "redirect": {
            "url": "string",
        },
    },
    allow_promotion_codes=False,
    managed_payments={
        "enabled": False,
    },
    optional_items=[{
        "price": "string",
        "quantity": float(0),
        "adjustable_quantity": {
            "enabled": False,
            "maximum": float(0),
            "minimum": float(0),
        },
    }],
    on_behalf_of="string",
    active=False,
    payment_intent_data={
        "capture_method": "string",
        "description": "string",
        "metadata": {
            "string": "string",
        },
        "setup_future_usage": "string",
        "statement_descriptor": "string",
        "statement_descriptor_suffix": "string",
        "transfer_group": "string",
    },
    payment_method_collection="string",
    payment_method_options={
        "card": {
            "restrictions": {
                "brands_blockeds": ["string"],
            },
        },
    },
    payment_method_types=["string"],
    phone_number_collection={
        "enabled": False,
    },
    restrictions={
        "completed_sessions": {
            "limit": float(0),
            "count": float(0),
        },
    },
    shipping_address_collection={
        "allowed_countries": ["string"],
    },
    shipping_options=[{
        "shipping_amount": float(0),
        "shipping_rate": "string",
    }],
    submit_type="string",
    subscription_data={
        "description": "string",
        "invoice_settings": {
            "issuer": {
                "type": "string",
                "account": "string",
            },
        },
        "metadata": {
            "string": "string",
        },
        "trial_period_days": float(0),
        "trial_settings": {
            "end_behavior": {
                "missing_payment_method": "string",
            },
        },
    },
    tax_id_collection={
        "enabled": False,
        "required": "string",
    },
    transfer_data={
        "destination": "string",
        "amount": float(0),
    })

    const paymentLinkResource = new stripe.PaymentLink("paymentLinkResource", {
    lineItems: [{
        quantity: 0,
        adjustableQuantity: {
            enabled: false,
            maximum: 0,
            minimum: 0,
        },
        id: "string",
        price: "string",
        priceData: {
            currency: "string",
            product: "string",
            productData: {
                name: "string",
                description: "string",
                images: ["string"],
                metadata: {
                    string: "string",
                },
                taxCode: "string",
                unitLabel: "string",
            },
            recurring: {
                interval: "string",
                intervalCount: 0,
            },
            taxBehavior: "string",
            unitAmount: 0,
            unitAmountDecimal: 0,
        },
    }],
    metadata: {
        string: "string",
    },
    nameCollection: {
        business: {
            enabled: false,
            optional: false,
        },
        individual: {
            enabled: false,
            optional: false,
        },
    },
    applicationFeeAmount: 0,
    applicationFeePercent: 0,
    automaticTax: {
        enabled: false,
        liability: {
            type: "string",
            account: "string",
        },
    },
    billingAddressCollection: "string",
    consentCollection: {
        paymentMethodReuseAgreement: {
            position: "string",
        },
        promotions: "string",
        termsOfService: "string",
    },
    currency: "string",
    customFields: [{
        key: "string",
        label: {
            custom: "string",
            type: "string",
        },
        type: "string",
        dropdown: {
            options: [{
                label: "string",
                value: "string",
            }],
            defaultValue: "string",
        },
        numeric: {
            defaultValue: "string",
            maximumLength: 0,
            minimumLength: 0,
        },
        optional: false,
        text: {
            defaultValue: "string",
            maximumLength: 0,
            minimumLength: 0,
        },
    }],
    customText: {
        afterSubmit: {
            message: "string",
        },
        shippingAddress: {
            message: "string",
        },
        submit: {
            message: "string",
        },
        termsOfServiceAcceptance: {
            message: "string",
        },
    },
    customerCreation: "string",
    inactiveMessage: "string",
    invoiceCreation: {
        enabled: false,
        invoiceData: {
            accountTaxIds: ["string"],
            customFields: [{
                name: "string",
                value: "string",
            }],
            description: "string",
            footer: "string",
            issuer: {
                type: "string",
                account: "string",
            },
            metadata: {
                string: "string",
            },
            renderingOptions: {
                amountTaxDisplay: "string",
                template: "string",
            },
        },
    },
    afterCompletion: {
        type: "string",
        hostedConfirmation: {
            customMessage: "string",
        },
        redirect: {
            url: "string",
        },
    },
    allowPromotionCodes: false,
    managedPayments: {
        enabled: false,
    },
    optionalItems: [{
        price: "string",
        quantity: 0,
        adjustableQuantity: {
            enabled: false,
            maximum: 0,
            minimum: 0,
        },
    }],
    onBehalfOf: "string",
    active: false,
    paymentIntentData: {
        captureMethod: "string",
        description: "string",
        metadata: {
            string: "string",
        },
        setupFutureUsage: "string",
        statementDescriptor: "string",
        statementDescriptorSuffix: "string",
        transferGroup: "string",
    },
    paymentMethodCollection: "string",
    paymentMethodOptions: {
        card: {
            restrictions: {
                brandsBlockeds: ["string"],
            },
        },
    },
    paymentMethodTypes: ["string"],
    phoneNumberCollection: {
        enabled: false,
    },
    restrictions: {
        completedSessions: {
            limit: 0,
            count: 0,
        },
    },
    shippingAddressCollection: {
        allowedCountries: ["string"],
    },
    shippingOptions: [{
        shippingAmount: 0,
        shippingRate: "string",
    }],
    submitType: "string",
    subscriptionData: {
        description: "string",
        invoiceSettings: {
            issuer: {
                type: "string",
                account: "string",
            },
        },
        metadata: {
            string: "string",
        },
        trialPeriodDays: 0,
        trialSettings: {
            endBehavior: {
                missingPaymentMethod: "string",
            },
        },
    },
    taxIdCollection: {
        enabled: false,
        required: "string",
    },
    transferData: {
        destination: "string",
        amount: 0,
    },
});

    type: stripe:PaymentLink
properties:
    active: false
    afterCompletion:
        hostedConfirmation:
            customMessage: string
        redirect:
            url: string
        type: string
    allowPromotionCodes: false
    applicationFeeAmount: 0
    applicationFeePercent: 0
    automaticTax:
        enabled: false
        liability:
            account: string
            type: string
    billingAddressCollection: string
    consentCollection:
        paymentMethodReuseAgreement:
            position: string
        promotions: string
        termsOfService: string
    currency: string
    customFields:
        - dropdown:
            defaultValue: string
            options:
                - label: string
                  value: string
          key: string
          label:
            custom: string
            type: string
          numeric:
            defaultValue: string
            maximumLength: 0
            minimumLength: 0
          optional: false
          text:
            defaultValue: string
            maximumLength: 0
            minimumLength: 0
          type: string
    customText:
        afterSubmit:
            message: string
        shippingAddress:
            message: string
        submit:
            message: string
        termsOfServiceAcceptance:
            message: string
    customerCreation: string
    inactiveMessage: string
    invoiceCreation:
        enabled: false
        invoiceData:
            accountTaxIds:
                - string
            customFields:
                - name: string
                  value: string
            description: string
            footer: string
            issuer:
                account: string
                type: string
            metadata:
                string: string
            renderingOptions:
                amountTaxDisplay: string
                template: string
    lineItems:
        - adjustableQuantity:
            enabled: false
            maximum: 0
            minimum: 0
          id: string
          price: string
          priceData:
            currency: string
            product: string
            productData:
                description: string
                images:
                    - string
                metadata:
                    string: string
                name: string
                taxCode: string
                unitLabel: string
            recurring:
                interval: string
                intervalCount: 0
            taxBehavior: string
            unitAmount: 0
            unitAmountDecimal: 0
          quantity: 0
    managedPayments:
        enabled: false
    metadata:
        string: string
    nameCollection:
        business:
            enabled: false
            optional: false
        individual:
            enabled: false
            optional: false
    onBehalfOf: string
    optionalItems:
        - adjustableQuantity:
            enabled: false
            maximum: 0
            minimum: 0
          price: string
          quantity: 0
    paymentIntentData:
        captureMethod: string
        description: string
        metadata:
            string: string
        setupFutureUsage: string
        statementDescriptor: string
        statementDescriptorSuffix: string
        transferGroup: string
    paymentMethodCollection: string
    paymentMethodOptions:
        card:
            restrictions:
                brandsBlockeds:
                    - string
    paymentMethodTypes:
        - string
    phoneNumberCollection:
        enabled: false
    restrictions:
        completedSessions:
            count: 0
            limit: 0
    shippingAddressCollection:
        allowedCountries:
            - string
    shippingOptions:
        - shippingAmount: 0
          shippingRate: string
    submitType: string
    subscriptionData:
        description: string
        invoiceSettings:
            issuer:
                account: string
                type: string
        metadata:
            string: string
        trialPeriodDays: 0
        trialSettings:
            endBehavior:
                missingPaymentMethod: string
    taxIdCollection:
        enabled: false
        required: string
    transferData:
        amount: 0
        destination: string

    PaymentLink Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The PaymentLink resource accepts the following input properties:

    LineItems List<PaymentLinkLineItem>
    The line items representing what is being sold.
    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.
    AfterCompletion PaymentLinkAfterCompletion
    AllowPromotionCodes bool
    Whether user redeemable promotion codes are enabled.
    ApplicationFeeAmount double
    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.
    ApplicationFeePercent double
    This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
    AutomaticTax PaymentLinkAutomaticTax
    BillingAddressCollection string
    Configuration for collecting the customer's billing address. Defaults to auto.
    ConsentCollection PaymentLinkConsentCollection
    When set, provides configuration to gather active consent from customers.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    CustomFields List<PaymentLinkCustomField>
    Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if ui_mode is custom.
    CustomText PaymentLinkCustomText
    CustomerCreation string
    Configuration for Customer creation during checkout.
    InactiveMessage string
    The custom message to be displayed to a customer when a payment link is no longer active.
    InvoiceCreation PaymentLinkInvoiceCreation
    Configuration for creating invoice for payment mode payment links.
    ManagedPayments PaymentLinkManagedPayments
    Settings for Managed Payments for this Payment Link and resulting CheckoutSessions, PaymentIntents, Invoices, and Subscriptions.
    Metadata Dictionary<string, string>
    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.
    NameCollection PaymentLinkNameCollection
    OnBehalfOf string
    The account on behalf of which to charge. See the Connect documentation for details.
    OptionalItems List<PaymentLinkOptionalItem>
    The optional items presented to the customer at checkout.
    PaymentIntentData PaymentLinkPaymentIntentData
    Indicates the parameters to be passed to PaymentIntent creation during checkout.
    PaymentMethodCollection string
    Configuration for collecting a payment method during checkout. Defaults to always.
    PaymentMethodOptions PaymentLinkPaymentMethodOptions
    Payment-method-specific configuration.
    PaymentMethodTypes List<string>
    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.
    PhoneNumberCollection PaymentLinkPhoneNumberCollection
    Restrictions PaymentLinkRestrictions
    Settings that restrict the usage of a payment link.
    ShippingAddressCollection PaymentLinkShippingAddressCollection
    Configuration for collecting the customer's shipping address.
    ShippingOptions List<PaymentLinkShippingOption>
    The shipping rate options applied to the session.
    SubmitType string
    Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.
    SubscriptionData PaymentLinkSubscriptionData
    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.
    TaxIdCollection PaymentLinkTaxIdCollection
    TransferData PaymentLinkTransferData
    The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.
    LineItems []PaymentLinkLineItemArgs
    The line items representing what is being sold.
    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.
    AfterCompletion PaymentLinkAfterCompletionArgs
    AllowPromotionCodes bool
    Whether user redeemable promotion codes are enabled.
    ApplicationFeeAmount float64
    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.
    ApplicationFeePercent float64
    This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
    AutomaticTax PaymentLinkAutomaticTaxArgs
    BillingAddressCollection string
    Configuration for collecting the customer's billing address. Defaults to auto.
    ConsentCollection PaymentLinkConsentCollectionArgs
    When set, provides configuration to gather active consent from customers.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    CustomFields []PaymentLinkCustomFieldArgs
    Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if ui_mode is custom.
    CustomText PaymentLinkCustomTextArgs
    CustomerCreation string
    Configuration for Customer creation during checkout.
    InactiveMessage string
    The custom message to be displayed to a customer when a payment link is no longer active.
    InvoiceCreation PaymentLinkInvoiceCreationArgs
    Configuration for creating invoice for payment mode payment links.
    ManagedPayments PaymentLinkManagedPaymentsArgs
    Settings for Managed Payments for this Payment Link and resulting CheckoutSessions, PaymentIntents, Invoices, and Subscriptions.
    Metadata map[string]string
    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.
    NameCollection PaymentLinkNameCollectionArgs
    OnBehalfOf string
    The account on behalf of which to charge. See the Connect documentation for details.
    OptionalItems []PaymentLinkOptionalItemArgs
    The optional items presented to the customer at checkout.
    PaymentIntentData PaymentLinkPaymentIntentDataArgs
    Indicates the parameters to be passed to PaymentIntent creation during checkout.
    PaymentMethodCollection string
    Configuration for collecting a payment method during checkout. Defaults to always.
    PaymentMethodOptions PaymentLinkPaymentMethodOptionsArgs
    Payment-method-specific configuration.
    PaymentMethodTypes []string
    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.
    PhoneNumberCollection PaymentLinkPhoneNumberCollectionArgs
    Restrictions PaymentLinkRestrictionsArgs
    Settings that restrict the usage of a payment link.
    ShippingAddressCollection PaymentLinkShippingAddressCollectionArgs
    Configuration for collecting the customer's shipping address.
    ShippingOptions []PaymentLinkShippingOptionArgs
    The shipping rate options applied to the session.
    SubmitType string
    Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.
    SubscriptionData PaymentLinkSubscriptionDataArgs
    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.
    TaxIdCollection PaymentLinkTaxIdCollectionArgs
    TransferData PaymentLinkTransferDataArgs
    The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.
    line_items list(object)
    The line items representing what is being sold.
    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 object
    allow_promotion_codes bool
    Whether user redeemable promotion codes are enabled.
    application_fee_amount number
    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 number
    This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
    automatic_tax object
    billing_address_collection string
    Configuration for collecting the customer's billing address. Defaults to auto.
    consent_collection object
    When set, provides configuration to gather active consent from customers.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    custom_fields list(object)
    Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if ui_mode is custom.
    custom_text object
    customer_creation string
    Configuration for Customer creation during checkout.
    inactive_message string
    The custom message to be displayed to a customer when a payment link is no longer active.
    invoice_creation object
    Configuration for creating invoice for payment mode payment links.
    managed_payments object
    Settings for Managed Payments for this Payment Link and resulting CheckoutSessions, PaymentIntents, Invoices, and Subscriptions.
    metadata map(string)
    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.
    name_collection object
    on_behalf_of string
    The account on behalf of which to charge. See the Connect documentation for details.
    optional_items list(object)
    The optional items presented to the customer at checkout.
    payment_intent_data object
    Indicates the parameters to be passed to PaymentIntent creation during checkout.
    payment_method_collection string
    Configuration for collecting a payment method during checkout. Defaults to always.
    payment_method_options object
    Payment-method-specific configuration.
    payment_method_types list(string)
    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 object
    restrictions object
    Settings that restrict the usage of a payment link.
    shipping_address_collection object
    Configuration for collecting the customer's shipping address.
    shipping_options list(object)
    The shipping rate options applied to the session.
    submit_type string
    Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.
    subscription_data object
    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.
    tax_id_collection object
    transfer_data object
    The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.
    lineItems List<PaymentLinkLineItem>
    The line items representing what is being sold.
    active Boolean
    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.
    afterCompletion PaymentLinkAfterCompletion
    allowPromotionCodes Boolean
    Whether user redeemable promotion codes are enabled.
    applicationFeeAmount Double
    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.
    applicationFeePercent Double
    This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
    automaticTax PaymentLinkAutomaticTax
    billingAddressCollection String
    Configuration for collecting the customer's billing address. Defaults to auto.
    consentCollection PaymentLinkConsentCollection
    When set, provides configuration to gather active consent from customers.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customFields List<PaymentLinkCustomField>
    Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if ui_mode is custom.
    customText PaymentLinkCustomText
    customerCreation String
    Configuration for Customer creation during checkout.
    inactiveMessage String
    The custom message to be displayed to a customer when a payment link is no longer active.
    invoiceCreation PaymentLinkInvoiceCreation
    Configuration for creating invoice for payment mode payment links.
    managedPayments PaymentLinkManagedPayments
    Settings for Managed Payments for this Payment Link and resulting CheckoutSessions, PaymentIntents, Invoices, and Subscriptions.
    metadata Map<String,String>
    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.
    nameCollection PaymentLinkNameCollection
    onBehalfOf String
    The account on behalf of which to charge. See the Connect documentation for details.
    optionalItems List<PaymentLinkOptionalItem>
    The optional items presented to the customer at checkout.
    paymentIntentData PaymentLinkPaymentIntentData
    Indicates the parameters to be passed to PaymentIntent creation during checkout.
    paymentMethodCollection String
    Configuration for collecting a payment method during checkout. Defaults to always.
    paymentMethodOptions PaymentLinkPaymentMethodOptions
    Payment-method-specific configuration.
    paymentMethodTypes List<String>
    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.
    phoneNumberCollection PaymentLinkPhoneNumberCollection
    restrictions PaymentLinkRestrictions
    Settings that restrict the usage of a payment link.
    shippingAddressCollection PaymentLinkShippingAddressCollection
    Configuration for collecting the customer's shipping address.
    shippingOptions List<PaymentLinkShippingOption>
    The shipping rate options applied to the session.
    submitType String
    Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.
    subscriptionData PaymentLinkSubscriptionData
    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.
    taxIdCollection PaymentLinkTaxIdCollection
    transferData PaymentLinkTransferData
    The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.
    lineItems PaymentLinkLineItem[]
    The line items representing what is being sold.
    active boolean
    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.
    afterCompletion PaymentLinkAfterCompletion
    allowPromotionCodes boolean
    Whether user redeemable promotion codes are enabled.
    applicationFeeAmount number
    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.
    applicationFeePercent number
    This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
    automaticTax PaymentLinkAutomaticTax
    billingAddressCollection string
    Configuration for collecting the customer's billing address. Defaults to auto.
    consentCollection PaymentLinkConsentCollection
    When set, provides configuration to gather active consent from customers.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customFields PaymentLinkCustomField[]
    Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if ui_mode is custom.
    customText PaymentLinkCustomText
    customerCreation string
    Configuration for Customer creation during checkout.
    inactiveMessage string
    The custom message to be displayed to a customer when a payment link is no longer active.
    invoiceCreation PaymentLinkInvoiceCreation
    Configuration for creating invoice for payment mode payment links.
    managedPayments PaymentLinkManagedPayments
    Settings for Managed Payments for this Payment Link and resulting CheckoutSessions, PaymentIntents, Invoices, and Subscriptions.
    metadata {[key: string]: string}
    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.
    nameCollection PaymentLinkNameCollection
    onBehalfOf string
    The account on behalf of which to charge. See the Connect documentation for details.
    optionalItems PaymentLinkOptionalItem[]
    The optional items presented to the customer at checkout.
    paymentIntentData PaymentLinkPaymentIntentData
    Indicates the parameters to be passed to PaymentIntent creation during checkout.
    paymentMethodCollection string
    Configuration for collecting a payment method during checkout. Defaults to always.
    paymentMethodOptions PaymentLinkPaymentMethodOptions
    Payment-method-specific configuration.
    paymentMethodTypes string[]
    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.
    phoneNumberCollection PaymentLinkPhoneNumberCollection
    restrictions PaymentLinkRestrictions
    Settings that restrict the usage of a payment link.
    shippingAddressCollection PaymentLinkShippingAddressCollection
    Configuration for collecting the customer's shipping address.
    shippingOptions PaymentLinkShippingOption[]
    The shipping rate options applied to the session.
    submitType string
    Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.
    subscriptionData PaymentLinkSubscriptionData
    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.
    taxIdCollection PaymentLinkTaxIdCollection
    transferData PaymentLinkTransferData
    The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.
    line_items Sequence[PaymentLinkLineItemArgs]
    The line items representing what is being sold.
    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 PaymentLinkAfterCompletionArgs
    allow_promotion_codes bool
    Whether user redeemable promotion codes are enabled.
    application_fee_amount float
    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 float
    This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
    automatic_tax PaymentLinkAutomaticTaxArgs
    billing_address_collection str
    Configuration for collecting the customer's billing address. Defaults to auto.
    consent_collection PaymentLinkConsentCollectionArgs
    When set, provides configuration to gather active consent from customers.
    currency str
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    custom_fields Sequence[PaymentLinkCustomFieldArgs]
    Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if ui_mode is custom.
    custom_text PaymentLinkCustomTextArgs
    customer_creation str
    Configuration for Customer creation during checkout.
    inactive_message str
    The custom message to be displayed to a customer when a payment link is no longer active.
    invoice_creation PaymentLinkInvoiceCreationArgs
    Configuration for creating invoice for payment mode payment links.
    managed_payments PaymentLinkManagedPaymentsArgs
    Settings for Managed Payments for this Payment Link and resulting CheckoutSessions, PaymentIntents, Invoices, and Subscriptions.
    metadata Mapping[str, str]
    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.
    name_collection PaymentLinkNameCollectionArgs
    on_behalf_of str
    The account on behalf of which to charge. See the Connect documentation for details.
    optional_items Sequence[PaymentLinkOptionalItemArgs]
    The optional items presented to the customer at checkout.
    payment_intent_data PaymentLinkPaymentIntentDataArgs
    Indicates the parameters to be passed to PaymentIntent creation during checkout.
    payment_method_collection str
    Configuration for collecting a payment method during checkout. Defaults to always.
    payment_method_options PaymentLinkPaymentMethodOptionsArgs
    Payment-method-specific configuration.
    payment_method_types Sequence[str]
    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 PaymentLinkPhoneNumberCollectionArgs
    restrictions PaymentLinkRestrictionsArgs
    Settings that restrict the usage of a payment link.
    shipping_address_collection PaymentLinkShippingAddressCollectionArgs
    Configuration for collecting the customer's shipping address.
    shipping_options Sequence[PaymentLinkShippingOptionArgs]
    The shipping rate options applied to the session.
    submit_type str
    Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.
    subscription_data PaymentLinkSubscriptionDataArgs
    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.
    tax_id_collection PaymentLinkTaxIdCollectionArgs
    transfer_data PaymentLinkTransferDataArgs
    The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.
    lineItems List<Property Map>
    The line items representing what is being sold.
    active Boolean
    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.
    afterCompletion Property Map
    allowPromotionCodes Boolean
    Whether user redeemable promotion codes are enabled.
    applicationFeeAmount Number
    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.
    applicationFeePercent Number
    This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
    automaticTax Property Map
    billingAddressCollection String
    Configuration for collecting the customer's billing address. Defaults to auto.
    consentCollection Property Map
    When set, provides configuration to gather active consent from customers.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customFields List<Property Map>
    Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if ui_mode is custom.
    customText Property Map
    customerCreation String
    Configuration for Customer creation during checkout.
    inactiveMessage String
    The custom message to be displayed to a customer when a payment link is no longer active.
    invoiceCreation Property Map
    Configuration for creating invoice for payment mode payment links.
    managedPayments Property Map
    Settings for Managed Payments for this Payment Link and resulting CheckoutSessions, PaymentIntents, Invoices, and Subscriptions.
    metadata Map<String>
    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.
    nameCollection Property Map
    onBehalfOf String
    The account on behalf of which to charge. See the Connect documentation for details.
    optionalItems List<Property Map>
    The optional items presented to the customer at checkout.
    paymentIntentData Property Map
    Indicates the parameters to be passed to PaymentIntent creation during checkout.
    paymentMethodCollection String
    Configuration for collecting a payment method during checkout. Defaults to always.
    paymentMethodOptions Property Map
    Payment-method-specific configuration.
    paymentMethodTypes List<String>
    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.
    phoneNumberCollection Property Map
    restrictions Property Map
    Settings that restrict the usage of a payment link.
    shippingAddressCollection Property Map
    Configuration for collecting the customer's shipping address.
    shippingOptions List<Property Map>
    The shipping rate options applied to the session.
    submitType String
    Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.
    subscriptionData Property Map
    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.
    taxIdCollection Property Map
    transferData Property Map
    The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PaymentLink resource produces the following output properties:

    Application string
    The ID of the Connect application that created the Payment Link.
    Id string
    The provider-assigned unique ID for this managed resource.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    Url string
    The public URL that can be shared with customers.
    Application string
    The ID of the Connect application that created the Payment Link.
    Id string
    The provider-assigned unique ID for this managed resource.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    Url string
    The public URL that can be shared with customers.
    application string
    The ID of the Connect application that created the Payment Link.
    id string
    The provider-assigned unique ID for this managed resource.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    object string
    String representing the object's type. Objects of the same type share the same value.
    url string
    The public URL that can be shared with customers.
    application String
    The ID of the Connect application that created the Payment Link.
    id String
    The provider-assigned unique ID for this managed resource.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    object String
    String representing the object's type. Objects of the same type share the same value.
    url String
    The public URL that can be shared with customers.
    application string
    The ID of the Connect application that created the Payment Link.
    id string
    The provider-assigned unique ID for this managed resource.
    livemode boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    object string
    String representing the object's type. Objects of the same type share the same value.
    url string
    The public URL that can be shared with customers.
    application str
    The ID of the Connect application that created the Payment Link.
    id str
    The provider-assigned unique ID for this managed resource.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    object str
    String representing the object's type. Objects of the same type share the same value.
    url str
    The public URL that can be shared with customers.
    application String
    The ID of the Connect application that created the Payment Link.
    id String
    The provider-assigned unique ID for this managed resource.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    object String
    String representing the object's type. Objects of the same type share the same value.
    url String
    The public URL that can be shared with customers.

    Look up Existing PaymentLink Resource

    Get an existing PaymentLink resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: PaymentLinkState, opts?: CustomResourceOptions): PaymentLink
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active: Optional[bool] = None,
        after_completion: Optional[PaymentLinkAfterCompletionArgs] = None,
        allow_promotion_codes: Optional[bool] = None,
        application: Optional[str] = None,
        application_fee_amount: Optional[float] = None,
        application_fee_percent: Optional[float] = None,
        automatic_tax: Optional[PaymentLinkAutomaticTaxArgs] = None,
        billing_address_collection: Optional[str] = None,
        consent_collection: Optional[PaymentLinkConsentCollectionArgs] = None,
        currency: Optional[str] = None,
        custom_fields: Optional[Sequence[PaymentLinkCustomFieldArgs]] = None,
        custom_text: Optional[PaymentLinkCustomTextArgs] = None,
        customer_creation: Optional[str] = None,
        inactive_message: Optional[str] = None,
        invoice_creation: Optional[PaymentLinkInvoiceCreationArgs] = None,
        line_items: Optional[Sequence[PaymentLinkLineItemArgs]] = None,
        livemode: Optional[bool] = None,
        managed_payments: Optional[PaymentLinkManagedPaymentsArgs] = None,
        metadata: Optional[Mapping[str, str]] = None,
        name_collection: Optional[PaymentLinkNameCollectionArgs] = None,
        object: Optional[str] = None,
        on_behalf_of: Optional[str] = None,
        optional_items: Optional[Sequence[PaymentLinkOptionalItemArgs]] = None,
        payment_intent_data: Optional[PaymentLinkPaymentIntentDataArgs] = None,
        payment_method_collection: Optional[str] = None,
        payment_method_options: Optional[PaymentLinkPaymentMethodOptionsArgs] = None,
        payment_method_types: Optional[Sequence[str]] = None,
        phone_number_collection: Optional[PaymentLinkPhoneNumberCollectionArgs] = None,
        restrictions: Optional[PaymentLinkRestrictionsArgs] = None,
        shipping_address_collection: Optional[PaymentLinkShippingAddressCollectionArgs] = None,
        shipping_options: Optional[Sequence[PaymentLinkShippingOptionArgs]] = None,
        submit_type: Optional[str] = None,
        subscription_data: Optional[PaymentLinkSubscriptionDataArgs] = None,
        tax_id_collection: Optional[PaymentLinkTaxIdCollectionArgs] = None,
        transfer_data: Optional[PaymentLinkTransferDataArgs] = None,
        url: Optional[str] = None) -> PaymentLink
    func GetPaymentLink(ctx *Context, name string, id IDInput, state *PaymentLinkState, opts ...ResourceOption) (*PaymentLink, error)
    public static PaymentLink Get(string name, Input<string> id, PaymentLinkState? state, CustomResourceOptions? opts = null)
    public static PaymentLink get(String name, Output<String> id, PaymentLinkState state, CustomResourceOptions options)
    resources:  _:    type: stripe:PaymentLink    get:      id: ${id}
    import {
  to = stripe_payment_link.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    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.
    AfterCompletion PaymentLinkAfterCompletion
    AllowPromotionCodes bool
    Whether user redeemable promotion codes are enabled.
    Application string
    The ID of the Connect application that created the Payment Link.
    ApplicationFeeAmount double
    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.
    ApplicationFeePercent double
    This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
    AutomaticTax PaymentLinkAutomaticTax
    BillingAddressCollection string
    Configuration for collecting the customer's billing address. Defaults to auto.
    ConsentCollection PaymentLinkConsentCollection
    When set, provides configuration to gather active consent from customers.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    CustomFields List<PaymentLinkCustomField>
    Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if ui_mode is custom.
    CustomText PaymentLinkCustomText
    CustomerCreation string
    Configuration for Customer creation during checkout.
    InactiveMessage string
    The custom message to be displayed to a customer when a payment link is no longer active.
    InvoiceCreation PaymentLinkInvoiceCreation
    Configuration for creating invoice for payment mode payment links.
    LineItems List<PaymentLinkLineItem>
    The line items representing what is being sold.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    ManagedPayments PaymentLinkManagedPayments
    Settings for Managed Payments for this Payment Link and resulting CheckoutSessions, PaymentIntents, Invoices, and Subscriptions.
    Metadata Dictionary<string, string>
    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.
    NameCollection PaymentLinkNameCollection
    Object string
    String representing the object's type. Objects of the same type share the same value.
    OnBehalfOf string
    The account on behalf of which to charge. See the Connect documentation for details.
    OptionalItems List<PaymentLinkOptionalItem>
    The optional items presented to the customer at checkout.
    PaymentIntentData PaymentLinkPaymentIntentData
    Indicates the parameters to be passed to PaymentIntent creation during checkout.
    PaymentMethodCollection string
    Configuration for collecting a payment method during checkout. Defaults to always.
    PaymentMethodOptions PaymentLinkPaymentMethodOptions
    Payment-method-specific configuration.
    PaymentMethodTypes List<string>
    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.
    PhoneNumberCollection PaymentLinkPhoneNumberCollection
    Restrictions PaymentLinkRestrictions
    Settings that restrict the usage of a payment link.
    ShippingAddressCollection PaymentLinkShippingAddressCollection
    Configuration for collecting the customer's shipping address.
    ShippingOptions List<PaymentLinkShippingOption>
    The shipping rate options applied to the session.
    SubmitType string
    Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.
    SubscriptionData PaymentLinkSubscriptionData
    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.
    TaxIdCollection PaymentLinkTaxIdCollection
    TransferData PaymentLinkTransferData
    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.
    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.
    AfterCompletion PaymentLinkAfterCompletionArgs
    AllowPromotionCodes bool
    Whether user redeemable promotion codes are enabled.
    Application string
    The ID of the Connect application that created the Payment Link.
    ApplicationFeeAmount float64
    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.
    ApplicationFeePercent float64
    This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
    AutomaticTax PaymentLinkAutomaticTaxArgs
    BillingAddressCollection string
    Configuration for collecting the customer's billing address. Defaults to auto.
    ConsentCollection PaymentLinkConsentCollectionArgs
    When set, provides configuration to gather active consent from customers.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    CustomFields []PaymentLinkCustomFieldArgs
    Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if ui_mode is custom.
    CustomText PaymentLinkCustomTextArgs
    CustomerCreation string
    Configuration for Customer creation during checkout.
    InactiveMessage string
    The custom message to be displayed to a customer when a payment link is no longer active.
    InvoiceCreation PaymentLinkInvoiceCreationArgs
    Configuration for creating invoice for payment mode payment links.
    LineItems []PaymentLinkLineItemArgs
    The line items representing what is being sold.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    ManagedPayments PaymentLinkManagedPaymentsArgs
    Settings for Managed Payments for this Payment Link and resulting CheckoutSessions, PaymentIntents, Invoices, and Subscriptions.
    Metadata map[string]string
    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.
    NameCollection PaymentLinkNameCollectionArgs
    Object string
    String representing the object's type. Objects of the same type share the same value.
    OnBehalfOf string
    The account on behalf of which to charge. See the Connect documentation for details.
    OptionalItems []PaymentLinkOptionalItemArgs
    The optional items presented to the customer at checkout.
    PaymentIntentData PaymentLinkPaymentIntentDataArgs
    Indicates the parameters to be passed to PaymentIntent creation during checkout.
    PaymentMethodCollection string
    Configuration for collecting a payment method during checkout. Defaults to always.
    PaymentMethodOptions PaymentLinkPaymentMethodOptionsArgs
    Payment-method-specific configuration.
    PaymentMethodTypes []string
    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.
    PhoneNumberCollection PaymentLinkPhoneNumberCollectionArgs
    Restrictions PaymentLinkRestrictionsArgs
    Settings that restrict the usage of a payment link.
    ShippingAddressCollection PaymentLinkShippingAddressCollectionArgs
    Configuration for collecting the customer's shipping address.
    ShippingOptions []PaymentLinkShippingOptionArgs
    The shipping rate options applied to the session.
    SubmitType string
    Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.
    SubscriptionData PaymentLinkSubscriptionDataArgs
    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.
    TaxIdCollection PaymentLinkTaxIdCollectionArgs
    TransferData PaymentLinkTransferDataArgs
    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.
    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 object
    allow_promotion_codes bool
    Whether user redeemable promotion codes are enabled.
    application string
    The ID of the Connect application that created the Payment Link.
    application_fee_amount number
    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 number
    This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
    automatic_tax object
    billing_address_collection string
    Configuration for collecting the customer's billing address. Defaults to auto.
    consent_collection object
    When set, provides configuration to gather active consent from customers.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    custom_fields list(object)
    Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if ui_mode is custom.
    custom_text object
    customer_creation string
    Configuration for Customer creation during checkout.
    inactive_message string
    The custom message to be displayed to a customer when a payment link is no longer active.
    invoice_creation object
    Configuration for creating invoice for payment mode payment links.
    line_items list(object)
    The line items representing what is being sold.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    managed_payments object
    Settings for Managed Payments for this Payment Link and resulting CheckoutSessions, PaymentIntents, Invoices, and Subscriptions.
    metadata map(string)
    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.
    name_collection object
    object string
    String representing the object's type. Objects of the same type share the same value.
    on_behalf_of string
    The account on behalf of which to charge. See the Connect documentation for details.
    optional_items list(object)
    The optional items presented to the customer at checkout.
    payment_intent_data object
    Indicates the parameters to be passed to PaymentIntent creation during checkout.
    payment_method_collection string
    Configuration for collecting a payment method during checkout. Defaults to always.
    payment_method_options object
    Payment-method-specific configuration.
    payment_method_types list(string)
    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 object
    restrictions object
    Settings that restrict the usage of a payment link.
    shipping_address_collection object
    Configuration for collecting the customer's shipping address.
    shipping_options list(object)
    The shipping rate options applied to the session.
    submit_type string
    Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.
    subscription_data object
    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.
    tax_id_collection object
    transfer_data object
    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.
    active Boolean
    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.
    afterCompletion PaymentLinkAfterCompletion
    allowPromotionCodes Boolean
    Whether user redeemable promotion codes are enabled.
    application String
    The ID of the Connect application that created the Payment Link.
    applicationFeeAmount Double
    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.
    applicationFeePercent Double
    This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
    automaticTax PaymentLinkAutomaticTax
    billingAddressCollection String
    Configuration for collecting the customer's billing address. Defaults to auto.
    consentCollection PaymentLinkConsentCollection
    When set, provides configuration to gather active consent from customers.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customFields List<PaymentLinkCustomField>
    Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if ui_mode is custom.
    customText PaymentLinkCustomText
    customerCreation String
    Configuration for Customer creation during checkout.
    inactiveMessage String
    The custom message to be displayed to a customer when a payment link is no longer active.
    invoiceCreation PaymentLinkInvoiceCreation
    Configuration for creating invoice for payment mode payment links.
    lineItems List<PaymentLinkLineItem>
    The line items representing what is being sold.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    managedPayments PaymentLinkManagedPayments
    Settings for Managed Payments for this Payment Link and resulting CheckoutSessions, PaymentIntents, Invoices, and Subscriptions.
    metadata Map<String,String>
    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.
    nameCollection PaymentLinkNameCollection
    object String
    String representing the object's type. Objects of the same type share the same value.
    onBehalfOf String
    The account on behalf of which to charge. See the Connect documentation for details.
    optionalItems List<PaymentLinkOptionalItem>
    The optional items presented to the customer at checkout.
    paymentIntentData PaymentLinkPaymentIntentData
    Indicates the parameters to be passed to PaymentIntent creation during checkout.
    paymentMethodCollection String
    Configuration for collecting a payment method during checkout. Defaults to always.
    paymentMethodOptions PaymentLinkPaymentMethodOptions
    Payment-method-specific configuration.
    paymentMethodTypes List<String>
    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.
    phoneNumberCollection PaymentLinkPhoneNumberCollection
    restrictions PaymentLinkRestrictions
    Settings that restrict the usage of a payment link.
    shippingAddressCollection PaymentLinkShippingAddressCollection
    Configuration for collecting the customer's shipping address.
    shippingOptions List<PaymentLinkShippingOption>
    The shipping rate options applied to the session.
    submitType String
    Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.
    subscriptionData PaymentLinkSubscriptionData
    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.
    taxIdCollection PaymentLinkTaxIdCollection
    transferData PaymentLinkTransferData
    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.
    active boolean
    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.
    afterCompletion PaymentLinkAfterCompletion
    allowPromotionCodes boolean
    Whether user redeemable promotion codes are enabled.
    application string
    The ID of the Connect application that created the Payment Link.
    applicationFeeAmount number
    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.
    applicationFeePercent number
    This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
    automaticTax PaymentLinkAutomaticTax
    billingAddressCollection string
    Configuration for collecting the customer's billing address. Defaults to auto.
    consentCollection PaymentLinkConsentCollection
    When set, provides configuration to gather active consent from customers.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customFields PaymentLinkCustomField[]
    Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if ui_mode is custom.
    customText PaymentLinkCustomText
    customerCreation string
    Configuration for Customer creation during checkout.
    inactiveMessage string
    The custom message to be displayed to a customer when a payment link is no longer active.
    invoiceCreation PaymentLinkInvoiceCreation
    Configuration for creating invoice for payment mode payment links.
    lineItems PaymentLinkLineItem[]
    The line items representing what is being sold.
    livemode boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    managedPayments PaymentLinkManagedPayments
    Settings for Managed Payments for this Payment Link and resulting CheckoutSessions, PaymentIntents, Invoices, and Subscriptions.
    metadata {[key: string]: string}
    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.
    nameCollection PaymentLinkNameCollection
    object string
    String representing the object's type. Objects of the same type share the same value.
    onBehalfOf string
    The account on behalf of which to charge. See the Connect documentation for details.
    optionalItems PaymentLinkOptionalItem[]
    The optional items presented to the customer at checkout.
    paymentIntentData PaymentLinkPaymentIntentData
    Indicates the parameters to be passed to PaymentIntent creation during checkout.
    paymentMethodCollection string
    Configuration for collecting a payment method during checkout. Defaults to always.
    paymentMethodOptions PaymentLinkPaymentMethodOptions
    Payment-method-specific configuration.
    paymentMethodTypes string[]
    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.
    phoneNumberCollection PaymentLinkPhoneNumberCollection
    restrictions PaymentLinkRestrictions
    Settings that restrict the usage of a payment link.
    shippingAddressCollection PaymentLinkShippingAddressCollection
    Configuration for collecting the customer's shipping address.
    shippingOptions PaymentLinkShippingOption[]
    The shipping rate options applied to the session.
    submitType string
    Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.
    subscriptionData PaymentLinkSubscriptionData
    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.
    taxIdCollection PaymentLinkTaxIdCollection
    transferData PaymentLinkTransferData
    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.
    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 PaymentLinkAfterCompletionArgs
    allow_promotion_codes bool
    Whether user redeemable promotion codes are enabled.
    application str
    The ID of the Connect application that created the Payment Link.
    application_fee_amount float
    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 float
    This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
    automatic_tax PaymentLinkAutomaticTaxArgs
    billing_address_collection str
    Configuration for collecting the customer's billing address. Defaults to auto.
    consent_collection PaymentLinkConsentCollectionArgs
    When set, provides configuration to gather active consent from customers.
    currency str
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    custom_fields Sequence[PaymentLinkCustomFieldArgs]
    Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if ui_mode is custom.
    custom_text PaymentLinkCustomTextArgs
    customer_creation str
    Configuration for Customer creation during checkout.
    inactive_message str
    The custom message to be displayed to a customer when a payment link is no longer active.
    invoice_creation PaymentLinkInvoiceCreationArgs
    Configuration for creating invoice for payment mode payment links.
    line_items Sequence[PaymentLinkLineItemArgs]
    The line items representing what is being sold.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    managed_payments PaymentLinkManagedPaymentsArgs
    Settings for Managed Payments for this Payment Link and resulting CheckoutSessions, PaymentIntents, Invoices, and Subscriptions.
    metadata Mapping[str, str]
    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.
    name_collection PaymentLinkNameCollectionArgs
    object str
    String representing the object's type. Objects of the same type share the same value.
    on_behalf_of str
    The account on behalf of which to charge. See the Connect documentation for details.
    optional_items Sequence[PaymentLinkOptionalItemArgs]
    The optional items presented to the customer at checkout.
    payment_intent_data PaymentLinkPaymentIntentDataArgs
    Indicates the parameters to be passed to PaymentIntent creation during checkout.
    payment_method_collection str
    Configuration for collecting a payment method during checkout. Defaults to always.
    payment_method_options PaymentLinkPaymentMethodOptionsArgs
    Payment-method-specific configuration.
    payment_method_types Sequence[str]
    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 PaymentLinkPhoneNumberCollectionArgs
    restrictions PaymentLinkRestrictionsArgs
    Settings that restrict the usage of a payment link.
    shipping_address_collection PaymentLinkShippingAddressCollectionArgs
    Configuration for collecting the customer's shipping address.
    shipping_options Sequence[PaymentLinkShippingOptionArgs]
    The shipping rate options applied to the session.
    submit_type str
    Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.
    subscription_data PaymentLinkSubscriptionDataArgs
    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.
    tax_id_collection PaymentLinkTaxIdCollectionArgs
    transfer_data PaymentLinkTransferDataArgs
    The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.
    url str
    The public URL that can be shared with customers.
    active Boolean
    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.
    afterCompletion Property Map
    allowPromotionCodes Boolean
    Whether user redeemable promotion codes are enabled.
    application String
    The ID of the Connect application that created the Payment Link.
    applicationFeeAmount Number
    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.
    applicationFeePercent Number
    This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
    automaticTax Property Map
    billingAddressCollection String
    Configuration for collecting the customer's billing address. Defaults to auto.
    consentCollection Property Map
    When set, provides configuration to gather active consent from customers.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customFields List<Property Map>
    Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if ui_mode is custom.
    customText Property Map
    customerCreation String
    Configuration for Customer creation during checkout.
    inactiveMessage String
    The custom message to be displayed to a customer when a payment link is no longer active.
    invoiceCreation Property Map
    Configuration for creating invoice for payment mode payment links.
    lineItems List<Property Map>
    The line items representing what is being sold.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    managedPayments Property Map
    Settings for Managed Payments for this Payment Link and resulting CheckoutSessions, PaymentIntents, Invoices, and Subscriptions.
    metadata Map<String>
    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.
    nameCollection Property Map
    object String
    String representing the object's type. Objects of the same type share the same value.
    onBehalfOf String
    The account on behalf of which to charge. See the Connect documentation for details.
    optionalItems List<Property Map>
    The optional items presented to the customer at checkout.
    paymentIntentData Property Map
    Indicates the parameters to be passed to PaymentIntent creation during checkout.
    paymentMethodCollection String
    Configuration for collecting a payment method during checkout. Defaults to always.
    paymentMethodOptions Property Map
    Payment-method-specific configuration.
    paymentMethodTypes List<String>
    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.
    phoneNumberCollection Property Map
    restrictions Property Map
    Settings that restrict the usage of a payment link.
    shippingAddressCollection Property Map
    Configuration for collecting the customer's shipping address.
    shippingOptions List<Property Map>
    The shipping rate options applied to the session.
    submitType String
    Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.
    subscriptionData Property Map
    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.
    taxIdCollection Property Map
    transferData Property Map
    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.

    Supporting Types

    PaymentLinkAfterCompletion, PaymentLinkAfterCompletionArgs

    type string
    The specified behavior after the purchase is complete.
    hosted_confirmation object
    redirect object
    type String
    The specified behavior after the purchase is complete.
    hostedConfirmation Property Map
    redirect Property Map

    PaymentLinkAfterCompletionHostedConfirmation, PaymentLinkAfterCompletionHostedConfirmationArgs

    CustomMessage string
    The custom message that is displayed to the customer after the purchase is complete.
    CustomMessage string
    The custom message that is displayed to the customer after the purchase is complete.
    custom_message string
    The custom message that is displayed to the customer after the purchase is complete.
    customMessage String
    The custom message that is displayed to the customer after the purchase is complete.
    customMessage string
    The custom message that is displayed to the customer after the purchase is complete.
    custom_message str
    The custom message that is displayed to the customer after the purchase is complete.
    customMessage String
    The custom message that is displayed to the customer after the purchase is complete.

    PaymentLinkAfterCompletionRedirect, PaymentLinkAfterCompletionRedirectArgs

    Url string
    The URL the customer will be redirected to after the purchase is complete.
    Url string
    The URL the customer will be redirected to after the purchase is complete.
    url string
    The URL the customer will be redirected to after the purchase is complete.
    url String
    The URL the customer will be redirected to after the purchase is complete.
    url string
    The URL the customer will be redirected to after the purchase is complete.
    url str
    The URL the customer will be redirected to after the purchase is complete.
    url String
    The URL the customer will be redirected to after the purchase is complete.

    PaymentLinkAutomaticTax, PaymentLinkAutomaticTaxArgs

    Enabled bool
    If true, tax will be calculated automatically using the customer's location.
    Liability PaymentLinkAutomaticTaxLiability
    The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
    Enabled bool
    If true, tax will be calculated automatically using the customer's location.
    Liability PaymentLinkAutomaticTaxLiability
    The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
    enabled bool
    If true, tax will be calculated automatically using the customer's location.
    liability object
    The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
    enabled Boolean
    If true, tax will be calculated automatically using the customer's location.
    liability PaymentLinkAutomaticTaxLiability
    The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
    enabled boolean
    If true, tax will be calculated automatically using the customer's location.
    liability PaymentLinkAutomaticTaxLiability
    The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
    enabled bool
    If true, tax will be calculated automatically using the customer's location.
    liability PaymentLinkAutomaticTaxLiability
    The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
    enabled Boolean
    If true, tax will be calculated automatically using the customer's location.
    liability Property Map
    The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.

    PaymentLinkAutomaticTaxLiability, PaymentLinkAutomaticTaxLiabilityArgs

    Type string
    Type of the account referenced.
    Account string
    The connected account being referenced when type is account.
    Type string
    Type of the account referenced.
    Account string
    The connected account being referenced when type is account.
    type string
    Type of the account referenced.
    account string
    The connected account being referenced when type is account.
    type String
    Type of the account referenced.
    account String
    The connected account being referenced when type is account.
    type string
    Type of the account referenced.
    account string
    The connected account being referenced when type is account.
    type str
    Type of the account referenced.
    account str
    The connected account being referenced when type is account.
    type String
    Type of the account referenced.
    account String
    The connected account being referenced when type is account.

    PaymentLinkConsentCollection, PaymentLinkConsentCollectionArgs

    PaymentMethodReuseAgreement PaymentLinkConsentCollectionPaymentMethodReuseAgreement
    Settings related to the payment method reuse text shown in the Checkout UI.
    Promotions string
    If set to auto, enables the collection of customer consent for promotional communications.
    TermsOfService string
    If set to required, it requires cutomers to accept the terms of service before being able to pay. If set to none, customers won't be shown a checkbox to accept the terms of service.
    PaymentMethodReuseAgreement PaymentLinkConsentCollectionPaymentMethodReuseAgreement
    Settings related to the payment method reuse text shown in the Checkout UI.
    Promotions string
    If set to auto, enables the collection of customer consent for promotional communications.
    TermsOfService string
    If set to required, it requires cutomers to accept the terms of service before being able to pay. If set to none, customers won't be shown a checkbox to accept the terms of service.
    payment_method_reuse_agreement object
    Settings related to the payment method reuse text shown in the Checkout UI.
    promotions string
    If set to auto, enables the collection of customer consent for promotional communications.
    terms_of_service string
    If set to required, it requires cutomers to accept the terms of service before being able to pay. If set to none, customers won't be shown a checkbox to accept the terms of service.
    paymentMethodReuseAgreement PaymentLinkConsentCollectionPaymentMethodReuseAgreement
    Settings related to the payment method reuse text shown in the Checkout UI.
    promotions String
    If set to auto, enables the collection of customer consent for promotional communications.
    termsOfService String
    If set to required, it requires cutomers to accept the terms of service before being able to pay. If set to none, customers won't be shown a checkbox to accept the terms of service.
    paymentMethodReuseAgreement PaymentLinkConsentCollectionPaymentMethodReuseAgreement
    Settings related to the payment method reuse text shown in the Checkout UI.
    promotions string
    If set to auto, enables the collection of customer consent for promotional communications.
    termsOfService string
    If set to required, it requires cutomers to accept the terms of service before being able to pay. If set to none, customers won't be shown a checkbox to accept the terms of service.
    payment_method_reuse_agreement PaymentLinkConsentCollectionPaymentMethodReuseAgreement
    Settings related to the payment method reuse text shown in the Checkout UI.
    promotions str
    If set to auto, enables the collection of customer consent for promotional communications.
    terms_of_service str
    If set to required, it requires cutomers to accept the terms of service before being able to pay. If set to none, customers won't be shown a checkbox to accept the terms of service.
    paymentMethodReuseAgreement Property Map
    Settings related to the payment method reuse text shown in the Checkout UI.
    promotions String
    If set to auto, enables the collection of customer consent for promotional communications.
    termsOfService String
    If set to required, it requires cutomers to accept the terms of service before being able to pay. If set to none, customers won't be shown a checkbox to accept the terms of service.

    PaymentLinkConsentCollectionPaymentMethodReuseAgreement, PaymentLinkConsentCollectionPaymentMethodReuseAgreementArgs

    Position string
    Determines the position and visibility of the payment method reuse agreement in the UI. When set to auto, Stripe's defaults will be used.
    Position string
    Determines the position and visibility of the payment method reuse agreement in the UI. When set to auto, Stripe's defaults will be used.
    position string
    Determines the position and visibility of the payment method reuse agreement in the UI. When set to auto, Stripe's defaults will be used.
    position String
    Determines the position and visibility of the payment method reuse agreement in the UI. When set to auto, Stripe's defaults will be used.
    position string
    Determines the position and visibility of the payment method reuse agreement in the UI. When set to auto, Stripe's defaults will be used.
    position str
    Determines the position and visibility of the payment method reuse agreement in the UI. When set to auto, Stripe's defaults will be used.
    position String
    Determines the position and visibility of the payment method reuse agreement in the UI. When set to auto, Stripe's defaults will be used.

    PaymentLinkCustomField, PaymentLinkCustomFieldArgs

    Key string
    String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.
    Label PaymentLinkCustomFieldLabel
    Type string
    The type of the field.
    Dropdown PaymentLinkCustomFieldDropdown
    Numeric PaymentLinkCustomFieldNumeric
    Optional bool
    Whether the customer is required to complete the field before completing the Checkout Session. Defaults to false.
    Text PaymentLinkCustomFieldText
    Key string
    String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.
    Label PaymentLinkCustomFieldLabel
    Type string
    The type of the field.
    Dropdown PaymentLinkCustomFieldDropdown
    Numeric PaymentLinkCustomFieldNumeric
    Optional bool
    Whether the customer is required to complete the field before completing the Checkout Session. Defaults to false.
    Text PaymentLinkCustomFieldText
    key string
    String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.
    label object
    type string
    The type of the field.
    dropdown object
    numeric object
    optional bool
    Whether the customer is required to complete the field before completing the Checkout Session. Defaults to false.
    text object
    key String
    String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.
    label PaymentLinkCustomFieldLabel
    type String
    The type of the field.
    dropdown PaymentLinkCustomFieldDropdown
    numeric PaymentLinkCustomFieldNumeric
    optional Boolean
    Whether the customer is required to complete the field before completing the Checkout Session. Defaults to false.
    text PaymentLinkCustomFieldText
    key string
    String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.
    label PaymentLinkCustomFieldLabel
    type string
    The type of the field.
    dropdown PaymentLinkCustomFieldDropdown
    numeric PaymentLinkCustomFieldNumeric
    optional boolean
    Whether the customer is required to complete the field before completing the Checkout Session. Defaults to false.
    text PaymentLinkCustomFieldText
    key str
    String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.
    label PaymentLinkCustomFieldLabel
    type str
    The type of the field.
    dropdown PaymentLinkCustomFieldDropdown
    numeric PaymentLinkCustomFieldNumeric
    optional bool
    Whether the customer is required to complete the field before completing the Checkout Session. Defaults to false.
    text PaymentLinkCustomFieldText
    key String
    String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.
    label Property Map
    type String
    The type of the field.
    dropdown Property Map
    numeric Property Map
    optional Boolean
    Whether the customer is required to complete the field before completing the Checkout Session. Defaults to false.
    text Property Map

    PaymentLinkCustomFieldDropdown, PaymentLinkCustomFieldDropdownArgs

    Options List<PaymentLinkCustomFieldDropdownOption>
    The options available for the customer to select. Up to 200 options allowed.
    DefaultValue string
    The value that pre-fills on the payment page.
    Options []PaymentLinkCustomFieldDropdownOption
    The options available for the customer to select. Up to 200 options allowed.
    DefaultValue string
    The value that pre-fills on the payment page.
    options list(object)
    The options available for the customer to select. Up to 200 options allowed.
    default_value string
    The value that pre-fills on the payment page.
    options List<PaymentLinkCustomFieldDropdownOption>
    The options available for the customer to select. Up to 200 options allowed.
    defaultValue String
    The value that pre-fills on the payment page.
    options PaymentLinkCustomFieldDropdownOption[]
    The options available for the customer to select. Up to 200 options allowed.
    defaultValue string
    The value that pre-fills on the payment page.
    options Sequence[PaymentLinkCustomFieldDropdownOption]
    The options available for the customer to select. Up to 200 options allowed.
    default_value str
    The value that pre-fills on the payment page.
    options List<Property Map>
    The options available for the customer to select. Up to 200 options allowed.
    defaultValue String
    The value that pre-fills on the payment page.

    PaymentLinkCustomFieldDropdownOption, PaymentLinkCustomFieldDropdownOptionArgs

    Label string
    The label for the option, displayed to the customer. Up to 100 characters.
    Value string
    The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.
    Label string
    The label for the option, displayed to the customer. Up to 100 characters.
    Value string
    The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.
    label string
    The label for the option, displayed to the customer. Up to 100 characters.
    value string
    The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.
    label String
    The label for the option, displayed to the customer. Up to 100 characters.
    value String
    The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.
    label string
    The label for the option, displayed to the customer. Up to 100 characters.
    value string
    The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.
    label str
    The label for the option, displayed to the customer. Up to 100 characters.
    value str
    The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.
    label String
    The label for the option, displayed to the customer. Up to 100 characters.
    value String
    The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.

    PaymentLinkCustomFieldLabel, PaymentLinkCustomFieldLabelArgs

    Custom string
    Custom text for the label, displayed to the customer. Up to 50 characters.
    Type string
    The type of the label.
    Custom string
    Custom text for the label, displayed to the customer. Up to 50 characters.
    Type string
    The type of the label.
    custom string
    Custom text for the label, displayed to the customer. Up to 50 characters.
    type string
    The type of the label.
    custom String
    Custom text for the label, displayed to the customer. Up to 50 characters.
    type String
    The type of the label.
    custom string
    Custom text for the label, displayed to the customer. Up to 50 characters.
    type string
    The type of the label.
    custom str
    Custom text for the label, displayed to the customer. Up to 50 characters.
    type str
    The type of the label.
    custom String
    Custom text for the label, displayed to the customer. Up to 50 characters.
    type String
    The type of the label.

    PaymentLinkCustomFieldNumeric, PaymentLinkCustomFieldNumericArgs

    DefaultValue string
    The value that pre-fills the field on the payment page.
    MaximumLength double
    The maximum character length constraint for the customer's input.
    MinimumLength double
    The minimum character length requirement for the customer's input.
    DefaultValue string
    The value that pre-fills the field on the payment page.
    MaximumLength float64
    The maximum character length constraint for the customer's input.
    MinimumLength float64
    The minimum character length requirement for the customer's input.
    default_value string
    The value that pre-fills the field on the payment page.
    maximum_length number
    The maximum character length constraint for the customer's input.
    minimum_length number
    The minimum character length requirement for the customer's input.
    defaultValue String
    The value that pre-fills the field on the payment page.
    maximumLength Double
    The maximum character length constraint for the customer's input.
    minimumLength Double
    The minimum character length requirement for the customer's input.
    defaultValue string
    The value that pre-fills the field on the payment page.
    maximumLength number
    The maximum character length constraint for the customer's input.
    minimumLength number
    The minimum character length requirement for the customer's input.
    default_value str
    The value that pre-fills the field on the payment page.
    maximum_length float
    The maximum character length constraint for the customer's input.
    minimum_length float
    The minimum character length requirement for the customer's input.
    defaultValue String
    The value that pre-fills the field on the payment page.
    maximumLength Number
    The maximum character length constraint for the customer's input.
    minimumLength Number
    The minimum character length requirement for the customer's input.

    PaymentLinkCustomFieldText, PaymentLinkCustomFieldTextArgs

    DefaultValue string
    The value that pre-fills the field on the payment page.
    MaximumLength double
    The maximum character length constraint for the customer's input.
    MinimumLength double
    The minimum character length requirement for the customer's input.
    DefaultValue string
    The value that pre-fills the field on the payment page.
    MaximumLength float64
    The maximum character length constraint for the customer's input.
    MinimumLength float64
    The minimum character length requirement for the customer's input.
    default_value string
    The value that pre-fills the field on the payment page.
    maximum_length number
    The maximum character length constraint for the customer's input.
    minimum_length number
    The minimum character length requirement for the customer's input.
    defaultValue String
    The value that pre-fills the field on the payment page.
    maximumLength Double
    The maximum character length constraint for the customer's input.
    minimumLength Double
    The minimum character length requirement for the customer's input.
    defaultValue string
    The value that pre-fills the field on the payment page.
    maximumLength number
    The maximum character length constraint for the customer's input.
    minimumLength number
    The minimum character length requirement for the customer's input.
    default_value str
    The value that pre-fills the field on the payment page.
    maximum_length float
    The maximum character length constraint for the customer's input.
    minimum_length float
    The minimum character length requirement for the customer's input.
    defaultValue String
    The value that pre-fills the field on the payment page.
    maximumLength Number
    The maximum character length constraint for the customer's input.
    minimumLength Number
    The minimum character length requirement for the customer's input.

    PaymentLinkCustomText, PaymentLinkCustomTextArgs

    AfterSubmit PaymentLinkCustomTextAfterSubmit
    Custom text that should be displayed after the payment confirmation button.
    ShippingAddress PaymentLinkCustomTextShippingAddress
    Custom text that should be displayed alongside shipping address collection.
    Submit PaymentLinkCustomTextSubmit
    Custom text that should be displayed alongside the payment confirmation button.
    TermsOfServiceAcceptance PaymentLinkCustomTextTermsOfServiceAcceptance
    Custom text that should be displayed in place of the default terms of service agreement text.
    AfterSubmit PaymentLinkCustomTextAfterSubmit
    Custom text that should be displayed after the payment confirmation button.
    ShippingAddress PaymentLinkCustomTextShippingAddress
    Custom text that should be displayed alongside shipping address collection.
    Submit PaymentLinkCustomTextSubmit
    Custom text that should be displayed alongside the payment confirmation button.
    TermsOfServiceAcceptance PaymentLinkCustomTextTermsOfServiceAcceptance
    Custom text that should be displayed in place of the default terms of service agreement text.
    after_submit object
    Custom text that should be displayed after the payment confirmation button.
    shipping_address object
    Custom text that should be displayed alongside shipping address collection.
    submit object
    Custom text that should be displayed alongside the payment confirmation button.
    terms_of_service_acceptance object
    Custom text that should be displayed in place of the default terms of service agreement text.
    afterSubmit PaymentLinkCustomTextAfterSubmit
    Custom text that should be displayed after the payment confirmation button.
    shippingAddress PaymentLinkCustomTextShippingAddress
    Custom text that should be displayed alongside shipping address collection.
    submit PaymentLinkCustomTextSubmit
    Custom text that should be displayed alongside the payment confirmation button.
    termsOfServiceAcceptance PaymentLinkCustomTextTermsOfServiceAcceptance
    Custom text that should be displayed in place of the default terms of service agreement text.
    afterSubmit PaymentLinkCustomTextAfterSubmit
    Custom text that should be displayed after the payment confirmation button.
    shippingAddress PaymentLinkCustomTextShippingAddress
    Custom text that should be displayed alongside shipping address collection.
    submit PaymentLinkCustomTextSubmit
    Custom text that should be displayed alongside the payment confirmation button.
    termsOfServiceAcceptance PaymentLinkCustomTextTermsOfServiceAcceptance
    Custom text that should be displayed in place of the default terms of service agreement text.
    after_submit PaymentLinkCustomTextAfterSubmit
    Custom text that should be displayed after the payment confirmation button.
    shipping_address PaymentLinkCustomTextShippingAddress
    Custom text that should be displayed alongside shipping address collection.
    submit PaymentLinkCustomTextSubmit
    Custom text that should be displayed alongside the payment confirmation button.
    terms_of_service_acceptance PaymentLinkCustomTextTermsOfServiceAcceptance
    Custom text that should be displayed in place of the default terms of service agreement text.
    afterSubmit Property Map
    Custom text that should be displayed after the payment confirmation button.
    shippingAddress Property Map
    Custom text that should be displayed alongside shipping address collection.
    submit Property Map
    Custom text that should be displayed alongside the payment confirmation button.
    termsOfServiceAcceptance Property Map
    Custom text that should be displayed in place of the default terms of service agreement text.

    PaymentLinkCustomTextAfterSubmit, PaymentLinkCustomTextAfterSubmitArgs

    Message string
    Text can be up to 1200 characters in length.
    Message string
    Text can be up to 1200 characters in length.
    message string
    Text can be up to 1200 characters in length.
    message String
    Text can be up to 1200 characters in length.
    message string
    Text can be up to 1200 characters in length.
    message str
    Text can be up to 1200 characters in length.
    message String
    Text can be up to 1200 characters in length.

    PaymentLinkCustomTextShippingAddress, PaymentLinkCustomTextShippingAddressArgs

    Message string
    Text can be up to 1200 characters in length.
    Message string
    Text can be up to 1200 characters in length.
    message string
    Text can be up to 1200 characters in length.
    message String
    Text can be up to 1200 characters in length.
    message string
    Text can be up to 1200 characters in length.
    message str
    Text can be up to 1200 characters in length.
    message String
    Text can be up to 1200 characters in length.

    PaymentLinkCustomTextSubmit, PaymentLinkCustomTextSubmitArgs

    Message string
    Text can be up to 1200 characters in length.
    Message string
    Text can be up to 1200 characters in length.
    message string
    Text can be up to 1200 characters in length.
    message String
    Text can be up to 1200 characters in length.
    message string
    Text can be up to 1200 characters in length.
    message str
    Text can be up to 1200 characters in length.
    message String
    Text can be up to 1200 characters in length.

    PaymentLinkCustomTextTermsOfServiceAcceptance, PaymentLinkCustomTextTermsOfServiceAcceptanceArgs

    Message string
    Text can be up to 1200 characters in length.
    Message string
    Text can be up to 1200 characters in length.
    message string
    Text can be up to 1200 characters in length.
    message String
    Text can be up to 1200 characters in length.
    message string
    Text can be up to 1200 characters in length.
    message str
    Text can be up to 1200 characters in length.
    message String
    Text can be up to 1200 characters in length.

    PaymentLinkInvoiceCreation, PaymentLinkInvoiceCreationArgs

    Enabled bool
    Enable creating an invoice on successful payment.
    InvoiceData PaymentLinkInvoiceCreationInvoiceData
    Configuration for the invoice. Default invoice values will be used if unspecified.
    Enabled bool
    Enable creating an invoice on successful payment.
    InvoiceData PaymentLinkInvoiceCreationInvoiceData
    Configuration for the invoice. Default invoice values will be used if unspecified.
    enabled bool
    Enable creating an invoice on successful payment.
    invoice_data object
    Configuration for the invoice. Default invoice values will be used if unspecified.
    enabled Boolean
    Enable creating an invoice on successful payment.
    invoiceData PaymentLinkInvoiceCreationInvoiceData
    Configuration for the invoice. Default invoice values will be used if unspecified.
    enabled boolean
    Enable creating an invoice on successful payment.
    invoiceData PaymentLinkInvoiceCreationInvoiceData
    Configuration for the invoice. Default invoice values will be used if unspecified.
    enabled bool
    Enable creating an invoice on successful payment.
    invoice_data PaymentLinkInvoiceCreationInvoiceData
    Configuration for the invoice. Default invoice values will be used if unspecified.
    enabled Boolean
    Enable creating an invoice on successful payment.
    invoiceData Property Map
    Configuration for the invoice. Default invoice values will be used if unspecified.

    PaymentLinkInvoiceCreationInvoiceData, PaymentLinkInvoiceCreationInvoiceDataArgs

    AccountTaxIds List<string>
    The account tax IDs associated with the invoice.
    CustomFields List<PaymentLinkInvoiceCreationInvoiceDataCustomField>
    A list of up to 4 custom fields to be displayed on the invoice.
    Description string
    An arbitrary string attached to the object. Often useful for displaying to users.
    Footer string
    Footer to be displayed on the invoice.
    Issuer PaymentLinkInvoiceCreationInvoiceDataIssuer
    The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
    Metadata Dictionary<string, string>
    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.
    RenderingOptions PaymentLinkInvoiceCreationInvoiceDataRenderingOptions
    Options for invoice PDF rendering.
    AccountTaxIds []string
    The account tax IDs associated with the invoice.
    CustomFields []PaymentLinkInvoiceCreationInvoiceDataCustomField
    A list of up to 4 custom fields to be displayed on the invoice.
    Description string
    An arbitrary string attached to the object. Often useful for displaying to users.
    Footer string
    Footer to be displayed on the invoice.
    Issuer PaymentLinkInvoiceCreationInvoiceDataIssuer
    The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
    Metadata map[string]string
    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.
    RenderingOptions PaymentLinkInvoiceCreationInvoiceDataRenderingOptions
    Options for invoice PDF rendering.
    account_tax_ids list(string)
    The account tax IDs associated with the invoice.
    custom_fields list(object)
    A list of up to 4 custom fields to be displayed on the invoice.
    description string
    An arbitrary string attached to the object. Often useful for displaying to users.
    footer string
    Footer to be displayed on the invoice.
    issuer object
    The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
    metadata map(string)
    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.
    rendering_options object
    Options for invoice PDF rendering.
    accountTaxIds List<String>
    The account tax IDs associated with the invoice.
    customFields List<PaymentLinkInvoiceCreationInvoiceDataCustomField>
    A list of up to 4 custom fields to be displayed on the invoice.
    description String
    An arbitrary string attached to the object. Often useful for displaying to users.
    footer String
    Footer to be displayed on the invoice.
    issuer PaymentLinkInvoiceCreationInvoiceDataIssuer
    The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
    metadata Map<String,String>
    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.
    renderingOptions PaymentLinkInvoiceCreationInvoiceDataRenderingOptions
    Options for invoice PDF rendering.
    accountTaxIds string[]
    The account tax IDs associated with the invoice.
    customFields PaymentLinkInvoiceCreationInvoiceDataCustomField[]
    A list of up to 4 custom fields to be displayed on the invoice.
    description string
    An arbitrary string attached to the object. Often useful for displaying to users.
    footer string
    Footer to be displayed on the invoice.
    issuer PaymentLinkInvoiceCreationInvoiceDataIssuer
    The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
    metadata {[key: string]: string}
    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.
    renderingOptions PaymentLinkInvoiceCreationInvoiceDataRenderingOptions
    Options for invoice PDF rendering.
    account_tax_ids Sequence[str]
    The account tax IDs associated with the invoice.
    custom_fields Sequence[PaymentLinkInvoiceCreationInvoiceDataCustomField]
    A list of up to 4 custom fields to be displayed on the invoice.
    description str
    An arbitrary string attached to the object. Often useful for displaying to users.
    footer str
    Footer to be displayed on the invoice.
    issuer PaymentLinkInvoiceCreationInvoiceDataIssuer
    The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
    metadata Mapping[str, str]
    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.
    rendering_options PaymentLinkInvoiceCreationInvoiceDataRenderingOptions
    Options for invoice PDF rendering.
    accountTaxIds List<String>
    The account tax IDs associated with the invoice.
    customFields List<Property Map>
    A list of up to 4 custom fields to be displayed on the invoice.
    description String
    An arbitrary string attached to the object. Often useful for displaying to users.
    footer String
    Footer to be displayed on the invoice.
    issuer Property Map
    The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
    metadata Map<String>
    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.
    renderingOptions Property Map
    Options for invoice PDF rendering.

    PaymentLinkInvoiceCreationInvoiceDataCustomField, PaymentLinkInvoiceCreationInvoiceDataCustomFieldArgs

    Name string
    The name of the custom field.
    Value string
    The value of the custom field.
    Name string
    The name of the custom field.
    Value string
    The value of the custom field.
    name string
    The name of the custom field.
    value string
    The value of the custom field.
    name String
    The name of the custom field.
    value String
    The value of the custom field.
    name string
    The name of the custom field.
    value string
    The value of the custom field.
    name str
    The name of the custom field.
    value str
    The value of the custom field.
    name String
    The name of the custom field.
    value String
    The value of the custom field.

    PaymentLinkInvoiceCreationInvoiceDataIssuer, PaymentLinkInvoiceCreationInvoiceDataIssuerArgs

    Type string
    Type of the account referenced.
    Account string
    The connected account being referenced when type is account.
    Type string
    Type of the account referenced.
    Account string
    The connected account being referenced when type is account.
    type string
    Type of the account referenced.
    account string
    The connected account being referenced when type is account.
    type String
    Type of the account referenced.
    account String
    The connected account being referenced when type is account.
    type string
    Type of the account referenced.
    account string
    The connected account being referenced when type is account.
    type str
    Type of the account referenced.
    account str
    The connected account being referenced when type is account.
    type String
    Type of the account referenced.
    account String
    The connected account being referenced when type is account.

    PaymentLinkInvoiceCreationInvoiceDataRenderingOptions, PaymentLinkInvoiceCreationInvoiceDataRenderingOptionsArgs

    AmountTaxDisplay string
    How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
    Template string
    ID of the invoice rendering template to be used for the generated invoice.
    AmountTaxDisplay string
    How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
    Template string
    ID of the invoice rendering template to be used for the generated invoice.
    amount_tax_display string
    How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
    template string
    ID of the invoice rendering template to be used for the generated invoice.
    amountTaxDisplay String
    How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
    template String
    ID of the invoice rendering template to be used for the generated invoice.
    amountTaxDisplay string
    How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
    template string
    ID of the invoice rendering template to be used for the generated invoice.
    amount_tax_display str
    How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
    template str
    ID of the invoice rendering template to be used for the generated invoice.
    amountTaxDisplay String
    How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
    template String
    ID of the invoice rendering template to be used for the generated invoice.

    PaymentLinkLineItem, PaymentLinkLineItemArgs

    Quantity double
    The quantity of the line item being purchased.
    AdjustableQuantity PaymentLinkLineItemAdjustableQuantity
    When set, provides configuration for this item’s quantity to be adjusted by the customer during checkout.
    Id string
    Unique identifier for the object.
    Price string
    The ID of the Price or Plan object. One of price or price_data is required.
    PriceData PaymentLinkLineItemPriceData
    Data used to generate a new Price object inline. One of price or price_data is required.
    Quantity float64
    The quantity of the line item being purchased.
    AdjustableQuantity PaymentLinkLineItemAdjustableQuantity
    When set, provides configuration for this item’s quantity to be adjusted by the customer during checkout.
    Id string
    Unique identifier for the object.
    Price string
    The ID of the Price or Plan object. One of price or price_data is required.
    PriceData PaymentLinkLineItemPriceData
    Data used to generate a new Price object inline. One of price or price_data is required.
    quantity number
    The quantity of the line item being purchased.
    adjustable_quantity object
    When set, provides configuration for this item’s quantity to be adjusted by the customer during checkout.
    id string
    Unique identifier for the object.
    price string
    The ID of the Price or Plan object. One of price or price_data is required.
    price_data object
    Data used to generate a new Price object inline. One of price or price_data is required.
    quantity Double
    The quantity of the line item being purchased.
    adjustableQuantity PaymentLinkLineItemAdjustableQuantity
    When set, provides configuration for this item’s quantity to be adjusted by the customer during checkout.
    id String
    Unique identifier for the object.
    price String
    The ID of the Price or Plan object. One of price or price_data is required.
    priceData PaymentLinkLineItemPriceData
    Data used to generate a new Price object inline. One of price or price_data is required.
    quantity number
    The quantity of the line item being purchased.
    adjustableQuantity PaymentLinkLineItemAdjustableQuantity
    When set, provides configuration for this item’s quantity to be adjusted by the customer during checkout.
    id string
    Unique identifier for the object.
    price string
    The ID of the Price or Plan object. One of price or price_data is required.
    priceData PaymentLinkLineItemPriceData
    Data used to generate a new Price object inline. One of price or price_data is required.
    quantity float
    The quantity of the line item being purchased.
    adjustable_quantity PaymentLinkLineItemAdjustableQuantity
    When set, provides configuration for this item’s quantity to be adjusted by the customer during checkout.
    id str
    Unique identifier for the object.
    price str
    The ID of the Price or Plan object. One of price or price_data is required.
    price_data PaymentLinkLineItemPriceData
    Data used to generate a new Price object inline. One of price or price_data is required.
    quantity Number
    The quantity of the line item being purchased.
    adjustableQuantity Property Map
    When set, provides configuration for this item’s quantity to be adjusted by the customer during checkout.
    id String
    Unique identifier for the object.
    price String
    The ID of the Price or Plan object. One of price or price_data is required.
    priceData Property Map
    Data used to generate a new Price object inline. One of price or price_data is required.

    PaymentLinkLineItemAdjustableQuantity, PaymentLinkLineItemAdjustableQuantityArgs

    Enabled bool
    Set to true if the quantity can be adjusted to any non-negative Integer.
    Maximum double
    The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999999.
    Minimum double
    The minimum quantity the customer can purchase. By default this value is 0. If there is only one item in the cart then that item's quantity cannot go down to 0.
    Enabled bool
    Set to true if the quantity can be adjusted to any non-negative Integer.
    Maximum float64
    The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999999.
    Minimum float64
    The minimum quantity the customer can purchase. By default this value is 0. If there is only one item in the cart then that item's quantity cannot go down to 0.
    enabled bool
    Set to true if the quantity can be adjusted to any non-negative Integer.
    maximum number
    The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999999.
    minimum number
    The minimum quantity the customer can purchase. By default this value is 0. If there is only one item in the cart then that item's quantity cannot go down to 0.
    enabled Boolean
    Set to true if the quantity can be adjusted to any non-negative Integer.
    maximum Double
    The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999999.
    minimum Double
    The minimum quantity the customer can purchase. By default this value is 0. If there is only one item in the cart then that item's quantity cannot go down to 0.
    enabled boolean
    Set to true if the quantity can be adjusted to any non-negative Integer.
    maximum number
    The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999999.
    minimum number
    The minimum quantity the customer can purchase. By default this value is 0. If there is only one item in the cart then that item's quantity cannot go down to 0.
    enabled bool
    Set to true if the quantity can be adjusted to any non-negative Integer.
    maximum float
    The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999999.
    minimum float
    The minimum quantity the customer can purchase. By default this value is 0. If there is only one item in the cart then that item's quantity cannot go down to 0.
    enabled Boolean
    Set to true if the quantity can be adjusted to any non-negative Integer.
    maximum Number
    The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999999.
    minimum Number
    The minimum quantity the customer can purchase. By default this value is 0. If there is only one item in the cart then that item's quantity cannot go down to 0.

    PaymentLinkLineItemPriceData, PaymentLinkLineItemPriceDataArgs

    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    Product string
    The ID of the Product that this Price will belong to. One of product or product_data is required.
    ProductData PaymentLinkLineItemPriceDataProductData
    Data used to generate a new Product object inline. One of product or product_data is required.
    Recurring PaymentLinkLineItemPriceDataRecurring
    The recurring components of a price such as interval and interval_count.
    TaxBehavior string
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    UnitAmount double
    A non-negative integer in cents (or local equivalent) representing how much to charge. One of unit_amount or unit_amount_decimal is required.
    UnitAmountDecimal double
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    Product string
    The ID of the Product that this Price will belong to. One of product or product_data is required.
    ProductData PaymentLinkLineItemPriceDataProductData
    Data used to generate a new Product object inline. One of product or product_data is required.
    Recurring PaymentLinkLineItemPriceDataRecurring
    The recurring components of a price such as interval and interval_count.
    TaxBehavior string
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    UnitAmount float64
    A non-negative integer in cents (or local equivalent) representing how much to charge. One of unit_amount or unit_amount_decimal is required.
    UnitAmountDecimal float64
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    product string
    The ID of the Product that this Price will belong to. One of product or product_data is required.
    product_data object
    Data used to generate a new Product object inline. One of product or product_data is required.
    recurring object
    The recurring components of a price such as interval and interval_count.
    tax_behavior string
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    unit_amount number
    A non-negative integer in cents (or local equivalent) representing how much to charge. One of unit_amount or unit_amount_decimal is required.
    unit_amount_decimal number
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    product String
    The ID of the Product that this Price will belong to. One of product or product_data is required.
    productData PaymentLinkLineItemPriceDataProductData
    Data used to generate a new Product object inline. One of product or product_data is required.
    recurring PaymentLinkLineItemPriceDataRecurring
    The recurring components of a price such as interval and interval_count.
    taxBehavior String
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    unitAmount Double
    A non-negative integer in cents (or local equivalent) representing how much to charge. One of unit_amount or unit_amount_decimal is required.
    unitAmountDecimal Double
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    product string
    The ID of the Product that this Price will belong to. One of product or product_data is required.
    productData PaymentLinkLineItemPriceDataProductData
    Data used to generate a new Product object inline. One of product or product_data is required.
    recurring PaymentLinkLineItemPriceDataRecurring
    The recurring components of a price such as interval and interval_count.
    taxBehavior string
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    unitAmount number
    A non-negative integer in cents (or local equivalent) representing how much to charge. One of unit_amount or unit_amount_decimal is required.
    unitAmountDecimal number
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    currency str
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    product str
    The ID of the Product that this Price will belong to. One of product or product_data is required.
    product_data PaymentLinkLineItemPriceDataProductData
    Data used to generate a new Product object inline. One of product or product_data is required.
    recurring PaymentLinkLineItemPriceDataRecurring
    The recurring components of a price such as interval and interval_count.
    tax_behavior str
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    unit_amount float
    A non-negative integer in cents (or local equivalent) representing how much to charge. One of unit_amount or unit_amount_decimal is required.
    unit_amount_decimal float
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    product String
    The ID of the Product that this Price will belong to. One of product or product_data is required.
    productData Property Map
    Data used to generate a new Product object inline. One of product or product_data is required.
    recurring Property Map
    The recurring components of a price such as interval and interval_count.
    taxBehavior String
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    unitAmount Number
    A non-negative integer in cents (or local equivalent) representing how much to charge. One of unit_amount or unit_amount_decimal is required.
    unitAmountDecimal Number
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.

    PaymentLinkLineItemPriceDataProductData, PaymentLinkLineItemPriceDataProductDataArgs

    Name string
    The product's name, meant to be displayable to the customer.
    Description string
    The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
    Images List<string>
    A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
    Metadata Dictionary<string, string>
    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.
    TaxCode string
    A tax code ID.
    UnitLabel string
    A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
    Name string
    The product's name, meant to be displayable to the customer.
    Description string
    The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
    Images []string
    A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
    Metadata map[string]string
    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.
    TaxCode string
    A tax code ID.
    UnitLabel string
    A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
    name string
    The product's name, meant to be displayable to the customer.
    description string
    The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
    images list(string)
    A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
    metadata map(string)
    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.
    tax_code string
    A tax code ID.
    unit_label string
    A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
    name String
    The product's name, meant to be displayable to the customer.
    description String
    The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
    images List<String>
    A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
    metadata Map<String,String>
    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.
    taxCode String
    A tax code ID.
    unitLabel String
    A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
    name string
    The product's name, meant to be displayable to the customer.
    description string
    The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
    images string[]
    A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
    metadata {[key: string]: string}
    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.
    taxCode string
    A tax code ID.
    unitLabel string
    A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
    name str
    The product's name, meant to be displayable to the customer.
    description str
    The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
    images Sequence[str]
    A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
    metadata Mapping[str, str]
    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.
    tax_code str
    A tax code ID.
    unit_label str
    A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
    name String
    The product's name, meant to be displayable to the customer.
    description String
    The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
    images List<String>
    A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
    metadata Map<String>
    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.
    taxCode String
    A tax code ID.
    unitLabel String
    A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.

    PaymentLinkLineItemPriceDataRecurring, PaymentLinkLineItemPriceDataRecurringArgs

    Interval string
    Specifies billing frequency. Either day, week, month or year.
    IntervalCount double
    The number of intervals between subscription billings. For example, interval=month and interval_count=3 bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
    Interval string
    Specifies billing frequency. Either day, week, month or year.
    IntervalCount float64
    The number of intervals between subscription billings. For example, interval=month and interval_count=3 bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
    interval string
    Specifies billing frequency. Either day, week, month or year.
    interval_count number
    The number of intervals between subscription billings. For example, interval=month and interval_count=3 bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
    interval String
    Specifies billing frequency. Either day, week, month or year.
    intervalCount Double
    The number of intervals between subscription billings. For example, interval=month and interval_count=3 bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
    interval string
    Specifies billing frequency. Either day, week, month or year.
    intervalCount number
    The number of intervals between subscription billings. For example, interval=month and interval_count=3 bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
    interval str
    Specifies billing frequency. Either day, week, month or year.
    interval_count float
    The number of intervals between subscription billings. For example, interval=month and interval_count=3 bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
    interval String
    Specifies billing frequency. Either day, week, month or year.
    intervalCount Number
    The number of intervals between subscription billings. For example, interval=month and interval_count=3 bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).

    PaymentLinkManagedPayments, PaymentLinkManagedPaymentsArgs

    Enabled bool
    Set to true to enable Managed Payments, Stripe's merchant of record solution, for this session.
    Enabled bool
    Set to true to enable Managed Payments, Stripe's merchant of record solution, for this session.
    enabled bool
    Set to true to enable Managed Payments, Stripe's merchant of record solution, for this session.
    enabled Boolean
    Set to true to enable Managed Payments, Stripe's merchant of record solution, for this session.
    enabled boolean
    Set to true to enable Managed Payments, Stripe's merchant of record solution, for this session.
    enabled bool
    Set to true to enable Managed Payments, Stripe's merchant of record solution, for this session.
    enabled Boolean
    Set to true to enable Managed Payments, Stripe's merchant of record solution, for this session.

    PaymentLinkNameCollection, PaymentLinkNameCollectionArgs

    PaymentLinkNameCollectionBusiness, PaymentLinkNameCollectionBusinessArgs

    Enabled bool
    Indicates whether business name collection is enabled for the payment link.
    Optional bool
    Whether the customer is required to complete the field before checking out. Defaults to false.
    Enabled bool
    Indicates whether business name collection is enabled for the payment link.
    Optional bool
    Whether the customer is required to complete the field before checking out. Defaults to false.
    enabled bool
    Indicates whether business name collection is enabled for the payment link.
    optional bool
    Whether the customer is required to complete the field before checking out. Defaults to false.
    enabled Boolean
    Indicates whether business name collection is enabled for the payment link.
    optional Boolean
    Whether the customer is required to complete the field before checking out. Defaults to false.
    enabled boolean
    Indicates whether business name collection is enabled for the payment link.
    optional boolean
    Whether the customer is required to complete the field before checking out. Defaults to false.
    enabled bool
    Indicates whether business name collection is enabled for the payment link.
    optional bool
    Whether the customer is required to complete the field before checking out. Defaults to false.
    enabled Boolean
    Indicates whether business name collection is enabled for the payment link.
    optional Boolean
    Whether the customer is required to complete the field before checking out. Defaults to false.

    PaymentLinkNameCollectionIndividual, PaymentLinkNameCollectionIndividualArgs

    Enabled bool
    Indicates whether individual name collection is enabled for the payment link.
    Optional bool
    Whether the customer is required to complete the field before checking out. Defaults to false.
    Enabled bool
    Indicates whether individual name collection is enabled for the payment link.
    Optional bool
    Whether the customer is required to complete the field before checking out. Defaults to false.
    enabled bool
    Indicates whether individual name collection is enabled for the payment link.
    optional bool
    Whether the customer is required to complete the field before checking out. Defaults to false.
    enabled Boolean
    Indicates whether individual name collection is enabled for the payment link.
    optional Boolean
    Whether the customer is required to complete the field before checking out. Defaults to false.
    enabled boolean
    Indicates whether individual name collection is enabled for the payment link.
    optional boolean
    Whether the customer is required to complete the field before checking out. Defaults to false.
    enabled bool
    Indicates whether individual name collection is enabled for the payment link.
    optional bool
    Whether the customer is required to complete the field before checking out. Defaults to false.
    enabled Boolean
    Indicates whether individual name collection is enabled for the payment link.
    optional Boolean
    Whether the customer is required to complete the field before checking out. Defaults to false.

    PaymentLinkOptionalItem, PaymentLinkOptionalItemArgs

    PaymentLinkOptionalItemAdjustableQuantity, PaymentLinkOptionalItemAdjustableQuantityArgs

    Enabled bool
    Set to true if the quantity can be adjusted to any non-negative integer.
    Maximum double
    The maximum quantity of this item the customer can purchase. By default this value is 99.
    Minimum double
    The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the minimum configured here is greater than 0. By default this value is 0.
    Enabled bool
    Set to true if the quantity can be adjusted to any non-negative integer.
    Maximum float64
    The maximum quantity of this item the customer can purchase. By default this value is 99.
    Minimum float64
    The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the minimum configured here is greater than 0. By default this value is 0.
    enabled bool
    Set to true if the quantity can be adjusted to any non-negative integer.
    maximum number
    The maximum quantity of this item the customer can purchase. By default this value is 99.
    minimum number
    The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the minimum configured here is greater than 0. By default this value is 0.
    enabled Boolean
    Set to true if the quantity can be adjusted to any non-negative integer.
    maximum Double
    The maximum quantity of this item the customer can purchase. By default this value is 99.
    minimum Double
    The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the minimum configured here is greater than 0. By default this value is 0.
    enabled boolean
    Set to true if the quantity can be adjusted to any non-negative integer.
    maximum number
    The maximum quantity of this item the customer can purchase. By default this value is 99.
    minimum number
    The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the minimum configured here is greater than 0. By default this value is 0.
    enabled bool
    Set to true if the quantity can be adjusted to any non-negative integer.
    maximum float
    The maximum quantity of this item the customer can purchase. By default this value is 99.
    minimum float
    The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the minimum configured here is greater than 0. By default this value is 0.
    enabled Boolean
    Set to true if the quantity can be adjusted to any non-negative integer.
    maximum Number
    The maximum quantity of this item the customer can purchase. By default this value is 99.
    minimum Number
    The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the minimum configured here is greater than 0. By default this value is 0.

    PaymentLinkPaymentIntentData, PaymentLinkPaymentIntentDataArgs

    CaptureMethod string
    Indicates when the funds will be captured from the customer's account.
    Description string
    An arbitrary string attached to the object. Often useful for displaying to users.
    Metadata Dictionary<string, string>
    Set of key-value pairs that will set metadata on Payment Intents generated from this payment link.
    SetupFutureUsage string
    Indicates that you intend to make future payments with the payment method collected during checkout.
    StatementDescriptor string
    For a non-card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge.
    StatementDescriptorSuffix string
    For a card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. Concatenated with the account's statement descriptor prefix to form the complete statement descriptor.
    TransferGroup string
    A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.
    CaptureMethod string
    Indicates when the funds will be captured from the customer's account.
    Description string
    An arbitrary string attached to the object. Often useful for displaying to users.
    Metadata map[string]string
    Set of key-value pairs that will set metadata on Payment Intents generated from this payment link.
    SetupFutureUsage string
    Indicates that you intend to make future payments with the payment method collected during checkout.
    StatementDescriptor string
    For a non-card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge.
    StatementDescriptorSuffix string
    For a card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. Concatenated with the account's statement descriptor prefix to form the complete statement descriptor.
    TransferGroup string
    A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.
    capture_method string
    Indicates when the funds will be captured from the customer's account.
    description string
    An arbitrary string attached to the object. Often useful for displaying to users.
    metadata map(string)
    Set of key-value pairs that will set metadata on Payment Intents generated from this payment link.
    setup_future_usage string
    Indicates that you intend to make future payments with the payment method collected during checkout.
    statement_descriptor string
    For a non-card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge.
    statement_descriptor_suffix string
    For a card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. Concatenated with the account's statement descriptor prefix to form the complete statement descriptor.
    transfer_group string
    A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.
    captureMethod String
    Indicates when the funds will be captured from the customer's account.
    description String
    An arbitrary string attached to the object. Often useful for displaying to users.
    metadata Map<String,String>
    Set of key-value pairs that will set metadata on Payment Intents generated from this payment link.
    setupFutureUsage String
    Indicates that you intend to make future payments with the payment method collected during checkout.
    statementDescriptor String
    For a non-card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge.
    statementDescriptorSuffix String
    For a card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. Concatenated with the account's statement descriptor prefix to form the complete statement descriptor.
    transferGroup String
    A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.
    captureMethod string
    Indicates when the funds will be captured from the customer's account.
    description string
    An arbitrary string attached to the object. Often useful for displaying to users.
    metadata {[key: string]: string}
    Set of key-value pairs that will set metadata on Payment Intents generated from this payment link.
    setupFutureUsage string
    Indicates that you intend to make future payments with the payment method collected during checkout.
    statementDescriptor string
    For a non-card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge.
    statementDescriptorSuffix string
    For a card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. Concatenated with the account's statement descriptor prefix to form the complete statement descriptor.
    transferGroup string
    A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.
    capture_method str
    Indicates when the funds will be captured from the customer's account.
    description str
    An arbitrary string attached to the object. Often useful for displaying to users.
    metadata Mapping[str, str]
    Set of key-value pairs that will set metadata on Payment Intents generated from this payment link.
    setup_future_usage str
    Indicates that you intend to make future payments with the payment method collected during checkout.
    statement_descriptor str
    For a non-card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge.
    statement_descriptor_suffix str
    For a card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. Concatenated with the account's statement descriptor prefix to form the complete statement descriptor.
    transfer_group str
    A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.
    captureMethod String
    Indicates when the funds will be captured from the customer's account.
    description String
    An arbitrary string attached to the object. Often useful for displaying to users.
    metadata Map<String>
    Set of key-value pairs that will set metadata on Payment Intents generated from this payment link.
    setupFutureUsage String
    Indicates that you intend to make future payments with the payment method collected during checkout.
    statementDescriptor String
    For a non-card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge.
    statementDescriptorSuffix String
    For a card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. Concatenated with the account's statement descriptor prefix to form the complete statement descriptor.
    transferGroup String
    A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.

    PaymentLinkPaymentMethodOptions, PaymentLinkPaymentMethodOptionsArgs

    Card PaymentLinkPaymentMethodOptionsCard
    Configuration for card payment methods.
    Card PaymentLinkPaymentMethodOptionsCard
    Configuration for card payment methods.
    card object
    Configuration for card payment methods.
    card PaymentLinkPaymentMethodOptionsCard
    Configuration for card payment methods.
    card PaymentLinkPaymentMethodOptionsCard
    Configuration for card payment methods.
    card PaymentLinkPaymentMethodOptionsCard
    Configuration for card payment methods.
    card Property Map
    Configuration for card payment methods.

    PaymentLinkPaymentMethodOptionsCard, PaymentLinkPaymentMethodOptionsCardArgs

    Restrictions PaymentLinkPaymentMethodOptionsCardRestrictions
    Restrictions to apply to the card payment method. For example, you can block specific card brands.
    Restrictions PaymentLinkPaymentMethodOptionsCardRestrictions
    Restrictions to apply to the card payment method. For example, you can block specific card brands.
    restrictions object
    Restrictions to apply to the card payment method. For example, you can block specific card brands.
    restrictions PaymentLinkPaymentMethodOptionsCardRestrictions
    Restrictions to apply to the card payment method. For example, you can block specific card brands.
    restrictions PaymentLinkPaymentMethodOptionsCardRestrictions
    Restrictions to apply to the card payment method. For example, you can block specific card brands.
    restrictions PaymentLinkPaymentMethodOptionsCardRestrictions
    Restrictions to apply to the card payment method. For example, you can block specific card brands.
    restrictions Property Map
    Restrictions to apply to the card payment method. For example, you can block specific card brands.

    PaymentLinkPaymentMethodOptionsCardRestrictions, PaymentLinkPaymentMethodOptionsCardRestrictionsArgs

    BrandsBlockeds List<string>
    The card brands to block. If a customer enters or selects a card belonging to a blocked brand, they can't complete the payment.
    BrandsBlockeds []string
    The card brands to block. If a customer enters or selects a card belonging to a blocked brand, they can't complete the payment.
    brands_blockeds list(string)
    The card brands to block. If a customer enters or selects a card belonging to a blocked brand, they can't complete the payment.
    brandsBlockeds List<String>
    The card brands to block. If a customer enters or selects a card belonging to a blocked brand, they can't complete the payment.
    brandsBlockeds string[]
    The card brands to block. If a customer enters or selects a card belonging to a blocked brand, they can't complete the payment.
    brands_blockeds Sequence[str]
    The card brands to block. If a customer enters or selects a card belonging to a blocked brand, they can't complete the payment.
    brandsBlockeds List<String>
    The card brands to block. If a customer enters or selects a card belonging to a blocked brand, they can't complete the payment.

    PaymentLinkPhoneNumberCollection, PaymentLinkPhoneNumberCollectionArgs

    Enabled bool
    If true, a phone number will be collected during checkout.
    Enabled bool
    If true, a phone number will be collected during checkout.
    enabled bool
    If true, a phone number will be collected during checkout.
    enabled Boolean
    If true, a phone number will be collected during checkout.
    enabled boolean
    If true, a phone number will be collected during checkout.
    enabled bool
    If true, a phone number will be collected during checkout.
    enabled Boolean
    If true, a phone number will be collected during checkout.

    PaymentLinkRestrictions, PaymentLinkRestrictionsArgs

    PaymentLinkRestrictionsCompletedSessions, PaymentLinkRestrictionsCompletedSessionsArgs

    Limit double
    The maximum number of checkout sessions that can be completed for the completed_sessions restriction to be met.
    Count double
    The current number of checkout sessions that have been completed on the payment link which count towards the completed_sessions restriction to be met.
    Limit float64
    The maximum number of checkout sessions that can be completed for the completed_sessions restriction to be met.
    Count float64
    The current number of checkout sessions that have been completed on the payment link which count towards the completed_sessions restriction to be met.
    limit number
    The maximum number of checkout sessions that can be completed for the completed_sessions restriction to be met.
    count number
    The current number of checkout sessions that have been completed on the payment link which count towards the completed_sessions restriction to be met.
    limit Double
    The maximum number of checkout sessions that can be completed for the completed_sessions restriction to be met.
    count Double
    The current number of checkout sessions that have been completed on the payment link which count towards the completed_sessions restriction to be met.
    limit number
    The maximum number of checkout sessions that can be completed for the completed_sessions restriction to be met.
    count number
    The current number of checkout sessions that have been completed on the payment link which count towards the completed_sessions restriction to be met.
    limit float
    The maximum number of checkout sessions that can be completed for the completed_sessions restriction to be met.
    count float
    The current number of checkout sessions that have been completed on the payment link which count towards the completed_sessions restriction to be met.
    limit Number
    The maximum number of checkout sessions that can be completed for the completed_sessions restriction to be met.
    count Number
    The current number of checkout sessions that have been completed on the payment link which count towards the completed_sessions restriction to be met.

    PaymentLinkShippingAddressCollection, PaymentLinkShippingAddressCollectionArgs

    AllowedCountries List<string>
    An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations. Unsupported country codes: AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI.
    AllowedCountries []string
    An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations. Unsupported country codes: AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI.
    allowed_countries list(string)
    An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations. Unsupported country codes: AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI.
    allowedCountries List<String>
    An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations. Unsupported country codes: AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI.
    allowedCountries string[]
    An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations. Unsupported country codes: AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI.
    allowed_countries Sequence[str]
    An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations. Unsupported country codes: AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI.
    allowedCountries List<String>
    An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations. Unsupported country codes: AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI.

    PaymentLinkShippingOption, PaymentLinkShippingOptionArgs

    ShippingAmount double
    A non-negative integer in cents representing how much to charge.
    ShippingRate string
    The ID of the Shipping Rate to use for this shipping option.
    ShippingAmount float64
    A non-negative integer in cents representing how much to charge.
    ShippingRate string
    The ID of the Shipping Rate to use for this shipping option.
    shipping_amount number
    A non-negative integer in cents representing how much to charge.
    shipping_rate string
    The ID of the Shipping Rate to use for this shipping option.
    shippingAmount Double
    A non-negative integer in cents representing how much to charge.
    shippingRate String
    The ID of the Shipping Rate to use for this shipping option.
    shippingAmount number
    A non-negative integer in cents representing how much to charge.
    shippingRate string
    The ID of the Shipping Rate to use for this shipping option.
    shipping_amount float
    A non-negative integer in cents representing how much to charge.
    shipping_rate str
    The ID of the Shipping Rate to use for this shipping option.
    shippingAmount Number
    A non-negative integer in cents representing how much to charge.
    shippingRate String
    The ID of the Shipping Rate to use for this shipping option.

    PaymentLinkSubscriptionData, PaymentLinkSubscriptionDataArgs

    Description string
    The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
    InvoiceSettings PaymentLinkSubscriptionDataInvoiceSettings
    Metadata Dictionary<string, string>
    Set of key-value pairs that will set metadata on Subscriptions generated from this payment link.
    TrialPeriodDays double
    Integer representing the number of trial period days before the customer is charged for the first time.
    TrialSettings PaymentLinkSubscriptionDataTrialSettings
    Settings related to subscription trials.
    Description string
    The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
    InvoiceSettings PaymentLinkSubscriptionDataInvoiceSettings
    Metadata map[string]string
    Set of key-value pairs that will set metadata on Subscriptions generated from this payment link.
    TrialPeriodDays float64
    Integer representing the number of trial period days before the customer is charged for the first time.
    TrialSettings PaymentLinkSubscriptionDataTrialSettings
    Settings related to subscription trials.
    description string
    The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
    invoice_settings object
    metadata map(string)
    Set of key-value pairs that will set metadata on Subscriptions generated from this payment link.
    trial_period_days number
    Integer representing the number of trial period days before the customer is charged for the first time.
    trial_settings object
    Settings related to subscription trials.
    description String
    The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
    invoiceSettings PaymentLinkSubscriptionDataInvoiceSettings
    metadata Map<String,String>
    Set of key-value pairs that will set metadata on Subscriptions generated from this payment link.
    trialPeriodDays Double
    Integer representing the number of trial period days before the customer is charged for the first time.
    trialSettings PaymentLinkSubscriptionDataTrialSettings
    Settings related to subscription trials.
    description string
    The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
    invoiceSettings PaymentLinkSubscriptionDataInvoiceSettings
    metadata {[key: string]: string}
    Set of key-value pairs that will set metadata on Subscriptions generated from this payment link.
    trialPeriodDays number
    Integer representing the number of trial period days before the customer is charged for the first time.
    trialSettings PaymentLinkSubscriptionDataTrialSettings
    Settings related to subscription trials.
    description str
    The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
    invoice_settings PaymentLinkSubscriptionDataInvoiceSettings
    metadata Mapping[str, str]
    Set of key-value pairs that will set metadata on Subscriptions generated from this payment link.
    trial_period_days float
    Integer representing the number of trial period days before the customer is charged for the first time.
    trial_settings PaymentLinkSubscriptionDataTrialSettings
    Settings related to subscription trials.
    description String
    The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
    invoiceSettings Property Map
    metadata Map<String>
    Set of key-value pairs that will set metadata on Subscriptions generated from this payment link.
    trialPeriodDays Number
    Integer representing the number of trial period days before the customer is charged for the first time.
    trialSettings Property Map
    Settings related to subscription trials.

    PaymentLinkSubscriptionDataInvoiceSettings, PaymentLinkSubscriptionDataInvoiceSettingsArgs

    PaymentLinkSubscriptionDataInvoiceSettingsIssuer, PaymentLinkSubscriptionDataInvoiceSettingsIssuerArgs

    Type string
    Type of the account referenced.
    Account string
    The connected account being referenced when type is account.
    Type string
    Type of the account referenced.
    Account string
    The connected account being referenced when type is account.
    type string
    Type of the account referenced.
    account string
    The connected account being referenced when type is account.
    type String
    Type of the account referenced.
    account String
    The connected account being referenced when type is account.
    type string
    Type of the account referenced.
    account string
    The connected account being referenced when type is account.
    type str
    Type of the account referenced.
    account str
    The connected account being referenced when type is account.
    type String
    Type of the account referenced.
    account String
    The connected account being referenced when type is account.

    PaymentLinkSubscriptionDataTrialSettings, PaymentLinkSubscriptionDataTrialSettingsArgs

    EndBehavior PaymentLinkSubscriptionDataTrialSettingsEndBehavior
    Defines how a subscription behaves when a free trial ends.
    EndBehavior PaymentLinkSubscriptionDataTrialSettingsEndBehavior
    Defines how a subscription behaves when a free trial ends.
    end_behavior object
    Defines how a subscription behaves when a free trial ends.
    endBehavior PaymentLinkSubscriptionDataTrialSettingsEndBehavior
    Defines how a subscription behaves when a free trial ends.
    endBehavior PaymentLinkSubscriptionDataTrialSettingsEndBehavior
    Defines how a subscription behaves when a free trial ends.
    end_behavior PaymentLinkSubscriptionDataTrialSettingsEndBehavior
    Defines how a subscription behaves when a free trial ends.
    endBehavior Property Map
    Defines how a subscription behaves when a free trial ends.

    PaymentLinkSubscriptionDataTrialSettingsEndBehavior, PaymentLinkSubscriptionDataTrialSettingsEndBehaviorArgs

    MissingPaymentMethod string
    Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
    MissingPaymentMethod string
    Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
    missing_payment_method string
    Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
    missingPaymentMethod String
    Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
    missingPaymentMethod string
    Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
    missing_payment_method str
    Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
    missingPaymentMethod String
    Indicates how the subscription should change when the trial ends if the user did not provide a payment method.

    PaymentLinkTaxIdCollection, PaymentLinkTaxIdCollectionArgs

    Enabled bool
    Indicates whether tax ID collection is enabled for the session.
    Required string
    Enabled bool
    Indicates whether tax ID collection is enabled for the session.
    Required string
    enabled bool
    Indicates whether tax ID collection is enabled for the session.
    required string
    enabled Boolean
    Indicates whether tax ID collection is enabled for the session.
    required String
    enabled boolean
    Indicates whether tax ID collection is enabled for the session.
    required string
    enabled bool
    Indicates whether tax ID collection is enabled for the session.
    required str
    enabled Boolean
    Indicates whether tax ID collection is enabled for the session.
    required String

    PaymentLinkTransferData, PaymentLinkTransferDataArgs

    Destination string
    The connected account receiving the transfer.
    Amount double
    The amount in cents (or local equivalent) that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
    Destination string
    The connected account receiving the transfer.
    Amount float64
    The amount in cents (or local equivalent) that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
    destination string
    The connected account receiving the transfer.
    amount number
    The amount in cents (or local equivalent) that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
    destination String
    The connected account receiving the transfer.
    amount Double
    The amount in cents (or local equivalent) that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
    destination string
    The connected account receiving the transfer.
    amount number
    The amount in cents (or local equivalent) that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
    destination str
    The connected account receiving the transfer.
    amount float
    The amount in cents (or local equivalent) that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
    destination String
    The connected account receiving the transfer.
    amount Number
    The amount in cents (or local equivalent) that will be transferred to the destination account. By default, the entire amount is transferred to the destination.

    Package Details

    Repository
    stripe stripe/terraform-provider-stripe
    License
    Notes
    This Pulumi package is based on the stripe Terraform Provider.
    Viewing docs for Stripe 0.3.0
    published on Friday, Aug 14, 2026 by Pulumi
    Schema (JSON)
    stripe/terraform-provider-stripe

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial