Module airbyte_agent_sdk.connectors.stripe.models

Pydantic models for stripe connector.

This module contains Pydantic models used for authentication configuration and response envelope types.

Classes

AirbyteSearchMeta(**data: Any) : Pagination metadata for search responses.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

cursor: str | None : Cursor for fetching the next page of results.

has_more: bool : Whether more results are available.

model_config : The type of the None singleton.

took_ms: int | None : Time taken to execute the search in milliseconds.

AirbyteSearchResult(**data: Any) : Result from Airbyte cache search operations with typed records.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel
• typing.Generic

Descendants

• airbyte_agent_sdk.connectors.stripe.models.AirbyteSearchResult[ChargesSearchData]
• airbyte_agent_sdk.connectors.stripe.models.AirbyteSearchResult[CustomersSearchData]
• airbyte_agent_sdk.connectors.stripe.models.AirbyteSearchResult[InvoicesSearchData]
• airbyte_agent_sdk.connectors.stripe.models.AirbyteSearchResult[RefundsSearchData]
• airbyte_agent_sdk.connectors.stripe.models.AirbyteSearchResult[SubscriptionsSearchData]

Class variables

data: list[~D] : List of matching records.

meta: airbyte_agent_sdk.connectors.stripe.models.AirbyteSearchMeta : Pagination metadata.

model_config : The type of the None singleton.

AirbyteSearchResult[ChargesSearchData](**data: Any) : Result from Airbyte cache search operations with typed records.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.AirbyteSearchResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

ChargesSearchResult(**data: Any) : Result from Airbyte cache search operations with typed records.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.AirbyteSearchResult
• pydantic.main.BaseModel
• typing.Generic

AirbyteSearchResult[CustomersSearchData](**data: Any) : Result from Airbyte cache search operations with typed records.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.AirbyteSearchResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

CustomersSearchResult(**data: Any) : Result from Airbyte cache search operations with typed records.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.AirbyteSearchResult
• pydantic.main.BaseModel
• typing.Generic

AirbyteSearchResult[InvoicesSearchData](**data: Any) : Result from Airbyte cache search operations with typed records.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.AirbyteSearchResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

InvoicesSearchResult(**data: Any) : Result from Airbyte cache search operations with typed records.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.AirbyteSearchResult
• pydantic.main.BaseModel
• typing.Generic

AirbyteSearchResult[RefundsSearchData](**data: Any) : Result from Airbyte cache search operations with typed records.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.AirbyteSearchResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

RefundsSearchResult(**data: Any) : Result from Airbyte cache search operations with typed records.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.AirbyteSearchResult
• pydantic.main.BaseModel
• typing.Generic

AirbyteSearchResult[SubscriptionsSearchData](**data: Any) : Result from Airbyte cache search operations with typed records.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.AirbyteSearchResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

SubscriptionsSearchResult(**data: Any) : Result from Airbyte cache search operations with typed records.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.AirbyteSearchResult
• pydantic.main.BaseModel
• typing.Generic

Balance(**data: Any) : Balance type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

available: list[airbyte_agent_sdk.connectors.stripe.models.BalanceAvailableItem] | None : The type of the None singleton.

connect_reserved: list[airbyte_agent_sdk.connectors.stripe.models.BalanceConnectReservedItem] | None : The type of the None singleton.

instant_available: list[airbyte_agent_sdk.connectors.stripe.models.BalanceInstantAvailableItem] | None : The type of the None singleton.

issuing: airbyte_agent_sdk.connectors.stripe.models.BalanceIssuing | None : The type of the None singleton.

livemode: bool | None : The type of the None singleton.

model_config : The type of the None singleton.

object_: str | None : The type of the None singleton.

pending: list[airbyte_agent_sdk.connectors.stripe.models.BalancePendingItem] | None : The type of the None singleton.

refund_and_dispute_prefunding: airbyte_agent_sdk.connectors.stripe.models.BalanceRefundAndDisputePrefunding | None : The type of the None singleton.

BalanceAvailableItem(**data: Any) : Nested schema for Balance.available_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount: int | None : Balance amount in the smallest currency unit (e.g., cents)

currency: str | None : Three-letter ISO currency code, in lowercase

model_config : The type of the None singleton.

source_types: airbyte_agent_sdk.connectors.stripe.models.BalanceAvailableItemSourceTypes | None : Breakdown of balance by source types

BalanceAvailableItemSourceTypes(**data: Any) : Breakdown of balance by source types

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

bank_account: int | None : Amount for bank_account

card: int | None : Amount for card

fpx: int | None : Amount for fpx

model_config : The type of the None singleton.

BalanceConnectReservedItem(**data: Any) : Nested schema for Balance.connect_reserved_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount: int | None : Balance amount in the smallest currency unit

currency: str | None : Three-letter ISO currency code, in lowercase

model_config : The type of the None singleton.

source_types: airbyte_agent_sdk.connectors.stripe.models.BalanceConnectReservedItemSourceTypes | None : Breakdown of balance by source types

BalanceConnectReservedItemSourceTypes(**data: Any) : Breakdown of balance by source types

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

bank_account: int | None : Amount for bank_account

card: int | None : Amount for card

fpx: int | None : Amount for fpx

model_config : The type of the None singleton.

BalanceInstantAvailableItem(**data: Any) : Nested schema for Balance.instant_available_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount: int | None : Balance amount in the smallest currency unit

currency: str | None : Three-letter ISO currency code, in lowercase

model_config : The type of the None singleton.

net_available: list[airbyte_agent_sdk.connectors.stripe.models.BalanceInstantAvailableItemNetAvailableItem] | None : Net balance amount available after deducting fees

source_types: airbyte_agent_sdk.connectors.stripe.models.BalanceInstantAvailableItemSourceTypes | None : Breakdown of balance by source types

BalanceInstantAvailableItemNetAvailableItem(**data: Any) : Nested schema for BalanceInstantAvailableItem.net_available_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount: int | None : Net balance amount

destination: str | None : ID of the external account

model_config : The type of the None singleton.

source_types: airbyte_agent_sdk.connectors.stripe.models.BalanceInstantAvailableItemNetAvailableItemSourceTypes | None : Breakdown of balance by source types

BalanceInstantAvailableItemNetAvailableItemSourceTypes(**data: Any) : Breakdown of balance by source types

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

bank_account: int | None : Amount for bank_account

card: int | None : Amount for card

fpx: int | None : Amount for fpx

model_config : The type of the None singleton.

BalanceInstantAvailableItemSourceTypes(**data: Any) : Breakdown of balance by source types

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

bank_account: int | None : Amount for bank_account

card: int | None : Amount for card

fpx: int | None : Amount for fpx

model_config : The type of the None singleton.

BalanceIssuing(**data: Any) : Funds that are available for use with Issuing cards

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

available: list[airbyte_agent_sdk.connectors.stripe.models.BalanceIssuingAvailableItem] | None : Funds available for issuing

model_config : The type of the None singleton.

BalanceIssuingAvailableItem(**data: Any) : Nested schema for BalanceIssuing.available_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount: int | None : Balance amount

currency: str | None : Three-letter ISO currency code

model_config : The type of the None singleton.

source_types: airbyte_agent_sdk.connectors.stripe.models.BalanceIssuingAvailableItemSourceTypes | None : Breakdown of balance by source types

BalanceIssuingAvailableItemSourceTypes(**data: Any) : Breakdown of balance by source types

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

bank_account: int | None : Amount for bank_account

card: int | None : Amount for card

fpx: int | None : Amount for fpx

model_config : The type of the None singleton.

BalancePendingItem(**data: Any) : Nested schema for Balance.pending_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount: int | None : Balance amount in the smallest currency unit

currency: str | None : Three-letter ISO currency code, in lowercase

model_config : The type of the None singleton.

source_types: airbyte_agent_sdk.connectors.stripe.models.BalancePendingItemSourceTypes | None : Breakdown of balance by source types

BalancePendingItemSourceTypes(**data: Any) : Breakdown of balance by source types

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

bank_account: int | None : Amount for bank_account

card: int | None : Amount for card

fpx: int | None : Amount for fpx

model_config : The type of the None singleton.

BalanceRefundAndDisputePrefunding(**data: Any) : Funds reserved for covering future refunds or disputes

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

available: list[airbyte_agent_sdk.connectors.stripe.models.BalanceRefundAndDisputePrefundingAvailableItem] | None : Available funds for refunds and disputes

model_config : The type of the None singleton.

pending: list[airbyte_agent_sdk.connectors.stripe.models.BalanceRefundAndDisputePrefundingPendingItem] | None : Pending funds for refunds and disputes

BalanceRefundAndDisputePrefundingAvailableItem(**data: Any) : Nested schema for BalanceRefundAndDisputePrefunding.available_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount: int | None : Balance amount

currency: str | None : Three-letter ISO currency code

model_config : The type of the None singleton.

source_types: airbyte_agent_sdk.connectors.stripe.models.BalanceRefundAndDisputePrefundingAvailableItemSourceTypes | None : Breakdown of balance by source types

BalanceRefundAndDisputePrefundingAvailableItemSourceTypes(**data: Any) : Breakdown of balance by source types

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

bank_account: int | None : Amount for bank_account

card: int | None : Amount for card

fpx: int | None : Amount for fpx

model_config : The type of the None singleton.

BalanceRefundAndDisputePrefundingPendingItem(**data: Any) : Nested schema for BalanceRefundAndDisputePrefunding.pending_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount: int | None : Balance amount

currency: str | None : Three-letter ISO currency code

model_config : The type of the None singleton.

source_types: airbyte_agent_sdk.connectors.stripe.models.BalanceRefundAndDisputePrefundingPendingItemSourceTypes | None : Breakdown of balance by source types

BalanceRefundAndDisputePrefundingPendingItemSourceTypes(**data: Any) : Breakdown of balance by source types

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

bank_account: int | None : Amount for bank_account

card: int | None : Amount for card

fpx: int | None : Amount for fpx

model_config : The type of the None singleton.

BalanceTransaction(**data: Any) : BalanceTransaction type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount: int | None : The type of the None singleton.

available_on: int | None : The type of the None singleton.

balance_type: str | None : The type of the None singleton.

created: int | None : The type of the None singleton.

currency: str | None : The type of the None singleton.

description: str | None : The type of the None singleton.

exchange_rate: float | None : The type of the None singleton.

fee: int | None : The type of the None singleton.

fee_details: list[airbyte_agent_sdk.connectors.stripe.models.BalanceTransactionFeeDetailsItem] | None : The type of the None singleton.

id: str | None : The type of the None singleton.

model_config : The type of the None singleton.

net: int | None : The type of the None singleton.

object_: str | None : The type of the None singleton.

reporting_category: str | None : The type of the None singleton.

source: str | None : The type of the None singleton.

status: str | None : The type of the None singleton.

type_: str | None : The type of the None singleton.

BalanceTransactionFeeDetailsItem(**data: Any) : Nested schema for BalanceTransaction.fee_details_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount: int | None : Amount of the fee, in cents

application: str | None : ID of the Connect application that earned the fee

currency: str | None : Three-letter ISO currency code, in lowercase

description: str | None : An arbitrary string attached to the object

model_config : The type of the None singleton.

type_: str | None : Type of the fee

BalanceTransactionList(**data: Any) : BalanceTransactionList type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

data: list[airbyte_agent_sdk.connectors.stripe.models.BalanceTransaction] | None : The type of the None singleton.

has_more: bool | None : The type of the None singleton.

model_config : The type of the None singleton.

object_: str | None : The type of the None singleton.

url: str | None : The type of the None singleton.

BalanceTransactionsListResultMeta(**data: Any) : Metadata for balance_transactions.Action.LIST operation

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

has_more: bool | None : The type of the None singleton.

model_config : The type of the None singleton.

Charge(**data: Any) : Charge type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount: int | None : The type of the None singleton.

amount_captured: int | None : The type of the None singleton.

amount_refunded: int | None : The type of the None singleton.

amount_updates: list[dict[str, typing.Any]] | None : The type of the None singleton.

application: str | None : The type of the None singleton.

application_fee: str | None : The type of the None singleton.

application_fee_amount: int | None : The type of the None singleton.

balance_transaction: str | None : The type of the None singleton.

billing_details: airbyte_agent_sdk.connectors.stripe.models.ChargeBillingDetails | None : The type of the None singleton.

calculated_statement_descriptor: str | None : The type of the None singleton.

captured: bool | None : The type of the None singleton.

created: int | None : The type of the None singleton.

currency: str | None : The type of the None singleton.

customer: str | None : The type of the None singleton.

description: str | None : The type of the None singleton.

destination: str | None : The type of the None singleton.

dispute: str | None : The type of the None singleton.

disputed: bool | None : The type of the None singleton.

failure_balance_transaction: str | None : The type of the None singleton.

failure_code: str | None : The type of the None singleton.

failure_message: str | None : The type of the None singleton.

fraud_details: airbyte_agent_sdk.connectors.stripe.models.ChargeFraudDetails | None : The type of the None singleton.

id: str | None : The type of the None singleton.

invoice: str | None : The type of the None singleton.

livemode: bool | None : The type of the None singleton.

metadata: dict[str, str] | None : The type of the None singleton.

model_config : The type of the None singleton.

object_: str | None : The type of the None singleton.

on_behalf_of: str | None : The type of the None singleton.

order: str | None : The type of the None singleton.

outcome: airbyte_agent_sdk.connectors.stripe.models.ChargeOutcome | None : The type of the None singleton.

paid: bool | None : The type of the None singleton.

payment_intent: str | None : The type of the None singleton.

payment_method: str | None : The type of the None singleton.

payment_method_details: airbyte_agent_sdk.connectors.stripe.models.ChargePaymentMethodDetails | None : The type of the None singleton.

presentment_details: airbyte_agent_sdk.connectors.stripe.models.ChargePresentmentDetails | None : The type of the None singleton.

radar_options: dict[str, typing.Any] | None : The type of the None singleton.

receipt_email: str | None : The type of the None singleton.

receipt_number: str | None : The type of the None singleton.

receipt_url: str | None : The type of the None singleton.

refunded: bool | None : The type of the None singleton.

refunds: airbyte_agent_sdk.connectors.stripe.models.ChargeRefunds | None : The type of the None singleton.

review: str | None : The type of the None singleton.

shipping: dict[str, typing.Any] | None : The type of the None singleton.

source: dict[str, typing.Any] | None : The type of the None singleton.

source_transfer: str | None : The type of the None singleton.

statement_descriptor: str | None : The type of the None singleton.

statement_descriptor_suffix: str | None : The type of the None singleton.

status: str | None : The type of the None singleton.

transfer_data: dict[str, typing.Any] | None : The type of the None singleton.

transfer_group: str | None : The type of the None singleton.

ChargeBillingDetails(**data: Any) : Billing information associated with the payment method

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

address: airbyte_agent_sdk.connectors.stripe.models.ChargeBillingDetailsAddress | None : The type of the None singleton.

email: str | None : The type of the None singleton.

model_config : The type of the None singleton.

name: str | None : The type of the None singleton.

phone: str | None : The type of the None singleton.

tax_id: str | None : The type of the None singleton.

ChargeBillingDetailsAddress(**data: Any) : Nested schema for ChargeBillingDetails.address

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

city: str | None : The type of the None singleton.

country: str | None : The type of the None singleton.

line1: str | None : The type of the None singleton.

line2: str | None : The type of the None singleton.

model_config : The type of the None singleton.

postal_code: str | None : The type of the None singleton.

state: str | None : The type of the None singleton.

ChargeFraudDetails(**data: Any) : Information on fraud assessments for the charge

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

stripe_report: str | None : Assessments from Stripe. If set, the value is fraudulent.

user_report: str | None : Assessments from you or your users. Possible values are fraudulent and safe

ChargeList(**data: Any) : ChargeList type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

data: list[airbyte_agent_sdk.connectors.stripe.models.Charge] | None : The type of the None singleton.

has_more: bool | None : The type of the None singleton.

model_config : The type of the None singleton.

object_: str | None : The type of the None singleton.

url: str | None : The type of the None singleton.

ChargeOutcome(**data: Any) : Details about whether the payment was accepted, and why

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

advice_code: str | None : The type of the None singleton.

model_config : The type of the None singleton.

network_advice_code: str | None : The type of the None singleton.

network_decline_code: str | None : The type of the None singleton.

network_status: str | None : The type of the None singleton.

reason: str | None : The type of the None singleton.

risk_level: str | None : The type of the None singleton.

risk_score: int | None : The type of the None singleton.

seller_message: str | None : The type of the None singleton.

type_: str | None : The type of the None singleton.

ChargePaymentMethodDetails(**data: Any) : Details about the payment method at the time of the transaction

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

card: airbyte_agent_sdk.connectors.stripe.models.ChargePaymentMethodDetailsCard | None : The type of the None singleton.

model_config : The type of the None singleton.

type_: str | None : The type of the None singleton.

ChargePaymentMethodDetailsCard(**data: Any) : Nested schema for ChargePaymentMethodDetails.card

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount_authorized: int | None : Amount authorized on the card

authorization_code: str | None : Authorization code on the charge

brand: str | None : Card brand

checks: airbyte_agent_sdk.connectors.stripe.models.ChargePaymentMethodDetailsCardChecks | None : Check results by Card networks on Card address and CVC

country: str | None : Two-letter ISO code representing the country of the card

exp_month: int | None : Two-digit number representing the card's expiration month

exp_year: int | None : Four-digit number representing the card's expiration year

extended_authorization: airbyte_agent_sdk.connectors.stripe.models.ChargePaymentMethodDetailsCardExtendedAuthorization | None : Extended authorization details

fingerprint: str | None : Uniquely identifies this particular card number

funding: str | None : Card funding type

incremental_authorization: airbyte_agent_sdk.connectors.stripe.models.ChargePaymentMethodDetailsCardIncrementalAuthorization | None : Incremental authorization details

installments: dict[str, typing.Any] | None : Installment details

last4: str | None : The last four digits of the card

mandate: str | None : ID of the mandate used to make this payment

model_config : The type of the None singleton.

multicapture: airbyte_agent_sdk.connectors.stripe.models.ChargePaymentMethodDetailsCardMulticapture | None : Multicapture details

network: str | None : Card network

network_token: airbyte_agent_sdk.connectors.stripe.models.ChargePaymentMethodDetailsCardNetworkToken | None : Network token details

network_transaction_id: str | None : Network transaction identifier

overcapture: airbyte_agent_sdk.connectors.stripe.models.ChargePaymentMethodDetailsCardOvercapture | None : Overcapture details

regulated_status: str | None : Regulated status of the card

three_d_secure: dict[str, typing.Any] | None : 3D Secure details

wallet: dict[str, typing.Any] | None : Digital wallet details if used

ChargePaymentMethodDetailsCardChecks(**data: Any) : Check results by Card networks on Card address and CVC

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

address_line1_check: str | None : The type of the None singleton.

address_postal_code_check: str | None : The type of the None singleton.

cvc_check: str | None : The type of the None singleton.

model_config : The type of the None singleton.

ChargePaymentMethodDetailsCardExtendedAuthorization(**data: Any) : Extended authorization details

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

status: str | None : The type of the None singleton.

ChargePaymentMethodDetailsCardIncrementalAuthorization(**data: Any) : Incremental authorization details

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

status: str | None : The type of the None singleton.

ChargePaymentMethodDetailsCardMulticapture(**data: Any) : Multicapture details

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

status: str | None : The type of the None singleton.

ChargePaymentMethodDetailsCardNetworkToken(**data: Any) : Network token details

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

used: bool | None : The type of the None singleton.

ChargePaymentMethodDetailsCardOvercapture(**data: Any) : Overcapture details

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

maximum_amount_capturable: int | None : The type of the None singleton.

model_config : The type of the None singleton.

status: str | None : The type of the None singleton.

ChargePresentmentDetails(**data: Any) : Currency presentation information for multi-currency charges

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount_authorized: int | None : Amount authorized in the presentment currency

amount_charged: int | None : Amount charged in the presentment currency

currency: str | None : Three-letter ISO currency code for presentment

model_config : The type of the None singleton.

ChargeRefunds(**data: Any) : A list of refunds that have been applied to the charge

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

data: list[dict[str, typing.Any]] | None : The type of the None singleton.

has_more: bool | None : The type of the None singleton.

model_config : The type of the None singleton.

object_: str | None : The type of the None singleton.

total_count: int | None : Total number of refunds

url: str | None : URL to access the refunds list

ChargeSearchResult(**data: Any) : ChargeSearchResult type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

data: list[airbyte_agent_sdk.connectors.stripe.models.Charge] | None : The type of the None singleton.

has_more: bool | None : The type of the None singleton.

model_config : The type of the None singleton.

next_page: str | None : The type of the None singleton.

object_: str | None : The type of the None singleton.

url: str | None : The type of the None singleton.

ChargesListResultMeta(**data: Any) : Metadata for charges.Action.LIST operation

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

has_more: bool | None : The type of the None singleton.

model_config : The type of the None singleton.

ChargesSearchData(**data: Any) : Search result data for charges entity.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount: int | None : 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: int | None : Amount that was actually captured from this charge.

amount_refunded: int | None : Amount that has been refunded back to the customer.

amount_updates: list[typing.Any] | None : Updates to the amount that have been made during the charge lifecycle.

application: str | None : ID of the application that created this charge (Connect only).

application_fee: str | None : ID of the application fee associated with this charge (Connect only).

application_fee_amount: int | None : The amount of the application fee deducted from this charge (Connect only).

balance_transaction: str | None : ID of the balance transaction that describes the impact of this charge on your account balance (excluding refunds or disputes).

billing_details: dict[str, typing.Any] | None : Billing information associated with the payment method at the time of the transaction, including name, email, phone, and address.

calculated_statement_descriptor: str | None : The full statement descriptor that appears on the customer's credit card statement, combining prefix and suffix.

captured: bool | None : Whether the charge has been captured and funds transferred to your account.

card: dict[str, typing.Any] | None : Deprecated card object containing payment card details if a card was used.

created: int | None : Timestamp indicating when the charge was created.

currency: str | None : Three-letter ISO currency code in lowercase (e.g., 'usd', 'eur') for the charge amount.

customer: str | None : ID of the customer this charge is for, if one exists.

description: str | None : An arbitrary string attached to the charge, often useful for displaying to users or internal reference.

destination: str | None : ID of the destination account where funds are transferred (Connect only).

dispute: str | None : ID of the dispute object if the charge has been disputed.

disputed: bool | None : Whether the charge has been disputed by the customer with their card issuer.

failure_balance_transaction: str | None : ID of the balance transaction that describes the reversal of funds if the charge failed.

failure_code: str | None : Error code explaining the reason for charge failure, if applicable.

failure_message: str | None : Human-readable message providing more details about why the charge failed.

fraud_details: dict[str, typing.Any] | None : Information about fraud assessments and user reports related to this charge.

id: str : Unique identifier for the charge, used to link transactions across other records.

invoice: str | None : ID of the invoice this charge is for, if the charge was created by invoicing.

livemode: bool | None : Whether the charge occurred in live mode (true) or test mode (false).

metadata: dict[str, typing.Any] | None : Key-value pairs for storing additional structured information about the charge, useful for internal tracking.

model_config : The type of the None singleton.

object_: str | None : String representing the object type, always 'charge' for charge objects.

on_behalf_of: str | None : ID of the account on whose behalf the charge was made (Connect only).

order: str | None : Deprecated field for order information associated with this charge.

outcome: dict[str, typing.Any] | None : Details about the outcome of the charge, including network status, risk assessment, and reason codes.

paid: bool | None : Whether the charge succeeded and funds were successfully collected.

payment_intent: str | None : ID of the PaymentIntent associated with this charge, if one exists.

payment_method: str | None : ID of the payment method used for this charge.

payment_method_details: dict[str, typing.Any] | None : Details about the payment method at the time of the transaction, including card brand, network, and authentication results.

receipt_email: str | None : Email address to which the receipt for this charge was sent.

receipt_number: str | None : Receipt number that appears on email receipts sent for this charge.

receipt_url: str | None : URL to a hosted receipt page for this charge, viewable by the customer.

refunded: bool | None : Whether the charge has been fully refunded (partial refunds will still show as false).

refunds: dict[str, typing.Any] | None : List of refunds that have been applied to this charge.

review: str | None : ID of the review object associated with this charge, if it was flagged for manual review.

shipping: dict[str, typing.Any] | None : Shipping information for the charge, including recipient name, address, and tracking details.

source: dict[str, typing.Any] | None : Deprecated payment source object used to create this charge.

source_transfer: str | None : ID of the transfer from a source account if funds came from another Stripe account (Connect only).

statement_description: str | None : Deprecated alias for statement_descriptor.

statement_descriptor: str | None : Statement descriptor that overrides the account default for card charges, appearing on the customer's statement.

statement_descriptor_suffix: str | None : Suffix concatenated to the account's statement descriptor prefix to form the complete descriptor on customer statements.

status: str | None : Current status of the payment: 'succeeded' (completed), 'pending' (processing), or 'failed' (unsuccessful).

transfer_data: dict[str, typing.Any] | None : Object containing destination and amount for transfers to connected accounts (Connect only).

transfer_group: str | None : String identifier for grouping related charges and transfers together (Connect only).

updated: int | None : Timestamp of the last update to this charge object.

CheckoutSession(**data: Any) : CheckoutSession type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

cancel_url: str | None : The type of the None singleton.

client_reference_id: str | None : The type of the None singleton.

created: int | None : The type of the None singleton.

currency: str | None : The type of the None singleton.

customer: str | None : The type of the None singleton.

customer_email: str | None : The type of the None singleton.

id: str | None : The type of the None singleton.

livemode: bool | None : The type of the None singleton.

metadata: dict[str, str] | None : The type of the None singleton.

mode: str | None : The type of the None singleton.

model_config : The type of the None singleton.

object_: str | None : The type of the None singleton.

payment_intent: str | None : The type of the None singleton.

payment_status: str | None : The type of the None singleton.

status: str | None : The type of the None singleton.

success_url: str | None : The type of the None singleton.

url: str | None : The type of the None singleton.

CheckoutSessionCreateParams(**data: Any) : CheckoutSessionCreateParams type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

cancel_url: str | None : The type of the None singleton.

client_reference_id: str | None : The type of the None singleton.

customer: str | None : The type of the None singleton.

customer_email: str | None : The type of the None singleton.

line_items: list[airbyte_agent_sdk.connectors.stripe.models.CheckoutSessionCreateParamsLineItemsItem] | None : The type of the None singleton.

metadata: dict[str, str] | None : The type of the None singleton.

mode: str : The type of the None singleton.

model_config : The type of the None singleton.

success_url: str | None : The type of the None singleton.

CheckoutSessionCreateParamsLineItemsItem(**data: Any) : Nested schema for CheckoutSessionCreateParams.line_items_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

price: str | None : The ID of the Price or Plan object

quantity: int | None : The quantity of the line item

Customer(**data: Any) : Customer type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

address: airbyte_agent_sdk.connectors.stripe.models.CustomerAddress | None : The type of the None singleton.

balance: int | None : The type of the None singleton.

business_name: str | None : The type of the None singleton.

cash_balance: airbyte_agent_sdk.connectors.stripe.models.CustomerCashBalance | None : The type of the None singleton.

created: int | None : The type of the None singleton.

currency: str | None : The type of the None singleton.

customer_account: str | None : The type of the None singleton.

default_currency: str | None : The type of the None singleton.

default_source: str | None : The type of the None singleton.

delinquent: bool | None : The type of the None singleton.

description: str | None : The type of the None singleton.

discount: airbyte_agent_sdk.connectors.stripe.models.CustomerDiscount | None : The type of the None singleton.

email: str | None : The type of the None singleton.

id: str | None : The type of the None singleton.

individual_name: str | None : The type of the None singleton.

invoice_credit_balance: dict[str, typing.Any] | None : The type of the None singleton.

invoice_prefix: str | None : The type of the None singleton.

invoice_settings: airbyte_agent_sdk.connectors.stripe.models.CustomerInvoiceSettings | None : The type of the None singleton.

livemode: bool | None : The type of the None singleton.

metadata: dict[str, str] | None : The type of the None singleton.

model_config : The type of the None singleton.

name: str | None : The type of the None singleton.

next_invoice_sequence: int | None : The type of the None singleton.

object_: str | None : The type of the None singleton.

phone: str | None : The type of the None singleton.

preferred_locales: list[str] | None : The type of the None singleton.

shipping: airbyte_agent_sdk.connectors.stripe.models.CustomerShipping | None : The type of the None singleton.

sources: airbyte_agent_sdk.connectors.stripe.models.CustomerSources | None : The type of the None singleton.

subscriptions: airbyte_agent_sdk.connectors.stripe.models.CustomerSubscriptions | None : The type of the None singleton.

tax_exempt: str | None : The type of the None singleton.

test_clock: str | None : The type of the None singleton.

CustomerAddress(**data: Any) : The customer's address

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

city: str | None : City, district, suburb, town, or village

country: str | None : Two-letter country code (ISO 3166-1 alpha-2)

line1: str | None : Address line 1, such as the street, PO Box, or company name

line2: str | None : Address line 2, such as the apartment, suite, unit, or building

model_config : The type of the None singleton.

postal_code: str | None : ZIP or postal code

state: str | None : State, county, province, or region

CustomerCashBalance(**data: Any) : The current funds being held by Stripe on behalf of the customer

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

available: dict[str, typing.Any] | None : A hash of all cash balances available to this customer

customer: str | None : The ID of the customer whose cash balance this object represents

customer_account: str | None : The ID of the account whose cash balance this object represents

livemode: bool | None : Has the value true if the object exists in live mode or false if in test mode

model_config : The type of the None singleton.

object_: str | None : String representing the object's type

settings: airbyte_agent_sdk.connectors.stripe.models.CustomerCashBalanceSettings | None : A hash of settings for this cash balance

CustomerCashBalanceSettings(**data: Any) : A hash of settings for this cash balance

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

reconciliation_mode: str | None : The configuration for how funds that land in the customer cash balance are reconciled

using_merchant_default: bool | None : A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance

CustomerCreateParams(**data: Any) : CustomerCreateParams type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

address: airbyte_agent_sdk.connectors.stripe.models.CustomerCreateParamsAddress | None : The type of the None singleton.

description: str | None : The type of the None singleton.

email: str | None : The type of the None singleton.

metadata: dict[str, str] | None : The type of the None singleton.

model_config : The type of the None singleton.

name: str | None : The type of the None singleton.

phone: str | None : The type of the None singleton.

CustomerCreateParamsAddress(**data: Any) : The customer's address

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

city: str | None : City, district, suburb, town, or village

country: str | None : Two-letter country code (ISO 3166-1 alpha-2)

line1: str | None : Address line 1

line2: str | None : Address line 2

model_config : The type of the None singleton.

postal_code: str | None : ZIP or postal code

state: str | None : State, county, province, or region

CustomerDeletedResponse(**data: Any) : CustomerDeletedResponse type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

deleted: bool | None : The type of the None singleton.

id: str | None : The type of the None singleton.

model_config : The type of the None singleton.

object_: str | None : The type of the None singleton.

CustomerDiscount(**data: Any) : Describes the current discount active on the customer, if there is one

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

checkout_session: str | None : The Checkout session that this coupon is applied to, if applicable

customer: str | None : The ID of the customer associated with this discount

customer_account: str | None : The ID of the account associated with this discount

end: int | None : If the coupon has a duration of repeating, the date that this discount will end

id: str | None : The ID of the discount object

invoice: str | None : The invoice that the discount's coupon was applied to

invoice_item: str | None : The invoice item that the discount's coupon was applied to

model_config : The type of the None singleton.

object_: str | None : String representing the object's type

promotion_code: str | None : The promotion code applied to create this discount

source: airbyte_agent_sdk.connectors.stripe.models.CustomerDiscountSource | None : The source of the discount

start: int | None : Date that the coupon was applied

subscription: str | None : The subscription that this coupon is applied to

subscription_item: str | None : The subscription item that this coupon is applied to

CustomerDiscountSource(**data: Any) : The source of the discount

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

coupon: str | None : The coupon that was redeemed to create this discount

model_config : The type of the None singleton.

type_: str | None : The source type of the discount

CustomerInvoiceSettings(**data: Any) : The customer's default invoice settings

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

custom_fields: list[airbyte_agent_sdk.connectors.stripe.models.CustomerInvoiceSettingsCustomFieldsItem] | None : Default custom fields to be displayed on invoices for this customer

default_payment_method: str | None : ID of a payment method that's attached to the customer

footer: str | None : Default footer to be displayed on invoices for this customer

model_config : The type of the None singleton.

rendering_options: airbyte_agent_sdk.connectors.stripe.models.CustomerInvoiceSettingsRenderingOptions | None : Default options for invoice PDF rendering for this customer

CustomerInvoiceSettingsCustomFieldsItem(**data: Any) : Nested schema for CustomerInvoiceSettings.custom_fields_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

name: str | None : The name of the custom field

value: str | None : The value of the custom field

CustomerInvoiceSettingsRenderingOptions(**data: Any) : Default options for invoice PDF rendering for this customer

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount_tax_display: str | None : How line-item prices and amounts will be displayed with respect to tax on invoice PDFs

model_config : The type of the None singleton.

template: str | None : ID of the invoice rendering template to be used for this customer's invoices

CustomerList(**data: Any) : CustomerList type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

data: list[airbyte_agent_sdk.connectors.stripe.models.Customer] | None : The type of the None singleton.

has_more: bool | None : The type of the None singleton.

model_config : The type of the None singleton.

object_: str | None : The type of the None singleton.

url: str | None : The type of the None singleton.

CustomerSearchResult(**data: Any) : CustomerSearchResult type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

data: list[airbyte_agent_sdk.connectors.stripe.models.Customer] | None : The type of the None singleton.

has_more: bool | None : The type of the None singleton.

model_config : The type of the None singleton.

next_page: str | None : The type of the None singleton.

object_: str | None : The type of the None singleton.

url: str | None : The type of the None singleton.

CustomerShipping(**data: Any) : Mailing and shipping address for the customer

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

address: airbyte_agent_sdk.connectors.stripe.models.CustomerShippingAddress | None : Customer shipping address

model_config : The type of the None singleton.

name: str | None : Customer name

phone: str | None : Customer phone (including extension)

CustomerShippingAddress(**data: Any) : Customer shipping address

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

city: str | None : City, district, suburb, town, or village

country: str | None : Two-letter country code (ISO 3166-1 alpha-2)

line1: str | None : Address line 1, such as the street, PO Box, or company name

line2: str | None : Address line 2, such as the apartment, suite, unit, or building

model_config : The type of the None singleton.

postal_code: str | None : ZIP or postal code

state: str | None : State, county, province, or region

CustomerSources(**data: Any) : The customer's payment sources, if any

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

data: list[airbyte_agent_sdk.connectors.stripe.models.CustomerSourcesDataItem] | None : Details about each object

has_more: bool | None : True if this list has another page of items after this one

model_config : The type of the None singleton.

object_: str | None : String representing the object's type

url: str | None : The URL where this list can be accessed

CustomerSourcesDataItem(**data: Any) : Nested schema for CustomerSources.data_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

account: str | None : The account this bank account belongs to

account_holder_name: str | None : The name of the person or business that owns the bank account

account_holder_type: str | None : The type of entity that holds the account

account_type: str | None : The bank account type

available_payout_methods: list[str] | None : A set of available payout methods for this bank account

bank_name: str | None : Name of the bank associated with the routing number

country: str | None : Two-letter ISO code representing the country the bank account is located in

currency: str | None : Three-letter ISO code for the currency paid out to the bank account

customer: str | None : The ID of the customer that the bank account is associated with

fingerprint: str | None : Uniquely identifies this particular bank account

id: str | None : Unique identifier for the object

last4: str | None : The last four digits of the bank account number

metadata: dict[str, str] | None : Set of key-value pairs that you can attach to an object

model_config : The type of the None singleton.

object_: str | None : String representing the object's type

routing_number: str | None : The routing transit number for the bank account

status: str | None : The status of the bank account

CustomerSubscriptions(**data: Any) : The customer's current subscriptions, if any

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

data: list[airbyte_agent_sdk.connectors.stripe.models.Subscription] | None : Details about each subscription

has_more: bool | None : True if this list has another page of items after this one

model_config : The type of the None singleton.

object_: str | None : String representing the object's type

url: str | None : The URL where this list can be accessed

CustomerUpdateParams(**data: Any) : CustomerUpdateParams type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

address: airbyte_agent_sdk.connectors.stripe.models.CustomerUpdateParamsAddress | None : The type of the None singleton.

description: str | None : The type of the None singleton.

email: str | None : The type of the None singleton.

metadata: dict[str, str] | None : The type of the None singleton.

model_config : The type of the None singleton.

name: str | None : The type of the None singleton.

phone: str | None : The type of the None singleton.

CustomerUpdateParamsAddress(**data: Any) : The customer's address

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

city: str | None : City, district, suburb, town, or village

country: str | None : Two-letter country code (ISO 3166-1 alpha-2)

line1: str | None : Address line 1

line2: str | None : Address line 2

model_config : The type of the None singleton.

postal_code: str | None : ZIP or postal code

state: str | None : State, county, province, or region

CustomersApiSearchResultMeta(**data: Any) : Metadata for customers.Action.API_SEARCH operation

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

has_more: bool | None : The type of the None singleton.

model_config : The type of the None singleton.

CustomersListResultMeta(**data: Any) : Metadata for customers.Action.LIST operation

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

has_more: bool | None : The type of the None singleton.

model_config : The type of the None singleton.

CustomersSearchData(**data: Any) : Search result data for customers entity.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

account_balance: int | None : Current balance value representing funds owed by or to the customer.

address: dict[str, typing.Any] | None : The customer's address information including line1, line2, city, state, postal code, and country.

balance: int | None : Current balance (positive or negative) that is automatically applied to the customer's next invoice.

cards: list[typing.Any] | None : Card payment methods associated with the customer account.

created: int | None : Timestamp indicating when the customer object was created.

currency: str | None : Three-letter ISO currency code representing the customer's default currency.

default_card: str | None : The default card to be used for charges when no specific payment method is provided.

default_source: str | None : The default payment source (card or bank account) for the customer.

delinquent: bool | None : Boolean indicating whether the customer is currently delinquent on payments.

description: str | None : An arbitrary string attached to the customer, often useful for displaying to users.

discount: dict[str, typing.Any] | None : Discount object describing any active discount applied to the customer.

email: str | None : The customer's email address for communication and tracking purposes.

id: str | None : Unique identifier for the customer object.

invoice_prefix: str | None : The prefix for invoice numbers generated for this customer.

invoice_settings: dict[str, typing.Any] | None : Customer's invoice-related settings including default payment method and custom fields.

is_deleted: bool | None : Boolean indicating whether the customer has been deleted.

livemode: bool | None : Boolean indicating whether the object exists in live mode or test mode.

metadata: dict[str, typing.Any] | None : Set of key-value pairs for storing additional structured information about the customer.

model_config : The type of the None singleton.

name: str | None : The customer's full name or business name.

next_invoice_sequence: int | None : The sequence number for the next invoice generated for this customer.

object_: str | None : String representing the object type, always 'customer'.

phone: str | None : The customer's phone number.

preferred_locales: list[typing.Any] | None : Array of preferred locales for the customer, used for invoice and receipt localization.

shipping: dict[str, typing.Any] | None : Mailing and shipping address for the customer, appears on invoices emailed to the customer.

sources: str : Payment sources (cards, bank accounts) attached to the customer for making payments.

subscriptions: dict[str, typing.Any] | None : List of active subscriptions associated with the customer.

tax_exempt: str | None : Describes the customer's tax exemption status (none, exempt, or reverse).

tax_info: str | None : Tax identification information for the customer.

tax_info_verification: str | None : Verification status of the customer's tax information.

test_clock: str | None : ID of the test clock associated with this customer for testing time-dependent scenarios.

updated: int | None : Timestamp indicating when the customer object was last updated.

Dispute(**data: Any) : Dispute type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount: int | None : The type of the None singleton.

balance_transactions: list[dict[str, typing.Any]] | None : The type of the None singleton.

charge: str | None : The type of the None singleton.

created: int | None : The type of the None singleton.

currency: str | None : The type of the None singleton.

enhanced_eligibility_types: list[str] | None : The type of the None singleton.

evidence: dict[str, typing.Any] | None : The type of the None singleton.

evidence_details: airbyte_agent_sdk.connectors.stripe.models.DisputeEvidenceDetails | None : The type of the None singleton.

id: str | None : The type of the None singleton.

is_charge_refundable: bool | None : The type of the None singleton.

livemode: bool | None : The type of the None singleton.

metadata: dict[str, str] | None : The type of the None singleton.

model_config : The type of the None singleton.

object_: str | None : The type of the None singleton.

payment_intent: str | None : The type of the None singleton.

payment_method_details: dict[str, typing.Any] | None : The type of the None singleton.

reason: str | None : The type of the None singleton.

status: str | None : The type of the None singleton.

DisputeEvidenceDetails(**data: Any) : Information about the evidence submission

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

due_by: int | None : Date by which evidence must be submitted, measured in seconds since the Unix epoch

has_evidence: bool | None : Whether evidence has been staged for this dispute

model_config : The type of the None singleton.

past_due: bool | None : Whether the last evidence submission was submitted past the due date

submission_count: int | None : The number of times evidence has been submitted

DisputeList(**data: Any) : DisputeList type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

data: list[airbyte_agent_sdk.connectors.stripe.models.Dispute] | None : The type of the None singleton.

has_more: bool | None : The type of the None singleton.

model_config : The type of the None singleton.

object_: str | None : The type of the None singleton.

url: str | None : The type of the None singleton.

DisputesListResultMeta(**data: Any) : Metadata for disputes.Action.LIST operation

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

has_more: bool | None : The type of the None singleton.

model_config : The type of the None singleton.

Invoice(**data: Any) : Invoice type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

account_country: str | None : The type of the None singleton.

account_name: str | None : The type of the None singleton.

account_tax_ids: list[str] | None : The type of the None singleton.

amount_due: int | None : The type of the None singleton.

amount_overpaid: int | None : The type of the None singleton.

amount_paid: int | None : The type of the None singleton.

amount_remaining: int | None : The type of the None singleton.

amount_shipping: int | None : The type of the None singleton.

application: str | None : The type of the None singleton.

application_fee_amount: int | None : The type of the None singleton.

attempt_count: int | None : The type of the None singleton.

attempted: bool | None : The type of the None singleton.

auto_advance: bool | None : The type of the None singleton.

automatic_tax: airbyte_agent_sdk.connectors.stripe.models.InvoiceAutomaticTax | None : The type of the None singleton.

automatically_finalizes_at: int | None : The type of the None singleton.

billing_reason: str | None : The type of the None singleton.

charge: str | None : The type of the None singleton.

collection_method: str | None : The type of the None singleton.

confirmation_secret: airbyte_agent_sdk.connectors.stripe.models.InvoiceConfirmationSecret | None : The type of the None singleton.

created: int | None : The type of the None singleton.

currency: str | None : The type of the None singleton.

custom_fields: list[airbyte_agent_sdk.connectors.stripe.models.InvoiceCustomFieldsItem] | None : The type of the None singleton.

customer: str | None : The type of the None singleton.

customer_account: str | None : The type of the None singleton.

customer_address: airbyte_agent_sdk.connectors.stripe.models.InvoiceCustomerAddress | None : The type of the None singleton.

customer_email: str | None : The type of the None singleton.

customer_name: str | None : The type of the None singleton.

customer_phone: str | None : The type of the None singleton.

customer_shipping: airbyte_agent_sdk.connectors.stripe.models.InvoiceCustomerShipping | None : The type of the None singleton.

customer_tax_exempt: str | None : The type of the None singleton.

customer_tax_ids: list[airbyte_agent_sdk.connectors.stripe.models.InvoiceCustomerTaxIdsItem] | None : The type of the None singleton.

default_payment_method: str | None : The type of the None singleton.

default_source: str | None : The type of the None singleton.

default_tax_rates: list[airbyte_agent_sdk.connectors.stripe.models.InvoiceDefaultTaxRatesItem] | None : The type of the None singleton.

description: str | None : The type of the None singleton.

discount: airbyte_agent_sdk.connectors.stripe.models.InvoiceDiscount | None : The type of the None singleton.

discounts: list[str] | None : The type of the None singleton.

due_date: int | None : The type of the None singleton.

effective_at: int | None : The type of the None singleton.

ending_balance: int | None : The type of the None singleton.

footer: str | None : The type of the None singleton.

from_invoice: airbyte_agent_sdk.connectors.stripe.models.InvoiceFromInvoice | None : The type of the None singleton.

hosted_invoice_url: str | None : The type of the None singleton.

id: str | None : The type of the None singleton.

invoice_pdf: str | None : The type of the None singleton.

issuer: airbyte_agent_sdk.connectors.stripe.models.InvoiceIssuer | None : The type of the None singleton.

last_finalization_error: airbyte_agent_sdk.connectors.stripe.models.InvoiceLastFinalizationError | None : The type of the None singleton.

latest_revision: str | None : The type of the None singleton.

lines: airbyte_agent_sdk.connectors.stripe.models.InvoiceLines | None : The type of the None singleton.

livemode: bool | None : The type of the None singleton.

metadata: dict[str, str] | None : The type of the None singleton.

model_config : The type of the None singleton.

next_payment_attempt: int | None : The type of the None singleton.

number: str | None : The type of the None singleton.

object_: str | None : The type of the None singleton.

on_behalf_of: str | None : The type of the None singleton.

paid: bool | None : The type of the None singleton.

paid_out_of_band: bool | None : The type of the None singleton.

parent: airbyte_agent_sdk.connectors.stripe.models.InvoiceParent | None : The type of the None singleton.

payment_intent: str | None : The type of the None singleton.

payment_settings: airbyte_agent_sdk.connectors.stripe.models.InvoicePaymentSettings | None : The type of the None singleton.

payments: airbyte_agent_sdk.connectors.stripe.models.InvoicePayments | None : The type of the None singleton.

period_end: int | None : The type of the None singleton.

period_start: int | None : The type of the None singleton.

post_payment_credit_notes_amount: int | None : The type of the None singleton.

pre_payment_credit_notes_amount: int | None : The type of the None singleton.

quote: str | None : The type of the None singleton.

receipt_number: str | None : The type of the None singleton.

rendering: airbyte_agent_sdk.connectors.stripe.models.InvoiceRendering | None : The type of the None singleton.

rendering_options: dict[str, typing.Any] | None : The type of the None singleton.

shipping_cost: airbyte_agent_sdk.connectors.stripe.models.InvoiceShippingCost | None : The type of the None singleton.

shipping_details: airbyte_agent_sdk.connectors.stripe.models.InvoiceShippingDetails | None : The type of the None singleton.

starting_balance: int | None : The type of the None singleton.

statement_descriptor: str | None : The type of the None singleton.

status: str | None : The type of the None singleton.

status_transitions: airbyte_agent_sdk.connectors.stripe.models.InvoiceStatusTransitions | None : The type of the None singleton.

subscription: str | None : The type of the None singleton.

subscription_details: airbyte_agent_sdk.connectors.stripe.models.InvoiceSubscriptionDetails | None : The type of the None singleton.

subtotal: int | None : The type of the None singleton.

subtotal_excluding_tax: int | None : The type of the None singleton.

tax: int | None : The type of the None singleton.

test_clock: str | None : The type of the None singleton.

threshold_reason: airbyte_agent_sdk.connectors.stripe.models.InvoiceThresholdReason | None : The type of the None singleton.

total: int | None : The type of the None singleton.

total_discount_amounts: list[airbyte_agent_sdk.connectors.stripe.models.InvoiceTotalDiscountAmountsItem] | None : The type of the None singleton.

total_excluding_tax: int | None : The type of the None singleton.

total_pretax_credit_amounts: list[airbyte_agent_sdk.connectors.stripe.models.InvoiceTotalPretaxCreditAmountsItem] | None : The type of the None singleton.

total_tax_amounts: list[airbyte_agent_sdk.connectors.stripe.models.InvoiceTotalTaxAmountsItem] | None : The type of the None singleton.

total_taxes: list[airbyte_agent_sdk.connectors.stripe.models.InvoiceTotalTaxesItem] | None : The type of the None singleton.

transfer_data: dict[str, typing.Any] | None : The type of the None singleton.

webhooks_delivered_at: int | None : The type of the None singleton.

InvoiceAutomaticTax(**data: Any) : Settings and latest results for automatic tax lookup for this invoice

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

disabled_reason: str | None : If Stripe disabled automatic tax, this enum describes why

enabled: bool | None : Whether Stripe automatically computes tax on this invoice

liability: airbyte_agent_sdk.connectors.stripe.models.InvoiceAutomaticTaxLiability | None : The account that's liable for tax

model_config : The type of the None singleton.

provider: str | None : The tax provider powering automatic tax

status: str | None : The status of the most recent automated tax calculation for this invoice

InvoiceAutomaticTaxLiability(**data: Any) : The account that's liable for tax

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

account: str | None : The connected account being referenced when type is account

model_config : The type of the None singleton.

type_: str | None : Type of the account referenced

InvoiceConfirmationSecret(**data: Any) : The confirmation secret associated with this invoice

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

client_secret: str | None : The client_secret of the payment that Stripe creates for the invoice after finalization

model_config : The type of the None singleton.

type_: str | None : The type of client_secret

InvoiceCreateParams(**data: Any) : InvoiceCreateParams type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

auto_advance: bool | None : The type of the None singleton.

collection_method: str | None : The type of the None singleton.

customer: str : The type of the None singleton.

days_until_due: int | None : The type of the None singleton.

description: str | None : The type of the None singleton.

due_date: int | None : The type of the None singleton.

footer: str | None : The type of the None singleton.

metadata: dict[str, str] | None : The type of the None singleton.

model_config : The type of the None singleton.

pending_invoice_items_behavior: str | None : The type of the None singleton.

InvoiceCustomFieldsItem(**data: Any) : Nested schema for Invoice.custom_fields_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

name: str | None : The name of the custom field

value: str | None : The value of the custom field

InvoiceCustomerAddress(**data: Any) : The customer's address

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

city: str | None : City, district, suburb, town, or village

country: str | None : Two-letter country code (ISO 3166-1 alpha-2)

line1: str | None : Address line 1

line2: str | None : Address line 2

model_config : The type of the None singleton.

postal_code: str | None : ZIP or postal code

state: str | None : State, county, province, or region

InvoiceCustomerShipping(**data: Any) : The customer's shipping information

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

address: airbyte_agent_sdk.connectors.stripe.models.InvoiceCustomerShippingAddress | None : Customer shipping address

model_config : The type of the None singleton.

name: str | None : Customer name

phone: str | None : Customer phone (including extension)

InvoiceCustomerShippingAddress(**data: Any) : Customer shipping address

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

city: str | None : City, district, suburb, town, or village

country: str | None : Two-letter country code (ISO 3166-1 alpha-2)

line1: str | None : Address line 1

line2: str | None : Address line 2

model_config : The type of the None singleton.

postal_code: str | None : ZIP or postal code

state: str | None : State, county, province, or region

InvoiceCustomerTaxIdsItem(**data: Any) : Nested schema for Invoice.customer_tax_ids_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

type_: str | None : The type of the tax ID

value: str | None : The value of the tax ID

InvoiceDefaultTaxRatesItem(**data: Any) : Nested schema for Invoice.default_tax_rates_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

active: bool | None : Defaults to true

country: str | None : Two-letter country code (ISO 3166-1 alpha-2)

created: int | None : Time at which the object was created

description: str | None : An arbitrary string attached to the tax rate for your internal use only

display_name: str | None : The display name of the tax rate

effective_percentage: float | None : Actual/effective tax rate percentage out of 100

flat_amount: airbyte_agent_sdk.connectors.stripe.models.InvoiceDefaultTaxRatesItemFlatAmount | None : The amount of the tax rate when the rate_type is flat_amount

id: str | None : Unique identifier for the object

inclusive: bool | None : This specifies if the tax rate is inclusive or exclusive

jurisdiction: str | None : The jurisdiction for the tax rate

jurisdiction_level: str | None : The level of the jurisdiction that imposes this tax rate

livemode: bool | None : Has the value true if the object exists in live mode

metadata: dict[str, str] | None : Set of key-value pairs

model_config : The type of the None singleton.

object_: str | None : String representing the object's type

percentage: float | None : Tax rate percentage out of 100

rate_type: str | None : Indicates the type of tax rate applied to the taxable amount

state: str | None : ISO 3166-2 subdivision code

tax_type: str | None : The high-level tax type

InvoiceDefaultTaxRatesItemFlatAmount(**data: Any) : The amount of the tax rate when the rate_type is flat_amount

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount: int | None : Amount of the tax when the rate_type is flat_amount

currency: str | None : Three-letter ISO currency code

model_config : The type of the None singleton.

InvoiceDiscount(**data: Any) : The discount applied to the invoice

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

checkout_session: str | None : The type of the None singleton.

coupon: airbyte_agent_sdk.connectors.stripe.models.InvoiceDiscountCoupon | None : The type of the None singleton.

customer: str | None : The type of the None singleton.

customer_account: str | None : The type of the None singleton.

end: int | None : The type of the None singleton.

id: str | None : The type of the None singleton.

invoice: str | None : The type of the None singleton.

invoice_item: str | None : The type of the None singleton.

model_config : The type of the None singleton.

object_: str | None : The type of the None singleton.

promotion_code: str | None : The type of the None singleton.

start: int | None : The type of the None singleton.

subscription: str | None : The type of the None singleton.

subscription_item: str | None : The type of the None singleton.

InvoiceDiscountCoupon(**data: Any) : Nested schema for InvoiceDiscount.coupon

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount_off: int | None : The type of the None singleton.

created: int | None : The type of the None singleton.

currency: str | None : The type of the None singleton.

duration: str | None : The type of the None singleton.

duration_in_months: int | None : The type of the None singleton.

id: str | None : The type of the None singleton.

livemode: bool | None : The type of the None singleton.

max_redemptions: int | None : The type of the None singleton.

metadata: dict[str, str] | None : The type of the None singleton.

model_config : The type of the None singleton.

name: str | None : The type of the None singleton.

object_: str | None : The type of the None singleton.

percent_off: float | None : The type of the None singleton.

redeem_by: int | None : The type of the None singleton.

times_redeemed: int | None : The type of the None singleton.

valid: bool | None : The type of the None singleton.

InvoiceFinalizeParams(**data: Any) : InvoiceFinalizeParams type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

auto_advance: bool | None : The type of the None singleton.

model_config : The type of the None singleton.

InvoiceFromInvoice(**data: Any) : Details of the invoice that was cloned

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

action: str | None : The type of the None singleton.

invoice: str | None : The type of the None singleton.

model_config : The type of the None singleton.

InvoiceIssuer(**data: Any) : The connected account that issues the invoice

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

account: str | None : The connected account being referenced when type is account

model_config : The type of the None singleton.

type_: str | None : Type of the account referenced

InvoiceLastFinalizationError(**data: Any) : The error encountered during the last finalization attempt

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

advice_code: str | None : For card errors resulting from a card issuer decline

code: str | None : For some errors that could be handled programmatically, a short string indicating the error code

doc_url: str | None : A URL to more information about the error code reported

message: str | None : A human-readable message providing more details about the error

model_config : The type of the None singleton.

network_advice_code: str | None : For card errors resulting from a card issuer decline

network_decline_code: str | None : For payments declined by the network

param: str | None : If the error is parameter-specific, the parameter related to the error

payment_method_type: str | None : If the error is specific to the type of payment method

type_: str | None : The type of error returned

InvoiceLines(**data: Any) : The individual line items that make up the invoice

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

data: list[airbyte_agent_sdk.connectors.stripe.models.InvoiceLinesDataItem] | None : The type of the None singleton.

has_more: bool | None : The type of the None singleton.

model_config : The type of the None singleton.

object_: str | None : The type of the None singleton.

total_count: int | None : The type of the None singleton.

url: str | None : The type of the None singleton.

InvoiceLinesDataItem(**data: Any) : Nested schema for InvoiceLines.data_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount: int | None : The amount in cents

currency: str | None : Three-letter ISO currency code

description: str | None : An arbitrary string attached to the object

discount_amounts: list[airbyte_agent_sdk.connectors.stripe.models.InvoiceLinesDataItemDiscountAmountsItem] | None : The amount of discount calculated per discount for this line item

discountable: bool | None : If true, discounts will apply to this line item

discounts: list[str] | None : The discounts applied to the invoice line item

id: str | None : Unique identifier for the object

invoice: str | None : The ID of the invoice that contains this line item

livemode: bool | None : Has the value true if the object exists in live mode

metadata: dict[str, str] | None : Set of key-value pairs

model_config : The type of the None singleton.

object_: str | None : String representing the object's type

period: airbyte_agent_sdk.connectors.stripe.models.InvoiceLinesDataItemPeriod | None : The period this line_item covers

proration: bool | None : Whether this is a proration

quantity: int | None : The quantity of the subscription

InvoiceLinesDataItemDiscountAmountsItem(**data: Any) : Nested schema for InvoiceLinesDataItem.discount_amounts_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount: int | None : The amount of the discount

discount: str | None : The discount that was applied

model_config : The type of the None singleton.

InvoiceLinesDataItemPeriod(**data: Any) : The period this line_item covers

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

end: int | None : The end of the period

model_config : The type of the None singleton.

start: int | None : The start of the period

InvoiceList(**data: Any) : InvoiceList type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

data: list[airbyte_agent_sdk.connectors.stripe.models.Invoice] | None : The type of the None singleton.

has_more: bool | None : The type of the None singleton.

model_config : The type of the None singleton.

object_: str | None : The type of the None singleton.

url: str | None : The type of the None singleton.

InvoiceParent(**data: Any) : The parent that generated this invoice

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

quote_details: airbyte_agent_sdk.connectors.stripe.models.InvoiceParentQuoteDetails | None : Details about the quote that generated this invoice

subscription_details: airbyte_agent_sdk.connectors.stripe.models.InvoiceParentSubscriptionDetails | None : Details about the subscription that generated this invoice

type_: str | None : The type of parent that generated this invoice

InvoiceParentQuoteDetails(**data: Any) : Details about the quote that generated this invoice

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

quote: str | None : The quote that generated this invoice

InvoiceParentSubscriptionDetails(**data: Any) : Details about the subscription that generated this invoice

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

metadata: dict[str, str] | None : Set of key-value pairs defined as subscription metadata

model_config : The type of the None singleton.

subscription: str | None : The subscription that generated this invoice

subscription_proration_date: int | None : Only set for upcoming invoices that preview prorations

InvoicePaymentSettings(**data: Any) : Configuration settings for the PaymentIntent that is generated when the invoice is finalized

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

default_mandate: str | None : ID of the mandate to be used for this invoice

model_config : The type of the None singleton.

payment_method_options: dict[str, typing.Any] | None : Payment-method-specific configuration to provide to the invoice's PaymentIntent

payment_method_types: list[str] | None : The list of payment method types to provide to the invoice's PaymentIntent

InvoicePayments(**data: Any) : Payments for this invoice

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

data: list[airbyte_agent_sdk.connectors.stripe.models.InvoicePaymentsDataItem] | None : Details about each payment

has_more: bool | None : True if this list has another page of items

model_config : The type of the None singleton.

object_: str | None : String representing the object's type

url: str | None : The URL where this list can be accessed

InvoicePaymentsDataItem(**data: Any) : Nested schema for InvoicePayments.data_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount_paid: int | None : Amount that was actually paid for this invoice

amount_requested: int | None : Amount intended to be paid toward this invoice

created: int | None : Time at which the object was created

currency: str | None : Three-letter ISO currency code

id: str | None : Unique identifier for the object

invoice: str | None : The invoice that was paid

is_default: bool | None : Whether this is the default payment created when the invoice was finalized

livemode: bool | None : Has the value true if the object exists in live mode

model_config : The type of the None singleton.

object_: str | None : String representing the object's type

status: str | None : The status of the payment

InvoiceRendering(**data: Any) : The rendering-related settings that control how the invoice is displayed

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount_tax_display: str | None : How line-item prices and amounts will be displayed with respect to tax

model_config : The type of the None singleton.

pdf: airbyte_agent_sdk.connectors.stripe.models.InvoiceRenderingPdf | None : Invoice pdf rendering options

template: str | None : ID of the rendering template that the invoice is formatted by

template_version: int | None : Version of the rendering template that the invoice is using

InvoiceRenderingPdf(**data: Any) : Invoice pdf rendering options

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

page_size: str | None : Page size of invoice pdf

InvoiceSearchResult(**data: Any) : InvoiceSearchResult type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

data: list[airbyte_agent_sdk.connectors.stripe.models.Invoice] | None : The type of the None singleton.

has_more: bool | None : The type of the None singleton.

model_config : The type of the None singleton.

next_page: str | None : The type of the None singleton.

object_: str | None : The type of the None singleton.

url: str | None : The type of the None singleton.

InvoiceShippingCost(**data: Any) : The details of the cost of shipping

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount_subtotal: int | None : Total shipping cost before any taxes are applied

amount_tax: int | None : Total tax amount applied due to shipping costs

amount_total: int | None : Total shipping cost after taxes are applied

model_config : The type of the None singleton.

shipping_rate: str | None : The ID of the ShippingRate for this invoice

taxes: list[airbyte_agent_sdk.connectors.stripe.models.InvoiceShippingCostTaxesItem] | None : The taxes applied to the shipping rate

InvoiceShippingCostTaxesItem(**data: Any) : Nested schema for InvoiceShippingCost.taxes_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount: int | None : Amount of tax applied for this rate

model_config : The type of the None singleton.

taxability_reason: str | None : The reasoning behind this tax

taxable_amount: int | None : The amount on which tax is calculated

InvoiceShippingDetails(**data: Any) : Shipping details for the invoice

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

address: airbyte_agent_sdk.connectors.stripe.models.InvoiceShippingDetailsAddress | None : Shipping address

model_config : The type of the None singleton.

name: str | None : Recipient name

phone: str | None : Recipient phone

InvoiceShippingDetailsAddress(**data: Any) : Shipping address

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

city: str | None : City, district, suburb, town, or village

country: str | None : Two-letter country code (ISO 3166-1 alpha-2)

line1: str | None : Address line 1

line2: str | None : Address line 2

model_config : The type of the None singleton.

postal_code: str | None : ZIP or postal code

state: str | None : State, county, province, or region

InvoiceStatusTransitions(**data: Any) : Status transition timestamps

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

finalized_at: int | None : The time that the invoice draft was finalized

marked_uncollectible_at: int | None : The time that the invoice was marked uncollectible

model_config : The type of the None singleton.

paid_at: int | None : The time that the invoice was paid

voided_at: int | None : The time that the invoice was voided

InvoiceSubscriptionDetails(**data: Any) : Details about the subscription that this invoice was prepared for, if any

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

metadata: dict[str, str] | None : Set of key-value pairs defined as subscription metadata when the invoice is created

model_config : The type of the None singleton.

InvoiceThresholdReason(**data: Any) : If billing_reason is set to subscription_threshold this returns more information

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount_gte: int | None : The total invoice amount threshold boundary if it triggered the threshold invoice

item_reasons: list[airbyte_agent_sdk.connectors.stripe.models.InvoiceThresholdReasonItemReasonsItem] | None : Indicates which line items triggered a threshold invoice

model_config : The type of the None singleton.

InvoiceThresholdReasonItemReasonsItem(**data: Any) : Nested schema for InvoiceThresholdReason.item_reasons_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

line_item_ids: list[str] | None : The IDs of the line items that triggered the threshold invoice

model_config : The type of the None singleton.

usage_gte: int | None : The quantity threshold boundary that applied to the given line item

InvoiceTotalDiscountAmountsItem(**data: Any) : Nested schema for Invoice.total_discount_amounts_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount: int | None : The amount of the discount

discount: str | None : The discount that was applied

model_config : The type of the None singleton.

InvoiceTotalPretaxCreditAmountsItem(**data: Any) : Nested schema for Invoice.total_pretax_credit_amounts_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount: int | None : The amount of the pretax credit amount

credit_balance_transaction: str | None : The credit balance transaction that was applied

discount: str | None : The discount that was applied

model_config : The type of the None singleton.

type_: str | None : Type of the pretax credit amount referenced

InvoiceTotalTaxAmountsItem(**data: Any) : Nested schema for Invoice.total_tax_amounts_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount: int | None : The amount of the tax

inclusive: bool | None : Whether the tax amount is included in the line item amount

model_config : The type of the None singleton.

tax_rate: str | None : The tax rate applied

taxability_reason: str | None : The reasoning behind the tax

taxable_amount: int | None : The amount on which tax is calculated

InvoiceTotalTaxesItem(**data: Any) : Nested schema for Invoice.total_taxes_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount: int | None : The amount of the tax

model_config : The type of the None singleton.

tax_behavior: str | None : Whether this tax is inclusive or exclusive

tax_rate_details: dict[str, typing.Any] | None : Additional details about the tax rate

taxability_reason: str | None : The reasoning behind this tax

taxable_amount: int | None : The amount on which tax is calculated

type_: str | None : The type of tax information

InvoicesListResultMeta(**data: Any) : Metadata for invoices.Action.LIST operation

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

has_more: bool | None : The type of the None singleton.

model_config : The type of the None singleton.

InvoicesSearchData(**data: Any) : Search result data for invoices entity.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

account_country: str | None : The country of the business associated with this invoice, commonly used to display localized content.

account_name: str | None : The public name of the business associated with this invoice.

account_tax_ids: list[typing.Any] | None : Tax IDs of the account associated with this invoice.

amount_due: int | None : Total amount, in smallest currency unit, that is due and owed by the customer.

amount_paid: int | None : Total amount, in smallest currency unit, that has been paid by the customer.

amount_remaining: int | None : The difference between amount_due and amount_paid, representing the outstanding balance.

amount_shipping: int | None : Total amount of shipping costs on the invoice.

application: str | None : ID of the Connect application that created this invoice.

application_fee: int | None : Amount of application fee charged for this invoice in a Connect scenario.

application_fee_amount: int | None : The fee in smallest currency unit that is collected by the application in a Connect scenario.

attempt_count: int | None : Number of payment attempts made for this invoice.

attempted: bool | None : Whether an attempt has been made to pay the invoice.

auto_advance: bool | None : Controls whether Stripe performs automatic collection of the invoice.

automatic_tax: dict[str, typing.Any] | None : Settings and status for automatic tax calculation on this invoice.

billing: str | None : Billing method used for the invoice (charge_automatically or send_invoice).

billing_reason: str | None : Indicates the reason why the invoice was created (subscription_cycle, manual, etc.).

charge: str | None : ID of the latest charge generated for this invoice, if any.

closed: bool | None : Whether the invoice has been marked as closed and no longer open for collection.

collection_method: str | None : Method by which the invoice is collected: charge_automatically or send_invoice.

created: int | None : Timestamp indicating when the invoice was created.

currency: str | None : Three-letter ISO currency code in which the invoice is denominated.

custom_fields: list[typing.Any] | None : Custom fields displayed on the invoice as specified by the account.

customer: str | None : The customer object or ID associated with this invoice.

customer_address: dict[str, typing.Any] | None : The customer's address at the time the invoice was finalized.

customer_email: str | None : The customer's email address at the time the invoice was finalized.

customer_name: str | None : The customer's name at the time the invoice was finalized.

customer_phone: str | None : The customer's phone number at the time the invoice was finalized.

customer_shipping: dict[str, typing.Any] | None : The customer's shipping information at the time the invoice was finalized.

customer_tax_exempt: str | None : The customer's tax exempt status at the time the invoice was finalized.

customer_tax_ids: list[typing.Any] | None : The customer's tax IDs at the time the invoice was finalized.

default_payment_method: str | None : Default payment method for the invoice, used if no other method is specified.

default_source: str | None : Default payment source for the invoice if no payment method is set.

default_tax_rates: list[typing.Any] | None : The tax rates applied to the invoice by default.

description: str | None : An arbitrary string attached to the invoice, often displayed to customers.

discount: dict[str, typing.Any] | None : The discount object applied to the invoice, if any.

discounts: list[typing.Any] | None : Array of discount IDs or objects currently applied to this invoice.

due_date: float | None : The date by which payment on this invoice is due, if the invoice is not auto-collected.

effective_at: int | None : Timestamp when the invoice becomes effective and finalized for payment.

ending_balance: int | None : The customer's ending account balance after this invoice is finalized.

footer: str | None : Footer text displayed on the invoice.

forgiven: bool | None : Whether the invoice has been forgiven and is considered paid without actual payment.

from_invoice: dict[str, typing.Any] | None : Details about the invoice this invoice was created from, if applicable.

hosted_invoice_url: str | None : URL for the hosted invoice page where customers can view and pay the invoice.

id: str | None : Unique identifier for the invoice object.

invoice_pdf: str | None : URL for the PDF version of the invoice.

is_deleted: bool | None : Indicates whether this invoice has been deleted.

issuer: dict[str, typing.Any] | None : Details about the entity issuing the invoice.

last_finalization_error: dict[str, typing.Any] | None : The error encountered during the last finalization attempt, if any.

latest_revision: str | None : The latest revision of the invoice, if revisions are enabled.

lines: dict[str, typing.Any] | None : The individual line items that make up the invoice, representing products, services, or fees.

livemode: bool | None : Indicates whether the invoice exists in live mode (true) or test mode (false).

metadata: dict[str, typing.Any] | None : Key-value pairs for storing additional structured information about the invoice.

model_config : The type of the None singleton.

next_payment_attempt: float | None : Timestamp of the next automatic payment attempt for this invoice, if applicable.

number: str | None : A unique, human-readable identifier for this invoice, often shown to customers.

object_: str | None : String representing the object type, always 'invoice'.

on_behalf_of: str | None : The account on behalf of which the invoice is being created, used in Connect scenarios.

paid: bool | None : Whether the invoice has been paid in full.

paid_out_of_band: bool | None : Whether payment was made outside of Stripe and manually marked as paid.

payment: str | None : ID of the payment associated with this invoice, if any.

payment_intent: str | None : The PaymentIntent associated with this invoice for processing payment.

payment_settings: dict[str, typing.Any] | None : Configuration settings for how payment should be collected on this invoice.

period_end: float | None : End date of the billing period covered by this invoice.

period_start: float | None : Start date of the billing period covered by this invoice.

post_payment_credit_notes_amount: int | None : Total amount of credit notes issued after the invoice was paid.

pre_payment_credit_notes_amount: int | None : Total amount of credit notes applied before payment was attempted.

quote: str | None : The quote from which this invoice was generated, if applicable.

receipt_number: str | None : The receipt number displayed on the invoice, if available.

rendering: dict[str, typing.Any] | None : Settings that control how the invoice is rendered for display.

rendering_options: dict[str, typing.Any] | None : Options for customizing the visual rendering of the invoice.

shipping_cost: dict[str, typing.Any] | None : Total cost of shipping charges included in the invoice.

shipping_details: dict[str, typing.Any] | None : Detailed shipping information for the invoice, including address and carrier.

starting_balance: int | None : The customer's starting account balance at the beginning of the billing period.

statement_description: str | None : Extra information about the invoice that appears on the customer's credit card statement.

statement_descriptor: str | None : A dynamic descriptor that appears on the customer's credit card statement for this invoice.

status: str | None : The status of the invoice: draft, open, paid, void, or uncollectible.

status_transitions: dict[str, typing.Any] : Timestamps tracking when the invoice transitioned between different statuses.

subscription: str | None : The subscription this invoice was generated for, if applicable.

subscription_details: dict[str, typing.Any] | None : Additional details about the subscription associated with this invoice.

subtotal: int | None : Total of all line items before discounts or tax are applied.

subtotal_excluding_tax: int | None : The subtotal amount excluding any tax calculations.

tax: int | None : Total tax amount applied to the invoice.

tax_percent: float | None : The percentage of tax applied to the invoice (deprecated, use total_tax_amounts instead).

test_clock: str | None : ID of the test clock this invoice belongs to, used for testing time-dependent billing.

total: int | None : Total amount of the invoice after all line items, discounts, and taxes are calculated.

total_discount_amounts: list[typing.Any] | None : Array of the total discount amounts applied, broken down by discount.

total_excluding_tax: int | None : Total amount of the invoice excluding all tax calculations.

total_tax_amounts: list[typing.Any] | None : Array of tax amounts applied to the invoice, broken down by tax rate.

transfer_data: dict[str, typing.Any] | None : Information about the transfer of funds associated with this invoice in Connect scenarios.

updated: int | None : Timestamp indicating when the invoice was last updated.

webhooks_delivered_at: float | None : Timestamp indicating when webhooks for this invoice were successfully delivered.

PaymentIntent(**data: Any) : PaymentIntent type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount: int | None : The type of the None singleton.

amount_capturable: int | None : The type of the None singleton.

amount_received: int | None : The type of the None singleton.

application: str | None : The type of the None singleton.

application_fee_amount: int | None : The type of the None singleton.

capture_method: str | None : The type of the None singleton.

client_secret: str | None : The type of the None singleton.

confirmation_method: str | None : The type of the None singleton.

created: int | None : The type of the None singleton.

currency: str | None : The type of the None singleton.

customer: str | None : The type of the None singleton.

description: str | None : The type of the None singleton.

id: str | None : The type of the None singleton.

livemode: bool | None : The type of the None singleton.

metadata: dict[str, str] | None : The type of the None singleton.

model_config : The type of the None singleton.

object_: str | None : The type of the None singleton.

payment_method: str | None : The type of the None singleton.

payment_method_types: list[str] | None : The type of the None singleton.

status: str | None : The type of the None singleton.

PaymentIntentCancelParams(**data: Any) : PaymentIntentCancelParams type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

cancellation_reason: str | None : The type of the None singleton.

model_config : The type of the None singleton.

PaymentIntentConfirmParams(**data: Any) : PaymentIntentConfirmParams type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

payment_method: str | None : The type of the None singleton.

receipt_email: str | None : The type of the None singleton.

return_url: str | None : The type of the None singleton.

PaymentIntentCreateParams(**data: Any) : PaymentIntentCreateParams type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount: int : The type of the None singleton.

automatic_payment_methods: airbyte_agent_sdk.connectors.stripe.models.PaymentIntentCreateParamsAutomaticPaymentMethods | None : The type of the None singleton.

confirm: bool | None : The type of the None singleton.

currency: str : The type of the None singleton.

customer: str | None : The type of the None singleton.

description: str | None : The type of the None singleton.

metadata: dict[str, str] | None : The type of the None singleton.

model_config : The type of the None singleton.

payment_method: str | None : The type of the None singleton.

receipt_email: str | None : The type of the None singleton.

statement_descriptor: str | None : The type of the None singleton.

statement_descriptor_suffix: str | None : The type of the None singleton.

PaymentIntentCreateParamsAutomaticPaymentMethods(**data: Any) : When you enable this parameter, this PaymentIntent accepts payment methods that you enable in the Dashboard and that are compatible with this PaymentIntent's other parameters

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

allow_redirects: str | None : Controls whether this PaymentIntent can accept redirect-based payment methods

enabled: bool | None : Whether this feature is enabled

model_config : The type of the None singleton.

PaymentIntentList(**data: Any) : PaymentIntentList type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

data: list[airbyte_agent_sdk.connectors.stripe.models.PaymentIntent] | None : The type of the None singleton.

has_more: bool | None : The type of the None singleton.

model_config : The type of the None singleton.

object_: str | None : The type of the None singleton.

url: str | None : The type of the None singleton.

PaymentIntentSearchResult(**data: Any) : PaymentIntentSearchResult type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

data: list[airbyte_agent_sdk.connectors.stripe.models.PaymentIntent] | None : The type of the None singleton.

has_more: bool | None : The type of the None singleton.

model_config : The type of the None singleton.

next_page: str | None : The type of the None singleton.

object_: str | None : The type of the None singleton.

url: str | None : The type of the None singleton.

PaymentIntentUpdateParams(**data: Any) : PaymentIntentUpdateParams type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount: int | None : The type of the None singleton.

currency: str | None : The type of the None singleton.

customer: str | None : The type of the None singleton.

description: str | None : The type of the None singleton.

metadata: dict[str, str] | None : The type of the None singleton.

model_config : The type of the None singleton.

payment_method: str | None : The type of the None singleton.

receipt_email: str | None : The type of the None singleton.

statement_descriptor: str | None : The type of the None singleton.

statement_descriptor_suffix: str | None : The type of the None singleton.

PaymentIntentsApiSearchResultMeta(**data: Any) : Metadata for payment_intents.Action.API_SEARCH operation

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

has_more: bool | None : The type of the None singleton.

model_config : The type of the None singleton.

PaymentIntentsListResultMeta(**data: Any) : Metadata for payment_intents.Action.LIST operation

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

has_more: bool | None : The type of the None singleton.

model_config : The type of the None singleton.

PaymentMethod(**data: Any) : PaymentMethod type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

billing_details: airbyte_agent_sdk.connectors.stripe.models.PaymentMethodBillingDetails | None : The type of the None singleton.

card: airbyte_agent_sdk.connectors.stripe.models.PaymentMethodCard | None : The type of the None singleton.

created: int | None : The type of the None singleton.

customer: str | None : The type of the None singleton.

id: str | None : The type of the None singleton.

livemode: bool | None : The type of the None singleton.

metadata: dict[str, str] | None : The type of the None singleton.

model_config : The type of the None singleton.

object_: str | None : The type of the None singleton.

type_: str | None : The type of the None singleton.

PaymentMethodAttachParams(**data: Any) : PaymentMethodAttachParams type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

customer: str : The type of the None singleton.

model_config : The type of the None singleton.

PaymentMethodBillingDetails(**data: Any) : Billing information associated with the PaymentMethod

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

address: airbyte_agent_sdk.connectors.stripe.models.PaymentMethodBillingDetailsAddress | None : Billing address

email: str | None : The type of the None singleton.

model_config : The type of the None singleton.

name: str | None : The type of the None singleton.

phone: str | None : The type of the None singleton.

PaymentMethodBillingDetailsAddress(**data: Any) : Billing address

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

city: str | None : The type of the None singleton.

country: str | None : The type of the None singleton.

line1: str | None : The type of the None singleton.

line2: str | None : The type of the None singleton.

model_config : The type of the None singleton.

postal_code: str | None : The type of the None singleton.

state: str | None : The type of the None singleton.

PaymentMethodCard(**data: Any) : If this is a card PaymentMethod, this hash contains the card details

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

brand: str | None : Card brand

country: str | None : Two-letter ISO code representing the country of the card

exp_month: int | None : Two-digit number representing the card's expiration month

exp_year: int | None : Four-digit number representing the card's expiration year

fingerprint: str | None : Uniquely identifies this particular card number

funding: str | None : Card funding type

last4: str | None : The last four digits of the card

model_config : The type of the None singleton.

Payout(**data: Any) : Payout type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount: int | None : The type of the None singleton.

application_fee: str | None : The type of the None singleton.

application_fee_amount: int | None : The type of the None singleton.

arrival_date: int | None : The type of the None singleton.

automatic: bool | None : The type of the None singleton.

balance_transaction: str | None : The type of the None singleton.

created: int | None : The type of the None singleton.

currency: str | None : The type of the None singleton.

description: str | None : The type of the None singleton.

destination: str | None : The type of the None singleton.

failure_balance_transaction: str | None : The type of the None singleton.

failure_code: str | None : The type of the None singleton.

failure_message: str | None : The type of the None singleton.

id: str | None : The type of the None singleton.

livemode: bool | None : The type of the None singleton.

metadata: dict[str, str] | None : The type of the None singleton.

method: str | None : The type of the None singleton.

model_config : The type of the None singleton.

object_: str | None : The type of the None singleton.

original_payout: str | None : The type of the None singleton.

payout_method: str | None : The type of the None singleton.

reconciliation_status: str | None : The type of the None singleton.

reversed_by: str | None : The type of the None singleton.

source_balance: str | None : The type of the None singleton.

source_type: str | None : The type of the None singleton.

statement_descriptor: str | None : The type of the None singleton.

status: str | None : The type of the None singleton.

trace_id: airbyte_agent_sdk.connectors.stripe.models.PayoutTraceId | None : The type of the None singleton.

type_: str | None : The type of the None singleton.

PayoutList(**data: Any) : PayoutList type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

data: list[airbyte_agent_sdk.connectors.stripe.models.Payout] | None : The type of the None singleton.

has_more: bool | None : The type of the None singleton.

model_config : The type of the None singleton.

object_: str | None : The type of the None singleton.

url: str | None : The type of the None singleton.

PayoutTraceId(**data: Any) : A string that identifies this payout as part of a group

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

status: str | None : The status of the trace ID

value: str | None : The trace ID value

PayoutsListResultMeta(**data: Any) : Metadata for payouts.Action.LIST operation

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

has_more: bool | None : The type of the None singleton.

model_config : The type of the None singleton.

Price(**data: Any) : Price type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

active: bool | None : The type of the None singleton.

billing_scheme: str | None : The type of the None singleton.

created: int | None : The type of the None singleton.

currency: str | None : The type of the None singleton.

id: str | None : The type of the None singleton.

livemode: bool | None : The type of the None singleton.

lookup_key: str | None : The type of the None singleton.

metadata: dict[str, str] | None : The type of the None singleton.

model_config : The type of the None singleton.

nickname: str | None : The type of the None singleton.

object_: str | None : The type of the None singleton.

product: str | None : The type of the None singleton.

recurring: airbyte_agent_sdk.connectors.stripe.models.PriceRecurring | None : The type of the None singleton.

tax_behavior: str | None : The type of the None singleton.

tiers_mode: str | None : The type of the None singleton.

transform_quantity: airbyte_agent_sdk.connectors.stripe.models.PriceTransformQuantity | None : The type of the None singleton.

type_: str | None : The type of the None singleton.

unit_amount: int | None : The type of the None singleton.

unit_amount_decimal: str | None : The type of the None singleton.

PriceCreateParams(**data: Any) : PriceCreateParams type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

active: bool | None : The type of the None singleton.

billing_scheme: str | None : The type of the None singleton.

currency: str : The type of the None singleton.

lookup_key: str | None : The type of the None singleton.

metadata: dict[str, str] | None : The type of the None singleton.

model_config : The type of the None singleton.

nickname: str | None : The type of the None singleton.

product: str : The type of the None singleton.

recurring: airbyte_agent_sdk.connectors.stripe.models.PriceCreateParamsRecurring | None : The type of the None singleton.

tax_behavior: str | None : The type of the None singleton.

unit_amount: int : The type of the None singleton.

PriceCreateParamsRecurring(**data: Any) : The recurring components of a price

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

interval: str | None : Specifies billing frequency

interval_count: int | None : The number of intervals between subscription billings (e.g., interval=month and interval_count=3 bills every 3 months)

model_config : The type of the None singleton.

usage_type: str | None : Configures how the quantity per period should be determined

PriceRecurring(**data: Any) : The recurring components of a price such as interval and usage_type

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

interval: str | None : The frequency at which a subscription is billed

interval_count: int | None : The number of intervals between subscription billings

model_config : The type of the None singleton.

usage_type: str | None : Configures how the quantity per period should be determined

PriceTransformQuantity(**data: Any) : Apply a transformation to the reported usage or set quantity before computing the amount billed

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

divide_by: int | None : Divide usage by this number

model_config : The type of the None singleton.

round: str | None : After division, either round the result up or down

Product(**data: Any) : Product type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

active: bool | None : The type of the None singleton.

attributes: list[str] | None : The type of the None singleton.

created: int | None : The type of the None singleton.

default_price: str | None : The type of the None singleton.

description: str | None : The type of the None singleton.

features: list[airbyte_agent_sdk.connectors.stripe.models.ProductFeaturesItem] | None : The type of the None singleton.

id: str | None : The type of the None singleton.

images: list[str] | None : The type of the None singleton.

livemode: bool | None : The type of the None singleton.

marketing_features: list[airbyte_agent_sdk.connectors.stripe.models.ProductMarketingFeaturesItem] | None : The type of the None singleton.

metadata: dict[str, str] | None : The type of the None singleton.

model_config : The type of the None singleton.

name: str | None : The type of the None singleton.

object_: str | None : The type of the None singleton.

package_dimensions: airbyte_agent_sdk.connectors.stripe.models.ProductPackageDimensions | None : The type of the None singleton.

shippable: bool | None : The type of the None singleton.

statement_descriptor: str | None : The type of the None singleton.

tax_code: str | None : The type of the None singleton.

type_: str | None : The type of the None singleton.

unit_label: str | None : The type of the None singleton.

updated: int | None : The type of the None singleton.

url: str | None : The type of the None singleton.

ProductCreateParams(**data: Any) : ProductCreateParams type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

active: bool | None : The type of the None singleton.

description: str | None : The type of the None singleton.

id: str | None : The type of the None singleton.

images: list[str] | None : The type of the None singleton.

marketing_features: list[airbyte_agent_sdk.connectors.stripe.models.ProductCreateParamsMarketingFeaturesItem] | None : The type of the None singleton.

metadata: dict[str, str] | None : The type of the None singleton.

model_config : The type of the None singleton.

name: str : The type of the None singleton.

package_dimensions: airbyte_agent_sdk.connectors.stripe.models.ProductCreateParamsPackageDimensions | None : The type of the None singleton.

shippable: bool | None : The type of the None singleton.

statement_descriptor: str | None : The type of the None singleton.

tax_code: str | None : The type of the None singleton.

unit_label: str | None : The type of the None singleton.

url: str | None : The type of the None singleton.

ProductCreateParamsMarketingFeaturesItem(**data: Any) : Nested schema for ProductCreateParams.marketing_features_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

name: str | None : The marketing feature name. Up to 80 characters long

ProductCreateParamsPackageDimensions(**data: Any) : The dimensions of this product for shipping purposes

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

height: float | None : Height, in inches

length: float | None : Length, in inches

model_config : The type of the None singleton.

weight: float | None : Weight, in ounces

width: float | None : Width, in inches

ProductDeletedResponse(**data: Any) : ProductDeletedResponse type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

deleted: bool | None : The type of the None singleton.

id: str | None : The type of the None singleton.

model_config : The type of the None singleton.

object_: str | None : The type of the None singleton.

ProductFeaturesItem(**data: Any) : Nested schema for Product.features_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

name: str | None : The feature name

ProductList(**data: Any) : ProductList type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

data: list[airbyte_agent_sdk.connectors.stripe.models.Product] | None : The type of the None singleton.

has_more: bool | None : The type of the None singleton.

model_config : The type of the None singleton.

object_: str | None : The type of the None singleton.

url: str | None : The type of the None singleton.

ProductMarketingFeaturesItem(**data: Any) : Nested schema for Product.marketing_features_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

name: str | None : The marketing feature name. Up to 80 characters long

ProductPackageDimensions(**data: Any) : The dimensions of this product for shipping purposes

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

height: float | None : Height, in inches

length: float | None : Length, in inches

model_config : The type of the None singleton.

weight: float | None : Weight, in ounces

width: float | None : Width, in inches

ProductSearchResult(**data: Any) : ProductSearchResult type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

data: list[airbyte_agent_sdk.connectors.stripe.models.Product] | None : The type of the None singleton.

has_more: bool | None : The type of the None singleton.

model_config : The type of the None singleton.

next_page: str | None : The type of the None singleton.

object_: str | None : The type of the None singleton.

url: str | None : The type of the None singleton.

ProductUpdateParams(**data: Any) : ProductUpdateParams type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

active: bool | None : The type of the None singleton.

default_price: str | None : The type of the None singleton.

description: str | None : The type of the None singleton.

images: list[str] | None : The type of the None singleton.

marketing_features: list[airbyte_agent_sdk.connectors.stripe.models.ProductUpdateParamsMarketingFeaturesItem] | None : The type of the None singleton.

metadata: dict[str, str] | None : The type of the None singleton.

model_config : The type of the None singleton.

name: str | None : The type of the None singleton.

package_dimensions: airbyte_agent_sdk.connectors.stripe.models.ProductUpdateParamsPackageDimensions | None : The type of the None singleton.

shippable: bool | None : The type of the None singleton.

statement_descriptor: str | None : The type of the None singleton.

tax_code: str | None : The type of the None singleton.

unit_label: str | None : The type of the None singleton.

url: str | None : The type of the None singleton.

ProductUpdateParamsMarketingFeaturesItem(**data: Any) : Nested schema for ProductUpdateParams.marketing_features_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

name: str | None : The marketing feature name. Up to 80 characters long

ProductUpdateParamsPackageDimensions(**data: Any) : The dimensions of this product for shipping purposes

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

height: float | None : Height, in inches

length: float | None : Length, in inches

model_config : The type of the None singleton.

weight: float | None : Weight, in ounces

width: float | None : Width, in inches

ProductsApiSearchResultMeta(**data: Any) : Metadata for products.Action.API_SEARCH operation

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

has_more: bool | None : The type of the None singleton.

model_config : The type of the None singleton.

ProductsListResultMeta(**data: Any) : Metadata for products.Action.LIST operation

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

has_more: bool | None : The type of the None singleton.

model_config : The type of the None singleton.

Refund(**data: Any) : Refund type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount: int | None : The type of the None singleton.

balance_transaction: str | None : The type of the None singleton.

charge: str | None : The type of the None singleton.

created: int | None : The type of the None singleton.

currency: str | None : The type of the None singleton.

description: str | None : The type of the None singleton.

destination_details: airbyte_agent_sdk.connectors.stripe.models.RefundDestinationDetails | None : The type of the None singleton.

failure_balance_transaction: str | None : The type of the None singleton.

failure_reason: str | None : The type of the None singleton.

id: str | None : The type of the None singleton.

instructions_email: str | None : The type of the None singleton.

metadata: dict[str, str] | None : The type of the None singleton.

model_config : The type of the None singleton.

next_action: airbyte_agent_sdk.connectors.stripe.models.RefundNextAction | None : The type of the None singleton.

object_: str | None : The type of the None singleton.

payment_intent: str | None : The type of the None singleton.

pending_reason: str | None : The type of the None singleton.

reason: str | None : The type of the None singleton.

receipt_number: str | None : The type of the None singleton.

source_transfer_reversal: str | None : The type of the None singleton.

status: str | None : The type of the None singleton.

transfer_reversal: str | None : The type of the None singleton.

RefundCreateParams(**data: Any) : RefundCreateParams type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount: int | None : The type of the None singleton.

charge: str | None : The type of the None singleton.

metadata: dict[str, str] | None : The type of the None singleton.

model_config : The type of the None singleton.

payment_intent: str | None : The type of the None singleton.

reason: str | None : The type of the None singleton.

refund_application_fee: bool | None : The type of the None singleton.

reverse_transfer: bool | None : The type of the None singleton.

RefundDestinationDetails(**data: Any) : Transaction-specific details for the refund

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

affirm: dict[str, typing.Any] | None : If this is a affirm refund, this hash contains the transaction specific details

afterpay_clearpay: dict[str, typing.Any] | None : If this is a afterpay_clearpay refund, this hash contains the transaction specific details

alipay: dict[str, typing.Any] | None : If this is a alipay refund, this hash contains the transaction specific details

alma: dict[str, typing.Any] | None : If this is a alma refund, this hash contains the transaction specific details

amazon_pay: dict[str, typing.Any] | None : If this is a amazon_pay refund, this hash contains the transaction specific details

au_bank_transfer: dict[str, typing.Any] | None : If this is a au_bank_transfer refund, this hash contains the transaction specific details

blik: airbyte_agent_sdk.connectors.stripe.models.RefundDestinationDetailsBlik | None : If this is a blik refund, this hash contains the transaction specific details

br_bank_transfer: airbyte_agent_sdk.connectors.stripe.models.RefundDestinationDetailsBrBankTransfer | None : If this is a br_bank_transfer refund, this hash contains the transaction specific details

card: airbyte_agent_sdk.connectors.stripe.models.RefundDestinationDetailsCard | None : If this is a card refund, this hash contains the transaction specific details

cashapp: dict[str, typing.Any] | None : If this is a cashapp refund, this hash contains the transaction specific details

crypto: airbyte_agent_sdk.connectors.stripe.models.RefundDestinationDetailsCrypto | None : If this is a crypto refund, this hash contains the transaction specific details

customer_cash_balance: dict[str, typing.Any] | None : If this is a customer_cash_balance refund, this hash contains the transaction specific details

eps: dict[str, typing.Any] | None : If this is a eps refund, this hash contains the transaction specific details

eu_bank_transfer: airbyte_agent_sdk.connectors.stripe.models.RefundDestinationDetailsEuBankTransfer | None : If this is a eu_bank_transfer refund, this hash contains the transaction specific details

gb_bank_transfer: airbyte_agent_sdk.connectors.stripe.models.RefundDestinationDetailsGbBankTransfer | None : If this is a gb_bank_transfer refund, this hash contains the transaction specific details

giropay: dict[str, typing.Any] | None : If this is a giropay refund, this hash contains the transaction specific details

grabpay: dict[str, typing.Any] | None : If this is a grabpay refund, this hash contains the transaction specific details

jp_bank_transfer: airbyte_agent_sdk.connectors.stripe.models.RefundDestinationDetailsJpBankTransfer | None : If this is a jp_bank_transfer refund, this hash contains the transaction specific details

klarna: dict[str, typing.Any] | None : If this is a klarna refund, this hash contains the transaction specific details

mb_way: airbyte_agent_sdk.connectors.stripe.models.RefundDestinationDetailsMbWay | None : If this is a mb_way refund, this hash contains the transaction specific details

model_config : The type of the None singleton.

multibanco: airbyte_agent_sdk.connectors.stripe.models.RefundDestinationDetailsMultibanco | None : If this is a multibanco refund, this hash contains the transaction specific details

mx_bank_transfer: airbyte_agent_sdk.connectors.stripe.models.RefundDestinationDetailsMxBankTransfer | None : If this is a mx_bank_transfer refund, this hash contains the transaction specific details

nz_bank_transfer: dict[str, typing.Any] | None : If this is a nz_bank_transfer refund, this hash contains the transaction specific details

p24: airbyte_agent_sdk.connectors.stripe.models.RefundDestinationDetailsP24 | None : If this is a p24 refund, this hash contains the transaction specific details

paynow: dict[str, typing.Any] | None : If this is a paynow refund, this hash contains the transaction specific details

paypal: airbyte_agent_sdk.connectors.stripe.models.RefundDestinationDetailsPaypal | None : If this is a paypal refund, this hash contains the transaction specific details

pix: dict[str, typing.Any] | None : If this is a pix refund, this hash contains the transaction specific details

revolut: dict[str, typing.Any] | None : If this is a revolut refund, this hash contains the transaction specific details

sofort: dict[str, typing.Any] | None : If this is a sofort refund, this hash contains the transaction specific details

swish: airbyte_agent_sdk.connectors.stripe.models.RefundDestinationDetailsSwish | None : If this is a swish refund, this hash contains the transaction specific details

th_bank_transfer: airbyte_agent_sdk.connectors.stripe.models.RefundDestinationDetailsThBankTransfer | None : If this is a th_bank_transfer refund, this hash contains the transaction specific details

twint: dict[str, typing.Any] | None : If this is a twint refund, this hash contains the transaction specific details

type_: str | None : The type of transaction-specific details of the payment method used in the refund

us_bank_transfer: airbyte_agent_sdk.connectors.stripe.models.RefundDestinationDetailsUsBankTransfer | None : If this is a us_bank_transfer refund, this hash contains the transaction specific details

wechat_pay: dict[str, typing.Any] | None : If this is a wechat_pay refund, this hash contains the transaction specific details

zip: dict[str, typing.Any] | None : If this is a zip refund, this hash contains the transaction specific details

RefundDestinationDetailsBlik(**data: Any) : If this is a blik refund, this hash contains the transaction specific details

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

network_decline_code: str | None : For refunds declined by the network, a decline code provided by the network

reference: str | None : The reference assigned to the refund

reference_status: str | None : Status of the reference on the refund

RefundDestinationDetailsBrBankTransfer(**data: Any) : If this is a br_bank_transfer refund, this hash contains the transaction specific details

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

reference: str | None : The reference assigned to the refund

reference_status: str | None : Status of the reference on the refund

RefundDestinationDetailsCard(**data: Any) : If this is a card refund, this hash contains the transaction specific details

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

reference: str | None : Value of the reference number assigned to the refund

reference_status: str | None : Status of the reference number on the refund

reference_type: str | None : Type of the reference number assigned to the refund

type_: str | None : The type of refund

RefundDestinationDetailsCrypto(**data: Any) : If this is a crypto refund, this hash contains the transaction specific details

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

reference: str | None : The transaction hash of the refund

RefundDestinationDetailsEuBankTransfer(**data: Any) : If this is a eu_bank_transfer refund, this hash contains the transaction specific details

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

reference: str | None : The reference assigned to the refund

reference_status: str | None : Status of the reference on the refund

RefundDestinationDetailsGbBankTransfer(**data: Any) : If this is a gb_bank_transfer refund, this hash contains the transaction specific details

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

reference: str | None : The reference assigned to the refund

reference_status: str | None : Status of the reference on the refund

RefundDestinationDetailsJpBankTransfer(**data: Any) : If this is a jp_bank_transfer refund, this hash contains the transaction specific details

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

reference: str | None : The reference assigned to the refund

reference_status: str | None : Status of the reference on the refund

RefundDestinationDetailsMbWay(**data: Any) : If this is a mb_way refund, this hash contains the transaction specific details

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

reference: str | None : The reference assigned to the refund

reference_status: str | None : Status of the reference on the refund

RefundDestinationDetailsMultibanco(**data: Any) : If this is a multibanco refund, this hash contains the transaction specific details

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

reference: str | None : The reference assigned to the refund

reference_status: str | None : Status of the reference on the refund

RefundDestinationDetailsMxBankTransfer(**data: Any) : If this is a mx_bank_transfer refund, this hash contains the transaction specific details

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

reference: str | None : The reference assigned to the refund

reference_status: str | None : Status of the reference on the refund

RefundDestinationDetailsP24(**data: Any) : If this is a p24 refund, this hash contains the transaction specific details

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

reference: str | None : The reference assigned to the refund

reference_status: str | None : Status of the reference on the refund

RefundDestinationDetailsPaypal(**data: Any) : If this is a paypal refund, this hash contains the transaction specific details

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

network_decline_code: str | None : For refunds declined by the network, a decline code provided by the network

RefundDestinationDetailsSwish(**data: Any) : If this is a swish refund, this hash contains the transaction specific details

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

network_decline_code: str | None : For refunds declined by the network, a decline code provided by the network

reference: str | None : The reference assigned to the refund

reference_status: str | None : Status of the reference on the refund

RefundDestinationDetailsThBankTransfer(**data: Any) : If this is a th_bank_transfer refund, this hash contains the transaction specific details

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

reference: str | None : The reference assigned to the refund

reference_status: str | None : Status of the reference on the refund

RefundDestinationDetailsUsBankTransfer(**data: Any) : If this is a us_bank_transfer refund, this hash contains the transaction specific details

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

reference: str | None : The reference assigned to the refund

reference_status: str | None : Status of the reference on the refund

RefundList(**data: Any) : RefundList type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

count: int | None : The type of the None singleton.

data: list[airbyte_agent_sdk.connectors.stripe.models.Refund] | None : The type of the None singleton.

has_more: bool | None : The type of the None singleton.

model_config : The type of the None singleton.

object_: str | None : The type of the None singleton.

url: str | None : The type of the None singleton.

RefundNextAction(**data: Any) : If the refund has a status of requires_action, this property describes what the refund needs to continue processing

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

display_details: airbyte_agent_sdk.connectors.stripe.models.RefundNextActionDisplayDetails | None : Contains the refund details

model_config : The type of the None singleton.

type_: str | None : Type of the next action to perform

RefundNextActionDisplayDetails(**data: Any) : Contains the refund details

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

email_sent: airbyte_agent_sdk.connectors.stripe.models.RefundNextActionDisplayDetailsEmailSent | None : Contains information about the email sent to the customer

expires_at: int | None : The expiry timestamp

model_config : The type of the None singleton.

RefundNextActionDisplayDetailsEmailSent(**data: Any) : Contains information about the email sent to the customer

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

email_sent_at: int | None : The timestamp when the email was sent

email_sent_to: str | None : The recipient's email address

model_config : The type of the None singleton.

RefundsListResultMeta(**data: Any) : Metadata for refunds.Action.LIST operation

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

has_more: bool | None : The type of the None singleton.

model_config : The type of the None singleton.

RefundsSearchData(**data: Any) : Search result data for refunds entity.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount: int | None : Amount refunded, in cents (the smallest currency unit).

balance_transaction: str | None : ID of the balance transaction that describes the impact of this refund on your account balance.

charge: str | None : ID of the charge that was refunded.

created: int | None : Timestamp indicating when the refund was created.

currency: str | None : Three-letter ISO currency code in lowercase representing the currency of the refund.

destination_details: dict[str, typing.Any] | None : Details about the destination where the refunded funds should be sent.

id: str | None : Unique identifier for the refund object.

metadata: dict[str, typing.Any] | None : Set of key-value pairs that you can attach to an object for storing additional structured information.

model_config : The type of the None singleton.

object_: str | None : String representing the object type, always 'refund'.

payment_intent: str | None : ID of the PaymentIntent that was refunded.

reason: str | None : Reason for the refund, either user-provided (duplicate, fraudulent, or requested_by_customer) or generated by Stripe internally (expired_uncaptured_charge).

receipt_number: str | None : The transaction number that appears on email receipts sent for this refund.

source_transfer_reversal: str | None : ID of the transfer reversal that was created as a result of refunding a transfer (Connect only).

status: str | None : Status of the refund (pending, requires_action, succeeded, failed, or canceled).

transfer_reversal: str | None : ID of the reversal of the transfer that funded the charge being refunded (Connect only).

updated: int | None : Timestamp indicating when the refund was last updated.

StripeAuthConfig(**data: Any) : API Key Authentication

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

api_key: str : Your Stripe API Key (starts with sk_test_ or sk_live_)

model_config : The type of the None singleton.

StripeCheckResult(**data: Any) : Result of a health check operation.

Returned by the check() method to indicate connectivity and credential status.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

checked_action: str | None : Action name used for the health check.

checked_entity: str | None : Entity name used for the health check.

error: str | None : Error message if status is 'unhealthy', None otherwise.

model_config : The type of the None singleton.

status: str : Health check status: 'healthy' or 'unhealthy'.

StripeExecuteResult(**data: Any) : Response envelope with data only.

Used for actions that return data without metadata.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel
• typing.Generic

Descendants

• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResult[ChargeSearchResult]
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResult[InvoiceSearchResult]
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResult[SubscriptionSearchResult]

Class variables

data: ~T : Response data containing the result of the action.

model_config : The type of the None singleton.

StripeExecuteResultWithMeta(**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Descendants

• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta[list[BalanceTransaction], BalanceTransactionsListResultMeta]
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta[list[Charge], ChargesListResultMeta]
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta[list[Customer], CustomersApiSearchResultMeta]
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta[list[Customer], CustomersListResultMeta]
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta[list[Dispute], DisputesListResultMeta]
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta[list[Invoice], InvoicesListResultMeta]
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta[list[PaymentIntent], PaymentIntentsApiSearchResultMeta]
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta[list[PaymentIntent], PaymentIntentsListResultMeta]
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta[list[Payout], PayoutsListResultMeta]
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta[list[Product], ProductsApiSearchResultMeta]
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta[list[Product], ProductsListResultMeta]
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta[list[Refund], RefundsListResultMeta]
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta[list[Subscription], SubscriptionsListResultMeta]

Class variables

meta: ~S : Metadata about the response (e.g., pagination cursors, record counts).

StripeExecuteResultWithMeta[list[BalanceTransaction], BalanceTransactionsListResultMeta](**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

BalanceTransactionsListResult(**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResult
• pydantic.main.BaseModel
• typing.Generic

StripeExecuteResultWithMeta[list[Charge], ChargesListResultMeta](**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

ChargesListResult(**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResult
• pydantic.main.BaseModel
• typing.Generic

StripeExecuteResultWithMeta[list[Customer], CustomersApiSearchResultMeta](**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

CustomersApiSearchResult(**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResult
• pydantic.main.BaseModel
• typing.Generic

StripeExecuteResultWithMeta[list[Customer], CustomersListResultMeta](**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

CustomersListResult(**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResult
• pydantic.main.BaseModel
• typing.Generic

StripeExecuteResultWithMeta[list[Dispute], DisputesListResultMeta](**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

DisputesListResult(**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResult
• pydantic.main.BaseModel
• typing.Generic

StripeExecuteResultWithMeta[list[Invoice], InvoicesListResultMeta](**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

InvoicesListResult(**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResult
• pydantic.main.BaseModel
• typing.Generic

StripeExecuteResultWithMeta[list[PaymentIntent], PaymentIntentsApiSearchResultMeta](**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

PaymentIntentsApiSearchResult(**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResult
• pydantic.main.BaseModel
• typing.Generic

StripeExecuteResultWithMeta[list[PaymentIntent], PaymentIntentsListResultMeta](**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

PaymentIntentsListResult(**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResult
• pydantic.main.BaseModel
• typing.Generic

StripeExecuteResultWithMeta[list[Payout], PayoutsListResultMeta](**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

PayoutsListResult(**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResult
• pydantic.main.BaseModel
• typing.Generic

StripeExecuteResultWithMeta[list[Product], ProductsApiSearchResultMeta](**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

ProductsApiSearchResult(**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResult
• pydantic.main.BaseModel
• typing.Generic

StripeExecuteResultWithMeta[list[Product], ProductsListResultMeta](**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

ProductsListResult(**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResult
• pydantic.main.BaseModel
• typing.Generic

StripeExecuteResultWithMeta[list[Refund], RefundsListResultMeta](**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

RefundsListResult(**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResult
• pydantic.main.BaseModel
• typing.Generic

StripeExecuteResultWithMeta[list[Subscription], SubscriptionsListResultMeta](**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

SubscriptionsListResult(**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResultWithMeta
• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResult
• pydantic.main.BaseModel
• typing.Generic

StripeExecuteResult[ChargeSearchResult](**data: Any) : Response envelope with data only.

Used for actions that return data without metadata.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

ChargesApiSearchResult(**data: Any) : Response envelope with data only.

Used for actions that return data without metadata.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResult
• pydantic.main.BaseModel
• typing.Generic

StripeExecuteResult[InvoiceSearchResult](**data: Any) : Response envelope with data only.

Used for actions that return data without metadata.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

InvoicesApiSearchResult(**data: Any) : Response envelope with data only.

Used for actions that return data without metadata.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResult
• pydantic.main.BaseModel
• typing.Generic

StripeExecuteResult[SubscriptionSearchResult](**data: Any) : Response envelope with data only.

Used for actions that return data without metadata.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

SubscriptionsApiSearchResult(**data: Any) : Response envelope with data only.

Used for actions that return data without metadata.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.stripe.models.StripeExecuteResult
• pydantic.main.BaseModel
• typing.Generic

StripeReplicationConfig(**data: Any) : Replication Configuration - Settings for data replication from Stripe.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

account_id: str : Your Stripe account ID (starts with 'acct_', find yours at https://dashboard.stripe.com/settings/account)

model_config : The type of the None singleton.

Subscription(**data: Any) : Subscription type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

application: str | None : The type of the None singleton.

application_fee_percent: float | None : The type of the None singleton.

automatic_tax: airbyte_agent_sdk.connectors.stripe.models.SubscriptionAutomaticTax | None : The type of the None singleton.

billing_cycle_anchor: int | None : The type of the None singleton.

billing_cycle_anchor_config: airbyte_agent_sdk.connectors.stripe.models.SubscriptionBillingCycleAnchorConfig | None : The type of the None singleton.

billing_mode: airbyte_agent_sdk.connectors.stripe.models.SubscriptionBillingMode | None : The type of the None singleton.

billing_thresholds: airbyte_agent_sdk.connectors.stripe.models.SubscriptionBillingThresholds | None : The type of the None singleton.

cancel_at: int | None : The type of the None singleton.

cancel_at_period_end: bool | None : The type of the None singleton.

canceled_at: int | None : The type of the None singleton.

cancellation_details: airbyte_agent_sdk.connectors.stripe.models.SubscriptionCancellationDetails | None : The type of the None singleton.

collection_method: str | None : The type of the None singleton.

created: int | None : The type of the None singleton.

currency: str | None : The type of the None singleton.

current_period_end: int | None : The type of the None singleton.

current_period_start: int | None : The type of the None singleton.

customer: str | None : The type of the None singleton.

customer_account: str | None : The type of the None singleton.

days_until_due: int | None : The type of the None singleton.

default_payment_method: str | None : The type of the None singleton.

default_source: str | None : The type of the None singleton.

default_tax_rates: list[airbyte_agent_sdk.connectors.stripe.models.SubscriptionDefaultTaxRatesItem] | None : The type of the None singleton.

description: str | None : The type of the None singleton.

discount: dict[str, typing.Any] | None : The type of the None singleton.

discounts: list[str] | None : The type of the None singleton.

ended_at: int | None : The type of the None singleton.

id: str | None : The type of the None singleton.

invoice_settings: airbyte_agent_sdk.connectors.stripe.models.SubscriptionInvoiceSettings | None : The type of the None singleton.

items: airbyte_agent_sdk.connectors.stripe.models.SubscriptionItems | None : The type of the None singleton.

latest_invoice: str | None : The type of the None singleton.

livemode: bool | None : The type of the None singleton.

metadata: dict[str, str] | None : The type of the None singleton.

model_config : The type of the None singleton.

next_pending_invoice_item_invoice: int | None : The type of the None singleton.

object_: str | None : The type of the None singleton.

on_behalf_of: str | None : The type of the None singleton.

pause_collection: airbyte_agent_sdk.connectors.stripe.models.SubscriptionPauseCollection | None : The type of the None singleton.

payment_settings: airbyte_agent_sdk.connectors.stripe.models.SubscriptionPaymentSettings | None : The type of the None singleton.

pending_invoice_item_interval: dict[str, typing.Any] | None : The type of the None singleton.

pending_setup_intent: str | None : The type of the None singleton.

pending_update: dict[str, typing.Any] | None : The type of the None singleton.

plan: dict[str, typing.Any] | None : The type of the None singleton.

quantity: int | None : The type of the None singleton.

schedule: str | None : The type of the None singleton.

start_date: int | None : The type of the None singleton.

status: str | None : The type of the None singleton.

test_clock: str | None : The type of the None singleton.

transfer_data: dict[str, typing.Any] | None : The type of the None singleton.

trial_end: int | None : The type of the None singleton.

trial_settings: airbyte_agent_sdk.connectors.stripe.models.SubscriptionTrialSettings | None : The type of the None singleton.

trial_start: int | None : The type of the None singleton.

SubscriptionAutomaticTax(**data: Any) : Automatic tax settings for this subscription

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

disabled_reason: str | None : If Stripe disabled automatic tax, this enum describes why

enabled: bool | None : Whether Stripe automatically computes tax on this subscription

liability: airbyte_agent_sdk.connectors.stripe.models.SubscriptionAutomaticTaxLiability | None : The account that's liable for tax

model_config : The type of the None singleton.

SubscriptionAutomaticTaxLiability(**data: Any) : The account that's liable for tax

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

account: str | None : The connected account being referenced when type is account

model_config : The type of the None singleton.

type_: str | None : Type of the account referenced

SubscriptionBillingCycleAnchorConfig(**data: Any) : The fixed values used to calculate the billing_cycle_anchor

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

day_of_month: int | None : The day of the month of the billing_cycle_anchor

hour: int | None : The hour of the day of the billing_cycle_anchor

minute: int | None : The minute of the hour of the billing_cycle_anchor

model_config : The type of the None singleton.

month: int | None : The month to start full cycle billing periods

second: int | None : The second of the minute of the billing_cycle_anchor

SubscriptionBillingMode(**data: Any) : Controls how prorations and invoices for subscriptions are calculated and orchestrated

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

flexible: airbyte_agent_sdk.connectors.stripe.models.SubscriptionBillingModeFlexible | None : Configure behavior for flexible billing mode

model_config : The type of the None singleton.

type_: str | None : Controls how prorations and invoices for subscriptions are calculated and orchestrated

updated_at: int | None : Details on when the current billing_mode was adopted

SubscriptionBillingModeFlexible(**data: Any) : Configure behavior for flexible billing mode

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

proration_discounts: str | None : Controls how invoices and invoice items display proration amounts and discount amounts

SubscriptionBillingThresholds(**data: Any) : Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount_gte: int | None : Monetary threshold that triggers the subscription to create an invoice

model_config : The type of the None singleton.

reset_billing_cycle_anchor: bool | None : Indicates if the billing_cycle_anchor should be reset when a threshold is reached

SubscriptionCancellationDetails(**data: Any) : Details about why this subscription was cancelled

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

comment: str | None : Additional comments about why the user canceled the subscription

feedback: str | None : The customer submitted reason for why they canceled

model_config : The type of the None singleton.

reason: str | None : Why this subscription was canceled

SubscriptionCreateParams(**data: Any) : SubscriptionCreateParams type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

cancel_at_period_end: bool | None : The type of the None singleton.

collection_method: str | None : The type of the None singleton.

currency: str | None : The type of the None singleton.

customer: str : The type of the None singleton.

days_until_due: int | None : The type of the None singleton.

default_payment_method: str | None : The type of the None singleton.

description: str | None : The type of the None singleton.

items: list[airbyte_agent_sdk.connectors.stripe.models.SubscriptionCreateParamsItemsItem] | None : The type of the None singleton.

metadata: dict[str, str] | None : The type of the None singleton.

model_config : The type of the None singleton.

trial_period_days: int | None : The type of the None singleton.

SubscriptionCreateParamsItemsItem(**data: Any) : Nested schema for SubscriptionCreateParams.items_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

price: str | None : The ID of the price object

quantity: int | None : The quantity you'd like to apply to the subscription item

SubscriptionDefaultTaxRatesItem(**data: Any) : Nested schema for Subscription.default_tax_rates_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

active: bool | None : Defaults to true

country: str | None : Two-letter country code (ISO 3166-1 alpha-2)

created: int | None : Time at which the object was created

description: str | None : An arbitrary string attached to the tax rate for your internal use only

display_name: str | None : The display name of the tax rates

effective_percentage: float | None : Actual/effective tax rate percentage out of 100

flat_amount: airbyte_agent_sdk.connectors.stripe.models.SubscriptionDefaultTaxRatesItemFlatAmount | None : The amount of the tax rate when the rate_type is flat_amount

id: str | None : Unique identifier for the object

inclusive: bool | None : This specifies if the tax rate is inclusive or exclusive

jurisdiction: str | None : The jurisdiction for the tax rate

jurisdiction_level: str | None : The level of the jurisdiction that imposes this tax rate

livemode: bool | None : Has the value true if the object exists in live mode or false if in test mode

metadata: dict[str, str] | None : Set of key-value pairs

model_config : The type of the None singleton.

object_: str | None : String representing the object's type

percentage: float | None : Tax rate percentage out of 100

rate_type: str | None : Indicates the type of tax rate applied to the taxable amount

state: str | None : ISO 3166-2 subdivision code, without country prefix

tax_type: str | None : The high-level tax type

SubscriptionDefaultTaxRatesItemFlatAmount(**data: Any) : The amount of the tax rate when the rate_type is flat_amount

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount: int | None : Amount of the tax when the rate_type is flat_amount

currency: str | None : Three-letter ISO currency code, in lowercase

model_config : The type of the None singleton.

SubscriptionInvoiceSettings(**data: Any) : All invoices will be billed using the specified settings

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

account_tax_ids: list[str] | None : The account tax IDs associated with the subscription

issuer: airbyte_agent_sdk.connectors.stripe.models.SubscriptionInvoiceSettingsIssuer | None : The connected account that issues the invoice

model_config : The type of the None singleton.

SubscriptionInvoiceSettingsIssuer(**data: Any) : The connected account that issues the invoice

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

account: str | None : The connected account being referenced when type is account

model_config : The type of the None singleton.

type_: str | None : Type of the account referenced

SubscriptionItems(**data: Any) : List of subscription items, each with an attached price

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

data: list[airbyte_agent_sdk.connectors.stripe.models.SubscriptionItemsDataItem] | None : Details about each object

has_more: bool | None : True if this list has another page of items after this one

model_config : The type of the None singleton.

object_: str | None : String representing the object's type

total_count: int | None : The total count of items in the list

url: str | None : The URL where this list can be accessed

SubscriptionItemsDataItem(**data: Any) : Nested schema for SubscriptionItems.data_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

billing_thresholds: airbyte_agent_sdk.connectors.stripe.models.SubscriptionItemsDataItemBillingThresholds | None : Define thresholds at which an invoice will be sent

created: int | None : Time at which the object was created

current_period_end: int | None : The end time of this subscription item's current billing period

current_period_start: int | None : The start time of this subscription item's current billing period

discounts: list[str] | None : The discounts applied to the subscription item

id: str | None : Unique identifier for the object

metadata: dict[str, str] | None : Set of key-value pairs

model_config : The type of the None singleton.

object_: str | None : String representing the object's type

plan: dict[str, typing.Any] | None : The plan the customer is subscribed to (deprecated, use price instead)

price: dict[str, typing.Any] | None : The price the customer is subscribed to

quantity: int | None : The quantity of the plan to which the customer should be subscribed

subscription: str | None : The subscription this subscription_item belongs to

tax_rates: list[dict[str, typing.Any]] | None : The tax rates which apply to this subscription_item

SubscriptionItemsDataItemBillingThresholds(**data: Any) : Define thresholds at which an invoice will be sent

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

usage_gte: int | None : Usage threshold that triggers the subscription to create an invoice

SubscriptionList(**data: Any) : SubscriptionList type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

data: list[airbyte_agent_sdk.connectors.stripe.models.Subscription] | None : The type of the None singleton.

has_more: bool | None : The type of the None singleton.

model_config : The type of the None singleton.

object_: str | None : The type of the None singleton.

url: str | None : The type of the None singleton.

SubscriptionPauseCollection(**data: Any) : If specified, payment collection for this subscription will be paused

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

behavior: str | None : The payment collection behavior for this subscription while paused

model_config : The type of the None singleton.

resumes_at: int | None : The time after which the subscription will resume collecting payments

SubscriptionPaymentSettings(**data: Any) : Payment settings passed on to invoices created by the subscription

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

payment_method_options: dict[str, typing.Any] | None : Payment-method-specific configuration to provide to invoices

payment_method_types: list[str] | None : The list of payment method types to provide to every invoice

SubscriptionSearchResult(**data: Any) : SubscriptionSearchResult type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

data: list[airbyte_agent_sdk.connectors.stripe.models.Subscription] | None : The type of the None singleton.

has_more: bool | None : The type of the None singleton.

model_config : The type of the None singleton.

next_page: str | None : The type of the None singleton.

object_: str | None : The type of the None singleton.

url: str | None : The type of the None singleton.

SubscriptionTrialSettings(**data: Any) : Settings related to subscription trials

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

end_behavior: airbyte_agent_sdk.connectors.stripe.models.SubscriptionTrialSettingsEndBehavior | None : The type of the None singleton.

model_config : The type of the None singleton.

SubscriptionTrialSettingsEndBehavior(**data: Any) : Nested schema for SubscriptionTrialSettings.end_behavior

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

missing_payment_method: str | None : Behavior when the trial ends and payment method is missing

model_config : The type of the None singleton.

SubscriptionUpdateParams(**data: Any) : SubscriptionUpdateParams type definition

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

cancel_at_period_end: bool | None : The type of the None singleton.

collection_method: str | None : The type of the None singleton.

days_until_due: int | None : The type of the None singleton.

default_payment_method: str | None : The type of the None singleton.

description: str | None : The type of the None singleton.

items: list[airbyte_agent_sdk.connectors.stripe.models.SubscriptionUpdateParamsItemsItem] | None : The type of the None singleton.

metadata: dict[str, str] | None : The type of the None singleton.

model_config : The type of the None singleton.

proration_behavior: str | None : The type of the None singleton.

SubscriptionUpdateParamsItemsItem(**data: Any) : Nested schema for SubscriptionUpdateParams.items_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

deleted: bool | None : A flag that, if set to true, will delete the specified item

id: str | None : Subscription item to update

model_config : The type of the None singleton.

price: str | None : The ID of the price object

quantity: int | None : The quantity you'd like to apply to the subscription item

SubscriptionsListResultMeta(**data: Any) : Metadata for subscriptions.Action.LIST operation

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

has_more: bool | None : The type of the None singleton.

model_config : The type of the None singleton.

SubscriptionsSearchData(**data: Any) : Search result data for subscriptions entity.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

application: str | None : For Connect platforms, the application associated with the subscription.

application_fee_percent: float | None : For Connect platforms, the percentage of the subscription amount taken as an application fee.

automatic_tax: dict[str, typing.Any] | None : Automatic tax calculation settings for the subscription.

billing: str | None : Billing mode configuration for the subscription.

billing_cycle_anchor: float | None : Timestamp determining when the billing cycle for the subscription starts.

billing_cycle_anchor_config: dict[str, typing.Any] | None : Configuration for the subscription's billing cycle anchor behavior.

billing_thresholds: dict[str, typing.Any] | None : Defines thresholds at which an invoice will be sent, controlling billing timing based on usage.

cancel_at: float | None : Timestamp indicating when the subscription is scheduled to be canceled.

cancel_at_period_end: bool | None : Boolean indicating whether the subscription will be canceled at the end of the current billing period.

canceled_at: float | None : Timestamp indicating when the subscription was canceled, if applicable.

cancellation_details: dict[str, typing.Any] | None : Details about why and how the subscription was canceled.

collection_method: str | None : How invoices are collected (charge_automatically or send_invoice).

created: int | None : Timestamp indicating when the subscription was created.

currency: str | None : Three-letter ISO currency code in lowercase indicating the currency for the subscription.

current_period_end: float | None : Timestamp marking the end of the current billing period.

current_period_start: int | None : Timestamp marking the start of the current billing period.

customer: str | None : ID of the customer who owns the subscription, expandable to full customer object.

days_until_due: int | None : Number of days until the invoice is due for subscriptions using send_invoice collection method.

default_payment_method: str | None : ID of the default payment method for the subscription, taking precedence over default_source.

default_source: str | None : ID of the default payment source for the subscription.

default_tax_rates: list[typing.Any] | None : Tax rates that apply to the subscription by default.

description: str | None : Human-readable description of the subscription, displayable to the customer.

discount: dict[str, typing.Any] | None : Describes any discount currently applied to the subscription.

ended_at: float | None : Timestamp indicating when the subscription ended, if applicable.

id: str | None : Unique identifier for the subscription object.

invoice_settings: dict[str, typing.Any] | None : Settings for invoices generated by this subscription, such as custom fields and footer.

is_deleted: bool | None : Indicates whether the subscription has been deleted.

items: dict[str, typing.Any] | None : List of subscription items, each with an attached price defining what the customer is subscribed to.

latest_invoice: str | None : The most recent invoice this subscription has generated, expandable to full invoice object.

livemode: bool | None : Indicates whether the subscription exists in live mode (true) or test mode (false).

metadata: dict[str, typing.Any] | None : Set of key-value pairs that you can attach to the subscription for storing additional structured information.

model_config : The type of the None singleton.

next_pending_invoice_item_invoice: int | None : Timestamp when the next invoice for pending invoice items will be created.

object_: str | None : String representing the object type, always 'subscription'.

on_behalf_of: str | None : For Connect platforms, the account for which the subscription is being created or managed.

pause_collection: dict[str, typing.Any] | None : Configuration for pausing collection on the subscription while retaining the subscription structure.

payment_settings: dict[str, typing.Any] | None : Payment settings for invoices generated by this subscription.

pending_invoice_item_interval: dict[str, typing.Any] | None : Specifies an interval for aggregating usage records into pending invoice items.

pending_setup_intent: str | None : SetupIntent used for collecting user authentication when updating payment methods without immediate payment.

pending_update: dict[str, typing.Any] | None : If specified, pending updates that will be applied to the subscription once the latest_invoice has been paid.

plan: dict[str, typing.Any] | None : The plan associated with the subscription (deprecated, use items instead).

quantity: int | None : Quantity of the plan subscribed to (deprecated, use items instead).

schedule: str | None : ID of the subscription schedule managing this subscription's lifecycle, if applicable.

start_date: int | None : Timestamp indicating when the subscription started.

status: str | None : Current status of the subscription (incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, or paused).

tax_percent: float | None : The percentage of tax applied to the subscription (deprecated, use default_tax_rates instead).

test_clock: str | None : ID of the test clock associated with this subscription for simulating time-based scenarios.

transfer_data: dict[str, typing.Any] | None : For Connect platforms, the account receiving funds from the subscription and optional percentage transferred.

trial_end: float | None : Timestamp indicating when the trial period ends, if applicable.

trial_settings: dict[str, typing.Any] | None : Settings related to trial periods, including conditions for ending trials.

trial_start: int | None : Timestamp indicating when the trial period began, if applicable.

updated: int | None : Timestamp indicating when the subscription was last updated.