# VyCheckoutSessionDto

## Properties

| Field                             | Type                                                                                                      | Description | Required |
| --------------------------------- | --------------------------------------------------------------------------------------------------------- | ----------- | -------- |
| id                                | string                                                                                                    |             | ✗        |
| object                            | string                                                                                                    |             | ✗        |
| afterExpiration                   | Any                                                                                                       |             | ✗        |
| allowPromotionCodes               | boolean                                                                                                   |             | ✗        |
| amountSubtotal                    | number                                                                                                    |             | ✗        |
| amountTotal                       | number                                                                                                    |             | ✗        |
| automaticTax                      | [VyAutomaticTaxDto](/sdk-reference/ts-js-v3/object-references/pay/vyautomatictaxdto.md)                   |             | ✗        |
| billingAddressCollection          | string                                                                                                    |             | ✗        |
| cancelUrl                         | string                                                                                                    |             | ✗        |
| clientReferenceId                 | string                                                                                                    |             | ✗        |
| clientSecret                      | string                                                                                                    |             | ✗        |
| consent                           | Any                                                                                                       |             | ✗        |
| consentCollection                 | Any                                                                                                       |             | ✗        |
| created                           | number                                                                                                    |             | ✗        |
| currency                          | string                                                                                                    |             | ✗        |
| currencyConversion                | Any                                                                                                       |             | ✗        |
| customFields                      | Any                                                                                                       |             | ✗        |
| customText                        | [VyCustomTextDto](/sdk-reference/ts-js-v3/object-references/pay/vycustomtextdto.md)                       |             | ✗        |
| customer                          | string                                                                                                    |             | ✗        |
| customerCreation                  | string                                                                                                    |             | ✗        |
| customerDetails                   | Any                                                                                                       |             | ✗        |
| customerEmail                     | string                                                                                                    |             | ✗        |
| expiresAt                         | number                                                                                                    |             | ✗        |
| invoice                           | string                                                                                                    |             | ✗        |
| invoiceCreation                   | [VyInvoiceCreationDto](/sdk-reference/ts-js-v3/object-references/pay/vyinvoicecreationdto.md)             |             | ✗        |
| livemode                          | boolean                                                                                                   |             | ✗        |
| locale                            | string                                                                                                    |             | ✗        |
| metadata                          | Any                                                                                                       |             | ✗        |
| mode                              | string                                                                                                    |             | ✗        |
| paymentIntent                     | Any                                                                                                       |             | ✗        |
| paymentLink                       | string                                                                                                    |             | ✗        |
| paymentMethodCollection           | string                                                                                                    |             | ✗        |
| paymentMethodConfigurationDetails | Any                                                                                                       |             | ✗        |
| paymentMethodOptions              | Any                                                                                                       |             | ✗        |
| paymentMethodTypes                | string                                                                                                    |             | ✗        |
| paymentStatus                     | string                                                                                                    |             | ✗        |
| phoneNumberCollection             | [VyPhoneNumberCollectionDto](/sdk-reference/ts-js-v3/object-references/pay/vyphonenumbercollectiondto.md) |             | ✗        |
| recoveredFrom                     | string                                                                                                    |             | ✗        |
| setupIntent                       | string                                                                                                    |             | ✗        |
| shippingAddressCollection         | Any                                                                                                       |             | ✗        |
| shippingCost                      | Any                                                                                                       |             | ✗        |
| shippingDetails                   | Any                                                                                                       |             | ✗        |
| shippingOptions                   | Any                                                                                                       |             | ✗        |
| status                            | string                                                                                                    |             | ✗        |
| submitType                        | string                                                                                                    |             | ✗        |
| subscription                      | string                                                                                                    |             | ✗        |
| successUrl                        | string                                                                                                    |             | ✗        |
| totalDetails                      | [VyTotalDetailsDto](/sdk-reference/ts-js-v3/object-references/pay/vytotaldetailsdto.md)                   |             | ✗        |
| uiMode                            | string                                                                                                    |             | ✗        |
| url                               | string                                                                                                    |             | ✗        |

## References

**Operation**

* [checkoutSession](/sdk-reference/ts-js-v3/function-references/pay/checkout/checkoutsession.md)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://sdk.venly.io/sdk-reference/ts-js-v3/object-references/pay/vycheckoutsessiondto.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.