Struct CreateInvoiceLink

pub struct CreateInvoiceLink {

    pub title: String,
    pub description: String,
    pub payload: String,
    pub currency: String,
    pub prices: Vec<LabeledPrice>,
    pub provider_token: Option<String>,
    pub business_connection_id: Option<BusinessConnectionId>,
    pub subscription_period: Option<Seconds>,
    pub max_tip_amount: Option<u32>,
    pub suggested_tip_amounts: Option<Vec<u32>>,
    pub provider_data: Option<String>,
    pub photo_url: Option<String>,
    pub photo_size: Option<String>,
    pub photo_width: Option<String>,
    pub photo_height: Option<String>,
    pub need_name: Option<bool>,
    pub need_phone_number: Option<bool>,
    pub need_email: Option<bool>,
    pub need_shipping_address: Option<bool>,
    pub send_phone_number_to_provider: Option<bool>,
    pub send_email_to_provider: Option<bool>,
    pub is_flexible: Option<bool>,
}

Use this method to create a link for an invoice. Returns the created invoice link as String on success.

Fields

title: String

Product name, 1-32 characters

description: String

Product description, 1-255 characters

payload: String

Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.

currency: String

Three-letter ISO 4217 currency code, see more on currencies. Pass XTR for payments in Telegram Stars.

prices: Vec<LabeledPrice>

Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)

provider_token: Option<String>

Payments provider token, obtained via Botfather. Pass None for payments in Telegram Stars.

business_connection_id: Option<BusinessConnectionId>

Unique identifier of the business connection on behalf of which the link will be created. For payments in Telegram Stars only.

subscription_period: Option<Seconds>

The number of seconds the subscription will be active for before the next payment. The currency must be set to “XTR” (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 (30 days) if specified. Any number of subscriptions can be active for a given bot at the same time, including multiple concurrent subscriptions from the same user.

max_tip_amount: Option<u32>

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

suggested_tip_amounts: Option<Vec<u32>>

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.

provider_data: Option<String>

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

photo_url: Option<String>

URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for.

photo_size: Option<String>

Photo size in bytes

photo_width: Option<String>

Photo width

photo_height: Option<String>

Photo height

need_name: Option<bool>

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

need_phone_number: Option<bool>

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

need_email: Option<bool>

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

need_shipping_address: Option<bool>

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

send_phone_number_to_provider: Option<bool>

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

send_email_to_provider: Option<bool>

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

is_flexible: Option<bool>

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

Implementations

impl CreateInvoiceLink

pub fn new( title: impl Into<String>, description: impl Into<String>, payload: impl Into<String>, currency: impl Into<String>, prices: impl IntoIterator<Item = LabeledPrice>, ) -> Self

Trait Implementations

impl Clone for CreateInvoiceLink

fn clone(&self) -> CreateInvoiceLink

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateInvoiceLink

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

Formats the value using the given formatter.

impl Hash for CreateInvoiceLink

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CreateInvoiceLink

fn eq(&self, other: &CreateInvoiceLink) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Payload for CreateInvoiceLink

const NAME: &'static str = "CreateInvoiceLink"

Name of a Telegram method.

type Output = String

The return type of a Telegram method.

fn timeout_hint(&self) -> Option<Duration>

If this payload may take long time to execute (e.g. GetUpdates with big timeout), the minimum timeout that should be used.

impl Serialize for CreateInvoiceLink

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CreateInvoiceLink

impl StructuralPartialEq for CreateInvoiceLink