MadelineProtoDocs/old_docs/API_docs_v95/constructors/invoice.md

48 lines
2.1 KiB
Markdown
Raw Normal View History

2019-03-29 21:12:30 +01:00
---
title: invoice
description: Invoice
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: invoice
[Back to constructors index](index.md)
Invoice
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
2019-12-27 17:48:04 +01:00
|test|[Bool](../types/Bool.md) | Optional|Test invoice|
|name\_requested|[Bool](../types/Bool.md) | Optional|Set this flag if you require the user's full name to complete the order|
|phone\_requested|[Bool](../types/Bool.md) | Optional|Set this flag if you require the user's phone number to complete the order|
|email\_requested|[Bool](../types/Bool.md) | Optional|Set this flag if you require the user's email address to complete the order|
|shipping\_address\_requested|[Bool](../types/Bool.md) | Optional|Set this flag if you require the user's shipping address to complete the order|
|flexible|[Bool](../types/Bool.md) | Optional|Set this flag if the final price depends on the shipping method|
|phone\_to\_provider|[Bool](../types/Bool.md) | Optional|Set this flag if user's phone number should be sent to provider|
|email\_to\_provider|[Bool](../types/Bool.md) | Optional|Set this flag if user's email address should be sent to provider|
|currency|[string](../types/string.md) | Yes|Three-letter ISO 4217 [currency](https://core.telegram.org/bots/payments#supported-currencies) code|
2019-03-29 21:12:30 +01:00
|prices|Array of [LabeledPrice](../types/LabeledPrice.md) | Yes|Prices|
### Type: [Invoice](../types/Invoice.md)
### Example:
```php
$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, 'currency' => 'string', 'prices' => [LabeledPrice, LabeledPrice]];
```
Or, if you're into Lua:
```lua
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, currency='string', prices={LabeledPrice}}
```