TransactionPartnerUser

Official docs ↗

Describes a transaction with a user.

Fields

typeString = userRequired

Type of the transaction partner, always "user"

transaction_typeStringRequired

Values:invoice_paymentpaid_media_paymentgift_purchasepremium_purchasebusiness_account_transfer

Type of the transaction, currently one of "invoice\payment" for payments via invoices, "paid\media\payment" for payments for paid media, "gift\purchase" for gifts sent by the bot, "premium\purchase" for Telegram Premium subscriptions gifted by the bot, "business\account\_transfer" for direct transfers from managed business accounts

userUserRequired

Information about the user

affiliateAffiliateInfoOptional

Optional. Information about the affiliate that received a commission via this transaction. Can be available only for "invoice\payment" and "paid\media\_payment" transactions.

invoice_payloadStringOptional

Optional. Bot-specified invoice payload. Can be available only for "invoice\_payment" transactions.

subscription_periodIntegerOptional

Optional. The duration of the paid subscription. Can be available only for "invoice\_payment" transactions.

paid_mediaPaidMedia[]Optional

Optional. Information about the paid media bought by the user; for "paid\media\payment" transactions only

paid_media_payloadStringOptional

Optional. Bot-specified paid media payload. Can be available only for "paid\media\payment" transactions.

giftGiftOptional

Optional. The gift sent to the user by the bot; for "gift\_purchase" transactions only

premium_subscription_durationIntegerOptional

Optional. Number of months the gifted Telegram Premium subscription will be active for; for "premium\_purchase" transactions only

GramIO Usage

See Also