stripe / stripe-go / 11296113556

//

//

// File generated from our OpenAPI spec

//

//

package stripe

import "encoding/json"

// The specified behavior after the purchase is complete.

type PaymentLinkAfterCompletionType string

// List of values that PaymentLinkAfterCompletionType can take

const (

        PaymentLinkAfterCompletionTypeHostedConfirmation PaymentLinkAfterCompletionType = "hosted_confirmation"

        PaymentLinkAfterCompletionTypeRedirect           PaymentLinkAfterCompletionType = "redirect"

)

// Type of the account referenced.

type PaymentLinkAutomaticTaxLiabilityType string

// List of values that PaymentLinkAutomaticTaxLiabilityType can take

const (

        PaymentLinkAutomaticTaxLiabilityTypeAccount PaymentLinkAutomaticTaxLiabilityType = "account"

        PaymentLinkAutomaticTaxLiabilityTypeSelf    PaymentLinkAutomaticTaxLiabilityType = "self"

)

// Configuration for collecting the customer's billing address. Defaults to `auto`.

type PaymentLinkBillingAddressCollection string

// List of values that PaymentLinkBillingAddressCollection can take

const (

        PaymentLinkBillingAddressCollectionAuto     PaymentLinkBillingAddressCollection = "auto"

        PaymentLinkBillingAddressCollectionRequired PaymentLinkBillingAddressCollection = "required"

)

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

//

// When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.

type PaymentLinkConsentCollectionPaymentMethodReuseAgreementPosition string

// List of values that PaymentLinkConsentCollectionPaymentMethodReuseAgreementPosition can take

const (

        PaymentLinkConsentCollectionPaymentMethodReuseAgreementPositionAuto   PaymentLinkConsentCollectionPaymentMethodReuseAgreementPosition = "auto"

        PaymentLinkConsentCollectionPaymentMethodReuseAgreementPositionHidden PaymentLinkConsentCollectionPaymentMethodReuseAgreementPosition = "hidden"

)

// If set to `auto`, enables the collection of customer consent for promotional communications.

type PaymentLinkConsentCollectionPromotions string

// List of values that PaymentLinkConsentCollectionPromotions can take

const (

        PaymentLinkConsentCollectionPromotionsAuto PaymentLinkConsentCollectionPromotions = "auto"

        PaymentLinkConsentCollectionPromotionsNone PaymentLinkConsentCollectionPromotions = "none"

)

// 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.

type PaymentLinkConsentCollectionTermsOfService string

// List of values that PaymentLinkConsentCollectionTermsOfService can take

const (

        PaymentLinkConsentCollectionTermsOfServiceNone     PaymentLinkConsentCollectionTermsOfService = "none"

        PaymentLinkConsentCollectionTermsOfServiceRequired PaymentLinkConsentCollectionTermsOfService = "required"

)

// The type of the label.

type PaymentLinkCustomFieldLabelType string

// List of values that PaymentLinkCustomFieldLabelType can take

const (

        PaymentLinkCustomFieldLabelTypeCustom PaymentLinkCustomFieldLabelType = "custom"

)

// The type of the field.

type PaymentLinkCustomFieldType string

// List of values that PaymentLinkCustomFieldType can take

const (

        PaymentLinkCustomFieldTypeDropdown PaymentLinkCustomFieldType = "dropdown"

        PaymentLinkCustomFieldTypeNumeric  PaymentLinkCustomFieldType = "numeric"

        PaymentLinkCustomFieldTypeText     PaymentLinkCustomFieldType = "text"

)

// Configuration for Customer creation during checkout.

type PaymentLinkCustomerCreation string

// List of values that PaymentLinkCustomerCreation can take

const (

        PaymentLinkCustomerCreationAlways     PaymentLinkCustomerCreation = "always"

        PaymentLinkCustomerCreationIfRequired PaymentLinkCustomerCreation = "if_required"

)

// Type of the account referenced.

type PaymentLinkInvoiceCreationInvoiceDataIssuerType string

// List of values that PaymentLinkInvoiceCreationInvoiceDataIssuerType can take

const (

        PaymentLinkInvoiceCreationInvoiceDataIssuerTypeAccount PaymentLinkInvoiceCreationInvoiceDataIssuerType = "account"

        PaymentLinkInvoiceCreationInvoiceDataIssuerTypeSelf    PaymentLinkInvoiceCreationInvoiceDataIssuerType = "self"

)

// Indicates when the funds will be captured from the customer's account.

type PaymentLinkPaymentIntentDataCaptureMethod string

// List of values that PaymentLinkPaymentIntentDataCaptureMethod can take

const (

        PaymentLinkPaymentIntentDataCaptureMethodAutomatic      PaymentLinkPaymentIntentDataCaptureMethod = "automatic"

        PaymentLinkPaymentIntentDataCaptureMethodAutomaticAsync PaymentLinkPaymentIntentDataCaptureMethod = "automatic_async"

        PaymentLinkPaymentIntentDataCaptureMethodManual         PaymentLinkPaymentIntentDataCaptureMethod = "manual"

)

// Indicates that you intend to make future payments with the payment method collected during checkout.

type PaymentLinkPaymentIntentDataSetupFutureUsage string

// List of values that PaymentLinkPaymentIntentDataSetupFutureUsage can take

const (

        PaymentLinkPaymentIntentDataSetupFutureUsageOffSession PaymentLinkPaymentIntentDataSetupFutureUsage = "off_session"

        PaymentLinkPaymentIntentDataSetupFutureUsageOnSession  PaymentLinkPaymentIntentDataSetupFutureUsage = "on_session"

)

// Configuration for collecting a payment method during checkout. Defaults to `always`.

type PaymentLinkPaymentMethodCollection string

// List of values that PaymentLinkPaymentMethodCollection can take

const (

        PaymentLinkPaymentMethodCollectionAlways     PaymentLinkPaymentMethodCollection = "always"

        PaymentLinkPaymentMethodCollectionIfRequired PaymentLinkPaymentMethodCollection = "if_required"

)

// 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](https://dashboard.stripe.com/settings/payment_methods).

type PaymentLinkPaymentMethodType string

// List of values that PaymentLinkPaymentMethodType can take

const (

        PaymentLinkPaymentMethodTypeAffirm           PaymentLinkPaymentMethodType = "affirm"

        PaymentLinkPaymentMethodTypeAfterpayClearpay PaymentLinkPaymentMethodType = "afterpay_clearpay"

        PaymentLinkPaymentMethodTypeAlipay           PaymentLinkPaymentMethodType = "alipay"

        PaymentLinkPaymentMethodTypeAUBECSDebit      PaymentLinkPaymentMethodType = "au_becs_debit"

        PaymentLinkPaymentMethodTypeBACSDebit        PaymentLinkPaymentMethodType = "bacs_debit"

        PaymentLinkPaymentMethodTypeBancontact       PaymentLinkPaymentMethodType = "bancontact"

        PaymentLinkPaymentMethodTypeBLIK             PaymentLinkPaymentMethodType = "blik"

        PaymentLinkPaymentMethodTypeBoleto           PaymentLinkPaymentMethodType = "boleto"

        PaymentLinkPaymentMethodTypeCard             PaymentLinkPaymentMethodType = "card"

        PaymentLinkPaymentMethodTypeCashApp          PaymentLinkPaymentMethodType = "cashapp"

        PaymentLinkPaymentMethodTypeEPS              PaymentLinkPaymentMethodType = "eps"

        PaymentLinkPaymentMethodTypeFPX              PaymentLinkPaymentMethodType = "fpx"

        PaymentLinkPaymentMethodTypeGiropay          PaymentLinkPaymentMethodType = "giropay"

        PaymentLinkPaymentMethodTypeGrabpay          PaymentLinkPaymentMethodType = "grabpay"

        PaymentLinkPaymentMethodTypeIDEAL            PaymentLinkPaymentMethodType = "ideal"

        PaymentLinkPaymentMethodTypeKlarna           PaymentLinkPaymentMethodType = "klarna"

        PaymentLinkPaymentMethodTypeKonbini          PaymentLinkPaymentMethodType = "konbini"

        PaymentLinkPaymentMethodTypeLink             PaymentLinkPaymentMethodType = "link"

        PaymentLinkPaymentMethodTypeMbWay            PaymentLinkPaymentMethodType = "mb_way"

        PaymentLinkPaymentMethodTypeMobilepay        PaymentLinkPaymentMethodType = "mobilepay"

        PaymentLinkPaymentMethodTypeMultibanco       PaymentLinkPaymentMethodType = "multibanco"

        PaymentLinkPaymentMethodTypeOXXO             PaymentLinkPaymentMethodType = "oxxo"

        PaymentLinkPaymentMethodTypeP24              PaymentLinkPaymentMethodType = "p24"

        PaymentLinkPaymentMethodTypePayNow           PaymentLinkPaymentMethodType = "paynow"

        PaymentLinkPaymentMethodTypePaypal           PaymentLinkPaymentMethodType = "paypal"

        PaymentLinkPaymentMethodTypePayto            PaymentLinkPaymentMethodType = "payto"

        PaymentLinkPaymentMethodTypePix              PaymentLinkPaymentMethodType = "pix"

        PaymentLinkPaymentMethodTypePromptPay        PaymentLinkPaymentMethodType = "promptpay"

        PaymentLinkPaymentMethodTypeRechnung         PaymentLinkPaymentMethodType = "rechnung"

        PaymentLinkPaymentMethodTypeSEPADebit        PaymentLinkPaymentMethodType = "sepa_debit"

        PaymentLinkPaymentMethodTypeSofort           PaymentLinkPaymentMethodType = "sofort"

        PaymentLinkPaymentMethodTypeSwish            PaymentLinkPaymentMethodType = "swish"

        PaymentLinkPaymentMethodTypeTWINT            PaymentLinkPaymentMethodType = "twint"

        PaymentLinkPaymentMethodTypeUSBankAccount    PaymentLinkPaymentMethodType = "us_bank_account"

        PaymentLinkPaymentMethodTypeWeChatPay        PaymentLinkPaymentMethodType = "wechat_pay"

        PaymentLinkPaymentMethodTypeZip              PaymentLinkPaymentMethodType = "zip"

)

// Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.

type PaymentLinkSubmitType string

// List of values that PaymentLinkSubmitType can take

const (

        PaymentLinkSubmitTypeAuto   PaymentLinkSubmitType = "auto"

        PaymentLinkSubmitTypeBook   PaymentLinkSubmitType = "book"

        PaymentLinkSubmitTypeDonate PaymentLinkSubmitType = "donate"

        PaymentLinkSubmitTypePay    PaymentLinkSubmitType = "pay"

)

// Type of the account referenced.

type PaymentLinkSubscriptionDataInvoiceSettingsIssuerType string

// List of values that PaymentLinkSubscriptionDataInvoiceSettingsIssuerType can take

const (

        PaymentLinkSubscriptionDataInvoiceSettingsIssuerTypeAccount PaymentLinkSubscriptionDataInvoiceSettingsIssuerType = "account"

        PaymentLinkSubscriptionDataInvoiceSettingsIssuerTypeSelf    PaymentLinkSubscriptionDataInvoiceSettingsIssuerType = "self"

)

// Indicates how the subscription should change when the trial ends if the user did not provide a payment method.

type PaymentLinkSubscriptionDataTrialSettingsEndBehaviorMissingPaymentMethod string

// List of values that PaymentLinkSubscriptionDataTrialSettingsEndBehaviorMissingPaymentMethod can take

const (

        PaymentLinkSubscriptionDataTrialSettingsEndBehaviorMissingPaymentMethodCancel        PaymentLinkSubscriptionDataTrialSettingsEndBehaviorMissingPaymentMethod = "cancel"

        PaymentLinkSubscriptionDataTrialSettingsEndBehaviorMissingPaymentMethodCreateInvoice PaymentLinkSubscriptionDataTrialSettingsEndBehaviorMissingPaymentMethod = "create_invoice"

        PaymentLinkSubscriptionDataTrialSettingsEndBehaviorMissingPaymentMethodPause         PaymentLinkSubscriptionDataTrialSettingsEndBehaviorMissingPaymentMethod = "pause"

)

type PaymentLinkTaxIDCollectionRequired string

// List of values that PaymentLinkTaxIDCollectionRequired can take

const (

        PaymentLinkTaxIDCollectionRequiredIfSupported PaymentLinkTaxIDCollectionRequired = "if_supported"

        PaymentLinkTaxIDCollectionRequiredNever       PaymentLinkTaxIDCollectionRequired = "never"

)

// Returns a list of your payment links.

type PaymentLinkListParams struct {

        ListParams `form:"*"`

        // Only return payment links that are active or inactive (e.g., pass `false` to list all inactive payment links).

        Active *bool `form:"active"`

        // Specifies which fields in the response should be expanded.

        Expand []*string `form:"expand"`

}

// AddExpand appends a new field to expand.

// Configuration when `type=hosted_confirmation`.

type PaymentLinkAfterCompletionHostedConfirmationParams struct {

        // A custom message to display to the customer after the purchase is complete.

        CustomMessage *string `form:"custom_message"`

}

// Configuration when `type=redirect`.

type PaymentLinkAfterCompletionRedirectParams struct {

        // The URL the customer will be redirected to after the purchase is complete. You can embed `{CHECKOUT_SESSION_ID}` into the URL to have the `id` of the completed [checkout session](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-id) included.

        URL *string `form:"url"`

}

// Behavior after the purchase is complete.

type PaymentLinkAfterCompletionParams struct {

        // Configuration when `type=hosted_confirmation`.

        HostedConfirmation *PaymentLinkAfterCompletionHostedConfirmationParams `form:"hosted_confirmation"`

        // Configuration when `type=redirect`.

        Redirect *PaymentLinkAfterCompletionRedirectParams `form:"redirect"`

        // The specified behavior after the purchase is complete. Either `redirect` or `hosted_confirmation`.

        Type *string `form:"type"`

}

// 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.

type PaymentLinkAutomaticTaxLiabilityParams struct {

        // The connected account being referenced when `type` is `account`.

        Account *string `form:"account"`

        // Type of the account referenced in the request.

        Type *string `form:"type"`

}

// Configuration for automatic tax collection.

type PaymentLinkAutomaticTaxParams struct {

        // If `true`, tax will be calculated automatically using the customer's location.

        Enabled *bool `form:"enabled"`

        // 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.

        Liability *PaymentLinkAutomaticTaxLiabilityParams `form:"liability"`

}

// Determines the display of payment method reuse agreement text in the UI. If set to `hidden`, it will hide legal text related to the reuse of a payment method.

type PaymentLinkConsentCollectionPaymentMethodReuseAgreementParams struct {

        // Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's

        // defaults will be used. When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.

        Position *string `form:"position"`

}

// Configure fields to gather active consent from customers.

type PaymentLinkConsentCollectionParams struct {

        // Determines the display of payment method reuse agreement text in the UI. If set to `hidden`, it will hide legal text related to the reuse of a payment method.

        PaymentMethodReuseAgreement *PaymentLinkConsentCollectionPaymentMethodReuseAgreementParams `form:"payment_method_reuse_agreement"`

        // If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout

        // Session will determine whether to display an option to opt into promotional communication

        // from the merchant depending on the customer's locale. Only available to US merchants.

        Promotions *string `form:"promotions"`

        // If set to `required`, it requires customers to check a terms of service checkbox before being able to pay.

        // There must be a valid terms of service URL set in your [Dashboard settings](https://dashboard.stripe.com/settings/public).

        TermsOfService *string `form:"terms_of_service"`

}

// The options available for the customer to select. Up to 200 options allowed.

type PaymentLinkCustomFieldDropdownOptionParams struct {

        // The label for the option, displayed to the customer. Up to 100 characters.

        Label *string `form:"label"`

        // 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.

        Value *string `form:"value"`

}

// Configuration for `type=dropdown` fields.

type PaymentLinkCustomFieldDropdownParams struct {

        // The options available for the customer to select. Up to 200 options allowed.

        Options []*PaymentLinkCustomFieldDropdownOptionParams `form:"options"`

}

// The label for the field, displayed to the customer.

type PaymentLinkCustomFieldLabelParams struct {

        // Custom text for the label, displayed to the customer. Up to 50 characters.

        Custom *string `form:"custom"`

        // The type of the label.

        Type *string `form:"type"`

}

// Configuration for `type=numeric` fields.

type PaymentLinkCustomFieldNumericParams struct {

        // The maximum character length constraint for the customer's input.

        MaximumLength *int64 `form:"maximum_length"`

        // The minimum character length requirement for the customer's input.

        MinimumLength *int64 `form:"minimum_length"`

}

// Configuration for `type=text` fields.

type PaymentLinkCustomFieldTextParams struct {

        // The maximum character length constraint for the customer's input.

        MaximumLength *int64 `form:"maximum_length"`

        // The minimum character length requirement for the customer's input.

        MinimumLength *int64 `form:"minimum_length"`

}

// Collect additional information from your customer using custom fields. Up to 3 fields are supported.

type PaymentLinkCustomFieldParams struct {

        // Configuration for `type=dropdown` fields.

        Dropdown *PaymentLinkCustomFieldDropdownParams `form:"dropdown"`

        // 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.

        Key *string `form:"key"`

        // The label for the field, displayed to the customer.

        Label *PaymentLinkCustomFieldLabelParams `form:"label"`

        // Configuration for `type=numeric` fields.

        Numeric *PaymentLinkCustomFieldNumericParams `form:"numeric"`

        // Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.

        Optional *bool `form:"optional"`

        // Configuration for `type=text` fields.

        Text *PaymentLinkCustomFieldTextParams `form:"text"`

        // The type of the field.

        Type *string `form:"type"`

}

// Custom text that should be displayed after the payment confirmation button.

type PaymentLinkCustomTextAfterSubmitParams struct {

        // Text may be up to 1200 characters in length.

        Message *string `form:"message"`

}

// Custom text that should be displayed alongside shipping address collection.

type PaymentLinkCustomTextShippingAddressParams struct {

        // Text may be up to 1200 characters in length.

        Message *string `form:"message"`

}

// Custom text that should be displayed alongside the payment confirmation button.

type PaymentLinkCustomTextSubmitParams struct {

        // Text may be up to 1200 characters in length.

        Message *string `form:"message"`

}

// Custom text that should be displayed in place of the default terms of service agreement text.

type PaymentLinkCustomTextTermsOfServiceAcceptanceParams struct {

        // Text may be up to 1200 characters in length.

        Message *string `form:"message"`

}

// Display additional text for your customers using custom text.

type PaymentLinkCustomTextParams struct {

        // Custom text that should be displayed after the payment confirmation button.

        AfterSubmit *PaymentLinkCustomTextAfterSubmitParams `form:"after_submit"`

        // Custom text that should be displayed alongside shipping address collection.

        ShippingAddress *PaymentLinkCustomTextShippingAddressParams `form:"shipping_address"`

        // Custom text that should be displayed alongside the payment confirmation button.

        Submit *PaymentLinkCustomTextSubmitParams `form:"submit"`

        // Custom text that should be displayed in place of the default terms of service agreement text.

        TermsOfServiceAcceptance *PaymentLinkCustomTextTermsOfServiceAcceptanceParams `form:"terms_of_service_acceptance"`

}

// Default custom fields to be displayed on invoices for this customer.

type PaymentLinkInvoiceCreationInvoiceDataCustomFieldParams struct {

        // The name of the custom field. This may be up to 40 characters.

        Name *string `form:"name"`

        // The value of the custom field. This may be up to 140 characters.

        Value *string `form:"value"`

}

// The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.

type PaymentLinkInvoiceCreationInvoiceDataIssuerParams struct {

        // The connected account being referenced when `type` is `account`.

        Account *string `form:"account"`

        // Type of the account referenced in the request.

        Type *string `form:"type"`

}

// Default options for invoice PDF rendering for this customer.

type PaymentLinkInvoiceCreationInvoiceDataRenderingOptionsParams struct {

        // How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.

        AmountTaxDisplay *string `form:"amount_tax_display"`

}

// Invoice PDF configuration.

type PaymentLinkInvoiceCreationInvoiceDataParams struct {

        // The account tax IDs associated with the invoice.

        AccountTaxIDs []*string `form:"account_tax_ids"`

        // Default custom fields to be displayed on invoices for this customer.

        CustomFields []*PaymentLinkInvoiceCreationInvoiceDataCustomFieldParams `form:"custom_fields"`

        // An arbitrary string attached to the object. Often useful for displaying to users.

        Description *string `form:"description"`

        // Default footer to be displayed on invoices for this customer.

        Footer *string `form:"footer"`

        // The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.

        Issuer *PaymentLinkInvoiceCreationInvoiceDataIssuerParams `form:"issuer"`

        // Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.

        Metadata map[string]string `form:"metadata"`

        // Default options for invoice PDF rendering for this customer.

        RenderingOptions *PaymentLinkInvoiceCreationInvoiceDataRenderingOptionsParams `form:"rendering_options"`

}

// AddMetadata adds a new key-value pair to the Metadata.

}

// Generate a post-purchase Invoice for one-time payments.

type PaymentLinkInvoiceCreationParams struct {

        // Whether the feature is enabled

        Enabled *bool `form:"enabled"`

        // Invoice PDF configuration.

        InvoiceData *PaymentLinkInvoiceCreationInvoiceDataParams `form:"invoice_data"`

}

// When set, provides configuration for this item's quantity to be adjusted by the customer during checkout.

type PaymentLinkLineItemAdjustableQuantityParams struct {

        // Set to true if the quantity can be adjusted to any non-negative Integer.

        Enabled *bool `form:"enabled"`

        // The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999.

        Maximum *int64 `form:"maximum"`

        // 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.

        Minimum *int64 `form:"minimum"`

}

// The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.

type PaymentLinkLineItemParams struct {

        // When set, provides configuration for this item's quantity to be adjusted by the customer during checkout.

        AdjustableQuantity *PaymentLinkLineItemAdjustableQuantityParams `form:"adjustable_quantity"`

        // The ID of an existing line item on the payment link.

        ID *string `form:"id"`

        // The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object.

        Price *string `form:"price"`

        // The quantity of the line item being purchased.

        Quantity *int64 `form:"quantity"`

}

// A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.

type PaymentLinkPaymentIntentDataParams struct {

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

        CaptureMethod *string `form:"capture_method"`

        // An arbitrary string attached to the object. Often useful for displaying to users.

        Description *string `form:"description"`

        // Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Payment Intents](https://stripe.com/docs/api/payment_intents) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.

        Metadata map[string]string `form:"metadata"`

        // Indicates that you intend to [make future payments](https://stripe.com/docs/payments/payment-intents#future-usage) with the payment method collected by this Checkout Session.

        //

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

        //

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

        //

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

        //

        // If Checkout does not create a Customer, the payment method is not attached to a Customer. To reuse the payment method, you can retrieve it from the Checkout Session's PaymentIntent.

        //

        // When processing card payments, Checkout also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.

        SetupFutureUsage *string `form:"setup_future_usage"`

        // Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).

        //

        // Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.

        StatementDescriptor *string `form:"statement_descriptor"`

        // Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.

        StatementDescriptorSuffix *string `form:"statement_descriptor_suffix"`

        // A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.

        TransferGroup *string `form:"transfer_group"`

}

// AddMetadata adds a new key-value pair to the Metadata.

}

// Controls phone number collection settings during checkout.

//

// We recommend that you review your privacy policy and check with your legal contacts.

type PaymentLinkPhoneNumberCollectionParams struct {

        // Set to `true` to enable phone number collection.

        Enabled *bool `form:"enabled"`

}

// Configuration for the `completed_sessions` restriction type.

type PaymentLinkRestrictionsCompletedSessionsParams struct {

        // The maximum number of checkout sessions that can be completed for the `completed_sessions` restriction to be met.

        Limit *int64 `form:"limit"`

}

// Settings that restrict the usage of a payment link.

type PaymentLinkRestrictionsParams struct {

        // Configuration for the `completed_sessions` restriction type.

        CompletedSessions *PaymentLinkRestrictionsCompletedSessionsParams `form:"completed_sessions"`

}

// Configuration for collecting the customer's shipping address.

type PaymentLinkShippingAddressCollectionParams struct {

        // 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 `form:"allowed_countries"`

}

// The shipping rate options to apply to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link.

type PaymentLinkShippingOptionParams struct {

        // The ID of the Shipping Rate to use for this shipping option.

        ShippingRate *string `form:"shipping_rate"`

}

// The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.

type PaymentLinkSubscriptionDataInvoiceSettingsIssuerParams struct {

        // The connected account being referenced when `type` is `account`.

        Account *string `form:"account"`

        // Type of the account referenced in the request.

        Type *string `form:"type"`

}

// All invoices will be billed using the specified settings.

type PaymentLinkSubscriptionDataInvoiceSettingsParams struct {

        // The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.

        Issuer *PaymentLinkSubscriptionDataInvoiceSettingsIssuerParams `form:"issuer"`

}

// Defines how the subscription should behave when the user's free trial ends.

type PaymentLinkSubscriptionDataTrialSettingsEndBehaviorParams struct {

        // Indicates how the subscription should change when the trial ends if the user did not provide a payment method.

        MissingPaymentMethod *string `form:"missing_payment_method"`

}

// Settings related to subscription trials.

type PaymentLinkSubscriptionDataTrialSettingsParams struct {

        // Defines how the subscription should behave when the user's free trial ends.

        EndBehavior *PaymentLinkSubscriptionDataTrialSettingsEndBehaviorParams `form:"end_behavior"`

}

// 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`.

type PaymentLinkSubscriptionDataParams struct {

        // 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.

        Description *string `form:"description"`

        // All invoices will be billed using the specified settings.

        InvoiceSettings *PaymentLinkSubscriptionDataInvoiceSettingsParams `form:"invoice_settings"`

        // Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.

        Metadata map[string]string `form:"metadata"`

        // Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.

        TrialPeriodDays *int64 `form:"trial_period_days"`

        // Settings related to subscription trials.

        TrialSettings *PaymentLinkSubscriptionDataTrialSettingsParams `form:"trial_settings"`

}

// AddMetadata adds a new key-value pair to the Metadata.

}

// Controls tax ID collection during checkout.

type PaymentLinkTaxIDCollectionParams struct {

        // Enable tax ID collection during checkout. Defaults to `false`.

        Enabled *bool `form:"enabled"`

        // Describes whether a tax ID is required during checkout. Defaults to `never`.

        Required *string `form:"required"`

}

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

type PaymentLinkTransferDataParams struct {

        // The amount that will be transferred automatically when a charge succeeds.

        Amount *int64 `form:"amount"`

        // If specified, successful charges will be attributed to the destination

        // account for tax reporting, and the funds from charges will be transferred

        // to the destination account. The ID of the resulting transfer will be

        // returned on the successful charge's `transfer` field.

        Destination *string `form:"destination"`

}

// Creates a payment link.

type PaymentLinkParams struct {

        Params `form:"*"`

        // 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.

        Active *bool `form:"active"`

        // Behavior after the purchase is complete.

        AfterCompletion *PaymentLinkAfterCompletionParams `form:"after_completion"`

        // Enables user redeemable promotion codes.

        AllowPromotionCodes *bool `form:"allow_promotion_codes"`

        // 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. Can only be applied when there are no line items with recurring prices.

        ApplicationFeeAmount *int64 `form:"application_fee_amount"`

        // A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field.

        ApplicationFeePercent *float64 `form:"application_fee_percent"`

        // Configuration for automatic tax collection.

        AutomaticTax *PaymentLinkAutomaticTaxParams `form:"automatic_tax"`

        // Configuration for collecting the customer's billing address. Defaults to `auto`.

        BillingAddressCollection *string `form:"billing_address_collection"`

        // Configure fields to gather active consent from customers.

        ConsentCollection *PaymentLinkConsentCollectionParams `form:"consent_collection"`

        // Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies) and supported by each line item's price.

        Currency *string `form:"currency"`

        // Configures whether [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link create a [Customer](https://stripe.com/docs/api/customers).

        CustomerCreation *string `form:"customer_creation"`

        // Collect additional information from your customer using custom fields. Up to 3 fields are supported.

        CustomFields []*PaymentLinkCustomFieldParams `form:"custom_fields"`

        // Display additional text for your customers using custom text.

        CustomText *PaymentLinkCustomTextParams `form:"custom_text"`

        // Specifies which fields in the response should be expanded.

        Expand []*string `form:"expand"`

        // The custom message to be displayed to a customer when a payment link is no longer active.

        InactiveMessage *string `form:"inactive_message"`

        // Generate a post-purchase Invoice for one-time payments.

        InvoiceCreation *PaymentLinkInvoiceCreationParams `form:"invoice_creation"`

        // The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.

        LineItems []*PaymentLinkLineItemParams `form:"line_items"`

        // Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link.

        Metadata map[string]string `form:"metadata"`

        // The account on behalf of which to charge.

        OnBehalfOf *string `form:"on_behalf_of"`

        // A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.

        PaymentIntentData *PaymentLinkPaymentIntentDataParams `form:"payment_intent_data"`

        // Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.

        //

        // Can only be set in `subscription` mode. Defaults to `always`.

        //

        // If you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).

        PaymentMethodCollection *string `form:"payment_method_collection"`

        // The list of payment method types that customers can use. If no value is passed, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods) (20+ payment methods [supported](https://stripe.com/docs/payments/payment-methods/integration-options#payment-method-product-support)).

        PaymentMethodTypes []*string `form:"payment_method_types"`

        // Controls phone number collection settings during checkout.

        //

        // We recommend that you review your privacy policy and check with your legal contacts.

        PhoneNumberCollection *PaymentLinkPhoneNumberCollectionParams `form:"phone_number_collection"`

        // Settings that restrict the usage of a payment link.

        Restrictions *PaymentLinkRestrictionsParams `form:"restrictions"`

        // Configuration for collecting the customer's shipping address.

        ShippingAddressCollection *PaymentLinkShippingAddressCollectionParams `form:"shipping_address_collection"`

        // The shipping rate options to apply to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link.

        ShippingOptions []*PaymentLinkShippingOptionParams `form:"shipping_options"`

        // Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](https://stripe.com/docs/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`).

        SubmitType *string `form:"submit_type"`

        // 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`.

        SubscriptionData *PaymentLinkSubscriptionDataParams `form:"subscription_data"`

        // Controls tax ID collection during checkout.

        TaxIDCollection *PaymentLinkTaxIDCollectionParams `form:"tax_id_collection"`

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

        TransferData *PaymentLinkTransferDataParams `form:"transfer_data"`

}

// AddExpand appends a new field to expand.

// AddMetadata adds a new key-value pair to the Metadata.

}

// When retrieving a payment link, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

type PaymentLinkListLineItemsParams struct {

        ListParams  `form:"*"`

        PaymentLink *string `form:"-"` // Included in URL

        // Specifies which fields in the response should be expanded.

        Expand []*string `form:"expand"`

}

// AddExpand appends a new field to expand.

type PaymentLinkAfterCompletionHostedConfirmation struct {

        // The custom message that is displayed to the customer after the purchase is complete.

        CustomMessage string `json:"custom_message"`

}

type PaymentLinkAfterCompletionRedirect struct {

        // The URL the customer will be redirected to after the purchase is complete.

        URL string `json:"url"`

}

type PaymentLinkAfterCompletion struct {

        HostedConfirmation *PaymentLinkAfterCompletionHostedConfirmation `json:"hosted_confirmation"`

        Redirect           *PaymentLinkAfterCompletionRedirect           `json:"redirect"`

        // The specified behavior after the purchase is complete.

        Type PaymentLinkAfterCompletionType `json:"type"`

}

// 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.

type PaymentLinkAutomaticTaxLiability struct {

        // The connected account being referenced when `type` is `account`.

        Account *Account `json:"account"`

        // Type of the account referenced.

        Type PaymentLinkAutomaticTaxLiabilityType `json:"type"`

}

type PaymentLinkAutomaticTax struct {

        // If `true`, tax will be calculated automatically using the customer's location.

        Enabled bool `json:"enabled"`

        // 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.

        Liability *PaymentLinkAutomaticTaxLiability `json:"liability"`

}

// Settings related to the payment method reuse text shown in the Checkout UI.

type PaymentLinkConsentCollectionPaymentMethodReuseAgreement struct {

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

        //

        // When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.

        Position PaymentLinkConsentCollectionPaymentMethodReuseAgreementPosition `json:"position"`

}

// When set, provides configuration to gather active consent from customers.

type PaymentLinkConsentCollection struct {

        // Settings related to the payment method reuse text shown in the Checkout UI.

        PaymentMethodReuseAgreement *PaymentLinkConsentCollectionPaymentMethodReuseAgreement `json:"payment_method_reuse_agreement"`

        // If set to `auto`, enables the collection of customer consent for promotional communications.

        Promotions PaymentLinkConsentCollectionPromotions `json:"promotions"`

        // 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.

        TermsOfService PaymentLinkConsentCollectionTermsOfService `json:"terms_of_service"`

}

// The options available for the customer to select. Up to 200 options allowed.

type PaymentLinkCustomFieldDropdownOption struct {

        // The label for the option, displayed to the customer. Up to 100 characters.

        Label string `json:"label"`

        // 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.

        Value string `json:"value"`

}

type PaymentLinkCustomFieldDropdown struct {

        // The options available for the customer to select. Up to 200 options allowed.

        Options []*PaymentLinkCustomFieldDropdownOption `json:"options"`

}

type PaymentLinkCustomFieldLabel struct {

        // Custom text for the label, displayed to the customer. Up to 50 characters.

        Custom string `json:"custom"`

        // The type of the label.

        Type PaymentLinkCustomFieldLabelType `json:"type"`

}

type PaymentLinkCustomFieldNumeric struct {

        // The maximum character length constraint for the customer's input.

        MaximumLength int64 `json:"maximum_length"`

        // The minimum character length requirement for the customer's input.

        MinimumLength int64 `json:"minimum_length"`

}

type PaymentLinkCustomFieldText struct {

        // The maximum character length constraint for the customer's input.

        MaximumLength int64 `json:"maximum_length"`

        // The minimum character length requirement for the customer's input.

        MinimumLength int64 `json:"minimum_length"`

}

// Collect additional information from your customer using custom fields. Up to 3 fields are supported.

type PaymentLinkCustomField struct {

        Dropdown *PaymentLinkCustomFieldDropdown `json:"dropdown"`

        // 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.

        Key     string                         `json:"key"`

        Label   *PaymentLinkCustomFieldLabel   `json:"label"`

        Numeric *PaymentLinkCustomFieldNumeric `json:"numeric"`

        // Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.

        Optional bool                        `json:"optional"`

        Text     *PaymentLinkCustomFieldText `json:"text"`

        // The type of the field.

        Type PaymentLinkCustomFieldType `json:"type"`

}

// Custom text that should be displayed after the payment confirmation button.

type PaymentLinkCustomTextAfterSubmit struct {

        // Text may be up to 1200 characters in length.

        Message string `json:"message"`

}

// Custom text that should be displayed alongside shipping address collection.

type PaymentLinkCustomTextShippingAddress struct {

        // Text may be up to 1200 characters in length.

        Message string `json:"message"`

}

// Custom text that should be displayed alongside the payment confirmation button.

type PaymentLinkCustomTextSubmit struct {

        // Text may be up to 1200 characters in length.

        Message string `json:"message"`

}

// Custom text that should be displayed in place of the default terms of service agreement text.

type PaymentLinkCustomTextTermsOfServiceAcceptance struct {

        // Text may be up to 1200 characters in length.

        Message string `json:"message"`

}

type PaymentLinkCustomText struct {

        // Custom text that should be displayed after the payment confirmation button.

        AfterSubmit *PaymentLinkCustomTextAfterSubmit `json:"after_submit"`

        // Custom text that should be displayed alongside shipping address collection.

        ShippingAddress *PaymentLinkCustomTextShippingAddress `json:"shipping_address"`

        // Custom text that should be displayed alongside the payment confirmation button.

        Submit *PaymentLinkCustomTextSubmit `json:"submit"`

        // Custom text that should be displayed in place of the default terms of service agreement text.

        TermsOfServiceAcceptance *PaymentLinkCustomTextTermsOfServiceAcceptance `json:"terms_of_service_acceptance"`

}

// A list of up to 4 custom fields to be displayed on the invoice.

type PaymentLinkInvoiceCreationInvoiceDataCustomField struct {

        // The name of the custom field.

        Name string `json:"name"`

        // The value of the custom field.

        Value string `json:"value"`

}

// The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.

type PaymentLinkInvoiceCreationInvoiceDataIssuer struct {

        // The connected account being referenced when `type` is `account`.

        Account *Account `json:"account"`

        // Type of the account referenced.

        Type PaymentLinkInvoiceCreationInvoiceDataIssuerType `json:"type"`

}

// Options for invoice PDF rendering.

type PaymentLinkInvoiceCreationInvoiceDataRenderingOptions struct {

        // How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.

        AmountTaxDisplay string `json:"amount_tax_display"`

}

// Configuration for the invoice. Default invoice values will be used if unspecified.

type PaymentLinkInvoiceCreationInvoiceData struct {

        // The account tax IDs associated with the invoice.

        AccountTaxIDs []*TaxID `json:"account_tax_ids"`

        // A list of up to 4 custom fields to be displayed on the invoice.

        CustomFields []*PaymentLinkInvoiceCreationInvoiceDataCustomField `json:"custom_fields"`

        // An arbitrary string attached to the object. Often useful for displaying to users.

        Description string `json:"description"`

        // Footer to be displayed on the invoice.

        Footer string `json:"footer"`

        // The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.

        Issuer *PaymentLinkInvoiceCreationInvoiceDataIssuer `json:"issuer"`

        // Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

        Metadata map[string]string `json:"metadata"`

        // Options for invoice PDF rendering.

        RenderingOptions *PaymentLinkInvoiceCreationInvoiceDataRenderingOptions `json:"rendering_options"`

}

// Configuration for creating invoice for payment mode payment links.

type PaymentLinkInvoiceCreation struct {

        // Enable creating an invoice on successful payment.

        Enabled bool `json:"enabled"`

        // Configuration for the invoice. Default invoice values will be used if unspecified.

        InvoiceData *PaymentLinkInvoiceCreationInvoiceData `json:"invoice_data"`

}

// Indicates the parameters to be passed to PaymentIntent creation during checkout.

type PaymentLinkPaymentIntentData struct {

        // Indicates when the funds will be captured from the customer's account.

        CaptureMethod PaymentLinkPaymentIntentDataCaptureMethod `json:"capture_method"`

        // An arbitrary string attached to the object. Often useful for displaying to users.

        Description string `json:"description"`

        // Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on [Payment Intents](https://stripe.com/docs/api/payment_intents) generated from this payment link.

        Metadata map[string]string `json:"metadata"`

        // Indicates that you intend to make future payments with the payment method collected during checkout.

        SetupFutureUsage PaymentLinkPaymentIntentDataSetupFutureUsage `json:"setup_future_usage"`

        // For a non-card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge.

        StatementDescriptor string `json:"statement_descriptor"`

        // 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.

        StatementDescriptorSuffix string `json:"statement_descriptor_suffix"`

        // A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.

        TransferGroup string `json:"transfer_group"`

}

type PaymentLinkPhoneNumberCollection struct {

        // If `true`, a phone number will be collected during checkout.

        Enabled bool `json:"enabled"`

}

type PaymentLinkRestrictionsCompletedSessions struct {

        // The current number of checkout sessions that have been completed on the payment link which count towards the `completed_sessions` restriction to be met.