digitaluapi

GetStripeSession

The following routes are available for this service:
All Verbs	/stripe-session/{Id}

**GetStripeSession** Parameters:
Name	Parameter	Data Type	Required	Description
Id	path	string	No

**Session** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Object	form	string	No
AfterExpiration	form	SessionAfterExpiration	No
AllowPromotionCodes	form	bool?	No
AmountSubtotal	form	long?	No
AmountTotal	form	long?	No
AutomaticTax	form	SessionAutomaticTax	No
BillingAddressCollection	form	string	No
CancelUrl	form	string	No
ClientReferenceId	form	string	No
Consent	form	SessionConsent	No
ConsentCollection	form	SessionConsentCollection	No
Created	form	DateTime	No
Currency	form	string	No
CustomFields	form	List<SessionCustomField>	No
CustomText	form	SessionCustomText	No
CustomerCreation	form	string	No
CustomerDetails	form	SessionCustomerDetails	No
CustomerEmail	form	string	No
ExpiresAt	form	DateTime	No
InvoiceCreation	form	SessionInvoiceCreation	No
LineItems	form	StripeList<LineItem>	No
Livemode	form	bool	No
Locale	form	string	No
Metadata	form	Dictionary<string, string>	No
Mode	form	string	No
PaymentMethodCollection	form	string	No
PaymentMethodOptions	form	SessionPaymentMethodOptions	No
PaymentMethodTypes	form	List<string>	No
PaymentStatus	form	string	No
PhoneNumberCollection	form	SessionPhoneNumberCollection	No
RecoveredFrom	form	string	No
ShippingAddressCollection	form	SessionShippingAddressCollection	No
ShippingCost	form	SessionShippingCost	No
ShippingDetails	form	SessionShippingDetails	No
ShippingOptions	form	List<SessionShippingOption>	No
Status	form	string	No
SubmitType	form	string	No
SuccessUrl	form	string	No
TaxIdCollection	form	SessionTaxIdCollection	No
TotalDetails	form	SessionTotalDetails	No
Url	form	string	No

**SessionAfterExpiration** Parameters:
Name	Parameter	Data Type	Required	Description
Recovery	form	SessionAfterExpirationRecovery	No

**SessionAfterExpirationRecovery** Parameters:
Name	Parameter	Data Type	Required
AllowPromotionCodes	form	bool	No
Enabled	form	bool	No
ExpiresAt	form	DateTime?	No
Url	form	string	No

**SessionAutomaticTax** Parameters:
Name	Parameter	Data Type	Required	Description
Enabled	form	bool	No
Status	form	string	No

**SessionConsent** Parameters:
Name	Parameter	Data Type	Required	Description
Promotions	form	string	No
TermsOfService	form	string	No

**SessionConsentCollection** Parameters:
Name	Parameter	Data Type	Required	Description
Promotions	form	string	No
TermsOfService	form	string	No

**SessionCustomField** Parameters:
Name	Parameter	Data Type	Required
Dropdown	form	SessionCustomFieldDropdown	No
Key	form	string	No
Label	form	SessionCustomFieldLabel	No
Numeric	form	SessionCustomFieldNumeric	No
Optional	form	bool	No
Text	form	SessionCustomFieldText	No
Type	form	string	No

**SessionCustomFieldDropdown** Parameters:
Name	Parameter	Data Type	Required	Description
Options	form	List<SessionCustomFieldDropdownOption>	No
Value	form	string	No

**SessionCustomFieldDropdownOption** Parameters:
Name	Parameter	Data Type	Required	Description
Label	form	string	No
Value	form	string	No

**SessionCustomFieldLabel** Parameters:
Name	Parameter	Data Type	Required	Description
Custom	form	string	No
Type	form	string	No

**SessionCustomFieldNumeric** Parameters:
Name	Parameter	Data Type	Required	Description
Value	form	string	No

**SessionCustomFieldText** Parameters:
Name	Parameter	Data Type	Required	Description
Value	form	string	No

**SessionCustomText** Parameters:
Name	Parameter	Data Type	Required	Description
ShippingAddress	form	SessionCustomTextShippingAddress	No
Submit	form	SessionCustomTextSubmit	No

**SessionCustomTextShippingAddress** Parameters:
Name	Parameter	Data Type	Required	Description
Message	form	string	No

**SessionCustomTextSubmit** Parameters:
Name	Parameter	Data Type	Required	Description
Message	form	string	No

**SessionCustomerDetails** Parameters:
Name	Parameter	Data Type	Required
Address	form	Address	No
Email	form	string	No
Name	form	string	No
Phone	form	string	No
TaxExempt	form	string	No
TaxIds	form	List<SessionCustomerDetailsTaxId>	No

**Address** Parameters:
Name	Parameter	Data Type	Required
City	form	string	No
Country	form	string	No
Line1	form	string	No
Line2	form	string	No
PostalCode	form	string	No
State	form	string	No

**SessionCustomerDetailsTaxId** Parameters:
Name	Parameter	Data Type	Required	Description
Type	form	string	No
Value	form	string	No

**SessionInvoiceCreation** Parameters:
Name	Parameter	Data Type	Required	Description
Enabled	form	bool	No
InvoiceData	form	SessionInvoiceCreationInvoiceData	No

**SessionInvoiceCreationInvoiceData** Parameters:
Name	Parameter	Data Type	Required
CustomFields	form	List<SessionInvoiceCreationInvoiceDataCustomField>	No
Description	form	string	No
Footer	form	string	No
Metadata	form	Dictionary<string, string>	No
RenderingOptions	form	SessionInvoiceCreationInvoiceDataRenderingOptions	No

**SessionInvoiceCreationInvoiceDataCustomField** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
Value	form	string	No

**SessionInvoiceCreationInvoiceDataRenderingOptions** Parameters:
Name	Parameter	Data Type	Required	Description
AmountTaxDisplay	form	string	No

**LineItem** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Object	form	string	No
AmountDiscount	form	long	No
AmountSubtotal	form	long	No
AmountTax	form	long	No
AmountTotal	form	long	No
Currency	form	string	No
Deleted	form	bool?	No
Description	form	string	No
Discounts	form	List<LineItemDiscount>	No
Price	form	Price	No
Quantity	form	long?	No
Taxes	form	List<LineItemTax>	No

**LineItemDiscount** Parameters:
Name	Parameter	Data Type	Required	Description
Amount	form	long	No
Discount	form	Discount	No

**Discount** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Object	form	string	No
CheckoutSession	form	string	No
Coupon	form	Coupon	No
Deleted	form	bool?	No
End	form	DateTime?	No
Invoice	form	string	No
InvoiceItem	form	string	No
Start	form	DateTime?	No

**Coupon** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Object	form	string	No
AmountOff	form	long?	No
AppliesTo	form	CouponAppliesTo	No
Created	form	DateTime	No
Currency	form	string	No
CurrencyOptions	form	Dictionary<string, CouponCurrencyOptions>	No
Deleted	form	bool?	No
Duration	form	string	No
DurationInMonths	form	long?	No
Livemode	form	bool	No
MaxRedemptions	form	long?	No
Metadata	form	Dictionary<string, string>	No
Name	form	string	No
PercentOff	form	decimal?	No
RedeemBy	form	DateTime?	No
TimesRedeemed	form	long	No
Valid	form	bool	No

**CouponAppliesTo** Parameters:
Name	Parameter	Data Type	Required	Description
Products	form	List<string>	No

**CouponCurrencyOptions** Parameters:
Name	Parameter	Data Type	Required	Description
AmountOff	form	long	No

**Price** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Object	form	string	No
Active	form	bool	No
BillingScheme	form	string	No
Created	form	DateTime	No
Currency	form	string	No
CurrencyOptions	form	Dictionary<string, PriceCurrencyOptions>	No
CustomUnitAmount	form	PriceCustomUnitAmount	No
Deleted	form	bool?	No
Livemode	form	bool	No
LookupKey	form	string	No
Metadata	form	Dictionary<string, string>	No
Nickname	form	string	No
Recurring	form	PriceRecurring	No
TaxBehavior	form	string	No
Tiers	form	List<PriceTier>	No
TiersMode	form	string	No
TransformQuantity	form	PriceTransformQuantity	No
Type	form	string	No
UnitAmount	form	long?	No
UnitAmountDecimal	form	decimal?	No

**PriceCurrencyOptions** Parameters:
Name	Parameter	Data Type	Required
CustomUnitAmount	form	PriceCurrencyOptionsCustomUnitAmount	No
TaxBehavior	form	string	No
Tiers	form	List<PriceCurrencyOptionsTier>	No
UnitAmount	form	long?	No
UnitAmountDecimal	form	decimal?	No

**PriceCurrencyOptionsCustomUnitAmount** Parameters:
Name	Parameter	Data Type	Required
Maximum	form	long?	No
Minimum	form	long?	No
Preset	form	long?	No

**PriceCurrencyOptionsTier** Parameters:
Name	Parameter	Data Type	Required
FlatAmount	form	long?	No
FlatAmountDecimal	form	decimal?	No
UnitAmount	form	long?	No
UnitAmountDecimal	form	decimal?	No
UpTo	form	long?	No

**PriceCustomUnitAmount** Parameters:
Name	Parameter	Data Type	Required
Maximum	form	long?	No
Minimum	form	long?	No
Preset	form	long?	No

**PriceRecurring** Parameters:
Name	Parameter	Data Type	Required
AggregateUsage	form	string	No
Interval	form	string	No
IntervalCount	form	long	No
TrialPeriodDays	form	long?	No
UsageType	form	string	No

**PriceTier** Parameters:
Name	Parameter	Data Type	Required
FlatAmount	form	long?	No
FlatAmountDecimal	form	decimal?	No
UnitAmount	form	long?	No
UnitAmountDecimal	form	decimal?	No
UpTo	form	long?	No

**PriceTransformQuantity** Parameters:
Name	Parameter	Data Type	Required	Description
DivideBy	form	long	No
Round	form	string	No

**LineItemTax** Parameters:
Name	Parameter	Data Type	Required	Description
Amount	form	long	No
Rate	form	TaxRate	No

**TaxRate** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Object	form	string	No
Active	form	bool	No
Country	form	string	No
Created	form	DateTime	No
Description	form	string	No
DisplayName	form	string	No
Inclusive	form	bool	No
Jurisdiction	form	string	No
Livemode	form	bool	No
Metadata	form	Dictionary<string, string>	No
Percentage	form	decimal	No
State	form	string	No
TaxType	form	string	No

**SessionPaymentMethodOptions** Parameters:
Name	Parameter	Data Type	Required
AcssDebit	form	SessionPaymentMethodOptionsAcssDebit	No
Affirm	form	SessionPaymentMethodOptionsAffirm	No
AfterpayClearpay	form	SessionPaymentMethodOptionsAfterpayClearpay	No
Alipay	form	SessionPaymentMethodOptionsAlipay	No
AuBecsDebit	form	SessionPaymentMethodOptionsAuBecsDebit	No
BacsDebit	form	SessionPaymentMethodOptionsBacsDebit	No
Bancontact	form	SessionPaymentMethodOptionsBancontact	No
Boleto	form	SessionPaymentMethodOptionsBoleto	No
Card	form	SessionPaymentMethodOptionsCard	No
CustomerBalance	form	SessionPaymentMethodOptionsCustomerBalance	No
Eps	form	SessionPaymentMethodOptionsEps	No
Fpx	form	SessionPaymentMethodOptionsFpx	No
Giropay	form	SessionPaymentMethodOptionsGiropay	No
Grabpay	form	SessionPaymentMethodOptionsGrabpay	No
Ideal	form	SessionPaymentMethodOptionsIdeal	No
Klarna	form	SessionPaymentMethodOptionsKlarna	No
Konbini	form	SessionPaymentMethodOptionsKonbini	No
Oxxo	form	SessionPaymentMethodOptionsOxxo	No
P24	form	SessionPaymentMethodOptionsP24	No
Paynow	form	SessionPaymentMethodOptionsPaynow	No
Pix	form	SessionPaymentMethodOptionsPix	No
SepaDebit	form	SessionPaymentMethodOptionsSepaDebit	No
Sofort	form	SessionPaymentMethodOptionsSofort	No
UsBankAccount	form	SessionPaymentMethodOptionsUsBankAccount	No

**SessionPaymentMethodOptionsAcssDebit** Parameters:
Name	Parameter	Data Type	Required
Currency	form	string	No
MandateOptions	form	SessionPaymentMethodOptionsAcssDebitMandateOptions	No
SetupFutureUsage	form	string	No
VerificationMethod	form	string	No

**SessionPaymentMethodOptionsAcssDebitMandateOptions** Parameters:
Name	Parameter	Data Type	Required
CustomMandateUrl	form	string	No
DefaultFor	form	List<string>	No
IntervalDescription	form	string	No
PaymentSchedule	form	string	No
TransactionType	form	string	No

**SessionPaymentMethodOptionsAffirm** Parameters:
Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

**SessionPaymentMethodOptionsAfterpayClearpay** Parameters:
Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

**SessionPaymentMethodOptionsAlipay** Parameters:
Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

**SessionPaymentMethodOptionsAuBecsDebit** Parameters:
Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

**SessionPaymentMethodOptionsBacsDebit** Parameters:
Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

**SessionPaymentMethodOptionsBancontact** Parameters:
Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

**SessionPaymentMethodOptionsBoleto** Parameters:
Name	Parameter	Data Type	Required	Description
ExpiresAfterDays	form	long	No
SetupFutureUsage	form	string	No

**SessionPaymentMethodOptionsCard** Parameters:
Name	Parameter	Data Type	Required
Installments	form	SessionPaymentMethodOptionsCardInstallments	No
SetupFutureUsage	form	string	No
StatementDescriptorSuffixKana	form	string	No
StatementDescriptorSuffixKanji	form	string	No

**SessionPaymentMethodOptionsCardInstallments** Parameters:
Name	Parameter	Data Type	Required	Description
Enabled	form	bool	No

**SessionPaymentMethodOptionsCustomerBalance** Parameters:
Name	Parameter	Data Type	Required
BankTransfer	form	SessionPaymentMethodOptionsCustomerBalanceBankTransfer	No
FundingType	form	string	No
SetupFutureUsage	form	string	No

**SessionPaymentMethodOptionsCustomerBalanceBankTransfer** Parameters:
Name	Parameter	Data Type	Required
EuBankTransfer	form	SessionPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer	No
RequestedAddressTypes	form	List<string>	No
Type	form	string	No

**SessionPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer** Parameters:
Name	Parameter	Data Type	Required	Description
Country	form	string	No

**SessionPaymentMethodOptionsEps** Parameters:
Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

**SessionPaymentMethodOptionsFpx** Parameters:
Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

**SessionPaymentMethodOptionsGiropay** Parameters:
Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

**SessionPaymentMethodOptionsGrabpay** Parameters:
Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

**SessionPaymentMethodOptionsIdeal** Parameters:
Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

**SessionPaymentMethodOptionsKlarna** Parameters:
Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

**SessionPaymentMethodOptionsKonbini** Parameters:
Name	Parameter	Data Type	Required	Description
ExpiresAfterDays	form	long?	No
SetupFutureUsage	form	string	No

**SessionPaymentMethodOptionsOxxo** Parameters:
Name	Parameter	Data Type	Required	Description
ExpiresAfterDays	form	long	No
SetupFutureUsage	form	string	No

**SessionPaymentMethodOptionsP24** Parameters:
Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

**SessionPaymentMethodOptionsPaynow** Parameters:
Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

**SessionPaymentMethodOptionsPix** Parameters:
Name	Parameter	Data Type	Required	Description
ExpiresAfterSeconds	form	long?	No

**SessionPaymentMethodOptionsSepaDebit** Parameters:
Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

**SessionPaymentMethodOptionsSofort** Parameters:
Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

**SessionPaymentMethodOptionsUsBankAccount** Parameters:
Name	Parameter	Data Type	Required
FinancialConnections	form	SessionPaymentMethodOptionsUsBankAccountFinancialConnections	No
SetupFutureUsage	form	string	No
VerificationMethod	form	string	No

**SessionPaymentMethodOptionsUsBankAccountFinancialConnections** Parameters:
Name	Parameter	Data Type	Required	Description
Permissions	form	List<string>	No
ReturnUrl	form	string	No

**SessionPhoneNumberCollection** Parameters:
Name	Parameter	Data Type	Required	Description
Enabled	form	bool	No

**SessionShippingAddressCollection** Parameters:
Name	Parameter	Data Type	Required	Description
AllowedCountries	form	List<string>	No

**SessionShippingCost** Parameters:
Name	Parameter	Data Type	Required
AmountSubtotal	form	long	No
AmountTax	form	long	No
AmountTotal	form	long	No
Taxes	form	List<SessionShippingCostTax>	No

**SessionShippingCostTax** Parameters:
Name	Parameter	Data Type	Required	Description
Amount	form	long	No
Rate	form	TaxRate	No

**SessionShippingDetails** Parameters:
Name	Parameter	Data Type	Required
Address	form	Address	No
Carrier	form	string	No
Name	form	string	No
Phone	form	string	No
TrackingNumber	form	string	No

**SessionShippingOption** Parameters:
Name	Parameter	Data Type	Required	Description
ShippingAmount	form	long	No

**SessionTaxIdCollection** Parameters:
Name	Parameter	Data Type	Required	Description
Enabled	form	bool	No

**SessionTotalDetails** Parameters:
Name	Parameter	Data Type	Required
AmountDiscount	form	long	No
AmountShipping	form	long?	No
AmountTax	form	long	No
Breakdown	form	SessionTotalDetailsBreakdown	No

**SessionTotalDetailsBreakdown** Parameters:
Name	Parameter	Data Type	Required	Description
Discounts	form	List<SessionTotalDetailsBreakdownDiscount>	No
Taxes	form	List<SessionTotalDetailsBreakdownTax>	No

**SessionTotalDetailsBreakdownDiscount** Parameters:
Name	Parameter	Data Type	Required	Description
Amount	form	long	No
Discount	form	Discount	No

**SessionTotalDetailsBreakdownTax** Parameters:
Name	Parameter	Data Type	Required	Description
Amount	form	long	No
Rate	form	TaxRate	No

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.