# 600 Reference 03a43eea

> Stripe full reference

- Skill: `tools-only/600-reference-03a43eea` (Agent Skill, multi-file: 3 files)
- Install (CLI): `npx skillmds@latest add tools-only/600-reference-03a43eea`
- Raw SKILL.md: https://api.skillmd.com/api/skills/tools-only/600-reference-03a43eea/raw
- Safety review: pending (external: skill-scanner PASS, skillspector PASS)
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Integrations & APIs
- Author: tools-only (https://skillmd.com/u/tools-only)
- Updated: 2026-09-22
- Page: https://skillmd.com/skills/tools-only/600-reference-03a43eea

---

# Stripe full reference

This is the full reference documentation for the Stripe agent connector.

## Supported entities and actions

The Stripe connector supports the following entities and actions.

| Entity | Actions |
|--------|---------|
| Customers | [List](#customers-list), [Create](#customers-create), [Get](#customers-get), [Update](#customers-update), [Delete](#customers-delete), [API Search](#customers-api-search), [Search](#customers-search) |
| Invoices | [List](#invoices-list), [Get](#invoices-get), [API Search](#invoices-api-search), [Search](#invoices-search) |
| Charges | [List](#charges-list), [Get](#charges-get), [API Search](#charges-api-search), [Search](#charges-search) |
| Subscriptions | [List](#subscriptions-list), [Get](#subscriptions-get), [API Search](#subscriptions-api-search), [Search](#subscriptions-search) |
| Refunds | [List](#refunds-list), [Create](#refunds-create), [Get](#refunds-get), [Search](#refunds-search) |
| Products | [List](#products-list), [Create](#products-create), [Get](#products-get), [Update](#products-update), [Delete](#products-delete), [API Search](#products-api-search) |
| Balance | [Get](#balance-get) |
| Balance Transactions | [List](#balance-transactions-list), [Get](#balance-transactions-get) |
| Payment Intents | [List](#payment-intents-list), [Get](#payment-intents-get), [API Search](#payment-intents-api-search) |
| Disputes | [List](#disputes-list), [Get](#disputes-get) |
| Payouts | [List](#payouts-list), [Get](#payouts-get) |

## Customers

### Customers List

Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.

#### Python SDK

```python
await stripe.customers.list()
```

#### API

```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/sources/{your_source_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "customers",
    "action": "list"
}'
```


#### Parameters

| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `limit` | `integer` | No | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. |
| `starting_after` | `string` | No | A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. |
| `ending_before` | `string` | No | A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. |
| `email` | `string` | No | A case-sensitive filter on the list based on the customer's email field. The value must be a string. |
| `created` | `object` | No | Only return customers that were created during the given date interval. |
| `created.gt` | `integer` | No | Minimum value to filter by (exclusive) |
| `created.gte` | `integer` | No | Minimum value to filter by (inclusive) |
| `created.lt` | `integer` | No | Maximum value to filter by (exclusive) |
| `created.lte` | `integer` | No | Maximum value to filter by (inclusive) |


<details>
<summary><b>Response Schema</b></summary>

#### Records

| Field Name | Type | Description |
|------------|------|-------------|
| `id` | `string` |  |
| `object` | `"customer"` |  |
| `address` | `object \| null` |  |
| `balance` | `integer` |  |
| `business_name` | `string \| null` |  |
| `cash_balance` | `object \| null` |  |
| `created` | `integer` |  |
| `currency` | `string \| null` |  |
| `customer_account` | `string \| null` |  |
| `default_currency` | `string \| null` |  |
| `default_source` | `string \| null` |  |
| `delinquent` | `boolean \| null` |  |
| `description` | `string \| null` |  |
| `discount` | `object \| null` |  |
| `email` | `string \| null` |  |
| `individual_name` | `string \| null` |  |
| `invoice_credit_balance` | `object` |  |
| `invoice_prefix` | `string \| null` |  |
| `invoice_settings` | `object` |  |
| `livemode` | `boolean` |  |
| `metadata` | `object` |  |
| `name` | `string \| null` |  |
| `next_invoice_sequence` | `integer \| null` |  |
| `phone` | `string \| null` |  |
| `preferred_locales` | `array \| null` |  |
| `shipping` | `object \| null` |  |
| `sources` | `object \| null` |  |
| `subscriptions` | `object \| null` |  |
| `tax_exempt` | `string \| null` |  |
| `test_clock` | `string \| null` |  |


#### Meta

| Field Name | Type | Description |
|------------|------|-------------|
| `has_more` | `boolean` |  |

</details>

### Customers Create

Creates a new customer object.

#### Python SDK

```python
await stripe.customers.create()
```

#### API

```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/sources/{your_source_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "customers",
    "action": "create"
}'
```



<details>
<summary><b>Response Schema</b></summary>

#### Records

| Field Name | Type | Description |
|------------|------|-------------|
| `id` | `string` |  |
| `object` | `"customer"` |  |
| `address` | `object \| null` |  |
| `balance` | `integer` |  |
| `business_name` | `string \| null` |  |
| `cash_balance` | `object \| null` |  |
| `created` | `integer` |  |
| `currency` | `string \| null` |  |
| `customer_account` | `string \| null` |  |
| `default_currency` | `string \| null` |  |
| `default_source` | `string \| null` |  |
| `delinquent` | `boolean \| null` |  |
| `description` | `string \| null` |  |
| `discount` | `object \| null` |  |
| `email` | `string \| null` |  |
| `individual_name` | `string \| null` |  |
| `invoice_credit_balance` | `object` |  |
| `invoice_prefix` | `string \| null` |  |
| `invoice_settings` | `object` |  |
| `livemode` | `boolean` |  |
| `metadata` | `object` |  |
| `name` | `string \| null` |  |
| `next_invoice_sequence` | `integer \| null` |  |
| `phone` | `string \| null` |  |
| `preferred_locales` | `array \| null` |  |
| `shipping` | `object \| null` |  |
| `sources` | `object \| null` |  |
| `subscriptions` | `object \| null` |  |
| `tax_exempt` | `string \| null` |  |
| `test_clock` | `string \| null` |  |


</details>

### Customers Get

Retrieves a Customer object.

#### Python SDK

```python
await stripe.customers.get(
    id="<str>"
)
```

#### API

```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/sources/{your_source_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "customers",
    "action": "get",
    "params": {
        "id": "<str>"
    }
}'
```


#### Parameters

| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `id` | `string` | Yes | The customer ID |


<details>
<summary><b>Response Schema</b></summary>

#### Records

| Field Name | Type | Description |
|------------|------|-------------|
| `id` | `string` |  |
| `object` | `"customer"` |  |
| `address` | `object \| null` |  |
| `balance` | `integer` |  |
| `business_name` | `string \| null` |  |
| `cash_balance` | `object \| null` |  |
| `created` | `integer` |  |
| `currency` | `string \| null` |  |
| `customer_account` | `string \| null` |  |
| `default_currency` | `string \| null` |  |
| `default_source` | `string \| null` |  |
| `delinquent` | `boolean \| null` |  |
| `description` | `string \| null` |  |
| `discount` | `object \| null` |  |
| `email` | `string \| null` |  |
| `individual_name` | `string \| null` |  |
| `invoice_credit_balance` | `object` |  |
| `invoice_prefix` | `string \| null` |  |
| `invoice_settings` | `object` |  |
| `livemode` | `boolean` |  |
| `metadata` | `object` |  |
| `name` | `string \| null` |  |
| `next_invoice_sequence` | `integer \| null` |  |
| `phone` | `string \| null` |  |
| `preferred_locales` | `array \| null` |  |
| `shipping` | `object \| null` |  |
| `sources` | `object \| null` |  |
| `subscriptions` | `object \| null` |  |
| `tax_exempt` | `string \| null` |  |
| `test_clock` | `string \| null` |  |


</details>

### Customers Update

Updates the specified customer by setting the values of the parameters passed.

#### Python SDK

```python
await stripe.customers.update(
    id="<str>"
)
```

#### API

```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/sources/{your_source_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "customers",
    "action": "update",
    "params": {
        "id": "<str>"
    }
}'
```


#### Parameters

| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `id` | `string` | Yes | The customer ID |


<details>
<summary><b>Response Schema</b></summary>

#### Records

| Field Name | Type | Description |
|------------|------|-------------|
| `id` | `string` |  |
| `object` | `"customer"` |  |
| `address` | `object \| null` |  |
| `balance` | `integer` |  |
| `business_name` | `string \| null` |  |
| `cash_balance` | `object \| null` |  |
| `created` | `integer` |  |
| `currency` | `string \| null` |  |
| `customer_account` | `string \| null` |  |
| `default_currency` | `string \| null` |  |
| `default_source` | `string \| null` |  |
| `delinquent` | `boolean \| null` |  |
| `description` | `string \| null` |  |
| `discount` | `object \| null` |  |
| `email` | `string \| null` |  |
| `individual_name` | `string \| null` |  |
| `invoice_credit_balance` | `object` |  |
| `invoice_prefix` | `string \| null` |  |
| `invoice_settings` | `object` |  |
| `livemode` | `boolean` |  |
| `metadata` | `object` |  |
| `name` | `string \| null` |  |
| `next_invoice_sequence` | `integer \| null` |  |
| `phone` | `string \| null` |  |
| `preferred_locales` | `array \| null` |  |
| `shipping` | `object \| null` |  |
| `sources` | `object \| null` |  |
| `subscriptions` | `object \| null` |  |
| `tax_exempt` | `string \| null` |  |
| `test_clock` | `string \| null` |  |


</details>

### Customers Delete

Permanently deletes a customer. It cannot be undone.

#### Python SDK

```python
await stripe.customers.delete(
    id="<str>"
)
```

#### API

```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/sources/{your_source_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "customers",
    "action": "delete",
    "params": {
        "id": "<str>"
    }
}'
```


#### Parameters

| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `id` | `string` | Yes | The customer ID |


<details>
<summary><b>Response Schema</b></summary>

#### Records

| Field Name | Type | Description |
|------------|------|-------------|
| `id` | `string` |  |
| `object` | `"customer"` |  |
| `deleted` | `boolean` |  |


</details>

### Customers API Search

Search for customers using Stripe's Search Query Language.

#### Python SDK

```python
await stripe.customers.api_search(
    query="<str>"
)
```

#### API

```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/sources/{your_source_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "customers",
    "action": "api_search",
    "params": {
        "query": "<str>"
    }
}'
```


#### Parameters

| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `query` | `string` | Yes | The search query string using Stripe's Search Query Language |
| `limit` | `integer` | No | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. |
| `page` | `string` | No | A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. |


<details>
<summary><b>Response Schema</b></summary>

#### Records

| Field Name | Type | Description |
|------------|------|-------------|
| `id` | `string` |  |
| `object` | `"customer"` |  |
| `address` | `object \| null` |  |
| `balance` | `integer` |  |
| `business_name` | `string \| null` |  |
| `cash_balance` | `object \| null` |  |
| `created` | `integer` |  |
| `currency` | `string \| null` |  |
| `customer_account` | `string \| null` |  |
| `default_currency` | `string \| null` |  |
| `default_source` | `string \| null` |  |
| `delinquent` | `boolean \| null` |  |
| `description` | `string \| null` |  |
| `discount` | `object \| null` |  |
| `email` | `string \| null` |  |
| `individual_name` | `string \| null` |  |
| `invoice_credit_balance` | `object` |  |
| `invoice_prefix` | `string \| null` |  |
| `invoice_settings` | `object` |  |
| `livemode` | `boolean` |  |
| `metadata` | `object` |  |
| `name` | `string \| null` |  |
| `next_invoice_sequence` | `integer \| null` |  |
| `phone` | `string \| null` |  |
| `preferred_locales` | `array \| null` |  |
| `shipping` | `object \| null` |  |
| `sources` | `object \| null` |  |
| `subscriptions` | `object \| null` |  |
| `tax_exempt` | `string \| null` |  |
| `test_clock` | `string \| null` |  |


#### Meta

| Field Name | Type | Description |
|------------|------|-------------|
| `has_more` | `boolean` |  |

</details>

### Customers Search

Search and filter customers records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

#### Python SDK

```python
await stripe.customers.search(
    query={"filter": {"eq": {"account_balance": 0}}}
)
```

#### API

```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/sources/{your_source_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "customers",
    "action": "search",
    "params": {
        "query": {"filter": {"eq": {"account_balance": 0}}}
    }
}'
```

#### Parameters

| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `query` | `object` | Yes | Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or |
| `query.filter` | `object` | No | Filter conditions |
| `query.sort` | `array` | No | Sort conditions |
| `limit` | `integer` | No | Maximum results to return (default 1000) |
| `cursor` | `string` | No | Pagination cursor from previous response's next_cursor |
| `fields` | `array` | No | Field paths to include in results |

#### Searchable Fields

| Field Name | Type | Description |
|------------|------|-------------|
| `account_balance` | `integer` | Current balance value representing funds owed by or to the customer. |
| `address` | `object` | The customer's address information including line1, line2, city, state, postal code, and country. |
| `balance` | `integer` | Current balance (positive or negative) that is automatically applied to the customer's next invoice. |
| `cards` | `array` | Card payment methods associated with the customer account. |
| `created` | `integer` | Timestamp indicating when the customer object was created. |
| `currency` | `string` | Three-letter ISO currency code representing the customer's default currency. |
| `default_card` | `string` | The default card to be used for charges when no specific payment method is provided. |
| `default_source` | `string` | The default payment source (card or bank account) for the customer. |
| `delinquent` | `boolean` | Boolean indicating whether the customer is currently delinquent on payments. |
| `description` | `string` | An arbitrary string attached to the customer, often useful for displaying to users. |
| `discount` | `object` | Discount object describing any active discount applied to the customer. |
| `email` | `string` | The customer's email address for communication and tracking purposes. |
| `id` | `string` | Unique identifier for the customer object. |
| `invoice_prefix` | `string` | The prefix for invoice numbers generated for this customer. |
| `invoice_settings` | `object` | Customer's invoice-related settings including default payment method and custom fields. |
| `is_deleted` | `boolean` | Boolean indicating whether the customer has been deleted. |
| `livemode` | `boolean` | Boolean indicating whether the object exists in live mode or test mode. |
| `metadata` | `object` | Set of key-value pairs for storing additional structured information about the customer. |
| `name` | `string` | The customer's full name or business name. |
| `next_invoice_sequence` | `integer` | The sequence number for the next invoice generated for this customer. |
| `object` | `string` | String representing the object type, always 'customer'. |
| `phone` | `string` | The customer's phone number. |
| `preferred_locales` | `array` | Array of preferred locales for the customer, used for invoice and receipt localization. |
| `shipping` | `object` | Mailing and shipping address for the customer, appears on invoices emailed to the customer. |
| `sources` | `string` | Payment sources (cards, bank accounts) attached to the customer for making payments. |
| `subscriptions` | `object` | List of active subscriptions associated with the customer. |
| `tax_exempt` | `string` | Describes the customer's tax exemption status (none, exempt, or reverse). |
| `tax_info` | `string` | Tax identification information for the customer. |
| `tax_info_verification` | `string` | Verification status of the customer's tax information. |
| `test_clock` | `string` | ID of the test clock associated with this customer for testing time-dependent scenarios. |
| `updated` | `integer` | Timestamp indicating when the customer object was last updated. |

<details>
<summary><b>Response Schema</b></summary>

| Field Name | Type | Description |
|------------|------|-------------|
| `hits` | `array` | List of matching records |
| `hits[].id` | `string` | Record identifier |
| `hits[].score` | `number` | Relevance score |
| `hits[].data` | `object` | Record data containing the searchable fields listed above |
| `hits[].data.account_balance` | `integer` | Current balance value representing funds owed by or to the customer. |
| `hits[].data.address` | `object` | The customer's address information including line1, line2, city, state, postal code, and country. |
| `hits[].data.balance` | `integer` | Current balance (positive or negative) that is automatically applied to the customer's next invoice. |
| `hits[].data.cards` | `array` | Card payment methods associated with the customer account. |
| `hits[].data.created` | `integer` | Timestamp indicating when the customer object was created. |
| `hits[].data.currency` | `string` | Three-letter ISO currency code representing the customer's default currency. |
| `hits[].data.default_card` | `string` | The default card to be used for charges when no specific payment method is provided. |
| `hits[].data.default_source` | `string` | The default payment source (card or bank account) for the customer. |
| `hits[].data.delinquent` | `boolean` | Boolean indicating whether the customer is currently delinquent on payments. |
| `hits[].data.description` | `string` | An arbitrary string attached to the customer, often useful for displaying to users. |
| `hits[].data.discount` | `object` | Discount object describing any active discount applied to the customer. |
| `hits[].data.email` | `string` | The customer's email address for communication and tracking purposes. |
| `hits[].data.id` | `string` | Unique identifier for the customer object. |
| `hits[].data.invoice_prefix` | `string` | The prefix for invoice numbers generated for this customer. |
| `hits[].data.invoice_settings` | `object` | Customer's invoice-related settings including default payment method and custom fields. |
| `hits[].data.is_deleted` | `boolean` | Boolean indicating whether the customer has been deleted. |
| `hits[].data.livemode` | `boolean` | Boolean indicating whether the object exists in live mode or test mode. |
| `hits[].data.metadata` | `object` | Set of key-value pairs for storing additional structured information about the customer. |
| `hits[].data.name` | `string` | The customer's full name or business name. |
| `hits[].data.next_invoice_sequence` | `integer` | The sequence number for the next invoice generated for this customer. |
| `hits[].data.object` | `string` | String representing the object type, always 'customer'. |
| `hits[].data.phone` | `string` | The customer's phone number. |
| `hits[].data.preferred_locales` | `array` | Array of preferred locales for the customer, used for invoice and receipt localization. |
| `hits[].data.shipping` | `object` | Mailing and shipping address for the customer, appears on invoices emailed to the customer. |
| `hits[].data.sources` | `string` | Payment sources (cards, bank accounts) attached to the customer for making payments. |
| `hits[].data.subscriptions` | `object` | List of active subscriptions associated with the customer. |
| `hits[].data.tax_exempt` | `string` | Describes the customer's tax exemption status (none, exempt, or reverse). |
| `hits[].data.tax_info` | `string` | Tax identification information for the customer. |
| `hits[].data.tax_info_verification` | `string` | Verification status of the customer's tax information. |
| `hits[].data.test_clock` | `string` | ID of the test clock associated with this customer for testing time-dependent scenarios. |
| `hits[].data.updated` | `integer` | Timestamp indicating when the customer object was last updated. |
| `next_cursor` | `string \| null` | Cursor for next page of results |
| `took_ms` | `number` | Query execution time in milliseconds |

</details>

## Invoices

### Invoices List

Returns a list of invoices

#### Python SDK

```python
await stripe.invoices.list()
```

#### API

```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/sources/{your_source_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "invoices",
    "action": "list"
}'
```


#### Parameters

| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `collection_method` | `"charge_automatically" \| "send_invoice"` | No | The collection method of the invoices to retrieve |
| `created` | `object` | No | Only return customers that were created during the given date interval. |
| `created.gt` | `integer` | No | Minimum value to filter by (exclusive) |
| `created.gte` | `integer` | No | Minimum value to filter by (inclusive) |
| `created.lt` | `integer` | No | Maximum value to filter by (exclusive) |
| `created.lte` | `integer` | No | Maximum value to filter by (inclusive) |
| `customer` | `string` | No | Only return invoices for the customer specified by this customer ID. |
| `customer_account` | `string` | No | Only return invoices for the account specified by this account ID |
| `ending_before` | `string` | No | A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. |
| `limit` | `integer` | No | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. |
| `starting_after` | `string` | No | A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. |
| `status` | `"draft" \| "open" \| "paid" \| "uncollectible" \| "void"` | No | The status of the invoices to retrieve |
| `subscription` | `string` | No | Only return invoices for the subscription specified by this subscription ID. |


<details>
<summary><b>Response Schema</b></summary>

#### Records

| Field Name | Type | Description |
|------------|------|-------------|
| `id` | `string` |  |
| `object` | `"invoice"` |  |
| `account_country` | `string \| null` |  |
| `account_name` | `string \| null` |  |
| `account_tax_ids` | `array \| null` |  |
| `amount_due` | `integer` |  |
| `amount_overpaid` | `integer` |  |
| `amount_paid` | `integer` |  |
| `amount_remaining` | `integer` |  |
| `amount_shipping` | `integer` |  |
| `application` | `string \| null` |  |
| `application_fee_amount` | `integer \| null` |  |
| `attempt_count` | `integer` |  |
| `attempted` | `boolean` |  |
| `auto_advance` | `boolean` |  |
| `automatic_tax` | `object` |  |
| `automatically_finalizes_at` | `integer \| null` |  |
| `billing_reason` | `string \| null` |  |
| `charge` | `string \| null` |  |
| `collection_method` | `"charge_automatically" \| "send_invoice"` |  |
| `confirmation_secret` | `object \| null` |  |
| `created` | `integer` |  |
| `currency` | `string` |  |
| `custom_fields` | `array \| null` |  |
| `customer` | `string` |  |
| `customer_account` | `string \| null` |  |
| `customer_address` | `object \| null` |  |
| `customer_email` | `string \| null` |  |
| `customer_name` | `string \| null` |  |
| `customer_phone` | `string \| null` |  |
| `customer_shipping` | `object \| null` |  |
| `customer_tax_exempt` | `string \| null` |  |
| `customer_tax_ids` | `array \| null` |  |
| `default_payment_method` | `string \| null` |  |
| `default_source` | `string \| null` |  |
| `default_tax_rates` | `array<object>` |  |
| `description` | `string \| null` |  |
| `discount` | `object \| null` |  |
| `discounts` | `array<string>` |  |
| `due_date` | `integer \| null` |  |
| `effective_at` | `integer \| null` |  |
| `ending_balance` | `integer \| null` |  |
| `footer` | `string \| null` |  |
| `from_invoice` | `object \| null` |  |
| `hosted_invoice_url` | `string \| null` |  |
| `invoice_pdf` | `string \| null` |  |
| `issuer` | `object` |  |
| `last_finalization_error` | `object \| null` |  |
| `latest_revision` | `string \| null` |  |
| `lines` | `object` |  |
| `livemode` | `boolean` |  |
| `metadata` | `object` |  |
| `next_payment_attempt` | `integer \| null` |  |
| `number` | `string \| null` |  |
| `on_behalf_of` | `string \| null` |  |
| `paid` | `boolean \| null` |  |
| `paid_out_of_band` | `boolean \| null` |  |
| `parent` | `object \| null` |  |
| `payment_intent` | `string \| null` |  |
| `payment_settings` | `object` |  |
| `payments` | `object` |  |
| `period_end` | `integer` |  |
| `period_start` | `integer` |  |
| `post_payment_credit_notes_amount` | `integer` |  |
| `pre_payment_credit_notes_amount` | `integer` |  |
| `quote` | `string \| null` |  |
| `receipt_number` | `string \| null` |  |
| `rendering` | `object \| null` |  |
| `rendering_options` | `object \| null` |  |
| `shipping_cost` | `object \| null` |  |
| `shipping_details` | `object \| null` |  |
| `starting_balance` | `integer` |  |
| `statement_descriptor` | `string \| null` |  |
| `status` | `string \| null` |  |
| `status_transitions` | `object` |  |
| `subscription` | `string \| null` |  |
| `subscription_details` | `object \| null` |  |
| `subtotal` | `integer` |  |
| `subtotal_excluding_tax` | `integer \| null` |  |
| `tax` | `integer \| null` |  |
| `test_clock` | `string \| null` |  |
| `threshold_reason` | `object \| null` |  |
| `total` | `integer` |  |
| `total_discount_amounts` | `array \| null` |  |
| `total_excluding_tax` | `integer \| null` |  |
| `total_pretax_credit_amounts` | `array \| null` |  |
| `total_tax_amounts` | `array \| null` |  |
| `total_taxes` | `array \| null` |  |
| `transfer_data` | `object \| null` |  |
| `webhooks_delivered_at` | `integer \| null` |  |


#### Meta

| Field Name | Type | Description |
|------------|------|-------------|
| `has_more` | `boolean` |  |

</details>

### Invoices Get

Retrieves the invoice with the given ID

#### Python SDK

```python
await stripe.invoices.get(
    id="<str>"
)
```

#### API

```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/sources/{your_source_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "invoices",
    "action": "get",
    "params": {
        "id": "<str>"
    }
}'
```


#### Parameters

| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `id` | `string` | Yes | The invoice ID |


<details>
<summary><b>Response Schema</b></summary>

#### Records

| Field Name | Type | Description |
|------------|------|-------------|
| `id` | `string` |  |
| `object` | `"invoice"` |  |
| `account_country` | `string \| null` |  |
| `account_name` | `string \| null` |  |
| `account_tax_ids` | `array \| null` |  |
| `amount_due` | `integer` |  |
| `amount_overpaid` | `integer` |  |
| `amount_paid` | `integer` |  |
| `amount_remaining` | `integer` |  |
| `amount_shipping` | `integer` |  |
| `application` | `string \| null` |  |
| `application_fee_amount` | `integer \| null` |  |
| `attempt_count` | `integer` |  |
| `attempted` | `boolean` |  |
| `auto_advance` | `boolean` |  |
| `automatic_tax` | `object` |  |
| `automatically_finalizes_at` | `integer \| null` |  |
| `billing_reason` | `string \| null` |  |
| `charge` | `string \| null` |  |
| `collection_method` | `"charge_automatically" \| "send_invoice"` |  |
| `confirmation_secret` | `object \| null` |  |
| `created` | `integer` |  |
| `currency` | `string` |  |
| `custom_fields` | `array \| null` |  |
| `customer` | `string` |  |
| `customer_account` | `string \| null` |  |
| `customer_address` | `object \| null` |  |
| `customer_email` | `string \| null` |  |
| `customer_name` | `string \| null` |  |
| `customer_phone` | `string \| null` |  |
| `customer_shipping` | `object \| null` |  |
| `customer_tax_exempt` | `string \| null` |  |
| `customer_tax_ids` | `array \| null` |  |
| `default_payment_method` | `string \| null` |  |
| `default_source` | `string \| null` |  |
| `default_tax_rates` | `array<object>` |  |
| `description` | `string \| null` |  |
| `discount` | `object \| null` |  |
| `discounts` | `array<string>` |  |
| `due_date` | `integer \| null` |  |
| `effective_at` | `integer \| null` |  |
| `ending_balance` | `integer \| null` |  |
| `footer` | `string \| null` |  |
| `from_invoice` | `object \| null` |  |
| `hosted_invoice_url` | `string \| null` |  |
| `invoice_pdf` | `string \| null` |  |
| `issuer` | `object` |  |
| `last_finalization_error` | `object \| null` |  |
| `latest_revision` | `string \| null` |  |
| `lines` | `object` |  |
| `livemode` | `boolean` |  |
| `metadata` | `object` |  |
| `next_payment_attempt` | `integer \| null` |  |
| `number` | `string \| null` |  |
| `on_behalf_of` | `string \| null` |  |
| `paid` | `boolean \| null` |  |
| `paid_out_of_band` | `boolean \| null` |  |
| `parent` | `object \| null` |  |
| `payment_intent` | `string \| null` |  |
| `payment_settings` | `object` |  |
| `payments` | `object` |  |
| `period_end` | `integer` |  |
| `period_start` | `integer` |  |
| `post_payment_credit_notes_amount` | `integer` |  |
| `pre_payment_credit_notes_amount` | `integer` |  |
| `quote` | `string \| null` |  |
| `receipt_number` | `string \| null` |  |
| `rendering` | `object \| null` |  |
| `rendering_options` | `object \| null` |  |
| `shipping_cost` | `object \| null` |  |
| `shipping_details` | `object \| null` |  |
| `starting_balance` | `integer` |  |
| `statement_descriptor` | `string \| null` |  |
| `status` | `string \| null` |  |
| `status_transitions` | `object` |  |
| `subscription` | `string \| null` |  |
| `subscription_details` | `object \| null` |  |
| `subtotal` | `integer` |  |
| `subtotal_excluding_tax` | `integer \| null` |  |
| `tax` | `integer \| null` |  |
| `test_clock` | `string \| null` |  |
| `threshold_reason` | `object \| null` |  |
| `total` | `integer` |  |
| `total_discount_amounts` | `array \| null` |  |
| `total_excluding_tax` | `integer \| null` |  |
| `total_pretax_credit_amounts` | `array \| null` |  |
| `total_tax_amounts` | `array \| null` |  |
| `total_taxes` | `array \| null` |  |
| `transfer_data` | `object \| null` |  |
| `webhooks_delivered_at` | `integer \| null` |  |


</details>

### Invoices API Search

Search for invoices using Stripe's Search Query Language

#### Python SDK

```python
await stripe.invoices.api_search(
    query="<str>"
)
```

#### API

```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/sources/{your_source_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "invoices",
    "action": "api_search",
    "params": {
        "query": "<str>"
    }
}'
```


#### Parameters

| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `query` | `string` | Yes | The search query string using Stripe's Search Query Language |
| `limit` | `integer` | No | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. |
| `page` | `string` | No | A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. |


<details>
<summary><b>Response Schema</b></summary>

#### Records

| Field Name | Type | Description |
|------------|------|-------------|
| `object` | `"search_result"` |  |
| `data` | `array<object>` |  |
| `data[].id` | `string` |  |
| `data[].object` | `"invoice"` |  |
| `data[].account_country` | `string \| null` |  |
| `data[].account_name` | `string \| null` |  |
| `data[].account_tax_ids` | `array \| null` |  |
| `data[].amount_due` | `integer` |  |
| `data[].amount_overpaid` | `integer` |  |
| `data[].amount_paid` | `integer` |  |
| `data[].amount_remaining` | `integer` |  |
| `data[].amount_shipping` | `integer` |  |
| `data[].application` | `string \| null` |  |
| `data[].application_fee_amount` | `integer \| null` |  |
| `data[].attempt_count` | `integer` |  |
| `data[].attempted` | `boolean` |  |
| `data[].auto_advance` | `boolean` |  |
| `data[].automatic_tax` | `object` |  |
| `data[].automatically_finalizes_at` | `integer \| null` |  |
| `data[].billing_reason` | `string \| null` |  |
| `data[].charge` | `string \| null` |  |
| `data[].collection_method` | `"charge_automatically" \| "send_invoice"` |  |
| `data[].confirmation_secret` | `object \| null` |  |
| `data[].created` | `integer` |  |
| `data[].currency` | `string` |  |
| `data[].custom_fields` | `array \| null` |  |
| `data[].customer` | `string` |  |
| `data[].customer_account` | `string \| null` |  |
| `data[].customer_address` | `object \| null` |  |
| `data[].customer_email` | `string \| null` |  |
| `data[].customer_name` | `string \| null` |  |
| `data[].customer_phone` | `string \| null` |  |
| `data[].customer_shipping` | `object \| null` |  |
| `data[].customer_tax_exempt` | `string \| null` |  |
| `data[].customer_tax_ids` | `array \| null` |  |
| `data[].default_payment_method` | `string \| null` |  |
| `data[].default_source` | `string \| null` |  |
| `data[].default_tax_rates` | `array<object>` |  |
| `data[].description` | `string \| null` |  |
| `data[].discount` | `object \| null` |  |
| `data[].discounts` | `array<string>` |  |
| `data[].due_date` | `integer \| null` |  |
| `data[].effective_at` | `integer \| null` |  |
| `data[].ending_balance` | `integer \| null` |  |
| `data[].footer` | `string \| null` |  |
| `data[].from_invoice` | `object \| null` |  |
| `data[].hosted_invoice_url` | `string \| null` |  |
| `data[].invoice_pdf` | `string \| null` |  |
| `data[].issuer` | `object` |  |
| `data[].last_finalization_error` | `object \| null` |  |
| `data[].latest_revision` | `string \| null` |  |
| `data[].lines` | `object` |  |
| `data[].livemode` | `boolean` |  |
| `data[].metadata` | `object` |  |
| `data[].next_payment_attempt` | `integer \| null` |  |
| `data[].number` | `string \| null` |  |
| `data[].on_behalf_of` | `string \| null` |  |
| `data[].paid` | `boolean \| null` |  |
| `data[].paid_out_of_band` | `boolean \| null` |  |
| `data[].parent` | `object \| null` |  |
| `data[].payment_intent` | `string \| null` |  |
| `data[].payment_settings` | `object` |  |
| `data[].payments` | `object` |  |
| `data[].period_end` | `integer` |  |
| `data[].period_start` | `integer` |  |
| `data[].post_payment_credit_notes_amount` | `integer` |  |
| `data[].pre_payment_credit_notes_amount` | `integer` |  |
| `data[].quote` | `string \| null` |  |
| `data[].receipt_number` | `string \| null` |  |
| `data[].rendering` | `object \| null` |  |
| `data[].rendering_options` | `object \| null` |  |
| `data[].shipping_cost` | `object \| null` |  |
| `data[].shipping_details` | `object \| null` |  |
| `data[].starting_balance` | `integer` |  |
| `data[].statement_descriptor` | `string \| null` |  |
| `data[].status` | `string \| null` |  |
| `data[].status_transitions` | `object` |  |
| `data[].subscription` | `string \| null` |  |
| `data[].subscription_details` | `object \| null` |  |
| `data[].subtotal` | `integer` |  |
| `data[].subtotal_excluding_tax` | `integer \| null` |  |
| `data[].tax` | `integer \| null` |  |
| `data[].test_clock` | `string \| null` |  |
| `data[].threshold_reason` | `object \| null` |  |
| `data[].total` | `integer` |  |
| `data[].total_discount_amounts` | `array \| null` |  |
| `data[].total_excluding_tax` | `integer \| null` |  |
| `data[].total_pretax_credit_amounts` | `array \| null` |  |
| `data[].total_tax_amounts` | `array \| null` |  |
| `data[].total_taxes` | `array \| null` |  |
| `data[].transfer_data` | `object \| null` |  |
| `data[].webhooks_delivered_at` | `integer \| null` |  |
| `has_more` | `boolean` |  |
| `next_page` | `string \| null` |  |
| `url` | `string` |  |


</details>

### Invoices Search

Search and filter invoices records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

#### Python SDK

```python
await stripe.invoices.search(
    query={"filter": {"eq": {"account_country": "<str>"}}}
)
```

#### API

```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/sources/{your_source_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "invoices",
    "action": "search",
    "params": {
        "query": {"filter": {"eq": {"account_country": "<str>"}}}
    }
}'
```

#### Parameters

| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `query` | `object` | Yes | Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or |
| `query.filter` | `object` | No | Filter conditions |
| `query.sort` | `array` | No | Sort conditions |
| `limit` | `integer` | No | Maximum results to return (default 1000) |
| `cursor` | `string` | No | Pagination cursor from previous response's next_cursor |
| `fields` | `array` | No | Field paths to include in results |

#### Searchable

…(truncated)