Session.md

Komoju::Session

Properties

Name	Type	Description	Notes
id	String	A unique 25-character alphanumeric resource identifier.
resource	String	Resource type name, always "session".
mode	SessionMode
amount	Integer	Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD).
currency	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	Locale
payment_methods	Array<PaymentMethod>	List of payment methods available for this session.
created_at	Time	Timestamp when the session was created.
cancelled_at	Time	Timestamp when the session was cancelled, or null if not cancelled.
completed_at	Time	Timestamp when the session was completed, or null if not completed.
status	SessionStatus
expired	Boolean	Whether the session has expired.
merchant	MerchantData
metadata	Object	Arbitrary key-value metadata attached to this session at creation time.
payment	Payment		[optional]
payment_data	PaymentData		[optional]
customer_id	String	Subscription customer UUID. Only present when mode includes &quot;customer&quot;.	[optional]
secure_token	SecureToken		[optional]
line_items	Array<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]

Example

require 'komoju-sdk'

instance = Komoju::Session.new(
  id: null,
  resource: null,
  mode: null,
  amount: null,
  currency: null,
  session_url: null,
  return_url: null,
  default_locale: null,
  payment_methods: null,
  created_at: null,
  cancelled_at: null,
  completed_at: null,
  status: null,
  expired: null,
  merchant: null,
  metadata: null,
  payment: null,
  payment_data: null,
  customer_id: null,
  secure_token: null,
  line_items: null,
  merchant_id: null,
  email: null
)