Checkout Session
Checkout session for processing payments
- idType: stringrequired
Unique identifier for the checkout session
- clientType: string | null
_secret max length:4096Opaque client-side capability for continuing this custom Checkout Session through a supported Paypercut client SDK. In a JavaScript integration, pass it to
paypercut.confirmPayment().Return it only to the untrusted client instance and customer that own the payment attempt. Do not parse it, log it, embed it in UI markup, place it in a URL or analytics, persist it in client-side storage, or expose it to another customer or payment attempt. This value is not a secret API key and does not authorize server-side API operations.
- currencyType:Properties: 2
Currency of the amount, including its three-letter ISO code and number of decimal places.
- descriptionType: string | null
A free-form reference that describes the checkout.
- modeType: stringenumrequired
The mode of the Checkout Session.
values- payment
Standard one-time payment.
- setup
Set up a payment method for future use.
- subscription
Create a subscription checkout that collects the first payment and stores a reusable payment method for renewal billing.
- payment
- uiType: stringenum
_mode The UI mode of the Session.
values- custom
Your frontend renders the payment form with Elements and your backend confirms the Session. A supported client SDK completes any required customer authentication.
- embedded
Checkout renders inside your own page through the Paypercut Checkout SDK, and Paypercut still controls the payment form.
- hosted
The customer is redirected to a payment page hosted by Paypercut.
- custom
- amountType: integerFormat: int64
_total Total of all items after discounts and taxes are applied.
- amountType: integerFormat: int64
_subtotal Subtotal of all items before shipping, discounts, and taxes are applied.
- Properties: 3totalType:
_details - shippingType:
_options Properties: 1Shipping options available for the Checkout Session.
- Properties: 5shippingType: nullable
_cost - urlType: stringFormat: urirequired
URL where the customer can complete the payment.
- cancelType: string | null
_url URL customers can return to if they cancel payment.
- successType: string | null
_url URL customers are sent to when payment or setup is complete.
- returnType: string | null
_url URL customers return to after redirect-based authentication.
- paymentType: array of string
_method _types max length:100Payment method types this Checkout Session can accept.
- submitType: string | nullenum
_type Submit button text behavior used for Checkout Sessions in
paymentmode.valuesautobookdonatepaysubscribe - Properties: 2walletType:
_options - clientType: string | null
_reference _id A free-form reference from the merchant's system.
- clientType: string | null
_customer _id An identifier of the customer in the merchant's system.
- expiresType: string | nullFormat: date-time
_at Expiry time for the checkout.
- lineType:
_items Properties: 4Details about the products sold or services provided.
- Properties: 3savedType:
_payment _method _options - paymentType: nullable
_method _options Properties: 1Payment-method-specific options captured for this Checkout Session.
- metadata
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.- propertyadditionalPropertyType: string
Name
- afterType:
_completion Properties: 3After completion behavior for the Checkout Session.
- localeType: string | null
The IETF language tag of the locale Checkout is displayed in.
- customer
Customer associated with the Checkout Session, if one exists.
- Type:max length:100
Customer associated with the Checkout Session, if one exists.
- customerType: string | null
_email Email address associated with the Checkout Session.
- customerType: "always" or "if_required"enum
_creation Customer creation behavior used during Session confirmation.
- payment
_intent The PaymentIntent for Checkout Sessions in
paymentmode. It may be returned as an ID unless expanded.- Type:max length:100
The PaymentIntent for Checkout Sessions in
paymentmode. It may be returned as an ID unless expanded.
- setup
_intent The SetupIntent for Checkout Sessions in
setupmode.- Type:max length:100
The SetupIntent for Checkout Sessions in
setupmode.
- subscription
The Subscription for Checkout Sessions in
subscriptionmode. It may be returned as an ID unless expanded.- Type: string
Subscription ID.
- payment
_link The Payment Link that created this Session, if applicable.
- Type:max length:100
The Payment Link that created this Session, if applicable.
- paymentType: stringenum
_status requiredThe payment status of the Checkout Session, one of
paid,unpaid, orno_payment_required.valuesno_payment_requiredprocessingpaidunpaid - statusType: "complete" or "expired" or "open"enumrequired
The status of the Checkout Session.
- Properties: 4nextType: nullable
_action - livemodeType: booleanrequired
Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode. - billingType: enum
_address _collection Specify whether Checkout should collect the customer's billing address. Defaults to
auto.values- auto
Checkout will only collect the billing address when necessary.
- required
Checkout will always collect the customer's billing address.
- auto

