Skip to content

Latest commit

 

History

History
22 lines (18 loc) · 2.49 KB

File metadata and controls

22 lines (18 loc) · 2.49 KB

CreateSessionRequest

Properties

Name Type Description Notes
mode String In `customer_payment` mode, a payment will be created and: * If `customer_id` is omitted, a new customer will be created. * If `customer_id` is given, updated payment information will be saved to that customer. [default to null]
return_url String Specify the URL where user will be redirected to after they have completed or aborted the session. A `session_id` will be appended to this URL as a query parameter. [optional] [default to null]
amount Integer Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD). [default to null]
currency Currency [default to null]
email String Customer's email address. [optional] [default to null]
expires_in_seconds Integer Time in seconds until the session expires after being created. The default value and upper limit are 86,400 seconds (24 hours). [optional] [default to null]
external_customer_id String An unique identifier of your customer. If your system has the concept of user accounts, then the ID of the current logged in user would be appropriate. [optional] [default to null]
payment_types List Specify which payment types are available for this session. By default, all activated payment methods will be available for the session if this value is omitted. [optional] [default to null]
default_locale Locale [optional] [default to null]
line_items List Specify the line items which will be displayed on the session page. [optional] [default to null]
metadata Object Store any additional data you want to associate with the session. The object's keys and values must be strings. Keys have a maximum length of 30 characters. Values have a maximum length of 2000 characters. [optional] [default to null]
payment_data PaymentDataRequest [optional] [default to null]
customer_id String If provided, updated payment details will be saved on the customer. [optional] [default to null]

[Back to Model list] [Back to API list] [Back to README]