# CheckoutSessionResponse

## Example Usage

```typescript
import { CheckoutSessionResponse } from "@flexprice/sdk/sdk/models";

let value: CheckoutSessionResponse = {};
```

## Fields

| Field                                                                                                                                                                                                    | Type                                                                                                                                                                                                     | Required                                                                                                                                                                                                 | Description                                                                                                                                                                                              |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `action`                                                                                                                                                                                                 | [models.CheckoutAction](../../sdk/models/checkout-action.md)                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
| `cancelUrl`                                                                                                                                                                                              | *string*                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
| `cancelledAt`                                                                                                                                                                                            | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
| `checkoutInvoiceId`                                                                                                                                                                                      | *string*                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                       | CheckoutInvoiceID and CheckoutPaymentID are set once the apply step<br/>creates the corresponding Flexprice entities (completed sessions only).                                                          |
| `checkoutPaymentId`                                                                                                                                                                                      | *string*                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
| `checkoutStatus`                                                                                                                                                                                         | [models.CheckoutStatus](../../sdk/models/checkout-status.md)                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
| `completedAt`                                                                                                                                                                                            | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
| `configuration`                                                                                                                                                                                          | [models.CheckoutJSONBCheckoutConfiguration](../../sdk/models/checkout-jsonb-checkout-configuration.md)                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
| `createdAt`                                                                                                                                                                                              | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
| `createdBy`                                                                                                                                                                                              | *string*                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
| `customerId`                                                                                                                                                                                             | *string*                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
| `environmentId`                                                                                                                                                                                          | *string*                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
| `expiresAt`                                                                                                                                                                                              | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                       | ExpiresAt is required. A Temporal timer fires at this time for any<br/>session still in initiated\|pending, marking it expired. The caller<br/>must create a new session after expiry (expire-and-restart model). |
| `failureReason`                                                                                                                                                                                          | *string*                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                       | FailureReason is a human-readable string set on failed sessions.                                                                                                                                         |
| `failureUrl`                                                                                                                                                                                             | *string*                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
| `id`                                                                                                                                                                                                     | *string*                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
| `idempotencyKey`                                                                                                                                                                                         | *string*                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                       | IdempotencyKey is caller-supplied. It is unique only while the session<br/>is active (initiated\|pending). The same key may be reused once the<br/>session reaches a terminal state (completed\|failed\|expired). |
| `metadata`                                                                                                                                                                                               | Record<string, *string*>                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
| `paymentAction`                                                                                                                                                                                          | [models.PaymentAction](../../sdk/models/payment-action.md)                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
| `paymentProvider`                                                                                                                                                                                        | [models.CheckoutPaymentProvider](../../sdk/models/checkout-payment-provider.md)                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
| `paymentProviderConfig`                                                                                                                                                                                  | [models.CheckoutJSONBCheckoutPaymentProviderConfig](../../sdk/models/checkout-jsonb-checkout-payment-provider-config.md)                                                                                 | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
| `providerResult`                                                                                                                                                                                         | [models.CheckoutJSONBCheckoutProviderResult](../../sdk/models/checkout-jsonb-checkout-provider-result.md)                                                                                                | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
| `result`                                                                                                                                                                                                 | [models.CheckoutJSONBCheckoutResult](../../sdk/models/checkout-jsonb-checkout-result.md)                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
| `status`                                                                                                                                                                                                 | [models.Status](../../sdk/models/status.md)                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
| `successUrl`                                                                                                                                                                                             | *string*                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                       | Redirect URLs sent to the payment provider. The provider redirects the<br/>user browser to the appropriate URL after the payment flow completes.                                                         |
| `tenantId`                                                                                                                                                                                               | *string*                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
| `updatedAt`                                                                                                                                                                                              | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
| `updatedBy`                                                                                                                                                                                              | *string*                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |