TransactionPartnerUser

interface

Describes a transaction with a user.

Declaration

interface TransactionPartnerUser

Properties

affiliateproperty#

affiliate?: AffiliateInfo;

Optional. Information about the affiliate that received a commission via this transaction. Can be available only for "invoice_payment" and "paid_media_payment" transactions.

giftproperty#

gift?: Gift;

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

invoice_payloadproperty#

invoice_payload?: string;

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

paid_media_payloadproperty#

paid_media_payload?: string;

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

paid_mediaproperty#

paid_media?: PaidMedia[];

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

premium_subscription_durationproperty#

premium_subscription_duration?: number;

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

subscription_periodproperty#

subscription_period?: number;

Optional. The duration of the paid subscription. Can be available only for "invoice_payment" transactions.

transaction_typeproperty#

transaction_type: string;

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

typeproperty#

type: 'user';

Type of the transaction partner, always "user"

userproperty#

user: User;

Information about the user