Record

session

No description available.

record session {
  after-expiration: option​<string>,
  allow-promotion-codes: option​<bool>,
  amount-subtotal: option​<s32>,
  amount-total: option​<s32>,
  automatic-tax: payment-pages-checkout-session-automatic-tax,
  billing-address-collection: option​<session-billing-address-collection-enum>,
  cancel-url: option​<string>,
  client-reference-id: option​<string>,
  consent: option​<string>,
  consent-collection: option​<string>,
  created: s32,
  currency: option​<string>,
  currency-conversion: option​<string>,
  custom-fields: list​<payment-pages-checkout-session-custom-fields>,
  custom-text: payment-pages-checkout-session-custom-text,
  customer: option​<string>,
  customer-creation: option​<session-customer-creation-enum>,
  customer-details: option​<string>,
  customer-email: option​<string>,
  expires-at: s32,
  id: string,
  invoice: option​<string>,
  invoice-creation: option​<string>,
  line-items: option​<session-line-items>,
  livemode: bool,
  locale: option​<session-locale-enum>,
  metadata: option​<session-metadata>,
  mode: session-mode-enum,
  object: session-object-enum,
  payment-intent: option​<string>,
  payment-link: option​<string>,
  payment-method-collection: option​<session-customer-creation-enum>,
  payment-method-options: option​<string>,
  payment-method-types: list​<string>,
  payment-status: session-payment-status-enum,
  phone-number-collection: option​<payment-pages-checkout-session-phone-number-collection>,
  recovered-from: option​<string>,
  setup-intent: option​<string>,
  shipping-address-collection: option​<string>,
  shipping-cost: option​<string>,
  shipping-details: option​<string>,
  shipping-options: list​<payment-pages-checkout-session-shipping-option>,
  status: option​<session-status-enum>,
  submit-type: option​<session-submit-type-enum>,
  subscription: option​<string>,
  success-url: string,
  tax-id-collection: option​<payment-pages-checkout-session-tax-id-collection>,
  total-details: option​<string>,
  url: option​<string>,
}

Fields

NameTypeDescription
after-expirationoption​<string>
allow-promotion-codesoption​<bool>
amount-subtotaloption​<s32>
amount-totaloption​<s32>
automatic-taxpayment-pages-checkout-session-automatic-tax
billing-address-collectionoption​<session-billing-address-collection-enum>
cancel-urloption​<string>
client-reference-idoption​<string>
consentoption​<string>
consent-collectionoption​<string>
createds32
currencyoption​<string>
currency-conversionoption​<string>
custom-fieldslist​<payment-pages-checkout-session-custom-fields>
custom-textpayment-pages-checkout-session-custom-text
customeroption​<string>
customer-creationoption​<session-customer-creation-enum>
customer-detailsoption​<string>
customer-emailoption​<string>
expires-ats32
idstring
invoiceoption​<string>
invoice-creationoption​<string>
line-itemsoption​<session-line-items>
livemodebool
localeoption​<session-locale-enum>
metadataoption​<session-metadata>
modesession-mode-enum
objectsession-object-enum
payment-intentoption​<string>
payment-linkoption​<string>
payment-method-collectionoption​<session-customer-creation-enum>
payment-method-optionsoption​<string>
payment-method-typeslist​<string>
payment-statussession-payment-status-enum
phone-number-collectionoption​<payment-pages-checkout-session-phone-number-collection>
recovered-fromoption​<string>
setup-intentoption​<string>
shipping-address-collectionoption​<string>
shipping-costoption​<string>
shipping-detailsoption​<string>
shipping-optionslist​<payment-pages-checkout-session-shipping-option>
statusoption​<session-status-enum>
submit-typeoption​<session-submit-type-enum>
subscriptionoption​<string>
success-urlstring
tax-id-collectionoption​<payment-pages-checkout-session-tax-id-collection>
total-detailsoption​<string>
urloption​<string>