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
andprovider_payment_charge_id
are equal.Available In
- Parameters:
currency (
str
) – Three-letter ISO 4217 currency code, orXTR
for payments in Telegram Stars.total_amount (
int
) – Total price in the smallest units of the currency (integer, not float/double). For example, for a price ofUS$ 1.45
passamount = 145
. See theexp
parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).invoice_payload (
str
) – Bot-specified invoice payload.subscription_expiration_date (
datetime.datetime
, optional) –Expiration date of the subscription; for recurring payments only.
Added in version 21.8.
is_recurring (
bool
, optional) –True, if the payment is for a subscription.
Added in version 21.8.
is_first_recurring (
bool
, optional) –True, if the payment is the first payment of a subscription.
Added in version 21.8.
shipping_option_id (
str
, optional) – Identifier of the shipping option chosen by the user.order_info (
telegram.OrderInfo
, optional) – Order info provided by the user.telegram_payment_charge_id (
str
) – Telegram payment identifier.provider_payment_charge_id (
str
) – Provider payment identifier.
- currency[source]¶
Three-letter ISO 4217 currency code, or
XTR
for payments in Telegram Stars.- Type:
- 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
passamount = 145
. See theexp
parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).- Type:
- subscription_expiration_date[source]¶
Optional. Expiration date of the subscription; for recurring payments only.
Added in version 21.8.
- Type:
- is_recurring[source]¶
Optional. True, if the payment is for a subscription.
Added in version 21.8.
- Type:
- is_first_recurring[source]¶
Optional. True, if the payment is the first payment of a subscription.
Added in version 21.8.
- Type: