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, Create, Get, Update, Delete, Search, Context Store Search, Context Store SQL Query
Invoices	List, Create, Get, Search, Context Store Search, Context Store SQL Query
Invoice Finalizations	Create
Invoice Sends	Create
Charges	List, Get, Search, Context Store Search, Context Store SQL Query
Subscriptions	List, Create, Get, Update, Delete, Search, Context Store Search, Context Store SQL Query
Refunds	List, Create, Get, Context Store Search, Context Store SQL Query
Products	List, Create, Get, Update, Delete, Search
Balance	Get
Balance Transactions	List, Get
Payment Intents	List, Create, Get, Update, Search
Payment Intent Confirmations	Create
Payment Intent Cancellations	Create
Prices	Create
Checkout Sessions	Create
Payment Method Attachments	Create
Disputes	List, Get
Payouts	List, 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.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "customers",
  "action": "list"
}'

Python SDK

await stripe.customers.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_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)

Response Schema

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

Customers Create

Creates a new customer object.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "customers",
  "action": "create"
}'

Python SDK

await stripe.customers.create()

API

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

Response Schema

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

Customers Get

Retrieves a Customer object.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "customers",
  "action": "get",
  "params": {
    "id": "<str>"
  }
}'

Python SDK

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

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_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

Response Schema

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

Customers Update

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

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "customers",
  "action": "update",
  "params": {
    "id": "<str>"
  }
}'

Python SDK

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

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_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

Response Schema

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

Customers Delete

Permanently deletes a customer. It cannot be undone.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "customers",
  "action": "delete",
  "params": {
    "id": "<str>"
  }
}'

Python SDK

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

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_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

Response Schema

Records

Field Name	Type	Description
id	string
object	"customer"
deleted	boolean

Customers Search

Search for customers using Stripe's Search Query Language.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "customers",
  "action": "search",
  "params": {
    "query": "<str>"
  }
}'

Python SDK

await stripe.customers.search(
    query="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "customers",
    "action": "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.

Response Schema

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

Customers Context Store 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.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "customers",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "account_balance": 0
        }
      }
    }
  }
}'

Python SDK

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

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "customers",
    "action": "context_store_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, startswith, endswith, contains, array_contains, 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 meta.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.

Response Schema

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

Customers Context Store SQL Query

Run a SQL query against customers records in the Airbyte Context Store. SQL projections may return any set of columns, so each result row is a dictionary matching the query's selected fields. Only available in hosted mode.

Use the hosted server documentation to find the qualified Context Store table name and SQL guidance.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "customers",
  "action": "context_store_sql_query",
  "params": {
    "sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
  }
}'

Python SDK

await stripe.customers.context_store_sql_query(
    sql="SELECT * FROM <qualified_context_store_table> LIMIT 100"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "customers",
    "action": "context_store_sql_query",
    "params": {
        "sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
    }
}'

Parameters

Parameter Name	Type	Required	Description
sql	string	Yes	SQL query to execute against this entity's Context Store data
limit	integer	No	Maximum results to return

Response Schema

Field Name	Type	Description
data	array	Projected rows, with dictionary keys matching the selected columns
meta	object	Query metadata
meta.has_more	boolean	Whether the result was limited and more rows are available
meta.cursor	null	SQL query results do not use cursor pagination
meta.took_ms	number | null	Query execution time in milliseconds

Invoices

Invoices List

Returns a list of invoices

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "invoices",
  "action": "list"
}'

Python SDK

await stripe.invoices.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_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.

Response Schema

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

Invoices Create

Creates a draft invoice for a given customer. The invoice remains a draft until you finalize it, which allows you to pay or send the invoice to your customers.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "invoices",
  "action": "create"
}'

Python SDK

await stripe.invoices.create()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "invoices",
    "action": "create"
}'

Response Schema

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

Invoices Get

Retrieves the invoice with the given ID

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "invoices",
  "action": "get",
  "params": {
    "id": "<str>"
  }
}'

Python SDK

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

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_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

Response Schema

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

Invoices Search

Search for invoices using Stripe's Search Query Language

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "invoices",
  "action": "search",
  "params": {
    "query": "<str>"
  }
}'

Python SDK

await stripe.invoices.search(
    query="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "invoices",
    "action": "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.

Response Schema

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

Invoices Context Store 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.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "invoices",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "account_country": "<str>"
        }
      }
    }
  }
}'

Python SDK

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

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "invoices",
    "action": "context_store_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, startswith, endswith, contains, array_contains, 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 meta.cursor
fields	array	No	Field paths to include in results

Searchable Fields

Field Name	Type	Description
account_country	string	The country of the business associated with this invoice, commonly used to display localized content.
account_name	string	The public name of the business associated with this invoice.
account_tax_ids	array	Tax IDs of the account associated with this invoice.
amount_due	integer	Total amount, in smallest currency unit, that is due and owed by the customer.
amount_paid	integer	Total amount, in smallest currency unit, that has been paid by the customer.
amount_remaining	integer	The difference between amount_due and amount_paid, representing the outstanding balance.
amount_shipping	integer	Total amount of shipping costs on the invoice.
application	string	ID of the Connect application that created this invoice.
application_fee	integer	Amount of application fee charged for this invoice in a Connect scenario.
application_fee_amount	integer	The fee in smallest currency unit that is collected by the application in a Connect scenario.
attempt_count	integer	Number of payment attempts made for this invoice.
attempted	boolean	Whether an attempt has been made to pay the invoice.
auto_advance	boolean	Controls whether Stripe performs automatic collection of the invoice.
automatic_tax	object	Settings and status for automatic tax calculation on this invoice.
billing	string	Billing method used for the invoice (charge_automatically or send_invoice).
billing_reason	string	Indicates the reason why the invoice was created (subscription_cycle, manual, etc.).
charge	string	ID of the latest charge generated for this invoice, if any.
closed	boolean	Whether the invoice has been marked as closed and no longer open for collection.
collection_method	string	Method by which the invoice is collected: charge_automatically or send_invoice.
created	integer	Timestamp indicating when the invoice was created.
currency	string	Three-letter ISO currency code in which the invoice is denominated.
custom_fields	array	Custom fields displayed on the invoice as specified by the account.
customer	string	The customer object or ID associated with this invoice.
customer_address	object	The customer's address at the time the invoice was finalized.
customer_email	string	The customer's email address at the time the invoice was finalized.
customer_name	string	The customer's name at the time the invoice was finalized.
customer_phone	string	The customer's phone number at the time the invoice was finalized.
customer_shipping	object	The customer's shipping information at the time the invoice was finalized.
customer_tax_exempt	string	The customer's tax exempt status at the time the invoice was finalized.
customer_tax_ids	array	The customer's tax IDs at the time the invoice was finalized.
default_payment_method	string	Default payment method for the invoice, used if no other method is specified.
default_source	string	Default payment source for the invoice if no payment method is set.
default_tax_rates	array	The tax rates applied to the invoice by default.
description	string	An arbitrary string attached to the invoice, often displayed to customers.
discount	object	The discount object applied to the invoice, if any.
discounts	array	Array of discount IDs or objects currently applied to this invoice.
due_date	number	The date by which payment on this invoice is due, if the invoice is not auto-collected.
effective_at	integer	Timestamp when the invoice becomes effective and finalized for payment.
ending_balance	integer	The customer's ending account balance after this invoice is finalized.
footer	string	Footer text displayed on the invoice.
forgiven	boolean	Whether the invoice has been forgiven and is considered paid without actual payment.
from_invoice	object	Details about the invoice this invoice was created from, if applicable.
hosted_invoice_url	string	URL for the hosted invoice page where customers can view and pay the invoice.
id	string	Unique identifier for the invoice object.
invoice_pdf	string	URL for the PDF version of the invoice.
is_deleted	boolean	Indicates whether this invoice has been deleted.
issuer	object	Details about the entity issuing the invoice.
last_finalization_error	object	The error encountered during the last finalization attempt, if any.
latest_revision	string	The latest revision of the invoice, if revisions are enabled.
lines	object	The individual line items that make up the invoice, representing products, services, or fees.
livemode	boolean	Indicates whether the invoice exists in live mode (true) or test mode (false).
metadata	object	Key-value pairs for storing additional structured information about the invoice.
next_payment_attempt	number	Timestamp of the next automatic payment attempt for this invoice, if applicable.
number	string	A unique, human-readable identifier for this invoice, often shown to customers.
object	string	String representing the object type, always 'invoice'.
on_behalf_of	string	The account on behalf of which the invoice is being created, used in Connect scenarios.
paid	boolean	Whether the invoice has been paid in full.
paid_out_of_band	boolean	Whether payment was made outside of Stripe and manually marked as paid.
payment	string	ID of the payment associated with this invoice, if any.
payment_intent	string	The PaymentIntent associated with this invoice for processing payment.
payment_settings	object	Configuration settings for how payment should be collected on this invoice.
period_end	number	End date of the billing period covered by this invoice.
period_start	number	Start date of the billing period covered by this invoice.
post_payment_credit_notes_amount	integer	Total amount of credit notes issued after the invoice was paid.
pre_payment_credit_notes_amount	integer	Total amount of credit notes applied before payment was attempted.
quote	string	The quote from which this invoice was generated, if applicable.
receipt_number	string	The receipt number displayed on the invoice, if available.
rendering	object	Settings that control how the invoice is rendered for display.
rendering_options	object	Options for customizing the visual rendering of the invoice.
shipping_cost	object	Total cost of shipping charges included in the invoice.
shipping_details	object	Detailed shipping information for the invoice, including address and carrier.
starting_balance	integer	The customer's starting account balance at the beginning of the billing period.
statement_description	string	Extra information about the invoice that appears on the customer's credit card statement.
statement_descriptor	string	A dynamic descriptor that appears on the customer's credit card statement for this invoice.
status	string	The status of the invoice: draft, open, paid, void, or uncollectible.
status_transitions	object	Timestamps tracking when the invoice transitioned between different statuses.
subscription	string	The subscription this invoice was generated for, if applicable.
subscription_details	object	Additional details about the subscription associated with this invoice.
subtotal	integer	Total of all line items before discounts or tax are applied.
subtotal_excluding_tax	integer	The subtotal amount excluding any tax calculations.
tax	integer	Total tax amount applied to the invoice.
tax_percent	number	The percentage of tax applied to the invoice (deprecated, use total_tax_amounts instead).
test_clock	string	ID of the test clock this invoice belongs to, used for testing time-dependent billing.
total	integer	Total amount of the invoice after all line items, discounts, and taxes are calculated.
total_discount_amounts	array	Array of the total discount amounts applied, broken down by discount.
total_excluding_tax	integer	Total amount of the invoice excluding all tax calculations.
total_tax_amounts	array	Array of tax amounts applied to the invoice, broken down by tax rate.
transfer_data	object	Information about the transfer of funds associated with this invoice in Connect scenarios.
updated	integer	Timestamp indicating when the invoice was last updated.
webhooks_delivered_at	number	Timestamp indicating when webhooks for this invoice were successfully delivered.

Response Schema

Field Name	Type	Description
data	array	List of matching records
meta	object	Pagination metadata
meta.has_more	boolean	Whether additional pages are available
meta.cursor	string | null	Cursor for next page of results
meta.took_ms	number | null	Query execution time in milliseconds
data[].account_country	string	The country of the business associated with this invoice, commonly used to display localized content.
data[].account_name	string	The public name of the business associated with this invoice.
data[].account_tax_ids	array	Tax IDs of the account associated with this invoice.
data[].amount_due	integer	Total amount, in smallest currency unit, that is due and owed by the customer.
data[].amount_paid	integer	Total amount, in smallest currency unit, that has been paid by the customer.
data[].amount_remaining	integer	The difference between amount_due and amount_paid, representing the outstanding balance.
data[].amount_shipping	integer	Total amount of shipping costs on the invoice.
data[].application	string	ID of the Connect application that created this invoice.
data[].application_fee	integer	Amount of application fee charged for this invoice in a Connect scenario.
data[].application_fee_amount	integer	The fee in smallest currency unit that is collected by the application in a Connect scenario.
data[].attempt_count	integer	Number of payment attempts made for this invoice.
data[].attempted	boolean	Whether an attempt has been made to pay the invoice.
data[].auto_advance	boolean	Controls whether Stripe performs automatic collection of the invoice.
data[].automatic_tax	object	Settings and status for automatic tax calculation on this invoice.
data[].billing	string	Billing method used for the invoice (charge_automatically or send_invoice).
data[].billing_reason	string	Indicates the reason why the invoice was created (subscription_cycle, manual, etc.).
data[].charge	string	ID of the latest charge generated for this invoice, if any.
data[].closed	boolean	Whether the invoice has been marked as closed and no longer open for collection.
data[].collection_method	string	Method by which the invoice is collected: charge_automatically or send_invoice.
data[].created	integer	Timestamp indicating when the invoice was created.
data[].currency	string	Three-letter ISO currency code in which the invoice is denominated.
data[].custom_fields	array	Custom fields displayed on the invoice as specified by the account.
data[].customer	string	The customer object or ID associated with this invoice.
data[].customer_address	object	The customer's address at the time the invoice was finalized.
data[].customer_email	string	The customer's email address at the time the invoice was finalized.
data[].customer_name	string	The customer's name at the time the invoice was finalized.
data[].customer_phone	string	The customer's phone number at the time the invoice was finalized.
data[].customer_shipping	object	The customer's shipping information at the time the invoice was finalized.
data[].customer_tax_exempt	string	The customer's tax exempt status at the time the invoice was finalized.
data[].customer_tax_ids	array	The customer's tax IDs at the time the invoice was finalized.
data[].default_payment_method	string	Default payment method for the invoice, used if no other method is specified.
data[].default_source	string	Default payment source for the invoice if no payment method is set.
data[].default_tax_rates	array	The tax rates applied to the invoice by default.
data[].description	string	An arbitrary string attached to the invoice, often displayed to customers.
data[].discount	object	The discount object applied to the invoice, if any.
data[].discounts	array	Array of discount IDs or objects currently applied to this invoice.
data[].due_date	number	The date by which payment on this invoice is due, if the invoice is not auto-collected.
data[].effective_at	integer	Timestamp when the invoice becomes effective and finalized for payment.
data[].ending_balance	integer	The customer's ending account balance after this invoice is finalized.
data[].footer	string	Footer text displayed on the invoice.
data[].forgiven	boolean	Whether the invoice has been forgiven and is considered paid without actual payment.
data[].from_invoice	object	Details about the invoice this invoice was created from, if applicable.
data[].hosted_invoice_url	string	URL for the hosted invoice page where customers can view and pay the invoice.
data[].id	string	Unique identifier for the invoice object.
data[].invoice_pdf	string	URL for the PDF version of the invoice.
data[].is_deleted	boolean	Indicates whether this invoice has been deleted.
data[].issuer	object	Details about the entity issuing the invoice.
data[].last_finalization_error	object	The error encountered during the last finalization attempt, if any.
data[].latest_revision	string	The latest revision of the invoice, if revisions are enabled.
data[].lines	object	The individual line items that make up the invoice, representing products, services, or fees.
data[].livemode	boolean	Indicates whether the invoice exists in live mode (true) or test mode (false).
data[].metadata	object	Key-value pairs for storing additional structured information about the invoice.
data[].next_payment_attempt	number	Timestamp of the next automatic payment attempt for this invoice, if applicable.
data[].number	string	A unique, human-readable identifier for this invoice, often shown to customers.
data[].object	string	String representing the object type, always 'invoice'.
data[].on_behalf_of	string	The account on behalf of which the invoice is being created, used in Connect scenarios.
data[].paid	boolean	Whether the invoice has been paid in full.
data[].paid_out_of_band	boolean	Whether payment was made outside of Stripe and manually marked as paid.
data[].payment	string	ID of the payment associated with this invoice, if any.
data[].payment_intent	string	The PaymentIntent associated with this invoice for processing payment.
data[].payment_settings	object	Configuration settings for how payment should be collected on this invoice.
data[].period_end	number	End date of the billing period covered by this invoice.
data[].period_start	number	Start date of the billing period covered by this invoice.
data[].post_payment_credit_notes_amount	integer	Total amount of credit notes issued after the invoice was paid.
data[].pre_payment_credit_notes_amount	integer	Total amount of credit notes applied before payment was attempted.
data[].quote	string	The quote from which this invoice was generated, if applicable.
data[].receipt_number	string	The receipt number displayed on the invoice, if available.
data[].rendering	object	Settings that control how the invoice is rendered for display.
data[].rendering_options	object	Options for customizing the visual rendering of the invoice.
data[].shipping_cost	object	Total cost of shipping charges included in the invoice.
data[].shipping_details	object	Detailed shipping information for the invoice, including address and carrier.
data[].starting_balance	integer	The customer's starting account balance at the beginning of the billing period.
data[].statement_description	string	Extra information about the invoice that appears on the customer's credit card statement.
data[].statement_descriptor	string	A dynamic descriptor that appears on the customer's credit card statement for this invoice.
data[].status	string	The status of the invoice: draft, open, paid, void, or uncollectible.
data[].status_transitions	object	Timestamps tracking when the invoice transitioned between different statuses.
data[].subscription	string	The subscription this invoice was generated for, if applicable.
data[].subscription_details	object	Additional details about the subscription associated with this invoice.
data[].subtotal	integer	Total of all line items before discounts or tax are applied.
data[].subtotal_excluding_tax	integer	The subtotal amount excluding any tax calculations.
data[].tax	integer	Total tax amount applied to the invoice.
data[].tax_percent	number	The percentage of tax applied to the invoice (deprecated, use total_tax_amounts instead).
data[].test_clock	string	ID of the test clock this invoice belongs to, used for testing time-dependent billing.
data[].total	integer	Total amount of the invoice after all line items, discounts, and taxes are calculated.
data[].total_discount_amounts	array	Array of the total discount amounts applied, broken down by discount.
data[].total_excluding_tax	integer	Total amount of the invoice excluding all tax calculations.
data[].total_tax_amounts	array	Array of tax amounts applied to the invoice, broken down by tax rate.
data[].transfer_data	object	Information about the transfer of funds associated with this invoice in Connect scenarios.
data[].updated	integer	Timestamp indicating when the invoice was last updated.
data[].webhooks_delivered_at	number	Timestamp indicating when webhooks for this invoice were successfully delivered.

Invoices Context Store SQL Query

Run a SQL query against invoices records in the Airbyte Context Store. SQL projections may return any set of columns, so each result row is a dictionary matching the query's selected fields. Only available in hosted mode.

Use the hosted server documentation to find the qualified Context Store table name and SQL guidance.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "invoices",
  "action": "context_store_sql_query",
  "params": {
    "sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
  }
}'

Python SDK

await stripe.invoices.context_store_sql_query(
    sql="SELECT * FROM <qualified_context_store_table> LIMIT 100"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "invoices",
    "action": "context_store_sql_query",
    "params": {
        "sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
    }
}'

Parameters

Parameter Name	Type	Required	Description
sql	string	Yes	SQL query to execute against this entity's Context Store data
limit	integer	No	Maximum results to return

Response Schema

Field Name	Type	Description
data	array	Projected rows, with dictionary keys matching the selected columns
meta	object	Query metadata
meta.has_more	boolean	Whether the result was limited and more rows are available
meta.cursor	null	SQL query results do not use cursor pagination
meta.took_ms	number | null	Query execution time in milliseconds

Invoice Finalizations

Invoice Finalizations Create

Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you'd like to finalize a draft invoice manually, you can do so using this method.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "invoice_finalizations",
  "action": "create",
  "params": {
    "id": "<str>"
  }
}'

Python SDK

await stripe.invoice_finalizations.create(
    id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "invoice_finalizations",
    "action": "create",
    "params": {
        "id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
id	string	Yes	The ID of the invoice to finalize

Response Schema

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

Invoice Sends

Invoice Sends Create

Stripe will automatically send invoices to customers according to your subscriptions settings. However, if you'd like to manually send an invoice to your customer out of the normal schedule, you can do so.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "invoice_sends",
  "action": "create",
  "params": {
    "id": "<str>"
  }
}'

Python SDK

await stripe.invoice_sends.create(
    id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "invoice_sends",
    "action": "create",
    "params": {
        "id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
id	string	Yes	The ID of the invoice to send

Response Schema

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

Charges

Charges List

Returns a list of charges you've previously created. The charges are returned in sorted order, with the most recent charges appearing first.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "charges",
  "action": "list"
}'

Python SDK

await stripe.charges.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "charges",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
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 charges for the customer specified by this customer 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.
payment_intent	string	No	Only return charges that were created by the PaymentIntent specified by this ID
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.

Response Schema

Records

Field Name	Type	Description
id	string
object	"charge"
created	integer
livemode	boolean
amount	integer
amount_captured	integer
amount_refunded	integer
amount_updates	array | null
application	string | null
application_fee	string | null
application_fee_amount	integer | null
calculated_statement_descriptor	string | null
currency	string
customer	string | null
description	string | null
destination	string | null
dispute	string | null
disputed	boolean
failure_balance_transaction	string | null
failure_code	string | null
failure_message	string | null
fraud_details	object | null
invoice	string | null
on_behalf_of	string | null
order	string | null
outcome	object | null
paid	boolean
payment_intent	string | null
payment_method	string | null
payment_method_details	object | null
presentment_details	object | null
receipt_email	string | null
receipt_number	string | null
receipt_url	string | null
refunded	boolean
refunds	object | null
review	string | null
shipping	object | null
source	object | null
source_transfer	string | null
statement_descriptor	string | null
statement_descriptor_suffix	string | null
status	"succeeded" | "pending" | "failed"
transfer_data	object | null
transfer_group	string | null
captured	boolean
balance_transaction	string | null
billing_details	object
metadata	object
radar_options	object | null

Meta

Field Name	Type	Description
has_more	boolean

Charges Get

Retrieves the details of a charge that has previously been created

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "charges",
  "action": "get",
  "params": {
    "id": "<str>"
  }
}'

Python SDK

await stripe.charges.get(
    id="<str>"
)

API

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

Parameters

Parameter Name	Type	Required	Description
id	string	Yes	The charge ID

Response Schema

Records

Field Name	Type	Description
id	string
object	"charge"
created	integer
livemode	boolean
amount	integer
amount_captured	integer
amount_refunded	integer
amount_updates	array | null
application	string | null
application_fee	string | null
application_fee_amount	integer | null
calculated_statement_descriptor	string | null
currency	string
customer	string | null
description	string | null
destination	string | null
dispute	string | null
disputed	boolean
failure_balance_transaction	string | null
failure_code	string | null
failure_message	string | null
fraud_details	object | null
invoice	string | null
on_behalf_of	string | null
order	string | null
outcome	object | null
paid	boolean
payment_intent	string | null
payment_method	string | null
payment_method_details	object | null
presentment_details	object | null
receipt_email	string | null
receipt_number	string | null
receipt_url	string | null
refunded	boolean
refunds	object | null
review	string | null
shipping	object | null
source	object | null
source_transfer	string | null
statement_descriptor	string | null
statement_descriptor_suffix	string | null
status	"succeeded" | "pending" | "failed"
transfer_data	object | null
transfer_group	string | null
captured	boolean
balance_transaction	string | null
billing_details	object
metadata	object
radar_options	object | null

Charges Search

Search for charges using Stripe's Search Query Language

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "charges",
  "action": "search",
  "params": {
    "query": "<str>"
  }
}'

Python SDK

await stripe.charges.search(
    query="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "charges",
    "action": "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.

Response Schema

Records

Field Name	Type	Description
object	"search_result"
data	array<object>
data[].id	string
data[].object	"charge"
data[].created	integer
data[].livemode	boolean
data[].amount	integer
data[].amount_captured	integer
data[].amount_refunded	integer
data[].amount_updates	array | null
data[].application	string | null
data[].application_fee	string | null
data[].application_fee_amount	integer | null
data[].calculated_statement_descriptor	string | null
data[].currency	string
data[].customer	string | null
data[].description	string | null
data[].destination	string | null
data[].dispute	string | null
data[].disputed	boolean
data[].failure_balance_transaction	string | null
data[].failure_code	string | null
data[].failure_message	string | null
data[].fraud_details	object | null
data[].invoice	string | null
data[].on_behalf_of	string | null
data[].order	string | null
data[].outcome	object | null
data[].paid	boolean
data[].payment_intent	string | null
data[].payment_method	string | null
data[].payment_method_details	object | null
data[].presentment_details	object | null
data[].receipt_email	string | null
data[].receipt_number	string | null
data[].receipt_url	string | null
data[].refunded	boolean
data[].refunds	object | null
data[].review	string | null
data[].shipping	object | null
data[].source	object | null
data[].source_transfer	string | null
data[].statement_descriptor	string | null
data[].statement_descriptor_suffix	string | null
data[].status	"succeeded" | "pending" | "failed"
data[].transfer_data	object | null
data[].transfer_group	string | null
data[].captured	boolean
data[].balance_transaction	string | null
data[].billing_details	object
data[].metadata	object
data[].radar_options	object | null
has_more	boolean
next_page	string | null
url	string

Charges Context Store Search

Search and filter charges 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.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "charges",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "amount": 0
        }
      }
    }
  }
}'

Python SDK

await stripe.charges.context_store_search(
    query={"filter": {"eq": {"amount": 0}}}
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "charges",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"amount": 0}}}
    }
}'

Parameters

Parameter Name	Type	Required	Description
query	object	Yes	Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, startswith, endswith, contains, array_contains, 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 meta.cursor
fields	array	No	Field paths to include in results

Searchable Fields

Field Name	Type	Description
amount	integer	Amount intended to be collected by this payment in the smallest currency unit (e.g., 100 cents for $1.00), supporting up to eight digits.
amount_captured	integer	Amount that was actually captured from this charge.
amount_refunded	integer	Amount that has been refunded back to the customer.
amount_updates	array	Updates to the amount that have been made during the charge lifecycle.
application	string	ID of the application that created this charge (Connect only).
application_fee	string	ID of the application fee associated with this charge (Connect only).
application_fee_amount	integer	The amount of the application fee deducted from this charge (Connect only).
balance_transaction	string	ID of the balance transaction that describes the impact of this charge on your account balance (excluding refunds or disputes).
billing_details	object	Billing information associated with the payment method at the time of the transaction, including name, email, phone, and address.
calculated_statement_descriptor	string	The full statement descriptor that appears on the customer's credit card statement, combining prefix and suffix.
captured	boolean	Whether the charge has been captured and funds transferred to your account.
card	object	Deprecated card object containing payment card details if a card was used.
created	integer	Timestamp indicating when the charge was created.
currency	string	Three-letter ISO currency code in lowercase (e.g., 'usd', 'eur') for the charge amount.
customer	string	ID of the customer this charge is for, if one exists.
description	string	An arbitrary string attached to the charge, often useful for displaying to users or internal reference.
destination	string	ID of the destination account where funds are transferred (Connect only).
dispute	string	ID of the dispute object if the charge has been disputed.
disputed	boolean	Whether the charge has been disputed by the customer with their card issuer.
failure_balance_transaction	string	ID of the balance transaction that describes the reversal of funds if the charge failed.
failure_code	string	Error code explaining the reason for charge failure, if applicable.
failure_message	string	Human-readable message providing more details about why the charge failed.
fraud_details	object	Information about fraud assessments and user reports related to this charge.
id	string	Unique identifier for the charge, used to link transactions across other records.
invoice	string	ID of the invoice this charge is for, if the charge was created by invoicing.
livemode	boolean	Whether the charge occurred in live mode (true) or test mode (false).
metadata	object	Key-value pairs for storing additional structured information about the charge, useful for internal tracking.
object	string	String representing the object type, always 'charge' for charge objects.
on_behalf_of	string	ID of the account on whose behalf the charge was made (Connect only).
order	string	Deprecated field for order information associated with this charge.
outcome	object	Details about the outcome of the charge, including network status, risk assessment, and reason codes.
paid	boolean	Whether the charge succeeded and funds were successfully collected.
payment_intent	string	ID of the PaymentIntent associated with this charge, if one exists.
payment_method	string	ID of the payment method used for this charge.
payment_method_details	object	Details about the payment method at the time of the transaction, including card brand, network, and authentication results.
receipt_email	string	Email address to which the receipt for this charge was sent.
receipt_number	string	Receipt number that appears on email receipts sent for this charge.
receipt_url	string	URL to a hosted receipt page for this charge, viewable by the customer.
refunded	boolean	Whether the charge has been fully refunded (partial refunds will still show as false).
refunds	object	List of refunds that have been applied to this charge.
review	string	ID of the review object associated with this charge, if it was flagged for manual review.
shipping	object	Shipping information for the charge, including recipient name, address, and tracking details.
source	object	Deprecated payment source object used to create this charge.
source_transfer	string	ID of the transfer from a source account if funds came from another Stripe account (Connect only).
statement_description	string	Deprecated alias for statement_descriptor.
statement_descriptor	string	Statement descriptor that overrides the account default for card charges, appearing on the customer's statement.
statement_descriptor_suffix	string	Suffix concatenated to the account's statement descriptor prefix to form the complete descriptor on customer statements.
status	string	Current status of the payment: 'succeeded' (completed), 'pending' (processing), or 'failed' (unsuccessful).
transfer_data	object	Object containing destination and amount for transfers to connected accounts (Connect only).
transfer_group	string	String identifier for grouping related charges and transfers together (Connect only).
updated	integer	Timestamp of the last update to this charge object.

Response Schema

Field Name	Type	Description
data	array	List of matching records
meta	object	Pagination metadata
meta.has_more	boolean	Whether additional pages are available
meta.cursor	string | null	Cursor for next page of results
meta.took_ms	number | null	Query execution time in milliseconds
data[].amount	integer	Amount intended to be collected by this payment in the smallest currency unit (e.g., 100 cents for $1.00), supporting up to eight digits.
data[].amount_captured	integer	Amount that was actually captured from this charge.
data[].amount_refunded	integer	Amount that has been refunded back to the customer.
data[].amount_updates	array	Updates to the amount that have been made during the charge lifecycle.
data[].application	string	ID of the application that created this charge (Connect only).
data[].application_fee	string	ID of the application fee associated with this charge (Connect only).
data[].application_fee_amount	integer	The amount of the application fee deducted from this charge (Connect only).
data[].balance_transaction	string	ID of the balance transaction that describes the impact of this charge on your account balance (excluding refunds or disputes).
data[].billing_details	object	Billing information associated with the payment method at the time of the transaction, including name, email, phone, and address.
data[].calculated_statement_descriptor	string	The full statement descriptor that appears on the customer's credit card statement, combining prefix and suffix.
data[].captured	boolean	Whether the charge has been captured and funds transferred to your account.
data[].card	object	Deprecated card object containing payment card details if a card was used.
data[].created	integer	Timestamp indicating when the charge was created.
data[].currency	string	Three-letter ISO currency code in lowercase (e.g., 'usd', 'eur') for the charge amount.
data[].customer	string	ID of the customer this charge is for, if one exists.
data[].description	string	An arbitrary string attached to the charge, often useful for displaying to users or internal reference.
data[].destination	string	ID of the destination account where funds are transferred (Connect only).
data[].dispute	string	ID of the dispute object if the charge has been disputed.
data[].disputed	boolean	Whether the charge has been disputed by the customer with their card issuer.
data[].failure_balance_transaction	string	ID of the balance transaction that describes the reversal of funds if the charge failed.
data[].failure_code	string	Error code explaining the reason for charge failure, if applicable.
data[].failure_message	string	Human-readable message providing more details about why the charge failed.
data[].fraud_details	object	Information about fraud assessments and user reports related to this charge.
data[].id	string	Unique identifier for the charge, used to link transactions across other records.
data[].invoice	string	ID of the invoice this charge is for, if the charge was created by invoicing.
data[].livemode	boolean	Whether the charge occurred in live mode (true) or test mode (false).
data[].metadata	object	Key-value pairs for storing additional structured information about the charge, useful for internal tracking.
data[].object	string	String representing the object type, always 'charge' for charge objects.
data[].on_behalf_of	string	ID of the account on whose behalf the charge was made (Connect only).
data[].order	string	Deprecated field for order information associated with this charge.
data[].outcome	object	Details about the outcome of the charge, including network status, risk assessment, and reason codes.
data[].paid	boolean	Whether the charge succeeded and funds were successfully collected.
data[].payment_intent	string	ID of the PaymentIntent associated with this charge, if one exists.
data[].payment_method	string	ID of the payment method used for this charge.
data[].payment_method_details	object	Details about the payment method at the time of the transaction, including card brand, network, and authentication results.
data[].receipt_email	string	Email address to which the receipt for this charge was sent.
data[].receipt_number	string	Receipt number that appears on email receipts sent for this charge.
data[].receipt_url	string	URL to a hosted receipt page for this charge, viewable by the customer.
data[].refunded	boolean	Whether the charge has been fully refunded (partial refunds will still show as false).
data[].refunds	object	List of refunds that have been applied to this charge.
data[].review	string	ID of the review object associated with this charge, if it was flagged for manual review.
data[].shipping	object	Shipping information for the charge, including recipient name, address, and tracking details.
data[].source	object	Deprecated payment source object used to create this charge.
data[].source_transfer	string	ID of the transfer from a source account if funds came from another Stripe account (Connect only).
data[].statement_description	string	Deprecated alias for statement_descriptor.
data[].statement_descriptor	string	Statement descriptor that overrides the account default for card charges, appearing on the customer's statement.
data[].statement_descriptor_suffix	string	Suffix concatenated to the account's statement descriptor prefix to form the complete descriptor on customer statements.
data[].status	string	Current status of the payment: 'succeeded' (completed), 'pending' (processing), or 'failed' (unsuccessful).
data[].transfer_data	object	Object containing destination and amount for transfers to connected accounts (Connect only).
data[].transfer_group	string	String identifier for grouping related charges and transfers together (Connect only).
data[].updated	integer	Timestamp of the last update to this charge object.

Charges Context Store SQL Query

Run a SQL query against charges records in the Airbyte Context Store. SQL projections may return any set of columns, so each result row is a dictionary matching the query's selected fields. Only available in hosted mode.

Use the hosted server documentation to find the qualified Context Store table name and SQL guidance.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "charges",
  "action": "context_store_sql_query",
  "params": {
    "sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
  }
}'

Python SDK

await stripe.charges.context_store_sql_query(
    sql="SELECT * FROM <qualified_context_store_table> LIMIT 100"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "charges",
    "action": "context_store_sql_query",
    "params": {
        "sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
    }
}'

Parameters

Parameter Name	Type	Required	Description
sql	string	Yes	SQL query to execute against this entity's Context Store data
limit	integer	No	Maximum results to return

Response Schema

Field Name	Type	Description
data	array	Projected rows, with dictionary keys matching the selected columns
meta	object	Query metadata
meta.has_more	boolean	Whether the result was limited and more rows are available
meta.cursor	null	SQL query results do not use cursor pagination
meta.took_ms	number | null	Query execution time in milliseconds

Subscriptions

Subscriptions List

By default, returns a list of subscriptions that have not been canceled

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "subscriptions",
  "action": "list"
}'

Python SDK

await stripe.subscriptions.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "subscriptions",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
automatic_tax	object	No	Filter subscriptions by their automatic tax settings.
automatic_tax.enabled	boolean	No	Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
collection_method	"charge_automatically" | "send_invoice"	No	The collection method of the subscriptions 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)
current_period_end	object	No	Only return subscriptions whose minimum item current_period_end falls within the given date interval.
current_period_end.gt	integer	No	Minimum value to filter by (exclusive)
current_period_end.gte	integer	No	Minimum value to filter by (inclusive)
current_period_end.lt	integer	No	Maximum value to filter by (exclusive)
current_period_end.lte	integer	No	Maximum value to filter by (inclusive)
current_period_start	object	No	Only return subscriptions whose maximum item current_period_start falls within the given date interval.
current_period_start.gt	integer	No	Minimum value to filter by (exclusive)
current_period_start.gte	integer	No	Minimum value to filter by (inclusive)
current_period_start.lt	integer	No	Maximum value to filter by (exclusive)
current_period_start.lte	integer	No	Maximum value to filter by (inclusive)
customer	string	No	Only return subscriptions for the customer specified by this customer ID
customer_account	string	No	The ID of the account whose subscriptions will be retrieved.
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.
price	string	No	Filter for subscriptions that contain this recurring price ID.
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	"canceled" | "ended" | "all"	No	The status of the subscriptions to retrieve. Passing in a value of canceled will return all canceled subscriptions, including those belonging to deleted customers. Pass ended to find subscriptions that are canceled and subscriptions that are expired due to incomplete payment. Passing in a value of all will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned.

Response Schema

Records

Field Name	Type	Description
id	string
object	"subscription"
application	string | null
application_fee_percent	number | null
automatic_tax	object
billing_cycle_anchor	integer
billing_cycle_anchor_config	object | null
billing_mode	object
billing_thresholds	object | null
cancel_at	integer | null
cancel_at_period_end	boolean
canceled_at	integer | null
cancellation_details	object | null
collection_method	"charge_automatically" | "send_invoice"
created	integer
currency	string
customer	string
customer_account	string | null
days_until_due	integer | null
default_payment_method	string | null
default_source	string | null
default_tax_rates	array | null
description	string | null
discounts	array<string>
ended_at	integer | null
invoice_settings	object
items	object
latest_invoice	string | null
livemode	boolean
metadata	object
next_pending_invoice_item_invoice	integer | null
on_behalf_of	string | null
pause_collection	object | null
payment_settings	object | null
status	"incomplete" | "incomplete_expired" | "trialing" | "active" | "past_due" | "canceled" | "unpaid" | "paused"
current_period_start	integer
current_period_end	integer
start_date	integer
trial_start	integer | null
trial_end	integer | null
discount	object | null
plan	object | null
quantity	integer | null
schedule	string | null
test_clock	string | null
transfer_data	object | null
trial_settings	object | null
pending_invoice_item_interval	object | null
pending_setup_intent	string | null
pending_update	object | null

Meta

Field Name	Type	Description
has_more	boolean

Subscriptions Create

Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "subscriptions",
  "action": "create"
}'

Python SDK

await stripe.subscriptions.create()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "subscriptions",
    "action": "create"
}'

Response Schema

Records

Field Name	Type	Description
id	string
object	"subscription"
application	string | null
application_fee_percent	number | null
automatic_tax	object
billing_cycle_anchor	integer
billing_cycle_anchor_config	object | null
billing_mode	object
billing_thresholds	object | null
cancel_at	integer | null
cancel_at_period_end	boolean
canceled_at	integer | null
cancellation_details	object | null
collection_method	"charge_automatically" | "send_invoice"
created	integer
currency	string
customer	string
customer_account	string | null
days_until_due	integer | null
default_payment_method	string | null
default_source	string | null
default_tax_rates	array | null
description	string | null
discounts	array<string>
ended_at	integer | null
invoice_settings	object
items	object
latest_invoice	string | null
livemode	boolean
metadata	object
next_pending_invoice_item_invoice	integer | null
on_behalf_of	string | null
pause_collection	object | null
payment_settings	object | null
status	"incomplete" | "incomplete_expired" | "trialing" | "active" | "past_due" | "canceled" | "unpaid" | "paused"
current_period_start	integer
current_period_end	integer
start_date	integer
trial_start	integer | null
trial_end	integer | null
discount	object | null
plan	object | null
quantity	integer | null
schedule	string | null
test_clock	string | null
transfer_data	object | null
trial_settings	object | null
pending_invoice_item_interval	object | null
pending_setup_intent	string | null
pending_update	object | null

Subscriptions Get

Retrieves the subscription with the given ID

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "subscriptions",
  "action": "get",
  "params": {
    "id": "<str>"
  }
}'

Python SDK

await stripe.subscriptions.get(
    id="<str>"
)

API

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

Parameters

Parameter Name	Type	Required	Description
id	string	Yes	The subscription ID

Response Schema

Records

Field Name	Type	Description
id	string
object	"subscription"
application	string | null
application_fee_percent	number | null
automatic_tax	object
billing_cycle_anchor	integer
billing_cycle_anchor_config	object | null
billing_mode	object
billing_thresholds	object | null
cancel_at	integer | null
cancel_at_period_end	boolean
canceled_at	integer | null
cancellation_details	object | null
collection_method	"charge_automatically" | "send_invoice"
created	integer
currency	string
customer	string
customer_account	string | null
days_until_due	integer | null
default_payment_method	string | null
default_source	string | null
default_tax_rates	array | null
description	string | null
discounts	array<string>
ended_at	integer | null
invoice_settings	object
items	object
latest_invoice	string | null
livemode	boolean
metadata	object
next_pending_invoice_item_invoice	integer | null
on_behalf_of	string | null
pause_collection	object | null
payment_settings	object | null
status	"incomplete" | "incomplete_expired" | "trialing" | "active" | "past_due" | "canceled" | "unpaid" | "paused"
current_period_start	integer
current_period_end	integer
start_date	integer
trial_start	integer | null
trial_end	integer | null
discount	object | null
plan	object | null
quantity	integer | null
schedule	string | null
test_clock	string | null
transfer_data	object | null
trial_settings	object | null
pending_invoice_item_interval	object | null
pending_setup_intent	string | null
pending_update	object | null

Subscriptions Update

Updates an existing subscription on a customer to match the specified parameters. When changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "subscriptions",
  "action": "update",
  "params": {
    "id": "<str>"
  }
}'

Python SDK

await stripe.subscriptions.update(
    id="<str>"
)

API

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

Parameters

Parameter Name	Type	Required	Description
id	string	Yes	The subscription ID

Response Schema

Records

Field Name	Type	Description
id	string
object	"subscription"
application	string | null
application_fee_percent	number | null
automatic_tax	object
billing_cycle_anchor	integer
billing_cycle_anchor_config	object | null
billing_mode	object
billing_thresholds	object | null
cancel_at	integer | null
cancel_at_period_end	boolean
canceled_at	integer | null
cancellation_details	object | null
collection_method	"charge_automatically" | "send_invoice"
created	integer
currency	string
customer	string
customer_account	string | null
days_until_due	integer | null
default_payment_method	string | null
default_source	string | null
default_tax_rates	array | null
description	string | null
discounts	array<string>
ended_at	integer | null
invoice_settings	object
items	object
latest_invoice	string | null
livemode	boolean
metadata	object
next_pending_invoice_item_invoice	integer | null
on_behalf_of	string | null
pause_collection	object | null
payment_settings	object | null
status	"incomplete" | "incomplete_expired" | "trialing" | "active" | "past_due" | "canceled" | "unpaid" | "paused"
current_period_start	integer
current_period_end	integer
start_date	integer
trial_start	integer | null
trial_end	integer | null
discount	object | null
plan	object | null
quantity	integer | null
schedule	string | null
test_clock	string | null
transfer_data	object | null
trial_settings	object | null
pending_invoice_item_interval	object | null
pending_setup_intent	string | null
pending_update	object | null

Subscriptions Delete

Cancels a customer's subscription immediately. The customer will not be charged again for the subscription. Any pending invoice items that you've created will still be charged for at the end of the period, unless manually deleted.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "subscriptions",
  "action": "delete",
  "params": {
    "id": "<str>"
  }
}'

Python SDK

await stripe.subscriptions.delete(
    id="<str>"
)

API

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

Parameters

Parameter Name	Type	Required	Description
id	string	Yes	The subscription ID

Response Schema

Records

Field Name	Type	Description
id	string
object	"subscription"
application	string | null
application_fee_percent	number | null
automatic_tax	object
billing_cycle_anchor	integer
billing_cycle_anchor_config	object | null
billing_mode	object
billing_thresholds	object | null
cancel_at	integer | null
cancel_at_period_end	boolean
canceled_at	integer | null
cancellation_details	object | null
collection_method	"charge_automatically" | "send_invoice"
created	integer
currency	string
customer	string
customer_account	string | null
days_until_due	integer | null
default_payment_method	string | null
default_source	string | null
default_tax_rates	array | null
description	string | null
discounts	array<string>
ended_at	integer | null
invoice_settings	object
items	object
latest_invoice	string | null
livemode	boolean
metadata	object
next_pending_invoice_item_invoice	integer | null
on_behalf_of	string | null
pause_collection	object | null
payment_settings	object | null
status	"incomplete" | "incomplete_expired" | "trialing" | "active" | "past_due" | "canceled" | "unpaid" | "paused"
current_period_start	integer
current_period_end	integer
start_date	integer
trial_start	integer | null
trial_end	integer | null
discount	object | null
plan	object | null
quantity	integer | null
schedule	string | null
test_clock	string | null
transfer_data	object | null
trial_settings	object | null
pending_invoice_item_interval	object | null
pending_setup_intent	string | null
pending_update	object | null

Subscriptions Search

Search for subscriptions using Stripe's Search Query Language

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "subscriptions",
  "action": "search",
  "params": {
    "query": "<str>"
  }
}'

Python SDK

await stripe.subscriptions.search(
    query="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "subscriptions",
    "action": "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.

Response Schema

Records

Field Name	Type	Description
object	"search_result"
data	array<object>
data[].id	string
data[].object	"subscription"
data[].application	string | null
data[].application_fee_percent	number | null
data[].automatic_tax	object
data[].billing_cycle_anchor	integer
data[].billing_cycle_anchor_config	object | null
data[].billing_mode	object
data[].billing_thresholds	object | null
data[].cancel_at	integer | null
data[].cancel_at_period_end	boolean
data[].canceled_at	integer | null
data[].cancellation_details	object | null
data[].collection_method	"charge_automatically" | "send_invoice"
data[].created	integer
data[].currency	string
data[].customer	string
data[].customer_account	string | null
data[].days_until_due	integer | null
data[].default_payment_method	string | null
data[].default_source	string | null
data[].default_tax_rates	array | null
data[].description	string | null
data[].discounts	array<string>
data[].ended_at	integer | null
data[].invoice_settings	object
data[].items	object
data[].latest_invoice	string | null
data[].livemode	boolean
data[].metadata	object
data[].next_pending_invoice_item_invoice	integer | null
data[].on_behalf_of	string | null
data[].pause_collection	object | null
data[].payment_settings	object | null
data[].status	"incomplete" | "incomplete_expired" | "trialing" | "active" | "past_due" | "canceled" | "unpaid" | "paused"
data[].current_period_start	integer
data[].current_period_end	integer
data[].start_date	integer
data[].trial_start	integer | null
data[].trial_end	integer | null
data[].discount	object | null
data[].plan	object | null
data[].quantity	integer | null
data[].schedule	string | null
data[].test_clock	string | null
data[].transfer_data	object | null
data[].trial_settings	object | null
data[].pending_invoice_item_interval	object | null
data[].pending_setup_intent	string | null
data[].pending_update	object | null
has_more	boolean
next_page	string | null
url	string

Subscriptions Context Store Search

Search and filter subscriptions 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.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "subscriptions",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "application": "<str>"
        }
      }
    }
  }
}'

Python SDK

await stripe.subscriptions.context_store_search(
    query={"filter": {"eq": {"application": "<str>"}}}
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "subscriptions",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"application": "<str>"}}}
    }
}'

Parameters

Parameter Name	Type	Required	Description
query	object	Yes	Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, startswith, endswith, contains, array_contains, 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 meta.cursor
fields	array	No	Field paths to include in results

Searchable Fields

Field Name	Type	Description
application	string	For Connect platforms, the application associated with the subscription.
application_fee_percent	number	For Connect platforms, the percentage of the subscription amount taken as an application fee.
automatic_tax	object	Automatic tax calculation settings for the subscription.
billing	string	Billing mode configuration for the subscription.
billing_cycle_anchor	number	Timestamp determining when the billing cycle for the subscription starts.
billing_cycle_anchor_config	object	Configuration for the subscription's billing cycle anchor behavior.
billing_thresholds	object	Defines thresholds at which an invoice will be sent, controlling billing timing based on usage.
cancel_at	number	Timestamp indicating when the subscription is scheduled to be canceled.
cancel_at_period_end	boolean	Boolean indicating whether the subscription will be canceled at the end of the current billing period.
canceled_at	number	Timestamp indicating when the subscription was canceled, if applicable.
cancellation_details	object	Details about why and how the subscription was canceled.
collection_method	string	How invoices are collected (charge_automatically or send_invoice).
created	integer	Timestamp indicating when the subscription was created.
currency	string	Three-letter ISO currency code in lowercase indicating the currency for the subscription.
current_period_end	number	Timestamp marking the end of the current billing period.
current_period_start	integer	Timestamp marking the start of the current billing period.
customer	string	ID of the customer who owns the subscription, expandable to full customer object.
days_until_due	integer	Number of days until the invoice is due for subscriptions using send_invoice collection method.
default_payment_method	string	ID of the default payment method for the subscription, taking precedence over default_source.
default_source	string	ID of the default payment source for the subscription.
default_tax_rates	array	Tax rates that apply to the subscription by default.
description	string	Human-readable description of the subscription, displayable to the customer.
discount	object	Describes any discount currently applied to the subscription.
ended_at	number	Timestamp indicating when the subscription ended, if applicable.
id	string	Unique identifier for the subscription object.
invoice_settings	object	Settings for invoices generated by this subscription, such as custom fields and footer.
is_deleted	boolean	Indicates whether the subscription has been deleted.
items	object	List of subscription items, each with an attached price defining what the customer is subscribed to.
latest_invoice	string	The most recent invoice this subscription has generated, expandable to full invoice object.
livemode	boolean	Indicates whether the subscription exists in live mode (true) or test mode (false).
metadata	object	Set of key-value pairs that you can attach to the subscription for storing additional structured information.
next_pending_invoice_item_invoice	integer	Timestamp when the next invoice for pending invoice items will be created.
object	string	String representing the object type, always 'subscription'.
on_behalf_of	string	For Connect platforms, the account for which the subscription is being created or managed.
pause_collection	object	Configuration for pausing collection on the subscription while retaining the subscription structure.
payment_settings	object	Payment settings for invoices generated by this subscription.
pending_invoice_item_interval	object	Specifies an interval for aggregating usage records into pending invoice items.
pending_setup_intent	string	SetupIntent used for collecting user authentication when updating payment methods without immediate payment.
pending_update	object	If specified, pending updates that will be applied to the subscription once the latest_invoice has been paid.
plan	object	The plan associated with the subscription (deprecated, use items instead).
quantity	integer	Quantity of the plan subscribed to (deprecated, use items instead).
schedule	string	ID of the subscription schedule managing this subscription's lifecycle, if applicable.
start_date	integer	Timestamp indicating when the subscription started.
status	string	Current status of the subscription (incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, or paused).
tax_percent	number	The percentage of tax applied to the subscription (deprecated, use default_tax_rates instead).
test_clock	string	ID of the test clock associated with this subscription for simulating time-based scenarios.
transfer_data	object	For Connect platforms, the account receiving funds from the subscription and optional percentage transferred.
trial_end	number	Timestamp indicating when the trial period ends, if applicable.
trial_settings	object	Settings related to trial periods, including conditions for ending trials.
trial_start	integer	Timestamp indicating when the trial period began, if applicable.
updated	integer	Timestamp indicating when the subscription was last updated.

Response Schema

Field Name	Type	Description
data	array	List of matching records
meta	object	Pagination metadata
meta.has_more	boolean	Whether additional pages are available
meta.cursor	string | null	Cursor for next page of results
meta.took_ms	number | null	Query execution time in milliseconds
data[].application	string	For Connect platforms, the application associated with the subscription.
data[].application_fee_percent	number	For Connect platforms, the percentage of the subscription amount taken as an application fee.
data[].automatic_tax	object	Automatic tax calculation settings for the subscription.
data[].billing	string	Billing mode configuration for the subscription.
data[].billing_cycle_anchor	number	Timestamp determining when the billing cycle for the subscription starts.
data[].billing_cycle_anchor_config	object	Configuration for the subscription's billing cycle anchor behavior.
data[].billing_thresholds	object	Defines thresholds at which an invoice will be sent, controlling billing timing based on usage.
data[].cancel_at	number	Timestamp indicating when the subscription is scheduled to be canceled.
data[].cancel_at_period_end	boolean	Boolean indicating whether the subscription will be canceled at the end of the current billing period.
data[].canceled_at	number	Timestamp indicating when the subscription was canceled, if applicable.
data[].cancellation_details	object	Details about why and how the subscription was canceled.
data[].collection_method	string	How invoices are collected (charge_automatically or send_invoice).
data[].created	integer	Timestamp indicating when the subscription was created.
data[].currency	string	Three-letter ISO currency code in lowercase indicating the currency for the subscription.
data[].current_period_end	number	Timestamp marking the end of the current billing period.
data[].current_period_start	integer	Timestamp marking the start of the current billing period.
data[].customer	string	ID of the customer who owns the subscription, expandable to full customer object.
data[].days_until_due	integer	Number of days until the invoice is due for subscriptions using send_invoice collection method.
data[].default_payment_method	string	ID of the default payment method for the subscription, taking precedence over default_source.
data[].default_source	string	ID of the default payment source for the subscription.
data[].default_tax_rates	array	Tax rates that apply to the subscription by default.
data[].description	string	Human-readable description of the subscription, displayable to the customer.
data[].discount	object	Describes any discount currently applied to the subscription.
data[].ended_at	number	Timestamp indicating when the subscription ended, if applicable.
data[].id	string	Unique identifier for the subscription object.
data[].invoice_settings	object	Settings for invoices generated by this subscription, such as custom fields and footer.
data[].is_deleted	boolean	Indicates whether the subscription has been deleted.
data[].items	object	List of subscription items, each with an attached price defining what the customer is subscribed to.
data[].latest_invoice	string	The most recent invoice this subscription has generated, expandable to full invoice object.
data[].livemode	boolean	Indicates whether the subscription exists in live mode (true) or test mode (false).
data[].metadata	object	Set of key-value pairs that you can attach to the subscription for storing additional structured information.
data[].next_pending_invoice_item_invoice	integer	Timestamp when the next invoice for pending invoice items will be created.
data[].object	string	String representing the object type, always 'subscription'.
data[].on_behalf_of	string	For Connect platforms, the account for which the subscription is being created or managed.
data[].pause_collection	object	Configuration for pausing collection on the subscription while retaining the subscription structure.
data[].payment_settings	object	Payment settings for invoices generated by this subscription.
data[].pending_invoice_item_interval	object	Specifies an interval for aggregating usage records into pending invoice items.
data[].pending_setup_intent	string	SetupIntent used for collecting user authentication when updating payment methods without immediate payment.
data[].pending_update	object	If specified, pending updates that will be applied to the subscription once the latest_invoice has been paid.
data[].plan	object	The plan associated with the subscription (deprecated, use items instead).
data[].quantity	integer	Quantity of the plan subscribed to (deprecated, use items instead).
data[].schedule	string	ID of the subscription schedule managing this subscription's lifecycle, if applicable.
data[].start_date	integer	Timestamp indicating when the subscription started.
data[].status	string	Current status of the subscription (incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, or paused).
data[].tax_percent	number	The percentage of tax applied to the subscription (deprecated, use default_tax_rates instead).
data[].test_clock	string	ID of the test clock associated with this subscription for simulating time-based scenarios.
data[].transfer_data	object	For Connect platforms, the account receiving funds from the subscription and optional percentage transferred.
data[].trial_end	number	Timestamp indicating when the trial period ends, if applicable.
data[].trial_settings	object	Settings related to trial periods, including conditions for ending trials.
data[].trial_start	integer	Timestamp indicating when the trial period began, if applicable.
data[].updated	integer	Timestamp indicating when the subscription was last updated.

Subscriptions Context Store SQL Query

Run a SQL query against subscriptions records in the Airbyte Context Store. SQL projections may return any set of columns, so each result row is a dictionary matching the query's selected fields. Only available in hosted mode.

Use the hosted server documentation to find the qualified Context Store table name and SQL guidance.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "subscriptions",
  "action": "context_store_sql_query",
  "params": {
    "sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
  }
}'

Python SDK

await stripe.subscriptions.context_store_sql_query(
    sql="SELECT * FROM <qualified_context_store_table> LIMIT 100"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "subscriptions",
    "action": "context_store_sql_query",
    "params": {
        "sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
    }
}'

Parameters

Parameter Name	Type	Required	Description
sql	string	Yes	SQL query to execute against this entity's Context Store data
limit	integer	No	Maximum results to return

Response Schema

Field Name	Type	Description
data	array	Projected rows, with dictionary keys matching the selected columns
meta	object	Query metadata
meta.has_more	boolean	Whether the result was limited and more rows are available
meta.cursor	null	SQL query results do not use cursor pagination
meta.took_ms	number | null	Query execution time in milliseconds

Refunds

Refunds List

Returns a list of all refunds you've previously created. The refunds are returned in sorted order, with the most recent refunds appearing first.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "refunds",
  "action": "list"
}'

Python SDK

await stripe.refunds.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "refunds",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
charge	string	No	Only return refunds for the charge specified by this charge ID
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)
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.
payment_intent	string	No	Only return refunds for the PaymentIntent specified by this ID
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.

Response Schema

Records

Field Name	Type	Description
id	string
object	"refund"
amount	integer
balance_transaction	string | null
charge	string | null
created	integer
currency	string
description	string | null
destination_details	object | null
failure_balance_transaction	string | null
failure_reason	string | null
instructions_email	string | null
metadata	object | null
next_action	object | null
payment_intent	string | null
pending_reason	string | null
reason	string | null
receipt_number	string | null
source_transfer_reversal	string | null
status	string | null
transfer_reversal	string | null

Meta

Field Name	Type	Description
has_more	boolean

Refunds Create

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it. Creating a new refund will refund a charge that has previously been created but not yet refunded.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "refunds",
  "action": "create"
}'

Python SDK

await stripe.refunds.create()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "refunds",
    "action": "create"
}'

Response Schema

Records

Field Name	Type	Description
id	string
object	"refund"
amount	integer
balance_transaction	string | null
charge	string | null
created	integer
currency	string
description	string | null
destination_details	object | null
failure_balance_transaction	string | null
failure_reason	string | null
instructions_email	string | null
metadata	object | null
next_action	object | null
payment_intent	string | null
pending_reason	string | null
reason	string | null
receipt_number	string | null
source_transfer_reversal	string | null
status	string | null
transfer_reversal	string | null

Refunds Get

Retrieves the details of an existing refund

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "refunds",
  "action": "get",
  "params": {
    "id": "<str>"
  }
}'

Python SDK

await stripe.refunds.get(
    id="<str>"
)

API

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

Parameters

Parameter Name	Type	Required	Description
id	string	Yes	The refund ID

Response Schema

Records

Field Name	Type	Description
id	string
object	"refund"
amount	integer
balance_transaction	string | null
charge	string | null
created	integer
currency	string
description	string | null
destination_details	object | null
failure_balance_transaction	string | null
failure_reason	string | null
instructions_email	string | null
metadata	object | null
next_action	object | null
payment_intent	string | null
pending_reason	string | null
reason	string | null
receipt_number	string | null
source_transfer_reversal	string | null
status	string | null
transfer_reversal	string | null

Refunds Context Store Search

Search and filter refunds 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.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "refunds",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "amount": 0
        }
      }
    }
  }
}'

Python SDK

await stripe.refunds.context_store_search(
    query={"filter": {"eq": {"amount": 0}}}
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "refunds",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"amount": 0}}}
    }
}'

Parameters

Parameter Name	Type	Required	Description
query	object	Yes	Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, startswith, endswith, contains, array_contains, 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 meta.cursor
fields	array	No	Field paths to include in results

Searchable Fields

Field Name	Type	Description
amount	integer	Amount refunded, in cents (the smallest currency unit).
balance_transaction	string	ID of the balance transaction that describes the impact of this refund on your account balance.
charge	string	ID of the charge that was refunded.
created	integer	Timestamp indicating when the refund was created.
currency	string	Three-letter ISO currency code in lowercase representing the currency of the refund.
destination_details	object	Details about the destination where the refunded funds should be sent.
id	string	Unique identifier for the refund object.
metadata	object	Set of key-value pairs that you can attach to an object for storing additional structured information.
object	string	String representing the object type, always 'refund'.
payment_intent	string	ID of the PaymentIntent that was refunded.
reason	string	Reason for the refund, either user-provided (duplicate, fraudulent, or requested_by_customer) or generated by Stripe internally (expired_uncaptured_charge).
receipt_number	string	The transaction number that appears on email receipts sent for this refund.
source_transfer_reversal	string	ID of the transfer reversal that was created as a result of refunding a transfer (Connect only).
status	string	Status of the refund (pending, requires_action, succeeded, failed, or canceled).
transfer_reversal	string	ID of the reversal of the transfer that funded the charge being refunded (Connect only).
updated	integer	Timestamp indicating when the refund was last updated.

Response Schema

Field Name	Type	Description
data	array	List of matching records
meta	object	Pagination metadata
meta.has_more	boolean	Whether additional pages are available
meta.cursor	string | null	Cursor for next page of results
meta.took_ms	number | null	Query execution time in milliseconds
data[].amount	integer	Amount refunded, in cents (the smallest currency unit).
data[].balance_transaction	string	ID of the balance transaction that describes the impact of this refund on your account balance.
data[].charge	string	ID of the charge that was refunded.
data[].created	integer	Timestamp indicating when the refund was created.
data[].currency	string	Three-letter ISO currency code in lowercase representing the currency of the refund.
data[].destination_details	object	Details about the destination where the refunded funds should be sent.
data[].id	string	Unique identifier for the refund object.
data[].metadata	object	Set of key-value pairs that you can attach to an object for storing additional structured information.
data[].object	string	String representing the object type, always 'refund'.
data[].payment_intent	string	ID of the PaymentIntent that was refunded.
data[].reason	string	Reason for the refund, either user-provided (duplicate, fraudulent, or requested_by_customer) or generated by Stripe internally (expired_uncaptured_charge).
data[].receipt_number	string	The transaction number that appears on email receipts sent for this refund.
data[].source_transfer_reversal	string	ID of the transfer reversal that was created as a result of refunding a transfer (Connect only).
data[].status	string	Status of the refund (pending, requires_action, succeeded, failed, or canceled).
data[].transfer_reversal	string	ID of the reversal of the transfer that funded the charge being refunded (Connect only).
data[].updated	integer	Timestamp indicating when the refund was last updated.

Refunds Context Store SQL Query

Run a SQL query against refunds records in the Airbyte Context Store. SQL projections may return any set of columns, so each result row is a dictionary matching the query's selected fields. Only available in hosted mode.

Use the hosted server documentation to find the qualified Context Store table name and SQL guidance.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "refunds",
  "action": "context_store_sql_query",
  "params": {
    "sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
  }
}'

Python SDK

await stripe.refunds.context_store_sql_query(
    sql="SELECT * FROM <qualified_context_store_table> LIMIT 100"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "refunds",
    "action": "context_store_sql_query",
    "params": {
        "sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
    }
}'

Parameters

Parameter Name	Type	Required	Description
sql	string	Yes	SQL query to execute against this entity's Context Store data
limit	integer	No	Maximum results to return

Response Schema

Field Name	Type	Description
data	array	Projected rows, with dictionary keys matching the selected columns
meta	object	Query metadata
meta.has_more	boolean	Whether the result was limited and more rows are available
meta.cursor	null	SQL query results do not use cursor pagination
meta.took_ms	number | null	Query execution time in milliseconds

Products

Products List

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

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "products",
  "action": "list"
}'

Python SDK

await stripe.products.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "products",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
active	boolean	No	Only return products that are active or inactive
created	object	No	Only return products 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)
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.
ids	array<string>	No	Only return products with the given IDs
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.
shippable	boolean	No	Only return products that can be shipped
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.
url	string	No	Only return products with the given url

Response Schema

Records

Field Name	Type	Description
id	string
object	"product"
active	boolean
attributes	array<string>
created	integer
default_price	string | null
description	string | null
features	array<object>
images	array<string>
livemode	boolean
marketing_features	array<object>
metadata	object
name	string
package_dimensions	object | null
shippable	boolean | null
statement_descriptor	string | null
tax_code	string | null
type	"good" | "service"
unit_label	string | null
updated	integer
url	string | null

Meta

Field Name	Type	Description
has_more	boolean

Products Create

Creates a new product object. Your product's name, description, and other information will be displayed in all product and invoice displays.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "products",
  "action": "create"
}'

Python SDK

await stripe.products.create()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "products",
    "action": "create"
}'

Response Schema

Records

Field Name	Type	Description
id	string
object	"product"
active	boolean
attributes	array<string>
created	integer
default_price	string | null
description	string | null
features	array<object>
images	array<string>
livemode	boolean
marketing_features	array<object>
metadata	object
name	string
package_dimensions	object | null
shippable	boolean | null
statement_descriptor	string | null
tax_code	string | null
type	"good" | "service"
unit_label	string | null
updated	integer
url	string | null

Products Get

Retrieves the details of an existing product. Supply the unique product ID and Stripe will return the corresponding product information.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "products",
  "action": "get",
  "params": {
    "id": "<str>"
  }
}'

Python SDK

await stripe.products.get(
    id="<str>"
)

API

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

Parameters

Parameter Name	Type	Required	Description
id	string	Yes	The product ID

Response Schema

Records

Field Name	Type	Description
id	string
object	"product"
active	boolean
attributes	array<string>
created	integer
default_price	string | null
description	string | null
features	array<object>
images	array<string>
livemode	boolean
marketing_features	array<object>
metadata	object
name	string
package_dimensions	object | null
shippable	boolean | null
statement_descriptor	string | null
tax_code	string | null
type	"good" | "service"
unit_label	string | null
updated	integer
url	string | null

Products Update

Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "products",
  "action": "update",
  "params": {
    "id": "<str>"
  }
}'

Python SDK

await stripe.products.update(
    id="<str>"
)

API

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

Parameters

Parameter Name	Type	Required	Description
id	string	Yes	The product ID

Response Schema

Records

Field Name	Type	Description
id	string
object	"product"
active	boolean
attributes	array<string>
created	integer
default_price	string | null
description	string | null
features	array<object>
images	array<string>
livemode	boolean
marketing_features	array<object>
metadata	object
name	string
package_dimensions	object | null
shippable	boolean | null
statement_descriptor	string | null
tax_code	string | null
type	"good" | "service"
unit_label	string | null
updated	integer
url	string | null

Products Delete

Deletes a product. Deleting a product is only possible if it has no prices associated with it.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "products",
  "action": "delete",
  "params": {
    "id": "<str>"
  }
}'

Python SDK

await stripe.products.delete(
    id="<str>"
)

API

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

Parameters

Parameter Name	Type	Required	Description
id	string	Yes	The product ID

Response Schema

Records

Field Name	Type	Description
id	string
object	"product"
deleted	boolean

Products Search

Search for products using Stripe's Search Query Language.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "products",
  "action": "search",
  "params": {
    "query": "<str>"
  }
}'

Python SDK

await stripe.products.search(
    query="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "products",
    "action": "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.

Response Schema

Records

Field Name	Type	Description
id	string
object	"product"
active	boolean
attributes	array<string>
created	integer
default_price	string | null
description	string | null
features	array<object>
images	array<string>
livemode	boolean
marketing_features	array<object>
metadata	object
name	string
package_dimensions	object | null
shippable	boolean | null
statement_descriptor	string | null
tax_code	string | null
type	"good" | "service"
unit_label	string | null
updated	integer
url	string | null

Meta

Field Name	Type	Description
has_more	boolean

Balance

Balance Get

Retrieves the current account balance, based on the authentication that was used to make the request.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "balance",
  "action": "get"
}'

Python SDK

await stripe.balance.get()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "balance",
    "action": "get"
}'

Response Schema

Records

Field Name	Type	Description
object	"balance"
livemode	boolean
available	array<object>
connect_reserved	array | null
instant_available	array | null
issuing	object | null
pending	array<object>
refund_and_dispute_prefunding	object | null

Balance Transactions

Balance Transactions List

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "balance_transactions",
  "action": "list"
}'

Python SDK

await stripe.balance_transactions.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "balance_transactions",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
created	object	No	Only return transactions 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)
currency	string	No	Only return transactions in a certain currency. Three-letter ISO currency code, in lowercase.
ending_before	string	No	A cursor for use in pagination. ending_before is an object ID that defines your place in 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.
payout	string	No	For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.
source	string	No	Only returns the original transaction.
starting_after	string	No	A cursor for use in pagination. starting_after is an object ID that defines your place in the list.
type	string	No	Only returns transactions of the given type.

Response Schema

Records

Field Name	Type	Description
id	string
object	"balance_transaction"
amount	integer
available_on	integer
balance_type	"issuing" | "payments" | "refund_and_dispute_prefunding"
created	integer
currency	string
description	string | null
exchange_rate	number | null
fee	integer
fee_details	array<object>
net	integer
reporting_category	string
source	string | null
status	"available" | "pending"
type	string

Meta

Field Name	Type	Description
has_more	boolean

Balance Transactions Get

Retrieves the balance transaction with the given ID.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "balance_transactions",
  "action": "get",
  "params": {
    "id": "<str>"
  }
}'

Python SDK

await stripe.balance_transactions.get(
    id="<str>"
)

API

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

Parameters

Parameter Name	Type	Required	Description
id	string	Yes	The ID of the desired balance transaction

Response Schema

Records

Field Name	Type	Description
id	string
object	"balance_transaction"
amount	integer
available_on	integer
balance_type	"issuing" | "payments" | "refund_and_dispute_prefunding"
created	integer
currency	string
description	string | null
exchange_rate	number | null
fee	integer
fee_details	array<object>
net	integer
reporting_category	string
source	string | null
status	"available" | "pending"
type	string

Payment Intents

Payment Intents List

Returns a list of PaymentIntents. The payment intents are returned sorted by creation date, with the most recent payment intents appearing first.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "payment_intents",
  "action": "list"
}'

Python SDK

await stripe.payment_intents.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "payment_intents",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
created	object	No	Only return payment intents 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 payment intents for the customer specified by this customer ID
customer_account	string	No	Only return payment intents 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.
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.

Response Schema

Records

Field Name	Type	Description
id	string
object	"payment_intent"
amount	integer
amount_capturable	integer
amount_received	integer
application	string | null
application_fee_amount	integer | null
capture_method	"automatic" | "automatic_async" | "manual"
client_secret	string | null
confirmation_method	"automatic" | "manual"
created	integer
currency	string
customer	string | null
description	string | null
livemode	boolean
metadata	object
payment_method	string | null
payment_method_types	array<string>
status	string

Meta

Field Name	Type	Description
has_more	boolean

Payment Intents Create

Creates a PaymentIntent object. After the PaymentIntent is created, attach a payment method and confirm to continue the payment.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "payment_intents",
  "action": "create"
}'

Python SDK

await stripe.payment_intents.create()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "payment_intents",
    "action": "create"
}'

Response Schema

Records

Field Name	Type	Description
id	string
object	"payment_intent"
amount	integer
amount_capturable	integer
amount_received	integer
application	string | null
application_fee_amount	integer | null
capture_method	"automatic" | "automatic_async" | "manual"
client_secret	string | null
confirmation_method	"automatic" | "manual"
created	integer
currency	string
customer	string | null
description	string | null
livemode	boolean
metadata	object
payment_method	string | null
payment_method_types	array<string>
status	string

Payment Intents Get

Retrieves the details of a PaymentIntent that has previously been created.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "payment_intents",
  "action": "get",
  "params": {
    "id": "<str>"
  }
}'

Python SDK

await stripe.payment_intents.get(
    id="<str>"
)

API

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

Parameters

Parameter Name	Type	Required	Description
id	string	Yes	The ID of the payment intent

Response Schema

Records

Field Name	Type	Description
id	string
object	"payment_intent"
amount	integer
amount_capturable	integer
amount_received	integer
application	string | null
application_fee_amount	integer | null
capture_method	"automatic" | "automatic_async" | "manual"
client_secret	string | null
confirmation_method	"automatic" | "manual"
created	integer
currency	string
customer	string | null
description	string | null
livemode	boolean
metadata	object
payment_method	string | null
payment_method_types	array<string>
status	string

Payment Intents Update

Updates properties on a PaymentIntent object without confirming.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "payment_intents",
  "action": "update",
  "params": {
    "id": "<str>"
  }
}'

Python SDK

await stripe.payment_intents.update(
    id="<str>"
)

API

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

Parameters

Parameter Name	Type	Required	Description
id	string	Yes	The ID of the payment intent to update

Response Schema

Records

Field Name	Type	Description
id	string
object	"payment_intent"
amount	integer
amount_capturable	integer
amount_received	integer
application	string | null
application_fee_amount	integer | null
capture_method	"automatic" | "automatic_async" | "manual"
client_secret	string | null
confirmation_method	"automatic" | "manual"
created	integer
currency	string
customer	string | null
description	string | null
livemode	boolean
metadata	object
payment_method	string | null
payment_method_types	array<string>
status	string

Payment Intents Search

Search for payment intents using Stripe's Search Query Language.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "payment_intents",
  "action": "search",
  "params": {
    "query": "<str>"
  }
}'

Python SDK

await stripe.payment_intents.search(
    query="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "payment_intents",
    "action": "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.

Response Schema

Records

Field Name	Type	Description
id	string
object	"payment_intent"
amount	integer
amount_capturable	integer
amount_received	integer
application	string | null
application_fee_amount	integer | null
capture_method	"automatic" | "automatic_async" | "manual"
client_secret	string | null
confirmation_method	"automatic" | "manual"
created	integer
currency	string
customer	string | null
description	string | null
livemode	boolean
metadata	object
payment_method	string | null
payment_method_types	array<string>
status	string

Meta

Field Name	Type	Description
has_more	boolean

Payment Intent Confirmations

Payment Intent Confirmations Create

Confirm that your customer intends to pay with current or provided payment method. Upon confirmation, the PaymentIntent will attempt to initiate a payment.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "payment_intent_confirmations",
  "action": "create",
  "params": {
    "id": "<str>"
  }
}'

Python SDK

await stripe.payment_intent_confirmations.create(
    id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "payment_intent_confirmations",
    "action": "create",
    "params": {
        "id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
id	string	Yes	The ID of the payment intent to confirm

Response Schema

Records

Field Name	Type	Description
id	string
object	"payment_intent"
amount	integer
amount_capturable	integer
amount_received	integer
application	string | null
application_fee_amount	integer | null
capture_method	"automatic" | "automatic_async" | "manual"
client_secret	string | null
confirmation_method	"automatic" | "manual"
created	integer
currency	string
customer	string | null
description	string | null
livemode	boolean
metadata	object
payment_method	string | null
payment_method_types	array<string>
status	string

Payment Intent Cancellations

Payment Intent Cancellations Create

You can cancel a PaymentIntent object when it's in one of these statuses - requires_payment_method, requires_capture, requires_confirmation, requires_action, or processing.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "payment_intent_cancellations",
  "action": "create",
  "params": {
    "id": "<str>"
  }
}'

Python SDK

await stripe.payment_intent_cancellations.create(
    id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "payment_intent_cancellations",
    "action": "create",
    "params": {
        "id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
id	string	Yes	The ID of the payment intent to cancel

Response Schema

Records

Field Name	Type	Description
id	string
object	"payment_intent"
amount	integer
amount_capturable	integer
amount_received	integer
application	string | null
application_fee_amount	integer | null
capture_method	"automatic" | "automatic_async" | "manual"
client_secret	string | null
confirmation_method	"automatic" | "manual"
created	integer
currency	string
customer	string | null
description	string | null
livemode	boolean
metadata	object
payment_method	string | null
payment_method_types	array<string>
status	string

Prices

Prices Create

Creates a new price for an existing product. The price can be recurring for use in subscriptions or one-time for use in one-off charges.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "prices",
  "action": "create"
}'

Python SDK

await stripe.prices.create()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "prices",
    "action": "create"
}'

Response Schema

Records

Field Name	Type	Description
id	string
object	"price"
active	boolean
billing_scheme	string | null
created	integer
currency	string
livemode	boolean
lookup_key	string | null
metadata	object
nickname	string | null
product	string
recurring	object | null
tax_behavior	string | null
tiers_mode	string | null
transform_quantity	object | null
type	"one_time" | "recurring"
unit_amount	integer | null
unit_amount_decimal	string | null

Checkout Sessions

Checkout Sessions Create

Creates a Checkout Session object. You can use it to create a payment page hosted on Stripe that customers can use to complete their purchase.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "checkout_sessions",
  "action": "create"
}'

Python SDK

await stripe.checkout_sessions.create()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "checkout_sessions",
    "action": "create"
}'

Response Schema

Records

Field Name	Type	Description
id	string
object	"checkout.session"
cancel_url	string | null
client_reference_id	string | null
created	integer
currency	string | null
customer	string | null
customer_email	string | null
livemode	boolean
metadata	object
mode	"payment" | "setup" | "subscription"
payment_intent	string | null
payment_status	"no_payment_required" | "paid" | "unpaid"
status	string | null
success_url	string | null
url	string | null

Payment Method Attachments

Payment Method Attachments Create

Attaches a PaymentMethod object to a Customer. To use this PaymentMethod as the default for invoice or subscription payments, set invoice_settings.default_payment_method on the Customer.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "payment_method_attachments",
  "action": "create",
  "params": {
    "id": "<str>"
  }
}'

Python SDK

await stripe.payment_method_attachments.create(
    id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "payment_method_attachments",
    "action": "create",
    "params": {
        "id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
id	string	Yes	The ID of the payment method to attach

Response Schema

Records

Field Name	Type	Description
id	string
object	"payment_method"
billing_details	object | null
created	integer
customer	string | null
livemode	boolean
metadata	object
type	string
card	object | null

Disputes

Disputes List

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

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "disputes",
  "action": "list"
}'

Python SDK

await stripe.disputes.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "disputes",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
charge	string	No	Only return disputes associated to the charge specified by this charge ID
created	object	No	Only return disputes 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)
ending_before	string	No	A cursor for use in pagination. ending_before is an object ID that defines your place in 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.
payment_intent	string	No	Only return disputes associated to the PaymentIntent specified by this PaymentIntent ID
starting_after	string	No	A cursor for use in pagination. starting_after is an object ID that defines your place in the list.

Response Schema

Records

Field Name	Type	Description
id	string
object	"dispute"
amount	integer
balance_transactions	array<object>
charge	string
created	integer
currency	string
enhanced_eligibility_types	array<string>
evidence	object
evidence_details	object
is_charge_refundable	boolean
livemode	boolean
metadata	object
payment_intent	string | null
payment_method_details	object | null
reason	string
status	string

Meta

Field Name	Type	Description
has_more	boolean

Disputes Get

Retrieves the dispute with the given ID.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "disputes",
  "action": "get",
  "params": {
    "id": "<str>"
  }
}'

Python SDK

await stripe.disputes.get(
    id="<str>"
)

API

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

Parameters

Parameter Name	Type	Required	Description
id	string	Yes	The ID of the dispute

Response Schema

Records

Field Name	Type	Description
id	string
object	"dispute"
amount	integer
balance_transactions	array<object>
charge	string
created	integer
currency	string
enhanced_eligibility_types	array<string>
evidence	object
evidence_details	object
is_charge_refundable	boolean
livemode	boolean
metadata	object
payment_intent	string | null
payment_method_details	object | null
reason	string
status	string

Payouts

Payouts List

Returns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you. The payouts return in sorted order, with the most recently created payouts appearing first.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "payouts",
  "action": "list"
}'

Python SDK

await stripe.payouts.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "payouts",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
arrival_date	object	No	Filter payouts by expected arrival date range.
arrival_date.gt	integer	No	Minimum value to filter by (exclusive)
arrival_date.gte	integer	No	Minimum value to filter by (inclusive)
arrival_date.lt	integer	No	Maximum value to filter by (exclusive)
arrival_date.lte	integer	No	Maximum value to filter by (inclusive)
created	object	No	Only return payouts 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)
destination	string	No	The ID of the external account the payout was sent to.
ending_before	string	No	A cursor for use in pagination. ending_before is an object ID that defines your place in 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.
status	"pending" | "paid" | "failed" | "canceled"	No	Only return payouts that have the given status

Response Schema

Records

Field Name	Type	Description
id	string
object	"payout"
amount	integer
application_fee	string | null
application_fee_amount	integer | null
arrival_date	integer
automatic	boolean
balance_transaction	string | null
created	integer
currency	string
description	string | null
destination	string | null
failure_balance_transaction	string | null
failure_code	string | null
failure_message	string | null
livemode	boolean
metadata	object
method	"standard" | "instant"
original_payout	string | null
payout_method	string | null
reconciliation_status	string
reversed_by	string | null
source_balance	string | null
source_type	string
statement_descriptor	string | null
status	string
trace_id	object | null
type	string

Meta

Field Name	Type	Description
has_more	boolean

Payouts Get

Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list, and Stripe will return the corresponding payout information.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "stripe",
  "entity": "payouts",
  "action": "get",
  "params": {
    "id": "<str>"
  }
}'

Python SDK

await stripe.payouts.get(
    id="<str>"
)

API

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

Parameters

Parameter Name	Type	Required	Description
id	string	Yes	The ID of the payout

Response Schema

Records

Field Name	Type	Description
id	string
object	"payout"
amount	integer
application_fee	string | null
application_fee_amount	integer | null
arrival_date	integer
automatic	boolean
balance_transaction	string | null
created	integer
currency	string
description	string | null
destination	string | null
failure_balance_transaction	string | null
failure_code	string | null
failure_message	string | null
livemode	boolean
metadata	object
method	"standard" | "instant"
original_payout	string | null
payout_method	string | null
reconciliation_status	string
reversed_by	string | null
source_balance	string | null
source_type	string
statement_descriptor	string | null
status	string
trace_id	object | null
type	string