# List products (optionally capped by ``limit``)

Operation ID: `connectors.stripeListProducts`

List products (optionally capped by ``limit``). Empty list on error.

## Public method

`listProducts`

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

Return type: `Promise<StripeProductResponse[]>`

## Authentication

Classification: **AUTHENTICATED**

Schemes: `bearerAuth`

## Prerequisites

None documented.

## HTTP

`POST /connectors/stripe/list-products`

## Path parameters

None.

## Query parameters

None.

## Body parameters

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

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

## Request example

```json
{
  "limit": 3,
  "mode": "sandbox",
  "publishable_key": "example-publishable_key",
  "secret_key": "example-api-key"
}
```

## Success responses

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

## Success response examples

### 200

```json
[
  {
    "active": true,
    "id": "example-id",
    "name": "HealthCloud Copay (smoke test)"
  }
]
```

## 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 { StripeListProductsRequest } from "@healthcloudai/hc-sdk";
```

```ts
const body = {
  "limit": 3,
  "mode": "sandbox",
  "publishable_key": "example-publishable_key",
  "secret_key": "example-api-key"
};

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

## cURL

```bash
curl -X POST \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{"limit":3,"mode":"sandbox","publishable_key":"example-publishable_key","secret_key":"example-api-key"}' \
  'https://dev-api-connectors.health.cloud/connectors/stripe/list-products'
```

## 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.