airbyte-agent-stripe 0.5.32__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.
@@ -22,34 +22,6 @@ class StripeAuthConfig(BaseModel):
22
22
 
23
23
  # ===== RESPONSE TYPE DEFINITIONS (PYDANTIC) =====
24
24
 
25
- class CustomerShippingAddress(BaseModel):
26
- """Customer shipping address"""
27
- model_config = ConfigDict(extra="allow", populate_by_name=True)
28
-
29
- city: Union[str | None, Any] = Field(default=None, description="City, district, suburb, town, or village")
30
- """City, district, suburb, town, or village"""
31
- country: Union[str | None, Any] = Field(default=None, description="Two-letter country code (ISO 3166-1 alpha-2)")
32
- """Two-letter country code (ISO 3166-1 alpha-2)"""
33
- line1: Union[str | None, Any] = Field(default=None, description="Address line 1, such as the street, PO Box, or company name")
34
- """Address line 1, such as the street, PO Box, or company name"""
35
- line2: Union[str | None, Any] = Field(default=None, description="Address line 2, such as the apartment, suite, unit, or building")
36
- """Address line 2, such as the apartment, suite, unit, or building"""
37
- postal_code: Union[str | None, Any] = Field(default=None, description="ZIP or postal code")
38
- """ZIP or postal code"""
39
- state: Union[str | None, Any] = Field(default=None, description="State, county, province, or region")
40
- """State, county, province, or region"""
41
-
42
- class CustomerShipping(BaseModel):
43
- """Mailing and shipping address for the customer"""
44
- model_config = ConfigDict(extra="allow", populate_by_name=True)
45
-
46
- address: Union[CustomerShippingAddress, Any] = Field(default=None, description="Customer shipping address")
47
- """Customer shipping address"""
48
- name: Union[str, Any] = Field(default=None, description="Customer name")
49
- """Customer name"""
50
- phone: Union[str | None, Any] = Field(default=None, description="Customer phone (including extension)")
51
- """Customer phone (including extension)"""
52
-
53
25
  class CustomerSourcesDataItem(BaseModel):
54
26
  """Nested schema for CustomerSources.data_item"""
55
27
  model_config = ConfigDict(extra="allow", populate_by_name=True)
@@ -100,6 +72,106 @@ class CustomerSources(BaseModel):
100
72
  url: Union[str, Any] = Field(default=None, description="The URL where this list can be accessed")
101
73
  """The URL where this list can be accessed"""
102
74
 
75
+ class CustomerAddress(BaseModel):
76
+ """The customer's address"""
77
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
78
+
79
+ city: Union[str | None, Any] = Field(default=None, description="City, district, suburb, town, or village")
80
+ """City, district, suburb, town, or village"""
81
+ country: Union[str | None, Any] = Field(default=None, description="Two-letter country code (ISO 3166-1 alpha-2)")
82
+ """Two-letter country code (ISO 3166-1 alpha-2)"""
83
+ line1: Union[str | None, Any] = Field(default=None, description="Address line 1, such as the street, PO Box, or company name")
84
+ """Address line 1, such as the street, PO Box, or company name"""
85
+ line2: Union[str | None, Any] = Field(default=None, description="Address line 2, such as the apartment, suite, unit, or building")
86
+ """Address line 2, such as the apartment, suite, unit, or building"""
87
+ postal_code: Union[str | None, Any] = Field(default=None, description="ZIP or postal code")
88
+ """ZIP or postal code"""
89
+ state: Union[str | None, Any] = Field(default=None, description="State, county, province, or region")
90
+ """State, county, province, or region"""
91
+
92
+ class CustomerCashBalanceSettings(BaseModel):
93
+ """A hash of settings for this cash balance"""
94
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
95
+
96
+ reconciliation_mode: Union[str, Any] = Field(default=None, description="The configuration for how funds that land in the customer cash balance are reconciled")
97
+ """The configuration for how funds that land in the customer cash balance are reconciled"""
98
+ using_merchant_default: Union[bool, Any] = Field(default=None, description="A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance")
99
+ """A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance"""
100
+
101
+ class CustomerCashBalance(BaseModel):
102
+ """The current funds being held by Stripe on behalf of the customer"""
103
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
104
+
105
+ object: Union[str, Any] = Field(default=None, description="String representing the object's type")
106
+ """String representing the object's type"""
107
+ available: Union[dict[str, Any] | None, Any] = Field(default=None, description="A hash of all cash balances available to this customer")
108
+ """A hash of all cash balances available to this customer"""
109
+ customer: Union[str, Any] = Field(default=None, description="The ID of the customer whose cash balance this object represents")
110
+ """The ID of the customer whose cash balance this object represents"""
111
+ customer_account: Union[str | None, Any] = Field(default=None, description="The ID of the account whose cash balance this object represents")
112
+ """The ID of the account whose cash balance this object represents"""
113
+ livemode: Union[bool, Any] = Field(default=None, description="Has the value true if the object exists in live mode or false if in test mode")
114
+ """Has the value true if the object exists in live mode or false if in test mode"""
115
+ settings: Union[CustomerCashBalanceSettings, Any] = Field(default=None, description="A hash of settings for this cash balance")
116
+ """A hash of settings for this cash balance"""
117
+
118
+ class CustomerInvoiceSettingsRenderingOptions(BaseModel):
119
+ """Default options for invoice PDF rendering for this customer"""
120
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
121
+
122
+ amount_tax_display: Union[str | None, Any] = Field(default=None, description="How line-item prices and amounts will be displayed with respect to tax on invoice PDFs")
123
+ """How line-item prices and amounts will be displayed with respect to tax on invoice PDFs"""
124
+ template: Union[str | None, Any] = Field(default=None, description="ID of the invoice rendering template to be used for this customer's invoices")
125
+ """ID of the invoice rendering template to be used for this customer's invoices"""
126
+
127
+ class CustomerInvoiceSettingsCustomFieldsItem(BaseModel):
128
+ """Nested schema for CustomerInvoiceSettings.custom_fields_item"""
129
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
130
+
131
+ name: Union[str, Any] = Field(default=None, description="The name of the custom field")
132
+ """The name of the custom field"""
133
+ value: Union[str, Any] = Field(default=None, description="The value of the custom field")
134
+ """The value of the custom field"""
135
+
136
+ class CustomerInvoiceSettings(BaseModel):
137
+ """The customer's default invoice settings"""
138
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
139
+
140
+ custom_fields: Union[list[CustomerInvoiceSettingsCustomFieldsItem] | None, Any] = Field(default=None, description="Default custom fields to be displayed on invoices for this customer")
141
+ """Default custom fields to be displayed on invoices for this customer"""
142
+ default_payment_method: Union[str | None, Any] = Field(default=None, description="ID of a payment method that's attached to the customer")
143
+ """ID of a payment method that's attached to the customer"""
144
+ footer: Union[str | None, Any] = Field(default=None, description="Default footer to be displayed on invoices for this customer")
145
+ """Default footer to be displayed on invoices for this customer"""
146
+ rendering_options: Union[CustomerInvoiceSettingsRenderingOptions | None, Any] = Field(default=None, description="Default options for invoice PDF rendering for this customer")
147
+ """Default options for invoice PDF rendering for this customer"""
148
+
149
+ class SubscriptionBillingCycleAnchorConfig(BaseModel):
150
+ """The fixed values used to calculate the billing_cycle_anchor"""
151
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
152
+
153
+ day_of_month: Union[int, Any] = Field(default=None, description="The day of the month of the billing_cycle_anchor")
154
+ """The day of the month of the billing_cycle_anchor"""
155
+ hour: Union[int | None, Any] = Field(default=None, description="The hour of the day of the billing_cycle_anchor")
156
+ """The hour of the day of the billing_cycle_anchor"""
157
+ minute: Union[int | None, Any] = Field(default=None, description="The minute of the hour of the billing_cycle_anchor")
158
+ """The minute of the hour of the billing_cycle_anchor"""
159
+ month: Union[int | None, Any] = Field(default=None, description="The month to start full cycle billing periods")
160
+ """The month to start full cycle billing periods"""
161
+ second: Union[int | None, Any] = Field(default=None, description="The second of the minute of the billing_cycle_anchor")
162
+ """The second of the minute of the billing_cycle_anchor"""
163
+
164
+ class SubscriptionCancellationDetails(BaseModel):
165
+ """Details about why this subscription was cancelled"""
166
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
167
+
168
+ comment: Union[str | None, Any] = Field(default=None, description="Additional comments about why the user canceled the subscription")
169
+ """Additional comments about why the user canceled the subscription"""
170
+ feedback: Union[str | None, Any] = Field(default=None, description="The customer submitted reason for why they canceled")
171
+ """The customer submitted reason for why they canceled"""
172
+ reason: Union[str | None, Any] = Field(default=None, description="Why this subscription was canceled")
173
+ """Why this subscription was canceled"""
174
+
103
175
  class SubscriptionBillingModeFlexible(BaseModel):
104
176
  """Configure behavior for flexible billing mode"""
105
177
  model_config = ConfigDict(extra="allow", populate_by_name=True)
@@ -118,14 +190,18 @@ class SubscriptionBillingMode(BaseModel):
118
190
  updated_at: Union[int | None, Any] = Field(default=None, description="Details on when the current billing_mode was adopted")
119
191
  """Details on when the current billing_mode was adopted"""
120
192
 
121
- class SubscriptionPaymentSettings(BaseModel):
122
- """Payment settings passed on to invoices created by the subscription"""
193
+ class SubscriptionTrialSettingsEndBehavior(BaseModel):
194
+ """Nested schema for SubscriptionTrialSettings.end_behavior"""
123
195
  model_config = ConfigDict(extra="allow", populate_by_name=True)
124
196
 
125
- payment_method_options: Union[dict[str, Any] | None, Any] = Field(default=None, description="Payment-method-specific configuration to provide to invoices")
126
- """Payment-method-specific configuration to provide to invoices"""
127
- payment_method_types: Union[list[str] | None, Any] = Field(default=None, description="The list of payment method types to provide to every invoice")
128
- """The list of payment method types to provide to every invoice"""
197
+ missing_payment_method: Union[str, Any] = Field(default=None, description="Behavior when the trial ends and payment method is missing")
198
+ """Behavior when the trial ends and payment method is missing"""
199
+
200
+ class SubscriptionTrialSettings(BaseModel):
201
+ """Settings related to subscription trials"""
202
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
203
+
204
+ end_behavior: Union[SubscriptionTrialSettingsEndBehavior, Any] = Field(default=None)
129
205
 
130
206
  class SubscriptionItemsDataItemBillingThresholds(BaseModel):
131
207
  """Define thresholds at which an invoice will be sent"""
@@ -180,20 +256,52 @@ class SubscriptionItems(BaseModel):
180
256
  total_count: Union[int, Any] = Field(default=None, description="The total count of items in the list")
181
257
  """The total count of items in the list"""
182
258
 
183
- class SubscriptionBillingCycleAnchorConfig(BaseModel):
184
- """The fixed values used to calculate the billing_cycle_anchor"""
259
+ class SubscriptionPaymentSettings(BaseModel):
260
+ """Payment settings passed on to invoices created by the subscription"""
185
261
  model_config = ConfigDict(extra="allow", populate_by_name=True)
186
262
 
187
- day_of_month: Union[int, Any] = Field(default=None, description="The day of the month of the billing_cycle_anchor")
188
- """The day of the month of the billing_cycle_anchor"""
189
- hour: Union[int | None, Any] = Field(default=None, description="The hour of the day of the billing_cycle_anchor")
190
- """The hour of the day of the billing_cycle_anchor"""
191
- minute: Union[int | None, Any] = Field(default=None, description="The minute of the hour of the billing_cycle_anchor")
192
- """The minute of the hour of the billing_cycle_anchor"""
193
- month: Union[int | None, Any] = Field(default=None, description="The month to start full cycle billing periods")
194
- """The month to start full cycle billing periods"""
195
- second: Union[int | None, Any] = Field(default=None, description="The second of the minute of the billing_cycle_anchor")
196
- """The second of the minute of the billing_cycle_anchor"""
263
+ payment_method_options: Union[dict[str, Any] | None, Any] = Field(default=None, description="Payment-method-specific configuration to provide to invoices")
264
+ """Payment-method-specific configuration to provide to invoices"""
265
+ payment_method_types: Union[list[str] | None, Any] = Field(default=None, description="The list of payment method types to provide to every invoice")
266
+ """The list of payment method types to provide to every invoice"""
267
+
268
+ class SubscriptionInvoiceSettingsIssuer(BaseModel):
269
+ """The connected account that issues the invoice"""
270
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
271
+
272
+ account: Union[str | None, Any] = Field(default=None, description="The connected account being referenced when type is account")
273
+ """The connected account being referenced when type is account"""
274
+ type: Union[str, Any] = Field(default=None, description="Type of the account referenced")
275
+ """Type of the account referenced"""
276
+
277
+ class SubscriptionInvoiceSettings(BaseModel):
278
+ """All invoices will be billed using the specified settings"""
279
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
280
+
281
+ account_tax_ids: Union[list[str] | None, Any] = Field(default=None, description="The account tax IDs associated with the subscription")
282
+ """The account tax IDs associated with the subscription"""
283
+ issuer: Union[SubscriptionInvoiceSettingsIssuer, Any] = Field(default=None, description="The connected account that issues the invoice")
284
+ """The connected account that issues the invoice"""
285
+
286
+ class SubscriptionAutomaticTaxLiability(BaseModel):
287
+ """The account that's liable for tax"""
288
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
289
+
290
+ account: Union[str | None, Any] = Field(default=None, description="The connected account being referenced when type is account")
291
+ """The connected account being referenced when type is account"""
292
+ type: Union[str, Any] = Field(default=None, description="Type of the account referenced")
293
+ """Type of the account referenced"""
294
+
295
+ class SubscriptionAutomaticTax(BaseModel):
296
+ """Automatic tax settings for this subscription"""
297
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
298
+
299
+ disabled_reason: Union[str | None, Any] = Field(default=None, description="If Stripe disabled automatic tax, this enum describes why")
300
+ """If Stripe disabled automatic tax, this enum describes why"""
301
+ enabled: Union[bool, Any] = Field(default=None, description="Whether Stripe automatically computes tax on this subscription")
302
+ """Whether Stripe automatically computes tax on this subscription"""
303
+ liability: Union[SubscriptionAutomaticTaxLiability | None, Any] = Field(default=None, description="The account that's liable for tax")
304
+ """The account that's liable for tax"""
197
305
 
198
306
  class SubscriptionBillingThresholds(BaseModel):
199
307
  """Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period"""
@@ -204,6 +312,15 @@ class SubscriptionBillingThresholds(BaseModel):
204
312
  reset_billing_cycle_anchor: Union[bool | None, Any] = Field(default=None, description="Indicates if the billing_cycle_anchor should be reset when a threshold is reached")
205
313
  """Indicates if the billing_cycle_anchor should be reset when a threshold is reached"""
206
314
 
315
+ class SubscriptionPauseCollection(BaseModel):
316
+ """If specified, payment collection for this subscription will be paused"""
317
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
318
+
319
+ behavior: Union[str, Any] = Field(default=None, description="The payment collection behavior for this subscription while paused")
320
+ """The payment collection behavior for this subscription while paused"""
321
+ resumes_at: Union[int | None, Any] = Field(default=None, description="The time after which the subscription will resume collecting payments")
322
+ """The time after which the subscription will resume collecting payments"""
323
+
207
324
  class SubscriptionDefaultTaxRatesItemFlatAmount(BaseModel):
208
325
  """The amount of the tax rate when the rate_type is flat_amount"""
209
326
  model_config = ConfigDict(extra="allow", populate_by_name=True)
@@ -254,79 +371,8 @@ class SubscriptionDefaultTaxRatesItem(BaseModel):
254
371
  tax_type: Union[str | None, Any] = Field(default=None, description="The high-level tax type")
255
372
  """The high-level tax type"""
256
373
 
257
- class SubscriptionCancellationDetails(BaseModel):
258
- """Details about why this subscription was cancelled"""
259
- model_config = ConfigDict(extra="allow", populate_by_name=True)
260
-
261
- comment: Union[str | None, Any] = Field(default=None, description="Additional comments about why the user canceled the subscription")
262
- """Additional comments about why the user canceled the subscription"""
263
- feedback: Union[str | None, Any] = Field(default=None, description="The customer submitted reason for why they canceled")
264
- """The customer submitted reason for why they canceled"""
265
- reason: Union[str | None, Any] = Field(default=None, description="Why this subscription was canceled")
266
- """Why this subscription was canceled"""
267
-
268
- class SubscriptionTrialSettingsEndBehavior(BaseModel):
269
- """Nested schema for SubscriptionTrialSettings.end_behavior"""
270
- model_config = ConfigDict(extra="allow", populate_by_name=True)
271
-
272
- missing_payment_method: Union[str, Any] = Field(default=None, description="Behavior when the trial ends and payment method is missing")
273
- """Behavior when the trial ends and payment method is missing"""
274
-
275
- class SubscriptionTrialSettings(BaseModel):
276
- """Settings related to subscription trials"""
277
- model_config = ConfigDict(extra="allow", populate_by_name=True)
278
-
279
- end_behavior: Union[SubscriptionTrialSettingsEndBehavior, Any] = Field(default=None)
280
-
281
- class SubscriptionInvoiceSettingsIssuer(BaseModel):
282
- """The connected account that issues the invoice"""
283
- model_config = ConfigDict(extra="allow", populate_by_name=True)
284
-
285
- account: Union[str | None, Any] = Field(default=None, description="The connected account being referenced when type is account")
286
- """The connected account being referenced when type is account"""
287
- type: Union[str, Any] = Field(default=None, description="Type of the account referenced")
288
- """Type of the account referenced"""
289
-
290
- class SubscriptionInvoiceSettings(BaseModel):
291
- """All invoices will be billed using the specified settings"""
292
- model_config = ConfigDict(extra="allow", populate_by_name=True)
293
-
294
- account_tax_ids: Union[list[str] | None, Any] = Field(default=None, description="The account tax IDs associated with the subscription")
295
- """The account tax IDs associated with the subscription"""
296
- issuer: Union[SubscriptionInvoiceSettingsIssuer, Any] = Field(default=None, description="The connected account that issues the invoice")
297
- """The connected account that issues the invoice"""
298
-
299
- class SubscriptionAutomaticTaxLiability(BaseModel):
300
- """The account that's liable for tax"""
301
- model_config = ConfigDict(extra="allow", populate_by_name=True)
302
-
303
- account: Union[str | None, Any] = Field(default=None, description="The connected account being referenced when type is account")
304
- """The connected account being referenced when type is account"""
305
- type: Union[str, Any] = Field(default=None, description="Type of the account referenced")
306
- """Type of the account referenced"""
307
-
308
- class SubscriptionAutomaticTax(BaseModel):
309
- """Automatic tax settings for this subscription"""
310
- model_config = ConfigDict(extra="allow", populate_by_name=True)
311
-
312
- disabled_reason: Union[str | None, Any] = Field(default=None, description="If Stripe disabled automatic tax, this enum describes why")
313
- """If Stripe disabled automatic tax, this enum describes why"""
314
- enabled: Union[bool, Any] = Field(default=None, description="Whether Stripe automatically computes tax on this subscription")
315
- """Whether Stripe automatically computes tax on this subscription"""
316
- liability: Union[SubscriptionAutomaticTaxLiability | None, Any] = Field(default=None, description="The account that's liable for tax")
317
- """The account that's liable for tax"""
318
-
319
- class SubscriptionPauseCollection(BaseModel):
320
- """If specified, payment collection for this subscription will be paused"""
321
- model_config = ConfigDict(extra="allow", populate_by_name=True)
322
-
323
- behavior: Union[str, Any] = Field(default=None, description="The payment collection behavior for this subscription while paused")
324
- """The payment collection behavior for this subscription while paused"""
325
- resumes_at: Union[int | None, Any] = Field(default=None, description="The time after which the subscription will resume collecting payments")
326
- """The time after which the subscription will resume collecting payments"""
327
-
328
- class Subscription(BaseModel):
329
- """Subscription type definition"""
374
+ class Subscription(BaseModel):
375
+ """Subscription type definition"""
330
376
  model_config = ConfigDict(extra="allow", populate_by_name=True)
331
377
 
332
378
  id: Union[str, Any] = Field(default=None)
@@ -393,6 +439,34 @@ class CustomerSubscriptions(BaseModel):
393
439
  url: Union[str, Any] = Field(default=None, description="The URL where this list can be accessed")
394
440
  """The URL where this list can be accessed"""
395
441
 
442
+ class CustomerShippingAddress(BaseModel):
443
+ """Customer shipping address"""
444
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
445
+
446
+ city: Union[str | None, Any] = Field(default=None, description="City, district, suburb, town, or village")
447
+ """City, district, suburb, town, or village"""
448
+ country: Union[str | None, Any] = Field(default=None, description="Two-letter country code (ISO 3166-1 alpha-2)")
449
+ """Two-letter country code (ISO 3166-1 alpha-2)"""
450
+ line1: Union[str | None, Any] = Field(default=None, description="Address line 1, such as the street, PO Box, or company name")
451
+ """Address line 1, such as the street, PO Box, or company name"""
452
+ line2: Union[str | None, Any] = Field(default=None, description="Address line 2, such as the apartment, suite, unit, or building")
453
+ """Address line 2, such as the apartment, suite, unit, or building"""
454
+ postal_code: Union[str | None, Any] = Field(default=None, description="ZIP or postal code")
455
+ """ZIP or postal code"""
456
+ state: Union[str | None, Any] = Field(default=None, description="State, county, province, or region")
457
+ """State, county, province, or region"""
458
+
459
+ class CustomerShipping(BaseModel):
460
+ """Mailing and shipping address for the customer"""
461
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
462
+
463
+ address: Union[CustomerShippingAddress, Any] = Field(default=None, description="Customer shipping address")
464
+ """Customer shipping address"""
465
+ name: Union[str, Any] = Field(default=None, description="Customer name")
466
+ """Customer name"""
467
+ phone: Union[str | None, Any] = Field(default=None, description="Customer phone (including extension)")
468
+ """Customer phone (including extension)"""
469
+
396
470
  class CustomerDiscountSource(BaseModel):
397
471
  """The source of the discount"""
398
472
  model_config = ConfigDict(extra="allow", populate_by_name=True)
@@ -433,80 +507,6 @@ class CustomerDiscount(BaseModel):
433
507
  subscription_item: Union[str | None, Any] = Field(default=None, description="The subscription item that this coupon is applied to")
434
508
  """The subscription item that this coupon is applied to"""
435
509
 
436
- class CustomerAddress(BaseModel):
437
- """The customer's address"""
438
- model_config = ConfigDict(extra="allow", populate_by_name=True)
439
-
440
- city: Union[str | None, Any] = Field(default=None, description="City, district, suburb, town, or village")
441
- """City, district, suburb, town, or village"""
442
- country: Union[str | None, Any] = Field(default=None, description="Two-letter country code (ISO 3166-1 alpha-2)")
443
- """Two-letter country code (ISO 3166-1 alpha-2)"""
444
- line1: Union[str | None, Any] = Field(default=None, description="Address line 1, such as the street, PO Box, or company name")
445
- """Address line 1, such as the street, PO Box, or company name"""
446
- line2: Union[str | None, Any] = Field(default=None, description="Address line 2, such as the apartment, suite, unit, or building")
447
- """Address line 2, such as the apartment, suite, unit, or building"""
448
- postal_code: Union[str | None, Any] = Field(default=None, description="ZIP or postal code")
449
- """ZIP or postal code"""
450
- state: Union[str | None, Any] = Field(default=None, description="State, county, province, or region")
451
- """State, county, province, or region"""
452
-
453
- class CustomerInvoiceSettingsRenderingOptions(BaseModel):
454
- """Default options for invoice PDF rendering for this customer"""
455
- model_config = ConfigDict(extra="allow", populate_by_name=True)
456
-
457
- amount_tax_display: Union[str | None, Any] = Field(default=None, description="How line-item prices and amounts will be displayed with respect to tax on invoice PDFs")
458
- """How line-item prices and amounts will be displayed with respect to tax on invoice PDFs"""
459
- template: Union[str | None, Any] = Field(default=None, description="ID of the invoice rendering template to be used for this customer's invoices")
460
- """ID of the invoice rendering template to be used for this customer's invoices"""
461
-
462
- class CustomerInvoiceSettingsCustomFieldsItem(BaseModel):
463
- """Nested schema for CustomerInvoiceSettings.custom_fields_item"""
464
- model_config = ConfigDict(extra="allow", populate_by_name=True)
465
-
466
- name: Union[str, Any] = Field(default=None, description="The name of the custom field")
467
- """The name of the custom field"""
468
- value: Union[str, Any] = Field(default=None, description="The value of the custom field")
469
- """The value of the custom field"""
470
-
471
- class CustomerInvoiceSettings(BaseModel):
472
- """The customer's default invoice settings"""
473
- model_config = ConfigDict(extra="allow", populate_by_name=True)
474
-
475
- custom_fields: Union[list[CustomerInvoiceSettingsCustomFieldsItem] | None, Any] = Field(default=None, description="Default custom fields to be displayed on invoices for this customer")
476
- """Default custom fields to be displayed on invoices for this customer"""
477
- default_payment_method: Union[str | None, Any] = Field(default=None, description="ID of a payment method that's attached to the customer")
478
- """ID of a payment method that's attached to the customer"""
479
- footer: Union[str | None, Any] = Field(default=None, description="Default footer to be displayed on invoices for this customer")
480
- """Default footer to be displayed on invoices for this customer"""
481
- rendering_options: Union[CustomerInvoiceSettingsRenderingOptions | None, Any] = Field(default=None, description="Default options for invoice PDF rendering for this customer")
482
- """Default options for invoice PDF rendering for this customer"""
483
-
484
- class CustomerCashBalanceSettings(BaseModel):
485
- """A hash of settings for this cash balance"""
486
- model_config = ConfigDict(extra="allow", populate_by_name=True)
487
-
488
- reconciliation_mode: Union[str, Any] = Field(default=None, description="The configuration for how funds that land in the customer cash balance are reconciled")
489
- """The configuration for how funds that land in the customer cash balance are reconciled"""
490
- using_merchant_default: Union[bool, Any] = Field(default=None, description="A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance")
491
- """A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance"""
492
-
493
- class CustomerCashBalance(BaseModel):
494
- """The current funds being held by Stripe on behalf of the customer"""
495
- model_config = ConfigDict(extra="allow", populate_by_name=True)
496
-
497
- object: Union[str, Any] = Field(default=None, description="String representing the object's type")
498
- """String representing the object's type"""
499
- available: Union[dict[str, Any] | None, Any] = Field(default=None, description="A hash of all cash balances available to this customer")
500
- """A hash of all cash balances available to this customer"""
501
- customer: Union[str, Any] = Field(default=None, description="The ID of the customer whose cash balance this object represents")
502
- """The ID of the customer whose cash balance this object represents"""
503
- customer_account: Union[str | None, Any] = Field(default=None, description="The ID of the account whose cash balance this object represents")
504
- """The ID of the account whose cash balance this object represents"""
505
- livemode: Union[bool, Any] = Field(default=None, description="Has the value true if the object exists in live mode or false if in test mode")
506
- """Has the value true if the object exists in live mode or false if in test mode"""
507
- settings: Union[CustomerCashBalanceSettings, Any] = Field(default=None, description="A hash of settings for this cash balance")
508
- """A hash of settings for this cash balance"""
509
-
510
510
  class Customer(BaseModel):
511
511
  """Customer type definition"""
512
512
  model_config = ConfigDict(extra="allow", populate_by_name=True)
@@ -551,202 +551,120 @@ class CustomerList(BaseModel):
551
551
  has_more: Union[bool, Any] = Field(default=None)
552
552
  url: Union[str, Any] = Field(default=None)
553
553
 
554
- class InvoiceCustomerTaxIdsItem(BaseModel):
555
- """Nested schema for Invoice.customer_tax_ids_item"""
556
- model_config = ConfigDict(extra="allow", populate_by_name=True)
557
-
558
- type: Union[str, Any] = Field(default=None, description="The type of the tax ID")
559
- """The type of the tax ID"""
560
- value: Union[str | None, Any] = Field(default=None, description="The value of the tax ID")
561
- """The value of the tax ID"""
562
-
563
- class InvoiceLastFinalizationError(BaseModel):
564
- """The error encountered during the last finalization attempt"""
565
- model_config = ConfigDict(extra="allow", populate_by_name=True)
566
-
567
- advice_code: Union[str | None, Any] = Field(default=None, description="For card errors resulting from a card issuer decline")
568
- """For card errors resulting from a card issuer decline"""
569
- code: Union[str | None, Any] = Field(default=None, description="For some errors that could be handled programmatically, a short string indicating the error code")
570
- """For some errors that could be handled programmatically, a short string indicating the error code"""
571
- doc_url: Union[str | None, Any] = Field(default=None, description="A URL to more information about the error code reported")
572
- """A URL to more information about the error code reported"""
573
- message: Union[str | None, Any] = Field(default=None, description="A human-readable message providing more details about the error")
574
- """A human-readable message providing more details about the error"""
575
- network_advice_code: Union[str | None, Any] = Field(default=None, description="For card errors resulting from a card issuer decline")
576
- """For card errors resulting from a card issuer decline"""
577
- network_decline_code: Union[str | None, Any] = Field(default=None, description="For payments declined by the network")
578
- """For payments declined by the network"""
579
- param: Union[str | None, Any] = Field(default=None, description="If the error is parameter-specific, the parameter related to the error")
580
- """If the error is parameter-specific, the parameter related to the error"""
581
- payment_method_type: Union[str | None, Any] = Field(default=None, description="If the error is specific to the type of payment method")
582
- """If the error is specific to the type of payment method"""
583
- type: Union[str, Any] = Field(default=None, description="The type of error returned")
584
- """The type of error returned"""
585
-
586
- class InvoiceCustomerAddress(BaseModel):
554
+ class CustomerCreateParamsAddress(BaseModel):
587
555
  """The customer's address"""
588
556
  model_config = ConfigDict(extra="allow", populate_by_name=True)
589
557
 
590
- city: Union[str | None, Any] = Field(default=None, description="City, district, suburb, town, or village")
591
- """City, district, suburb, town, or village"""
592
- country: Union[str | None, Any] = Field(default=None, description="Two-letter country code (ISO 3166-1 alpha-2)")
593
- """Two-letter country code (ISO 3166-1 alpha-2)"""
594
- line1: Union[str | None, Any] = Field(default=None, description="Address line 1")
558
+ line1: Union[str, Any] = Field(default=None, description="Address line 1")
595
559
  """Address line 1"""
596
- line2: Union[str | None, Any] = Field(default=None, description="Address line 2")
560
+ line2: Union[str, Any] = Field(default=None, description="Address line 2")
597
561
  """Address line 2"""
598
- postal_code: Union[str | None, Any] = Field(default=None, description="ZIP or postal code")
599
- """ZIP or postal code"""
600
- state: Union[str | None, Any] = Field(default=None, description="State, county, province, or region")
562
+ city: Union[str, Any] = Field(default=None, description="City, district, suburb, town, or village")
563
+ """City, district, suburb, town, or village"""
564
+ state: Union[str, Any] = Field(default=None, description="State, county, province, or region")
601
565
  """State, county, province, or region"""
566
+ postal_code: Union[str, Any] = Field(default=None, description="ZIP or postal code")
567
+ """ZIP or postal code"""
568
+ country: Union[str, Any] = Field(default=None, description="Two-letter country code (ISO 3166-1 alpha-2)")
569
+ """Two-letter country code (ISO 3166-1 alpha-2)"""
602
570
 
603
- class InvoiceStatusTransitions(BaseModel):
604
- """Status transition timestamps"""
571
+ class CustomerCreateParams(BaseModel):
572
+ """CustomerCreateParams type definition"""
605
573
  model_config = ConfigDict(extra="allow", populate_by_name=True)
606
574
 
607
- finalized_at: Union[int | None, Any] = Field(default=None, description="The time that the invoice draft was finalized")
608
- """The time that the invoice draft was finalized"""
609
- marked_uncollectible_at: Union[int | None, Any] = Field(default=None, description="The time that the invoice was marked uncollectible")
610
- """The time that the invoice was marked uncollectible"""
611
- paid_at: Union[int | None, Any] = Field(default=None, description="The time that the invoice was paid")
612
- """The time that the invoice was paid"""
613
- voided_at: Union[int | None, Any] = Field(default=None, description="The time that the invoice was voided")
614
- """The time that the invoice was voided"""
575
+ email: Union[str, Any] = Field(default=None)
576
+ name: Union[str, Any] = Field(default=None)
577
+ description: Union[str, Any] = Field(default=None)
578
+ phone: Union[str, Any] = Field(default=None)
579
+ address: Union[CustomerCreateParamsAddress, Any] = Field(default=None)
580
+ metadata: Union[dict[str, str], Any] = Field(default=None)
615
581
 
616
- class InvoiceShippingDetailsAddress(BaseModel):
617
- """Shipping address"""
582
+ class CustomerUpdateParamsAddress(BaseModel):
583
+ """The customer's address"""
618
584
  model_config = ConfigDict(extra="allow", populate_by_name=True)
619
585
 
620
- city: Union[str | None, Any] = Field(default=None, description="City, district, suburb, town, or village")
621
- """City, district, suburb, town, or village"""
622
- country: Union[str | None, Any] = Field(default=None, description="Two-letter country code (ISO 3166-1 alpha-2)")
623
- """Two-letter country code (ISO 3166-1 alpha-2)"""
624
- line1: Union[str | None, Any] = Field(default=None, description="Address line 1")
586
+ line1: Union[str, Any] = Field(default=None, description="Address line 1")
625
587
  """Address line 1"""
626
- line2: Union[str | None, Any] = Field(default=None, description="Address line 2")
588
+ line2: Union[str, Any] = Field(default=None, description="Address line 2")
627
589
  """Address line 2"""
628
- postal_code: Union[str | None, Any] = Field(default=None, description="ZIP or postal code")
629
- """ZIP or postal code"""
630
- state: Union[str | None, Any] = Field(default=None, description="State, county, province, or region")
590
+ city: Union[str, Any] = Field(default=None, description="City, district, suburb, town, or village")
591
+ """City, district, suburb, town, or village"""
592
+ state: Union[str, Any] = Field(default=None, description="State, county, province, or region")
631
593
  """State, county, province, or region"""
594
+ postal_code: Union[str, Any] = Field(default=None, description="ZIP or postal code")
595
+ """ZIP or postal code"""
596
+ country: Union[str, Any] = Field(default=None, description="Two-letter country code (ISO 3166-1 alpha-2)")
597
+ """Two-letter country code (ISO 3166-1 alpha-2)"""
632
598
 
633
- class InvoiceShippingDetails(BaseModel):
634
- """Shipping details for the invoice"""
599
+ class CustomerUpdateParams(BaseModel):
600
+ """CustomerUpdateParams type definition"""
635
601
  model_config = ConfigDict(extra="allow", populate_by_name=True)
636
602
 
637
- address: Union[InvoiceShippingDetailsAddress, Any] = Field(default=None, description="Shipping address")
638
- """Shipping address"""
639
- name: Union[str, Any] = Field(default=None, description="Recipient name")
640
- """Recipient name"""
641
- phone: Union[str | None, Any] = Field(default=None, description="Recipient phone")
642
- """Recipient phone"""
603
+ email: Union[str, Any] = Field(default=None)
604
+ name: Union[str, Any] = Field(default=None)
605
+ description: Union[str, Any] = Field(default=None)
606
+ phone: Union[str, Any] = Field(default=None)
607
+ address: Union[CustomerUpdateParamsAddress, Any] = Field(default=None)
608
+ metadata: Union[dict[str, str], Any] = Field(default=None)
643
609
 
644
- class InvoiceRenderingPdf(BaseModel):
645
- """Invoice pdf rendering options"""
610
+ class CustomerDeletedResponse(BaseModel):
611
+ """CustomerDeletedResponse type definition"""
646
612
  model_config = ConfigDict(extra="allow", populate_by_name=True)
647
613
 
648
- page_size: Union[str | None, Any] = Field(default=None, description="Page size of invoice pdf")
649
- """Page size of invoice pdf"""
614
+ id: Union[str, Any] = Field(default=None)
615
+ object: Union[str, Any] = Field(default=None)
616
+ deleted: Union[bool, Any] = Field(default=None)
650
617
 
651
- class InvoiceRendering(BaseModel):
652
- """The rendering-related settings that control how the invoice is displayed"""
618
+ class InvoiceCustomerTaxIdsItem(BaseModel):
619
+ """Nested schema for Invoice.customer_tax_ids_item"""
653
620
  model_config = ConfigDict(extra="allow", populate_by_name=True)
654
621
 
655
- amount_tax_display: Union[str | None, Any] = Field(default=None, description="How line-item prices and amounts will be displayed with respect to tax")
656
- """How line-item prices and amounts will be displayed with respect to tax"""
657
- pdf: Union[InvoiceRenderingPdf | None, Any] = Field(default=None, description="Invoice pdf rendering options")
658
- """Invoice pdf rendering options"""
659
- template: Union[str | None, Any] = Field(default=None, description="ID of the rendering template that the invoice is formatted by")
660
- """ID of the rendering template that the invoice is formatted by"""
661
- template_version: Union[int | None, Any] = Field(default=None, description="Version of the rendering template that the invoice is using")
662
- """Version of the rendering template that the invoice is using"""
622
+ type: Union[str, Any] = Field(default=None, description="The type of the tax ID")
623
+ """The type of the tax ID"""
624
+ value: Union[str | None, Any] = Field(default=None, description="The value of the tax ID")
625
+ """The value of the tax ID"""
663
626
 
664
- class InvoiceLinesDataItemPeriod(BaseModel):
665
- """The period this line_item covers"""
627
+ class InvoiceFromInvoice(BaseModel):
628
+ """Details of the invoice that was cloned"""
666
629
  model_config = ConfigDict(extra="allow", populate_by_name=True)
667
630
 
668
- end: Union[int, Any] = Field(default=None, description="The end of the period")
669
- """The end of the period"""
670
- start: Union[int, Any] = Field(default=None, description="The start of the period")
671
- """The start of the period"""
631
+ action: Union[str, Any] = Field(default=None)
632
+ invoice: Union[str, Any] = Field(default=None)
672
633
 
673
- class InvoiceLinesDataItemDiscountAmountsItem(BaseModel):
674
- """Nested schema for InvoiceLinesDataItem.discount_amounts_item"""
634
+ class InvoiceTotalTaxesItem(BaseModel):
635
+ """Nested schema for Invoice.total_taxes_item"""
675
636
  model_config = ConfigDict(extra="allow", populate_by_name=True)
676
637
 
677
- amount: Union[int, Any] = Field(default=None, description="The amount of the discount")
678
- """The amount of the discount"""
679
- discount: Union[str, Any] = Field(default=None, description="The discount that was applied")
680
- """The discount that was applied"""
681
-
682
- class InvoiceLinesDataItem(BaseModel):
683
- """Nested schema for InvoiceLines.data_item"""
684
- model_config = ConfigDict(extra="allow", populate_by_name=True)
685
-
686
- id: Union[str, Any] = Field(default=None, description="Unique identifier for the object")
687
- """Unique identifier for the object"""
688
- object: Union[str, Any] = Field(default=None, description="String representing the object's type")
689
- """String representing the object's type"""
690
- amount: Union[int, Any] = Field(default=None, description="The amount in cents")
691
- """The amount in cents"""
692
- currency: Union[str, Any] = Field(default=None, description="Three-letter ISO currency code")
693
- """Three-letter ISO currency code"""
694
- description: Union[str | None, Any] = Field(default=None, description="An arbitrary string attached to the object")
695
- """An arbitrary string attached to the object"""
696
- discount_amounts: Union[list[InvoiceLinesDataItemDiscountAmountsItem] | None, Any] = Field(default=None, description="The amount of discount calculated per discount for this line item")
697
- """The amount of discount calculated per discount for this line item"""
698
- discountable: Union[bool, Any] = Field(default=None, description="If true, discounts will apply to this line item")
699
- """If true, discounts will apply to this line item"""
700
- discounts: Union[list[str], Any] = Field(default=None, description="The discounts applied to the invoice line item")
701
- """The discounts applied to the invoice line item"""
702
- invoice: Union[str | None, Any] = Field(default=None, description="The ID of the invoice that contains this line item")
703
- """The ID of the invoice that contains this line item"""
704
- livemode: Union[bool, Any] = Field(default=None, description="Has the value true if the object exists in live mode")
705
- """Has the value true if the object exists in live mode"""
706
- metadata: Union[dict[str, str], Any] = Field(default=None, description="Set of key-value pairs")
707
- """Set of key-value pairs"""
708
- period: Union[InvoiceLinesDataItemPeriod, Any] = Field(default=None, description="The period this line_item covers")
709
- """The period this line_item covers"""
710
- proration: Union[bool, Any] = Field(default=None, description="Whether this is a proration")
711
- """Whether this is a proration"""
712
- quantity: Union[int | None, Any] = Field(default=None, description="The quantity of the subscription")
713
- """The quantity of the subscription"""
714
-
715
- class InvoiceLines(BaseModel):
716
- """The individual line items that make up the invoice"""
717
- model_config = ConfigDict(extra="allow", populate_by_name=True)
718
-
719
- object: Union[str, Any] = Field(default=None)
720
- data: Union[list[InvoiceLinesDataItem], Any] = Field(default=None)
721
- has_more: Union[bool, Any] = Field(default=None)
722
- total_count: Union[int | None, Any] = Field(default=None)
723
- url: Union[str | None, Any] = Field(default=None)
724
-
725
- class InvoiceShippingCostTaxesItem(BaseModel):
726
- """Nested schema for InvoiceShippingCost.taxes_item"""
727
- model_config = ConfigDict(extra="allow", populate_by_name=True)
728
-
729
- amount: Union[int, Any] = Field(default=None, description="Amount of tax applied for this rate")
730
- """Amount of tax applied for this rate"""
731
- taxability_reason: Union[str | None, Any] = Field(default=None, description="The reasoning behind this tax")
638
+ amount: Union[int, Any] = Field(default=None, description="The amount of the tax")
639
+ """The amount of the tax"""
640
+ tax_behavior: Union[str, Any] = Field(default=None, description="Whether this tax is inclusive or exclusive")
641
+ """Whether this tax is inclusive or exclusive"""
642
+ tax_rate_details: Union[dict[str, Any] | None, Any] = Field(default=None, description="Additional details about the tax rate")
643
+ """Additional details about the tax rate"""
644
+ taxability_reason: Union[str, Any] = Field(default=None, description="The reasoning behind this tax")
732
645
  """The reasoning behind this tax"""
733
646
  taxable_amount: Union[int | None, Any] = Field(default=None, description="The amount on which tax is calculated")
734
647
  """The amount on which tax is calculated"""
648
+ type: Union[str, Any] = Field(default=None, description="The type of tax information")
649
+ """The type of tax information"""
735
650
 
736
- class InvoiceShippingCost(BaseModel):
737
- """The details of the cost of shipping"""
651
+ class InvoiceThresholdReasonItemReasonsItem(BaseModel):
652
+ """Nested schema for InvoiceThresholdReason.item_reasons_item"""
738
653
  model_config = ConfigDict(extra="allow", populate_by_name=True)
739
654
 
740
- amount_subtotal: Union[int, Any] = Field(default=None, description="Total shipping cost before any taxes are applied")
741
- """Total shipping cost before any taxes are applied"""
742
- amount_tax: Union[int, Any] = Field(default=None, description="Total tax amount applied due to shipping costs")
743
- """Total tax amount applied due to shipping costs"""
744
- amount_total: Union[int, Any] = Field(default=None, description="Total shipping cost after taxes are applied")
745
- """Total shipping cost after taxes are applied"""
746
- shipping_rate: Union[str | None, Any] = Field(default=None, description="The ID of the ShippingRate for this invoice")
747
- """The ID of the ShippingRate for this invoice"""
748
- taxes: Union[list[InvoiceShippingCostTaxesItem] | None, Any] = Field(default=None, description="The taxes applied to the shipping rate")
749
- """The taxes applied to the shipping rate"""
655
+ line_item_ids: Union[list[str], Any] = Field(default=None, description="The IDs of the line items that triggered the threshold invoice")
656
+ """The IDs of the line items that triggered the threshold invoice"""
657
+ usage_gte: Union[int, Any] = Field(default=None, description="The quantity threshold boundary that applied to the given line item")
658
+ """The quantity threshold boundary that applied to the given line item"""
659
+
660
+ class InvoiceThresholdReason(BaseModel):
661
+ """If billing_reason is set to subscription_threshold this returns more information"""
662
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
663
+
664
+ amount_gte: Union[int | None, Any] = Field(default=None, description="The total invoice amount threshold boundary if it triggered the threshold invoice")
665
+ """The total invoice amount threshold boundary if it triggered the threshold invoice"""
666
+ item_reasons: Union[list[InvoiceThresholdReasonItemReasonsItem], Any] = Field(default=None, description="Indicates which line items triggered a threshold invoice")
667
+ """Indicates which line items triggered a threshold invoice"""
750
668
 
751
669
  class InvoiceDefaultTaxRatesItemFlatAmount(BaseModel):
752
670
  """The amount of the tax rate when the rate_type is flat_amount"""
@@ -798,99 +716,6 @@ class InvoiceDefaultTaxRatesItem(BaseModel):
798
716
  tax_type: Union[str | None, Any] = Field(default=None, description="The high-level tax type")
799
717
  """The high-level tax type"""
800
718
 
801
- class InvoiceIssuer(BaseModel):
802
- """The connected account that issues the invoice"""
803
- model_config = ConfigDict(extra="allow", populate_by_name=True)
804
-
805
- account: Union[str | None, Any] = Field(default=None, description="The connected account being referenced when type is account")
806
- """The connected account being referenced when type is account"""
807
- type: Union[str, Any] = Field(default=None, description="Type of the account referenced")
808
- """Type of the account referenced"""
809
-
810
- class InvoiceTotalTaxesItem(BaseModel):
811
- """Nested schema for Invoice.total_taxes_item"""
812
- model_config = ConfigDict(extra="allow", populate_by_name=True)
813
-
814
- amount: Union[int, Any] = Field(default=None, description="The amount of the tax")
815
- """The amount of the tax"""
816
- tax_behavior: Union[str, Any] = Field(default=None, description="Whether this tax is inclusive or exclusive")
817
- """Whether this tax is inclusive or exclusive"""
818
- tax_rate_details: Union[dict[str, Any] | None, Any] = Field(default=None, description="Additional details about the tax rate")
819
- """Additional details about the tax rate"""
820
- taxability_reason: Union[str, Any] = Field(default=None, description="The reasoning behind this tax")
821
- """The reasoning behind this tax"""
822
- taxable_amount: Union[int | None, Any] = Field(default=None, description="The amount on which tax is calculated")
823
- """The amount on which tax is calculated"""
824
- type: Union[str, Any] = Field(default=None, description="The type of tax information")
825
- """The type of tax information"""
826
-
827
- class InvoicePaymentsDataItem(BaseModel):
828
- """Nested schema for InvoicePayments.data_item"""
829
- model_config = ConfigDict(extra="allow", populate_by_name=True)
830
-
831
- id: Union[str, Any] = Field(default=None, description="Unique identifier for the object")
832
- """Unique identifier for the object"""
833
- object: Union[str, Any] = Field(default=None, description="String representing the object's type")
834
- """String representing the object's type"""
835
- amount_paid: Union[int | None, Any] = Field(default=None, description="Amount that was actually paid for this invoice")
836
- """Amount that was actually paid for this invoice"""
837
- amount_requested: Union[int, Any] = Field(default=None, description="Amount intended to be paid toward this invoice")
838
- """Amount intended to be paid toward this invoice"""
839
- created: Union[int, Any] = Field(default=None, description="Time at which the object was created")
840
- """Time at which the object was created"""
841
- currency: Union[str, Any] = Field(default=None, description="Three-letter ISO currency code")
842
- """Three-letter ISO currency code"""
843
- invoice: Union[str, Any] = Field(default=None, description="The invoice that was paid")
844
- """The invoice that was paid"""
845
- is_default: Union[bool, Any] = Field(default=None, description="Whether this is the default payment created when the invoice was finalized")
846
- """Whether this is the default payment created when the invoice was finalized"""
847
- livemode: Union[bool, Any] = Field(default=None, description="Has the value true if the object exists in live mode")
848
- """Has the value true if the object exists in live mode"""
849
- status: Union[str, Any] = Field(default=None, description="The status of the payment")
850
- """The status of the payment"""
851
-
852
- class InvoicePayments(BaseModel):
853
- """Payments for this invoice"""
854
- model_config = ConfigDict(extra="allow", populate_by_name=True)
855
-
856
- object: Union[str, Any] = Field(default=None, description="String representing the object's type")
857
- """String representing the object's type"""
858
- data: Union[list[InvoicePaymentsDataItem], Any] = Field(default=None, description="Details about each payment")
859
- """Details about each payment"""
860
- has_more: Union[bool, Any] = Field(default=None, description="True if this list has another page of items")
861
- """True if this list has another page of items"""
862
- url: Union[str, Any] = Field(default=None, description="The URL where this list can be accessed")
863
- """The URL where this list can be accessed"""
864
-
865
- class InvoiceParentSubscriptionDetails(BaseModel):
866
- """Details about the subscription that generated this invoice"""
867
- model_config = ConfigDict(extra="allow", populate_by_name=True)
868
-
869
- metadata: Union[dict[str, str] | None, Any] = Field(default=None, description="Set of key-value pairs defined as subscription metadata")
870
- """Set of key-value pairs defined as subscription metadata"""
871
- subscription: Union[str, Any] = Field(default=None, description="The subscription that generated this invoice")
872
- """The subscription that generated this invoice"""
873
- subscription_proration_date: Union[int | None, Any] = Field(default=None, description="Only set for upcoming invoices that preview prorations")
874
- """Only set for upcoming invoices that preview prorations"""
875
-
876
- class InvoiceParentQuoteDetails(BaseModel):
877
- """Details about the quote that generated this invoice"""
878
- model_config = ConfigDict(extra="allow", populate_by_name=True)
879
-
880
- quote: Union[str, Any] = Field(default=None, description="The quote that generated this invoice")
881
- """The quote that generated this invoice"""
882
-
883
- class InvoiceParent(BaseModel):
884
- """The parent that generated this invoice"""
885
- model_config = ConfigDict(extra="allow", populate_by_name=True)
886
-
887
- quote_details: Union[InvoiceParentQuoteDetails | None, Any] = Field(default=None, description="Details about the quote that generated this invoice")
888
- """Details about the quote that generated this invoice"""
889
- subscription_details: Union[InvoiceParentSubscriptionDetails | None, Any] = Field(default=None, description="Details about the subscription that generated this invoice")
890
- """Details about the subscription that generated this invoice"""
891
- type: Union[str, Any] = Field(default=None, description="The type of parent that generated this invoice")
892
- """The type of parent that generated this invoice"""
893
-
894
719
  class InvoiceAutomaticTaxLiability(BaseModel):
895
720
  """The account that's liable for tax"""
896
721
  model_config = ConfigDict(extra="allow", populate_by_name=True)
@@ -915,6 +740,62 @@ class InvoiceAutomaticTax(BaseModel):
915
740
  status: Union[str | None, Any] = Field(default=None, description="The status of the most recent automated tax calculation for this invoice")
916
741
  """The status of the most recent automated tax calculation for this invoice"""
917
742
 
743
+ class InvoiceLastFinalizationError(BaseModel):
744
+ """The error encountered during the last finalization attempt"""
745
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
746
+
747
+ advice_code: Union[str | None, Any] = Field(default=None, description="For card errors resulting from a card issuer decline")
748
+ """For card errors resulting from a card issuer decline"""
749
+ code: Union[str | None, Any] = Field(default=None, description="For some errors that could be handled programmatically, a short string indicating the error code")
750
+ """For some errors that could be handled programmatically, a short string indicating the error code"""
751
+ doc_url: Union[str | None, Any] = Field(default=None, description="A URL to more information about the error code reported")
752
+ """A URL to more information about the error code reported"""
753
+ message: Union[str | None, Any] = Field(default=None, description="A human-readable message providing more details about the error")
754
+ """A human-readable message providing more details about the error"""
755
+ network_advice_code: Union[str | None, Any] = Field(default=None, description="For card errors resulting from a card issuer decline")
756
+ """For card errors resulting from a card issuer decline"""
757
+ network_decline_code: Union[str | None, Any] = Field(default=None, description="For payments declined by the network")
758
+ """For payments declined by the network"""
759
+ param: Union[str | None, Any] = Field(default=None, description="If the error is parameter-specific, the parameter related to the error")
760
+ """If the error is parameter-specific, the parameter related to the error"""
761
+ payment_method_type: Union[str | None, Any] = Field(default=None, description="If the error is specific to the type of payment method")
762
+ """If the error is specific to the type of payment method"""
763
+ type: Union[str, Any] = Field(default=None, description="The type of error returned")
764
+ """The type of error returned"""
765
+
766
+ class InvoiceCustomFieldsItem(BaseModel):
767
+ """Nested schema for Invoice.custom_fields_item"""
768
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
769
+
770
+ name: Union[str, Any] = Field(default=None, description="The name of the custom field")
771
+ """The name of the custom field"""
772
+ value: Union[str, Any] = Field(default=None, description="The value of the custom field")
773
+ """The value of the custom field"""
774
+
775
+ class InvoiceCustomerAddress(BaseModel):
776
+ """The customer's address"""
777
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
778
+
779
+ city: Union[str | None, Any] = Field(default=None, description="City, district, suburb, town, or village")
780
+ """City, district, suburb, town, or village"""
781
+ country: Union[str | None, Any] = Field(default=None, description="Two-letter country code (ISO 3166-1 alpha-2)")
782
+ """Two-letter country code (ISO 3166-1 alpha-2)"""
783
+ line1: Union[str | None, Any] = Field(default=None, description="Address line 1")
784
+ """Address line 1"""
785
+ line2: Union[str | None, Any] = Field(default=None, description="Address line 2")
786
+ """Address line 2"""
787
+ postal_code: Union[str | None, Any] = Field(default=None, description="ZIP or postal code")
788
+ """ZIP or postal code"""
789
+ state: Union[str | None, Any] = Field(default=None, description="State, county, province, or region")
790
+ """State, county, province, or region"""
791
+
792
+ class InvoiceSubscriptionDetails(BaseModel):
793
+ """Details about the subscription that this invoice was prepared for, if any"""
794
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
795
+
796
+ metadata: Union[dict[str, str] | None, Any] = Field(default=None, description="Set of key-value pairs defined as subscription metadata when the invoice is created")
797
+ """Set of key-value pairs defined as subscription metadata when the invoice is created"""
798
+
918
799
  class InvoiceDiscountCoupon(BaseModel):
919
800
  """Nested schema for InvoiceDiscount.coupon"""
920
801
  model_config = ConfigDict(extra="allow", populate_by_name=True)
@@ -953,23 +834,14 @@ class InvoiceDiscount(BaseModel):
953
834
  subscription: Union[str | None, Any] = Field(default=None)
954
835
  subscription_item: Union[str | None, Any] = Field(default=None)
955
836
 
956
- class InvoiceCustomFieldsItem(BaseModel):
957
- """Nested schema for Invoice.custom_fields_item"""
958
- model_config = ConfigDict(extra="allow", populate_by_name=True)
959
-
960
- name: Union[str, Any] = Field(default=None, description="The name of the custom field")
961
- """The name of the custom field"""
962
- value: Union[str, Any] = Field(default=None, description="The value of the custom field")
963
- """The value of the custom field"""
964
-
965
- class InvoiceConfirmationSecret(BaseModel):
966
- """The confirmation secret associated with this invoice"""
837
+ class InvoiceTotalDiscountAmountsItem(BaseModel):
838
+ """Nested schema for Invoice.total_discount_amounts_item"""
967
839
  model_config = ConfigDict(extra="allow", populate_by_name=True)
968
840
 
969
- client_secret: Union[str, Any] = Field(default=None, description="The client_secret of the payment that Stripe creates for the invoice after finalization")
970
- """The client_secret of the payment that Stripe creates for the invoice after finalization"""
971
- type: Union[str, Any] = Field(default=None, description="The type of client_secret")
972
- """The type of client_secret"""
841
+ amount: Union[int, Any] = Field(default=None, description="The amount of the discount")
842
+ """The amount of the discount"""
843
+ discount: Union[str, Any] = Field(default=None, description="The discount that was applied")
844
+ """The discount that was applied"""
973
845
 
974
846
  class InvoiceTotalTaxAmountsItem(BaseModel):
975
847
  """Nested schema for Invoice.total_tax_amounts_item"""
@@ -986,6 +858,243 @@ class InvoiceTotalTaxAmountsItem(BaseModel):
986
858
  taxable_amount: Union[int, Any] = Field(default=None, description="The amount on which tax is calculated")
987
859
  """The amount on which tax is calculated"""
988
860
 
861
+ class InvoiceIssuer(BaseModel):
862
+ """The connected account that issues the invoice"""
863
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
864
+
865
+ account: Union[str | None, Any] = Field(default=None, description="The connected account being referenced when type is account")
866
+ """The connected account being referenced when type is account"""
867
+ type: Union[str, Any] = Field(default=None, description="Type of the account referenced")
868
+ """Type of the account referenced"""
869
+
870
+ class InvoiceShippingCostTaxesItem(BaseModel):
871
+ """Nested schema for InvoiceShippingCost.taxes_item"""
872
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
873
+
874
+ amount: Union[int, Any] = Field(default=None, description="Amount of tax applied for this rate")
875
+ """Amount of tax applied for this rate"""
876
+ taxability_reason: Union[str | None, Any] = Field(default=None, description="The reasoning behind this tax")
877
+ """The reasoning behind this tax"""
878
+ taxable_amount: Union[int | None, Any] = Field(default=None, description="The amount on which tax is calculated")
879
+ """The amount on which tax is calculated"""
880
+
881
+ class InvoiceShippingCost(BaseModel):
882
+ """The details of the cost of shipping"""
883
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
884
+
885
+ amount_subtotal: Union[int, Any] = Field(default=None, description="Total shipping cost before any taxes are applied")
886
+ """Total shipping cost before any taxes are applied"""
887
+ amount_tax: Union[int, Any] = Field(default=None, description="Total tax amount applied due to shipping costs")
888
+ """Total tax amount applied due to shipping costs"""
889
+ amount_total: Union[int, Any] = Field(default=None, description="Total shipping cost after taxes are applied")
890
+ """Total shipping cost after taxes are applied"""
891
+ shipping_rate: Union[str | None, Any] = Field(default=None, description="The ID of the ShippingRate for this invoice")
892
+ """The ID of the ShippingRate for this invoice"""
893
+ taxes: Union[list[InvoiceShippingCostTaxesItem] | None, Any] = Field(default=None, description="The taxes applied to the shipping rate")
894
+ """The taxes applied to the shipping rate"""
895
+
896
+ class InvoiceLinesDataItemPeriod(BaseModel):
897
+ """The period this line_item covers"""
898
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
899
+
900
+ end: Union[int, Any] = Field(default=None, description="The end of the period")
901
+ """The end of the period"""
902
+ start: Union[int, Any] = Field(default=None, description="The start of the period")
903
+ """The start of the period"""
904
+
905
+ class InvoiceLinesDataItemDiscountAmountsItem(BaseModel):
906
+ """Nested schema for InvoiceLinesDataItem.discount_amounts_item"""
907
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
908
+
909
+ amount: Union[int, Any] = Field(default=None, description="The amount of the discount")
910
+ """The amount of the discount"""
911
+ discount: Union[str, Any] = Field(default=None, description="The discount that was applied")
912
+ """The discount that was applied"""
913
+
914
+ class InvoiceLinesDataItem(BaseModel):
915
+ """Nested schema for InvoiceLines.data_item"""
916
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
917
+
918
+ id: Union[str, Any] = Field(default=None, description="Unique identifier for the object")
919
+ """Unique identifier for the object"""
920
+ object: Union[str, Any] = Field(default=None, description="String representing the object's type")
921
+ """String representing the object's type"""
922
+ amount: Union[int, Any] = Field(default=None, description="The amount in cents")
923
+ """The amount in cents"""
924
+ currency: Union[str, Any] = Field(default=None, description="Three-letter ISO currency code")
925
+ """Three-letter ISO currency code"""
926
+ description: Union[str | None, Any] = Field(default=None, description="An arbitrary string attached to the object")
927
+ """An arbitrary string attached to the object"""
928
+ discount_amounts: Union[list[InvoiceLinesDataItemDiscountAmountsItem] | None, Any] = Field(default=None, description="The amount of discount calculated per discount for this line item")
929
+ """The amount of discount calculated per discount for this line item"""
930
+ discountable: Union[bool, Any] = Field(default=None, description="If true, discounts will apply to this line item")
931
+ """If true, discounts will apply to this line item"""
932
+ discounts: Union[list[str], Any] = Field(default=None, description="The discounts applied to the invoice line item")
933
+ """The discounts applied to the invoice line item"""
934
+ invoice: Union[str | None, Any] = Field(default=None, description="The ID of the invoice that contains this line item")
935
+ """The ID of the invoice that contains this line item"""
936
+ livemode: Union[bool, Any] = Field(default=None, description="Has the value true if the object exists in live mode")
937
+ """Has the value true if the object exists in live mode"""
938
+ metadata: Union[dict[str, str], Any] = Field(default=None, description="Set of key-value pairs")
939
+ """Set of key-value pairs"""
940
+ period: Union[InvoiceLinesDataItemPeriod, Any] = Field(default=None, description="The period this line_item covers")
941
+ """The period this line_item covers"""
942
+ proration: Union[bool, Any] = Field(default=None, description="Whether this is a proration")
943
+ """Whether this is a proration"""
944
+ quantity: Union[int | None, Any] = Field(default=None, description="The quantity of the subscription")
945
+ """The quantity of the subscription"""
946
+
947
+ class InvoiceLines(BaseModel):
948
+ """The individual line items that make up the invoice"""
949
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
950
+
951
+ object: Union[str, Any] = Field(default=None)
952
+ data: Union[list[InvoiceLinesDataItem], Any] = Field(default=None)
953
+ has_more: Union[bool, Any] = Field(default=None)
954
+ total_count: Union[int | None, Any] = Field(default=None)
955
+ url: Union[str | None, Any] = Field(default=None)
956
+
957
+ class InvoiceConfirmationSecret(BaseModel):
958
+ """The confirmation secret associated with this invoice"""
959
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
960
+
961
+ client_secret: Union[str, Any] = Field(default=None, description="The client_secret of the payment that Stripe creates for the invoice after finalization")
962
+ """The client_secret of the payment that Stripe creates for the invoice after finalization"""
963
+ type: Union[str, Any] = Field(default=None, description="The type of client_secret")
964
+ """The type of client_secret"""
965
+
966
+ class InvoiceParentQuoteDetails(BaseModel):
967
+ """Details about the quote that generated this invoice"""
968
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
969
+
970
+ quote: Union[str, Any] = Field(default=None, description="The quote that generated this invoice")
971
+ """The quote that generated this invoice"""
972
+
973
+ class InvoiceParentSubscriptionDetails(BaseModel):
974
+ """Details about the subscription that generated this invoice"""
975
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
976
+
977
+ metadata: Union[dict[str, str] | None, Any] = Field(default=None, description="Set of key-value pairs defined as subscription metadata")
978
+ """Set of key-value pairs defined as subscription metadata"""
979
+ subscription: Union[str, Any] = Field(default=None, description="The subscription that generated this invoice")
980
+ """The subscription that generated this invoice"""
981
+ subscription_proration_date: Union[int | None, Any] = Field(default=None, description="Only set for upcoming invoices that preview prorations")
982
+ """Only set for upcoming invoices that preview prorations"""
983
+
984
+ class InvoiceParent(BaseModel):
985
+ """The parent that generated this invoice"""
986
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
987
+
988
+ quote_details: Union[InvoiceParentQuoteDetails | None, Any] = Field(default=None, description="Details about the quote that generated this invoice")
989
+ """Details about the quote that generated this invoice"""
990
+ subscription_details: Union[InvoiceParentSubscriptionDetails | None, Any] = Field(default=None, description="Details about the subscription that generated this invoice")
991
+ """Details about the subscription that generated this invoice"""
992
+ type: Union[str, Any] = Field(default=None, description="The type of parent that generated this invoice")
993
+ """The type of parent that generated this invoice"""
994
+
995
+ class InvoiceTotalPretaxCreditAmountsItem(BaseModel):
996
+ """Nested schema for Invoice.total_pretax_credit_amounts_item"""
997
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
998
+
999
+ amount: Union[int, Any] = Field(default=None, description="The amount of the pretax credit amount")
1000
+ """The amount of the pretax credit amount"""
1001
+ credit_balance_transaction: Union[str | None, Any] = Field(default=None, description="The credit balance transaction that was applied")
1002
+ """The credit balance transaction that was applied"""
1003
+ discount: Union[str | None, Any] = Field(default=None, description="The discount that was applied")
1004
+ """The discount that was applied"""
1005
+ type: Union[str, Any] = Field(default=None, description="Type of the pretax credit amount referenced")
1006
+ """Type of the pretax credit amount referenced"""
1007
+
1008
+ class InvoicePaymentSettings(BaseModel):
1009
+ """Configuration settings for the PaymentIntent that is generated when the invoice is finalized"""
1010
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
1011
+
1012
+ default_mandate: Union[str | None, Any] = Field(default=None, description="ID of the mandate to be used for this invoice")
1013
+ """ID of the mandate to be used for this invoice"""
1014
+ payment_method_options: Union[dict[str, Any] | None, Any] = Field(default=None, description="Payment-method-specific configuration to provide to the invoice's PaymentIntent")
1015
+ """Payment-method-specific configuration to provide to the invoice's PaymentIntent"""
1016
+ payment_method_types: Union[list[str] | None, Any] = Field(default=None, description="The list of payment method types to provide to the invoice's PaymentIntent")
1017
+ """The list of payment method types to provide to the invoice's PaymentIntent"""
1018
+
1019
+ class InvoiceShippingDetailsAddress(BaseModel):
1020
+ """Shipping address"""
1021
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
1022
+
1023
+ city: Union[str | None, Any] = Field(default=None, description="City, district, suburb, town, or village")
1024
+ """City, district, suburb, town, or village"""
1025
+ country: Union[str | None, Any] = Field(default=None, description="Two-letter country code (ISO 3166-1 alpha-2)")
1026
+ """Two-letter country code (ISO 3166-1 alpha-2)"""
1027
+ line1: Union[str | None, Any] = Field(default=None, description="Address line 1")
1028
+ """Address line 1"""
1029
+ line2: Union[str | None, Any] = Field(default=None, description="Address line 2")
1030
+ """Address line 2"""
1031
+ postal_code: Union[str | None, Any] = Field(default=None, description="ZIP or postal code")
1032
+ """ZIP or postal code"""
1033
+ state: Union[str | None, Any] = Field(default=None, description="State, county, province, or region")
1034
+ """State, county, province, or region"""
1035
+
1036
+ class InvoiceShippingDetails(BaseModel):
1037
+ """Shipping details for the invoice"""
1038
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
1039
+
1040
+ address: Union[InvoiceShippingDetailsAddress, Any] = Field(default=None, description="Shipping address")
1041
+ """Shipping address"""
1042
+ name: Union[str, Any] = Field(default=None, description="Recipient name")
1043
+ """Recipient name"""
1044
+ phone: Union[str | None, Any] = Field(default=None, description="Recipient phone")
1045
+ """Recipient phone"""
1046
+
1047
+ class InvoiceStatusTransitions(BaseModel):
1048
+ """Status transition timestamps"""
1049
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
1050
+
1051
+ finalized_at: Union[int | None, Any] = Field(default=None, description="The time that the invoice draft was finalized")
1052
+ """The time that the invoice draft was finalized"""
1053
+ marked_uncollectible_at: Union[int | None, Any] = Field(default=None, description="The time that the invoice was marked uncollectible")
1054
+ """The time that the invoice was marked uncollectible"""
1055
+ paid_at: Union[int | None, Any] = Field(default=None, description="The time that the invoice was paid")
1056
+ """The time that the invoice was paid"""
1057
+ voided_at: Union[int | None, Any] = Field(default=None, description="The time that the invoice was voided")
1058
+ """The time that the invoice was voided"""
1059
+
1060
+ class InvoicePaymentsDataItem(BaseModel):
1061
+ """Nested schema for InvoicePayments.data_item"""
1062
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
1063
+
1064
+ id: Union[str, Any] = Field(default=None, description="Unique identifier for the object")
1065
+ """Unique identifier for the object"""
1066
+ object: Union[str, Any] = Field(default=None, description="String representing the object's type")
1067
+ """String representing the object's type"""
1068
+ amount_paid: Union[int | None, Any] = Field(default=None, description="Amount that was actually paid for this invoice")
1069
+ """Amount that was actually paid for this invoice"""
1070
+ amount_requested: Union[int, Any] = Field(default=None, description="Amount intended to be paid toward this invoice")
1071
+ """Amount intended to be paid toward this invoice"""
1072
+ created: Union[int, Any] = Field(default=None, description="Time at which the object was created")
1073
+ """Time at which the object was created"""
1074
+ currency: Union[str, Any] = Field(default=None, description="Three-letter ISO currency code")
1075
+ """Three-letter ISO currency code"""
1076
+ invoice: Union[str, Any] = Field(default=None, description="The invoice that was paid")
1077
+ """The invoice that was paid"""
1078
+ is_default: Union[bool, Any] = Field(default=None, description="Whether this is the default payment created when the invoice was finalized")
1079
+ """Whether this is the default payment created when the invoice was finalized"""
1080
+ livemode: Union[bool, Any] = Field(default=None, description="Has the value true if the object exists in live mode")
1081
+ """Has the value true if the object exists in live mode"""
1082
+ status: Union[str, Any] = Field(default=None, description="The status of the payment")
1083
+ """The status of the payment"""
1084
+
1085
+ class InvoicePayments(BaseModel):
1086
+ """Payments for this invoice"""
1087
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
1088
+
1089
+ object: Union[str, Any] = Field(default=None, description="String representing the object's type")
1090
+ """String representing the object's type"""
1091
+ data: Union[list[InvoicePaymentsDataItem], Any] = Field(default=None, description="Details about each payment")
1092
+ """Details about each payment"""
1093
+ has_more: Union[bool, Any] = Field(default=None, description="True if this list has another page of items")
1094
+ """True if this list has another page of items"""
1095
+ url: Union[str, Any] = Field(default=None, description="The URL where this list can be accessed")
1096
+ """The URL where this list can be accessed"""
1097
+
989
1098
  class InvoiceCustomerShippingAddress(BaseModel):
990
1099
  """Customer shipping address"""
991
1100
  model_config = ConfigDict(extra="allow", populate_by_name=True)
@@ -1014,70 +1123,25 @@ class InvoiceCustomerShipping(BaseModel):
1014
1123
  phone: Union[str | None, Any] = Field(default=None, description="Customer phone (including extension)")
1015
1124
  """Customer phone (including extension)"""
1016
1125
 
1017
- class InvoiceThresholdReasonItemReasonsItem(BaseModel):
1018
- """Nested schema for InvoiceThresholdReason.item_reasons_item"""
1019
- model_config = ConfigDict(extra="allow", populate_by_name=True)
1020
-
1021
- line_item_ids: Union[list[str], Any] = Field(default=None, description="The IDs of the line items that triggered the threshold invoice")
1022
- """The IDs of the line items that triggered the threshold invoice"""
1023
- usage_gte: Union[int, Any] = Field(default=None, description="The quantity threshold boundary that applied to the given line item")
1024
- """The quantity threshold boundary that applied to the given line item"""
1025
-
1026
- class InvoiceThresholdReason(BaseModel):
1027
- """If billing_reason is set to subscription_threshold this returns more information"""
1028
- model_config = ConfigDict(extra="allow", populate_by_name=True)
1029
-
1030
- amount_gte: Union[int | None, Any] = Field(default=None, description="The total invoice amount threshold boundary if it triggered the threshold invoice")
1031
- """The total invoice amount threshold boundary if it triggered the threshold invoice"""
1032
- item_reasons: Union[list[InvoiceThresholdReasonItemReasonsItem], Any] = Field(default=None, description="Indicates which line items triggered a threshold invoice")
1033
- """Indicates which line items triggered a threshold invoice"""
1034
-
1035
- class InvoiceFromInvoice(BaseModel):
1036
- """Details of the invoice that was cloned"""
1037
- model_config = ConfigDict(extra="allow", populate_by_name=True)
1038
-
1039
- action: Union[str, Any] = Field(default=None)
1040
- invoice: Union[str, Any] = Field(default=None)
1041
-
1042
- class InvoiceSubscriptionDetails(BaseModel):
1043
- """Details about the subscription that this invoice was prepared for, if any"""
1044
- model_config = ConfigDict(extra="allow", populate_by_name=True)
1045
-
1046
- metadata: Union[dict[str, str] | None, Any] = Field(default=None, description="Set of key-value pairs defined as subscription metadata when the invoice is created")
1047
- """Set of key-value pairs defined as subscription metadata when the invoice is created"""
1048
-
1049
- class InvoiceTotalPretaxCreditAmountsItem(BaseModel):
1050
- """Nested schema for Invoice.total_pretax_credit_amounts_item"""
1051
- model_config = ConfigDict(extra="allow", populate_by_name=True)
1052
-
1053
- amount: Union[int, Any] = Field(default=None, description="The amount of the pretax credit amount")
1054
- """The amount of the pretax credit amount"""
1055
- credit_balance_transaction: Union[str | None, Any] = Field(default=None, description="The credit balance transaction that was applied")
1056
- """The credit balance transaction that was applied"""
1057
- discount: Union[str | None, Any] = Field(default=None, description="The discount that was applied")
1058
- """The discount that was applied"""
1059
- type: Union[str, Any] = Field(default=None, description="Type of the pretax credit amount referenced")
1060
- """Type of the pretax credit amount referenced"""
1061
-
1062
- class InvoicePaymentSettings(BaseModel):
1063
- """Configuration settings for the PaymentIntent that is generated when the invoice is finalized"""
1126
+ class InvoiceRenderingPdf(BaseModel):
1127
+ """Invoice pdf rendering options"""
1064
1128
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1065
1129
 
1066
- default_mandate: Union[str | None, Any] = Field(default=None, description="ID of the mandate to be used for this invoice")
1067
- """ID of the mandate to be used for this invoice"""
1068
- payment_method_options: Union[dict[str, Any] | None, Any] = Field(default=None, description="Payment-method-specific configuration to provide to the invoice's PaymentIntent")
1069
- """Payment-method-specific configuration to provide to the invoice's PaymentIntent"""
1070
- payment_method_types: Union[list[str] | None, Any] = Field(default=None, description="The list of payment method types to provide to the invoice's PaymentIntent")
1071
- """The list of payment method types to provide to the invoice's PaymentIntent"""
1130
+ page_size: Union[str | None, Any] = Field(default=None, description="Page size of invoice pdf")
1131
+ """Page size of invoice pdf"""
1072
1132
 
1073
- class InvoiceTotalDiscountAmountsItem(BaseModel):
1074
- """Nested schema for Invoice.total_discount_amounts_item"""
1133
+ class InvoiceRendering(BaseModel):
1134
+ """The rendering-related settings that control how the invoice is displayed"""
1075
1135
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1076
1136
 
1077
- amount: Union[int, Any] = Field(default=None, description="The amount of the discount")
1078
- """The amount of the discount"""
1079
- discount: Union[str, Any] = Field(default=None, description="The discount that was applied")
1080
- """The discount that was applied"""
1137
+ amount_tax_display: Union[str | None, Any] = Field(default=None, description="How line-item prices and amounts will be displayed with respect to tax")
1138
+ """How line-item prices and amounts will be displayed with respect to tax"""
1139
+ pdf: Union[InvoiceRenderingPdf | None, Any] = Field(default=None, description="Invoice pdf rendering options")
1140
+ """Invoice pdf rendering options"""
1141
+ template: Union[str | None, Any] = Field(default=None, description="ID of the rendering template that the invoice is formatted by")
1142
+ """ID of the rendering template that the invoice is formatted by"""
1143
+ template_version: Union[int | None, Any] = Field(default=None, description="Version of the rendering template that the invoice is using")
1144
+ """Version of the rendering template that the invoice is using"""
1081
1145
 
1082
1146
  class Invoice(BaseModel):
1083
1147
  """Invoice type definition"""
@@ -1183,14 +1247,26 @@ class InvoiceList(BaseModel):
1183
1247
  has_more: Union[bool, Any] = Field(default=None)
1184
1248
  url: Union[str, Any] = Field(default=None)
1185
1249
 
1186
- class ChargeFraudDetails(BaseModel):
1187
- """Information on fraud assessments for the charge"""
1250
+ class ChargeBillingDetailsAddress(BaseModel):
1251
+ """Nested schema for ChargeBillingDetails.address"""
1188
1252
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1189
1253
 
1190
- stripe_report: Union[str | None, Any] = Field(default=None, description="Assessments from Stripe. If set, the value is `fraudulent`.")
1191
- """Assessments from Stripe. If set, the value is `fraudulent`."""
1192
- user_report: Union[str | None, Any] = Field(default=None, description="Assessments from you or your users. Possible values are `fraudulent` and `safe`")
1193
- """Assessments from you or your users. Possible values are `fraudulent` and `safe`"""
1254
+ city: Union[str | None, Any] = Field(default=None)
1255
+ country: Union[str | None, Any] = Field(default=None)
1256
+ line1: Union[str | None, Any] = Field(default=None)
1257
+ line2: Union[str | None, Any] = Field(default=None)
1258
+ postal_code: Union[str | None, Any] = Field(default=None)
1259
+ state: Union[str | None, Any] = Field(default=None)
1260
+
1261
+ class ChargeBillingDetails(BaseModel):
1262
+ """Billing information associated with the payment method"""
1263
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
1264
+
1265
+ address: Union[ChargeBillingDetailsAddress | None, Any] = Field(default=None)
1266
+ email: Union[str | None, Any] = Field(default=None)
1267
+ name: Union[str | None, Any] = Field(default=None)
1268
+ phone: Union[str | None, Any] = Field(default=None)
1269
+ tax_id: Union[str | None, Any] = Field(default=None)
1194
1270
 
1195
1271
  class ChargeOutcome(BaseModel):
1196
1272
  """Details about whether the payment was accepted, and why"""
@@ -1206,26 +1282,25 @@ class ChargeOutcome(BaseModel):
1206
1282
  seller_message: Union[str, Any] = Field(default=None)
1207
1283
  type: Union[str, Any] = Field(default=None)
1208
1284
 
1209
- class ChargeBillingDetailsAddress(BaseModel):
1210
- """Nested schema for ChargeBillingDetails.address"""
1285
+ class ChargeFraudDetails(BaseModel):
1286
+ """Information on fraud assessments for the charge"""
1211
1287
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1212
1288
 
1213
- city: Union[str | None, Any] = Field(default=None)
1214
- country: Union[str | None, Any] = Field(default=None)
1215
- line1: Union[str | None, Any] = Field(default=None)
1216
- line2: Union[str | None, Any] = Field(default=None)
1217
- postal_code: Union[str | None, Any] = Field(default=None)
1218
- state: Union[str | None, Any] = Field(default=None)
1289
+ stripe_report: Union[str | None, Any] = Field(default=None, description="Assessments from Stripe. If set, the value is `fraudulent`.")
1290
+ """Assessments from Stripe. If set, the value is `fraudulent`."""
1291
+ user_report: Union[str | None, Any] = Field(default=None, description="Assessments from you or your users. Possible values are `fraudulent` and `safe`")
1292
+ """Assessments from you or your users. Possible values are `fraudulent` and `safe`"""
1219
1293
 
1220
- class ChargeBillingDetails(BaseModel):
1221
- """Billing information associated with the payment method"""
1294
+ class ChargePresentmentDetails(BaseModel):
1295
+ """Currency presentation information for multi-currency charges"""
1222
1296
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1223
1297
 
1224
- address: Union[ChargeBillingDetailsAddress | None, Any] = Field(default=None)
1225
- email: Union[str | None, Any] = Field(default=None)
1226
- name: Union[str | None, Any] = Field(default=None)
1227
- phone: Union[str | None, Any] = Field(default=None)
1228
- tax_id: Union[str | None, Any] = Field(default=None)
1298
+ amount_authorized: Union[int | None, Any] = Field(default=None, description="Amount authorized in the presentment currency")
1299
+ """Amount authorized in the presentment currency"""
1300
+ amount_charged: Union[int | None, Any] = Field(default=None, description="Amount charged in the presentment currency")
1301
+ """Amount charged in the presentment currency"""
1302
+ currency: Union[str | None, Any] = Field(default=None, description="Three-letter ISO currency code for presentment")
1303
+ """Three-letter ISO currency code for presentment"""
1229
1304
 
1230
1305
  class ChargeRefunds(BaseModel):
1231
1306
  """A list of refunds that have been applied to the charge"""
@@ -1239,8 +1314,8 @@ class ChargeRefunds(BaseModel):
1239
1314
  url: Union[str, Any] = Field(default=None, description="URL to access the refunds list")
1240
1315
  """URL to access the refunds list"""
1241
1316
 
1242
- class ChargePaymentMethodDetailsCardExtendedAuthorization(BaseModel):
1243
- """Extended authorization details"""
1317
+ class ChargePaymentMethodDetailsCardMulticapture(BaseModel):
1318
+ """Multicapture details"""
1244
1319
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1245
1320
 
1246
1321
  status: Union[str, Any] = Field(default=None)
@@ -1253,31 +1328,31 @@ class ChargePaymentMethodDetailsCardChecks(BaseModel):
1253
1328
  address_postal_code_check: Union[str | None, Any] = Field(default=None)
1254
1329
  cvc_check: Union[str | None, Any] = Field(default=None)
1255
1330
 
1256
- class ChargePaymentMethodDetailsCardNetworkToken(BaseModel):
1257
- """Network token details"""
1258
- model_config = ConfigDict(extra="allow", populate_by_name=True)
1259
-
1260
- used: Union[bool, Any] = Field(default=None)
1261
-
1262
1331
  class ChargePaymentMethodDetailsCardIncrementalAuthorization(BaseModel):
1263
1332
  """Incremental authorization details"""
1264
1333
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1265
1334
 
1266
1335
  status: Union[str, Any] = Field(default=None)
1267
1336
 
1268
- class ChargePaymentMethodDetailsCardMulticapture(BaseModel):
1269
- """Multicapture details"""
1337
+ class ChargePaymentMethodDetailsCardOvercapture(BaseModel):
1338
+ """Overcapture details"""
1270
1339
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1271
1340
 
1341
+ maximum_amount_capturable: Union[int, Any] = Field(default=None)
1272
1342
  status: Union[str, Any] = Field(default=None)
1273
1343
 
1274
- class ChargePaymentMethodDetailsCardOvercapture(BaseModel):
1275
- """Overcapture details"""
1344
+ class ChargePaymentMethodDetailsCardExtendedAuthorization(BaseModel):
1345
+ """Extended authorization details"""
1276
1346
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1277
1347
 
1278
- maximum_amount_capturable: Union[int, Any] = Field(default=None)
1279
1348
  status: Union[str, Any] = Field(default=None)
1280
1349
 
1350
+ class ChargePaymentMethodDetailsCardNetworkToken(BaseModel):
1351
+ """Network token details"""
1352
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
1353
+
1354
+ used: Union[bool, Any] = Field(default=None)
1355
+
1281
1356
  class ChargePaymentMethodDetailsCard(BaseModel):
1282
1357
  """Nested schema for ChargePaymentMethodDetails.card"""
1283
1358
  model_config = ConfigDict(extra="allow", populate_by_name=True)
@@ -1334,17 +1409,6 @@ class ChargePaymentMethodDetails(BaseModel):
1334
1409
  type: Union[str, Any] = Field(default=None)
1335
1410
  card: Union[ChargePaymentMethodDetailsCard | None, Any] = Field(default=None)
1336
1411
 
1337
- class ChargePresentmentDetails(BaseModel):
1338
- """Currency presentation information for multi-currency charges"""
1339
- model_config = ConfigDict(extra="allow", populate_by_name=True)
1340
-
1341
- amount_authorized: Union[int | None, Any] = Field(default=None, description="Amount authorized in the presentment currency")
1342
- """Amount authorized in the presentment currency"""
1343
- amount_charged: Union[int | None, Any] = Field(default=None, description="Amount charged in the presentment currency")
1344
- """Amount charged in the presentment currency"""
1345
- currency: Union[str | None, Any] = Field(default=None, description="Three-letter ISO currency code for presentment")
1346
- """Three-letter ISO currency code for presentment"""
1347
-
1348
1412
  class Charge(BaseModel):
1349
1413
  """Charge type definition"""
1350
1414
  model_config = ConfigDict(extra="allow", populate_by_name=True)
@@ -1418,26 +1482,46 @@ class SubscriptionList(BaseModel):
1418
1482
  has_more: Union[bool, Any] = Field(default=None)
1419
1483
  url: Union[str, Any] = Field(default=None)
1420
1484
 
1421
- class RefundDestinationDetailsBrBankTransfer(BaseModel):
1422
- """If this is a br_bank_transfer refund, this hash contains the transaction specific details"""
1485
+ class RefundNextActionDisplayDetailsEmailSent(BaseModel):
1486
+ """Contains information about the email sent to the customer"""
1423
1487
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1424
1488
 
1425
- reference: Union[str | None, Any] = Field(default=None, description="The reference assigned to the refund")
1426
- """The reference assigned to the refund"""
1427
- reference_status: Union[str | None, Any] = Field(default=None, description="Status of the reference on the refund")
1428
- """Status of the reference on the refund"""
1489
+ email_sent_at: Union[int, Any] = Field(default=None, description="The timestamp when the email was sent")
1490
+ """The timestamp when the email was sent"""
1491
+ email_sent_to: Union[str, Any] = Field(default=None, description="The recipient's email address")
1492
+ """The recipient's email address"""
1429
1493
 
1430
- class RefundDestinationDetailsGbBankTransfer(BaseModel):
1431
- """If this is a gb_bank_transfer refund, this hash contains the transaction specific details"""
1494
+ class RefundNextActionDisplayDetails(BaseModel):
1495
+ """Contains the refund details"""
1496
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
1497
+
1498
+ email_sent: Union[RefundNextActionDisplayDetailsEmailSent, Any] = Field(default=None, description="Contains information about the email sent to the customer")
1499
+ """Contains information about the email sent to the customer"""
1500
+ expires_at: Union[int, Any] = Field(default=None, description="The expiry timestamp")
1501
+ """The expiry timestamp"""
1502
+
1503
+ class RefundNextAction(BaseModel):
1504
+ """If the refund has a status of requires_action, this property describes what the refund needs to continue processing"""
1505
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
1506
+
1507
+ display_details: Union[RefundNextActionDisplayDetails | None, Any] = Field(default=None, description="Contains the refund details")
1508
+ """Contains the refund details"""
1509
+ type: Union[str, Any] = Field(default=None, description="Type of the next action to perform")
1510
+ """Type of the next action to perform"""
1511
+
1512
+ class RefundDestinationDetailsBlik(BaseModel):
1513
+ """If this is a blik refund, this hash contains the transaction specific details"""
1432
1514
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1433
1515
 
1516
+ network_decline_code: Union[str | None, Any] = Field(default=None, description="For refunds declined by the network, a decline code provided by the network")
1517
+ """For refunds declined by the network, a decline code provided by the network"""
1434
1518
  reference: Union[str | None, Any] = Field(default=None, description="The reference assigned to the refund")
1435
1519
  """The reference assigned to the refund"""
1436
1520
  reference_status: Union[str | None, Any] = Field(default=None, description="Status of the reference on the refund")
1437
1521
  """Status of the reference on the refund"""
1438
1522
 
1439
- class RefundDestinationDetailsMxBankTransfer(BaseModel):
1440
- """If this is a mx_bank_transfer refund, this hash contains the transaction specific details"""
1523
+ class RefundDestinationDetailsThBankTransfer(BaseModel):
1524
+ """If this is a th_bank_transfer refund, this hash contains the transaction specific details"""
1441
1525
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1442
1526
 
1443
1527
  reference: Union[str | None, Any] = Field(default=None, description="The reference assigned to the refund")
@@ -1445,18 +1529,12 @@ class RefundDestinationDetailsMxBankTransfer(BaseModel):
1445
1529
  reference_status: Union[str | None, Any] = Field(default=None, description="Status of the reference on the refund")
1446
1530
  """Status of the reference on the refund"""
1447
1531
 
1448
- class RefundDestinationDetailsCard(BaseModel):
1449
- """If this is a card refund, this hash contains the transaction specific details"""
1532
+ class RefundDestinationDetailsCrypto(BaseModel):
1533
+ """If this is a crypto refund, this hash contains the transaction specific details"""
1450
1534
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1451
1535
 
1452
- reference: Union[str | None, Any] = Field(default=None, description="Value of the reference number assigned to the refund")
1453
- """Value of the reference number assigned to the refund"""
1454
- reference_status: Union[str | None, Any] = Field(default=None, description="Status of the reference number on the refund")
1455
- """Status of the reference number on the refund"""
1456
- reference_type: Union[str | None, Any] = Field(default=None, description="Type of the reference number assigned to the refund")
1457
- """Type of the reference number assigned to the refund"""
1458
- type: Union[str, Any] = Field(default=None, description="The type of refund")
1459
- """The type of refund"""
1536
+ reference: Union[str | None, Any] = Field(default=None, description="The transaction hash of the refund")
1537
+ """The transaction hash of the refund"""
1460
1538
 
1461
1539
  class RefundDestinationDetailsSwish(BaseModel):
1462
1540
  """If this is a swish refund, this hash contains the transaction specific details"""
@@ -1469,8 +1547,8 @@ class RefundDestinationDetailsSwish(BaseModel):
1469
1547
  reference_status: Union[str | None, Any] = Field(default=None, description="Status of the reference on the refund")
1470
1548
  """Status of the reference on the refund"""
1471
1549
 
1472
- class RefundDestinationDetailsJpBankTransfer(BaseModel):
1473
- """If this is a jp_bank_transfer refund, this hash contains the transaction specific details"""
1550
+ class RefundDestinationDetailsMxBankTransfer(BaseModel):
1551
+ """If this is a mx_bank_transfer refund, this hash contains the transaction specific details"""
1474
1552
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1475
1553
 
1476
1554
  reference: Union[str | None, Any] = Field(default=None, description="The reference assigned to the refund")
@@ -1478,19 +1556,46 @@ class RefundDestinationDetailsJpBankTransfer(BaseModel):
1478
1556
  reference_status: Union[str | None, Any] = Field(default=None, description="Status of the reference on the refund")
1479
1557
  """Status of the reference on the refund"""
1480
1558
 
1481
- class RefundDestinationDetailsBlik(BaseModel):
1482
- """If this is a blik refund, this hash contains the transaction specific details"""
1559
+ class RefundDestinationDetailsPaypal(BaseModel):
1560
+ """If this is a paypal refund, this hash contains the transaction specific details"""
1561
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
1562
+
1563
+ network_decline_code: Union[str | None, Any] = Field(default=None, description="For refunds declined by the network, a decline code provided by the network")
1564
+ """For refunds declined by the network, a decline code provided by the network"""
1565
+
1566
+ class RefundDestinationDetailsGbBankTransfer(BaseModel):
1567
+ """If this is a gb_bank_transfer refund, this hash contains the transaction specific details"""
1568
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
1569
+
1570
+ reference: Union[str | None, Any] = Field(default=None, description="The reference assigned to the refund")
1571
+ """The reference assigned to the refund"""
1572
+ reference_status: Union[str | None, Any] = Field(default=None, description="Status of the reference on the refund")
1573
+ """Status of the reference on the refund"""
1574
+
1575
+ class RefundDestinationDetailsCard(BaseModel):
1576
+ """If this is a card refund, this hash contains the transaction specific details"""
1577
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
1578
+
1579
+ reference: Union[str | None, Any] = Field(default=None, description="Value of the reference number assigned to the refund")
1580
+ """Value of the reference number assigned to the refund"""
1581
+ reference_status: Union[str | None, Any] = Field(default=None, description="Status of the reference number on the refund")
1582
+ """Status of the reference number on the refund"""
1583
+ reference_type: Union[str | None, Any] = Field(default=None, description="Type of the reference number assigned to the refund")
1584
+ """Type of the reference number assigned to the refund"""
1585
+ type: Union[str, Any] = Field(default=None, description="The type of refund")
1586
+ """The type of refund"""
1587
+
1588
+ class RefundDestinationDetailsEuBankTransfer(BaseModel):
1589
+ """If this is a eu_bank_transfer refund, this hash contains the transaction specific details"""
1483
1590
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1484
1591
 
1485
- network_decline_code: Union[str | None, Any] = Field(default=None, description="For refunds declined by the network, a decline code provided by the network")
1486
- """For refunds declined by the network, a decline code provided by the network"""
1487
1592
  reference: Union[str | None, Any] = Field(default=None, description="The reference assigned to the refund")
1488
1593
  """The reference assigned to the refund"""
1489
1594
  reference_status: Union[str | None, Any] = Field(default=None, description="Status of the reference on the refund")
1490
1595
  """Status of the reference on the refund"""
1491
1596
 
1492
- class RefundDestinationDetailsMultibanco(BaseModel):
1493
- """If this is a multibanco refund, this hash contains the transaction specific details"""
1597
+ class RefundDestinationDetailsMbWay(BaseModel):
1598
+ """If this is a mb_way refund, this hash contains the transaction specific details"""
1494
1599
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1495
1600
 
1496
1601
  reference: Union[str | None, Any] = Field(default=None, description="The reference assigned to the refund")
@@ -1498,8 +1603,8 @@ class RefundDestinationDetailsMultibanco(BaseModel):
1498
1603
  reference_status: Union[str | None, Any] = Field(default=None, description="Status of the reference on the refund")
1499
1604
  """Status of the reference on the refund"""
1500
1605
 
1501
- class RefundDestinationDetailsEuBankTransfer(BaseModel):
1502
- """If this is a eu_bank_transfer refund, this hash contains the transaction specific details"""
1606
+ class RefundDestinationDetailsUsBankTransfer(BaseModel):
1607
+ """If this is a us_bank_transfer refund, this hash contains the transaction specific details"""
1503
1608
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1504
1609
 
1505
1610
  reference: Union[str | None, Any] = Field(default=None, description="The reference assigned to the refund")
@@ -1507,13 +1612,6 @@ class RefundDestinationDetailsEuBankTransfer(BaseModel):
1507
1612
  reference_status: Union[str | None, Any] = Field(default=None, description="Status of the reference on the refund")
1508
1613
  """Status of the reference on the refund"""
1509
1614
 
1510
- class RefundDestinationDetailsCrypto(BaseModel):
1511
- """If this is a crypto refund, this hash contains the transaction specific details"""
1512
- model_config = ConfigDict(extra="allow", populate_by_name=True)
1513
-
1514
- reference: Union[str | None, Any] = Field(default=None, description="The transaction hash of the refund")
1515
- """The transaction hash of the refund"""
1516
-
1517
1615
  class RefundDestinationDetailsP24(BaseModel):
1518
1616
  """If this is a p24 refund, this hash contains the transaction specific details"""
1519
1617
  model_config = ConfigDict(extra="allow", populate_by_name=True)
@@ -1523,8 +1621,8 @@ class RefundDestinationDetailsP24(BaseModel):
1523
1621
  reference_status: Union[str | None, Any] = Field(default=None, description="Status of the reference on the refund")
1524
1622
  """Status of the reference on the refund"""
1525
1623
 
1526
- class RefundDestinationDetailsMbWay(BaseModel):
1527
- """If this is a mb_way refund, this hash contains the transaction specific details"""
1624
+ class RefundDestinationDetailsJpBankTransfer(BaseModel):
1625
+ """If this is a jp_bank_transfer refund, this hash contains the transaction specific details"""
1528
1626
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1529
1627
 
1530
1628
  reference: Union[str | None, Any] = Field(default=None, description="The reference assigned to the refund")
@@ -1532,15 +1630,8 @@ class RefundDestinationDetailsMbWay(BaseModel):
1532
1630
  reference_status: Union[str | None, Any] = Field(default=None, description="Status of the reference on the refund")
1533
1631
  """Status of the reference on the refund"""
1534
1632
 
1535
- class RefundDestinationDetailsPaypal(BaseModel):
1536
- """If this is a paypal refund, this hash contains the transaction specific details"""
1537
- model_config = ConfigDict(extra="allow", populate_by_name=True)
1538
-
1539
- network_decline_code: Union[str | None, Any] = Field(default=None, description="For refunds declined by the network, a decline code provided by the network")
1540
- """For refunds declined by the network, a decline code provided by the network"""
1541
-
1542
- class RefundDestinationDetailsUsBankTransfer(BaseModel):
1543
- """If this is a us_bank_transfer refund, this hash contains the transaction specific details"""
1633
+ class RefundDestinationDetailsBrBankTransfer(BaseModel):
1634
+ """If this is a br_bank_transfer refund, this hash contains the transaction specific details"""
1544
1635
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1545
1636
 
1546
1637
  reference: Union[str | None, Any] = Field(default=None, description="The reference assigned to the refund")
@@ -1548,8 +1639,8 @@ class RefundDestinationDetailsUsBankTransfer(BaseModel):
1548
1639
  reference_status: Union[str | None, Any] = Field(default=None, description="Status of the reference on the refund")
1549
1640
  """Status of the reference on the refund"""
1550
1641
 
1551
- class RefundDestinationDetailsThBankTransfer(BaseModel):
1552
- """If this is a th_bank_transfer refund, this hash contains the transaction specific details"""
1642
+ class RefundDestinationDetailsMultibanco(BaseModel):
1643
+ """If this is a multibanco refund, this hash contains the transaction specific details"""
1553
1644
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1554
1645
 
1555
1646
  reference: Union[str | None, Any] = Field(default=None, description="The reference assigned to the refund")
@@ -1634,33 +1725,6 @@ class RefundDestinationDetails(BaseModel):
1634
1725
  zip: Union[dict[str, Any] | None, Any] = Field(default=None, description="If this is a zip refund, this hash contains the transaction specific details")
1635
1726
  """If this is a zip refund, this hash contains the transaction specific details"""
1636
1727
 
1637
- class RefundNextActionDisplayDetailsEmailSent(BaseModel):
1638
- """Contains information about the email sent to the customer"""
1639
- model_config = ConfigDict(extra="allow", populate_by_name=True)
1640
-
1641
- email_sent_at: Union[int, Any] = Field(default=None, description="The timestamp when the email was sent")
1642
- """The timestamp when the email was sent"""
1643
- email_sent_to: Union[str, Any] = Field(default=None, description="The recipient's email address")
1644
- """The recipient's email address"""
1645
-
1646
- class RefundNextActionDisplayDetails(BaseModel):
1647
- """Contains the refund details"""
1648
- model_config = ConfigDict(extra="allow", populate_by_name=True)
1649
-
1650
- email_sent: Union[RefundNextActionDisplayDetailsEmailSent, Any] = Field(default=None, description="Contains information about the email sent to the customer")
1651
- """Contains information about the email sent to the customer"""
1652
- expires_at: Union[int, Any] = Field(default=None, description="The expiry timestamp")
1653
- """The expiry timestamp"""
1654
-
1655
- class RefundNextAction(BaseModel):
1656
- """If the refund has a status of requires_action, this property describes what the refund needs to continue processing"""
1657
- model_config = ConfigDict(extra="allow", populate_by_name=True)
1658
-
1659
- display_details: Union[RefundNextActionDisplayDetails | None, Any] = Field(default=None, description="Contains the refund details")
1660
- """Contains the refund details"""
1661
- type: Union[str, Any] = Field(default=None, description="Type of the next action to perform")
1662
- """Type of the next action to perform"""
1663
-
1664
1728
  class Refund(BaseModel):
1665
1729
  """Refund type definition"""
1666
1730
  model_config = ConfigDict(extra="allow", populate_by_name=True)
@@ -1697,12 +1761,17 @@ class RefundList(BaseModel):
1697
1761
  has_more: Union[bool, Any] = Field(default=None)
1698
1762
  url: Union[str, Any] = Field(default=None)
1699
1763
 
1700
- class ProductMarketingFeaturesItem(BaseModel):
1701
- """Nested schema for Product.marketing_features_item"""
1764
+ class RefundCreateParams(BaseModel):
1765
+ """RefundCreateParams type definition"""
1702
1766
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1703
1767
 
1704
- name: Union[str | None, Any] = Field(default=None, description="The marketing feature name. Up to 80 characters long")
1705
- """The marketing feature name. Up to 80 characters long"""
1768
+ charge: Union[str, Any] = Field(default=None)
1769
+ payment_intent: Union[str, Any] = Field(default=None)
1770
+ amount: Union[int, Any] = Field(default=None)
1771
+ metadata: Union[dict[str, str], Any] = Field(default=None)
1772
+ reason: Union[str, Any] = Field(default=None)
1773
+ refund_application_fee: Union[bool, Any] = Field(default=None)
1774
+ reverse_transfer: Union[bool, Any] = Field(default=None)
1706
1775
 
1707
1776
  class ProductPackageDimensions(BaseModel):
1708
1777
  """The dimensions of this product for shipping purposes"""
@@ -1717,6 +1786,13 @@ class ProductPackageDimensions(BaseModel):
1717
1786
  width: Union[float, Any] = Field(default=None, description="Width, in inches")
1718
1787
  """Width, in inches"""
1719
1788
 
1789
+ class ProductMarketingFeaturesItem(BaseModel):
1790
+ """Nested schema for Product.marketing_features_item"""
1791
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
1792
+
1793
+ name: Union[str | None, Any] = Field(default=None, description="The marketing feature name. Up to 80 characters long")
1794
+ """The marketing feature name. Up to 80 characters long"""
1795
+
1720
1796
  class ProductFeaturesItem(BaseModel):
1721
1797
  """Nested schema for Product.features_item"""
1722
1798
  model_config = ConfigDict(extra="allow", populate_by_name=True)
@@ -1769,7 +1845,91 @@ class ProductSearchResult(BaseModel):
1769
1845
  next_page: Union[str | None, Any] = Field(default=None)
1770
1846
  url: Union[str, Any] = Field(default=None)
1771
1847
 
1772
- class BalanceConnectReservedItemSourceTypes(BaseModel):
1848
+ class ProductCreateParamsPackageDimensions(BaseModel):
1849
+ """The dimensions of this product for shipping purposes"""
1850
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
1851
+
1852
+ height: Union[float, Any] = Field(default=None, description="Height, in inches")
1853
+ """Height, in inches"""
1854
+ length: Union[float, Any] = Field(default=None, description="Length, in inches")
1855
+ """Length, in inches"""
1856
+ weight: Union[float, Any] = Field(default=None, description="Weight, in ounces")
1857
+ """Weight, in ounces"""
1858
+ width: Union[float, Any] = Field(default=None, description="Width, in inches")
1859
+ """Width, in inches"""
1860
+
1861
+ class ProductCreateParamsMarketingFeaturesItem(BaseModel):
1862
+ """Nested schema for ProductCreateParams.marketing_features_item"""
1863
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
1864
+
1865
+ name: Union[str, Any] = Field(default=None, description="The marketing feature name. Up to 80 characters long")
1866
+ """The marketing feature name. Up to 80 characters long"""
1867
+
1868
+ class ProductCreateParams(BaseModel):
1869
+ """ProductCreateParams type definition"""
1870
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
1871
+
1872
+ name: Union[str, Any] = Field(default=None)
1873
+ active: Union[bool, Any] = Field(default=None)
1874
+ description: Union[str, Any] = Field(default=None)
1875
+ id: Union[str, Any] = Field(default=None)
1876
+ images: Union[list[str], Any] = Field(default=None)
1877
+ marketing_features: Union[list[ProductCreateParamsMarketingFeaturesItem], Any] = Field(default=None)
1878
+ metadata: Union[dict[str, str], Any] = Field(default=None)
1879
+ package_dimensions: Union[ProductCreateParamsPackageDimensions, Any] = Field(default=None)
1880
+ shippable: Union[bool, Any] = Field(default=None)
1881
+ statement_descriptor: Union[str, Any] = Field(default=None)
1882
+ tax_code: Union[str, Any] = Field(default=None)
1883
+ unit_label: Union[str, Any] = Field(default=None)
1884
+ url: Union[str, Any] = Field(default=None)
1885
+
1886
+ class ProductUpdateParamsMarketingFeaturesItem(BaseModel):
1887
+ """Nested schema for ProductUpdateParams.marketing_features_item"""
1888
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
1889
+
1890
+ name: Union[str, Any] = Field(default=None, description="The marketing feature name. Up to 80 characters long")
1891
+ """The marketing feature name. Up to 80 characters long"""
1892
+
1893
+ class ProductUpdateParamsPackageDimensions(BaseModel):
1894
+ """The dimensions of this product for shipping purposes"""
1895
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
1896
+
1897
+ height: Union[float, Any] = Field(default=None, description="Height, in inches")
1898
+ """Height, in inches"""
1899
+ length: Union[float, Any] = Field(default=None, description="Length, in inches")
1900
+ """Length, in inches"""
1901
+ weight: Union[float, Any] = Field(default=None, description="Weight, in ounces")
1902
+ """Weight, in ounces"""
1903
+ width: Union[float, Any] = Field(default=None, description="Width, in inches")
1904
+ """Width, in inches"""
1905
+
1906
+ class ProductUpdateParams(BaseModel):
1907
+ """ProductUpdateParams type definition"""
1908
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
1909
+
1910
+ active: Union[bool, Any] = Field(default=None)
1911
+ name: Union[str, Any] = Field(default=None)
1912
+ description: Union[str, Any] = Field(default=None)
1913
+ default_price: Union[str, Any] = Field(default=None)
1914
+ images: Union[list[str], Any] = Field(default=None)
1915
+ marketing_features: Union[list[ProductUpdateParamsMarketingFeaturesItem], Any] = Field(default=None)
1916
+ metadata: Union[dict[str, str], Any] = Field(default=None)
1917
+ package_dimensions: Union[ProductUpdateParamsPackageDimensions, Any] = Field(default=None)
1918
+ shippable: Union[bool, Any] = Field(default=None)
1919
+ statement_descriptor: Union[str, Any] = Field(default=None)
1920
+ tax_code: Union[str, Any] = Field(default=None)
1921
+ unit_label: Union[str, Any] = Field(default=None)
1922
+ url: Union[str, Any] = Field(default=None)
1923
+
1924
+ class ProductDeletedResponse(BaseModel):
1925
+ """ProductDeletedResponse type definition"""
1926
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
1927
+
1928
+ id: Union[str, Any] = Field(default=None)
1929
+ object: Union[str, Any] = Field(default=None)
1930
+ deleted: Union[bool, Any] = Field(default=None)
1931
+
1932
+ class BalanceAvailableItemSourceTypes(BaseModel):
1773
1933
  """Breakdown of balance by source types"""
1774
1934
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1775
1935
 
@@ -1780,18 +1940,18 @@ class BalanceConnectReservedItemSourceTypes(BaseModel):
1780
1940
  fpx: Union[int | None, Any] = Field(default=None, description="Amount for fpx")
1781
1941
  """Amount for fpx"""
1782
1942
 
1783
- class BalanceConnectReservedItem(BaseModel):
1784
- """Nested schema for Balance.connect_reserved_item"""
1943
+ class BalanceAvailableItem(BaseModel):
1944
+ """Nested schema for Balance.available_item"""
1785
1945
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1786
1946
 
1787
- amount: Union[int, Any] = Field(default=None, description="Balance amount in the smallest currency unit")
1788
- """Balance amount in the smallest currency unit"""
1947
+ amount: Union[int, Any] = Field(default=None, description="Balance amount in the smallest currency unit (e.g., cents)")
1948
+ """Balance amount in the smallest currency unit (e.g., cents)"""
1789
1949
  currency: Union[str, Any] = Field(default=None, description="Three-letter ISO currency code, in lowercase")
1790
1950
  """Three-letter ISO currency code, in lowercase"""
1791
- source_types: Union[BalanceConnectReservedItemSourceTypes | None, Any] = Field(default=None, description="Breakdown of balance by source types")
1951
+ source_types: Union[BalanceAvailableItemSourceTypes | None, Any] = Field(default=None, description="Breakdown of balance by source types")
1792
1952
  """Breakdown of balance by source types"""
1793
1953
 
1794
- class BalanceAvailableItemSourceTypes(BaseModel):
1954
+ class BalanceInstantAvailableItemNetAvailableItemSourceTypes(BaseModel):
1795
1955
  """Breakdown of balance by source types"""
1796
1956
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1797
1957
 
@@ -1802,18 +1962,18 @@ class BalanceAvailableItemSourceTypes(BaseModel):
1802
1962
  fpx: Union[int | None, Any] = Field(default=None, description="Amount for fpx")
1803
1963
  """Amount for fpx"""
1804
1964
 
1805
- class BalanceAvailableItem(BaseModel):
1806
- """Nested schema for Balance.available_item"""
1965
+ class BalanceInstantAvailableItemNetAvailableItem(BaseModel):
1966
+ """Nested schema for BalanceInstantAvailableItem.net_available_item"""
1807
1967
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1808
1968
 
1809
- amount: Union[int, Any] = Field(default=None, description="Balance amount in the smallest currency unit (e.g., cents)")
1810
- """Balance amount in the smallest currency unit (e.g., cents)"""
1811
- currency: Union[str, Any] = Field(default=None, description="Three-letter ISO currency code, in lowercase")
1812
- """Three-letter ISO currency code, in lowercase"""
1813
- source_types: Union[BalanceAvailableItemSourceTypes | None, Any] = Field(default=None, description="Breakdown of balance by source types")
1969
+ amount: Union[int, Any] = Field(default=None, description="Net balance amount")
1970
+ """Net balance amount"""
1971
+ destination: Union[str, Any] = Field(default=None, description="ID of the external account")
1972
+ """ID of the external account"""
1973
+ source_types: Union[BalanceInstantAvailableItemNetAvailableItemSourceTypes | None, Any] = Field(default=None, description="Breakdown of balance by source types")
1814
1974
  """Breakdown of balance by source types"""
1815
1975
 
1816
- class BalanceRefundAndDisputePrefundingPendingItemSourceTypes(BaseModel):
1976
+ class BalanceInstantAvailableItemSourceTypes(BaseModel):
1817
1977
  """Breakdown of balance by source types"""
1818
1978
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1819
1979
 
@@ -1824,18 +1984,20 @@ class BalanceRefundAndDisputePrefundingPendingItemSourceTypes(BaseModel):
1824
1984
  fpx: Union[int | None, Any] = Field(default=None, description="Amount for fpx")
1825
1985
  """Amount for fpx"""
1826
1986
 
1827
- class BalanceRefundAndDisputePrefundingPendingItem(BaseModel):
1828
- """Nested schema for BalanceRefundAndDisputePrefunding.pending_item"""
1987
+ class BalanceInstantAvailableItem(BaseModel):
1988
+ """Nested schema for Balance.instant_available_item"""
1829
1989
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1830
1990
 
1831
- amount: Union[int, Any] = Field(default=None, description="Balance amount")
1832
- """Balance amount"""
1833
- currency: Union[str, Any] = Field(default=None, description="Three-letter ISO currency code")
1834
- """Three-letter ISO currency code"""
1835
- source_types: Union[BalanceRefundAndDisputePrefundingPendingItemSourceTypes | None, Any] = Field(default=None, description="Breakdown of balance by source types")
1991
+ amount: Union[int, Any] = Field(default=None, description="Balance amount in the smallest currency unit")
1992
+ """Balance amount in the smallest currency unit"""
1993
+ currency: Union[str, Any] = Field(default=None, description="Three-letter ISO currency code, in lowercase")
1994
+ """Three-letter ISO currency code, in lowercase"""
1995
+ source_types: Union[BalanceInstantAvailableItemSourceTypes | None, Any] = Field(default=None, description="Breakdown of balance by source types")
1836
1996
  """Breakdown of balance by source types"""
1997
+ net_available: Union[list[BalanceInstantAvailableItemNetAvailableItem] | None, Any] = Field(default=None, description="Net balance amount available after deducting fees")
1998
+ """Net balance amount available after deducting fees"""
1837
1999
 
1838
- class BalanceRefundAndDisputePrefundingAvailableItemSourceTypes(BaseModel):
2000
+ class BalanceIssuingAvailableItemSourceTypes(BaseModel):
1839
2001
  """Breakdown of balance by source types"""
1840
2002
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1841
2003
 
@@ -1846,27 +2008,25 @@ class BalanceRefundAndDisputePrefundingAvailableItemSourceTypes(BaseModel):
1846
2008
  fpx: Union[int | None, Any] = Field(default=None, description="Amount for fpx")
1847
2009
  """Amount for fpx"""
1848
2010
 
1849
- class BalanceRefundAndDisputePrefundingAvailableItem(BaseModel):
1850
- """Nested schema for BalanceRefundAndDisputePrefunding.available_item"""
2011
+ class BalanceIssuingAvailableItem(BaseModel):
2012
+ """Nested schema for BalanceIssuing.available_item"""
1851
2013
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1852
2014
 
1853
2015
  amount: Union[int, Any] = Field(default=None, description="Balance amount")
1854
2016
  """Balance amount"""
1855
2017
  currency: Union[str, Any] = Field(default=None, description="Three-letter ISO currency code")
1856
2018
  """Three-letter ISO currency code"""
1857
- source_types: Union[BalanceRefundAndDisputePrefundingAvailableItemSourceTypes | None, Any] = Field(default=None, description="Breakdown of balance by source types")
2019
+ source_types: Union[BalanceIssuingAvailableItemSourceTypes | None, Any] = Field(default=None, description="Breakdown of balance by source types")
1858
2020
  """Breakdown of balance by source types"""
1859
2021
 
1860
- class BalanceRefundAndDisputePrefunding(BaseModel):
1861
- """Funds reserved for covering future refunds or disputes"""
2022
+ class BalanceIssuing(BaseModel):
2023
+ """Funds that are available for use with Issuing cards"""
1862
2024
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1863
2025
 
1864
- available: Union[list[BalanceRefundAndDisputePrefundingAvailableItem], Any] = Field(default=None, description="Available funds for refunds and disputes")
1865
- """Available funds for refunds and disputes"""
1866
- pending: Union[list[BalanceRefundAndDisputePrefundingPendingItem], Any] = Field(default=None, description="Pending funds for refunds and disputes")
1867
- """Pending funds for refunds and disputes"""
2026
+ available: Union[list[BalanceIssuingAvailableItem], Any] = Field(default=None, description="Funds available for issuing")
2027
+ """Funds available for issuing"""
1868
2028
 
1869
- class BalancePendingItemSourceTypes(BaseModel):
2029
+ class BalanceRefundAndDisputePrefundingAvailableItemSourceTypes(BaseModel):
1870
2030
  """Breakdown of balance by source types"""
1871
2031
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1872
2032
 
@@ -1877,18 +2037,18 @@ class BalancePendingItemSourceTypes(BaseModel):
1877
2037
  fpx: Union[int | None, Any] = Field(default=None, description="Amount for fpx")
1878
2038
  """Amount for fpx"""
1879
2039
 
1880
- class BalancePendingItem(BaseModel):
1881
- """Nested schema for Balance.pending_item"""
2040
+ class BalanceRefundAndDisputePrefundingAvailableItem(BaseModel):
2041
+ """Nested schema for BalanceRefundAndDisputePrefunding.available_item"""
1882
2042
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1883
2043
 
1884
- amount: Union[int, Any] = Field(default=None, description="Balance amount in the smallest currency unit")
1885
- """Balance amount in the smallest currency unit"""
1886
- currency: Union[str, Any] = Field(default=None, description="Three-letter ISO currency code, in lowercase")
1887
- """Three-letter ISO currency code, in lowercase"""
1888
- source_types: Union[BalancePendingItemSourceTypes | None, Any] = Field(default=None, description="Breakdown of balance by source types")
2044
+ amount: Union[int, Any] = Field(default=None, description="Balance amount")
2045
+ """Balance amount"""
2046
+ currency: Union[str, Any] = Field(default=None, description="Three-letter ISO currency code")
2047
+ """Three-letter ISO currency code"""
2048
+ source_types: Union[BalanceRefundAndDisputePrefundingAvailableItemSourceTypes | None, Any] = Field(default=None, description="Breakdown of balance by source types")
1889
2049
  """Breakdown of balance by source types"""
1890
2050
 
1891
- class BalanceIssuingAvailableItemSourceTypes(BaseModel):
2051
+ class BalanceRefundAndDisputePrefundingPendingItemSourceTypes(BaseModel):
1892
2052
  """Breakdown of balance by source types"""
1893
2053
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1894
2054
 
@@ -1899,25 +2059,27 @@ class BalanceIssuingAvailableItemSourceTypes(BaseModel):
1899
2059
  fpx: Union[int | None, Any] = Field(default=None, description="Amount for fpx")
1900
2060
  """Amount for fpx"""
1901
2061
 
1902
- class BalanceIssuingAvailableItem(BaseModel):
1903
- """Nested schema for BalanceIssuing.available_item"""
2062
+ class BalanceRefundAndDisputePrefundingPendingItem(BaseModel):
2063
+ """Nested schema for BalanceRefundAndDisputePrefunding.pending_item"""
1904
2064
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1905
2065
 
1906
2066
  amount: Union[int, Any] = Field(default=None, description="Balance amount")
1907
2067
  """Balance amount"""
1908
2068
  currency: Union[str, Any] = Field(default=None, description="Three-letter ISO currency code")
1909
2069
  """Three-letter ISO currency code"""
1910
- source_types: Union[BalanceIssuingAvailableItemSourceTypes | None, Any] = Field(default=None, description="Breakdown of balance by source types")
2070
+ source_types: Union[BalanceRefundAndDisputePrefundingPendingItemSourceTypes | None, Any] = Field(default=None, description="Breakdown of balance by source types")
1911
2071
  """Breakdown of balance by source types"""
1912
2072
 
1913
- class BalanceIssuing(BaseModel):
1914
- """Funds that are available for use with Issuing cards"""
2073
+ class BalanceRefundAndDisputePrefunding(BaseModel):
2074
+ """Funds reserved for covering future refunds or disputes"""
1915
2075
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1916
2076
 
1917
- available: Union[list[BalanceIssuingAvailableItem], Any] = Field(default=None, description="Funds available for issuing")
1918
- """Funds available for issuing"""
2077
+ available: Union[list[BalanceRefundAndDisputePrefundingAvailableItem], Any] = Field(default=None, description="Available funds for refunds and disputes")
2078
+ """Available funds for refunds and disputes"""
2079
+ pending: Union[list[BalanceRefundAndDisputePrefundingPendingItem], Any] = Field(default=None, description="Pending funds for refunds and disputes")
2080
+ """Pending funds for refunds and disputes"""
1919
2081
 
1920
- class BalanceInstantAvailableItemNetAvailableItemSourceTypes(BaseModel):
2082
+ class BalanceConnectReservedItemSourceTypes(BaseModel):
1921
2083
  """Breakdown of balance by source types"""
1922
2084
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1923
2085
 
@@ -1928,18 +2090,18 @@ class BalanceInstantAvailableItemNetAvailableItemSourceTypes(BaseModel):
1928
2090
  fpx: Union[int | None, Any] = Field(default=None, description="Amount for fpx")
1929
2091
  """Amount for fpx"""
1930
2092
 
1931
- class BalanceInstantAvailableItemNetAvailableItem(BaseModel):
1932
- """Nested schema for BalanceInstantAvailableItem.net_available_item"""
2093
+ class BalanceConnectReservedItem(BaseModel):
2094
+ """Nested schema for Balance.connect_reserved_item"""
1933
2095
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1934
2096
 
1935
- amount: Union[int, Any] = Field(default=None, description="Net balance amount")
1936
- """Net balance amount"""
1937
- destination: Union[str, Any] = Field(default=None, description="ID of the external account")
1938
- """ID of the external account"""
1939
- source_types: Union[BalanceInstantAvailableItemNetAvailableItemSourceTypes | None, Any] = Field(default=None, description="Breakdown of balance by source types")
2097
+ amount: Union[int, Any] = Field(default=None, description="Balance amount in the smallest currency unit")
2098
+ """Balance amount in the smallest currency unit"""
2099
+ currency: Union[str, Any] = Field(default=None, description="Three-letter ISO currency code, in lowercase")
2100
+ """Three-letter ISO currency code, in lowercase"""
2101
+ source_types: Union[BalanceConnectReservedItemSourceTypes | None, Any] = Field(default=None, description="Breakdown of balance by source types")
1940
2102
  """Breakdown of balance by source types"""
1941
2103
 
1942
- class BalanceInstantAvailableItemSourceTypes(BaseModel):
2104
+ class BalancePendingItemSourceTypes(BaseModel):
1943
2105
  """Breakdown of balance by source types"""
1944
2106
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1945
2107
 
@@ -1950,18 +2112,16 @@ class BalanceInstantAvailableItemSourceTypes(BaseModel):
1950
2112
  fpx: Union[int | None, Any] = Field(default=None, description="Amount for fpx")
1951
2113
  """Amount for fpx"""
1952
2114
 
1953
- class BalanceInstantAvailableItem(BaseModel):
1954
- """Nested schema for Balance.instant_available_item"""
2115
+ class BalancePendingItem(BaseModel):
2116
+ """Nested schema for Balance.pending_item"""
1955
2117
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1956
2118
 
1957
2119
  amount: Union[int, Any] = Field(default=None, description="Balance amount in the smallest currency unit")
1958
2120
  """Balance amount in the smallest currency unit"""
1959
2121
  currency: Union[str, Any] = Field(default=None, description="Three-letter ISO currency code, in lowercase")
1960
2122
  """Three-letter ISO currency code, in lowercase"""
1961
- source_types: Union[BalanceInstantAvailableItemSourceTypes | None, Any] = Field(default=None, description="Breakdown of balance by source types")
2123
+ source_types: Union[BalancePendingItemSourceTypes | None, Any] = Field(default=None, description="Breakdown of balance by source types")
1962
2124
  """Breakdown of balance by source types"""
1963
- net_available: Union[list[BalanceInstantAvailableItemNetAvailableItem] | None, Any] = Field(default=None, description="Net balance amount available after deducting fees")
1964
- """Net balance amount available after deducting fees"""
1965
2125
 
1966
2126
  class Balance(BaseModel):
1967
2127
  """Balance type definition"""
@@ -2208,8 +2368,8 @@ class CustomersListResultMeta(BaseModel):
2208
2368
 
2209
2369
  has_more: Union[bool, Any] = Field(default=None)
2210
2370
 
2211
- class CustomersSearchResultMeta(BaseModel):
2212
- """Metadata for customers.search operation"""
2371
+ class CustomersApiSearchResultMeta(BaseModel):
2372
+ """Metadata for customers.api_search operation"""
2213
2373
  model_config = ConfigDict(extra="allow", populate_by_name=True)
2214
2374
 
2215
2375
  has_more: Union[bool, Any] = Field(default=None)
@@ -2244,8 +2404,8 @@ class ProductsListResultMeta(BaseModel):
2244
2404
 
2245
2405
  has_more: Union[bool, Any] = Field(default=None)
2246
2406
 
2247
- class ProductsSearchResultMeta(BaseModel):
2248
- """Metadata for products.search operation"""
2407
+ class ProductsApiSearchResultMeta(BaseModel):
2408
+ """Metadata for products.api_search operation"""
2249
2409
  model_config = ConfigDict(extra="allow", populate_by_name=True)
2250
2410
 
2251
2411
  has_more: Union[bool, Any] = Field(default=None)
@@ -2262,8 +2422,8 @@ class PaymentIntentsListResultMeta(BaseModel):
2262
2422
 
2263
2423
  has_more: Union[bool, Any] = Field(default=None)
2264
2424
 
2265
- class PaymentIntentsSearchResultMeta(BaseModel):
2266
- """Metadata for payment_intents.search operation"""
2425
+ class PaymentIntentsApiSearchResultMeta(BaseModel):
2426
+ """Metadata for payment_intents.api_search operation"""
2267
2427
  model_config = ConfigDict(extra="allow", populate_by_name=True)
2268
2428
 
2269
2429
  has_more: Union[bool, Any] = Field(default=None)
@@ -2315,8 +2475,8 @@ class StripeExecuteResultWithMeta(StripeExecuteResult[T], Generic[T, S]):
2315
2475
  CustomersListResult = StripeExecuteResultWithMeta[list[Customer], CustomersListResultMeta]
2316
2476
  """Result type for customers.list operation with data and metadata."""
2317
2477
 
2318
- CustomersSearchResult = StripeExecuteResultWithMeta[list[Customer], CustomersSearchResultMeta]
2319
- """Result type for customers.search operation with data and metadata."""
2478
+ CustomersApiSearchResult = StripeExecuteResultWithMeta[list[Customer], CustomersApiSearchResultMeta]
2479
+ """Result type for customers.api_search operation with data and metadata."""
2320
2480
 
2321
2481
  InvoicesListResult = StripeExecuteResultWithMeta[list[Invoice], InvoicesListResultMeta]
2322
2482
  """Result type for invoices.list operation with data and metadata."""
@@ -2333,8 +2493,8 @@ RefundsListResult = StripeExecuteResultWithMeta[list[Refund], RefundsListResultM
2333
2493
  ProductsListResult = StripeExecuteResultWithMeta[list[Product], ProductsListResultMeta]
2334
2494
  """Result type for products.list operation with data and metadata."""
2335
2495
 
2336
- ProductsSearchResult = StripeExecuteResultWithMeta[list[Product], ProductsSearchResultMeta]
2337
- """Result type for products.search operation with data and metadata."""
2496
+ ProductsApiSearchResult = StripeExecuteResultWithMeta[list[Product], ProductsApiSearchResultMeta]
2497
+ """Result type for products.api_search operation with data and metadata."""
2338
2498
 
2339
2499
  BalanceTransactionsListResult = StripeExecuteResultWithMeta[list[BalanceTransaction], BalanceTransactionsListResultMeta]
2340
2500
  """Result type for balance_transactions.list operation with data and metadata."""
@@ -2342,8 +2502,8 @@ BalanceTransactionsListResult = StripeExecuteResultWithMeta[list[BalanceTransact
2342
2502
  PaymentIntentsListResult = StripeExecuteResultWithMeta[list[PaymentIntent], PaymentIntentsListResultMeta]
2343
2503
  """Result type for payment_intents.list operation with data and metadata."""
2344
2504
 
2345
- PaymentIntentsSearchResult = StripeExecuteResultWithMeta[list[PaymentIntent], PaymentIntentsSearchResultMeta]
2346
- """Result type for payment_intents.search operation with data and metadata."""
2505
+ PaymentIntentsApiSearchResult = StripeExecuteResultWithMeta[list[PaymentIntent], PaymentIntentsApiSearchResultMeta]
2506
+ """Result type for payment_intents.api_search operation with data and metadata."""
2347
2507
 
2348
2508
  DisputesListResult = StripeExecuteResultWithMeta[list[Dispute], DisputesListResultMeta]
2349
2509
  """Result type for disputes.list operation with data and metadata."""