MadelineProtoDocs/docs/API_docs/constructors/invoice.md
2024-05-01 14:53:46 +02:00

3.1 KiB

title description nav_exclude image
invoice Invoice true https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png

Constructor: invoice

Back to constructors index

Invoice

Attributes:

Name Type Required Description
test Bool Optional Test invoice
name_requested Bool Optional Set this flag if you require the user's full name to complete the order
phone_requested Bool Optional Set this flag if you require the user's phone number to complete the order
email_requested Bool Optional Set this flag if you require the user's email address to complete the order
shipping_address_requested Bool Optional Set this flag if you require the user's shipping address to complete the order
flexible Bool Optional Set this flag if the final price depends on the shipping method
phone_to_provider Bool Optional Set this flag if user's phone number should be sent to provider
email_to_provider Bool Optional Set this flag if user's email address should be sent to provider
recurring Bool Optional Whether this is a recurring payment
currency string Yes Three-letter ISO 4217 currency code
prices Array of LabeledPrice Yes Price breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)
max_tip_amount long Optional The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
suggested_tip_amounts Array of long Optional A vector of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount.
terms_url string Optional Terms of service URL

Type: Invoice

Example:

$invoice = ['_' => 'invoice', 'test' => Bool, 'name_requested' => Bool, 'phone_requested' => Bool, 'email_requested' => Bool, 'shipping_address_requested' => Bool, 'flexible' => Bool, 'phone_to_provider' => Bool, 'email_to_provider' => Bool, 'recurring' => Bool, 'currency' => 'string', 'prices' => [LabeledPrice, LabeledPrice], 'max_tip_amount' => long, 'suggested_tip_amounts' => [long, long], 'terms_url' => 'string'];