SuccessfulPayment

class telegram.SuccessfulPayment(currency, total_amount, invoice_payload, telegram_payment_charge_id, provider_payment_charge_id, shipping_option_id=None, order_info=None, subscription_expiration_date=None, is_recurring=None, is_first_recurring=None, *, api_kwargs=None)[source]

Bases: telegram.TelegramObject

This object contains basic information about a successful payment.

Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their telegram_payment_charge_id and provider_payment_charge_id are equal.

Available In

telegram.Message.successful_payment

Parameters:
currency[source]

Three-letter ISO 4217 currency code, or XTR for payments in Telegram Stars.

Type:

str

total_amount[source]

Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass 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).

Type:

int

invoice_payload[source]

Bot-specified invoice payload.

Type:

str

subscription_expiration_date[source]

Optional. Expiration date of the subscription; for recurring payments only.

Added in version 21.8.

Type:

datetime.datetime

is_recurring[source]

Optional. True, if the payment is for a subscription.

Added in version 21.8.

Type:

bool

is_first_recurring[source]

Optional. True, if the payment is the first payment of a subscription.

Added in version 21.8.

Type:

bool

shipping_option_id[source]

Optional. Identifier of the shipping option chosen by the user.

Type:

str

order_info[source]

Optional. Order info provided by the user.

Type:

telegram.OrderInfo

telegram_payment_charge_id[source]

Telegram payment identifier.

Type:

str

provider_payment_charge_id[source]

Provider payment identifier.

Type:

str

classmethod de_json(data, bot=None)[source]

See telegram.TelegramObject.de_json().