payments.SendStarsForm

class pyrogram.raw.functions.payments.SendStarsForm

Make a payment using Telegram Stars, see here » for more info.

Details:

  • Layer: 227

  • ID: 7998C914

Parameters:

  • form_id (int 64-bit) – Payment form ID

  • invoice (InputInvoice) – Invoice

Returns:

payments.PaymentResult

TL Schema

payments.sendStarsForm#7998c914
form_id:long
invoice:InputInvoice

= payments.PaymentResult

Parameter Tree

SendStarsForm
├── form_id → long
└── invoice → InputInvoice
├── InputInvoiceMessage
│ ├── peer → InputPeer
│ │ ├── InputPeerEmpty
│ │ ├── InputPeerSelf
│ │ ├── InputPeerChat
│ │ ├── InputPeerUser
│ │ ├── InputPeerChannel
│ │ ├── InputPeerUserFromMessage
│ │ └── InputPeerChannelFromMessage
│ └── msg_id → int
├── InputInvoiceSlug
│ └── slug → string
├── InputInvoicePremiumGiftCode
│ ├── purpose → InputStorePaymentPurpose
│ │ ├── InputStorePaymentPremiumSubscription
│ │ │ ├── restore → true (optional)
│ │ │ └── upgrade → true (optional)
│ │ ├── InputStorePaymentGiftPremium
│ │ │ ├── user_id → InputUser
│ │ │ │ ├── InputUserEmpty
│ │ │ │ ├── InputUserSelf
│ │ │ │ ├── InputUser
│ │ │ │ └── InputUserFromMessage
│ │ │ ├── currency → string
│ │ │ └── amount → long
│ │ ├── InputStorePaymentPremiumGiftCode
│ │ │ ├── users → Vector < InputUser >
│ │ │ │ ├── InputUserEmpty
│ │ │ │ ├── InputUserSelf
│ │ │ │ ├── InputUser
│ │ │ │ └── InputUserFromMessage
│ │ │ ├── boost_peer → InputPeer (optional)
│ │ │ │ ├── InputPeerEmpty
│ │ │ │ ├── InputPeerSelf
│ │ │ │ ├── InputPeerChat
│ │ │ │ ├── InputPeerUser
│ │ │ │ ├── InputPeerChannel
│ │ │ │ ├── InputPeerUserFromMessage
│ │ │ │ └── InputPeerChannelFromMessage
│ │ │ ├── currency → string
│ │ │ ├── amount → long
│ │ │ └── message → TextWithEntities (optional)
│ │ │ └── TextWithEntities
│ │ ├── InputStorePaymentPremiumGiveaway
│ │ │ ├── only_new_subscribers → true (optional)
│ │ │ ├── winners_are_visible → true (optional)
│ │ │ ├── boost_peer → InputPeer
│ │ │ │ ├── InputPeerEmpty
│ │ │ │ ├── InputPeerSelf
│ │ │ │ ├── InputPeerChat
│ │ │ │ ├── InputPeerUser
│ │ │ │ ├── InputPeerChannel
│ │ │ │ ├── InputPeerUserFromMessage
│ │ │ │ └── InputPeerChannelFromMessage
│ │ │ ├── additional_peers → Vector < InputPeer > (optional)
│ │ │ │ ├── InputPeerEmpty
│ │ │ │ ├── InputPeerSelf
│ │ │ │ ├── InputPeerChat
│ │ │ │ ├── InputPeerUser
│ │ │ │ ├── InputPeerChannel
│ │ │ │ ├── InputPeerUserFromMessage
│ │ │ │ └── InputPeerChannelFromMessage
│ │ │ ├── countries_iso2 → Vector < string > (optional)
│ │ │ ├── prize_description → string (optional)
│ │ │ ├── random_id → long
│ │ │ ├── until_date → int
│ │ │ ├── currency → string
│ │ │ └── amount → long
│ │ ├── InputStorePaymentStarsTopup
│ │ │ ├── stars → long
│ │ │ ├── currency → string
│ │ │ ├── amount → long
│ │ │ └── spend_purpose_peer → InputPeer (optional)
│ │ │ ├── InputPeerEmpty
│ │ │ ├── InputPeerSelf
│ │ │ ├── InputPeerChat
│ │ │ ├── InputPeerUser
│ │ │ ├── InputPeerChannel
│ │ │ ├── InputPeerUserFromMessage
│ │ │ └── InputPeerChannelFromMessage
│ │ ├── InputStorePaymentStarsGift
│ │ │ ├── user_id → InputUser
│ │ │ │ ├── InputUserEmpty
│ │ │ │ ├── InputUserSelf
│ │ │ │ ├── InputUser
│ │ │ │ └── InputUserFromMessage
│ │ │ ├── stars → long
│ │ │ ├── currency → string
│ │ │ └── amount → long
│ │ ├── InputStorePaymentStarsGiveaway
│ │ │ ├── only_new_subscribers → true (optional)
│ │ │ ├── winners_are_visible → true (optional)
│ │ │ ├── stars → long
│ │ │ ├── boost_peer → InputPeer
│ │ │ │ ├── InputPeerEmpty
│ │ │ │ ├── InputPeerSelf
│ │ │ │ ├── InputPeerChat
│ │ │ │ ├── InputPeerUser
│ │ │ │ ├── InputPeerChannel
│ │ │ │ ├── InputPeerUserFromMessage
│ │ │ │ └── InputPeerChannelFromMessage
│ │ │ ├── additional_peers → Vector < InputPeer > (optional)
│ │ │ │ ├── InputPeerEmpty
│ │ │ │ ├── InputPeerSelf
│ │ │ │ ├── InputPeerChat
│ │ │ │ ├── InputPeerUser
│ │ │ │ ├── InputPeerChannel
│ │ │ │ ├── InputPeerUserFromMessage
│ │ │ │ └── InputPeerChannelFromMessage
│ │ │ ├── countries_iso2 → Vector < string > (optional)
│ │ │ ├── prize_description → string (optional)
│ │ │ ├── random_id → long
│ │ │ ├── until_date → int
│ │ │ ├── currency → string
│ │ │ ├── amount → long
│ │ │ └── users → int
│ │ └── InputStorePaymentAuthCode
│ │ ├── restore → true (optional)
│ │ ├── phone_number → string
│ │ ├── phone_code_hash → string
│ │ ├── premium_days → int
│ │ ├── currency → string
│ │ └── amount → long
│ └── option → PremiumGiftCodeOption
│ └── PremiumGiftCodeOption
│ ├── users → int
│ ├── months → int
│ ├── store_product → string (optional)
│ ├── store_quantity → int (optional)
│ ├── currency → string
│ └── amount → long
├── InputInvoiceStars
│ └── purpose → InputStorePaymentPurpose
│ ├── InputStorePaymentPremiumSubscription
│ │ ├── restore → true (optional)
│ │ └── upgrade → true (optional)
│ ├── InputStorePaymentGiftPremium
│ │ ├── user_id → InputUser
│ │ │ ├── InputUserEmpty
│ │ │ ├── InputUserSelf
│ │ │ ├── InputUser
│ │ │ └── InputUserFromMessage
│ │ ├── currency → string
│ │ └── amount → long
│ ├── InputStorePaymentPremiumGiftCode
│ │ ├── users → Vector < InputUser >
│ │ │ ├── InputUserEmpty
│ │ │ ├── InputUserSelf
│ │ │ ├── InputUser
│ │ │ └── InputUserFromMessage
│ │ ├── boost_peer → InputPeer (optional)
│ │ │ ├── InputPeerEmpty
│ │ │ ├── InputPeerSelf
│ │ │ ├── InputPeerChat
│ │ │ ├── InputPeerUser
│ │ │ ├── InputPeerChannel
│ │ │ ├── InputPeerUserFromMessage
│ │ │ └── InputPeerChannelFromMessage
│ │ ├── currency → string
│ │ ├── amount → long
│ │ └── message → TextWithEntities (optional)
│ │ └── TextWithEntities
│ ├── InputStorePaymentPremiumGiveaway
│ │ ├── only_new_subscribers → true (optional)
│ │ ├── winners_are_visible → true (optional)
│ │ ├── boost_peer → InputPeer
│ │ │ ├── InputPeerEmpty
│ │ │ ├── InputPeerSelf
│ │ │ ├── InputPeerChat
│ │ │ ├── InputPeerUser
│ │ │ ├── InputPeerChannel
│ │ │ ├── InputPeerUserFromMessage
│ │ │ └── InputPeerChannelFromMessage
│ │ ├── additional_peers → Vector < InputPeer > (optional)
│ │ │ ├── InputPeerEmpty
│ │ │ ├── InputPeerSelf
│ │ │ ├── InputPeerChat
│ │ │ ├── InputPeerUser
│ │ │ ├── InputPeerChannel
│ │ │ ├── InputPeerUserFromMessage
│ │ │ └── InputPeerChannelFromMessage
│ │ ├── countries_iso2 → Vector < string > (optional)
│ │ ├── prize_description → string (optional)
│ │ ├── random_id → long
│ │ ├── until_date → int
│ │ ├── currency → string
│ │ └── amount → long
│ ├── InputStorePaymentStarsTopup
│ │ ├── stars → long
│ │ ├── currency → string
│ │ ├── amount → long
│ │ └── spend_purpose_peer → InputPeer (optional)
│ │ ├── InputPeerEmpty
│ │ ├── InputPeerSelf
│ │ ├── InputPeerChat
│ │ ├── InputPeerUser
│ │ ├── InputPeerChannel
│ │ ├── InputPeerUserFromMessage
│ │ └── InputPeerChannelFromMessage
│ ├── InputStorePaymentStarsGift
│ │ ├── user_id → InputUser
│ │ │ ├── InputUserEmpty
│ │ │ ├── InputUserSelf
│ │ │ ├── InputUser
│ │ │ └── InputUserFromMessage
│ │ ├── stars → long
│ │ ├── currency → string
│ │ └── amount → long
│ ├── InputStorePaymentStarsGiveaway
│ │ ├── only_new_subscribers → true (optional)
│ │ ├── winners_are_visible → true (optional)
│ │ ├── stars → long
│ │ ├── boost_peer → InputPeer
│ │ │ ├── InputPeerEmpty
│ │ │ ├── InputPeerSelf
│ │ │ ├── InputPeerChat
│ │ │ ├── InputPeerUser
│ │ │ ├── InputPeerChannel
│ │ │ ├── InputPeerUserFromMessage
│ │ │ └── InputPeerChannelFromMessage
│ │ ├── additional_peers → Vector < InputPeer > (optional)
│ │ │ ├── InputPeerEmpty
│ │ │ ├── InputPeerSelf
│ │ │ ├── InputPeerChat
│ │ │ ├── InputPeerUser
│ │ │ ├── InputPeerChannel
│ │ │ ├── InputPeerUserFromMessage
│ │ │ └── InputPeerChannelFromMessage
│ │ ├── countries_iso2 → Vector < string > (optional)
│ │ ├── prize_description → string (optional)
│ │ ├── random_id → long
│ │ ├── until_date → int
│ │ ├── currency → string
│ │ ├── amount → long
│ │ └── users → int
│ └── InputStorePaymentAuthCode
│ ├── restore → true (optional)
│ ├── phone_number → string
│ ├── phone_code_hash → string
│ ├── premium_days → int
│ ├── currency → string
│ └── amount → long
├── InputInvoiceChatInviteSubscription
│ └── hash → string
├── InputInvoiceStarGift
│ ├── hide_name → true (optional)
│ ├── include_upgrade → true (optional)
│ ├── peer → InputPeer
│ │ ├── InputPeerEmpty
│ │ ├── InputPeerSelf
│ │ ├── InputPeerChat
│ │ ├── InputPeerUser
│ │ ├── InputPeerChannel
│ │ ├── InputPeerUserFromMessage
│ │ └── InputPeerChannelFromMessage
│ ├── gift_id → long
│ └── message → TextWithEntities (optional)
│ └── TextWithEntities
│ ├── text → string
│ └── entities → Vector < MessageEntity >
│ ├── MessageEntityUnknown
│ ├── MessageEntityMention
│ ├── MessageEntityHashtag
│ ├── MessageEntityBotCommand
│ ├── MessageEntityUrl
│ ├── MessageEntityEmail
│ ├── MessageEntityBold
│ ├── MessageEntityItalic
│ ├── MessageEntityCode
│ ├── MessageEntityPre
│ ├── MessageEntityTextUrl
│ ├── MessageEntityMentionName
│ ├── InputMessageEntityMentionName
│ ├── MessageEntityPhone
│ ├── MessageEntityCashtag
│ ├── MessageEntityUnderline
│ ├── MessageEntityStrike
│ ├── MessageEntityBankCard
│ ├── MessageEntitySpoiler
│ ├── MessageEntityCustomEmoji
│ ├── MessageEntityBlockquote
│ ├── MessageEntityFormattedDate
│ ├── MessageEntityDiffInsert
│ ├── MessageEntityDiffReplace
│ └── MessageEntityDiffDelete
├── InputInvoiceStarGiftUpgrade
│ ├── keep_original_details → true (optional)
│ └── stargift → InputSavedStarGift
│ ├── InputSavedStarGiftUser
│ │ └── msg_id → int
│ ├── InputSavedStarGiftChat
│ │ ├── peer → InputPeer
│ │ │ ├── InputPeerEmpty
│ │ │ ├── InputPeerSelf
│ │ │ ├── InputPeerChat
│ │ │ ├── InputPeerUser
│ │ │ ├── InputPeerChannel
│ │ │ ├── InputPeerUserFromMessage
│ │ │ └── InputPeerChannelFromMessage
│ │ └── saved_id → long
│ └── InputSavedStarGiftSlug
│ └── slug → string
├── InputInvoiceStarGiftTransfer
│ ├── stargift → InputSavedStarGift
│ │ ├── InputSavedStarGiftUser
│ │ │ └── msg_id → int
│ │ ├── InputSavedStarGiftChat
│ │ │ ├── peer → InputPeer
│ │ │ │ ├── InputPeerEmpty
│ │ │ │ ├── InputPeerSelf
│ │ │ │ ├── InputPeerChat
│ │ │ │ ├── InputPeerUser
│ │ │ │ ├── InputPeerChannel
│ │ │ │ ├── InputPeerUserFromMessage
│ │ │ │ └── InputPeerChannelFromMessage
│ │ │ └── saved_id → long
│ │ └── InputSavedStarGiftSlug
│ │ └── slug → string
│ └── to_id → InputPeer
│ ├── InputPeerEmpty
│ ├── InputPeerSelf
│ ├── InputPeerChat
│ ├── InputPeerUser
│ ├── InputPeerChannel
│ ├── InputPeerUserFromMessage
│ └── InputPeerChannelFromMessage
├── InputInvoicePremiumGiftStars
│ ├── user_id → InputUser
│ │ ├── InputUserEmpty
│ │ ├── InputUserSelf
│ │ ├── InputUser
│ │ └── InputUserFromMessage
│ ├── months → int
│ └── message → TextWithEntities (optional)
│ └── TextWithEntities
│ ├── text → string
│ └── entities → Vector < MessageEntity >
│ ├── MessageEntityUnknown
│ ├── MessageEntityMention
│ ├── MessageEntityHashtag
│ ├── MessageEntityBotCommand
│ ├── MessageEntityUrl
│ ├── MessageEntityEmail
│ ├── MessageEntityBold
│ ├── MessageEntityItalic
│ ├── MessageEntityCode
│ ├── MessageEntityPre
│ ├── MessageEntityTextUrl
│ ├── MessageEntityMentionName
│ ├── InputMessageEntityMentionName
│ ├── MessageEntityPhone
│ ├── MessageEntityCashtag
│ ├── MessageEntityUnderline
│ ├── MessageEntityStrike
│ ├── MessageEntityBankCard
│ ├── MessageEntitySpoiler
│ ├── MessageEntityCustomEmoji
│ ├── MessageEntityBlockquote
│ ├── MessageEntityFormattedDate
│ ├── MessageEntityDiffInsert
│ ├── MessageEntityDiffReplace
│ └── MessageEntityDiffDelete
├── InputInvoiceBusinessBotTransferStars
│ ├── bot → InputUser
│ │ ├── InputUserEmpty
│ │ ├── InputUserSelf
│ │ ├── InputUser
│ │ └── InputUserFromMessage
│ └── stars → long
├── InputInvoiceStarGiftResale
│ ├── ton → true (optional)
│ ├── slug → string
│ └── to_id → InputPeer
│ ├── InputPeerEmpty
│ ├── InputPeerSelf
│ ├── InputPeerChat
│ ├── InputPeerUser
│ ├── InputPeerChannel
│ ├── InputPeerUserFromMessage
│ └── InputPeerChannelFromMessage
├── InputInvoiceStarGiftPrepaidUpgrade
│ ├── peer → InputPeer
│ │ ├── InputPeerEmpty
│ │ ├── InputPeerSelf
│ │ ├── InputPeerChat
│ │ ├── InputPeerUser
│ │ ├── InputPeerChannel
│ │ ├── InputPeerUserFromMessage
│ │ └── InputPeerChannelFromMessage
│ └── hash → string
├── InputInvoicePremiumAuthCode
│ └── purpose → InputStorePaymentPurpose
│ ├── InputStorePaymentPremiumSubscription
│ │ ├── restore → true (optional)
│ │ └── upgrade → true (optional)
│ ├── InputStorePaymentGiftPremium
│ │ ├── user_id → InputUser
│ │ │ ├── InputUserEmpty
│ │ │ ├── InputUserSelf
│ │ │ ├── InputUser
│ │ │ └── InputUserFromMessage
│ │ ├── currency → string
│ │ └── amount → long
│ ├── InputStorePaymentPremiumGiftCode
│ │ ├── users → Vector < InputUser >
│ │ │ ├── InputUserEmpty
│ │ │ ├── InputUserSelf
│ │ │ ├── InputUser
│ │ │ └── InputUserFromMessage
│ │ ├── boost_peer → InputPeer (optional)
│ │ │ ├── InputPeerEmpty
│ │ │ ├── InputPeerSelf
│ │ │ ├── InputPeerChat
│ │ │ ├── InputPeerUser
│ │ │ ├── InputPeerChannel
│ │ │ ├── InputPeerUserFromMessage
│ │ │ └── InputPeerChannelFromMessage
│ │ ├── currency → string
│ │ ├── amount → long
│ │ └── message → TextWithEntities (optional)
│ │ └── TextWithEntities
│ ├── InputStorePaymentPremiumGiveaway
│ │ ├── only_new_subscribers → true (optional)
│ │ ├── winners_are_visible → true (optional)
│ │ ├── boost_peer → InputPeer
│ │ │ ├── InputPeerEmpty
│ │ │ ├── InputPeerSelf
│ │ │ ├── InputPeerChat
│ │ │ ├── InputPeerUser
│ │ │ ├── InputPeerChannel
│ │ │ ├── InputPeerUserFromMessage
│ │ │ └── InputPeerChannelFromMessage
│ │ ├── additional_peers → Vector < InputPeer > (optional)
│ │ │ ├── InputPeerEmpty
│ │ │ ├── InputPeerSelf
│ │ │ ├── InputPeerChat
│ │ │ ├── InputPeerUser
│ │ │ ├── InputPeerChannel
│ │ │ ├── InputPeerUserFromMessage
│ │ │ └── InputPeerChannelFromMessage
│ │ ├── countries_iso2 → Vector < string > (optional)
│ │ ├── prize_description → string (optional)
│ │ ├── random_id → long
│ │ ├── until_date → int
│ │ ├── currency → string
│ │ └── amount → long
│ ├── InputStorePaymentStarsTopup
│ │ ├── stars → long
│ │ ├── currency → string
│ │ ├── amount → long
│ │ └── spend_purpose_peer → InputPeer (optional)
│ │ ├── InputPeerEmpty
│ │ ├── InputPeerSelf
│ │ ├── InputPeerChat
│ │ ├── InputPeerUser
│ │ ├── InputPeerChannel
│ │ ├── InputPeerUserFromMessage
│ │ └── InputPeerChannelFromMessage
│ ├── InputStorePaymentStarsGift
│ │ ├── user_id → InputUser
│ │ │ ├── InputUserEmpty
│ │ │ ├── InputUserSelf
│ │ │ ├── InputUser
│ │ │ └── InputUserFromMessage
│ │ ├── stars → long
│ │ ├── currency → string
│ │ └── amount → long
│ ├── InputStorePaymentStarsGiveaway
│ │ ├── only_new_subscribers → true (optional)
│ │ ├── winners_are_visible → true (optional)
│ │ ├── stars → long
│ │ ├── boost_peer → InputPeer
│ │ │ ├── InputPeerEmpty
│ │ │ ├── InputPeerSelf
│ │ │ ├── InputPeerChat
│ │ │ ├── InputPeerUser
│ │ │ ├── InputPeerChannel
│ │ │ ├── InputPeerUserFromMessage
│ │ │ └── InputPeerChannelFromMessage
│ │ ├── additional_peers → Vector < InputPeer > (optional)
│ │ │ ├── InputPeerEmpty
│ │ │ ├── InputPeerSelf
│ │ │ ├── InputPeerChat
│ │ │ ├── InputPeerUser
│ │ │ ├── InputPeerChannel
│ │ │ ├── InputPeerUserFromMessage
│ │ │ └── InputPeerChannelFromMessage
│ │ ├── countries_iso2 → Vector < string > (optional)
│ │ ├── prize_description → string (optional)
│ │ ├── random_id → long
│ │ ├── until_date → int
│ │ ├── currency → string
│ │ ├── amount → long
│ │ └── users → int
│ └── InputStorePaymentAuthCode
│ ├── restore → true (optional)
│ ├── phone_number → string
│ ├── phone_code_hash → string
│ ├── premium_days → int
│ ├── currency → string
│ └── amount → long
├── InputInvoiceStarGiftDropOriginalDetails
│ └── stargift → InputSavedStarGift
│ ├── InputSavedStarGiftUser
│ │ └── msg_id → int
│ ├── InputSavedStarGiftChat
│ │ ├── peer → InputPeer
│ │ │ ├── InputPeerEmpty
│ │ │ ├── InputPeerSelf
│ │ │ ├── InputPeerChat
│ │ │ ├── InputPeerUser
│ │ │ ├── InputPeerChannel
│ │ │ ├── InputPeerUserFromMessage
│ │ │ └── InputPeerChannelFromMessage
│ │ └── saved_id → long
│ └── InputSavedStarGiftSlug
│ └── slug → string
└── InputInvoiceStarGiftAuctionBid
├── hide_name → true (optional)
├── update_bid → true (optional)
├── peer → InputPeer (optional)
│ ├── InputPeerEmpty
│ ├── InputPeerSelf
│ ├── InputPeerChat
│ ├── InputPeerUser
│ ├── InputPeerChannel
│ ├── InputPeerUserFromMessage
│ └── InputPeerChannelFromMessage
├── gift_id → long
├── bid_amount → long
└── message → TextWithEntities (optional)
└── TextWithEntities
├── text → string
└── entities → Vector < MessageEntity >
├── MessageEntityUnknown
├── MessageEntityMention
├── MessageEntityHashtag
├── MessageEntityBotCommand
├── MessageEntityUrl
├── MessageEntityEmail
├── MessageEntityBold
├── MessageEntityItalic
├── MessageEntityCode
├── MessageEntityPre
├── MessageEntityTextUrl
├── MessageEntityMentionName
├── InputMessageEntityMentionName
├── MessageEntityPhone
├── MessageEntityCashtag
├── MessageEntityUnderline
├── MessageEntityStrike
├── MessageEntityBankCard
├── MessageEntitySpoiler
├── MessageEntityCustomEmoji
├── MessageEntityBlockquote
├── MessageEntityFormattedDate
├── MessageEntityDiffInsert
├── MessageEntityDiffReplace
└── MessageEntityDiffDelete

Example

await app.invoke(
    SendStarsForm(
        form_id=0,
        invoice=InputInvoiceMessage(
            peer=await app.resolve_peer(chat_id),
            msg_id=0
        ),
    )
)