GramIO API Reference / gramio/dist / TelegramTransactionPartnerUser
Interface: TelegramTransactionPartnerUser
Defined in: @gramio/types/out/objects.d.ts:8119
Describes a transaction with a user.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
affiliate? | TelegramAffiliateInfo | Optional. Information about the affiliate that received a commission via this transaction. Can be available only for “invoice_payment” and “paid_media_payment” transactions. | @gramio/types/out/objects.d.ts:8135 |
gift? | TelegramGift | Optional. The gift sent to the user by the bot; for “gift_purchase” transactions only | @gramio/types/out/objects.d.ts:8155 |
invoice_payload? | string | Optional. Bot-specified invoice payload. Can be available only for “invoice_payment” transactions. | @gramio/types/out/objects.d.ts:8139 |
paid_media? | TelegramPaidMedia[] | Optional. Information about the paid media bought by the user; for “paid_media_payment” transactions only | @gramio/types/out/objects.d.ts:8147 |
paid_media_payload? | string | Optional. Bot-specified paid media payload. Can be available only for “paid_media_payment” transactions. | @gramio/types/out/objects.d.ts:8151 |
premium_subscription_duration? | number | Optional. Number of months the gifted Telegram Premium subscription will be active for; for “premium_purchase” transactions only | @gramio/types/out/objects.d.ts:8159 |
subscription_period? | number | Optional. The duration of the paid subscription. Can be available only for “invoice_payment” transactions. | @gramio/types/out/objects.d.ts:8143 |
transaction_type | TelegramTransactionPartnerUserTransactionType | 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 | @gramio/types/out/objects.d.ts:8127 |
type | "user" | Type of the transaction partner, always “user” | @gramio/types/out/objects.d.ts:8123 |
user | TelegramUser | Information about the user | @gramio/types/out/objects.d.ts:8131 |