Telegram Bot/eu.vendeli.tgbot.types.internal.options/CreateInvoiceLinkOptions

CreateInvoiceLinkOptions

@Serializable

data class CreateInvoiceLinkOptions(var providerToken: String? = null, var maxTipAmount: Int? = null, var suggestedTipAmounts: List<Int>? = null, var providerData: String? = null, var photoUrl: String? = null, var photoSize: Long? = null, var photoWidth: Int? = null, var photoHeight: Int? = null, var needName: Boolean? = null, var subscriptionPeriod: Duration? = null, var needPhoneNumber: Boolean? = null, var needEmail: Boolean? = null, var needShippingAddress: Boolean? = null, var sendPhoneNumberToProvider: Boolean? = null, var sendEmailToProvider: Boolean? = null, var isFlexible: Boolean? = null) : Options

Create invoice link options

Constructors

constructor(providerToken: String? = null, maxTipAmount: Int? = null, suggestedTipAmounts: List<Int>? = null, providerData: String? = null, photoUrl: String? = null, photoSize: Long? = null, photoWidth: Int? = null, photoHeight: Int? = null, needName: Boolean? = null, subscriptionPeriod: Duration? = null, needPhoneNumber: Boolean? = null, needEmail: Boolean? = null, needShippingAddress: Boolean? = null, sendPhoneNumberToProvider: Boolean? = null, sendEmailToProvider: Boolean? = null, isFlexible: Boolean? = null)

Properties

isFlexible

var isFlexible: Boolean?

Pass True, if the final price depends on the shipping method

maxTipAmount

var maxTipAmount: Int?

The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0

needEmail

var needEmail: Boolean?

Pass True, if you require the user's email address to complete the order

needName

var needName: Boolean?

Pass True, if you require the user's full name to complete the order

needPhoneNumber

var needPhoneNumber: Boolean?

Pass True, if you require the user's phone number to complete the order

needShippingAddress

var needShippingAddress: Boolean?

Pass True, if you require the user's shipping address to complete the order

photoHeight

var photoHeight: Int?

Photo height

photoSize

var photoSize: Long?

Photo size in bytes

photoUrl

var photoUrl: String?

URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.

photoWidth

var photoWidth: Int?

Photo width

providerData

var providerData: String?

JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.

providerToken

var providerToken: String?

sendEmailToProvider

var sendEmailToProvider: Boolean?

Pass True, if the user's email address should be sent to the provider

sendPhoneNumberToProvider

var sendPhoneNumberToProvider: Boolean?

Pass True, if the user's phone number should be sent to the provider

subscriptionPeriod

@Serializable(with = DurationSerializer::class)

var subscriptionPeriod: Duration?

suggestedTipAmounts

var suggestedTipAmounts: List<Int>?

A JSON-serialized array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount.