Skip to content

Invoice

Type · TDLib 1.8.67 · d1085f9c

Product invoice

Invoice(
  currency: string,
  price_parts: list of LabeledPricePart,
  subscription_period: int32,
  max_tip_amount: int53,
  suggested_tip_amounts: list of int53,
  recurring_payment_terms_of_service_url: string,
  terms_of_service_url: string,
  is_test: Bool,
  need_name: Bool,
  need_phone_number: Bool,
  need_email_address: Bool,
  need_shipping_address: Bool,
  send_phone_number_to_provider: Bool,
  send_email_address_to_provider: Bool,
  is_flexible: Bool
) → Invoice

currency

string

ISO 4217 currency code

price_parts

list of LabeledPricePart

A list of objects used to calculate the total price of the product

subscription_period

int32

The number of seconds between consecutive Telegram Star debiting for subscription invoices; 0 if the invoice doesn't create subscription

max_tip_amount

int53

The maximum allowed amount of tip in the smallest units of the currency

suggested_tip_amounts

list of int53

Suggested amounts of tip in the smallest units of the currency

recurring_payment_terms_of_service_url

string

An HTTP URL with terms of service for recurring payments. If non-empty, the invoice payment will result in recurring payments and the user must accept the terms of service before allowed to pay

terms_of_service_url

string

An HTTP URL with terms of service for non-recurring payments. If non-empty, then the user must accept the terms of service before allowed to pay

is_test

Bool

True, if the payment is a test payment

need_name

Bool

True, if the user's name is needed for payment

need_phone_number

Bool

True, if the user's phone number is needed for payment

need_email_address

Bool

True, if the user's email address is needed for payment

need_shipping_address

Bool

True, if the user's shipping address is needed for payment

send_phone_number_to_provider

Bool

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

send_email_address_to_provider

Bool

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

is_flexible

Bool

True, if the total price depends on the shipping method