Link Search Menu Expand Document

Constructor: invoice

Back to constructors index

Invoice

Attributes:

NameTypeRequiredDescription
testBoolOptionalTest invoice
name_requestedBoolOptionalSet this flag if you require the user’s full name to complete the order
phone_requestedBoolOptionalSet this flag if you require the user’s phone number to complete the order
email_requestedBoolOptionalSet this flag if you require the user’s email address to complete the order
shipping_address_requestedBoolOptionalSet this flag if you require the user’s shipping address to complete the order
flexibleBoolOptionalSet this flag if the final price depends on the shipping method
phone_to_providerBoolOptionalSet this flag if user’s phone number should be sent to provider
email_to_providerBoolOptionalSet this flag if user’s email address should be sent to provider
recurringBoolOptionalWhether this is a recurring payment
currencystringYesThree-letter ISO 4217 currency code
pricesArray of LabeledPriceYesPrice breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)
max_tip_amountlongOptionalThe 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_amountsArray of longOptionalA 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_urlstringOptional

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'];