TransactionPartnerUser

^{ref / types / TransactionPartnerUser}

Describes a transaction with a user.

^Source

Properties

type

type: "user";

Type of the transaction partner, always “user”

^Source

transaction_type

transaction_type: "invoice_payment" | "paid_media_payment" | "gift_purchase" | "premium_purchase" | "business_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

^Source

user

user: User;

Information about the user

^Source

affiliate

affiliate?: AffiliateInfo;

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

^Source

invoice_payload

invoice_payload?: string;

Bot-specified invoice payload. Can be available only for “invoice_payment” transactions.

^Source

subscription_period

subscription_period?: number;

The duration of the paid subscription. Can be available only for “invoice_payment” transactions.

^Source

paid_media

paid_media?: PaidMedia[];

Information about the paid media bought by the user; for “paid_media_payment” transactions only

^Source

paid_media_payload

paid_media_payload?: string;

Bot-specified paid media payload. Can be available only for “paid_media_payment” transactions.

^Source

gift

gift?: Gift;

The gift sent to the user by the bot; for “gift_purchase” transactions only

^Source

premium_subscription_duration

premium_subscription_duration?: number;

Number of months the gifted Telegram Premium subscription will be active for; for “premium_purchase” transactions only

^Source