digitaluapi

<back to all web services

GetStripeSession

The following routes are available for this service:
All Verbs/stripe-session/{Id}
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class GetStripeSession
{
    open var Id:String? = null
}

open class Session : StripeEntity_1<Session>(), IHasId, IHasMetadata, IHasObject
{
    override var Id:String? = null
    override var Object:String? = null
    open var AfterExpiration:SessionAfterExpiration? = null
    open var AllowPromotionCodes:Boolean? = null
    open var AmountSubtotal:Long? = null
    open var AmountTotal:Long? = null
    open var AutomaticTax:SessionAutomaticTax? = null
    open var BillingAddressCollection:String? = null
    open var CancelUrl:String? = null
    open var ClientReferenceId:String? = null
    open var Consent:SessionConsent? = null
    open var ConsentCollection:SessionConsentCollection? = null
    open var Created:Date? = null
    open var Currency:String? = null
    open var CustomFields:ArrayList<SessionCustomField>? = null
    open var CustomText:SessionCustomText? = null
    open var CustomerCreation:String? = null
    open var CustomerDetails:SessionCustomerDetails? = null
    open var CustomerEmail:String? = null
    open var ExpiresAt:Date? = null
    open var InvoiceCreation:SessionInvoiceCreation? = null
    open var LineItems:StripeList<LineItem>? = null
    open var Livemode:Boolean? = null
    open var Locale:String? = null
    override var Metadata:HashMap<String,String>? = null
    open var Mode:String? = null
    open var PaymentMethodCollection:String? = null
    open var PaymentMethodOptions:SessionPaymentMethodOptions? = null
    open var PaymentMethodTypes:ArrayList<String>? = null
    open var PaymentStatus:String? = null
    open var PhoneNumberCollection:SessionPhoneNumberCollection? = null
    open var RecoveredFrom:String? = null
    open var ShippingAddressCollection:SessionShippingAddressCollection? = null
    open var ShippingCost:SessionShippingCost? = null
    open var ShippingDetails:SessionShippingDetails? = null
    open var ShippingOptions:ArrayList<SessionShippingOption>? = null
    open var Status:String? = null
    open var SubmitType:String? = null
    open var SuccessUrl:String? = null
    open var TaxIdCollection:SessionTaxIdCollection? = null
    open var TotalDetails:SessionTotalDetails? = null
    open var Url:String? = null
}

open class StripeEntity_1<T> : StripeEntity()
{
}

open class StripeEntity : IStripeEntity
{
}

open class SessionAfterExpiration : StripeEntity_1<SessionAfterExpiration>()
{
    open var Recovery:SessionAfterExpirationRecovery? = null
}

open class SessionAfterExpirationRecovery : StripeEntity_1<SessionAfterExpirationRecovery>()
{
    open var AllowPromotionCodes:Boolean? = null
    open var Enabled:Boolean? = null
    open var ExpiresAt:Date? = null
    open var Url:String? = null
}

open class SessionAutomaticTax : StripeEntity_1<SessionAutomaticTax>()
{
    open var Enabled:Boolean? = null
    open var Status:String? = null
}

open class SessionConsent : StripeEntity_1<SessionConsent>()
{
    open var Promotions:String? = null
    open var TermsOfService:String? = null
}

open class SessionConsentCollection : StripeEntity_1<SessionConsentCollection>()
{
    open var Promotions:String? = null
    open var TermsOfService:String? = null
}

open class SessionCustomField : StripeEntity_1<SessionCustomField>()
{
    open var Dropdown:SessionCustomFieldDropdown? = null
    open var Key:String? = null
    open var Label:SessionCustomFieldLabel? = null
    open var Numeric:SessionCustomFieldNumeric? = null
    open var Optional:Boolean? = null
    open var Text:SessionCustomFieldText? = null
    open var Type:String? = null
}

open class SessionCustomFieldDropdown : StripeEntity_1<SessionCustomFieldDropdown>()
{
    open var Options:ArrayList<SessionCustomFieldDropdownOption>? = null
    open var Value:String? = null
}

open class SessionCustomFieldDropdownOption : StripeEntity_1<SessionCustomFieldDropdownOption>()
{
    open var Label:String? = null
    open var Value:String? = null
}

open class SessionCustomFieldLabel : StripeEntity_1<SessionCustomFieldLabel>()
{
    open var Custom:String? = null
    open var Type:String? = null
}

open class SessionCustomFieldNumeric : StripeEntity_1<SessionCustomFieldNumeric>()
{
    open var Value:String? = null
}

open class SessionCustomFieldText : StripeEntity_1<SessionCustomFieldText>()
{
    open var Value:String? = null
}

open class SessionCustomText : StripeEntity_1<SessionCustomText>()
{
    open var ShippingAddress:SessionCustomTextShippingAddress? = null
    open var Submit:SessionCustomTextSubmit? = null
}

open class SessionCustomTextShippingAddress : StripeEntity_1<SessionCustomTextShippingAddress>()
{
    open var Message:String? = null
}

open class SessionCustomTextSubmit : StripeEntity_1<SessionCustomTextSubmit>()
{
    open var Message:String? = null
}

open class SessionCustomerDetails : StripeEntity_1<SessionCustomerDetails>()
{
    open var Address:Address? = null
    open var Email:String? = null
    open var Name:String? = null
    open var Phone:String? = null
    open var TaxExempt:String? = null
    open var TaxIds:ArrayList<SessionCustomerDetailsTaxId>? = null
}

open class Address : StripeEntity_1<Address>()
{
    open var City:String? = null
    open var Country:String? = null
    open var Line1:String? = null
    open var Line2:String? = null
    open var PostalCode:String? = null
    open var State:String? = null
}

open class SessionCustomerDetailsTaxId : StripeEntity_1<SessionCustomerDetailsTaxId>()
{
    open var Type:String? = null
    open var Value:String? = null
}

open class SessionInvoiceCreation : StripeEntity_1<SessionInvoiceCreation>()
{
    open var Enabled:Boolean? = null
    open var InvoiceData:SessionInvoiceCreationInvoiceData? = null
}

open class SessionInvoiceCreationInvoiceData : StripeEntity_1<SessionInvoiceCreationInvoiceData>(), IHasMetadata
{
    open var CustomFields:ArrayList<SessionInvoiceCreationInvoiceDataCustomField>? = null
    open var Description:String? = null
    open var Footer:String? = null
    override var Metadata:HashMap<String,String>? = null
    open var RenderingOptions:SessionInvoiceCreationInvoiceDataRenderingOptions? = null
}

open class SessionInvoiceCreationInvoiceDataCustomField : StripeEntity_1<SessionInvoiceCreationInvoiceDataCustomField>()
{
    open var Name:String? = null
    open var Value:String? = null
}

open class SessionInvoiceCreationInvoiceDataRenderingOptions : StripeEntity_1<SessionInvoiceCreationInvoiceDataRenderingOptions>()
{
    open var AmountTaxDisplay:String? = null
}

open class StripeList<T> : StripeEntity_1<StripeList<T>>(), IHasObject
{
}

open class LineItem : StripeEntity_1<LineItem>(), IHasId, IHasObject
{
    override var Id:String? = null
    override var Object:String? = null
    open var AmountDiscount:Long? = null
    open var AmountSubtotal:Long? = null
    open var AmountTax:Long? = null
    open var AmountTotal:Long? = null
    open var Currency:String? = null
    open var Deleted:Boolean? = null
    open var Description:String? = null
    open var Discounts:ArrayList<LineItemDiscount>? = null
    open var Price:Price? = null
    open var Quantity:Long? = null
    open var Taxes:ArrayList<LineItemTax>? = null
}

open class LineItemDiscount : StripeEntity_1<LineItemDiscount>()
{
    open var Amount:Long? = null
    open var Discount:Discount? = null
}

open class Discount : StripeEntity_1<Discount>(), IHasId, IHasObject
{
    override var Id:String? = null
    override var Object:String? = null
    open var CheckoutSession:String? = null
    open var Coupon:Coupon? = null
    open var Deleted:Boolean? = null
    open var End:Date? = null
    open var Invoice:String? = null
    open var InvoiceItem:String? = null
    open var Start:Date? = null
}

open class Coupon : StripeEntity_1<Coupon>(), IHasId, IHasMetadata, IHasObject
{
    override var Id:String? = null
    override var Object:String? = null
    open var AmountOff:Long? = null
    open var AppliesTo:CouponAppliesTo? = null
    open var Created:Date? = null
    open var Currency:String? = null
    open var CurrencyOptions:HashMap<String,CouponCurrencyOptions>? = null
    open var Deleted:Boolean? = null
    open var Duration:String? = null
    open var DurationInMonths:Long? = null
    open var Livemode:Boolean? = null
    open var MaxRedemptions:Long? = null
    override var Metadata:HashMap<String,String>? = null
    open var Name:String? = null
    open var PercentOff:BigDecimal? = null
    open var RedeemBy:Date? = null
    open var TimesRedeemed:Long? = null
    open var Valid:Boolean? = null
}

open class CouponAppliesTo : StripeEntity_1<CouponAppliesTo>()
{
    open var Products:ArrayList<String>? = null
}

open class CouponCurrencyOptions : StripeEntity_1<CouponCurrencyOptions>()
{
    open var AmountOff:Long? = null
}

open class Price : StripeEntity_1<Price>(), IHasId, IHasMetadata, IHasObject
{
    override var Id:String? = null
    override var Object:String? = null
    open var Active:Boolean? = null
    open var BillingScheme:String? = null
    open var Created:Date? = null
    open var Currency:String? = null
    open var CurrencyOptions:HashMap<String,PriceCurrencyOptions>? = null
    open var CustomUnitAmount:PriceCustomUnitAmount? = null
    open var Deleted:Boolean? = null
    open var Livemode:Boolean? = null
    open var LookupKey:String? = null
    override var Metadata:HashMap<String,String>? = null
    open var Nickname:String? = null
    open var Recurring:PriceRecurring? = null
    open var TaxBehavior:String? = null
    open var Tiers:ArrayList<PriceTier>? = null
    open var TiersMode:String? = null
    open var TransformQuantity:PriceTransformQuantity? = null
    open var Type:String? = null
    open var UnitAmount:Long? = null
    open var UnitAmountDecimal:BigDecimal? = null
}

open class PriceCurrencyOptions : StripeEntity_1<PriceCurrencyOptions>()
{
    open var CustomUnitAmount:PriceCurrencyOptionsCustomUnitAmount? = null
    open var TaxBehavior:String? = null
    open var Tiers:ArrayList<PriceCurrencyOptionsTier>? = null
    open var UnitAmount:Long? = null
    open var UnitAmountDecimal:BigDecimal? = null
}

open class PriceCurrencyOptionsCustomUnitAmount : StripeEntity_1<PriceCurrencyOptionsCustomUnitAmount>()
{
    open var Maximum:Long? = null
    open var Minimum:Long? = null
    open var Preset:Long? = null
}

open class PriceCurrencyOptionsTier : StripeEntity_1<PriceCurrencyOptionsTier>()
{
    open var FlatAmount:Long? = null
    open var FlatAmountDecimal:BigDecimal? = null
    open var UnitAmount:Long? = null
    open var UnitAmountDecimal:BigDecimal? = null
    open var UpTo:Long? = null
}

open class PriceCustomUnitAmount : StripeEntity_1<PriceCustomUnitAmount>()
{
    open var Maximum:Long? = null
    open var Minimum:Long? = null
    open var Preset:Long? = null
}

open class PriceRecurring : StripeEntity_1<PriceRecurring>()
{
    open var AggregateUsage:String? = null
    open var Interval:String? = null
    open var IntervalCount:Long? = null
    open var TrialPeriodDays:Long? = null
    open var UsageType:String? = null
}

open class PriceTier : StripeEntity_1<PriceTier>()
{
    open var FlatAmount:Long? = null
    open var FlatAmountDecimal:BigDecimal? = null
    open var UnitAmount:Long? = null
    open var UnitAmountDecimal:BigDecimal? = null
    open var UpTo:Long? = null
}

open class PriceTransformQuantity : StripeEntity_1<PriceTransformQuantity>()
{
    open var DivideBy:Long? = null
    open var Round:String? = null
}

open class LineItemTax : StripeEntity_1<LineItemTax>()
{
    open var Amount:Long? = null
    open var Rate:TaxRate? = null
}

open class TaxRate : StripeEntity_1<TaxRate>(), IHasId, IHasMetadata, IHasObject
{
    override var Id:String? = null
    override var Object:String? = null
    open var Active:Boolean? = null
    open var Country:String? = null
    open var Created:Date? = null
    open var Description:String? = null
    open var DisplayName:String? = null
    open var Inclusive:Boolean? = null
    open var Jurisdiction:String? = null
    open var Livemode:Boolean? = null
    override var Metadata:HashMap<String,String>? = null
    open var Percentage:BigDecimal? = null
    open var State:String? = null
    open var TaxType:String? = null
}

open class SessionPaymentMethodOptions : StripeEntity_1<SessionPaymentMethodOptions>()
{
    open var AcssDebit:SessionPaymentMethodOptionsAcssDebit? = null
    open var Affirm:SessionPaymentMethodOptionsAffirm? = null
    open var AfterpayClearpay:SessionPaymentMethodOptionsAfterpayClearpay? = null
    open var Alipay:SessionPaymentMethodOptionsAlipay? = null
    open var AuBecsDebit:SessionPaymentMethodOptionsAuBecsDebit? = null
    open var BacsDebit:SessionPaymentMethodOptionsBacsDebit? = null
    open var Bancontact:SessionPaymentMethodOptionsBancontact? = null
    open var Boleto:SessionPaymentMethodOptionsBoleto? = null
    open var Card:SessionPaymentMethodOptionsCard? = null
    open var CustomerBalance:SessionPaymentMethodOptionsCustomerBalance? = null
    open var Eps:SessionPaymentMethodOptionsEps? = null
    open var Fpx:SessionPaymentMethodOptionsFpx? = null
    open var Giropay:SessionPaymentMethodOptionsGiropay? = null
    open var Grabpay:SessionPaymentMethodOptionsGrabpay? = null
    open var Ideal:SessionPaymentMethodOptionsIdeal? = null
    open var Klarna:SessionPaymentMethodOptionsKlarna? = null
    open var Konbini:SessionPaymentMethodOptionsKonbini? = null
    open var Oxxo:SessionPaymentMethodOptionsOxxo? = null
    open var P24:SessionPaymentMethodOptionsP24? = null
    open var Paynow:SessionPaymentMethodOptionsPaynow? = null
    open var Pix:SessionPaymentMethodOptionsPix? = null
    open var SepaDebit:SessionPaymentMethodOptionsSepaDebit? = null
    open var Sofort:SessionPaymentMethodOptionsSofort? = null
    open var UsBankAccount:SessionPaymentMethodOptionsUsBankAccount? = null
}

open class SessionPaymentMethodOptionsAcssDebit : StripeEntity_1<SessionPaymentMethodOptionsAcssDebit>()
{
    open var Currency:String? = null
    open var MandateOptions:SessionPaymentMethodOptionsAcssDebitMandateOptions? = null
    open var SetupFutureUsage:String? = null
    open var VerificationMethod:String? = null
}

open class SessionPaymentMethodOptionsAcssDebitMandateOptions : StripeEntity_1<SessionPaymentMethodOptionsAcssDebitMandateOptions>()
{
    open var CustomMandateUrl:String? = null
    open var DefaultFor:ArrayList<String>? = null
    open var IntervalDescription:String? = null
    open var PaymentSchedule:String? = null
    open var TransactionType:String? = null
}

open class SessionPaymentMethodOptionsAffirm : StripeEntity_1<SessionPaymentMethodOptionsAffirm>()
{
    open var SetupFutureUsage:String? = null
}

open class SessionPaymentMethodOptionsAfterpayClearpay : StripeEntity_1<SessionPaymentMethodOptionsAfterpayClearpay>()
{
    open var SetupFutureUsage:String? = null
}

open class SessionPaymentMethodOptionsAlipay : StripeEntity_1<SessionPaymentMethodOptionsAlipay>()
{
    open var SetupFutureUsage:String? = null
}

open class SessionPaymentMethodOptionsAuBecsDebit : StripeEntity_1<SessionPaymentMethodOptionsAuBecsDebit>()
{
    open var SetupFutureUsage:String? = null
}

open class SessionPaymentMethodOptionsBacsDebit : StripeEntity_1<SessionPaymentMethodOptionsBacsDebit>()
{
    open var SetupFutureUsage:String? = null
}

open class SessionPaymentMethodOptionsBancontact : StripeEntity_1<SessionPaymentMethodOptionsBancontact>()
{
    open var SetupFutureUsage:String? = null
}

open class SessionPaymentMethodOptionsBoleto : StripeEntity_1<SessionPaymentMethodOptionsBoleto>()
{
    open var ExpiresAfterDays:Long? = null
    open var SetupFutureUsage:String? = null
}

open class SessionPaymentMethodOptionsCard : StripeEntity_1<SessionPaymentMethodOptionsCard>()
{
    open var Installments:SessionPaymentMethodOptionsCardInstallments? = null
    open var SetupFutureUsage:String? = null
    open var StatementDescriptorSuffixKana:String? = null
    open var StatementDescriptorSuffixKanji:String? = null
}

open class SessionPaymentMethodOptionsCardInstallments : StripeEntity_1<SessionPaymentMethodOptionsCardInstallments>()
{
    open var Enabled:Boolean? = null
}

open class SessionPaymentMethodOptionsCustomerBalance : StripeEntity_1<SessionPaymentMethodOptionsCustomerBalance>()
{
    open var BankTransfer:SessionPaymentMethodOptionsCustomerBalanceBankTransfer? = null
    open var FundingType:String? = null
    open var SetupFutureUsage:String? = null
}

open class SessionPaymentMethodOptionsCustomerBalanceBankTransfer : StripeEntity_1<SessionPaymentMethodOptionsCustomerBalanceBankTransfer>()
{
    open var EuBankTransfer:SessionPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer? = null
    open var RequestedAddressTypes:ArrayList<String>? = null
    open var Type:String? = null
}

open class SessionPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer : StripeEntity_1<SessionPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer>()
{
    open var Country:String? = null
}

open class SessionPaymentMethodOptionsEps : StripeEntity_1<SessionPaymentMethodOptionsEps>()
{
    open var SetupFutureUsage:String? = null
}

open class SessionPaymentMethodOptionsFpx : StripeEntity_1<SessionPaymentMethodOptionsFpx>()
{
    open var SetupFutureUsage:String? = null
}

open class SessionPaymentMethodOptionsGiropay : StripeEntity_1<SessionPaymentMethodOptionsGiropay>()
{
    open var SetupFutureUsage:String? = null
}

open class SessionPaymentMethodOptionsGrabpay : StripeEntity_1<SessionPaymentMethodOptionsGrabpay>()
{
    open var SetupFutureUsage:String? = null
}

open class SessionPaymentMethodOptionsIdeal : StripeEntity_1<SessionPaymentMethodOptionsIdeal>()
{
    open var SetupFutureUsage:String? = null
}

open class SessionPaymentMethodOptionsKlarna : StripeEntity_1<SessionPaymentMethodOptionsKlarna>()
{
    open var SetupFutureUsage:String? = null
}

open class SessionPaymentMethodOptionsKonbini : StripeEntity_1<SessionPaymentMethodOptionsKonbini>()
{
    open var ExpiresAfterDays:Long? = null
    open var SetupFutureUsage:String? = null
}

open class SessionPaymentMethodOptionsOxxo : StripeEntity_1<SessionPaymentMethodOptionsOxxo>()
{
    open var ExpiresAfterDays:Long? = null
    open var SetupFutureUsage:String? = null
}

open class SessionPaymentMethodOptionsP24 : StripeEntity_1<SessionPaymentMethodOptionsP24>()
{
    open var SetupFutureUsage:String? = null
}

open class SessionPaymentMethodOptionsPaynow : StripeEntity_1<SessionPaymentMethodOptionsPaynow>()
{
    open var SetupFutureUsage:String? = null
}

open class SessionPaymentMethodOptionsPix : StripeEntity_1<SessionPaymentMethodOptionsPix>()
{
    open var ExpiresAfterSeconds:Long? = null
}

open class SessionPaymentMethodOptionsSepaDebit : StripeEntity_1<SessionPaymentMethodOptionsSepaDebit>()
{
    open var SetupFutureUsage:String? = null
}

open class SessionPaymentMethodOptionsSofort : StripeEntity_1<SessionPaymentMethodOptionsSofort>()
{
    open var SetupFutureUsage:String? = null
}

open class SessionPaymentMethodOptionsUsBankAccount : StripeEntity_1<SessionPaymentMethodOptionsUsBankAccount>()
{
    open var FinancialConnections:SessionPaymentMethodOptionsUsBankAccountFinancialConnections? = null
    open var SetupFutureUsage:String? = null
    open var VerificationMethod:String? = null
}

open class SessionPaymentMethodOptionsUsBankAccountFinancialConnections : StripeEntity_1<SessionPaymentMethodOptionsUsBankAccountFinancialConnections>()
{
    open var Permissions:ArrayList<String>? = null
    open var ReturnUrl:String? = null
}

open class SessionPhoneNumberCollection : StripeEntity_1<SessionPhoneNumberCollection>()
{
    open var Enabled:Boolean? = null
}

open class SessionShippingAddressCollection : StripeEntity_1<SessionShippingAddressCollection>()
{
    open var AllowedCountries:ArrayList<String>? = null
}

open class SessionShippingCost : StripeEntity_1<SessionShippingCost>()
{
    open var AmountSubtotal:Long? = null
    open var AmountTax:Long? = null
    open var AmountTotal:Long? = null
    open var Taxes:ArrayList<SessionShippingCostTax>? = null
}

open class SessionShippingCostTax : StripeEntity_1<SessionShippingCostTax>()
{
    open var Amount:Long? = null
    open var Rate:TaxRate? = null
}

open class SessionShippingDetails : StripeEntity_1<SessionShippingDetails>()
{
    open var Address:Address? = null
    open var Carrier:String? = null
    open var Name:String? = null
    open var Phone:String? = null
    open var TrackingNumber:String? = null
}

open class SessionShippingOption : StripeEntity_1<SessionShippingOption>()
{
    open var ShippingAmount:Long? = null
}

open class SessionTaxIdCollection : StripeEntity_1<SessionTaxIdCollection>()
{
    open var Enabled:Boolean? = null
}

open class SessionTotalDetails : StripeEntity_1<SessionTotalDetails>()
{
    open var AmountDiscount:Long? = null
    open var AmountShipping:Long? = null
    open var AmountTax:Long? = null
    open var Breakdown:SessionTotalDetailsBreakdown? = null
}

open class SessionTotalDetailsBreakdown : StripeEntity_1<SessionTotalDetailsBreakdown>()
{
    open var Discounts:ArrayList<SessionTotalDetailsBreakdownDiscount>? = null
    open var Taxes:ArrayList<SessionTotalDetailsBreakdownTax>? = null
}

open class SessionTotalDetailsBreakdownDiscount : StripeEntity_1<SessionTotalDetailsBreakdownDiscount>()
{
    open var Amount:Long? = null
    open var Discount:Discount? = null
}

open class SessionTotalDetailsBreakdownTax : StripeEntity_1<SessionTotalDetailsBreakdownTax>()
{
    open var Amount:Long? = null
    open var Rate:TaxRate? = null
}

Kotlin GetStripeSession DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /stripe-session/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Id":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{Unable to show example output for type 'Session' using the custom 'other' filter}Exception has been thrown by the target of an invocation.