Skip to content

Latest commit

 

History

History
29 lines (28 loc) · 2.32 KB

File metadata and controls

29 lines (28 loc) · 2.32 KB

# Session

Properties

Name Type Description Notes
id string A unique 25-character alphanumeric resource identifier.
resource string Resource type name, always "session".
mode \Komoju\Model\SessionMode
amount int Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD).
currency \Komoju\Model\Currency
session_url string URL to redirect the customer to for completing the session.
return_url string URL the customer is redirected to after completing or cancelling the session.
default_locale \Komoju\Model\Locale
payment_methods \Komoju\Model\PaymentMethod[] List of payment methods available for this session.
created_at \DateTime Timestamp when the session was created.
cancelled_at \DateTime Timestamp when the session was cancelled, or null if not cancelled.
completed_at \DateTime Timestamp when the session was completed, or null if not completed.
status \Komoju\Model\SessionStatus
expired bool Whether the session has expired.
merchant \Komoju\Model\MerchantData
metadata object Arbitrary key-value metadata attached to this session at creation time.
payment \Komoju\Model\Payment [optional]
payment_data \Komoju\Model\PaymentData [optional]
customer_id string Subscription customer UUID. Only present when mode includes "customer". [optional]
secure_token \Komoju\Model\SecureToken [optional]
line_items \Komoju\Model\LineItem[] Line items for this session. Only present when line items were provided on create. [optional]
merchant_id string Merchant UUID. Only present for Platform Model seller merchants. [optional]
email string Customer email. Only present when an email was provided. [optional]
[Back to Model list] [Back to API list] [Back to README]