InputInvoice

class pyrogram.raw.base.InputInvoice

An invoice

Constructors:

This base type has 15 constructors available.

InputInvoiceBusinessBotTransferStars

Transfer stars from the balance of a user account connected to a business bot, to the balance of the business bot, see here » for more info on the full flow.

InputInvoiceChatInviteSubscription

Used to pay for a Telegram Star subscription ».

InputInvoiceMessage

An invoice contained in a messageMediaInvoice message or paid media ».

InputInvoicePremiumAuthCode

{schema}

InputInvoicePremiumGiftCode

Used if the user wishes to start a channel/supergroup giveaway or send some giftcodes to members of a channel/supergroup, in exchange for boosts.

InputInvoicePremiumGiftStars

Used to gift a Telegram Premium subscription to another user, paying with Telegram Stars.

InputInvoiceSlug

An invoice slug taken from an invoice deep link or from the premium_invoice_slug app config parameter »

InputInvoiceStarGift

Used to buy a Telegram Star Gift, see here » for more info.

InputInvoiceStarGiftAuctionBid

{schema}

InputInvoiceStarGiftDropOriginalDetails

{schema}

InputInvoiceStarGiftPrepaidUpgrade

Separately prepay for the upgrade of a gift ».

InputInvoiceStarGiftResale

Used to buy a collectible gift currently up on resale, see here for more info on the full flow.

InputInvoiceStarGiftTransfer

Used to pay to transfer a collectible gift to another peer, see the gifts » documentation for more info.

InputInvoiceStarGiftUpgrade

Used to pay to upgrade a Gift to a collectible gift, see the collectible gifts » documentation for more info on the full flow.

InputInvoiceStars

Used to top up the Telegram Stars balance of the current account or someone else's account, or to start a Telegram Star giveaway ».

TL Schema


Parameter Tree

InputInvoice
│ ├── peerInputPeer
│ │ ├── InputPeerEmpty
│ │ ├── InputPeerSelf
│ │ ├── InputPeerChat
│ │ ├── InputPeerUser
│ │ ├── InputPeerChannel
│ │ ├── InputPeerUserFromMessage
│ │ └── InputPeerChannelFromMessage
│ └── msg_idint
│ └── slugstring
│ ├── purposeInputStorePaymentPurpose
│ │ │ ├── restoretrue (optional)
│ │ │ └── upgradetrue (optional)
│ │ │ ├── user_idInputUser
│ │ │ │ ├── InputUserEmpty
│ │ │ │ ├── InputUserSelf
│ │ │ │ ├── InputUser
│ │ │ │ └── InputUserFromMessage
│ │ │ ├── currencystring
│ │ │ └── amountlong
│ │ │ ├── usersVector < InputUser >
│ │ │ │ ├── InputUserEmpty
│ │ │ │ ├── InputUserSelf
│ │ │ │ ├── InputUser
│ │ │ │ └── InputUserFromMessage
│ │ │ ├── boost_peerInputPeer (optional)
│ │ │ │ ├── InputPeerEmpty
│ │ │ │ ├── InputPeerSelf
│ │ │ │ ├── InputPeerChat
│ │ │ │ ├── InputPeerUser
│ │ │ │ ├── InputPeerChannel
│ │ │ │ ├── InputPeerUserFromMessage
│ │ │ │ └── InputPeerChannelFromMessage
│ │ │ ├── currencystring
│ │ │ ├── amountlong
│ │ │ └── messageTextWithEntities (optional)
│ │ │ └── TextWithEntities
│ │ │ ├── only_new_subscriberstrue (optional)
│ │ │ ├── winners_are_visibletrue (optional)
│ │ │ ├── boost_peerInputPeer
│ │ │ │ ├── InputPeerEmpty
│ │ │ │ ├── InputPeerSelf
│ │ │ │ ├── InputPeerChat
│ │ │ │ ├── InputPeerUser
│ │ │ │ ├── InputPeerChannel
│ │ │ │ ├── InputPeerUserFromMessage
│ │ │ │ └── InputPeerChannelFromMessage
│ │ │ ├── additional_peersVector < InputPeer > (optional)
│ │ │ │ ├── InputPeerEmpty
│ │ │ │ ├── InputPeerSelf
│ │ │ │ ├── InputPeerChat
│ │ │ │ ├── InputPeerUser
│ │ │ │ ├── InputPeerChannel
│ │ │ │ ├── InputPeerUserFromMessage
│ │ │ │ └── InputPeerChannelFromMessage
│ │ │ ├── countries_iso2Vector < string > (optional)
│ │ │ ├── prize_descriptionstring (optional)
│ │ │ ├── random_idlong
│ │ │ ├── until_dateint
│ │ │ ├── currencystring
│ │ │ └── amountlong
│ │ ├── InputStorePaymentStarsTopup
│ │ │ ├── starslong
│ │ │ ├── currencystring
│ │ │ ├── amountlong
│ │ │ └── spend_purpose_peerInputPeer (optional)
│ │ │ ├── InputPeerEmpty
│ │ │ ├── InputPeerSelf
│ │ │ ├── InputPeerChat
│ │ │ ├── InputPeerUser
│ │ │ ├── InputPeerChannel
│ │ │ ├── InputPeerUserFromMessage
│ │ │ └── InputPeerChannelFromMessage
│ │ ├── InputStorePaymentStarsGift
│ │ │ ├── user_idInputUser
│ │ │ │ ├── InputUserEmpty
│ │ │ │ ├── InputUserSelf
│ │ │ │ ├── InputUser
│ │ │ │ └── InputUserFromMessage
│ │ │ ├── starslong
│ │ │ ├── currencystring
│ │ │ └── amountlong
│ │ │ ├── only_new_subscriberstrue (optional)
│ │ │ ├── winners_are_visibletrue (optional)
│ │ │ ├── starslong
│ │ │ ├── boost_peerInputPeer
│ │ │ │ ├── InputPeerEmpty
│ │ │ │ ├── InputPeerSelf
│ │ │ │ ├── InputPeerChat
│ │ │ │ ├── InputPeerUser
│ │ │ │ ├── InputPeerChannel
│ │ │ │ ├── InputPeerUserFromMessage
│ │ │ │ └── InputPeerChannelFromMessage
│ │ │ ├── additional_peersVector < InputPeer > (optional)
│ │ │ │ ├── InputPeerEmpty
│ │ │ │ ├── InputPeerSelf
│ │ │ │ ├── InputPeerChat
│ │ │ │ ├── InputPeerUser
│ │ │ │ ├── InputPeerChannel
│ │ │ │ ├── InputPeerUserFromMessage
│ │ │ │ └── InputPeerChannelFromMessage
│ │ │ ├── countries_iso2Vector < string > (optional)
│ │ │ ├── prize_descriptionstring (optional)
│ │ │ ├── random_idlong
│ │ │ ├── until_dateint
│ │ │ ├── currencystring
│ │ │ ├── amountlong
│ │ │ └── usersint
│ │ └── InputStorePaymentAuthCode
│ │ ├── restoretrue (optional)
│ │ ├── phone_numberstring
│ │ ├── phone_code_hashstring
│ │ ├── currencystring
│ │ └── amountlong
│ └── optionPremiumGiftCodeOption
│ └── PremiumGiftCodeOption
│ ├── usersint
│ ├── monthsint
│ ├── store_productstring (optional)
│ ├── store_quantityint (optional)
│ ├── currencystring
│ └── amountlong
│ └── purposeInputStorePaymentPurpose
│ │ ├── restoretrue (optional)
│ │ └── upgradetrue (optional)
│ │ ├── user_idInputUser
│ │ │ ├── InputUserEmpty
│ │ │ ├── InputUserSelf
│ │ │ ├── InputUser
│ │ │ └── InputUserFromMessage
│ │ ├── currencystring
│ │ └── amountlong
│ │ ├── usersVector < InputUser >
│ │ │ ├── InputUserEmpty
│ │ │ ├── InputUserSelf
│ │ │ ├── InputUser
│ │ │ └── InputUserFromMessage
│ │ ├── boost_peerInputPeer (optional)
│ │ │ ├── InputPeerEmpty
│ │ │ ├── InputPeerSelf
│ │ │ ├── InputPeerChat
│ │ │ ├── InputPeerUser
│ │ │ ├── InputPeerChannel
│ │ │ ├── InputPeerUserFromMessage
│ │ │ └── InputPeerChannelFromMessage
│ │ ├── currencystring
│ │ ├── amountlong
│ │ └── messageTextWithEntities (optional)
│ │ └── TextWithEntities
│ │ ├── only_new_subscriberstrue (optional)
│ │ ├── winners_are_visibletrue (optional)
│ │ ├── boost_peerInputPeer
│ │ │ ├── InputPeerEmpty
│ │ │ ├── InputPeerSelf
│ │ │ ├── InputPeerChat
│ │ │ ├── InputPeerUser
│ │ │ ├── InputPeerChannel
│ │ │ ├── InputPeerUserFromMessage
│ │ │ └── InputPeerChannelFromMessage
│ │ ├── additional_peersVector < InputPeer > (optional)
│ │ │ ├── InputPeerEmpty
│ │ │ ├── InputPeerSelf
│ │ │ ├── InputPeerChat
│ │ │ ├── InputPeerUser
│ │ │ ├── InputPeerChannel
│ │ │ ├── InputPeerUserFromMessage
│ │ │ └── InputPeerChannelFromMessage
│ │ ├── countries_iso2Vector < string > (optional)
│ │ ├── prize_descriptionstring (optional)
│ │ ├── random_idlong
│ │ ├── until_dateint
│ │ ├── currencystring
│ │ └── amountlong
│ │ ├── starslong
│ │ ├── currencystring
│ │ ├── amountlong
│ │ └── spend_purpose_peerInputPeer (optional)
│ │ ├── InputPeerEmpty
│ │ ├── InputPeerSelf
│ │ ├── InputPeerChat
│ │ ├── InputPeerUser
│ │ ├── InputPeerChannel
│ │ ├── InputPeerUserFromMessage
│ │ └── InputPeerChannelFromMessage
│ │ ├── user_idInputUser
│ │ │ ├── InputUserEmpty
│ │ │ ├── InputUserSelf
│ │ │ ├── InputUser
│ │ │ └── InputUserFromMessage
│ │ ├── starslong
│ │ ├── currencystring
│ │ └── amountlong
│ │ ├── only_new_subscriberstrue (optional)
│ │ ├── winners_are_visibletrue (optional)
│ │ ├── starslong
│ │ ├── boost_peerInputPeer
│ │ │ ├── InputPeerEmpty
│ │ │ ├── InputPeerSelf
│ │ │ ├── InputPeerChat
│ │ │ ├── InputPeerUser
│ │ │ ├── InputPeerChannel
│ │ │ ├── InputPeerUserFromMessage
│ │ │ └── InputPeerChannelFromMessage
│ │ ├── additional_peersVector < InputPeer > (optional)
│ │ │ ├── InputPeerEmpty
│ │ │ ├── InputPeerSelf
│ │ │ ├── InputPeerChat
│ │ │ ├── InputPeerUser
│ │ │ ├── InputPeerChannel
│ │ │ ├── InputPeerUserFromMessage
│ │ │ └── InputPeerChannelFromMessage
│ │ ├── countries_iso2Vector < string > (optional)
│ │ ├── prize_descriptionstring (optional)
│ │ ├── random_idlong
│ │ ├── until_dateint
│ │ ├── currencystring
│ │ ├── amountlong
│ │ └── usersint
│ ├── restoretrue (optional)
│ ├── phone_numberstring
│ ├── phone_code_hashstring
│ ├── currencystring
│ └── amountlong
│ └── hashstring
│ ├── hide_nametrue (optional)
│ ├── include_upgradetrue (optional)
│ ├── peerInputPeer
│ │ ├── InputPeerEmpty
│ │ ├── InputPeerSelf
│ │ ├── InputPeerChat
│ │ ├── InputPeerUser
│ │ ├── InputPeerChannel
│ │ ├── InputPeerUserFromMessage
│ │ └── InputPeerChannelFromMessage
│ ├── gift_idlong
│ └── messageTextWithEntities (optional)
│ └── TextWithEntities
│ ├── textstring
│ └── entitiesVector < MessageEntity >
│ ├── MessageEntityUnknown
│ ├── MessageEntityMention
│ ├── MessageEntityHashtag
│ ├── MessageEntityUrl
│ ├── MessageEntityEmail
│ ├── MessageEntityBold
│ ├── MessageEntityItalic
│ ├── MessageEntityCode
│ ├── MessageEntityPre
│ ├── MessageEntityTextUrl
│ ├── MessageEntityPhone
│ ├── MessageEntityCashtag
│ ├── MessageEntityStrike
│ ├── MessageEntityBankCard
│ ├── MessageEntitySpoiler
│ ├── keep_original_detailstrue (optional)
│ └── stargiftInputSavedStarGift
│ │ └── msg_idint
│ │ ├── peerInputPeer
│ │ │ ├── InputPeerEmpty
│ │ │ ├── InputPeerSelf
│ │ │ ├── InputPeerChat
│ │ │ ├── InputPeerUser
│ │ │ ├── InputPeerChannel
│ │ │ ├── InputPeerUserFromMessage
│ │ │ └── InputPeerChannelFromMessage
│ │ └── saved_idlong
│ └── slugstring
│ ├── stargiftInputSavedStarGift
│ │ ├── InputSavedStarGiftUser
│ │ │ └── msg_idint
│ │ ├── InputSavedStarGiftChat
│ │ │ ├── peerInputPeer
│ │ │ │ ├── InputPeerEmpty
│ │ │ │ ├── InputPeerSelf
│ │ │ │ ├── InputPeerChat
│ │ │ │ ├── InputPeerUser
│ │ │ │ ├── InputPeerChannel
│ │ │ │ ├── InputPeerUserFromMessage
│ │ │ │ └── InputPeerChannelFromMessage
│ │ │ └── saved_idlong
│ │ └── InputSavedStarGiftSlug
│ │ └── slugstring
│ └── to_idInputPeer
│ ├── InputPeerEmpty
│ ├── InputPeerSelf
│ ├── InputPeerChat
│ ├── InputPeerUser
│ ├── InputPeerChannel
│ ├── user_idInputUser
│ │ ├── InputUserEmpty
│ │ ├── InputUserSelf
│ │ ├── InputUser
│ │ └── InputUserFromMessage
│ ├── monthsint
│ └── messageTextWithEntities (optional)
│ └── TextWithEntities
│ ├── textstring
│ └── entitiesVector < MessageEntity >
│ ├── MessageEntityUnknown
│ ├── MessageEntityMention
│ ├── MessageEntityHashtag
│ ├── MessageEntityUrl
│ ├── MessageEntityEmail
│ ├── MessageEntityBold
│ ├── MessageEntityItalic
│ ├── MessageEntityCode
│ ├── MessageEntityPre
│ ├── MessageEntityTextUrl
│ ├── MessageEntityPhone
│ ├── MessageEntityCashtag
│ ├── MessageEntityStrike
│ ├── MessageEntityBankCard
│ ├── MessageEntitySpoiler
│ ├── botInputUser
│ │ ├── InputUserEmpty
│ │ ├── InputUserSelf
│ │ ├── InputUser
│ │ └── InputUserFromMessage
│ └── starslong
│ ├── tontrue (optional)
│ ├── slugstring
│ └── to_idInputPeer
│ ├── InputPeerEmpty
│ ├── InputPeerSelf
│ ├── InputPeerChat
│ ├── InputPeerUser
│ ├── InputPeerChannel
│ ├── peerInputPeer
│ │ ├── InputPeerEmpty
│ │ ├── InputPeerSelf
│ │ ├── InputPeerChat
│ │ ├── InputPeerUser
│ │ ├── InputPeerChannel
│ │ ├── InputPeerUserFromMessage
│ │ └── InputPeerChannelFromMessage
│ └── hashstring
│ └── purposeInputStorePaymentPurpose
│ │ ├── restoretrue (optional)
│ │ └── upgradetrue (optional)
│ │ ├── user_idInputUser
│ │ │ ├── InputUserEmpty
│ │ │ ├── InputUserSelf
│ │ │ ├── InputUser
│ │ │ └── InputUserFromMessage
│ │ ├── currencystring
│ │ └── amountlong
│ │ ├── usersVector < InputUser >
│ │ │ ├── InputUserEmpty
│ │ │ ├── InputUserSelf
│ │ │ ├── InputUser
│ │ │ └── InputUserFromMessage
│ │ ├── boost_peerInputPeer (optional)
│ │ │ ├── InputPeerEmpty
│ │ │ ├── InputPeerSelf
│ │ │ ├── InputPeerChat
│ │ │ ├── InputPeerUser
│ │ │ ├── InputPeerChannel
│ │ │ ├── InputPeerUserFromMessage
│ │ │ └── InputPeerChannelFromMessage
│ │ ├── currencystring
│ │ ├── amountlong
│ │ └── messageTextWithEntities (optional)
│ │ └── TextWithEntities
│ │ ├── only_new_subscriberstrue (optional)
│ │ ├── winners_are_visibletrue (optional)
│ │ ├── boost_peerInputPeer
│ │ │ ├── InputPeerEmpty
│ │ │ ├── InputPeerSelf
│ │ │ ├── InputPeerChat
│ │ │ ├── InputPeerUser
│ │ │ ├── InputPeerChannel
│ │ │ ├── InputPeerUserFromMessage
│ │ │ └── InputPeerChannelFromMessage
│ │ ├── additional_peersVector < InputPeer > (optional)
│ │ │ ├── InputPeerEmpty
│ │ │ ├── InputPeerSelf
│ │ │ ├── InputPeerChat
│ │ │ ├── InputPeerUser
│ │ │ ├── InputPeerChannel
│ │ │ ├── InputPeerUserFromMessage
│ │ │ └── InputPeerChannelFromMessage
│ │ ├── countries_iso2Vector < string > (optional)
│ │ ├── prize_descriptionstring (optional)
│ │ ├── random_idlong
│ │ ├── until_dateint
│ │ ├── currencystring
│ │ └── amountlong
│ │ ├── starslong
│ │ ├── currencystring
│ │ ├── amountlong
│ │ └── spend_purpose_peerInputPeer (optional)
│ │ ├── InputPeerEmpty
│ │ ├── InputPeerSelf
│ │ ├── InputPeerChat
│ │ ├── InputPeerUser
│ │ ├── InputPeerChannel
│ │ ├── InputPeerUserFromMessage
│ │ └── InputPeerChannelFromMessage
│ │ ├── user_idInputUser
│ │ │ ├── InputUserEmpty
│ │ │ ├── InputUserSelf
│ │ │ ├── InputUser
│ │ │ └── InputUserFromMessage
│ │ ├── starslong
│ │ ├── currencystring
│ │ └── amountlong
│ │ ├── only_new_subscriberstrue (optional)
│ │ ├── winners_are_visibletrue (optional)
│ │ ├── starslong
│ │ ├── boost_peerInputPeer
│ │ │ ├── InputPeerEmpty
│ │ │ ├── InputPeerSelf
│ │ │ ├── InputPeerChat
│ │ │ ├── InputPeerUser
│ │ │ ├── InputPeerChannel
│ │ │ ├── InputPeerUserFromMessage
│ │ │ └── InputPeerChannelFromMessage
│ │ ├── additional_peersVector < InputPeer > (optional)
│ │ │ ├── InputPeerEmpty
│ │ │ ├── InputPeerSelf
│ │ │ ├── InputPeerChat
│ │ │ ├── InputPeerUser
│ │ │ ├── InputPeerChannel
│ │ │ ├── InputPeerUserFromMessage
│ │ │ └── InputPeerChannelFromMessage
│ │ ├── countries_iso2Vector < string > (optional)
│ │ ├── prize_descriptionstring (optional)
│ │ ├── random_idlong
│ │ ├── until_dateint
│ │ ├── currencystring
│ │ ├── amountlong
│ │ └── usersint
│ ├── restoretrue (optional)
│ ├── phone_numberstring
│ ├── phone_code_hashstring
│ ├── currencystring
│ └── amountlong
│ └── stargiftInputSavedStarGift
│ │ └── msg_idint
│ │ ├── peerInputPeer
│ │ │ ├── InputPeerEmpty
│ │ │ ├── InputPeerSelf
│ │ │ ├── InputPeerChat
│ │ │ ├── InputPeerUser
│ │ │ ├── InputPeerChannel
│ │ │ ├── InputPeerUserFromMessage
│ │ │ └── InputPeerChannelFromMessage
│ │ └── saved_idlong
│ └── slugstring
├── hide_nametrue (optional)
├── update_bidtrue (optional)
├── peerInputPeer (optional)
│ ├── InputPeerEmpty
│ ├── InputPeerSelf
│ ├── InputPeerChat
│ ├── InputPeerUser
│ ├── InputPeerChannel
├── gift_idlong
├── bid_amountlong
└── messageTextWithEntities (optional)

Example