airbyte-agent-stripe 0.5.28__py3-none-any.whl → 0.5.37__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (21) hide show
  1. airbyte_agent_stripe/__init__.py +103 -83
  2. airbyte_agent_stripe/_vendored/connector_sdk/connector_model_loader.py +10 -2
  3. airbyte_agent_stripe/_vendored/connector_sdk/constants.py +1 -1
  4. airbyte_agent_stripe/_vendored/connector_sdk/executor/local_executor.py +54 -4
  5. airbyte_agent_stripe/_vendored/connector_sdk/extensions.py +42 -3
  6. airbyte_agent_stripe/_vendored/connector_sdk/introspection.py +262 -0
  7. airbyte_agent_stripe/_vendored/connector_sdk/observability/config.py +179 -0
  8. airbyte_agent_stripe/_vendored/connector_sdk/observability/session.py +35 -28
  9. airbyte_agent_stripe/_vendored/connector_sdk/schema/components.py +2 -1
  10. airbyte_agent_stripe/_vendored/connector_sdk/schema/operations.py +1 -1
  11. airbyte_agent_stripe/_vendored/connector_sdk/schema/security.py +10 -0
  12. airbyte_agent_stripe/_vendored/connector_sdk/telemetry/events.py +2 -1
  13. airbyte_agent_stripe/_vendored/connector_sdk/telemetry/tracker.py +3 -0
  14. airbyte_agent_stripe/_vendored/connector_sdk/types.py +5 -1
  15. airbyte_agent_stripe/connector.py +379 -61
  16. airbyte_agent_stripe/connector_model.py +3444 -692
  17. airbyte_agent_stripe/models.py +926 -766
  18. airbyte_agent_stripe/types.py +41 -13
  19. {airbyte_agent_stripe-0.5.28.dist-info → airbyte_agent_stripe-0.5.37.dist-info}/METADATA +12 -16
  20. {airbyte_agent_stripe-0.5.28.dist-info → airbyte_agent_stripe-0.5.37.dist-info}/RECORD +21 -19
  21. {airbyte_agent_stripe-0.5.28.dist-info → airbyte_agent_stripe-0.5.37.dist-info}/WHEEL +0 -0
airbyte_agent_stripe/connector_model.py CHANGED
@@ -12,6 +12,7 @@ from ._vendored.connector_sdk.types import (
12
12
  AuthConfig,
13
13
  AuthType,
14
14
  ConnectorModel,
15
+ ContentType,
15
16
  EndpointDefinition,
16
17
  EntityDefinition,
17
18
  )
@@ -26,7 +27,7 @@ from uuid import (
26
27
  StripeConnectorModel: ConnectorModel = ConnectorModel(
27
28
  id=UUID('e094cb9a-26de-4645-8761-65c0c425d1de'),
28
29
  name='stripe',
29
- version='0.1.3',
30
+ version='0.1.4',
30
31
  base_url='https://api.stripe.com',
31
32
  auth=AuthConfig(
32
33
  type=AuthType.BEARER,
@@ -43,12 +44,20 @@ StripeConnectorModel: ConnectorModel = ConnectorModel(
43
44
  ),
44
45
  },
45
46
  auth_mapping={'token': '${api_key}'},
47
+ replication_auth_key_mapping={'client_secret': 'api_key'},
46
48
  ),
47
49
  ),
48
50
  entities=[
49
51
  EntityDefinition(
50
52
  name='customers',
51
- actions=[Action.LIST, Action.GET, Action.SEARCH],
53
+ actions=[
54
+ Action.LIST,
55
+ Action.CREATE,
56
+ Action.GET,
57
+ Action.UPDATE,
58
+ Action.DELETE,
59
+ Action.API_SEARCH,
60
+ ],
52
61
  endpoints={
53
62
  Action.LIST: EndpointDefinition(
54
63
  method='GET',
@@ -989,14 +998,45 @@ StripeConnectorModel: ConnectorModel = ConnectorModel(
989
998
  record_extractor='$.data',
990
999
  meta_extractor={'has_more': '$.has_more'},
991
1000
  ),
992
- Action.GET: EndpointDefinition(
993
- method='GET',
994
- path='/v1/customers/{id}',
995
- action=Action.GET,
996
- description='Retrieves a Customer object.',
997
- path_params=['id'],
998
- path_params_schema={
999
- 'id': {'type': 'string', 'required': True},
1001
+ Action.CREATE: EndpointDefinition(
1002
+ method='POST',
1003
+ path='/v1/customers',
1004
+ action=Action.CREATE,
1005
+ description='Creates a new customer object.',
1006
+ body_fields=[
1007
+ 'email',
1008
+ 'name',
1009
+ 'description',
1010
+ 'phone',
1011
+ 'address',
1012
+ 'metadata',
1013
+ ],
1014
+ content_type=ContentType.FORM_URLENCODED,
1015
+ request_schema={
1016
+ 'type': 'object',
1017
+ 'properties': {
1018
+ 'email': {'type': 'string', 'description': "Customer's email address"},
1019
+ 'name': {'type': 'string', 'description': "The customer's full name or business name"},
1020
+ 'description': {'type': 'string', 'description': 'An arbitrary string attached to the object'},
1021
+ 'phone': {'type': 'string', 'description': "The customer's phone number"},
1022
+ 'address': {
1023
+ 'type': 'object',
1024
+ 'description': "The customer's address",
1025
+ 'properties': {
1026
+ 'line1': {'type': 'string', 'description': 'Address line 1'},
1027
+ 'line2': {'type': 'string', 'description': 'Address line 2'},
1028
+ 'city': {'type': 'string', 'description': 'City, district, suburb, town, or village'},
1029
+ 'state': {'type': 'string', 'description': 'State, county, province, or region'},
1030
+ 'postal_code': {'type': 'string', 'description': 'ZIP or postal code'},
1031
+ 'country': {'type': 'string', 'description': 'Two-letter country code (ISO 3166-1 alpha-2)'},
1032
+ },
1033
+ },
1034
+ 'metadata': {
1035
+ 'type': 'object',
1036
+ 'description': 'Set of key-value pairs that you can attach to an object',
1037
+ 'additionalProperties': {'type': 'string'},
1038
+ },
1039
+ },
1000
1040
  },
1001
1041
  response_schema={
1002
1042
  'type': 'object',
@@ -1901,594 +1941,2475 @@ StripeConnectorModel: ConnectorModel = ConnectorModel(
1901
1941
  'x-airbyte-entity-name': 'customers',
1902
1942
  },
1903
1943
  ),
1904
- Action.SEARCH: EndpointDefinition(
1944
+ Action.GET: EndpointDefinition(
1905
1945
  method='GET',
1906
- path='/v1/customers/search',
1907
- action=Action.SEARCH,
1908
- description="Search for customers using Stripe's Search Query Language.",
1909
- query_params=['query', 'limit', 'page'],
1910
- query_params_schema={
1911
- 'query': {'type': 'string', 'required': True},
1912
- 'limit': {'type': 'integer', 'required': False},
1913
- 'page': {'type': 'string', 'required': False},
1946
+ path='/v1/customers/{id}',
1947
+ action=Action.GET,
1948
+ description='Retrieves a Customer object.',
1949
+ path_params=['id'],
1950
+ path_params_schema={
1951
+ 'id': {'type': 'string', 'required': True},
1914
1952
  },
1915
1953
  response_schema={
1916
1954
  'type': 'object',
1917
1955
  'properties': {
1956
+ 'id': {'type': 'string', 'description': 'Unique identifier for the customer'},
1918
1957
  'object': {
1919
1958
  'type': 'string',
1920
- 'enum': ['search_result'],
1959
+ 'description': "String representing the object's type",
1960
+ 'enum': ['customer'],
1921
1961
  },
1922
- 'data': {
1923
- 'type': 'array',
1924
- 'items': {
1925
- 'type': 'object',
1926
- 'properties': {
1927
- 'id': {'type': 'string', 'description': 'Unique identifier for the customer'},
1928
- 'object': {
1929
- 'type': 'string',
1930
- 'description': "String representing the object's type",
1931
- 'enum': ['customer'],
1932
- },
1933
- 'address': {
1934
- 'type': ['object', 'null'],
1935
- 'description': "The customer's address",
1936
- 'properties': {
1937
- 'city': {
1938
- 'type': ['string', 'null'],
1939
- 'description': 'City, district, suburb, town, or village',
1940
- },
1941
- 'country': {
1942
- 'type': ['string', 'null'],
1943
- 'description': 'Two-letter country code (ISO 3166-1 alpha-2)',
1944
- },
1945
- 'line1': {
1946
- 'type': ['string', 'null'],
1947
- 'description': 'Address line 1, such as the street, PO Box, or company name',
1948
- },
1949
- 'line2': {
1950
- 'type': ['string', 'null'],
1951
- 'description': 'Address line 2, such as the apartment, suite, unit, or building',
1952
- },
1953
- 'postal_code': {
1954
- 'type': ['string', 'null'],
1955
- 'description': 'ZIP or postal code',
1956
- },
1957
- 'state': {
1958
- 'type': ['string', 'null'],
1959
- 'description': 'State, county, province, or region',
1960
- },
1962
+ 'address': {
1963
+ 'type': ['object', 'null'],
1964
+ 'description': "The customer's address",
1965
+ 'properties': {
1966
+ 'city': {
1967
+ 'type': ['string', 'null'],
1968
+ 'description': 'City, district, suburb, town, or village',
1969
+ },
1970
+ 'country': {
1971
+ 'type': ['string', 'null'],
1972
+ 'description': 'Two-letter country code (ISO 3166-1 alpha-2)',
1973
+ },
1974
+ 'line1': {
1975
+ 'type': ['string', 'null'],
1976
+ 'description': 'Address line 1, such as the street, PO Box, or company name',
1977
+ },
1978
+ 'line2': {
1979
+ 'type': ['string', 'null'],
1980
+ 'description': 'Address line 2, such as the apartment, suite, unit, or building',
1981
+ },
1982
+ 'postal_code': {
1983
+ 'type': ['string', 'null'],
1984
+ 'description': 'ZIP or postal code',
1985
+ },
1986
+ 'state': {
1987
+ 'type': ['string', 'null'],
1988
+ 'description': 'State, county, province, or region',
1989
+ },
1990
+ },
1991
+ },
1992
+ 'balance': {'type': 'integer', 'description': 'The current balance stored on the customer'},
1993
+ 'business_name': {
1994
+ 'type': ['string', 'null'],
1995
+ 'description': "The customer's business name",
1996
+ },
1997
+ 'cash_balance': {
1998
+ 'type': ['object', 'null'],
1999
+ 'description': 'The current funds being held by Stripe on behalf of the customer',
2000
+ 'properties': {
2001
+ 'object': {'type': 'string', 'description': "String representing the object's type"},
2002
+ 'available': {
2003
+ 'type': ['object', 'null'],
2004
+ 'description': 'A hash of all cash balances available to this customer',
2005
+ },
2006
+ 'customer': {'type': 'string', 'description': 'The ID of the customer whose cash balance this object represents'},
2007
+ 'customer_account': {
2008
+ 'type': ['string', 'null'],
2009
+ 'description': 'The ID of the account whose cash balance this object represents',
2010
+ },
2011
+ 'livemode': {'type': 'boolean', 'description': 'Has the value true if the object exists in live mode or false if in test mode'},
2012
+ 'settings': {
2013
+ 'type': 'object',
2014
+ 'description': 'A hash of settings for this cash balance',
2015
+ 'properties': {
2016
+ 'reconciliation_mode': {
2017
+ 'type': 'string',
2018
+ 'enum': ['automatic', 'manual'],
2019
+ 'description': 'The configuration for how funds that land in the customer cash balance are reconciled',
1961
2020
  },
2021
+ 'using_merchant_default': {'type': 'boolean', 'description': "A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance"},
1962
2022
  },
1963
- 'balance': {'type': 'integer', 'description': 'The current balance stored on the customer'},
1964
- 'business_name': {
1965
- 'type': ['string', 'null'],
1966
- 'description': "The customer's business name",
1967
- },
1968
- 'cash_balance': {
1969
- 'type': ['object', 'null'],
1970
- 'description': 'The current funds being held by Stripe on behalf of the customer',
1971
- 'properties': {
1972
- 'object': {'type': 'string', 'description': "String representing the object's type"},
1973
- 'available': {
1974
- 'type': ['object', 'null'],
1975
- 'description': 'A hash of all cash balances available to this customer',
1976
- },
1977
- 'customer': {'type': 'string', 'description': 'The ID of the customer whose cash balance this object represents'},
1978
- 'customer_account': {
1979
- 'type': ['string', 'null'],
1980
- 'description': 'The ID of the account whose cash balance this object represents',
1981
- },
1982
- 'livemode': {'type': 'boolean', 'description': 'Has the value true if the object exists in live mode or false if in test mode'},
1983
- 'settings': {
1984
- 'type': 'object',
1985
- 'description': 'A hash of settings for this cash balance',
1986
- 'properties': {
1987
- 'reconciliation_mode': {
1988
- 'type': 'string',
1989
- 'enum': ['automatic', 'manual'],
1990
- 'description': 'The configuration for how funds that land in the customer cash balance are reconciled',
1991
- },
1992
- 'using_merchant_default': {'type': 'boolean', 'description': "A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance"},
1993
- },
1994
- },
2023
+ },
2024
+ },
2025
+ },
2026
+ 'created': {
2027
+ 'type': 'integer',
2028
+ 'format': 'int64',
2029
+ 'description': 'Time at which the object was created (Unix timestamp)',
2030
+ },
2031
+ 'currency': {
2032
+ 'type': ['string', 'null'],
2033
+ 'description': 'Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes',
2034
+ },
2035
+ 'customer_account': {
2036
+ 'type': ['string', 'null'],
2037
+ 'description': 'The ID of the customer account associated with this customer',
2038
+ },
2039
+ 'default_currency': {
2040
+ 'type': ['string', 'null'],
2041
+ 'description': 'The default currency for the customer',
2042
+ },
2043
+ 'default_source': {
2044
+ 'type': ['string', 'null'],
2045
+ 'description': 'ID of the default payment source for the customer',
2046
+ },
2047
+ 'delinquent': {
2048
+ 'type': ['boolean', 'null'],
2049
+ 'description': 'Whether the customer is delinquent on payments',
2050
+ },
2051
+ 'description': {
2052
+ 'type': ['string', 'null'],
2053
+ 'description': 'An arbitrary string attached to the object',
2054
+ },
2055
+ 'discount': {
2056
+ 'type': ['object', 'null'],
2057
+ 'description': 'Describes the current discount active on the customer, if there is one',
2058
+ 'properties': {
2059
+ 'id': {'type': 'string', 'description': 'The ID of the discount object'},
2060
+ 'object': {'type': 'string', 'description': "String representing the object's type"},
2061
+ 'checkout_session': {
2062
+ 'type': ['string', 'null'],
2063
+ 'description': 'The Checkout session that this coupon is applied to, if applicable',
2064
+ },
2065
+ 'customer': {
2066
+ 'type': ['string', 'null'],
2067
+ 'description': 'The ID of the customer associated with this discount',
2068
+ },
2069
+ 'customer_account': {
2070
+ 'type': ['string', 'null'],
2071
+ 'description': 'The ID of the account associated with this discount',
2072
+ },
2073
+ 'end': {
2074
+ 'type': ['integer', 'null'],
2075
+ 'description': 'If the coupon has a duration of repeating, the date that this discount will end',
2076
+ },
2077
+ 'invoice': {
2078
+ 'type': ['string', 'null'],
2079
+ 'description': "The invoice that the discount's coupon was applied to",
2080
+ },
2081
+ 'invoice_item': {
2082
+ 'type': ['string', 'null'],
2083
+ 'description': "The invoice item that the discount's coupon was applied to",
2084
+ },
2085
+ 'promotion_code': {
2086
+ 'type': ['string', 'null'],
2087
+ 'description': 'The promotion code applied to create this discount',
2088
+ },
2089
+ 'source': {
2090
+ 'type': 'object',
2091
+ 'description': 'The source of the discount',
2092
+ 'properties': {
2093
+ 'coupon': {
2094
+ 'type': ['string', 'null'],
2095
+ 'description': 'The coupon that was redeemed to create this discount',
2096
+ },
2097
+ 'type': {
2098
+ 'type': 'string',
2099
+ 'enum': ['coupon'],
2100
+ 'description': 'The source type of the discount',
1995
2101
  },
1996
2102
  },
1997
- 'created': {
1998
- 'type': 'integer',
1999
- 'format': 'int64',
2000
- 'description': 'Time at which the object was created (Unix timestamp)',
2001
- },
2002
- 'currency': {
2003
- 'type': ['string', 'null'],
2004
- 'description': 'Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes',
2005
- },
2006
- 'customer_account': {
2007
- 'type': ['string', 'null'],
2008
- 'description': 'The ID of the customer account associated with this customer',
2009
- },
2010
- 'default_currency': {
2011
- 'type': ['string', 'null'],
2012
- 'description': 'The default currency for the customer',
2013
- },
2014
- 'default_source': {
2015
- 'type': ['string', 'null'],
2016
- 'description': 'ID of the default payment source for the customer',
2103
+ },
2104
+ 'start': {'type': 'integer', 'description': 'Date that the coupon was applied'},
2105
+ 'subscription': {
2106
+ 'type': ['string', 'null'],
2107
+ 'description': 'The subscription that this coupon is applied to',
2108
+ },
2109
+ 'subscription_item': {
2110
+ 'type': ['string', 'null'],
2111
+ 'description': 'The subscription item that this coupon is applied to',
2112
+ },
2113
+ },
2114
+ },
2115
+ 'email': {
2116
+ 'type': ['string', 'null'],
2117
+ 'format': 'email',
2118
+ 'description': "The customer's email address",
2119
+ },
2120
+ 'individual_name': {
2121
+ 'type': ['string', 'null'],
2122
+ 'description': "The customer's individual name",
2123
+ },
2124
+ 'invoice_credit_balance': {'type': 'object', 'description': 'The current multi-currency balances stored on the customer'},
2125
+ 'invoice_prefix': {
2126
+ 'type': ['string', 'null'],
2127
+ 'description': 'The prefix for the customer used to generate unique invoice numbers',
2128
+ },
2129
+ 'invoice_settings': {
2130
+ 'type': 'object',
2131
+ 'description': "The customer's default invoice settings",
2132
+ 'properties': {
2133
+ 'custom_fields': {
2134
+ 'type': ['array', 'null'],
2135
+ 'description': 'Default custom fields to be displayed on invoices for this customer',
2136
+ 'items': {
2137
+ 'type': 'object',
2138
+ 'properties': {
2139
+ 'name': {'type': 'string', 'description': 'The name of the custom field'},
2140
+ 'value': {'type': 'string', 'description': 'The value of the custom field'},
2141
+ },
2017
2142
  },
2018
- 'delinquent': {
2019
- 'type': ['boolean', 'null'],
2020
- 'description': 'Whether the customer is delinquent on payments',
2143
+ },
2144
+ 'default_payment_method': {
2145
+ 'type': ['string', 'null'],
2146
+ 'description': "ID of a payment method that's attached to the customer",
2147
+ },
2148
+ 'footer': {
2149
+ 'type': ['string', 'null'],
2150
+ 'description': 'Default footer to be displayed on invoices for this customer',
2151
+ },
2152
+ 'rendering_options': {
2153
+ 'type': ['object', 'null'],
2154
+ 'description': 'Default options for invoice PDF rendering for this customer',
2155
+ 'properties': {
2156
+ 'amount_tax_display': {
2157
+ 'type': ['string', 'null'],
2158
+ 'description': 'How line-item prices and amounts will be displayed with respect to tax on invoice PDFs',
2159
+ },
2160
+ 'template': {
2161
+ 'type': ['string', 'null'],
2162
+ 'description': "ID of the invoice rendering template to be used for this customer's invoices",
2163
+ },
2021
2164
  },
2022
- 'description': {
2023
- 'type': ['string', 'null'],
2024
- 'description': 'An arbitrary string attached to the object',
2165
+ },
2166
+ },
2167
+ },
2168
+ 'livemode': {'type': 'boolean', 'description': 'Has the value true if the object exists in live mode or false if in test mode'},
2169
+ 'metadata': {
2170
+ 'type': 'object',
2171
+ 'additionalProperties': {'type': 'string'},
2172
+ 'description': 'Set of key-value pairs that you can attach to an object',
2173
+ },
2174
+ 'name': {
2175
+ 'type': ['string', 'null'],
2176
+ 'description': "The customer's full name or business name",
2177
+ },
2178
+ 'next_invoice_sequence': {
2179
+ 'type': ['integer', 'null'],
2180
+ 'description': "The suffix of the customer's next invoice number",
2181
+ },
2182
+ 'phone': {
2183
+ 'type': ['string', 'null'],
2184
+ 'description': "The customer's phone number",
2185
+ },
2186
+ 'preferred_locales': {
2187
+ 'type': ['array', 'null'],
2188
+ 'items': {'type': 'string'},
2189
+ 'description': "The customer's preferred locales (languages), ordered by preference",
2190
+ },
2191
+ 'shipping': {
2192
+ 'type': ['object', 'null'],
2193
+ 'description': 'Mailing and shipping address for the customer',
2194
+ 'properties': {
2195
+ 'address': {
2196
+ 'type': 'object',
2197
+ 'description': 'Customer shipping address',
2198
+ 'properties': {
2199
+ 'city': {
2200
+ 'type': ['string', 'null'],
2201
+ 'description': 'City, district, suburb, town, or village',
2202
+ },
2203
+ 'country': {
2204
+ 'type': ['string', 'null'],
2205
+ 'description': 'Two-letter country code (ISO 3166-1 alpha-2)',
2206
+ },
2207
+ 'line1': {
2208
+ 'type': ['string', 'null'],
2209
+ 'description': 'Address line 1, such as the street, PO Box, or company name',
2210
+ },
2211
+ 'line2': {
2212
+ 'type': ['string', 'null'],
2213
+ 'description': 'Address line 2, such as the apartment, suite, unit, or building',
2214
+ },
2215
+ 'postal_code': {
2216
+ 'type': ['string', 'null'],
2217
+ 'description': 'ZIP or postal code',
2218
+ },
2219
+ 'state': {
2220
+ 'type': ['string', 'null'],
2221
+ 'description': 'State, county, province, or region',
2222
+ },
2025
2223
  },
2026
- 'discount': {
2027
- 'type': ['object', 'null'],
2028
- 'description': 'Describes the current discount active on the customer, if there is one',
2224
+ },
2225
+ 'name': {'type': 'string', 'description': 'Customer name'},
2226
+ 'phone': {
2227
+ 'type': ['string', 'null'],
2228
+ 'description': 'Customer phone (including extension)',
2229
+ },
2230
+ },
2231
+ },
2232
+ 'sources': {
2233
+ 'type': ['object', 'null'],
2234
+ 'description': "The customer's payment sources, if any",
2235
+ 'properties': {
2236
+ 'object': {
2237
+ 'type': 'string',
2238
+ 'enum': ['list'],
2239
+ 'description': "String representing the object's type",
2240
+ },
2241
+ 'data': {
2242
+ 'type': 'array',
2243
+ 'description': 'Details about each object',
2244
+ 'items': {
2245
+ 'type': 'object',
2029
2246
  'properties': {
2030
- 'id': {'type': 'string', 'description': 'The ID of the discount object'},
2247
+ 'id': {'type': 'string', 'description': 'Unique identifier for the object'},
2031
2248
  'object': {'type': 'string', 'description': "String representing the object's type"},
2032
- 'checkout_session': {
2249
+ 'account': {
2033
2250
  'type': ['string', 'null'],
2034
- 'description': 'The Checkout session that this coupon is applied to, if applicable',
2251
+ 'description': 'The account this bank account belongs to',
2035
2252
  },
2036
- 'customer': {
2253
+ 'account_holder_name': {
2037
2254
  'type': ['string', 'null'],
2038
- 'description': 'The ID of the customer associated with this discount',
2255
+ 'description': 'The name of the person or business that owns the bank account',
2039
2256
  },
2040
- 'customer_account': {
2257
+ 'account_holder_type': {
2041
2258
  'type': ['string', 'null'],
2042
- 'description': 'The ID of the account associated with this discount',
2043
- },
2044
- 'end': {
2045
- 'type': ['integer', 'null'],
2046
- 'description': 'If the coupon has a duration of repeating, the date that this discount will end',
2259
+ 'description': 'The type of entity that holds the account',
2047
2260
  },
2048
- 'invoice': {
2261
+ 'account_type': {
2049
2262
  'type': ['string', 'null'],
2050
- 'description': "The invoice that the discount's coupon was applied to",
2263
+ 'description': 'The bank account type',
2051
2264
  },
2052
- 'invoice_item': {
2053
- 'type': ['string', 'null'],
2054
- 'description': "The invoice item that the discount's coupon was applied to",
2265
+ 'available_payout_methods': {
2266
+ 'type': ['array', 'null'],
2267
+ 'description': 'A set of available payout methods for this bank account',
2268
+ 'items': {
2269
+ 'type': 'string',
2270
+ 'enum': ['instant', 'standard'],
2271
+ },
2055
2272
  },
2056
- 'promotion_code': {
2273
+ 'bank_name': {
2057
2274
  'type': ['string', 'null'],
2058
- 'description': 'The promotion code applied to create this discount',
2275
+ 'description': 'Name of the bank associated with the routing number',
2059
2276
  },
2060
- 'source': {
2061
- 'type': 'object',
2062
- 'description': 'The source of the discount',
2063
- 'properties': {
2064
- 'coupon': {
2065
- 'type': ['string', 'null'],
2066
- 'description': 'The coupon that was redeemed to create this discount',
2067
- },
2068
- 'type': {
2069
- 'type': 'string',
2070
- 'enum': ['coupon'],
2071
- 'description': 'The source type of the discount',
2072
- },
2073
- },
2277
+ 'country': {'type': 'string', 'description': 'Two-letter ISO code representing the country the bank account is located in'},
2278
+ 'currency': {'type': 'string', 'description': 'Three-letter ISO code for the currency paid out to the bank account'},
2279
+ 'customer': {
2280
+ 'type': ['string', 'null'],
2281
+ 'description': 'The ID of the customer that the bank account is associated with',
2074
2282
  },
2075
- 'start': {'type': 'integer', 'description': 'Date that the coupon was applied'},
2076
- 'subscription': {
2283
+ 'fingerprint': {
2077
2284
  'type': ['string', 'null'],
2078
- 'description': 'The subscription that this coupon is applied to',
2285
+ 'description': 'Uniquely identifies this particular bank account',
2079
2286
  },
2080
- 'subscription_item': {
2287
+ 'last4': {'type': 'string', 'description': 'The last four digits of the bank account number'},
2288
+ 'metadata': {
2289
+ 'type': ['object', 'null'],
2290
+ 'description': 'Set of key-value pairs that you can attach to an object',
2291
+ 'additionalProperties': {'type': 'string'},
2292
+ },
2293
+ 'routing_number': {
2081
2294
  'type': ['string', 'null'],
2082
- 'description': 'The subscription item that this coupon is applied to',
2295
+ 'description': 'The routing transit number for the bank account',
2083
2296
  },
2297
+ 'status': {'type': 'string', 'description': 'The status of the bank account'},
2084
2298
  },
2085
2299
  },
2086
- 'email': {
2087
- 'type': ['string', 'null'],
2088
- 'format': 'email',
2089
- 'description': "The customer's email address",
2090
- },
2091
- 'individual_name': {
2092
- 'type': ['string', 'null'],
2093
- 'description': "The customer's individual name",
2094
- },
2095
- 'invoice_credit_balance': {'type': 'object', 'description': 'The current multi-currency balances stored on the customer'},
2096
- 'invoice_prefix': {
2097
- 'type': ['string', 'null'],
2098
- 'description': 'The prefix for the customer used to generate unique invoice numbers',
2099
- },
2100
- 'invoice_settings': {
2101
- 'type': 'object',
2102
- 'description': "The customer's default invoice settings",
2103
- 'properties': {
2104
- 'custom_fields': {
2105
- 'type': ['array', 'null'],
2106
- 'description': 'Default custom fields to be displayed on invoices for this customer',
2107
- 'items': {
2108
- 'type': 'object',
2109
- 'properties': {
2110
- 'name': {'type': 'string', 'description': 'The name of the custom field'},
2111
- 'value': {'type': 'string', 'description': 'The value of the custom field'},
2112
- },
2113
- },
2300
+ },
2301
+ 'has_more': {'type': 'boolean', 'description': 'True if this list has another page of items after this one'},
2302
+ 'url': {'type': 'string', 'description': 'The URL where this list can be accessed'},
2303
+ },
2304
+ },
2305
+ 'subscriptions': {
2306
+ 'type': ['object', 'null'],
2307
+ 'description': "The customer's current subscriptions, if any",
2308
+ 'properties': {
2309
+ 'object': {
2310
+ 'type': 'string',
2311
+ 'enum': ['list'],
2312
+ 'description': "String representing the object's type",
2313
+ },
2314
+ 'data': {
2315
+ 'type': 'array',
2316
+ 'description': 'Details about each subscription',
2317
+ 'items': {
2318
+ 'type': 'object',
2319
+ 'properties': {
2320
+ 'id': {'type': 'string', 'description': 'Unique identifier for the object'},
2321
+ 'object': {
2322
+ 'type': 'string',
2323
+ 'description': "String representing the object's type",
2324
+ 'enum': ['subscription'],
2114
2325
  },
2115
- 'default_payment_method': {
2326
+ 'application': {
2116
2327
  'type': ['string', 'null'],
2117
- 'description': "ID of a payment method that's attached to the customer",
2328
+ 'description': 'ID of the Connect Application that created the subscription',
2118
2329
  },
2119
- 'footer': {
2120
- 'type': ['string', 'null'],
2121
- 'description': 'Default footer to be displayed on invoices for this customer',
2330
+ 'application_fee_percent': {
2331
+ 'type': ['number', 'null'],
2332
+ 'format': 'float',
2333
+ 'description': 'A non-negative decimal between 0 and 100, with at most two decimal places',
2122
2334
  },
2123
- 'rendering_options': {
2124
- 'type': ['object', 'null'],
2125
- 'description': 'Default options for invoice PDF rendering for this customer',
2335
+ 'automatic_tax': {
2336
+ 'type': 'object',
2337
+ 'description': 'Automatic tax settings for this subscription',
2126
2338
  'properties': {
2127
- 'amount_tax_display': {
2339
+ 'disabled_reason': {
2128
2340
  'type': ['string', 'null'],
2129
- 'description': 'How line-item prices and amounts will be displayed with respect to tax on invoice PDFs',
2341
+ 'description': 'If Stripe disabled automatic tax, this enum describes why',
2130
2342
  },
2131
- 'template': {
2132
- 'type': ['string', 'null'],
2133
- 'description': "ID of the invoice rendering template to be used for this customer's invoices",
2343
+ 'enabled': {'type': 'boolean', 'description': 'Whether Stripe automatically computes tax on this subscription'},
2344
+ 'liability': {
2345
+ 'type': ['object', 'null'],
2346
+ 'description': "The account that's liable for tax",
2347
+ 'properties': {
2348
+ 'account': {
2349
+ 'type': ['string', 'null'],
2350
+ 'description': 'The connected account being referenced when type is account',
2351
+ },
2352
+ 'type': {
2353
+ 'type': 'string',
2354
+ 'enum': ['account', 'self'],
2355
+ 'description': 'Type of the account referenced',
2356
+ },
2357
+ },
2134
2358
  },
2135
2359
  },
2136
2360
  },
2137
- },
2138
- },
2139
- 'livemode': {'type': 'boolean', 'description': 'Has the value true if the object exists in live mode or false if in test mode'},
2140
- 'metadata': {
2141
- 'type': 'object',
2142
- 'additionalProperties': {'type': 'string'},
2143
- 'description': 'Set of key-value pairs that you can attach to an object',
2144
- },
2145
- 'name': {
2146
- 'type': ['string', 'null'],
2147
- 'description': "The customer's full name or business name",
2148
- },
2149
- 'next_invoice_sequence': {
2150
- 'type': ['integer', 'null'],
2151
- 'description': "The suffix of the customer's next invoice number",
2152
- },
2153
- 'phone': {
2154
- 'type': ['string', 'null'],
2155
- 'description': "The customer's phone number",
2156
- },
2157
- 'preferred_locales': {
2158
- 'type': ['array', 'null'],
2159
- 'items': {'type': 'string'},
2160
- 'description': "The customer's preferred locales (languages), ordered by preference",
2161
- },
2162
- 'shipping': {
2163
- 'type': ['object', 'null'],
2164
- 'description': 'Mailing and shipping address for the customer',
2165
- 'properties': {
2166
- 'address': {
2361
+ 'billing_cycle_anchor': {
2362
+ 'type': 'integer',
2363
+ 'format': 'int64',
2364
+ 'description': 'The reference point that aligns future billing cycle dates',
2365
+ },
2366
+ 'billing_cycle_anchor_config': {
2367
+ 'type': ['object', 'null'],
2368
+ 'description': 'The fixed values used to calculate the billing_cycle_anchor',
2369
+ 'properties': {
2370
+ 'day_of_month': {'type': 'integer', 'description': 'The day of the month of the billing_cycle_anchor'},
2371
+ 'hour': {
2372
+ 'type': ['integer', 'null'],
2373
+ 'description': 'The hour of the day of the billing_cycle_anchor',
2374
+ },
2375
+ 'minute': {
2376
+ 'type': ['integer', 'null'],
2377
+ 'description': 'The minute of the hour of the billing_cycle_anchor',
2378
+ },
2379
+ 'month': {
2380
+ 'type': ['integer', 'null'],
2381
+ 'description': 'The month to start full cycle billing periods',
2382
+ },
2383
+ 'second': {
2384
+ 'type': ['integer', 'null'],
2385
+ 'description': 'The second of the minute of the billing_cycle_anchor',
2386
+ },
2387
+ },
2388
+ },
2389
+ 'billing_mode': {
2167
2390
  'type': 'object',
2168
- 'description': 'Customer shipping address',
2391
+ 'description': 'Controls how prorations and invoices for subscriptions are calculated and orchestrated',
2169
2392
  'properties': {
2170
- 'city': {
2171
- 'type': ['string', 'null'],
2172
- 'description': 'City, district, suburb, town, or village',
2393
+ 'flexible': {
2394
+ 'type': ['object', 'null'],
2395
+ 'description': 'Configure behavior for flexible billing mode',
2396
+ 'properties': {
2397
+ 'proration_discounts': {
2398
+ 'type': 'string',
2399
+ 'enum': ['included', 'itemized'],
2400
+ 'description': 'Controls how invoices and invoice items display proration amounts and discount amounts',
2401
+ },
2402
+ },
2173
2403
  },
2174
- 'country': {
2175
- 'type': ['string', 'null'],
2176
- 'description': 'Two-letter country code (ISO 3166-1 alpha-2)',
2404
+ 'type': {
2405
+ 'type': 'string',
2406
+ 'enum': ['classic', 'flexible'],
2407
+ 'description': 'Controls how prorations and invoices for subscriptions are calculated and orchestrated',
2177
2408
  },
2178
- 'line1': {
2179
- 'type': ['string', 'null'],
2180
- 'description': 'Address line 1, such as the street, PO Box, or company name',
2409
+ 'updated_at': {
2410
+ 'type': ['integer', 'null'],
2411
+ 'format': 'int64',
2412
+ 'description': 'Details on when the current billing_mode was adopted',
2181
2413
  },
2182
- 'line2': {
2414
+ },
2415
+ },
2416
+ 'billing_thresholds': {
2417
+ 'type': ['object', 'null'],
2418
+ 'description': 'Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period',
2419
+ 'properties': {
2420
+ 'amount_gte': {
2421
+ 'type': ['integer', 'null'],
2422
+ 'description': 'Monetary threshold that triggers the subscription to create an invoice',
2423
+ },
2424
+ 'reset_billing_cycle_anchor': {
2425
+ 'type': ['boolean', 'null'],
2426
+ 'description': 'Indicates if the billing_cycle_anchor should be reset when a threshold is reached',
2427
+ },
2428
+ },
2429
+ },
2430
+ 'cancel_at': {
2431
+ 'type': ['integer', 'null'],
2432
+ 'format': 'int64',
2433
+ 'description': 'A date in the future at which the subscription will automatically get canceled',
2434
+ },
2435
+ 'cancel_at_period_end': {'type': 'boolean', 'description': 'Whether this subscription will (if status=active) or did (if status=canceled) cancel at the end of the current billing period'},
2436
+ 'canceled_at': {
2437
+ 'type': ['integer', 'null'],
2438
+ 'format': 'int64',
2439
+ 'description': 'If the subscription has been canceled, the date of that cancellation',
2440
+ },
2441
+ 'cancellation_details': {
2442
+ 'type': ['object', 'null'],
2443
+ 'description': 'Details about why this subscription was cancelled',
2444
+ 'properties': {
2445
+ 'comment': {
2183
2446
  'type': ['string', 'null'],
2184
- 'description': 'Address line 2, such as the apartment, suite, unit, or building',
2447
+ 'description': 'Additional comments about why the user canceled the subscription',
2185
2448
  },
2186
- 'postal_code': {
2449
+ 'feedback': {
2187
2450
  'type': ['string', 'null'],
2188
- 'description': 'ZIP or postal code',
2451
+ 'description': 'The customer submitted reason for why they canceled',
2189
2452
  },
2190
- 'state': {
2453
+ 'reason': {
2191
2454
  'type': ['string', 'null'],
2192
- 'description': 'State, county, province, or region',
2455
+ 'description': 'Why this subscription was canceled',
2193
2456
  },
2194
2457
  },
2195
2458
  },
2196
- 'name': {'type': 'string', 'description': 'Customer name'},
2197
- 'phone': {
2459
+ 'collection_method': {
2460
+ 'type': 'string',
2461
+ 'enum': ['charge_automatically', 'send_invoice'],
2462
+ 'description': 'Either charge_automatically, or send_invoice',
2463
+ },
2464
+ 'created': {
2465
+ 'type': 'integer',
2466
+ 'format': 'int64',
2467
+ 'description': 'Time at which the object was created. Measured in seconds since the Unix epoch',
2468
+ },
2469
+ 'currency': {'type': 'string', 'description': 'Three-letter ISO currency code, in lowercase'},
2470
+ 'customer': {'type': 'string', 'description': 'ID of the customer who owns the subscription'},
2471
+ 'customer_account': {
2198
2472
  'type': ['string', 'null'],
2199
- 'description': 'Customer phone (including extension)',
2473
+ 'description': 'ID of the account who owns the subscription',
2200
2474
  },
2201
- },
2202
- },
2203
- 'sources': {
2204
- 'type': ['object', 'null'],
2205
- 'description': "The customer's payment sources, if any",
2206
- 'properties': {
2207
- 'object': {
2208
- 'type': 'string',
2209
- 'enum': ['list'],
2210
- 'description': "String representing the object's type",
2475
+ 'days_until_due': {
2476
+ 'type': ['integer', 'null'],
2477
+ 'description': 'Number of days a customer has to pay invoices generated by this subscription',
2211
2478
  },
2212
- 'data': {
2213
- 'type': 'array',
2214
- 'description': 'Details about each object',
2479
+ 'default_payment_method': {
2480
+ 'type': ['string', 'null'],
2481
+ 'description': 'ID of the default payment method for the subscription',
2482
+ },
2483
+ 'default_source': {
2484
+ 'type': ['string', 'null'],
2485
+ 'description': 'ID of the default payment source for the subscription',
2486
+ },
2487
+ 'default_tax_rates': {
2488
+ 'type': ['array', 'null'],
2489
+ 'description': 'The tax rates that will apply to any subscription item that does not have tax_rates set',
2215
2490
  'items': {
2216
2491
  'type': 'object',
2217
2492
  'properties': {
2218
2493
  'id': {'type': 'string', 'description': 'Unique identifier for the object'},
2219
2494
  'object': {'type': 'string', 'description': "String representing the object's type"},
2220
- 'account': {
2221
- 'type': ['string', 'null'],
2222
- 'description': 'The account this bank account belongs to',
2223
- },
2224
- 'account_holder_name': {
2495
+ 'active': {'type': 'boolean', 'description': 'Defaults to true'},
2496
+ 'country': {
2225
2497
  'type': ['string', 'null'],
2226
- 'description': 'The name of the person or business that owns the bank account',
2498
+ 'description': 'Two-letter country code (ISO 3166-1 alpha-2)',
2227
2499
  },
2228
- 'account_holder_type': {
2229
- 'type': ['string', 'null'],
2230
- 'description': 'The type of entity that holds the account',
2500
+ 'created': {
2501
+ 'type': 'integer',
2502
+ 'format': 'int64',
2503
+ 'description': 'Time at which the object was created',
2231
2504
  },
2232
- 'account_type': {
2505
+ 'description': {
2233
2506
  'type': ['string', 'null'],
2234
- 'description': 'The bank account type',
2507
+ 'description': 'An arbitrary string attached to the tax rate for your internal use only',
2235
2508
  },
2236
- 'available_payout_methods': {
2237
- 'type': ['array', 'null'],
2238
- 'description': 'A set of available payout methods for this bank account',
2239
- 'items': {
2240
- 'type': 'string',
2241
- 'enum': ['instant', 'standard'],
2242
- },
2509
+ 'display_name': {'type': 'string', 'description': 'The display name of the tax rates'},
2510
+ 'effective_percentage': {
2511
+ 'type': ['number', 'null'],
2512
+ 'description': 'Actual/effective tax rate percentage out of 100',
2243
2513
  },
2244
- 'bank_name': {
2245
- 'type': ['string', 'null'],
2246
- 'description': 'Name of the bank associated with the routing number',
2514
+ 'flat_amount': {
2515
+ 'type': ['object', 'null'],
2516
+ 'description': 'The amount of the tax rate when the rate_type is flat_amount',
2517
+ 'properties': {
2518
+ 'amount': {'type': 'integer', 'description': 'Amount of the tax when the rate_type is flat_amount'},
2519
+ 'currency': {'type': 'string', 'description': 'Three-letter ISO currency code, in lowercase'},
2520
+ },
2247
2521
  },
2248
- 'country': {'type': 'string', 'description': 'Two-letter ISO code representing the country the bank account is located in'},
2249
- 'currency': {'type': 'string', 'description': 'Three-letter ISO code for the currency paid out to the bank account'},
2250
- 'customer': {
2522
+ 'inclusive': {'type': 'boolean', 'description': 'This specifies if the tax rate is inclusive or exclusive'},
2523
+ 'jurisdiction': {
2251
2524
  'type': ['string', 'null'],
2252
- 'description': 'The ID of the customer that the bank account is associated with',
2525
+ 'description': 'The jurisdiction for the tax rate',
2253
2526
  },
2254
- 'fingerprint': {
2527
+ 'jurisdiction_level': {
2255
2528
  'type': ['string', 'null'],
2256
- 'description': 'Uniquely identifies this particular bank account',
2529
+ 'enum': [
2530
+ 'city',
2531
+ 'country',
2532
+ 'county',
2533
+ 'district',
2534
+ 'multiple',
2535
+ 'state',
2536
+ ],
2537
+ 'description': 'The level of the jurisdiction that imposes this tax rate',
2257
2538
  },
2258
- 'last4': {'type': 'string', 'description': 'The last four digits of the bank account number'},
2539
+ 'livemode': {'type': 'boolean', 'description': 'Has the value true if the object exists in live mode or false if in test mode'},
2259
2540
  'metadata': {
2260
2541
  'type': ['object', 'null'],
2261
- 'description': 'Set of key-value pairs that you can attach to an object',
2542
+ 'description': 'Set of key-value pairs',
2262
2543
  'additionalProperties': {'type': 'string'},
2263
2544
  },
2264
- 'routing_number': {
2545
+ 'percentage': {'type': 'number', 'description': 'Tax rate percentage out of 100'},
2546
+ 'rate_type': {
2265
2547
  'type': ['string', 'null'],
2266
- 'description': 'The routing transit number for the bank account',
2548
+ 'enum': ['flat_amount', 'percentage'],
2549
+ 'description': 'Indicates the type of tax rate applied to the taxable amount',
2550
+ },
2551
+ 'state': {
2552
+ 'type': ['string', 'null'],
2553
+ 'description': 'ISO 3166-2 subdivision code, without country prefix',
2554
+ },
2555
+ 'tax_type': {
2556
+ 'type': ['string', 'null'],
2557
+ 'enum': [
2558
+ 'amusement_tax',
2559
+ 'communications_tax',
2560
+ 'gst',
2561
+ 'hst',
2562
+ 'igst',
2563
+ 'jct',
2564
+ 'lease_tax',
2565
+ 'pst',
2566
+ 'qst',
2567
+ 'retail_delivery_fee',
2568
+ 'rst',
2569
+ 'sales_tax',
2570
+ 'service_tax',
2571
+ 'vat',
2572
+ ],
2573
+ 'description': 'The high-level tax type',
2267
2574
  },
2268
- 'status': {'type': 'string', 'description': 'The status of the bank account'},
2269
2575
  },
2270
2576
  },
2271
2577
  },
2272
- 'has_more': {'type': 'boolean', 'description': 'True if this list has another page of items after this one'},
2273
- 'url': {'type': 'string', 'description': 'The URL where this list can be accessed'},
2274
- },
2275
- },
2276
- 'subscriptions': {
2277
- 'type': ['object', 'null'],
2278
- 'description': "The customer's current subscriptions, if any",
2279
- 'properties': {
2280
- 'object': {
2281
- 'type': 'string',
2282
- 'enum': ['list'],
2283
- 'description': "String representing the object's type",
2578
+ 'description': {
2579
+ 'type': ['string', 'null'],
2580
+ 'description': "The subscription's description, meant to be displayable to the customer",
2284
2581
  },
2285
- 'data': {
2582
+ 'discounts': {
2286
2583
  'type': 'array',
2287
- 'description': 'Details about each subscription',
2288
- 'items': {
2289
- 'type': 'object',
2290
- 'properties': {
2291
- 'id': {'type': 'string', 'description': 'Unique identifier for the object'},
2292
- 'object': {
2293
- 'type': 'string',
2294
- 'description': "String representing the object's type",
2295
- 'enum': ['subscription'],
2296
- },
2297
- 'application': {
2298
- 'type': ['string', 'null'],
2299
- 'description': 'ID of the Connect Application that created the subscription',
2300
- },
2301
- 'application_fee_percent': {
2302
- 'type': ['number', 'null'],
2303
- 'format': 'float',
2304
- 'description': 'A non-negative decimal between 0 and 100, with at most two decimal places',
2584
+ 'items': {'type': 'string'},
2585
+ 'description': 'The discounts applied to the subscription',
2586
+ },
2587
+ 'ended_at': {
2588
+ 'type': ['integer', 'null'],
2589
+ 'format': 'int64',
2590
+ 'description': 'If the subscription has ended, the date the subscription ended',
2591
+ },
2592
+ 'invoice_settings': {
2593
+ 'type': 'object',
2594
+ 'description': 'All invoices will be billed using the specified settings',
2595
+ 'properties': {
2596
+ 'account_tax_ids': {
2597
+ 'type': ['array', 'null'],
2598
+ 'description': 'The account tax IDs associated with the subscription',
2599
+ 'items': {'type': 'string'},
2600
+ },
2601
+ 'issuer': {
2602
+ 'type': 'object',
2603
+ 'description': 'The connected account that issues the invoice',
2604
+ 'properties': {
2605
+ 'account': {
2606
+ 'type': ['string', 'null'],
2607
+ 'description': 'The connected account being referenced when type is account',
2608
+ },
2609
+ 'type': {
2610
+ 'type': 'string',
2611
+ 'enum': ['account', 'self'],
2612
+ 'description': 'Type of the account referenced',
2613
+ },
2305
2614
  },
2306
- 'automatic_tax': {
2615
+ },
2616
+ },
2617
+ },
2618
+ 'items': {
2619
+ 'type': 'object',
2620
+ 'description': 'List of subscription items, each with an attached price',
2621
+ 'properties': {
2622
+ 'object': {
2623
+ 'type': 'string',
2624
+ 'enum': ['list'],
2625
+ 'description': "String representing the object's type",
2626
+ },
2627
+ 'data': {
2628
+ 'type': 'array',
2629
+ 'description': 'Details about each object',
2630
+ 'items': {
2307
2631
  'type': 'object',
2308
- 'description': 'Automatic tax settings for this subscription',
2309
2632
  'properties': {
2310
- 'disabled_reason': {
2311
- 'type': ['string', 'null'],
2312
- 'description': 'If Stripe disabled automatic tax, this enum describes why',
2313
- },
2314
- 'enabled': {'type': 'boolean', 'description': 'Whether Stripe automatically computes tax on this subscription'},
2315
- 'liability': {
2633
+ 'id': {'type': 'string', 'description': 'Unique identifier for the object'},
2634
+ 'object': {'type': 'string', 'description': "String representing the object's type"},
2635
+ 'billing_thresholds': {
2316
2636
  'type': ['object', 'null'],
2317
- 'description': "The account that's liable for tax",
2637
+ 'description': 'Define thresholds at which an invoice will be sent',
2318
2638
  'properties': {
2319
- 'account': {
2320
- 'type': ['string', 'null'],
2321
- 'description': 'The connected account being referenced when type is account',
2322
- },
2323
- 'type': {
2324
- 'type': 'string',
2325
- 'enum': ['account', 'self'],
2326
- 'description': 'Type of the account referenced',
2639
+ 'usage_gte': {
2640
+ 'type': ['integer', 'null'],
2641
+ 'description': 'Usage threshold that triggers the subscription to create an invoice',
2327
2642
  },
2328
2643
  },
2329
2644
  },
2330
- },
2331
- },
2332
- 'billing_cycle_anchor': {
2333
- 'type': 'integer',
2334
- 'format': 'int64',
2335
- 'description': 'The reference point that aligns future billing cycle dates',
2336
- },
2337
- 'billing_cycle_anchor_config': {
2338
- 'type': ['object', 'null'],
2339
- 'description': 'The fixed values used to calculate the billing_cycle_anchor',
2340
- 'properties': {
2341
- 'day_of_month': {'type': 'integer', 'description': 'The day of the month of the billing_cycle_anchor'},
2342
- 'hour': {
2343
- 'type': ['integer', 'null'],
2344
- 'description': 'The hour of the day of the billing_cycle_anchor',
2645
+ 'created': {
2646
+ 'type': 'integer',
2647
+ 'format': 'int64',
2648
+ 'description': 'Time at which the object was created',
2345
2649
  },
2346
- 'minute': {
2347
- 'type': ['integer', 'null'],
2348
- 'description': 'The minute of the hour of the billing_cycle_anchor',
2650
+ 'current_period_end': {
2651
+ 'type': 'integer',
2652
+ 'format': 'int64',
2653
+ 'description': "The end time of this subscription item's current billing period",
2349
2654
  },
2350
- 'month': {
2351
- 'type': ['integer', 'null'],
2352
- 'description': 'The month to start full cycle billing periods',
2655
+ 'current_period_start': {
2656
+ 'type': 'integer',
2657
+ 'format': 'int64',
2658
+ 'description': "The start time of this subscription item's current billing period",
2353
2659
  },
2354
- 'second': {
2660
+ 'discounts': {
2661
+ 'type': 'array',
2662
+ 'items': {'type': 'string'},
2663
+ 'description': 'The discounts applied to the subscription item',
2664
+ },
2665
+ 'metadata': {
2666
+ 'type': 'object',
2667
+ 'description': 'Set of key-value pairs',
2668
+ 'additionalProperties': {'type': 'string'},
2669
+ },
2670
+ 'plan': {
2671
+ 'type': ['object', 'null'],
2672
+ 'description': 'The plan the customer is subscribed to (deprecated, use price instead)',
2673
+ 'additionalProperties': True,
2674
+ },
2675
+ 'price': {
2676
+ 'type': 'object',
2677
+ 'description': 'The price the customer is subscribed to',
2678
+ 'additionalProperties': True,
2679
+ },
2680
+ 'quantity': {
2355
2681
  'type': ['integer', 'null'],
2356
- 'description': 'The second of the minute of the billing_cycle_anchor',
2682
+ 'description': 'The quantity of the plan to which the customer should be subscribed',
2683
+ },
2684
+ 'subscription': {'type': 'string', 'description': 'The subscription this subscription_item belongs to'},
2685
+ 'tax_rates': {
2686
+ 'type': ['array', 'null'],
2687
+ 'description': 'The tax rates which apply to this subscription_item',
2688
+ 'items': {'type': 'object', 'additionalProperties': True},
2357
2689
  },
2358
2690
  },
2359
2691
  },
2360
- 'billing_mode': {
2361
- 'type': 'object',
2362
- 'description': 'Controls how prorations and invoices for subscriptions are calculated and orchestrated',
2363
- 'properties': {
2364
- 'flexible': {
2365
- 'type': ['object', 'null'],
2366
- 'description': 'Configure behavior for flexible billing mode',
2367
- 'properties': {
2368
- 'proration_discounts': {
2369
- 'type': 'string',
2370
- 'enum': ['included', 'itemized'],
2371
- 'description': 'Controls how invoices and invoice items display proration amounts and discount amounts',
2372
- },
2373
- },
2374
- },
2375
- 'type': {
2376
- 'type': 'string',
2377
- 'enum': ['classic', 'flexible'],
2378
- 'description': 'Controls how prorations and invoices for subscriptions are calculated and orchestrated',
2379
- },
2380
- 'updated_at': {
2381
- 'type': ['integer', 'null'],
2382
- 'format': 'int64',
2383
- 'description': 'Details on when the current billing_mode was adopted',
2384
- },
2385
- },
2386
- },
2387
- 'billing_thresholds': {
2388
- 'type': ['object', 'null'],
2389
- 'description': 'Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period',
2390
- 'properties': {
2391
- 'amount_gte': {
2392
- 'type': ['integer', 'null'],
2393
- 'description': 'Monetary threshold that triggers the subscription to create an invoice',
2394
- },
2395
- 'reset_billing_cycle_anchor': {
2396
- 'type': ['boolean', 'null'],
2397
- 'description': 'Indicates if the billing_cycle_anchor should be reset when a threshold is reached',
2398
- },
2399
- },
2400
- },
2401
- 'cancel_at': {
2402
- 'type': ['integer', 'null'],
2403
- 'format': 'int64',
2404
- 'description': 'A date in the future at which the subscription will automatically get canceled',
2405
- },
2406
- 'cancel_at_period_end': {'type': 'boolean', 'description': 'Whether this subscription will (if status=active) or did (if status=canceled) cancel at the end of the current billing period'},
2407
- 'canceled_at': {
2408
- 'type': ['integer', 'null'],
2409
- 'format': 'int64',
2410
- 'description': 'If the subscription has been canceled, the date of that cancellation',
2411
- },
2412
- 'cancellation_details': {
2413
- 'type': ['object', 'null'],
2414
- 'description': 'Details about why this subscription was cancelled',
2415
- 'properties': {
2416
- 'comment': {
2417
- 'type': ['string', 'null'],
2418
- 'description': 'Additional comments about why the user canceled the subscription',
2419
- },
2420
- 'feedback': {
2421
- 'type': ['string', 'null'],
2422
- 'description': 'The customer submitted reason for why they canceled',
2423
- },
2424
- 'reason': {
2425
- 'type': ['string', 'null'],
2426
- 'description': 'Why this subscription was canceled',
2427
- },
2428
- },
2429
- },
2430
- 'collection_method': {
2431
- 'type': 'string',
2432
- 'enum': ['charge_automatically', 'send_invoice'],
2433
- 'description': 'Either charge_automatically, or send_invoice',
2434
- },
2435
- 'created': {
2436
- 'type': 'integer',
2437
- 'format': 'int64',
2438
- 'description': 'Time at which the object was created. Measured in seconds since the Unix epoch',
2439
- },
2440
- 'currency': {'type': 'string', 'description': 'Three-letter ISO currency code, in lowercase'},
2441
- 'customer': {'type': 'string', 'description': 'ID of the customer who owns the subscription'},
2442
- 'customer_account': {
2443
- 'type': ['string', 'null'],
2444
- 'description': 'ID of the account who owns the subscription',
2445
- },
2446
- 'days_until_due': {
2447
- 'type': ['integer', 'null'],
2448
- 'description': 'Number of days a customer has to pay invoices generated by this subscription',
2449
- },
2450
- 'default_payment_method': {
2451
- 'type': ['string', 'null'],
2452
- 'description': 'ID of the default payment method for the subscription',
2453
- },
2454
- 'default_source': {
2455
- 'type': ['string', 'null'],
2456
- 'description': 'ID of the default payment source for the subscription',
2692
+ },
2693
+ 'has_more': {'type': 'boolean', 'description': 'True if this list has another page of items after this one'},
2694
+ 'url': {'type': 'string', 'description': 'The URL where this list can be accessed'},
2695
+ 'total_count': {'type': 'integer', 'description': 'The total count of items in the list'},
2696
+ },
2697
+ },
2698
+ 'latest_invoice': {
2699
+ 'type': ['string', 'null'],
2700
+ 'description': 'The most recent invoice this subscription has generated',
2701
+ },
2702
+ 'livemode': {'type': 'boolean', 'description': 'Has the value true if the object exists in live mode or false if in test mode'},
2703
+ 'metadata': {
2704
+ 'type': 'object',
2705
+ 'additionalProperties': {'type': 'string'},
2706
+ 'description': 'Set of key-value pairs',
2707
+ },
2708
+ 'next_pending_invoice_item_invoice': {
2709
+ 'type': ['integer', 'null'],
2710
+ 'format': 'int64',
2711
+ 'description': 'Specifies the approximate timestamp on which any pending invoice items will be billed',
2712
+ },
2713
+ 'on_behalf_of': {
2714
+ 'type': ['string', 'null'],
2715
+ 'description': 'The account (if any) the charge was made on behalf of for charges associated with this subscription',
2716
+ },
2717
+ 'pause_collection': {
2718
+ 'type': ['object', 'null'],
2719
+ 'description': 'If specified, payment collection for this subscription will be paused',
2720
+ 'properties': {
2721
+ 'behavior': {
2722
+ 'type': 'string',
2723
+ 'enum': ['keep_as_draft', 'mark_uncollectible', 'void'],
2724
+ 'description': 'The payment collection behavior for this subscription while paused',
2725
+ },
2726
+ 'resumes_at': {
2727
+ 'type': ['integer', 'null'],
2728
+ 'format': 'int64',
2729
+ 'description': 'The time after which the subscription will resume collecting payments',
2730
+ },
2731
+ },
2732
+ },
2733
+ 'payment_settings': {
2734
+ 'type': ['object', 'null'],
2735
+ 'description': 'Payment settings passed on to invoices created by the subscription',
2736
+ 'properties': {
2737
+ 'payment_method_options': {
2738
+ 'type': ['object', 'null'],
2739
+ 'description': 'Payment-method-specific configuration to provide to invoices',
2740
+ 'additionalProperties': True,
2741
+ },
2742
+ 'payment_method_types': {
2743
+ 'type': ['array', 'null'],
2744
+ 'description': 'The list of payment method types to provide to every invoice',
2745
+ 'items': {'type': 'string'},
2746
+ },
2747
+ },
2748
+ },
2749
+ 'status': {
2750
+ 'type': 'string',
2751
+ 'enum': [
2752
+ 'incomplete',
2753
+ 'incomplete_expired',
2754
+ 'trialing',
2755
+ 'active',
2756
+ 'past_due',
2757
+ 'canceled',
2758
+ 'unpaid',
2759
+ 'paused',
2760
+ ],
2761
+ 'description': 'The status of the subscription',
2762
+ },
2763
+ 'current_period_start': {
2764
+ 'type': 'integer',
2765
+ 'format': 'int64',
2766
+ 'description': 'Start of the current period for which the subscription has been invoiced',
2767
+ },
2768
+ 'current_period_end': {
2769
+ 'type': 'integer',
2770
+ 'format': 'int64',
2771
+ 'description': 'End of the current period for which the subscription has been invoiced',
2772
+ },
2773
+ 'start_date': {
2774
+ 'type': 'integer',
2775
+ 'format': 'int64',
2776
+ 'description': 'Date when the subscription was first created',
2777
+ },
2778
+ 'trial_start': {
2779
+ 'type': ['integer', 'null'],
2780
+ 'format': 'int64',
2781
+ 'description': 'If the subscription has a trial, the beginning of that trial',
2782
+ },
2783
+ 'trial_end': {
2784
+ 'type': ['integer', 'null'],
2785
+ 'format': 'int64',
2786
+ 'description': 'If the subscription has a trial, the end of that trial',
2787
+ },
2788
+ 'discount': {
2789
+ 'type': ['object', 'null'],
2790
+ 'description': 'The discount applied to the subscription',
2791
+ },
2792
+ 'plan': {
2793
+ 'type': ['object', 'null'],
2794
+ 'description': 'The subscription plan (deprecated, use price instead)',
2795
+ },
2796
+ 'quantity': {
2797
+ 'type': ['integer', 'null'],
2798
+ 'description': 'The quantity of the subscription',
2799
+ },
2800
+ 'schedule': {
2801
+ 'type': ['string', 'null'],
2802
+ 'description': 'The schedule attached to the subscription',
2803
+ },
2804
+ 'test_clock': {
2805
+ 'type': ['string', 'null'],
2806
+ 'description': 'ID of the test clock this subscription belongs to',
2807
+ },
2808
+ 'transfer_data': {
2809
+ 'type': ['object', 'null'],
2810
+ 'description': "The account (if any) the subscription's payments will be attributed to for tax reporting",
2811
+ },
2812
+ 'trial_settings': {
2813
+ 'type': ['object', 'null'],
2814
+ 'description': 'Settings related to subscription trials',
2815
+ 'properties': {
2816
+ 'end_behavior': {
2817
+ 'type': 'object',
2818
+ 'properties': {
2819
+ 'missing_payment_method': {'type': 'string', 'description': 'Behavior when the trial ends and payment method is missing'},
2457
2820
  },
2458
- 'default_tax_rates': {
2459
- 'type': ['array', 'null'],
2460
- 'description': 'The tax rates that will apply to any subscription item that does not have tax_rates set',
2461
- 'items': {
2462
- 'type': 'object',
2463
- 'properties': {
2464
- 'id': {'type': 'string', 'description': 'Unique identifier for the object'},
2465
- 'object': {'type': 'string', 'description': "String representing the object's type"},
2466
- 'active': {'type': 'boolean', 'description': 'Defaults to true'},
2467
- 'country': {
2468
- 'type': ['string', 'null'],
2469
- 'description': 'Two-letter country code (ISO 3166-1 alpha-2)',
2470
- },
2471
- 'created': {
2472
- 'type': 'integer',
2473
- 'format': 'int64',
2474
- 'description': 'Time at which the object was created',
2475
- },
2476
- 'description': {
2477
- 'type': ['string', 'null'],
2478
- 'description': 'An arbitrary string attached to the tax rate for your internal use only',
2479
- },
2480
- 'display_name': {'type': 'string', 'description': 'The display name of the tax rates'},
2481
- 'effective_percentage': {
2482
- 'type': ['number', 'null'],
2483
- 'description': 'Actual/effective tax rate percentage out of 100',
2484
- },
2485
- 'flat_amount': {
2486
- 'type': ['object', 'null'],
2487
- 'description': 'The amount of the tax rate when the rate_type is flat_amount',
2488
- 'properties': {
2489
- 'amount': {'type': 'integer', 'description': 'Amount of the tax when the rate_type is flat_amount'},
2490
- 'currency': {'type': 'string', 'description': 'Three-letter ISO currency code, in lowercase'},
2491
- },
2821
+ },
2822
+ },
2823
+ },
2824
+ 'pending_invoice_item_interval': {
2825
+ 'type': ['object', 'null'],
2826
+ 'description': 'Specifies an interval for how often to bill for any pending invoice items',
2827
+ },
2828
+ 'pending_setup_intent': {
2829
+ 'type': ['string', 'null'],
2830
+ 'description': 'The ID of the SetupIntent to be confirmed',
2831
+ },
2832
+ 'pending_update': {
2833
+ 'type': ['object', 'null'],
2834
+ 'description': 'If specified, pending updates that will be applied to the subscription once the latest_invoice has been paid',
2835
+ },
2836
+ },
2837
+ 'x-airbyte-entity-name': 'subscriptions',
2838
+ },
2839
+ },
2840
+ 'has_more': {'type': 'boolean', 'description': 'True if this list has another page of items after this one'},
2841
+ 'url': {'type': 'string', 'description': 'The URL where this list can be accessed'},
2842
+ },
2843
+ },
2844
+ 'tax_exempt': {
2845
+ 'type': ['string', 'null'],
2846
+ 'description': "Describes the customer's tax exemption status",
2847
+ },
2848
+ 'test_clock': {
2849
+ 'type': ['string', 'null'],
2850
+ 'description': 'ID of the test clock this customer belongs to',
2851
+ },
2852
+ },
2853
+ 'x-airbyte-entity-name': 'customers',
2854
+ },
2855
+ ),
2856
+ Action.UPDATE: EndpointDefinition(
2857
+ method='POST',
2858
+ path='/v1/customers/{id}',
2859
+ action=Action.UPDATE,
2860
+ description='Updates the specified customer by setting the values of the parameters passed.',
2861
+ body_fields=[
2862
+ 'email',
2863
+ 'name',
2864
+ 'description',
2865
+ 'phone',
2866
+ 'address',
2867
+ 'metadata',
2868
+ ],
2869
+ path_params=['id'],
2870
+ path_params_schema={
2871
+ 'id': {'type': 'string', 'required': True},
2872
+ },
2873
+ content_type=ContentType.FORM_URLENCODED,
2874
+ request_schema={
2875
+ 'type': 'object',
2876
+ 'properties': {
2877
+ 'email': {'type': 'string', 'description': "Customer's email address"},
2878
+ 'name': {'type': 'string', 'description': "The customer's full name or business name"},
2879
+ 'description': {'type': 'string', 'description': 'An arbitrary string attached to the object'},
2880
+ 'phone': {'type': 'string', 'description': "The customer's phone number"},
2881
+ 'address': {
2882
+ 'type': 'object',
2883
+ 'description': "The customer's address",
2884
+ 'properties': {
2885
+ 'line1': {'type': 'string', 'description': 'Address line 1'},
2886
+ 'line2': {'type': 'string', 'description': 'Address line 2'},
2887
+ 'city': {'type': 'string', 'description': 'City, district, suburb, town, or village'},
2888
+ 'state': {'type': 'string', 'description': 'State, county, province, or region'},
2889
+ 'postal_code': {'type': 'string', 'description': 'ZIP or postal code'},
2890
+ 'country': {'type': 'string', 'description': 'Two-letter country code (ISO 3166-1 alpha-2)'},
2891
+ },
2892
+ },
2893
+ 'metadata': {
2894
+ 'type': 'object',
2895
+ 'description': 'Set of key-value pairs that you can attach to an object',
2896
+ 'additionalProperties': {'type': 'string'},
2897
+ },
2898
+ },
2899
+ },
2900
+ response_schema={
2901
+ 'type': 'object',
2902
+ 'properties': {
2903
+ 'id': {'type': 'string', 'description': 'Unique identifier for the customer'},
2904
+ 'object': {
2905
+ 'type': 'string',
2906
+ 'description': "String representing the object's type",
2907
+ 'enum': ['customer'],
2908
+ },
2909
+ 'address': {
2910
+ 'type': ['object', 'null'],
2911
+ 'description': "The customer's address",
2912
+ 'properties': {
2913
+ 'city': {
2914
+ 'type': ['string', 'null'],
2915
+ 'description': 'City, district, suburb, town, or village',
2916
+ },
2917
+ 'country': {
2918
+ 'type': ['string', 'null'],
2919
+ 'description': 'Two-letter country code (ISO 3166-1 alpha-2)',
2920
+ },
2921
+ 'line1': {
2922
+ 'type': ['string', 'null'],
2923
+ 'description': 'Address line 1, such as the street, PO Box, or company name',
2924
+ },
2925
+ 'line2': {
2926
+ 'type': ['string', 'null'],
2927
+ 'description': 'Address line 2, such as the apartment, suite, unit, or building',
2928
+ },
2929
+ 'postal_code': {
2930
+ 'type': ['string', 'null'],
2931
+ 'description': 'ZIP or postal code',
2932
+ },
2933
+ 'state': {
2934
+ 'type': ['string', 'null'],
2935
+ 'description': 'State, county, province, or region',
2936
+ },
2937
+ },
2938
+ },
2939
+ 'balance': {'type': 'integer', 'description': 'The current balance stored on the customer'},
2940
+ 'business_name': {
2941
+ 'type': ['string', 'null'],
2942
+ 'description': "The customer's business name",
2943
+ },
2944
+ 'cash_balance': {
2945
+ 'type': ['object', 'null'],
2946
+ 'description': 'The current funds being held by Stripe on behalf of the customer',
2947
+ 'properties': {
2948
+ 'object': {'type': 'string', 'description': "String representing the object's type"},
2949
+ 'available': {
2950
+ 'type': ['object', 'null'],
2951
+ 'description': 'A hash of all cash balances available to this customer',
2952
+ },
2953
+ 'customer': {'type': 'string', 'description': 'The ID of the customer whose cash balance this object represents'},
2954
+ 'customer_account': {
2955
+ 'type': ['string', 'null'],
2956
+ 'description': 'The ID of the account whose cash balance this object represents',
2957
+ },
2958
+ 'livemode': {'type': 'boolean', 'description': 'Has the value true if the object exists in live mode or false if in test mode'},
2959
+ 'settings': {
2960
+ 'type': 'object',
2961
+ 'description': 'A hash of settings for this cash balance',
2962
+ 'properties': {
2963
+ 'reconciliation_mode': {
2964
+ 'type': 'string',
2965
+ 'enum': ['automatic', 'manual'],
2966
+ 'description': 'The configuration for how funds that land in the customer cash balance are reconciled',
2967
+ },
2968
+ 'using_merchant_default': {'type': 'boolean', 'description': "A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance"},
2969
+ },
2970
+ },
2971
+ },
2972
+ },
2973
+ 'created': {
2974
+ 'type': 'integer',
2975
+ 'format': 'int64',
2976
+ 'description': 'Time at which the object was created (Unix timestamp)',
2977
+ },
2978
+ 'currency': {
2979
+ 'type': ['string', 'null'],
2980
+ 'description': 'Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes',
2981
+ },
2982
+ 'customer_account': {
2983
+ 'type': ['string', 'null'],
2984
+ 'description': 'The ID of the customer account associated with this customer',
2985
+ },
2986
+ 'default_currency': {
2987
+ 'type': ['string', 'null'],
2988
+ 'description': 'The default currency for the customer',
2989
+ },
2990
+ 'default_source': {
2991
+ 'type': ['string', 'null'],
2992
+ 'description': 'ID of the default payment source for the customer',
2993
+ },
2994
+ 'delinquent': {
2995
+ 'type': ['boolean', 'null'],
2996
+ 'description': 'Whether the customer is delinquent on payments',
2997
+ },
2998
+ 'description': {
2999
+ 'type': ['string', 'null'],
3000
+ 'description': 'An arbitrary string attached to the object',
3001
+ },
3002
+ 'discount': {
3003
+ 'type': ['object', 'null'],
3004
+ 'description': 'Describes the current discount active on the customer, if there is one',
3005
+ 'properties': {
3006
+ 'id': {'type': 'string', 'description': 'The ID of the discount object'},
3007
+ 'object': {'type': 'string', 'description': "String representing the object's type"},
3008
+ 'checkout_session': {
3009
+ 'type': ['string', 'null'],
3010
+ 'description': 'The Checkout session that this coupon is applied to, if applicable',
3011
+ },
3012
+ 'customer': {
3013
+ 'type': ['string', 'null'],
3014
+ 'description': 'The ID of the customer associated with this discount',
3015
+ },
3016
+ 'customer_account': {
3017
+ 'type': ['string', 'null'],
3018
+ 'description': 'The ID of the account associated with this discount',
3019
+ },
3020
+ 'end': {
3021
+ 'type': ['integer', 'null'],
3022
+ 'description': 'If the coupon has a duration of repeating, the date that this discount will end',
3023
+ },
3024
+ 'invoice': {
3025
+ 'type': ['string', 'null'],
3026
+ 'description': "The invoice that the discount's coupon was applied to",
3027
+ },
3028
+ 'invoice_item': {
3029
+ 'type': ['string', 'null'],
3030
+ 'description': "The invoice item that the discount's coupon was applied to",
3031
+ },
3032
+ 'promotion_code': {
3033
+ 'type': ['string', 'null'],
3034
+ 'description': 'The promotion code applied to create this discount',
3035
+ },
3036
+ 'source': {
3037
+ 'type': 'object',
3038
+ 'description': 'The source of the discount',
3039
+ 'properties': {
3040
+ 'coupon': {
3041
+ 'type': ['string', 'null'],
3042
+ 'description': 'The coupon that was redeemed to create this discount',
3043
+ },
3044
+ 'type': {
3045
+ 'type': 'string',
3046
+ 'enum': ['coupon'],
3047
+ 'description': 'The source type of the discount',
3048
+ },
3049
+ },
3050
+ },
3051
+ 'start': {'type': 'integer', 'description': 'Date that the coupon was applied'},
3052
+ 'subscription': {
3053
+ 'type': ['string', 'null'],
3054
+ 'description': 'The subscription that this coupon is applied to',
3055
+ },
3056
+ 'subscription_item': {
3057
+ 'type': ['string', 'null'],
3058
+ 'description': 'The subscription item that this coupon is applied to',
3059
+ },
3060
+ },
3061
+ },
3062
+ 'email': {
3063
+ 'type': ['string', 'null'],
3064
+ 'format': 'email',
3065
+ 'description': "The customer's email address",
3066
+ },
3067
+ 'individual_name': {
3068
+ 'type': ['string', 'null'],
3069
+ 'description': "The customer's individual name",
3070
+ },
3071
+ 'invoice_credit_balance': {'type': 'object', 'description': 'The current multi-currency balances stored on the customer'},
3072
+ 'invoice_prefix': {
3073
+ 'type': ['string', 'null'],
3074
+ 'description': 'The prefix for the customer used to generate unique invoice numbers',
3075
+ },
3076
+ 'invoice_settings': {
3077
+ 'type': 'object',
3078
+ 'description': "The customer's default invoice settings",
3079
+ 'properties': {
3080
+ 'custom_fields': {
3081
+ 'type': ['array', 'null'],
3082
+ 'description': 'Default custom fields to be displayed on invoices for this customer',
3083
+ 'items': {
3084
+ 'type': 'object',
3085
+ 'properties': {
3086
+ 'name': {'type': 'string', 'description': 'The name of the custom field'},
3087
+ 'value': {'type': 'string', 'description': 'The value of the custom field'},
3088
+ },
3089
+ },
3090
+ },
3091
+ 'default_payment_method': {
3092
+ 'type': ['string', 'null'],
3093
+ 'description': "ID of a payment method that's attached to the customer",
3094
+ },
3095
+ 'footer': {
3096
+ 'type': ['string', 'null'],
3097
+ 'description': 'Default footer to be displayed on invoices for this customer',
3098
+ },
3099
+ 'rendering_options': {
3100
+ 'type': ['object', 'null'],
3101
+ 'description': 'Default options for invoice PDF rendering for this customer',
3102
+ 'properties': {
3103
+ 'amount_tax_display': {
3104
+ 'type': ['string', 'null'],
3105
+ 'description': 'How line-item prices and amounts will be displayed with respect to tax on invoice PDFs',
3106
+ },
3107
+ 'template': {
3108
+ 'type': ['string', 'null'],
3109
+ 'description': "ID of the invoice rendering template to be used for this customer's invoices",
3110
+ },
3111
+ },
3112
+ },
3113
+ },
3114
+ },
3115
+ 'livemode': {'type': 'boolean', 'description': 'Has the value true if the object exists in live mode or false if in test mode'},
3116
+ 'metadata': {
3117
+ 'type': 'object',
3118
+ 'additionalProperties': {'type': 'string'},
3119
+ 'description': 'Set of key-value pairs that you can attach to an object',
3120
+ },
3121
+ 'name': {
3122
+ 'type': ['string', 'null'],
3123
+ 'description': "The customer's full name or business name",
3124
+ },
3125
+ 'next_invoice_sequence': {
3126
+ 'type': ['integer', 'null'],
3127
+ 'description': "The suffix of the customer's next invoice number",
3128
+ },
3129
+ 'phone': {
3130
+ 'type': ['string', 'null'],
3131
+ 'description': "The customer's phone number",
3132
+ },
3133
+ 'preferred_locales': {
3134
+ 'type': ['array', 'null'],
3135
+ 'items': {'type': 'string'},
3136
+ 'description': "The customer's preferred locales (languages), ordered by preference",
3137
+ },
3138
+ 'shipping': {
3139
+ 'type': ['object', 'null'],
3140
+ 'description': 'Mailing and shipping address for the customer',
3141
+ 'properties': {
3142
+ 'address': {
3143
+ 'type': 'object',
3144
+ 'description': 'Customer shipping address',
3145
+ 'properties': {
3146
+ 'city': {
3147
+ 'type': ['string', 'null'],
3148
+ 'description': 'City, district, suburb, town, or village',
3149
+ },
3150
+ 'country': {
3151
+ 'type': ['string', 'null'],
3152
+ 'description': 'Two-letter country code (ISO 3166-1 alpha-2)',
3153
+ },
3154
+ 'line1': {
3155
+ 'type': ['string', 'null'],
3156
+ 'description': 'Address line 1, such as the street, PO Box, or company name',
3157
+ },
3158
+ 'line2': {
3159
+ 'type': ['string', 'null'],
3160
+ 'description': 'Address line 2, such as the apartment, suite, unit, or building',
3161
+ },
3162
+ 'postal_code': {
3163
+ 'type': ['string', 'null'],
3164
+ 'description': 'ZIP or postal code',
3165
+ },
3166
+ 'state': {
3167
+ 'type': ['string', 'null'],
3168
+ 'description': 'State, county, province, or region',
3169
+ },
3170
+ },
3171
+ },
3172
+ 'name': {'type': 'string', 'description': 'Customer name'},
3173
+ 'phone': {
3174
+ 'type': ['string', 'null'],
3175
+ 'description': 'Customer phone (including extension)',
3176
+ },
3177
+ },
3178
+ },
3179
+ 'sources': {
3180
+ 'type': ['object', 'null'],
3181
+ 'description': "The customer's payment sources, if any",
3182
+ 'properties': {
3183
+ 'object': {
3184
+ 'type': 'string',
3185
+ 'enum': ['list'],
3186
+ 'description': "String representing the object's type",
3187
+ },
3188
+ 'data': {
3189
+ 'type': 'array',
3190
+ 'description': 'Details about each object',
3191
+ 'items': {
3192
+ 'type': 'object',
3193
+ 'properties': {
3194
+ 'id': {'type': 'string', 'description': 'Unique identifier for the object'},
3195
+ 'object': {'type': 'string', 'description': "String representing the object's type"},
3196
+ 'account': {
3197
+ 'type': ['string', 'null'],
3198
+ 'description': 'The account this bank account belongs to',
3199
+ },
3200
+ 'account_holder_name': {
3201
+ 'type': ['string', 'null'],
3202
+ 'description': 'The name of the person or business that owns the bank account',
3203
+ },
3204
+ 'account_holder_type': {
3205
+ 'type': ['string', 'null'],
3206
+ 'description': 'The type of entity that holds the account',
3207
+ },
3208
+ 'account_type': {
3209
+ 'type': ['string', 'null'],
3210
+ 'description': 'The bank account type',
3211
+ },
3212
+ 'available_payout_methods': {
3213
+ 'type': ['array', 'null'],
3214
+ 'description': 'A set of available payout methods for this bank account',
3215
+ 'items': {
3216
+ 'type': 'string',
3217
+ 'enum': ['instant', 'standard'],
3218
+ },
3219
+ },
3220
+ 'bank_name': {
3221
+ 'type': ['string', 'null'],
3222
+ 'description': 'Name of the bank associated with the routing number',
3223
+ },
3224
+ 'country': {'type': 'string', 'description': 'Two-letter ISO code representing the country the bank account is located in'},
3225
+ 'currency': {'type': 'string', 'description': 'Three-letter ISO code for the currency paid out to the bank account'},
3226
+ 'customer': {
3227
+ 'type': ['string', 'null'],
3228
+ 'description': 'The ID of the customer that the bank account is associated with',
3229
+ },
3230
+ 'fingerprint': {
3231
+ 'type': ['string', 'null'],
3232
+ 'description': 'Uniquely identifies this particular bank account',
3233
+ },
3234
+ 'last4': {'type': 'string', 'description': 'The last four digits of the bank account number'},
3235
+ 'metadata': {
3236
+ 'type': ['object', 'null'],
3237
+ 'description': 'Set of key-value pairs that you can attach to an object',
3238
+ 'additionalProperties': {'type': 'string'},
3239
+ },
3240
+ 'routing_number': {
3241
+ 'type': ['string', 'null'],
3242
+ 'description': 'The routing transit number for the bank account',
3243
+ },
3244
+ 'status': {'type': 'string', 'description': 'The status of the bank account'},
3245
+ },
3246
+ },
3247
+ },
3248
+ 'has_more': {'type': 'boolean', 'description': 'True if this list has another page of items after this one'},
3249
+ 'url': {'type': 'string', 'description': 'The URL where this list can be accessed'},
3250
+ },
3251
+ },
3252
+ 'subscriptions': {
3253
+ 'type': ['object', 'null'],
3254
+ 'description': "The customer's current subscriptions, if any",
3255
+ 'properties': {
3256
+ 'object': {
3257
+ 'type': 'string',
3258
+ 'enum': ['list'],
3259
+ 'description': "String representing the object's type",
3260
+ },
3261
+ 'data': {
3262
+ 'type': 'array',
3263
+ 'description': 'Details about each subscription',
3264
+ 'items': {
3265
+ 'type': 'object',
3266
+ 'properties': {
3267
+ 'id': {'type': 'string', 'description': 'Unique identifier for the object'},
3268
+ 'object': {
3269
+ 'type': 'string',
3270
+ 'description': "String representing the object's type",
3271
+ 'enum': ['subscription'],
3272
+ },
3273
+ 'application': {
3274
+ 'type': ['string', 'null'],
3275
+ 'description': 'ID of the Connect Application that created the subscription',
3276
+ },
3277
+ 'application_fee_percent': {
3278
+ 'type': ['number', 'null'],
3279
+ 'format': 'float',
3280
+ 'description': 'A non-negative decimal between 0 and 100, with at most two decimal places',
3281
+ },
3282
+ 'automatic_tax': {
3283
+ 'type': 'object',
3284
+ 'description': 'Automatic tax settings for this subscription',
3285
+ 'properties': {
3286
+ 'disabled_reason': {
3287
+ 'type': ['string', 'null'],
3288
+ 'description': 'If Stripe disabled automatic tax, this enum describes why',
3289
+ },
3290
+ 'enabled': {'type': 'boolean', 'description': 'Whether Stripe automatically computes tax on this subscription'},
3291
+ 'liability': {
3292
+ 'type': ['object', 'null'],
3293
+ 'description': "The account that's liable for tax",
3294
+ 'properties': {
3295
+ 'account': {
3296
+ 'type': ['string', 'null'],
3297
+ 'description': 'The connected account being referenced when type is account',
3298
+ },
3299
+ 'type': {
3300
+ 'type': 'string',
3301
+ 'enum': ['account', 'self'],
3302
+ 'description': 'Type of the account referenced',
3303
+ },
3304
+ },
3305
+ },
3306
+ },
3307
+ },
3308
+ 'billing_cycle_anchor': {
3309
+ 'type': 'integer',
3310
+ 'format': 'int64',
3311
+ 'description': 'The reference point that aligns future billing cycle dates',
3312
+ },
3313
+ 'billing_cycle_anchor_config': {
3314
+ 'type': ['object', 'null'],
3315
+ 'description': 'The fixed values used to calculate the billing_cycle_anchor',
3316
+ 'properties': {
3317
+ 'day_of_month': {'type': 'integer', 'description': 'The day of the month of the billing_cycle_anchor'},
3318
+ 'hour': {
3319
+ 'type': ['integer', 'null'],
3320
+ 'description': 'The hour of the day of the billing_cycle_anchor',
3321
+ },
3322
+ 'minute': {
3323
+ 'type': ['integer', 'null'],
3324
+ 'description': 'The minute of the hour of the billing_cycle_anchor',
3325
+ },
3326
+ 'month': {
3327
+ 'type': ['integer', 'null'],
3328
+ 'description': 'The month to start full cycle billing periods',
3329
+ },
3330
+ 'second': {
3331
+ 'type': ['integer', 'null'],
3332
+ 'description': 'The second of the minute of the billing_cycle_anchor',
3333
+ },
3334
+ },
3335
+ },
3336
+ 'billing_mode': {
3337
+ 'type': 'object',
3338
+ 'description': 'Controls how prorations and invoices for subscriptions are calculated and orchestrated',
3339
+ 'properties': {
3340
+ 'flexible': {
3341
+ 'type': ['object', 'null'],
3342
+ 'description': 'Configure behavior for flexible billing mode',
3343
+ 'properties': {
3344
+ 'proration_discounts': {
3345
+ 'type': 'string',
3346
+ 'enum': ['included', 'itemized'],
3347
+ 'description': 'Controls how invoices and invoice items display proration amounts and discount amounts',
3348
+ },
3349
+ },
3350
+ },
3351
+ 'type': {
3352
+ 'type': 'string',
3353
+ 'enum': ['classic', 'flexible'],
3354
+ 'description': 'Controls how prorations and invoices for subscriptions are calculated and orchestrated',
3355
+ },
3356
+ 'updated_at': {
3357
+ 'type': ['integer', 'null'],
3358
+ 'format': 'int64',
3359
+ 'description': 'Details on when the current billing_mode was adopted',
3360
+ },
3361
+ },
3362
+ },
3363
+ 'billing_thresholds': {
3364
+ 'type': ['object', 'null'],
3365
+ 'description': 'Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period',
3366
+ 'properties': {
3367
+ 'amount_gte': {
3368
+ 'type': ['integer', 'null'],
3369
+ 'description': 'Monetary threshold that triggers the subscription to create an invoice',
3370
+ },
3371
+ 'reset_billing_cycle_anchor': {
3372
+ 'type': ['boolean', 'null'],
3373
+ 'description': 'Indicates if the billing_cycle_anchor should be reset when a threshold is reached',
3374
+ },
3375
+ },
3376
+ },
3377
+ 'cancel_at': {
3378
+ 'type': ['integer', 'null'],
3379
+ 'format': 'int64',
3380
+ 'description': 'A date in the future at which the subscription will automatically get canceled',
3381
+ },
3382
+ 'cancel_at_period_end': {'type': 'boolean', 'description': 'Whether this subscription will (if status=active) or did (if status=canceled) cancel at the end of the current billing period'},
3383
+ 'canceled_at': {
3384
+ 'type': ['integer', 'null'],
3385
+ 'format': 'int64',
3386
+ 'description': 'If the subscription has been canceled, the date of that cancellation',
3387
+ },
3388
+ 'cancellation_details': {
3389
+ 'type': ['object', 'null'],
3390
+ 'description': 'Details about why this subscription was cancelled',
3391
+ 'properties': {
3392
+ 'comment': {
3393
+ 'type': ['string', 'null'],
3394
+ 'description': 'Additional comments about why the user canceled the subscription',
3395
+ },
3396
+ 'feedback': {
3397
+ 'type': ['string', 'null'],
3398
+ 'description': 'The customer submitted reason for why they canceled',
3399
+ },
3400
+ 'reason': {
3401
+ 'type': ['string', 'null'],
3402
+ 'description': 'Why this subscription was canceled',
3403
+ },
3404
+ },
3405
+ },
3406
+ 'collection_method': {
3407
+ 'type': 'string',
3408
+ 'enum': ['charge_automatically', 'send_invoice'],
3409
+ 'description': 'Either charge_automatically, or send_invoice',
3410
+ },
3411
+ 'created': {
3412
+ 'type': 'integer',
3413
+ 'format': 'int64',
3414
+ 'description': 'Time at which the object was created. Measured in seconds since the Unix epoch',
3415
+ },
3416
+ 'currency': {'type': 'string', 'description': 'Three-letter ISO currency code, in lowercase'},
3417
+ 'customer': {'type': 'string', 'description': 'ID of the customer who owns the subscription'},
3418
+ 'customer_account': {
3419
+ 'type': ['string', 'null'],
3420
+ 'description': 'ID of the account who owns the subscription',
3421
+ },
3422
+ 'days_until_due': {
3423
+ 'type': ['integer', 'null'],
3424
+ 'description': 'Number of days a customer has to pay invoices generated by this subscription',
3425
+ },
3426
+ 'default_payment_method': {
3427
+ 'type': ['string', 'null'],
3428
+ 'description': 'ID of the default payment method for the subscription',
3429
+ },
3430
+ 'default_source': {
3431
+ 'type': ['string', 'null'],
3432
+ 'description': 'ID of the default payment source for the subscription',
3433
+ },
3434
+ 'default_tax_rates': {
3435
+ 'type': ['array', 'null'],
3436
+ 'description': 'The tax rates that will apply to any subscription item that does not have tax_rates set',
3437
+ 'items': {
3438
+ 'type': 'object',
3439
+ 'properties': {
3440
+ 'id': {'type': 'string', 'description': 'Unique identifier for the object'},
3441
+ 'object': {'type': 'string', 'description': "String representing the object's type"},
3442
+ 'active': {'type': 'boolean', 'description': 'Defaults to true'},
3443
+ 'country': {
3444
+ 'type': ['string', 'null'],
3445
+ 'description': 'Two-letter country code (ISO 3166-1 alpha-2)',
3446
+ },
3447
+ 'created': {
3448
+ 'type': 'integer',
3449
+ 'format': 'int64',
3450
+ 'description': 'Time at which the object was created',
3451
+ },
3452
+ 'description': {
3453
+ 'type': ['string', 'null'],
3454
+ 'description': 'An arbitrary string attached to the tax rate for your internal use only',
3455
+ },
3456
+ 'display_name': {'type': 'string', 'description': 'The display name of the tax rates'},
3457
+ 'effective_percentage': {
3458
+ 'type': ['number', 'null'],
3459
+ 'description': 'Actual/effective tax rate percentage out of 100',
3460
+ },
3461
+ 'flat_amount': {
3462
+ 'type': ['object', 'null'],
3463
+ 'description': 'The amount of the tax rate when the rate_type is flat_amount',
3464
+ 'properties': {
3465
+ 'amount': {'type': 'integer', 'description': 'Amount of the tax when the rate_type is flat_amount'},
3466
+ 'currency': {'type': 'string', 'description': 'Three-letter ISO currency code, in lowercase'},
3467
+ },
3468
+ },
3469
+ 'inclusive': {'type': 'boolean', 'description': 'This specifies if the tax rate is inclusive or exclusive'},
3470
+ 'jurisdiction': {
3471
+ 'type': ['string', 'null'],
3472
+ 'description': 'The jurisdiction for the tax rate',
3473
+ },
3474
+ 'jurisdiction_level': {
3475
+ 'type': ['string', 'null'],
3476
+ 'enum': [
3477
+ 'city',
3478
+ 'country',
3479
+ 'county',
3480
+ 'district',
3481
+ 'multiple',
3482
+ 'state',
3483
+ ],
3484
+ 'description': 'The level of the jurisdiction that imposes this tax rate',
3485
+ },
3486
+ 'livemode': {'type': 'boolean', 'description': 'Has the value true if the object exists in live mode or false if in test mode'},
3487
+ 'metadata': {
3488
+ 'type': ['object', 'null'],
3489
+ 'description': 'Set of key-value pairs',
3490
+ 'additionalProperties': {'type': 'string'},
3491
+ },
3492
+ 'percentage': {'type': 'number', 'description': 'Tax rate percentage out of 100'},
3493
+ 'rate_type': {
3494
+ 'type': ['string', 'null'],
3495
+ 'enum': ['flat_amount', 'percentage'],
3496
+ 'description': 'Indicates the type of tax rate applied to the taxable amount',
3497
+ },
3498
+ 'state': {
3499
+ 'type': ['string', 'null'],
3500
+ 'description': 'ISO 3166-2 subdivision code, without country prefix',
3501
+ },
3502
+ 'tax_type': {
3503
+ 'type': ['string', 'null'],
3504
+ 'enum': [
3505
+ 'amusement_tax',
3506
+ 'communications_tax',
3507
+ 'gst',
3508
+ 'hst',
3509
+ 'igst',
3510
+ 'jct',
3511
+ 'lease_tax',
3512
+ 'pst',
3513
+ 'qst',
3514
+ 'retail_delivery_fee',
3515
+ 'rst',
3516
+ 'sales_tax',
3517
+ 'service_tax',
3518
+ 'vat',
3519
+ ],
3520
+ 'description': 'The high-level tax type',
3521
+ },
3522
+ },
3523
+ },
3524
+ },
3525
+ 'description': {
3526
+ 'type': ['string', 'null'],
3527
+ 'description': "The subscription's description, meant to be displayable to the customer",
3528
+ },
3529
+ 'discounts': {
3530
+ 'type': 'array',
3531
+ 'items': {'type': 'string'},
3532
+ 'description': 'The discounts applied to the subscription',
3533
+ },
3534
+ 'ended_at': {
3535
+ 'type': ['integer', 'null'],
3536
+ 'format': 'int64',
3537
+ 'description': 'If the subscription has ended, the date the subscription ended',
3538
+ },
3539
+ 'invoice_settings': {
3540
+ 'type': 'object',
3541
+ 'description': 'All invoices will be billed using the specified settings',
3542
+ 'properties': {
3543
+ 'account_tax_ids': {
3544
+ 'type': ['array', 'null'],
3545
+ 'description': 'The account tax IDs associated with the subscription',
3546
+ 'items': {'type': 'string'},
3547
+ },
3548
+ 'issuer': {
3549
+ 'type': 'object',
3550
+ 'description': 'The connected account that issues the invoice',
3551
+ 'properties': {
3552
+ 'account': {
3553
+ 'type': ['string', 'null'],
3554
+ 'description': 'The connected account being referenced when type is account',
3555
+ },
3556
+ 'type': {
3557
+ 'type': 'string',
3558
+ 'enum': ['account', 'self'],
3559
+ 'description': 'Type of the account referenced',
3560
+ },
3561
+ },
3562
+ },
3563
+ },
3564
+ },
3565
+ 'items': {
3566
+ 'type': 'object',
3567
+ 'description': 'List of subscription items, each with an attached price',
3568
+ 'properties': {
3569
+ 'object': {
3570
+ 'type': 'string',
3571
+ 'enum': ['list'],
3572
+ 'description': "String representing the object's type",
3573
+ },
3574
+ 'data': {
3575
+ 'type': 'array',
3576
+ 'description': 'Details about each object',
3577
+ 'items': {
3578
+ 'type': 'object',
3579
+ 'properties': {
3580
+ 'id': {'type': 'string', 'description': 'Unique identifier for the object'},
3581
+ 'object': {'type': 'string', 'description': "String representing the object's type"},
3582
+ 'billing_thresholds': {
3583
+ 'type': ['object', 'null'],
3584
+ 'description': 'Define thresholds at which an invoice will be sent',
3585
+ 'properties': {
3586
+ 'usage_gte': {
3587
+ 'type': ['integer', 'null'],
3588
+ 'description': 'Usage threshold that triggers the subscription to create an invoice',
3589
+ },
3590
+ },
3591
+ },
3592
+ 'created': {
3593
+ 'type': 'integer',
3594
+ 'format': 'int64',
3595
+ 'description': 'Time at which the object was created',
3596
+ },
3597
+ 'current_period_end': {
3598
+ 'type': 'integer',
3599
+ 'format': 'int64',
3600
+ 'description': "The end time of this subscription item's current billing period",
3601
+ },
3602
+ 'current_period_start': {
3603
+ 'type': 'integer',
3604
+ 'format': 'int64',
3605
+ 'description': "The start time of this subscription item's current billing period",
3606
+ },
3607
+ 'discounts': {
3608
+ 'type': 'array',
3609
+ 'items': {'type': 'string'},
3610
+ 'description': 'The discounts applied to the subscription item',
3611
+ },
3612
+ 'metadata': {
3613
+ 'type': 'object',
3614
+ 'description': 'Set of key-value pairs',
3615
+ 'additionalProperties': {'type': 'string'},
3616
+ },
3617
+ 'plan': {
3618
+ 'type': ['object', 'null'],
3619
+ 'description': 'The plan the customer is subscribed to (deprecated, use price instead)',
3620
+ 'additionalProperties': True,
3621
+ },
3622
+ 'price': {
3623
+ 'type': 'object',
3624
+ 'description': 'The price the customer is subscribed to',
3625
+ 'additionalProperties': True,
3626
+ },
3627
+ 'quantity': {
3628
+ 'type': ['integer', 'null'],
3629
+ 'description': 'The quantity of the plan to which the customer should be subscribed',
3630
+ },
3631
+ 'subscription': {'type': 'string', 'description': 'The subscription this subscription_item belongs to'},
3632
+ 'tax_rates': {
3633
+ 'type': ['array', 'null'],
3634
+ 'description': 'The tax rates which apply to this subscription_item',
3635
+ 'items': {'type': 'object', 'additionalProperties': True},
3636
+ },
3637
+ },
3638
+ },
3639
+ },
3640
+ 'has_more': {'type': 'boolean', 'description': 'True if this list has another page of items after this one'},
3641
+ 'url': {'type': 'string', 'description': 'The URL where this list can be accessed'},
3642
+ 'total_count': {'type': 'integer', 'description': 'The total count of items in the list'},
3643
+ },
3644
+ },
3645
+ 'latest_invoice': {
3646
+ 'type': ['string', 'null'],
3647
+ 'description': 'The most recent invoice this subscription has generated',
3648
+ },
3649
+ 'livemode': {'type': 'boolean', 'description': 'Has the value true if the object exists in live mode or false if in test mode'},
3650
+ 'metadata': {
3651
+ 'type': 'object',
3652
+ 'additionalProperties': {'type': 'string'},
3653
+ 'description': 'Set of key-value pairs',
3654
+ },
3655
+ 'next_pending_invoice_item_invoice': {
3656
+ 'type': ['integer', 'null'],
3657
+ 'format': 'int64',
3658
+ 'description': 'Specifies the approximate timestamp on which any pending invoice items will be billed',
3659
+ },
3660
+ 'on_behalf_of': {
3661
+ 'type': ['string', 'null'],
3662
+ 'description': 'The account (if any) the charge was made on behalf of for charges associated with this subscription',
3663
+ },
3664
+ 'pause_collection': {
3665
+ 'type': ['object', 'null'],
3666
+ 'description': 'If specified, payment collection for this subscription will be paused',
3667
+ 'properties': {
3668
+ 'behavior': {
3669
+ 'type': 'string',
3670
+ 'enum': ['keep_as_draft', 'mark_uncollectible', 'void'],
3671
+ 'description': 'The payment collection behavior for this subscription while paused',
3672
+ },
3673
+ 'resumes_at': {
3674
+ 'type': ['integer', 'null'],
3675
+ 'format': 'int64',
3676
+ 'description': 'The time after which the subscription will resume collecting payments',
3677
+ },
3678
+ },
3679
+ },
3680
+ 'payment_settings': {
3681
+ 'type': ['object', 'null'],
3682
+ 'description': 'Payment settings passed on to invoices created by the subscription',
3683
+ 'properties': {
3684
+ 'payment_method_options': {
3685
+ 'type': ['object', 'null'],
3686
+ 'description': 'Payment-method-specific configuration to provide to invoices',
3687
+ 'additionalProperties': True,
3688
+ },
3689
+ 'payment_method_types': {
3690
+ 'type': ['array', 'null'],
3691
+ 'description': 'The list of payment method types to provide to every invoice',
3692
+ 'items': {'type': 'string'},
3693
+ },
3694
+ },
3695
+ },
3696
+ 'status': {
3697
+ 'type': 'string',
3698
+ 'enum': [
3699
+ 'incomplete',
3700
+ 'incomplete_expired',
3701
+ 'trialing',
3702
+ 'active',
3703
+ 'past_due',
3704
+ 'canceled',
3705
+ 'unpaid',
3706
+ 'paused',
3707
+ ],
3708
+ 'description': 'The status of the subscription',
3709
+ },
3710
+ 'current_period_start': {
3711
+ 'type': 'integer',
3712
+ 'format': 'int64',
3713
+ 'description': 'Start of the current period for which the subscription has been invoiced',
3714
+ },
3715
+ 'current_period_end': {
3716
+ 'type': 'integer',
3717
+ 'format': 'int64',
3718
+ 'description': 'End of the current period for which the subscription has been invoiced',
3719
+ },
3720
+ 'start_date': {
3721
+ 'type': 'integer',
3722
+ 'format': 'int64',
3723
+ 'description': 'Date when the subscription was first created',
3724
+ },
3725
+ 'trial_start': {
3726
+ 'type': ['integer', 'null'],
3727
+ 'format': 'int64',
3728
+ 'description': 'If the subscription has a trial, the beginning of that trial',
3729
+ },
3730
+ 'trial_end': {
3731
+ 'type': ['integer', 'null'],
3732
+ 'format': 'int64',
3733
+ 'description': 'If the subscription has a trial, the end of that trial',
3734
+ },
3735
+ 'discount': {
3736
+ 'type': ['object', 'null'],
3737
+ 'description': 'The discount applied to the subscription',
3738
+ },
3739
+ 'plan': {
3740
+ 'type': ['object', 'null'],
3741
+ 'description': 'The subscription plan (deprecated, use price instead)',
3742
+ },
3743
+ 'quantity': {
3744
+ 'type': ['integer', 'null'],
3745
+ 'description': 'The quantity of the subscription',
3746
+ },
3747
+ 'schedule': {
3748
+ 'type': ['string', 'null'],
3749
+ 'description': 'The schedule attached to the subscription',
3750
+ },
3751
+ 'test_clock': {
3752
+ 'type': ['string', 'null'],
3753
+ 'description': 'ID of the test clock this subscription belongs to',
3754
+ },
3755
+ 'transfer_data': {
3756
+ 'type': ['object', 'null'],
3757
+ 'description': "The account (if any) the subscription's payments will be attributed to for tax reporting",
3758
+ },
3759
+ 'trial_settings': {
3760
+ 'type': ['object', 'null'],
3761
+ 'description': 'Settings related to subscription trials',
3762
+ 'properties': {
3763
+ 'end_behavior': {
3764
+ 'type': 'object',
3765
+ 'properties': {
3766
+ 'missing_payment_method': {'type': 'string', 'description': 'Behavior when the trial ends and payment method is missing'},
3767
+ },
3768
+ },
3769
+ },
3770
+ },
3771
+ 'pending_invoice_item_interval': {
3772
+ 'type': ['object', 'null'],
3773
+ 'description': 'Specifies an interval for how often to bill for any pending invoice items',
3774
+ },
3775
+ 'pending_setup_intent': {
3776
+ 'type': ['string', 'null'],
3777
+ 'description': 'The ID of the SetupIntent to be confirmed',
3778
+ },
3779
+ 'pending_update': {
3780
+ 'type': ['object', 'null'],
3781
+ 'description': 'If specified, pending updates that will be applied to the subscription once the latest_invoice has been paid',
3782
+ },
3783
+ },
3784
+ 'x-airbyte-entity-name': 'subscriptions',
3785
+ },
3786
+ },
3787
+ 'has_more': {'type': 'boolean', 'description': 'True if this list has another page of items after this one'},
3788
+ 'url': {'type': 'string', 'description': 'The URL where this list can be accessed'},
3789
+ },
3790
+ },
3791
+ 'tax_exempt': {
3792
+ 'type': ['string', 'null'],
3793
+ 'description': "Describes the customer's tax exemption status",
3794
+ },
3795
+ 'test_clock': {
3796
+ 'type': ['string', 'null'],
3797
+ 'description': 'ID of the test clock this customer belongs to',
3798
+ },
3799
+ },
3800
+ 'x-airbyte-entity-name': 'customers',
3801
+ },
3802
+ ),
3803
+ Action.DELETE: EndpointDefinition(
3804
+ method='DELETE',
3805
+ path='/v1/customers/{id}',
3806
+ action=Action.DELETE,
3807
+ description='Permanently deletes a customer. It cannot be undone.',
3808
+ path_params=['id'],
3809
+ path_params_schema={
3810
+ 'id': {'type': 'string', 'required': True},
3811
+ },
3812
+ response_schema={
3813
+ 'type': 'object',
3814
+ 'properties': {
3815
+ 'id': {'type': 'string', 'description': 'The ID of the deleted customer'},
3816
+ 'object': {
3817
+ 'type': 'string',
3818
+ 'enum': ['customer'],
3819
+ 'description': "String representing the object's type",
3820
+ },
3821
+ 'deleted': {'type': 'boolean', 'description': 'Always true for a deleted object'},
3822
+ },
3823
+ },
3824
+ ),
3825
+ Action.API_SEARCH: EndpointDefinition(
3826
+ method='GET',
3827
+ path='/v1/customers/search',
3828
+ action=Action.API_SEARCH,
3829
+ description="Search for customers using Stripe's Search Query Language.",
3830
+ query_params=['query', 'limit', 'page'],
3831
+ query_params_schema={
3832
+ 'query': {'type': 'string', 'required': True},
3833
+ 'limit': {'type': 'integer', 'required': False},
3834
+ 'page': {'type': 'string', 'required': False},
3835
+ },
3836
+ response_schema={
3837
+ 'type': 'object',
3838
+ 'properties': {
3839
+ 'object': {
3840
+ 'type': 'string',
3841
+ 'enum': ['search_result'],
3842
+ },
3843
+ 'data': {
3844
+ 'type': 'array',
3845
+ 'items': {
3846
+ 'type': 'object',
3847
+ 'properties': {
3848
+ 'id': {'type': 'string', 'description': 'Unique identifier for the customer'},
3849
+ 'object': {
3850
+ 'type': 'string',
3851
+ 'description': "String representing the object's type",
3852
+ 'enum': ['customer'],
3853
+ },
3854
+ 'address': {
3855
+ 'type': ['object', 'null'],
3856
+ 'description': "The customer's address",
3857
+ 'properties': {
3858
+ 'city': {
3859
+ 'type': ['string', 'null'],
3860
+ 'description': 'City, district, suburb, town, or village',
3861
+ },
3862
+ 'country': {
3863
+ 'type': ['string', 'null'],
3864
+ 'description': 'Two-letter country code (ISO 3166-1 alpha-2)',
3865
+ },
3866
+ 'line1': {
3867
+ 'type': ['string', 'null'],
3868
+ 'description': 'Address line 1, such as the street, PO Box, or company name',
3869
+ },
3870
+ 'line2': {
3871
+ 'type': ['string', 'null'],
3872
+ 'description': 'Address line 2, such as the apartment, suite, unit, or building',
3873
+ },
3874
+ 'postal_code': {
3875
+ 'type': ['string', 'null'],
3876
+ 'description': 'ZIP or postal code',
3877
+ },
3878
+ 'state': {
3879
+ 'type': ['string', 'null'],
3880
+ 'description': 'State, county, province, or region',
3881
+ },
3882
+ },
3883
+ },
3884
+ 'balance': {'type': 'integer', 'description': 'The current balance stored on the customer'},
3885
+ 'business_name': {
3886
+ 'type': ['string', 'null'],
3887
+ 'description': "The customer's business name",
3888
+ },
3889
+ 'cash_balance': {
3890
+ 'type': ['object', 'null'],
3891
+ 'description': 'The current funds being held by Stripe on behalf of the customer',
3892
+ 'properties': {
3893
+ 'object': {'type': 'string', 'description': "String representing the object's type"},
3894
+ 'available': {
3895
+ 'type': ['object', 'null'],
3896
+ 'description': 'A hash of all cash balances available to this customer',
3897
+ },
3898
+ 'customer': {'type': 'string', 'description': 'The ID of the customer whose cash balance this object represents'},
3899
+ 'customer_account': {
3900
+ 'type': ['string', 'null'],
3901
+ 'description': 'The ID of the account whose cash balance this object represents',
3902
+ },
3903
+ 'livemode': {'type': 'boolean', 'description': 'Has the value true if the object exists in live mode or false if in test mode'},
3904
+ 'settings': {
3905
+ 'type': 'object',
3906
+ 'description': 'A hash of settings for this cash balance',
3907
+ 'properties': {
3908
+ 'reconciliation_mode': {
3909
+ 'type': 'string',
3910
+ 'enum': ['automatic', 'manual'],
3911
+ 'description': 'The configuration for how funds that land in the customer cash balance are reconciled',
3912
+ },
3913
+ 'using_merchant_default': {'type': 'boolean', 'description': "A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance"},
3914
+ },
3915
+ },
3916
+ },
3917
+ },
3918
+ 'created': {
3919
+ 'type': 'integer',
3920
+ 'format': 'int64',
3921
+ 'description': 'Time at which the object was created (Unix timestamp)',
3922
+ },
3923
+ 'currency': {
3924
+ 'type': ['string', 'null'],
3925
+ 'description': 'Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes',
3926
+ },
3927
+ 'customer_account': {
3928
+ 'type': ['string', 'null'],
3929
+ 'description': 'The ID of the customer account associated with this customer',
3930
+ },
3931
+ 'default_currency': {
3932
+ 'type': ['string', 'null'],
3933
+ 'description': 'The default currency for the customer',
3934
+ },
3935
+ 'default_source': {
3936
+ 'type': ['string', 'null'],
3937
+ 'description': 'ID of the default payment source for the customer',
3938
+ },
3939
+ 'delinquent': {
3940
+ 'type': ['boolean', 'null'],
3941
+ 'description': 'Whether the customer is delinquent on payments',
3942
+ },
3943
+ 'description': {
3944
+ 'type': ['string', 'null'],
3945
+ 'description': 'An arbitrary string attached to the object',
3946
+ },
3947
+ 'discount': {
3948
+ 'type': ['object', 'null'],
3949
+ 'description': 'Describes the current discount active on the customer, if there is one',
3950
+ 'properties': {
3951
+ 'id': {'type': 'string', 'description': 'The ID of the discount object'},
3952
+ 'object': {'type': 'string', 'description': "String representing the object's type"},
3953
+ 'checkout_session': {
3954
+ 'type': ['string', 'null'],
3955
+ 'description': 'The Checkout session that this coupon is applied to, if applicable',
3956
+ },
3957
+ 'customer': {
3958
+ 'type': ['string', 'null'],
3959
+ 'description': 'The ID of the customer associated with this discount',
3960
+ },
3961
+ 'customer_account': {
3962
+ 'type': ['string', 'null'],
3963
+ 'description': 'The ID of the account associated with this discount',
3964
+ },
3965
+ 'end': {
3966
+ 'type': ['integer', 'null'],
3967
+ 'description': 'If the coupon has a duration of repeating, the date that this discount will end',
3968
+ },
3969
+ 'invoice': {
3970
+ 'type': ['string', 'null'],
3971
+ 'description': "The invoice that the discount's coupon was applied to",
3972
+ },
3973
+ 'invoice_item': {
3974
+ 'type': ['string', 'null'],
3975
+ 'description': "The invoice item that the discount's coupon was applied to",
3976
+ },
3977
+ 'promotion_code': {
3978
+ 'type': ['string', 'null'],
3979
+ 'description': 'The promotion code applied to create this discount',
3980
+ },
3981
+ 'source': {
3982
+ 'type': 'object',
3983
+ 'description': 'The source of the discount',
3984
+ 'properties': {
3985
+ 'coupon': {
3986
+ 'type': ['string', 'null'],
3987
+ 'description': 'The coupon that was redeemed to create this discount',
3988
+ },
3989
+ 'type': {
3990
+ 'type': 'string',
3991
+ 'enum': ['coupon'],
3992
+ 'description': 'The source type of the discount',
3993
+ },
3994
+ },
3995
+ },
3996
+ 'start': {'type': 'integer', 'description': 'Date that the coupon was applied'},
3997
+ 'subscription': {
3998
+ 'type': ['string', 'null'],
3999
+ 'description': 'The subscription that this coupon is applied to',
4000
+ },
4001
+ 'subscription_item': {
4002
+ 'type': ['string', 'null'],
4003
+ 'description': 'The subscription item that this coupon is applied to',
4004
+ },
4005
+ },
4006
+ },
4007
+ 'email': {
4008
+ 'type': ['string', 'null'],
4009
+ 'format': 'email',
4010
+ 'description': "The customer's email address",
4011
+ },
4012
+ 'individual_name': {
4013
+ 'type': ['string', 'null'],
4014
+ 'description': "The customer's individual name",
4015
+ },
4016
+ 'invoice_credit_balance': {'type': 'object', 'description': 'The current multi-currency balances stored on the customer'},
4017
+ 'invoice_prefix': {
4018
+ 'type': ['string', 'null'],
4019
+ 'description': 'The prefix for the customer used to generate unique invoice numbers',
4020
+ },
4021
+ 'invoice_settings': {
4022
+ 'type': 'object',
4023
+ 'description': "The customer's default invoice settings",
4024
+ 'properties': {
4025
+ 'custom_fields': {
4026
+ 'type': ['array', 'null'],
4027
+ 'description': 'Default custom fields to be displayed on invoices for this customer',
4028
+ 'items': {
4029
+ 'type': 'object',
4030
+ 'properties': {
4031
+ 'name': {'type': 'string', 'description': 'The name of the custom field'},
4032
+ 'value': {'type': 'string', 'description': 'The value of the custom field'},
4033
+ },
4034
+ },
4035
+ },
4036
+ 'default_payment_method': {
4037
+ 'type': ['string', 'null'],
4038
+ 'description': "ID of a payment method that's attached to the customer",
4039
+ },
4040
+ 'footer': {
4041
+ 'type': ['string', 'null'],
4042
+ 'description': 'Default footer to be displayed on invoices for this customer',
4043
+ },
4044
+ 'rendering_options': {
4045
+ 'type': ['object', 'null'],
4046
+ 'description': 'Default options for invoice PDF rendering for this customer',
4047
+ 'properties': {
4048
+ 'amount_tax_display': {
4049
+ 'type': ['string', 'null'],
4050
+ 'description': 'How line-item prices and amounts will be displayed with respect to tax on invoice PDFs',
4051
+ },
4052
+ 'template': {
4053
+ 'type': ['string', 'null'],
4054
+ 'description': "ID of the invoice rendering template to be used for this customer's invoices",
4055
+ },
4056
+ },
4057
+ },
4058
+ },
4059
+ },
4060
+ 'livemode': {'type': 'boolean', 'description': 'Has the value true if the object exists in live mode or false if in test mode'},
4061
+ 'metadata': {
4062
+ 'type': 'object',
4063
+ 'additionalProperties': {'type': 'string'},
4064
+ 'description': 'Set of key-value pairs that you can attach to an object',
4065
+ },
4066
+ 'name': {
4067
+ 'type': ['string', 'null'],
4068
+ 'description': "The customer's full name or business name",
4069
+ },
4070
+ 'next_invoice_sequence': {
4071
+ 'type': ['integer', 'null'],
4072
+ 'description': "The suffix of the customer's next invoice number",
4073
+ },
4074
+ 'phone': {
4075
+ 'type': ['string', 'null'],
4076
+ 'description': "The customer's phone number",
4077
+ },
4078
+ 'preferred_locales': {
4079
+ 'type': ['array', 'null'],
4080
+ 'items': {'type': 'string'},
4081
+ 'description': "The customer's preferred locales (languages), ordered by preference",
4082
+ },
4083
+ 'shipping': {
4084
+ 'type': ['object', 'null'],
4085
+ 'description': 'Mailing and shipping address for the customer',
4086
+ 'properties': {
4087
+ 'address': {
4088
+ 'type': 'object',
4089
+ 'description': 'Customer shipping address',
4090
+ 'properties': {
4091
+ 'city': {
4092
+ 'type': ['string', 'null'],
4093
+ 'description': 'City, district, suburb, town, or village',
4094
+ },
4095
+ 'country': {
4096
+ 'type': ['string', 'null'],
4097
+ 'description': 'Two-letter country code (ISO 3166-1 alpha-2)',
4098
+ },
4099
+ 'line1': {
4100
+ 'type': ['string', 'null'],
4101
+ 'description': 'Address line 1, such as the street, PO Box, or company name',
4102
+ },
4103
+ 'line2': {
4104
+ 'type': ['string', 'null'],
4105
+ 'description': 'Address line 2, such as the apartment, suite, unit, or building',
4106
+ },
4107
+ 'postal_code': {
4108
+ 'type': ['string', 'null'],
4109
+ 'description': 'ZIP or postal code',
4110
+ },
4111
+ 'state': {
4112
+ 'type': ['string', 'null'],
4113
+ 'description': 'State, county, province, or region',
4114
+ },
4115
+ },
4116
+ },
4117
+ 'name': {'type': 'string', 'description': 'Customer name'},
4118
+ 'phone': {
4119
+ 'type': ['string', 'null'],
4120
+ 'description': 'Customer phone (including extension)',
4121
+ },
4122
+ },
4123
+ },
4124
+ 'sources': {
4125
+ 'type': ['object', 'null'],
4126
+ 'description': "The customer's payment sources, if any",
4127
+ 'properties': {
4128
+ 'object': {
4129
+ 'type': 'string',
4130
+ 'enum': ['list'],
4131
+ 'description': "String representing the object's type",
4132
+ },
4133
+ 'data': {
4134
+ 'type': 'array',
4135
+ 'description': 'Details about each object',
4136
+ 'items': {
4137
+ 'type': 'object',
4138
+ 'properties': {
4139
+ 'id': {'type': 'string', 'description': 'Unique identifier for the object'},
4140
+ 'object': {'type': 'string', 'description': "String representing the object's type"},
4141
+ 'account': {
4142
+ 'type': ['string', 'null'],
4143
+ 'description': 'The account this bank account belongs to',
4144
+ },
4145
+ 'account_holder_name': {
4146
+ 'type': ['string', 'null'],
4147
+ 'description': 'The name of the person or business that owns the bank account',
4148
+ },
4149
+ 'account_holder_type': {
4150
+ 'type': ['string', 'null'],
4151
+ 'description': 'The type of entity that holds the account',
4152
+ },
4153
+ 'account_type': {
4154
+ 'type': ['string', 'null'],
4155
+ 'description': 'The bank account type',
4156
+ },
4157
+ 'available_payout_methods': {
4158
+ 'type': ['array', 'null'],
4159
+ 'description': 'A set of available payout methods for this bank account',
4160
+ 'items': {
4161
+ 'type': 'string',
4162
+ 'enum': ['instant', 'standard'],
4163
+ },
4164
+ },
4165
+ 'bank_name': {
4166
+ 'type': ['string', 'null'],
4167
+ 'description': 'Name of the bank associated with the routing number',
4168
+ },
4169
+ 'country': {'type': 'string', 'description': 'Two-letter ISO code representing the country the bank account is located in'},
4170
+ 'currency': {'type': 'string', 'description': 'Three-letter ISO code for the currency paid out to the bank account'},
4171
+ 'customer': {
4172
+ 'type': ['string', 'null'],
4173
+ 'description': 'The ID of the customer that the bank account is associated with',
4174
+ },
4175
+ 'fingerprint': {
4176
+ 'type': ['string', 'null'],
4177
+ 'description': 'Uniquely identifies this particular bank account',
4178
+ },
4179
+ 'last4': {'type': 'string', 'description': 'The last four digits of the bank account number'},
4180
+ 'metadata': {
4181
+ 'type': ['object', 'null'],
4182
+ 'description': 'Set of key-value pairs that you can attach to an object',
4183
+ 'additionalProperties': {'type': 'string'},
4184
+ },
4185
+ 'routing_number': {
4186
+ 'type': ['string', 'null'],
4187
+ 'description': 'The routing transit number for the bank account',
4188
+ },
4189
+ 'status': {'type': 'string', 'description': 'The status of the bank account'},
4190
+ },
4191
+ },
4192
+ },
4193
+ 'has_more': {'type': 'boolean', 'description': 'True if this list has another page of items after this one'},
4194
+ 'url': {'type': 'string', 'description': 'The URL where this list can be accessed'},
4195
+ },
4196
+ },
4197
+ 'subscriptions': {
4198
+ 'type': ['object', 'null'],
4199
+ 'description': "The customer's current subscriptions, if any",
4200
+ 'properties': {
4201
+ 'object': {
4202
+ 'type': 'string',
4203
+ 'enum': ['list'],
4204
+ 'description': "String representing the object's type",
4205
+ },
4206
+ 'data': {
4207
+ 'type': 'array',
4208
+ 'description': 'Details about each subscription',
4209
+ 'items': {
4210
+ 'type': 'object',
4211
+ 'properties': {
4212
+ 'id': {'type': 'string', 'description': 'Unique identifier for the object'},
4213
+ 'object': {
4214
+ 'type': 'string',
4215
+ 'description': "String representing the object's type",
4216
+ 'enum': ['subscription'],
4217
+ },
4218
+ 'application': {
4219
+ 'type': ['string', 'null'],
4220
+ 'description': 'ID of the Connect Application that created the subscription',
4221
+ },
4222
+ 'application_fee_percent': {
4223
+ 'type': ['number', 'null'],
4224
+ 'format': 'float',
4225
+ 'description': 'A non-negative decimal between 0 and 100, with at most two decimal places',
4226
+ },
4227
+ 'automatic_tax': {
4228
+ 'type': 'object',
4229
+ 'description': 'Automatic tax settings for this subscription',
4230
+ 'properties': {
4231
+ 'disabled_reason': {
4232
+ 'type': ['string', 'null'],
4233
+ 'description': 'If Stripe disabled automatic tax, this enum describes why',
4234
+ },
4235
+ 'enabled': {'type': 'boolean', 'description': 'Whether Stripe automatically computes tax on this subscription'},
4236
+ 'liability': {
4237
+ 'type': ['object', 'null'],
4238
+ 'description': "The account that's liable for tax",
4239
+ 'properties': {
4240
+ 'account': {
4241
+ 'type': ['string', 'null'],
4242
+ 'description': 'The connected account being referenced when type is account',
4243
+ },
4244
+ 'type': {
4245
+ 'type': 'string',
4246
+ 'enum': ['account', 'self'],
4247
+ 'description': 'Type of the account referenced',
4248
+ },
4249
+ },
4250
+ },
4251
+ },
4252
+ },
4253
+ 'billing_cycle_anchor': {
4254
+ 'type': 'integer',
4255
+ 'format': 'int64',
4256
+ 'description': 'The reference point that aligns future billing cycle dates',
4257
+ },
4258
+ 'billing_cycle_anchor_config': {
4259
+ 'type': ['object', 'null'],
4260
+ 'description': 'The fixed values used to calculate the billing_cycle_anchor',
4261
+ 'properties': {
4262
+ 'day_of_month': {'type': 'integer', 'description': 'The day of the month of the billing_cycle_anchor'},
4263
+ 'hour': {
4264
+ 'type': ['integer', 'null'],
4265
+ 'description': 'The hour of the day of the billing_cycle_anchor',
4266
+ },
4267
+ 'minute': {
4268
+ 'type': ['integer', 'null'],
4269
+ 'description': 'The minute of the hour of the billing_cycle_anchor',
4270
+ },
4271
+ 'month': {
4272
+ 'type': ['integer', 'null'],
4273
+ 'description': 'The month to start full cycle billing periods',
4274
+ },
4275
+ 'second': {
4276
+ 'type': ['integer', 'null'],
4277
+ 'description': 'The second of the minute of the billing_cycle_anchor',
4278
+ },
4279
+ },
4280
+ },
4281
+ 'billing_mode': {
4282
+ 'type': 'object',
4283
+ 'description': 'Controls how prorations and invoices for subscriptions are calculated and orchestrated',
4284
+ 'properties': {
4285
+ 'flexible': {
4286
+ 'type': ['object', 'null'],
4287
+ 'description': 'Configure behavior for flexible billing mode',
4288
+ 'properties': {
4289
+ 'proration_discounts': {
4290
+ 'type': 'string',
4291
+ 'enum': ['included', 'itemized'],
4292
+ 'description': 'Controls how invoices and invoice items display proration amounts and discount amounts',
4293
+ },
4294
+ },
4295
+ },
4296
+ 'type': {
4297
+ 'type': 'string',
4298
+ 'enum': ['classic', 'flexible'],
4299
+ 'description': 'Controls how prorations and invoices for subscriptions are calculated and orchestrated',
4300
+ },
4301
+ 'updated_at': {
4302
+ 'type': ['integer', 'null'],
4303
+ 'format': 'int64',
4304
+ 'description': 'Details on when the current billing_mode was adopted',
4305
+ },
4306
+ },
4307
+ },
4308
+ 'billing_thresholds': {
4309
+ 'type': ['object', 'null'],
4310
+ 'description': 'Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period',
4311
+ 'properties': {
4312
+ 'amount_gte': {
4313
+ 'type': ['integer', 'null'],
4314
+ 'description': 'Monetary threshold that triggers the subscription to create an invoice',
4315
+ },
4316
+ 'reset_billing_cycle_anchor': {
4317
+ 'type': ['boolean', 'null'],
4318
+ 'description': 'Indicates if the billing_cycle_anchor should be reset when a threshold is reached',
4319
+ },
4320
+ },
4321
+ },
4322
+ 'cancel_at': {
4323
+ 'type': ['integer', 'null'],
4324
+ 'format': 'int64',
4325
+ 'description': 'A date in the future at which the subscription will automatically get canceled',
4326
+ },
4327
+ 'cancel_at_period_end': {'type': 'boolean', 'description': 'Whether this subscription will (if status=active) or did (if status=canceled) cancel at the end of the current billing period'},
4328
+ 'canceled_at': {
4329
+ 'type': ['integer', 'null'],
4330
+ 'format': 'int64',
4331
+ 'description': 'If the subscription has been canceled, the date of that cancellation',
4332
+ },
4333
+ 'cancellation_details': {
4334
+ 'type': ['object', 'null'],
4335
+ 'description': 'Details about why this subscription was cancelled',
4336
+ 'properties': {
4337
+ 'comment': {
4338
+ 'type': ['string', 'null'],
4339
+ 'description': 'Additional comments about why the user canceled the subscription',
4340
+ },
4341
+ 'feedback': {
4342
+ 'type': ['string', 'null'],
4343
+ 'description': 'The customer submitted reason for why they canceled',
4344
+ },
4345
+ 'reason': {
4346
+ 'type': ['string', 'null'],
4347
+ 'description': 'Why this subscription was canceled',
4348
+ },
4349
+ },
4350
+ },
4351
+ 'collection_method': {
4352
+ 'type': 'string',
4353
+ 'enum': ['charge_automatically', 'send_invoice'],
4354
+ 'description': 'Either charge_automatically, or send_invoice',
4355
+ },
4356
+ 'created': {
4357
+ 'type': 'integer',
4358
+ 'format': 'int64',
4359
+ 'description': 'Time at which the object was created. Measured in seconds since the Unix epoch',
4360
+ },
4361
+ 'currency': {'type': 'string', 'description': 'Three-letter ISO currency code, in lowercase'},
4362
+ 'customer': {'type': 'string', 'description': 'ID of the customer who owns the subscription'},
4363
+ 'customer_account': {
4364
+ 'type': ['string', 'null'],
4365
+ 'description': 'ID of the account who owns the subscription',
4366
+ },
4367
+ 'days_until_due': {
4368
+ 'type': ['integer', 'null'],
4369
+ 'description': 'Number of days a customer has to pay invoices generated by this subscription',
4370
+ },
4371
+ 'default_payment_method': {
4372
+ 'type': ['string', 'null'],
4373
+ 'description': 'ID of the default payment method for the subscription',
4374
+ },
4375
+ 'default_source': {
4376
+ 'type': ['string', 'null'],
4377
+ 'description': 'ID of the default payment source for the subscription',
4378
+ },
4379
+ 'default_tax_rates': {
4380
+ 'type': ['array', 'null'],
4381
+ 'description': 'The tax rates that will apply to any subscription item that does not have tax_rates set',
4382
+ 'items': {
4383
+ 'type': 'object',
4384
+ 'properties': {
4385
+ 'id': {'type': 'string', 'description': 'Unique identifier for the object'},
4386
+ 'object': {'type': 'string', 'description': "String representing the object's type"},
4387
+ 'active': {'type': 'boolean', 'description': 'Defaults to true'},
4388
+ 'country': {
4389
+ 'type': ['string', 'null'],
4390
+ 'description': 'Two-letter country code (ISO 3166-1 alpha-2)',
4391
+ },
4392
+ 'created': {
4393
+ 'type': 'integer',
4394
+ 'format': 'int64',
4395
+ 'description': 'Time at which the object was created',
4396
+ },
4397
+ 'description': {
4398
+ 'type': ['string', 'null'],
4399
+ 'description': 'An arbitrary string attached to the tax rate for your internal use only',
4400
+ },
4401
+ 'display_name': {'type': 'string', 'description': 'The display name of the tax rates'},
4402
+ 'effective_percentage': {
4403
+ 'type': ['number', 'null'],
4404
+ 'description': 'Actual/effective tax rate percentage out of 100',
4405
+ },
4406
+ 'flat_amount': {
4407
+ 'type': ['object', 'null'],
4408
+ 'description': 'The amount of the tax rate when the rate_type is flat_amount',
4409
+ 'properties': {
4410
+ 'amount': {'type': 'integer', 'description': 'Amount of the tax when the rate_type is flat_amount'},
4411
+ 'currency': {'type': 'string', 'description': 'Three-letter ISO currency code, in lowercase'},
4412
+ },
2492
4413
  },
2493
4414
  'inclusive': {'type': 'boolean', 'description': 'This specifies if the tax rate is inclusive or exclusive'},
2494
4415
  'jurisdiction': {
@@ -3220,7 +5141,7 @@ StripeConnectorModel: ConnectorModel = ConnectorModel(
3220
5141
  ),
3221
5142
  EntityDefinition(
3222
5143
  name='invoices',
3223
- actions=[Action.LIST, Action.GET, Action.SEARCH],
5144
+ actions=[Action.LIST, Action.GET, Action.API_SEARCH],
3224
5145
  endpoints={
3225
5146
  Action.LIST: EndpointDefinition(
3226
5147
  method='GET',
@@ -5403,10 +7324,10 @@ StripeConnectorModel: ConnectorModel = ConnectorModel(
5403
7324
  'x-airbyte-entity-name': 'invoices',
5404
7325
  },
5405
7326
  ),
5406
- Action.SEARCH: EndpointDefinition(
7327
+ Action.API_SEARCH: EndpointDefinition(
5407
7328
  method='GET',
5408
7329
  path='/v1/invoices/search',
5409
- action=Action.SEARCH,
7330
+ action=Action.API_SEARCH,
5410
7331
  description="Search for invoices using Stripe's Search Query Language",
5411
7332
  query_params=['query', 'limit', 'page'],
5412
7333
  query_params_schema={
@@ -7563,7 +9484,7 @@ StripeConnectorModel: ConnectorModel = ConnectorModel(
7563
9484
  ),
7564
9485
  EntityDefinition(
7565
9486
  name='charges',
7566
- actions=[Action.LIST, Action.GET, Action.SEARCH],
9487
+ actions=[Action.LIST, Action.GET, Action.API_SEARCH],
7567
9488
  endpoints={
7568
9489
  Action.LIST: EndpointDefinition(
7569
9490
  method='GET',
@@ -8364,10 +10285,10 @@ StripeConnectorModel: ConnectorModel = ConnectorModel(
8364
10285
  'x-airbyte-entity-name': 'charges',
8365
10286
  },
8366
10287
  ),
8367
- Action.SEARCH: EndpointDefinition(
10288
+ Action.API_SEARCH: EndpointDefinition(
8368
10289
  method='GET',
8369
10290
  path='/v1/charges/search',
8370
- action=Action.SEARCH,
10291
+ action=Action.API_SEARCH,
8371
10292
  description="Search for charges using Stripe's Search Query Language",
8372
10293
  query_params=['query', 'limit', 'page'],
8373
10294
  query_params_schema={
@@ -9148,7 +11069,7 @@ StripeConnectorModel: ConnectorModel = ConnectorModel(
9148
11069
  ),
9149
11070
  EntityDefinition(
9150
11071
  name='subscriptions',
9151
- actions=[Action.LIST, Action.GET, Action.SEARCH],
11072
+ actions=[Action.LIST, Action.GET, Action.API_SEARCH],
9152
11073
  endpoints={
9153
11074
  Action.LIST: EndpointDefinition(
9154
11075
  method='GET',
@@ -10260,10 +12181,10 @@ StripeConnectorModel: ConnectorModel = ConnectorModel(
10260
12181
  'x-airbyte-entity-name': 'subscriptions',
10261
12182
  },
10262
12183
  ),
10263
- Action.SEARCH: EndpointDefinition(
12184
+ Action.API_SEARCH: EndpointDefinition(
10264
12185
  method='GET',
10265
12186
  path='/v1/subscriptions/search',
10266
- action=Action.SEARCH,
12187
+ action=Action.API_SEARCH,
10267
12188
  description="Search for subscriptions using Stripe's Search Query Language",
10268
12189
  query_params=['query', 'limit', 'page'],
10269
12190
  query_params_schema={
@@ -11338,7 +13259,7 @@ StripeConnectorModel: ConnectorModel = ConnectorModel(
11338
13259
  ),
11339
13260
  EntityDefinition(
11340
13261
  name='refunds',
11341
- actions=[Action.LIST, Action.GET],
13262
+ actions=[Action.LIST, Action.CREATE, Action.GET],
11342
13263
  endpoints={
11343
13264
  Action.LIST: EndpointDefinition(
11344
13265
  method='GET',
@@ -11719,99 +13640,568 @@ StripeConnectorModel: ConnectorModel = ConnectorModel(
11719
13640
  },
11720
13641
  },
11721
13642
  },
11722
- 'failure_balance_transaction': {
11723
- 'type': ['string', 'null'],
11724
- 'description': 'After the refund fails, this balance transaction describes the adjustment made on your account balance',
13643
+ 'failure_balance_transaction': {
13644
+ 'type': ['string', 'null'],
13645
+ 'description': 'After the refund fails, this balance transaction describes the adjustment made on your account balance',
13646
+ },
13647
+ 'failure_reason': {
13648
+ 'type': ['string', 'null'],
13649
+ 'description': 'Reason for refund failure if status is failed',
13650
+ },
13651
+ 'instructions_email': {
13652
+ 'type': ['string', 'null'],
13653
+ 'description': 'Email address to which instructions for refund were sent',
13654
+ },
13655
+ 'metadata': {
13656
+ 'type': ['object', 'null'],
13657
+ 'additionalProperties': {'type': 'string'},
13658
+ 'description': 'Set of key-value pairs for storing additional information',
13659
+ },
13660
+ 'next_action': {
13661
+ 'type': ['object', 'null'],
13662
+ 'description': 'If the refund has a status of requires_action, this property describes what the refund needs to continue processing',
13663
+ 'properties': {
13664
+ 'display_details': {
13665
+ 'type': ['object', 'null'],
13666
+ 'description': 'Contains the refund details',
13667
+ 'properties': {
13668
+ 'email_sent': {
13669
+ 'type': 'object',
13670
+ 'description': 'Contains information about the email sent to the customer',
13671
+ 'properties': {
13672
+ 'email_sent_at': {
13673
+ 'type': 'integer',
13674
+ 'format': 'int64',
13675
+ 'description': 'The timestamp when the email was sent',
13676
+ },
13677
+ 'email_sent_to': {'type': 'string', 'description': "The recipient's email address"},
13678
+ },
13679
+ },
13680
+ 'expires_at': {
13681
+ 'type': 'integer',
13682
+ 'format': 'int64',
13683
+ 'description': 'The expiry timestamp',
13684
+ },
13685
+ },
13686
+ },
13687
+ 'type': {'type': 'string', 'description': 'Type of the next action to perform'},
13688
+ },
13689
+ },
13690
+ 'payment_intent': {
13691
+ 'type': ['string', 'null'],
13692
+ 'description': 'ID of the PaymentIntent that was refunded',
13693
+ },
13694
+ 'pending_reason': {
13695
+ 'type': ['string', 'null'],
13696
+ 'description': 'Reason for why the refund is pending',
13697
+ 'enum': ['processing', 'insufficient_funds', 'charge_pending'],
13698
+ },
13699
+ 'reason': {
13700
+ 'type': ['string', 'null'],
13701
+ 'description': 'Reason for the refund',
13702
+ },
13703
+ 'receipt_number': {
13704
+ 'type': ['string', 'null'],
13705
+ 'description': 'Transaction number that appears on email receipts sent for this refund',
13706
+ },
13707
+ 'source_transfer_reversal': {
13708
+ 'type': ['string', 'null'],
13709
+ 'description': 'The transfer reversal that is associated with the refund',
13710
+ },
13711
+ 'status': {
13712
+ 'type': ['string', 'null'],
13713
+ 'description': 'Status of the refund',
13714
+ 'enum': [
13715
+ 'pending',
13716
+ 'requires_action',
13717
+ 'succeeded',
13718
+ 'failed',
13719
+ 'canceled',
13720
+ ],
13721
+ },
13722
+ 'transfer_reversal': {
13723
+ 'type': ['string', 'null'],
13724
+ 'description': 'If the refund is associated with a transfer, the ID of the transfer reversal',
13725
+ },
13726
+ },
13727
+ 'x-airbyte-entity-name': 'refunds',
13728
+ },
13729
+ },
13730
+ 'has_more': {'type': 'boolean'},
13731
+ 'url': {'type': 'string'},
13732
+ },
13733
+ },
13734
+ record_extractor='$.data',
13735
+ meta_extractor={'has_more': '$.has_more'},
13736
+ ),
13737
+ Action.CREATE: EndpointDefinition(
13738
+ method='POST',
13739
+ path='/v1/refunds',
13740
+ action=Action.CREATE,
13741
+ description='When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it. Creating a new refund will refund a charge that has previously been created but not yet refunded.',
13742
+ body_fields=[
13743
+ 'charge',
13744
+ 'payment_intent',
13745
+ 'amount',
13746
+ 'metadata',
13747
+ 'reason',
13748
+ 'refund_application_fee',
13749
+ 'reverse_transfer',
13750
+ ],
13751
+ content_type=ContentType.FORM_URLENCODED,
13752
+ request_schema={
13753
+ 'type': 'object',
13754
+ 'properties': {
13755
+ 'charge': {'type': 'string', 'description': 'The identifier of the charge to refund'},
13756
+ 'payment_intent': {'type': 'string', 'description': 'The identifier of the PaymentIntent to refund'},
13757
+ 'amount': {'type': 'integer', 'description': 'A positive integer in the smallest currency unit representing how much to refund. Can refund only up to the remaining, unrefunded amount'},
13758
+ 'metadata': {
13759
+ 'type': 'object',
13760
+ 'description': 'Set of key-value pairs that you can attach to an object',
13761
+ 'additionalProperties': {'type': 'string'},
13762
+ },
13763
+ 'reason': {
13764
+ 'type': 'string',
13765
+ 'enum': ['duplicate', 'fraudulent', 'requested_by_customer'],
13766
+ 'description': 'String indicating the reason for the refund',
13767
+ },
13768
+ 'refund_application_fee': {'type': 'boolean', 'description': 'Whether to refund the application fee'},
13769
+ 'reverse_transfer': {'type': 'boolean', 'description': 'Whether to reverse the transfer'},
13770
+ },
13771
+ },
13772
+ response_schema={
13773
+ 'type': 'object',
13774
+ 'properties': {
13775
+ 'id': {'type': 'string', 'description': 'Unique identifier for the refund'},
13776
+ 'object': {
13777
+ 'type': 'string',
13778
+ 'description': "String representing the object's type",
13779
+ 'enum': ['refund'],
13780
+ },
13781
+ 'amount': {'type': 'integer', 'description': 'Amount refunded (in smallest currency unit)'},
13782
+ 'balance_transaction': {
13783
+ 'type': ['string', 'null'],
13784
+ 'description': 'Balance transaction that describes the impact on your account balance',
13785
+ },
13786
+ 'charge': {
13787
+ 'type': ['string', 'null'],
13788
+ 'description': 'ID of the charge that was refunded',
13789
+ },
13790
+ 'created': {
13791
+ 'type': 'integer',
13792
+ 'format': 'int64',
13793
+ 'description': 'Time at which the refund was created (Unix timestamp)',
13794
+ },
13795
+ 'currency': {'type': 'string', 'description': 'Three-letter ISO currency code (lowercase)'},
13796
+ 'description': {
13797
+ 'type': ['string', 'null'],
13798
+ 'description': 'An arbitrary string attached to the object',
13799
+ },
13800
+ 'destination_details': {
13801
+ 'type': ['object', 'null'],
13802
+ 'description': 'Transaction-specific details for the refund',
13803
+ 'properties': {
13804
+ 'affirm': {
13805
+ 'type': ['object', 'null'],
13806
+ 'description': 'If this is a affirm refund, this hash contains the transaction specific details',
13807
+ },
13808
+ 'afterpay_clearpay': {
13809
+ 'type': ['object', 'null'],
13810
+ 'description': 'If this is a afterpay_clearpay refund, this hash contains the transaction specific details',
13811
+ },
13812
+ 'alipay': {
13813
+ 'type': ['object', 'null'],
13814
+ 'description': 'If this is a alipay refund, this hash contains the transaction specific details',
13815
+ },
13816
+ 'alma': {
13817
+ 'type': ['object', 'null'],
13818
+ 'description': 'If this is a alma refund, this hash contains the transaction specific details',
13819
+ },
13820
+ 'amazon_pay': {
13821
+ 'type': ['object', 'null'],
13822
+ 'description': 'If this is a amazon_pay refund, this hash contains the transaction specific details',
13823
+ },
13824
+ 'au_bank_transfer': {
13825
+ 'type': ['object', 'null'],
13826
+ 'description': 'If this is a au_bank_transfer refund, this hash contains the transaction specific details',
13827
+ },
13828
+ 'blik': {
13829
+ 'type': ['object', 'null'],
13830
+ 'description': 'If this is a blik refund, this hash contains the transaction specific details',
13831
+ 'properties': {
13832
+ 'network_decline_code': {
13833
+ 'type': ['string', 'null'],
13834
+ 'description': 'For refunds declined by the network, a decline code provided by the network',
13835
+ },
13836
+ 'reference': {
13837
+ 'type': ['string', 'null'],
13838
+ 'description': 'The reference assigned to the refund',
13839
+ },
13840
+ 'reference_status': {
13841
+ 'type': ['string', 'null'],
13842
+ 'description': 'Status of the reference on the refund',
13843
+ 'enum': ['pending', 'available', 'unavailable'],
13844
+ },
13845
+ },
13846
+ },
13847
+ 'br_bank_transfer': {
13848
+ 'type': ['object', 'null'],
13849
+ 'description': 'If this is a br_bank_transfer refund, this hash contains the transaction specific details',
13850
+ 'properties': {
13851
+ 'reference': {
13852
+ 'type': ['string', 'null'],
13853
+ 'description': 'The reference assigned to the refund',
13854
+ },
13855
+ 'reference_status': {
13856
+ 'type': ['string', 'null'],
13857
+ 'description': 'Status of the reference on the refund',
13858
+ 'enum': ['pending', 'available', 'unavailable'],
13859
+ },
13860
+ },
13861
+ },
13862
+ 'card': {
13863
+ 'type': ['object', 'null'],
13864
+ 'description': 'If this is a card refund, this hash contains the transaction specific details',
13865
+ 'properties': {
13866
+ 'reference': {
13867
+ 'type': ['string', 'null'],
13868
+ 'description': 'Value of the reference number assigned to the refund',
13869
+ },
13870
+ 'reference_status': {
13871
+ 'type': ['string', 'null'],
13872
+ 'description': 'Status of the reference number on the refund',
13873
+ 'enum': ['pending', 'available', 'unavailable'],
13874
+ },
13875
+ 'reference_type': {
13876
+ 'type': ['string', 'null'],
13877
+ 'description': 'Type of the reference number assigned to the refund',
13878
+ },
13879
+ 'type': {
13880
+ 'type': 'string',
13881
+ 'description': 'The type of refund',
13882
+ 'enum': ['pending', 'refund', 'reversal'],
13883
+ },
13884
+ },
13885
+ },
13886
+ 'cashapp': {
13887
+ 'type': ['object', 'null'],
13888
+ 'description': 'If this is a cashapp refund, this hash contains the transaction specific details',
13889
+ },
13890
+ 'crypto': {
13891
+ 'type': ['object', 'null'],
13892
+ 'description': 'If this is a crypto refund, this hash contains the transaction specific details',
13893
+ 'properties': {
13894
+ 'reference': {
13895
+ 'type': ['string', 'null'],
13896
+ 'description': 'The transaction hash of the refund',
13897
+ },
13898
+ },
13899
+ },
13900
+ 'customer_cash_balance': {
13901
+ 'type': ['object', 'null'],
13902
+ 'description': 'If this is a customer_cash_balance refund, this hash contains the transaction specific details',
13903
+ },
13904
+ 'eps': {
13905
+ 'type': ['object', 'null'],
13906
+ 'description': 'If this is a eps refund, this hash contains the transaction specific details',
13907
+ },
13908
+ 'eu_bank_transfer': {
13909
+ 'type': ['object', 'null'],
13910
+ 'description': 'If this is a eu_bank_transfer refund, this hash contains the transaction specific details',
13911
+ 'properties': {
13912
+ 'reference': {
13913
+ 'type': ['string', 'null'],
13914
+ 'description': 'The reference assigned to the refund',
13915
+ },
13916
+ 'reference_status': {
13917
+ 'type': ['string', 'null'],
13918
+ 'description': 'Status of the reference on the refund',
13919
+ 'enum': ['pending', 'available', 'unavailable'],
13920
+ },
13921
+ },
13922
+ },
13923
+ 'gb_bank_transfer': {
13924
+ 'type': ['object', 'null'],
13925
+ 'description': 'If this is a gb_bank_transfer refund, this hash contains the transaction specific details',
13926
+ 'properties': {
13927
+ 'reference': {
13928
+ 'type': ['string', 'null'],
13929
+ 'description': 'The reference assigned to the refund',
13930
+ },
13931
+ 'reference_status': {
13932
+ 'type': ['string', 'null'],
13933
+ 'description': 'Status of the reference on the refund',
13934
+ 'enum': ['pending', 'available', 'unavailable'],
13935
+ },
13936
+ },
13937
+ },
13938
+ 'giropay': {
13939
+ 'type': ['object', 'null'],
13940
+ 'description': 'If this is a giropay refund, this hash contains the transaction specific details',
13941
+ },
13942
+ 'grabpay': {
13943
+ 'type': ['object', 'null'],
13944
+ 'description': 'If this is a grabpay refund, this hash contains the transaction specific details',
13945
+ },
13946
+ 'jp_bank_transfer': {
13947
+ 'type': ['object', 'null'],
13948
+ 'description': 'If this is a jp_bank_transfer refund, this hash contains the transaction specific details',
13949
+ 'properties': {
13950
+ 'reference': {
13951
+ 'type': ['string', 'null'],
13952
+ 'description': 'The reference assigned to the refund',
13953
+ },
13954
+ 'reference_status': {
13955
+ 'type': ['string', 'null'],
13956
+ 'description': 'Status of the reference on the refund',
13957
+ 'enum': ['pending', 'available', 'unavailable'],
13958
+ },
13959
+ },
13960
+ },
13961
+ 'klarna': {
13962
+ 'type': ['object', 'null'],
13963
+ 'description': 'If this is a klarna refund, this hash contains the transaction specific details',
13964
+ },
13965
+ 'mb_way': {
13966
+ 'type': ['object', 'null'],
13967
+ 'description': 'If this is a mb_way refund, this hash contains the transaction specific details',
13968
+ 'properties': {
13969
+ 'reference': {
13970
+ 'type': ['string', 'null'],
13971
+ 'description': 'The reference assigned to the refund',
13972
+ },
13973
+ 'reference_status': {
13974
+ 'type': ['string', 'null'],
13975
+ 'description': 'Status of the reference on the refund',
13976
+ 'enum': ['pending', 'available', 'unavailable'],
13977
+ },
13978
+ },
13979
+ },
13980
+ 'multibanco': {
13981
+ 'type': ['object', 'null'],
13982
+ 'description': 'If this is a multibanco refund, this hash contains the transaction specific details',
13983
+ 'properties': {
13984
+ 'reference': {
13985
+ 'type': ['string', 'null'],
13986
+ 'description': 'The reference assigned to the refund',
13987
+ },
13988
+ 'reference_status': {
13989
+ 'type': ['string', 'null'],
13990
+ 'description': 'Status of the reference on the refund',
13991
+ 'enum': ['pending', 'available', 'unavailable'],
13992
+ },
13993
+ },
13994
+ },
13995
+ 'mx_bank_transfer': {
13996
+ 'type': ['object', 'null'],
13997
+ 'description': 'If this is a mx_bank_transfer refund, this hash contains the transaction specific details',
13998
+ 'properties': {
13999
+ 'reference': {
14000
+ 'type': ['string', 'null'],
14001
+ 'description': 'The reference assigned to the refund',
14002
+ },
14003
+ 'reference_status': {
14004
+ 'type': ['string', 'null'],
14005
+ 'description': 'Status of the reference on the refund',
14006
+ 'enum': ['pending', 'available', 'unavailable'],
14007
+ },
14008
+ },
14009
+ },
14010
+ 'nz_bank_transfer': {
14011
+ 'type': ['object', 'null'],
14012
+ 'description': 'If this is a nz_bank_transfer refund, this hash contains the transaction specific details',
14013
+ },
14014
+ 'p24': {
14015
+ 'type': ['object', 'null'],
14016
+ 'description': 'If this is a p24 refund, this hash contains the transaction specific details',
14017
+ 'properties': {
14018
+ 'reference': {
14019
+ 'type': ['string', 'null'],
14020
+ 'description': 'The reference assigned to the refund',
14021
+ },
14022
+ 'reference_status': {
14023
+ 'type': ['string', 'null'],
14024
+ 'description': 'Status of the reference on the refund',
14025
+ 'enum': ['pending', 'available', 'unavailable'],
14026
+ },
11725
14027
  },
11726
- 'failure_reason': {
11727
- 'type': ['string', 'null'],
11728
- 'description': 'Reason for refund failure if status is failed',
14028
+ },
14029
+ 'paynow': {
14030
+ 'type': ['object', 'null'],
14031
+ 'description': 'If this is a paynow refund, this hash contains the transaction specific details',
14032
+ },
14033
+ 'paypal': {
14034
+ 'type': ['object', 'null'],
14035
+ 'description': 'If this is a paypal refund, this hash contains the transaction specific details',
14036
+ 'properties': {
14037
+ 'network_decline_code': {
14038
+ 'type': ['string', 'null'],
14039
+ 'description': 'For refunds declined by the network, a decline code provided by the network',
14040
+ },
11729
14041
  },
11730
- 'instructions_email': {
11731
- 'type': ['string', 'null'],
11732
- 'description': 'Email address to which instructions for refund were sent',
14042
+ },
14043
+ 'pix': {
14044
+ 'type': ['object', 'null'],
14045
+ 'description': 'If this is a pix refund, this hash contains the transaction specific details',
14046
+ },
14047
+ 'revolut': {
14048
+ 'type': ['object', 'null'],
14049
+ 'description': 'If this is a revolut refund, this hash contains the transaction specific details',
14050
+ },
14051
+ 'sofort': {
14052
+ 'type': ['object', 'null'],
14053
+ 'description': 'If this is a sofort refund, this hash contains the transaction specific details',
14054
+ },
14055
+ 'swish': {
14056
+ 'type': ['object', 'null'],
14057
+ 'description': 'If this is a swish refund, this hash contains the transaction specific details',
14058
+ 'properties': {
14059
+ 'network_decline_code': {
14060
+ 'type': ['string', 'null'],
14061
+ 'description': 'For refunds declined by the network, a decline code provided by the network',
14062
+ },
14063
+ 'reference': {
14064
+ 'type': ['string', 'null'],
14065
+ 'description': 'The reference assigned to the refund',
14066
+ },
14067
+ 'reference_status': {
14068
+ 'type': ['string', 'null'],
14069
+ 'description': 'Status of the reference on the refund',
14070
+ 'enum': ['pending', 'available', 'unavailable'],
14071
+ },
11733
14072
  },
11734
- 'metadata': {
11735
- 'type': ['object', 'null'],
11736
- 'additionalProperties': {'type': 'string'},
11737
- 'description': 'Set of key-value pairs for storing additional information',
14073
+ },
14074
+ 'th_bank_transfer': {
14075
+ 'type': ['object', 'null'],
14076
+ 'description': 'If this is a th_bank_transfer refund, this hash contains the transaction specific details',
14077
+ 'properties': {
14078
+ 'reference': {
14079
+ 'type': ['string', 'null'],
14080
+ 'description': 'The reference assigned to the refund',
14081
+ },
14082
+ 'reference_status': {
14083
+ 'type': ['string', 'null'],
14084
+ 'description': 'Status of the reference on the refund',
14085
+ 'enum': ['pending', 'available', 'unavailable'],
14086
+ },
11738
14087
  },
11739
- 'next_action': {
11740
- 'type': ['object', 'null'],
11741
- 'description': 'If the refund has a status of requires_action, this property describes what the refund needs to continue processing',
11742
- 'properties': {
11743
- 'display_details': {
11744
- 'type': ['object', 'null'],
11745
- 'description': 'Contains the refund details',
11746
- 'properties': {
11747
- 'email_sent': {
11748
- 'type': 'object',
11749
- 'description': 'Contains information about the email sent to the customer',
11750
- 'properties': {
11751
- 'email_sent_at': {
11752
- 'type': 'integer',
11753
- 'format': 'int64',
11754
- 'description': 'The timestamp when the email was sent',
11755
- },
11756
- 'email_sent_to': {'type': 'string', 'description': "The recipient's email address"},
11757
- },
11758
- },
11759
- 'expires_at': {
11760
- 'type': 'integer',
11761
- 'format': 'int64',
11762
- 'description': 'The expiry timestamp',
11763
- },
14088
+ },
14089
+ 'twint': {
14090
+ 'type': ['object', 'null'],
14091
+ 'description': 'If this is a twint refund, this hash contains the transaction specific details',
14092
+ },
14093
+ 'type': {'type': 'string', 'description': 'The type of transaction-specific details of the payment method used in the refund'},
14094
+ 'us_bank_transfer': {
14095
+ 'type': ['object', 'null'],
14096
+ 'description': 'If this is a us_bank_transfer refund, this hash contains the transaction specific details',
14097
+ 'properties': {
14098
+ 'reference': {
14099
+ 'type': ['string', 'null'],
14100
+ 'description': 'The reference assigned to the refund',
14101
+ },
14102
+ 'reference_status': {
14103
+ 'type': ['string', 'null'],
14104
+ 'description': 'Status of the reference on the refund',
14105
+ 'enum': ['pending', 'available', 'unavailable'],
14106
+ },
14107
+ },
14108
+ },
14109
+ 'wechat_pay': {
14110
+ 'type': ['object', 'null'],
14111
+ 'description': 'If this is a wechat_pay refund, this hash contains the transaction specific details',
14112
+ },
14113
+ 'zip': {
14114
+ 'type': ['object', 'null'],
14115
+ 'description': 'If this is a zip refund, this hash contains the transaction specific details',
14116
+ },
14117
+ },
14118
+ },
14119
+ 'failure_balance_transaction': {
14120
+ 'type': ['string', 'null'],
14121
+ 'description': 'After the refund fails, this balance transaction describes the adjustment made on your account balance',
14122
+ },
14123
+ 'failure_reason': {
14124
+ 'type': ['string', 'null'],
14125
+ 'description': 'Reason for refund failure if status is failed',
14126
+ },
14127
+ 'instructions_email': {
14128
+ 'type': ['string', 'null'],
14129
+ 'description': 'Email address to which instructions for refund were sent',
14130
+ },
14131
+ 'metadata': {
14132
+ 'type': ['object', 'null'],
14133
+ 'additionalProperties': {'type': 'string'},
14134
+ 'description': 'Set of key-value pairs for storing additional information',
14135
+ },
14136
+ 'next_action': {
14137
+ 'type': ['object', 'null'],
14138
+ 'description': 'If the refund has a status of requires_action, this property describes what the refund needs to continue processing',
14139
+ 'properties': {
14140
+ 'display_details': {
14141
+ 'type': ['object', 'null'],
14142
+ 'description': 'Contains the refund details',
14143
+ 'properties': {
14144
+ 'email_sent': {
14145
+ 'type': 'object',
14146
+ 'description': 'Contains information about the email sent to the customer',
14147
+ 'properties': {
14148
+ 'email_sent_at': {
14149
+ 'type': 'integer',
14150
+ 'format': 'int64',
14151
+ 'description': 'The timestamp when the email was sent',
11764
14152
  },
14153
+ 'email_sent_to': {'type': 'string', 'description': "The recipient's email address"},
11765
14154
  },
11766
- 'type': {'type': 'string', 'description': 'Type of the next action to perform'},
11767
14155
  },
11768
- },
11769
- 'payment_intent': {
11770
- 'type': ['string', 'null'],
11771
- 'description': 'ID of the PaymentIntent that was refunded',
11772
- },
11773
- 'pending_reason': {
11774
- 'type': ['string', 'null'],
11775
- 'description': 'Reason for why the refund is pending',
11776
- 'enum': ['processing', 'insufficient_funds', 'charge_pending'],
11777
- },
11778
- 'reason': {
11779
- 'type': ['string', 'null'],
11780
- 'description': 'Reason for the refund',
11781
- },
11782
- 'receipt_number': {
11783
- 'type': ['string', 'null'],
11784
- 'description': 'Transaction number that appears on email receipts sent for this refund',
11785
- },
11786
- 'source_transfer_reversal': {
11787
- 'type': ['string', 'null'],
11788
- 'description': 'The transfer reversal that is associated with the refund',
11789
- },
11790
- 'status': {
11791
- 'type': ['string', 'null'],
11792
- 'description': 'Status of the refund',
11793
- 'enum': [
11794
- 'pending',
11795
- 'requires_action',
11796
- 'succeeded',
11797
- 'failed',
11798
- 'canceled',
11799
- ],
11800
- },
11801
- 'transfer_reversal': {
11802
- 'type': ['string', 'null'],
11803
- 'description': 'If the refund is associated with a transfer, the ID of the transfer reversal',
14156
+ 'expires_at': {
14157
+ 'type': 'integer',
14158
+ 'format': 'int64',
14159
+ 'description': 'The expiry timestamp',
14160
+ },
11804
14161
  },
11805
14162
  },
11806
- 'x-airbyte-entity-name': 'refunds',
14163
+ 'type': {'type': 'string', 'description': 'Type of the next action to perform'},
11807
14164
  },
11808
14165
  },
11809
- 'has_more': {'type': 'boolean'},
11810
- 'url': {'type': 'string'},
14166
+ 'payment_intent': {
14167
+ 'type': ['string', 'null'],
14168
+ 'description': 'ID of the PaymentIntent that was refunded',
14169
+ },
14170
+ 'pending_reason': {
14171
+ 'type': ['string', 'null'],
14172
+ 'description': 'Reason for why the refund is pending',
14173
+ 'enum': ['processing', 'insufficient_funds', 'charge_pending'],
14174
+ },
14175
+ 'reason': {
14176
+ 'type': ['string', 'null'],
14177
+ 'description': 'Reason for the refund',
14178
+ },
14179
+ 'receipt_number': {
14180
+ 'type': ['string', 'null'],
14181
+ 'description': 'Transaction number that appears on email receipts sent for this refund',
14182
+ },
14183
+ 'source_transfer_reversal': {
14184
+ 'type': ['string', 'null'],
14185
+ 'description': 'The transfer reversal that is associated with the refund',
14186
+ },
14187
+ 'status': {
14188
+ 'type': ['string', 'null'],
14189
+ 'description': 'Status of the refund',
14190
+ 'enum': [
14191
+ 'pending',
14192
+ 'requires_action',
14193
+ 'succeeded',
14194
+ 'failed',
14195
+ 'canceled',
14196
+ ],
14197
+ },
14198
+ 'transfer_reversal': {
14199
+ 'type': ['string', 'null'],
14200
+ 'description': 'If the refund is associated with a transfer, the ID of the transfer reversal',
14201
+ },
11811
14202
  },
14203
+ 'x-airbyte-entity-name': 'refunds',
11812
14204
  },
11813
- record_extractor='$.data',
11814
- meta_extractor={'has_more': '$.has_more'},
11815
14205
  ),
11816
14206
  Action.GET: EndpointDefinition(
11817
14207
  method='GET',
@@ -12693,7 +15083,14 @@ StripeConnectorModel: ConnectorModel = ConnectorModel(
12693
15083
  ),
12694
15084
  EntityDefinition(
12695
15085
  name='products',
12696
- actions=[Action.LIST, Action.GET, Action.SEARCH],
15086
+ actions=[
15087
+ Action.LIST,
15088
+ Action.CREATE,
15089
+ Action.GET,
15090
+ Action.UPDATE,
15091
+ Action.DELETE,
15092
+ Action.API_SEARCH,
15093
+ ],
12697
15094
  endpoints={
12698
15095
  Action.LIST: EndpointDefinition(
12699
15096
  method='GET',
@@ -12720,131 +15117,464 @@ StripeConnectorModel: ConnectorModel = ConnectorModel(
12720
15117
  'starting_after': {'type': 'string', 'required': False},
12721
15118
  'url': {'type': 'string', 'required': False},
12722
15119
  },
12723
- deep_object_params=['created'],
15120
+ deep_object_params=['created'],
15121
+ response_schema={
15122
+ 'type': 'object',
15123
+ 'properties': {
15124
+ 'object': {
15125
+ 'type': 'string',
15126
+ 'enum': ['list'],
15127
+ },
15128
+ 'data': {
15129
+ 'type': 'array',
15130
+ 'items': {
15131
+ 'type': 'object',
15132
+ 'properties': {
15133
+ 'id': {'type': 'string', 'description': 'Unique identifier for the product'},
15134
+ 'object': {
15135
+ 'type': 'string',
15136
+ 'description': "String representing the object's type",
15137
+ 'enum': ['product'],
15138
+ },
15139
+ 'active': {'type': 'boolean', 'description': 'Whether the product is currently available for purchase'},
15140
+ 'attributes': {
15141
+ 'type': 'array',
15142
+ 'description': 'A list of up to 5 alphanumeric attributes that each SKU can have',
15143
+ 'items': {'type': 'string'},
15144
+ },
15145
+ 'created': {'type': 'integer', 'description': 'Time at which the product was created, measured in seconds since the Unix epoch'},
15146
+ 'default_price': {
15147
+ 'type': ['string', 'null'],
15148
+ 'description': 'The ID of the Price object that is the default price for this product',
15149
+ },
15150
+ 'description': {
15151
+ 'type': ['string', 'null'],
15152
+ 'description': "The product's description, meant to be displayable to the customer",
15153
+ },
15154
+ 'features': {
15155
+ 'type': 'array',
15156
+ 'description': 'A list of up to 15 features for this product',
15157
+ 'items': {
15158
+ 'type': 'object',
15159
+ 'properties': {
15160
+ 'name': {'type': 'string', 'description': 'The feature name'},
15161
+ },
15162
+ },
15163
+ },
15164
+ 'images': {
15165
+ 'type': 'array',
15166
+ 'description': 'A list of up to 8 URLs of images for this product',
15167
+ 'items': {'type': 'string'},
15168
+ },
15169
+ 'livemode': {'type': 'boolean', 'description': 'Has the value true if the object exists in live mode or the value false if the object exists in test mode'},
15170
+ 'marketing_features': {
15171
+ 'type': 'array',
15172
+ 'description': 'A list of up to 15 marketing features for this product',
15173
+ 'items': {
15174
+ 'type': 'object',
15175
+ 'properties': {
15176
+ 'name': {
15177
+ 'type': ['string', 'null'],
15178
+ 'description': 'The marketing feature name. Up to 80 characters long',
15179
+ },
15180
+ },
15181
+ },
15182
+ },
15183
+ 'metadata': {
15184
+ 'type': 'object',
15185
+ 'description': 'Set of key-value pairs that you can attach to an object',
15186
+ 'additionalProperties': {'type': 'string'},
15187
+ },
15188
+ 'name': {'type': 'string', 'description': "The product's name, meant to be displayable to the customer"},
15189
+ 'package_dimensions': {
15190
+ 'type': ['object', 'null'],
15191
+ 'description': 'The dimensions of this product for shipping purposes',
15192
+ 'properties': {
15193
+ 'height': {'type': 'number', 'description': 'Height, in inches'},
15194
+ 'length': {'type': 'number', 'description': 'Length, in inches'},
15195
+ 'weight': {'type': 'number', 'description': 'Weight, in ounces'},
15196
+ 'width': {'type': 'number', 'description': 'Width, in inches'},
15197
+ },
15198
+ },
15199
+ 'shippable': {
15200
+ 'type': ['boolean', 'null'],
15201
+ 'description': 'Whether this product is shipped (i.e., physical goods)',
15202
+ },
15203
+ 'statement_descriptor': {
15204
+ 'type': ['string', 'null'],
15205
+ 'description': "Extra information about a product which will appear on your customer's credit card statement",
15206
+ },
15207
+ 'tax_code': {
15208
+ 'type': ['string', 'null'],
15209
+ 'description': 'A tax code ID',
15210
+ },
15211
+ 'type': {
15212
+ 'type': 'string',
15213
+ 'description': "The type of the product. Either 'good' for physical goods or 'service' for digital services",
15214
+ 'enum': ['good', 'service'],
15215
+ },
15216
+ 'unit_label': {
15217
+ 'type': ['string', 'null'],
15218
+ 'description': 'A label that represents units of this product',
15219
+ },
15220
+ 'updated': {'type': 'integer', 'description': 'Time at which the product was last updated, measured in seconds since the Unix epoch'},
15221
+ 'url': {
15222
+ 'type': ['string', 'null'],
15223
+ 'description': 'A URL of a publicly-accessible webpage for this product',
15224
+ },
15225
+ },
15226
+ 'x-airbyte-entity-name': 'products',
15227
+ },
15228
+ },
15229
+ 'has_more': {'type': 'boolean'},
15230
+ 'url': {'type': 'string'},
15231
+ },
15232
+ },
15233
+ record_extractor='$.data',
15234
+ meta_extractor={'has_more': '$.has_more'},
15235
+ ),
15236
+ Action.CREATE: EndpointDefinition(
15237
+ method='POST',
15238
+ path='/v1/products',
15239
+ action=Action.CREATE,
15240
+ description="Creates a new product object. Your product's name, description, and other information will be displayed in all product and invoice displays.",
15241
+ body_fields=[
15242
+ 'name',
15243
+ 'active',
15244
+ 'description',
15245
+ 'id',
15246
+ 'images',
15247
+ 'marketing_features',
15248
+ 'metadata',
15249
+ 'package_dimensions',
15250
+ 'shippable',
15251
+ 'statement_descriptor',
15252
+ 'tax_code',
15253
+ 'unit_label',
15254
+ 'url',
15255
+ ],
15256
+ content_type=ContentType.FORM_URLENCODED,
15257
+ request_schema={
15258
+ 'type': 'object',
15259
+ 'properties': {
15260
+ 'name': {'type': 'string', 'description': "The product's name, meant to be displayable to the customer"},
15261
+ 'active': {'type': 'boolean', 'description': 'Whether the product is available for purchase. Defaults to true'},
15262
+ 'description': {'type': 'string', 'description': "The product's description, meant to be displayable to the customer"},
15263
+ 'id': {'type': 'string', 'description': 'An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account'},
15264
+ 'images': {
15265
+ 'type': 'array',
15266
+ 'description': 'A list of up to 8 URLs of images for this product',
15267
+ 'items': {'type': 'string'},
15268
+ },
15269
+ 'marketing_features': {
15270
+ 'type': 'array',
15271
+ 'description': 'A list of up to 15 marketing features for this product',
15272
+ 'items': {
15273
+ 'type': 'object',
15274
+ 'properties': {
15275
+ 'name': {'type': 'string', 'description': 'The marketing feature name. Up to 80 characters long'},
15276
+ },
15277
+ },
15278
+ },
15279
+ 'metadata': {
15280
+ 'type': 'object',
15281
+ 'description': 'Set of key-value pairs that you can attach to an object',
15282
+ 'additionalProperties': {'type': 'string'},
15283
+ },
15284
+ 'package_dimensions': {
15285
+ 'type': 'object',
15286
+ 'description': 'The dimensions of this product for shipping purposes',
15287
+ 'properties': {
15288
+ 'height': {'type': 'number', 'description': 'Height, in inches'},
15289
+ 'length': {'type': 'number', 'description': 'Length, in inches'},
15290
+ 'weight': {'type': 'number', 'description': 'Weight, in ounces'},
15291
+ 'width': {'type': 'number', 'description': 'Width, in inches'},
15292
+ },
15293
+ },
15294
+ 'shippable': {'type': 'boolean', 'description': 'Whether this product is shipped (i.e., physical goods)'},
15295
+ 'statement_descriptor': {'type': 'string', 'description': "Extra information about a product which will appear on your customer's credit card statement. At most 22 characters"},
15296
+ 'tax_code': {'type': 'string', 'description': 'A tax code ID'},
15297
+ 'unit_label': {'type': 'string', 'description': 'A label that represents units of this product. Max 12 characters'},
15298
+ 'url': {'type': 'string', 'description': 'A URL of a publicly-accessible webpage for this product'},
15299
+ },
15300
+ 'required': ['name'],
15301
+ },
15302
+ response_schema={
15303
+ 'type': 'object',
15304
+ 'properties': {
15305
+ 'id': {'type': 'string', 'description': 'Unique identifier for the product'},
15306
+ 'object': {
15307
+ 'type': 'string',
15308
+ 'description': "String representing the object's type",
15309
+ 'enum': ['product'],
15310
+ },
15311
+ 'active': {'type': 'boolean', 'description': 'Whether the product is currently available for purchase'},
15312
+ 'attributes': {
15313
+ 'type': 'array',
15314
+ 'description': 'A list of up to 5 alphanumeric attributes that each SKU can have',
15315
+ 'items': {'type': 'string'},
15316
+ },
15317
+ 'created': {'type': 'integer', 'description': 'Time at which the product was created, measured in seconds since the Unix epoch'},
15318
+ 'default_price': {
15319
+ 'type': ['string', 'null'],
15320
+ 'description': 'The ID of the Price object that is the default price for this product',
15321
+ },
15322
+ 'description': {
15323
+ 'type': ['string', 'null'],
15324
+ 'description': "The product's description, meant to be displayable to the customer",
15325
+ },
15326
+ 'features': {
15327
+ 'type': 'array',
15328
+ 'description': 'A list of up to 15 features for this product',
15329
+ 'items': {
15330
+ 'type': 'object',
15331
+ 'properties': {
15332
+ 'name': {'type': 'string', 'description': 'The feature name'},
15333
+ },
15334
+ },
15335
+ },
15336
+ 'images': {
15337
+ 'type': 'array',
15338
+ 'description': 'A list of up to 8 URLs of images for this product',
15339
+ 'items': {'type': 'string'},
15340
+ },
15341
+ 'livemode': {'type': 'boolean', 'description': 'Has the value true if the object exists in live mode or the value false if the object exists in test mode'},
15342
+ 'marketing_features': {
15343
+ 'type': 'array',
15344
+ 'description': 'A list of up to 15 marketing features for this product',
15345
+ 'items': {
15346
+ 'type': 'object',
15347
+ 'properties': {
15348
+ 'name': {
15349
+ 'type': ['string', 'null'],
15350
+ 'description': 'The marketing feature name. Up to 80 characters long',
15351
+ },
15352
+ },
15353
+ },
15354
+ },
15355
+ 'metadata': {
15356
+ 'type': 'object',
15357
+ 'description': 'Set of key-value pairs that you can attach to an object',
15358
+ 'additionalProperties': {'type': 'string'},
15359
+ },
15360
+ 'name': {'type': 'string', 'description': "The product's name, meant to be displayable to the customer"},
15361
+ 'package_dimensions': {
15362
+ 'type': ['object', 'null'],
15363
+ 'description': 'The dimensions of this product for shipping purposes',
15364
+ 'properties': {
15365
+ 'height': {'type': 'number', 'description': 'Height, in inches'},
15366
+ 'length': {'type': 'number', 'description': 'Length, in inches'},
15367
+ 'weight': {'type': 'number', 'description': 'Weight, in ounces'},
15368
+ 'width': {'type': 'number', 'description': 'Width, in inches'},
15369
+ },
15370
+ },
15371
+ 'shippable': {
15372
+ 'type': ['boolean', 'null'],
15373
+ 'description': 'Whether this product is shipped (i.e., physical goods)',
15374
+ },
15375
+ 'statement_descriptor': {
15376
+ 'type': ['string', 'null'],
15377
+ 'description': "Extra information about a product which will appear on your customer's credit card statement",
15378
+ },
15379
+ 'tax_code': {
15380
+ 'type': ['string', 'null'],
15381
+ 'description': 'A tax code ID',
15382
+ },
15383
+ 'type': {
15384
+ 'type': 'string',
15385
+ 'description': "The type of the product. Either 'good' for physical goods or 'service' for digital services",
15386
+ 'enum': ['good', 'service'],
15387
+ },
15388
+ 'unit_label': {
15389
+ 'type': ['string', 'null'],
15390
+ 'description': 'A label that represents units of this product',
15391
+ },
15392
+ 'updated': {'type': 'integer', 'description': 'Time at which the product was last updated, measured in seconds since the Unix epoch'},
15393
+ 'url': {
15394
+ 'type': ['string', 'null'],
15395
+ 'description': 'A URL of a publicly-accessible webpage for this product',
15396
+ },
15397
+ },
15398
+ 'x-airbyte-entity-name': 'products',
15399
+ },
15400
+ ),
15401
+ Action.GET: EndpointDefinition(
15402
+ method='GET',
15403
+ path='/v1/products/{id}',
15404
+ action=Action.GET,
15405
+ description='Retrieves the details of an existing product. Supply the unique product ID and Stripe will return the corresponding product information.',
15406
+ path_params=['id'],
15407
+ path_params_schema={
15408
+ 'id': {'type': 'string', 'required': True},
15409
+ },
12724
15410
  response_schema={
12725
15411
  'type': 'object',
12726
15412
  'properties': {
15413
+ 'id': {'type': 'string', 'description': 'Unique identifier for the product'},
12727
15414
  'object': {
12728
15415
  'type': 'string',
12729
- 'enum': ['list'],
15416
+ 'description': "String representing the object's type",
15417
+ 'enum': ['product'],
12730
15418
  },
12731
- 'data': {
15419
+ 'active': {'type': 'boolean', 'description': 'Whether the product is currently available for purchase'},
15420
+ 'attributes': {
15421
+ 'type': 'array',
15422
+ 'description': 'A list of up to 5 alphanumeric attributes that each SKU can have',
15423
+ 'items': {'type': 'string'},
15424
+ },
15425
+ 'created': {'type': 'integer', 'description': 'Time at which the product was created, measured in seconds since the Unix epoch'},
15426
+ 'default_price': {
15427
+ 'type': ['string', 'null'],
15428
+ 'description': 'The ID of the Price object that is the default price for this product',
15429
+ },
15430
+ 'description': {
15431
+ 'type': ['string', 'null'],
15432
+ 'description': "The product's description, meant to be displayable to the customer",
15433
+ },
15434
+ 'features': {
12732
15435
  'type': 'array',
15436
+ 'description': 'A list of up to 15 features for this product',
12733
15437
  'items': {
12734
15438
  'type': 'object',
12735
15439
  'properties': {
12736
- 'id': {'type': 'string', 'description': 'Unique identifier for the product'},
12737
- 'object': {
12738
- 'type': 'string',
12739
- 'description': "String representing the object's type",
12740
- 'enum': ['product'],
12741
- },
12742
- 'active': {'type': 'boolean', 'description': 'Whether the product is currently available for purchase'},
12743
- 'attributes': {
12744
- 'type': 'array',
12745
- 'description': 'A list of up to 5 alphanumeric attributes that each SKU can have',
12746
- 'items': {'type': 'string'},
12747
- },
12748
- 'created': {'type': 'integer', 'description': 'Time at which the product was created, measured in seconds since the Unix epoch'},
12749
- 'default_price': {
12750
- 'type': ['string', 'null'],
12751
- 'description': 'The ID of the Price object that is the default price for this product',
12752
- },
12753
- 'description': {
12754
- 'type': ['string', 'null'],
12755
- 'description': "The product's description, meant to be displayable to the customer",
12756
- },
12757
- 'features': {
12758
- 'type': 'array',
12759
- 'description': 'A list of up to 15 features for this product',
12760
- 'items': {
12761
- 'type': 'object',
12762
- 'properties': {
12763
- 'name': {'type': 'string', 'description': 'The feature name'},
12764
- },
12765
- },
12766
- },
12767
- 'images': {
12768
- 'type': 'array',
12769
- 'description': 'A list of up to 8 URLs of images for this product',
12770
- 'items': {'type': 'string'},
12771
- },
12772
- 'livemode': {'type': 'boolean', 'description': 'Has the value true if the object exists in live mode or the value false if the object exists in test mode'},
12773
- 'marketing_features': {
12774
- 'type': 'array',
12775
- 'description': 'A list of up to 15 marketing features for this product',
12776
- 'items': {
12777
- 'type': 'object',
12778
- 'properties': {
12779
- 'name': {
12780
- 'type': ['string', 'null'],
12781
- 'description': 'The marketing feature name. Up to 80 characters long',
12782
- },
12783
- },
12784
- },
12785
- },
12786
- 'metadata': {
12787
- 'type': 'object',
12788
- 'description': 'Set of key-value pairs that you can attach to an object',
12789
- 'additionalProperties': {'type': 'string'},
12790
- },
12791
- 'name': {'type': 'string', 'description': "The product's name, meant to be displayable to the customer"},
12792
- 'package_dimensions': {
12793
- 'type': ['object', 'null'],
12794
- 'description': 'The dimensions of this product for shipping purposes',
12795
- 'properties': {
12796
- 'height': {'type': 'number', 'description': 'Height, in inches'},
12797
- 'length': {'type': 'number', 'description': 'Length, in inches'},
12798
- 'weight': {'type': 'number', 'description': 'Weight, in ounces'},
12799
- 'width': {'type': 'number', 'description': 'Width, in inches'},
12800
- },
12801
- },
12802
- 'shippable': {
12803
- 'type': ['boolean', 'null'],
12804
- 'description': 'Whether this product is shipped (i.e., physical goods)',
12805
- },
12806
- 'statement_descriptor': {
12807
- 'type': ['string', 'null'],
12808
- 'description': "Extra information about a product which will appear on your customer's credit card statement",
12809
- },
12810
- 'tax_code': {
12811
- 'type': ['string', 'null'],
12812
- 'description': 'A tax code ID',
12813
- },
12814
- 'type': {
12815
- 'type': 'string',
12816
- 'description': "The type of the product. Either 'good' for physical goods or 'service' for digital services",
12817
- 'enum': ['good', 'service'],
12818
- },
12819
- 'unit_label': {
12820
- 'type': ['string', 'null'],
12821
- 'description': 'A label that represents units of this product',
12822
- },
12823
- 'updated': {'type': 'integer', 'description': 'Time at which the product was last updated, measured in seconds since the Unix epoch'},
12824
- 'url': {
15440
+ 'name': {'type': 'string', 'description': 'The feature name'},
15441
+ },
15442
+ },
15443
+ },
15444
+ 'images': {
15445
+ 'type': 'array',
15446
+ 'description': 'A list of up to 8 URLs of images for this product',
15447
+ 'items': {'type': 'string'},
15448
+ },
15449
+ 'livemode': {'type': 'boolean', 'description': 'Has the value true if the object exists in live mode or the value false if the object exists in test mode'},
15450
+ 'marketing_features': {
15451
+ 'type': 'array',
15452
+ 'description': 'A list of up to 15 marketing features for this product',
15453
+ 'items': {
15454
+ 'type': 'object',
15455
+ 'properties': {
15456
+ 'name': {
12825
15457
  'type': ['string', 'null'],
12826
- 'description': 'A URL of a publicly-accessible webpage for this product',
15458
+ 'description': 'The marketing feature name. Up to 80 characters long',
12827
15459
  },
12828
15460
  },
12829
- 'x-airbyte-entity-name': 'products',
12830
15461
  },
12831
15462
  },
12832
- 'has_more': {'type': 'boolean'},
12833
- 'url': {'type': 'string'},
15463
+ 'metadata': {
15464
+ 'type': 'object',
15465
+ 'description': 'Set of key-value pairs that you can attach to an object',
15466
+ 'additionalProperties': {'type': 'string'},
15467
+ },
15468
+ 'name': {'type': 'string', 'description': "The product's name, meant to be displayable to the customer"},
15469
+ 'package_dimensions': {
15470
+ 'type': ['object', 'null'],
15471
+ 'description': 'The dimensions of this product for shipping purposes',
15472
+ 'properties': {
15473
+ 'height': {'type': 'number', 'description': 'Height, in inches'},
15474
+ 'length': {'type': 'number', 'description': 'Length, in inches'},
15475
+ 'weight': {'type': 'number', 'description': 'Weight, in ounces'},
15476
+ 'width': {'type': 'number', 'description': 'Width, in inches'},
15477
+ },
15478
+ },
15479
+ 'shippable': {
15480
+ 'type': ['boolean', 'null'],
15481
+ 'description': 'Whether this product is shipped (i.e., physical goods)',
15482
+ },
15483
+ 'statement_descriptor': {
15484
+ 'type': ['string', 'null'],
15485
+ 'description': "Extra information about a product which will appear on your customer's credit card statement",
15486
+ },
15487
+ 'tax_code': {
15488
+ 'type': ['string', 'null'],
15489
+ 'description': 'A tax code ID',
15490
+ },
15491
+ 'type': {
15492
+ 'type': 'string',
15493
+ 'description': "The type of the product. Either 'good' for physical goods or 'service' for digital services",
15494
+ 'enum': ['good', 'service'],
15495
+ },
15496
+ 'unit_label': {
15497
+ 'type': ['string', 'null'],
15498
+ 'description': 'A label that represents units of this product',
15499
+ },
15500
+ 'updated': {'type': 'integer', 'description': 'Time at which the product was last updated, measured in seconds since the Unix epoch'},
15501
+ 'url': {
15502
+ 'type': ['string', 'null'],
15503
+ 'description': 'A URL of a publicly-accessible webpage for this product',
15504
+ },
12834
15505
  },
15506
+ 'x-airbyte-entity-name': 'products',
12835
15507
  },
12836
- record_extractor='$.data',
12837
- meta_extractor={'has_more': '$.has_more'},
12838
15508
  ),
12839
- Action.GET: EndpointDefinition(
12840
- method='GET',
15509
+ Action.UPDATE: EndpointDefinition(
15510
+ method='POST',
12841
15511
  path='/v1/products/{id}',
12842
- action=Action.GET,
12843
- description='Retrieves the details of an existing product. Supply the unique product ID and Stripe will return the corresponding product information.',
15512
+ action=Action.UPDATE,
15513
+ description='Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.',
15514
+ body_fields=[
15515
+ 'active',
15516
+ 'name',
15517
+ 'description',
15518
+ 'default_price',
15519
+ 'images',
15520
+ 'marketing_features',
15521
+ 'metadata',
15522
+ 'package_dimensions',
15523
+ 'shippable',
15524
+ 'statement_descriptor',
15525
+ 'tax_code',
15526
+ 'unit_label',
15527
+ 'url',
15528
+ ],
12844
15529
  path_params=['id'],
12845
15530
  path_params_schema={
12846
15531
  'id': {'type': 'string', 'required': True},
12847
15532
  },
15533
+ content_type=ContentType.FORM_URLENCODED,
15534
+ request_schema={
15535
+ 'type': 'object',
15536
+ 'properties': {
15537
+ 'active': {'type': 'boolean', 'description': 'Whether the product is available for purchase'},
15538
+ 'name': {'type': 'string', 'description': "The product's name, meant to be displayable to the customer"},
15539
+ 'description': {'type': 'string', 'description': "The product's description, meant to be displayable to the customer"},
15540
+ 'default_price': {'type': 'string', 'description': 'The ID of the Price object that is the default price for this product'},
15541
+ 'images': {
15542
+ 'type': 'array',
15543
+ 'description': 'A list of up to 8 URLs of images for this product',
15544
+ 'items': {'type': 'string'},
15545
+ },
15546
+ 'marketing_features': {
15547
+ 'type': 'array',
15548
+ 'description': 'A list of up to 15 marketing features for this product',
15549
+ 'items': {
15550
+ 'type': 'object',
15551
+ 'properties': {
15552
+ 'name': {'type': 'string', 'description': 'The marketing feature name. Up to 80 characters long'},
15553
+ },
15554
+ },
15555
+ },
15556
+ 'metadata': {
15557
+ 'type': 'object',
15558
+ 'description': 'Set of key-value pairs that you can attach to an object',
15559
+ 'additionalProperties': {'type': 'string'},
15560
+ },
15561
+ 'package_dimensions': {
15562
+ 'type': 'object',
15563
+ 'description': 'The dimensions of this product for shipping purposes',
15564
+ 'properties': {
15565
+ 'height': {'type': 'number', 'description': 'Height, in inches'},
15566
+ 'length': {'type': 'number', 'description': 'Length, in inches'},
15567
+ 'weight': {'type': 'number', 'description': 'Weight, in ounces'},
15568
+ 'width': {'type': 'number', 'description': 'Width, in inches'},
15569
+ },
15570
+ },
15571
+ 'shippable': {'type': 'boolean', 'description': 'Whether this product is shipped (i.e., physical goods)'},
15572
+ 'statement_descriptor': {'type': 'string', 'description': "Extra information about a product which will appear on your customer's credit card statement. At most 22 characters"},
15573
+ 'tax_code': {'type': 'string', 'description': 'A tax code ID'},
15574
+ 'unit_label': {'type': 'string', 'description': 'A label that represents units of this product. Max 12 characters'},
15575
+ 'url': {'type': 'string', 'description': 'A URL of a publicly-accessible webpage for this product'},
15576
+ },
15577
+ },
12848
15578
  response_schema={
12849
15579
  'type': 'object',
12850
15580
  'properties': {
@@ -12944,10 +15674,32 @@ StripeConnectorModel: ConnectorModel = ConnectorModel(
12944
15674
  'x-airbyte-entity-name': 'products',
12945
15675
  },
12946
15676
  ),
12947
- Action.SEARCH: EndpointDefinition(
15677
+ Action.DELETE: EndpointDefinition(
15678
+ method='DELETE',
15679
+ path='/v1/products/{id}',
15680
+ action=Action.DELETE,
15681
+ description='Deletes a product. Deleting a product is only possible if it has no prices associated with it.',
15682
+ path_params=['id'],
15683
+ path_params_schema={
15684
+ 'id': {'type': 'string', 'required': True},
15685
+ },
15686
+ response_schema={
15687
+ 'type': 'object',
15688
+ 'properties': {
15689
+ 'id': {'type': 'string', 'description': 'The ID of the deleted product'},
15690
+ 'object': {
15691
+ 'type': 'string',
15692
+ 'enum': ['product'],
15693
+ 'description': "String representing the object's type",
15694
+ },
15695
+ 'deleted': {'type': 'boolean', 'description': 'Always true for a deleted object'},
15696
+ },
15697
+ },
15698
+ ),
15699
+ Action.API_SEARCH: EndpointDefinition(
12948
15700
  method='GET',
12949
15701
  path='/v1/products/search',
12950
- action=Action.SEARCH,
15702
+ action=Action.API_SEARCH,
12951
15703
  description="Search for products using Stripe's Search Query Language.",
12952
15704
  query_params=['query', 'limit', 'page'],
12953
15705
  query_params_schema={
@@ -13945,7 +16697,7 @@ StripeConnectorModel: ConnectorModel = ConnectorModel(
13945
16697
  ),
13946
16698
  EntityDefinition(
13947
16699
  name='payment_intents',
13948
- actions=[Action.LIST, Action.GET, Action.SEARCH],
16700
+ actions=[Action.LIST, Action.GET, Action.API_SEARCH],
13949
16701
  endpoints={
13950
16702
  Action.LIST: EndpointDefinition(
13951
16703
  method='GET',
@@ -14122,10 +16874,10 @@ StripeConnectorModel: ConnectorModel = ConnectorModel(
14122
16874
  'x-airbyte-entity-name': 'payment_intents',
14123
16875
  },
14124
16876
  ),
14125
- Action.SEARCH: EndpointDefinition(
16877
+ Action.API_SEARCH: EndpointDefinition(
14126
16878
  method='GET',
14127
16879
  path='/v1/payment_intents/search',
14128
- action=Action.SEARCH,
16880
+ action=Action.API_SEARCH,
14129
16881
  description="Search for payment intents using Stripe's Search Query Language.",
14130
16882
  query_params=['query', 'limit', 'page'],
14131
16883
  query_params_schema={