# Create a Checkout Session for a single line item

Operation ID: `connectors.stripeCreateSession`

Create a Checkout Session for a single line item. Success/cancel URLs are built from ``return_origin``. Returns the shaped session (including the hosted checkout ``url``), or None on error.

## Public method

`createSession`

Signature: `connectors.stripe.createClient(config).createSession(body)`

Return type: `Promise<StripeSessionResponse>`

## Authentication

Classification: **AUTHENTICATED**

Schemes: `bearerAuth`

## Prerequisites

None documented.

## HTTP

`POST /connectors/stripe/create-session`

## Path parameters

None.

## Query parameters

None.

## Body parameters

| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|---|---|---:|---|---|---|---:|---|
| `body` | [`StripeCreateSessionRequest`](../models/StripeCreateSessionRequest.md) | Yes |  |  |  | No |  |

Request model: [`StripeCreateSessionRequest`](../models/StripeCreateSessionRequest.md)

## Request example

```json
{
  "customer_email": "patient@example.com",
  "item_price": "example-item_price",
  "mode": "sandbox",
  "publishable_key": "example-publishable_key",
  "quantity": 1,
  "return_origin": "https://app.test",
  "secret_key": "example-api-key"
}
```

## Success responses

| Status | Shape | Content type | Description |
|---|---|---|---|
| `200` | [`StripeCreateSessionResponse`](../models/StripeCreateSessionResponse.md) | application/json | Successful response |

## Success response examples

### 200

```json
{
  "amount_total": 2500,
  "currency": "usd",
  "customer_email": "patient@example.com",
  "id": "example-id",
  "payment_status": "unpaid",
  "status": "open",
  "url": "https://checkout.stripe.com/c/pay/cs_test_a17pSrjSbl7P95MkeWysKXwhnM3K2X6feaMSFVWMkwyFLFn2JDG2gLslEK#fidnandhYHdWcXxpYCc"
}
```

## Common errors

| Status | Shape | Content type | Description |
|---|---|---|---|
| `400` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | Connector validation rejected the payload, or a required field was missing or of the wrong type. |
| `401` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The HealthCloud bearer token is missing or invalid, or the vendor rejected the supplied connector credentials. |
| `500` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The connector failed unexpectedly. |
| `502` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The vendor returned an application or transport-level failure. |
| `504` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The vendor did not respond within the connector timeout. |

## Error examples

### 400 — Invalid request

```json
{
  "error": "Invalid request"
}
```

### 401 — Authorization required

```json
{
  "error": "Authorization required"
}
```

### 500 — Internal error

```json
{
  "error": "Internal error"
}
```

### 502 — Upstream vendor error

```json
{
  "error": "Upstream vendor error"
}
```

### 504 — Upstream timeout

```json
{
  "error": "Upstream timeout"
}
```

## NodeJS / TypeScript implementation

```ts
import { HCSDK } from "@healthcloudai/hc-sdk";
import type { StripeCreateSessionRequest } from "@healthcloudai/hc-sdk";
```

```ts
const body = {
  "customer_email": "patient@example.com",
  "item_price": "example-item_price",
  "mode": "sandbox",
  "publishable_key": "example-publishable_key",
  "quantity": 1,
  "return_origin": "https://app.test",
  "secret_key": "example-api-key"
};

const result = await connectors.stripe.createClient(config).createSession(body);
```

## cURL

```bash
curl -X POST \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{"customer_email":"patient@example.com","item_price":"example-item_price","mode":"sandbox","publishable_key":"example-publishable_key","quantity":1,"return_origin":"https://app.test","secret_key":"example-api-key"}' \
  'https://dev-api-connectors.health.cloud/connectors/stripe/create-session'
```

## Notes

None.

## Prepared Test Console scenario

No canonical scenario is currently associated.

## Real response

No approved real integration response is currently published. Unapproved candidates are never rendered as examples.