airbyte-agent-stripe 0.5.28__py3-none-any.whl → 0.5.32__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.
@@ -100,119 +100,85 @@ class CustomerSources(BaseModel):
100
100
  url: Union[str, Any] = Field(default=None, description="The URL where this list can be accessed")
101
101
  """The URL where this list can be accessed"""
102
102
 
103
- class CustomerInvoiceSettingsCustomFieldsItem(BaseModel):
104
- """Nested schema for CustomerInvoiceSettings.custom_fields_item"""
105
- model_config = ConfigDict(extra="allow", populate_by_name=True)
106
-
107
- name: Union[str, Any] = Field(default=None, description="The name of the custom field")
108
- """The name of the custom field"""
109
- value: Union[str, Any] = Field(default=None, description="The value of the custom field")
110
- """The value of the custom field"""
111
-
112
- class CustomerInvoiceSettingsRenderingOptions(BaseModel):
113
- """Default options for invoice PDF rendering for this customer"""
103
+ class SubscriptionBillingModeFlexible(BaseModel):
104
+ """Configure behavior for flexible billing mode"""
114
105
  model_config = ConfigDict(extra="allow", populate_by_name=True)
115
106
 
116
- 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")
117
- """How line-item prices and amounts will be displayed with respect to tax on invoice PDFs"""
118
- template: Union[str | None, Any] = Field(default=None, description="ID of the invoice rendering template to be used for this customer's invoices")
119
- """ID of the invoice rendering template to be used for this customer's invoices"""
107
+ proration_discounts: Union[str, Any] = Field(default=None, description="Controls how invoices and invoice items display proration amounts and discount amounts")
108
+ """Controls how invoices and invoice items display proration amounts and discount amounts"""
120
109
 
121
- class CustomerInvoiceSettings(BaseModel):
122
- """The customer's default invoice settings"""
110
+ class SubscriptionBillingMode(BaseModel):
111
+ """Controls how prorations and invoices for subscriptions are calculated and orchestrated"""
123
112
  model_config = ConfigDict(extra="allow", populate_by_name=True)
124
113
 
125
- custom_fields: Union[list[CustomerInvoiceSettingsCustomFieldsItem] | None, Any] = Field(default=None, description="Default custom fields to be displayed on invoices for this customer")
126
- """Default custom fields to be displayed on invoices for this customer"""
127
- default_payment_method: Union[str | None, Any] = Field(default=None, description="ID of a payment method that's attached to the customer")
128
- """ID of a payment method that's attached to the customer"""
129
- footer: Union[str | None, Any] = Field(default=None, description="Default footer to be displayed on invoices for this customer")
130
- """Default footer to be displayed on invoices for this customer"""
131
- rendering_options: Union[CustomerInvoiceSettingsRenderingOptions | None, Any] = Field(default=None, description="Default options for invoice PDF rendering for this customer")
132
- """Default options for invoice PDF rendering for this customer"""
114
+ flexible: Union[SubscriptionBillingModeFlexible | None, Any] = Field(default=None, description="Configure behavior for flexible billing mode")
115
+ """Configure behavior for flexible billing mode"""
116
+ type: Union[str, Any] = Field(default=None, description="Controls how prorations and invoices for subscriptions are calculated and orchestrated")
117
+ """Controls how prorations and invoices for subscriptions are calculated and orchestrated"""
118
+ updated_at: Union[int | None, Any] = Field(default=None, description="Details on when the current billing_mode was adopted")
119
+ """Details on when the current billing_mode was adopted"""
133
120
 
134
- class CustomerAddress(BaseModel):
135
- """The customer's address"""
121
+ class SubscriptionPaymentSettings(BaseModel):
122
+ """Payment settings passed on to invoices created by the subscription"""
136
123
  model_config = ConfigDict(extra="allow", populate_by_name=True)
137
124
 
138
- city: Union[str | None, Any] = Field(default=None, description="City, district, suburb, town, or village")
139
- """City, district, suburb, town, or village"""
140
- country: Union[str | None, Any] = Field(default=None, description="Two-letter country code (ISO 3166-1 alpha-2)")
141
- """Two-letter country code (ISO 3166-1 alpha-2)"""
142
- line1: Union[str | None, Any] = Field(default=None, description="Address line 1, such as the street, PO Box, or company name")
143
- """Address line 1, such as the street, PO Box, or company name"""
144
- line2: Union[str | None, Any] = Field(default=None, description="Address line 2, such as the apartment, suite, unit, or building")
145
- """Address line 2, such as the apartment, suite, unit, or building"""
146
- postal_code: Union[str | None, Any] = Field(default=None, description="ZIP or postal code")
147
- """ZIP or postal code"""
148
- state: Union[str | None, Any] = Field(default=None, description="State, county, province, or region")
149
- """State, county, province, or region"""
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"""
150
129
 
151
- class CustomerCashBalanceSettings(BaseModel):
152
- """A hash of settings for this cash balance"""
130
+ class SubscriptionItemsDataItemBillingThresholds(BaseModel):
131
+ """Define thresholds at which an invoice will be sent"""
153
132
  model_config = ConfigDict(extra="allow", populate_by_name=True)
154
133
 
155
- reconciliation_mode: Union[str, Any] = Field(default=None, description="The configuration for how funds that land in the customer cash balance are reconciled")
156
- """The configuration for how funds that land in the customer cash balance are reconciled"""
157
- 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")
158
- """A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance"""
134
+ usage_gte: Union[int | None, Any] = Field(default=None, description="Usage threshold that triggers the subscription to create an invoice")
135
+ """Usage threshold that triggers the subscription to create an invoice"""
159
136
 
160
- class CustomerCashBalance(BaseModel):
161
- """The current funds being held by Stripe on behalf of the customer"""
137
+ class SubscriptionItemsDataItem(BaseModel):
138
+ """Nested schema for SubscriptionItems.data_item"""
162
139
  model_config = ConfigDict(extra="allow", populate_by_name=True)
163
140
 
141
+ id: Union[str, Any] = Field(default=None, description="Unique identifier for the object")
142
+ """Unique identifier for the object"""
164
143
  object: Union[str, Any] = Field(default=None, description="String representing the object's type")
165
144
  """String representing the object's type"""
166
- available: Union[dict[str, Any] | None, Any] = Field(default=None, description="A hash of all cash balances available to this customer")
167
- """A hash of all cash balances available to this customer"""
168
- customer: Union[str, Any] = Field(default=None, description="The ID of the customer whose cash balance this object represents")
169
- """The ID of the customer whose cash balance this object represents"""
170
- customer_account: Union[str | None, Any] = Field(default=None, description="The ID of the account whose cash balance this object represents")
171
- """The ID of the account whose cash balance this object represents"""
172
- 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")
173
- """Has the value true if the object exists in live mode or false if in test mode"""
174
- settings: Union[CustomerCashBalanceSettings, Any] = Field(default=None, description="A hash of settings for this cash balance")
175
- """A hash of settings for this cash balance"""
176
-
177
- class CustomerDiscountSource(BaseModel):
178
- """The source of the discount"""
179
- model_config = ConfigDict(extra="allow", populate_by_name=True)
180
-
181
- coupon: Union[str | None, Any] = Field(default=None, description="The coupon that was redeemed to create this discount")
182
- """The coupon that was redeemed to create this discount"""
183
- type: Union[str, Any] = Field(default=None, description="The source type of the discount")
184
- """The source type of the discount"""
145
+ billing_thresholds: Union[SubscriptionItemsDataItemBillingThresholds | None, Any] = Field(default=None, description="Define thresholds at which an invoice will be sent")
146
+ """Define thresholds at which an invoice will be sent"""
147
+ created: Union[int, Any] = Field(default=None, description="Time at which the object was created")
148
+ """Time at which the object was created"""
149
+ current_period_end: Union[int, Any] = Field(default=None, description="The end time of this subscription item's current billing period")
150
+ """The end time of this subscription item's current billing period"""
151
+ current_period_start: Union[int, Any] = Field(default=None, description="The start time of this subscription item's current billing period")
152
+ """The start time of this subscription item's current billing period"""
153
+ discounts: Union[list[str], Any] = Field(default=None, description="The discounts applied to the subscription item")
154
+ """The discounts applied to the subscription item"""
155
+ metadata: Union[dict[str, str], Any] = Field(default=None, description="Set of key-value pairs")
156
+ """Set of key-value pairs"""
157
+ plan: Union[dict[str, Any] | None, Any] = Field(default=None, description="The plan the customer is subscribed to (deprecated, use price instead)")
158
+ """The plan the customer is subscribed to (deprecated, use price instead)"""
159
+ price: Union[dict[str, Any], Any] = Field(default=None, description="The price the customer is subscribed to")
160
+ """The price the customer is subscribed to"""
161
+ quantity: Union[int | None, Any] = Field(default=None, description="The quantity of the plan to which the customer should be subscribed")
162
+ """The quantity of the plan to which the customer should be subscribed"""
163
+ subscription: Union[str, Any] = Field(default=None, description="The subscription this subscription_item belongs to")
164
+ """The subscription this subscription_item belongs to"""
165
+ tax_rates: Union[list[dict[str, Any]] | None, Any] = Field(default=None, description="The tax rates which apply to this subscription_item")
166
+ """The tax rates which apply to this subscription_item"""
185
167
 
186
- class CustomerDiscount(BaseModel):
187
- """Describes the current discount active on the customer, if there is one"""
168
+ class SubscriptionItems(BaseModel):
169
+ """List of subscription items, each with an attached price"""
188
170
  model_config = ConfigDict(extra="allow", populate_by_name=True)
189
171
 
190
- id: Union[str, Any] = Field(default=None, description="The ID of the discount object")
191
- """The ID of the discount object"""
192
172
  object: Union[str, Any] = Field(default=None, description="String representing the object's type")
193
173
  """String representing the object's type"""
194
- checkout_session: Union[str | None, Any] = Field(default=None, description="The Checkout session that this coupon is applied to, if applicable")
195
- """The Checkout session that this coupon is applied to, if applicable"""
196
- customer: Union[str | None, Any] = Field(default=None, description="The ID of the customer associated with this discount")
197
- """The ID of the customer associated with this discount"""
198
- customer_account: Union[str | None, Any] = Field(default=None, description="The ID of the account associated with this discount")
199
- """The ID of the account associated with this discount"""
200
- end: Union[int | None, Any] = Field(default=None, description="If the coupon has a duration of repeating, the date that this discount will end")
201
- """If the coupon has a duration of repeating, the date that this discount will end"""
202
- invoice: Union[str | None, Any] = Field(default=None, description="The invoice that the discount's coupon was applied to")
203
- """The invoice that the discount's coupon was applied to"""
204
- invoice_item: Union[str | None, Any] = Field(default=None, description="The invoice item that the discount's coupon was applied to")
205
- """The invoice item that the discount's coupon was applied to"""
206
- promotion_code: Union[str | None, Any] = Field(default=None, description="The promotion code applied to create this discount")
207
- """The promotion code applied to create this discount"""
208
- source: Union[CustomerDiscountSource, Any] = Field(default=None, description="The source of the discount")
209
- """The source of the discount"""
210
- start: Union[int, Any] = Field(default=None, description="Date that the coupon was applied")
211
- """Date that the coupon was applied"""
212
- subscription: Union[str | None, Any] = Field(default=None, description="The subscription that this coupon is applied to")
213
- """The subscription that this coupon is applied to"""
214
- subscription_item: Union[str | None, Any] = Field(default=None, description="The subscription item that this coupon is applied to")
215
- """The subscription item that this coupon is applied to"""
174
+ data: Union[list[SubscriptionItemsDataItem], Any] = Field(default=None, description="Details about each object")
175
+ """Details about each object"""
176
+ has_more: Union[bool, Any] = Field(default=None, description="True if this list has another page of items after this one")
177
+ """True if this list has another page of items after this one"""
178
+ url: Union[str, Any] = Field(default=None, description="The URL where this list can be accessed")
179
+ """The URL where this list can be accessed"""
180
+ total_count: Union[int, Any] = Field(default=None, description="The total count of items in the list")
181
+ """The total count of items in the list"""
216
182
 
217
183
  class SubscriptionBillingCycleAnchorConfig(BaseModel):
218
184
  """The fixed values used to calculate the billing_cycle_anchor"""
@@ -229,41 +195,14 @@ class SubscriptionBillingCycleAnchorConfig(BaseModel):
229
195
  second: Union[int | None, Any] = Field(default=None, description="The second of the minute of the billing_cycle_anchor")
230
196
  """The second of the minute of the billing_cycle_anchor"""
231
197
 
232
- class SubscriptionPauseCollection(BaseModel):
233
- """If specified, payment collection for this subscription will be paused"""
234
- model_config = ConfigDict(extra="allow", populate_by_name=True)
235
-
236
- behavior: Union[str, Any] = Field(default=None, description="The payment collection behavior for this subscription while paused")
237
- """The payment collection behavior for this subscription while paused"""
238
- resumes_at: Union[int | None, Any] = Field(default=None, description="The time after which the subscription will resume collecting payments")
239
- """The time after which the subscription will resume collecting payments"""
240
-
241
- class SubscriptionBillingModeFlexible(BaseModel):
242
- """Configure behavior for flexible billing mode"""
243
- model_config = ConfigDict(extra="allow", populate_by_name=True)
244
-
245
- proration_discounts: Union[str, Any] = Field(default=None, description="Controls how invoices and invoice items display proration amounts and discount amounts")
246
- """Controls how invoices and invoice items display proration amounts and discount amounts"""
247
-
248
- class SubscriptionBillingMode(BaseModel):
249
- """Controls how prorations and invoices for subscriptions are calculated and orchestrated"""
250
- model_config = ConfigDict(extra="allow", populate_by_name=True)
251
-
252
- flexible: Union[SubscriptionBillingModeFlexible | None, Any] = Field(default=None, description="Configure behavior for flexible billing mode")
253
- """Configure behavior for flexible billing mode"""
254
- type: Union[str, Any] = Field(default=None, description="Controls how prorations and invoices for subscriptions are calculated and orchestrated")
255
- """Controls how prorations and invoices for subscriptions are calculated and orchestrated"""
256
- updated_at: Union[int | None, Any] = Field(default=None, description="Details on when the current billing_mode was adopted")
257
- """Details on when the current billing_mode was adopted"""
258
-
259
- class SubscriptionPaymentSettings(BaseModel):
260
- """Payment settings passed on to invoices created by the subscription"""
198
+ class SubscriptionBillingThresholds(BaseModel):
199
+ """Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period"""
261
200
  model_config = ConfigDict(extra="allow", populate_by_name=True)
262
201
 
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"""
202
+ amount_gte: Union[int | None, Any] = Field(default=None, description="Monetary threshold that triggers the subscription to create an invoice")
203
+ """Monetary threshold that triggers the subscription to create an invoice"""
204
+ 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
+ """Indicates if the billing_cycle_anchor should be reset when a threshold is reached"""
267
206
 
268
207
  class SubscriptionDefaultTaxRatesItemFlatAmount(BaseModel):
269
208
  """The amount of the tax rate when the rate_type is flat_amount"""
@@ -339,15 +278,6 @@ class SubscriptionTrialSettings(BaseModel):
339
278
 
340
279
  end_behavior: Union[SubscriptionTrialSettingsEndBehavior, Any] = Field(default=None)
341
280
 
342
- class SubscriptionBillingThresholds(BaseModel):
343
- """Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period"""
344
- model_config = ConfigDict(extra="allow", populate_by_name=True)
345
-
346
- amount_gte: Union[int | None, Any] = Field(default=None, description="Monetary threshold that triggers the subscription to create an invoice")
347
- """Monetary threshold that triggers the subscription to create an invoice"""
348
- 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")
349
- """Indicates if the billing_cycle_anchor should be reset when a threshold is reached"""
350
-
351
281
  class SubscriptionInvoiceSettingsIssuer(BaseModel):
352
282
  """The connected account that issues the invoice"""
353
283
  model_config = ConfigDict(extra="allow", populate_by_name=True)
@@ -386,58 +316,14 @@ class SubscriptionAutomaticTax(BaseModel):
386
316
  liability: Union[SubscriptionAutomaticTaxLiability | None, Any] = Field(default=None, description="The account that's liable for tax")
387
317
  """The account that's liable for tax"""
388
318
 
389
- class SubscriptionItemsDataItemBillingThresholds(BaseModel):
390
- """Define thresholds at which an invoice will be sent"""
391
- model_config = ConfigDict(extra="allow", populate_by_name=True)
392
-
393
- usage_gte: Union[int | None, Any] = Field(default=None, description="Usage threshold that triggers the subscription to create an invoice")
394
- """Usage threshold that triggers the subscription to create an invoice"""
395
-
396
- class SubscriptionItemsDataItem(BaseModel):
397
- """Nested schema for SubscriptionItems.data_item"""
398
- model_config = ConfigDict(extra="allow", populate_by_name=True)
399
-
400
- id: Union[str, Any] = Field(default=None, description="Unique identifier for the object")
401
- """Unique identifier for the object"""
402
- object: Union[str, Any] = Field(default=None, description="String representing the object's type")
403
- """String representing the object's type"""
404
- billing_thresholds: Union[SubscriptionItemsDataItemBillingThresholds | None, Any] = Field(default=None, description="Define thresholds at which an invoice will be sent")
405
- """Define thresholds at which an invoice will be sent"""
406
- created: Union[int, Any] = Field(default=None, description="Time at which the object was created")
407
- """Time at which the object was created"""
408
- current_period_end: Union[int, Any] = Field(default=None, description="The end time of this subscription item's current billing period")
409
- """The end time of this subscription item's current billing period"""
410
- current_period_start: Union[int, Any] = Field(default=None, description="The start time of this subscription item's current billing period")
411
- """The start time of this subscription item's current billing period"""
412
- discounts: Union[list[str], Any] = Field(default=None, description="The discounts applied to the subscription item")
413
- """The discounts applied to the subscription item"""
414
- metadata: Union[dict[str, str], Any] = Field(default=None, description="Set of key-value pairs")
415
- """Set of key-value pairs"""
416
- plan: Union[dict[str, Any] | None, Any] = Field(default=None, description="The plan the customer is subscribed to (deprecated, use price instead)")
417
- """The plan the customer is subscribed to (deprecated, use price instead)"""
418
- price: Union[dict[str, Any], Any] = Field(default=None, description="The price the customer is subscribed to")
419
- """The price the customer is subscribed to"""
420
- quantity: Union[int | None, Any] = Field(default=None, description="The quantity of the plan to which the customer should be subscribed")
421
- """The quantity of the plan to which the customer should be subscribed"""
422
- subscription: Union[str, Any] = Field(default=None, description="The subscription this subscription_item belongs to")
423
- """The subscription this subscription_item belongs to"""
424
- tax_rates: Union[list[dict[str, Any]] | None, Any] = Field(default=None, description="The tax rates which apply to this subscription_item")
425
- """The tax rates which apply to this subscription_item"""
426
-
427
- class SubscriptionItems(BaseModel):
428
- """List of subscription items, each with an attached price"""
319
+ class SubscriptionPauseCollection(BaseModel):
320
+ """If specified, payment collection for this subscription will be paused"""
429
321
  model_config = ConfigDict(extra="allow", populate_by_name=True)
430
322
 
431
- object: Union[str, Any] = Field(default=None, description="String representing the object's type")
432
- """String representing the object's type"""
433
- data: Union[list[SubscriptionItemsDataItem], Any] = Field(default=None, description="Details about each object")
434
- """Details about each object"""
435
- has_more: Union[bool, Any] = Field(default=None, description="True if this list has another page of items after this one")
436
- """True if this list has another page of items after this one"""
437
- url: Union[str, Any] = Field(default=None, description="The URL where this list can be accessed")
438
- """The URL where this list can be accessed"""
439
- total_count: Union[int, Any] = Field(default=None, description="The total count of items in the list")
440
- """The total count of items in the list"""
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"""
441
327
 
442
328
  class Subscription(BaseModel):
443
329
  """Subscription type definition"""
@@ -507,8 +393,122 @@ class CustomerSubscriptions(BaseModel):
507
393
  url: Union[str, Any] = Field(default=None, description="The URL where this list can be accessed")
508
394
  """The URL where this list can be accessed"""
509
395
 
510
- class Customer(BaseModel):
511
- """Customer type definition"""
396
+ class CustomerDiscountSource(BaseModel):
397
+ """The source of the discount"""
398
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
399
+
400
+ coupon: Union[str | None, Any] = Field(default=None, description="The coupon that was redeemed to create this discount")
401
+ """The coupon that was redeemed to create this discount"""
402
+ type: Union[str, Any] = Field(default=None, description="The source type of the discount")
403
+ """The source type of the discount"""
404
+
405
+ class CustomerDiscount(BaseModel):
406
+ """Describes the current discount active on the customer, if there is one"""
407
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
408
+
409
+ id: Union[str, Any] = Field(default=None, description="The ID of the discount object")
410
+ """The ID of the discount object"""
411
+ object: Union[str, Any] = Field(default=None, description="String representing the object's type")
412
+ """String representing the object's type"""
413
+ checkout_session: Union[str | None, Any] = Field(default=None, description="The Checkout session that this coupon is applied to, if applicable")
414
+ """The Checkout session that this coupon is applied to, if applicable"""
415
+ customer: Union[str | None, Any] = Field(default=None, description="The ID of the customer associated with this discount")
416
+ """The ID of the customer associated with this discount"""
417
+ customer_account: Union[str | None, Any] = Field(default=None, description="The ID of the account associated with this discount")
418
+ """The ID of the account associated with this discount"""
419
+ end: Union[int | None, Any] = Field(default=None, description="If the coupon has a duration of repeating, the date that this discount will end")
420
+ """If the coupon has a duration of repeating, the date that this discount will end"""
421
+ invoice: Union[str | None, Any] = Field(default=None, description="The invoice that the discount's coupon was applied to")
422
+ """The invoice that the discount's coupon was applied to"""
423
+ invoice_item: Union[str | None, Any] = Field(default=None, description="The invoice item that the discount's coupon was applied to")
424
+ """The invoice item that the discount's coupon was applied to"""
425
+ promotion_code: Union[str | None, Any] = Field(default=None, description="The promotion code applied to create this discount")
426
+ """The promotion code applied to create this discount"""
427
+ source: Union[CustomerDiscountSource, Any] = Field(default=None, description="The source of the discount")
428
+ """The source of the discount"""
429
+ start: Union[int, Any] = Field(default=None, description="Date that the coupon was applied")
430
+ """Date that the coupon was applied"""
431
+ subscription: Union[str | None, Any] = Field(default=None, description="The subscription that this coupon is applied to")
432
+ """The subscription that this coupon is applied to"""
433
+ subscription_item: Union[str | None, Any] = Field(default=None, description="The subscription item that this coupon is applied to")
434
+ """The subscription item that this coupon is applied to"""
435
+
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
+ class Customer(BaseModel):
511
+ """Customer type definition"""
512
512
  model_config = ConfigDict(extra="allow", populate_by_name=True)
513
513
 
514
514
  id: Union[str, Any] = Field(default=None)
@@ -551,78 +551,54 @@ 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 InvoiceConfirmationSecret(BaseModel):
555
- """The confirmation secret associated with this invoice"""
556
- model_config = ConfigDict(extra="allow", populate_by_name=True)
557
-
558
- client_secret: Union[str, Any] = Field(default=None, description="The client_secret of the payment that Stripe creates for the invoice after finalization")
559
- """The client_secret of the payment that Stripe creates for the invoice after finalization"""
560
- type: Union[str, Any] = Field(default=None, description="The type of client_secret")
561
- """The type of client_secret"""
562
-
563
- class InvoiceSubscriptionDetails(BaseModel):
564
- """Details about the subscription that this invoice was prepared for, if any"""
565
- model_config = ConfigDict(extra="allow", populate_by_name=True)
566
-
567
- 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")
568
- """Set of key-value pairs defined as subscription metadata when the invoice is created"""
569
-
570
- class InvoiceIssuer(BaseModel):
571
- """The connected account that issues the invoice"""
572
- model_config = ConfigDict(extra="allow", populate_by_name=True)
573
-
574
- account: Union[str | None, Any] = Field(default=None, description="The connected account being referenced when type is account")
575
- """The connected account being referenced when type is account"""
576
- type: Union[str, Any] = Field(default=None, description="Type of the account referenced")
577
- """Type of the account referenced"""
578
-
579
- class InvoiceTotalTaxAmountsItem(BaseModel):
580
- """Nested schema for Invoice.total_tax_amounts_item"""
581
- model_config = ConfigDict(extra="allow", populate_by_name=True)
582
-
583
- amount: Union[int, Any] = Field(default=None, description="The amount of the tax")
584
- """The amount of the tax"""
585
- inclusive: Union[bool, Any] = Field(default=None, description="Whether the tax amount is included in the line item amount")
586
- """Whether the tax amount is included in the line item amount"""
587
- tax_rate: Union[str, Any] = Field(default=None, description="The tax rate applied")
588
- """The tax rate applied"""
589
- taxability_reason: Union[str | None, Any] = Field(default=None, description="The reasoning behind the tax")
590
- """The reasoning behind the tax"""
591
- taxable_amount: Union[int, Any] = Field(default=None, description="The amount on which tax is calculated")
592
- """The amount on which tax is calculated"""
593
-
594
- class InvoiceTotalDiscountAmountsItem(BaseModel):
595
- """Nested schema for Invoice.total_discount_amounts_item"""
554
+ class InvoiceCustomerTaxIdsItem(BaseModel):
555
+ """Nested schema for Invoice.customer_tax_ids_item"""
596
556
  model_config = ConfigDict(extra="allow", populate_by_name=True)
597
557
 
598
- amount: Union[int, Any] = Field(default=None, description="The amount of the discount")
599
- """The amount of the discount"""
600
- discount: Union[str, Any] = Field(default=None, description="The discount that was applied")
601
- """The discount that was applied"""
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"""
602
562
 
603
- class InvoiceAutomaticTaxLiability(BaseModel):
604
- """The account that's liable for tax"""
563
+ class InvoiceLastFinalizationError(BaseModel):
564
+ """The error encountered during the last finalization attempt"""
605
565
  model_config = ConfigDict(extra="allow", populate_by_name=True)
606
566
 
607
- account: Union[str | None, Any] = Field(default=None, description="The connected account being referenced when type is account")
608
- """The connected account being referenced when type is account"""
609
- type: Union[str, Any] = Field(default=None, description="Type of the account referenced")
610
- """Type of the account referenced"""
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"""
611
585
 
612
- class InvoiceAutomaticTax(BaseModel):
613
- """Settings and latest results for automatic tax lookup for this invoice"""
586
+ class InvoiceCustomerAddress(BaseModel):
587
+ """The customer's address"""
614
588
  model_config = ConfigDict(extra="allow", populate_by_name=True)
615
589
 
616
- disabled_reason: Union[str | None, Any] = Field(default=None, description="If Stripe disabled automatic tax, this enum describes why")
617
- """If Stripe disabled automatic tax, this enum describes why"""
618
- enabled: Union[bool, Any] = Field(default=None, description="Whether Stripe automatically computes tax on this invoice")
619
- """Whether Stripe automatically computes tax on this invoice"""
620
- liability: Union[InvoiceAutomaticTaxLiability | None, Any] = Field(default=None, description="The account that's liable for tax")
621
- """The account that's liable for tax"""
622
- provider: Union[str | None, Any] = Field(default=None, description="The tax provider powering automatic tax")
623
- """The tax provider powering automatic tax"""
624
- status: Union[str | None, Any] = Field(default=None, description="The status of the most recent automated tax calculation for this invoice")
625
- """The status of the most recent automated tax calculation for this invoice"""
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")
595
+ """Address line 1"""
596
+ line2: Union[str | None, Any] = Field(default=None, description="Address line 2")
597
+ """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")
601
+ """State, county, province, or region"""
626
602
 
627
603
  class InvoiceStatusTransitions(BaseModel):
628
604
  """Status transition timestamps"""
@@ -637,14 +613,53 @@ class InvoiceStatusTransitions(BaseModel):
637
613
  voided_at: Union[int | None, Any] = Field(default=None, description="The time that the invoice was voided")
638
614
  """The time that the invoice was voided"""
639
615
 
640
- class InvoiceLinesDataItemDiscountAmountsItem(BaseModel):
641
- """Nested schema for InvoiceLinesDataItem.discount_amounts_item"""
616
+ class InvoiceShippingDetailsAddress(BaseModel):
617
+ """Shipping address"""
642
618
  model_config = ConfigDict(extra="allow", populate_by_name=True)
643
619
 
644
- amount: Union[int, Any] = Field(default=None, description="The amount of the discount")
645
- """The amount of the discount"""
646
- discount: Union[str, Any] = Field(default=None, description="The discount that was applied")
647
- """The discount that was applied"""
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")
625
+ """Address line 1"""
626
+ line2: Union[str | None, Any] = Field(default=None, description="Address line 2")
627
+ """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")
631
+ """State, county, province, or region"""
632
+
633
+ class InvoiceShippingDetails(BaseModel):
634
+ """Shipping details for the invoice"""
635
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
636
+
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"""
643
+
644
+ class InvoiceRenderingPdf(BaseModel):
645
+ """Invoice pdf rendering options"""
646
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
647
+
648
+ page_size: Union[str | None, Any] = Field(default=None, description="Page size of invoice pdf")
649
+ """Page size of invoice pdf"""
650
+
651
+ class InvoiceRendering(BaseModel):
652
+ """The rendering-related settings that control how the invoice is displayed"""
653
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
654
+
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"""
648
663
 
649
664
  class InvoiceLinesDataItemPeriod(BaseModel):
650
665
  """The period this line_item covers"""
@@ -655,6 +670,15 @@ class InvoiceLinesDataItemPeriod(BaseModel):
655
670
  start: Union[int, Any] = Field(default=None, description="The start of the period")
656
671
  """The start of the period"""
657
672
 
673
+ class InvoiceLinesDataItemDiscountAmountsItem(BaseModel):
674
+ """Nested schema for InvoiceLinesDataItem.discount_amounts_item"""
675
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
676
+
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
+
658
682
  class InvoiceLinesDataItem(BaseModel):
659
683
  """Nested schema for InvoiceLines.data_item"""
660
684
  model_config = ConfigDict(extra="allow", populate_by_name=True)
@@ -698,151 +722,198 @@ class InvoiceLines(BaseModel):
698
722
  total_count: Union[int | None, Any] = Field(default=None)
699
723
  url: Union[str | None, Any] = Field(default=None)
700
724
 
701
- class InvoiceShippingDetailsAddress(BaseModel):
702
- """Shipping address"""
725
+ class InvoiceShippingCostTaxesItem(BaseModel):
726
+ """Nested schema for InvoiceShippingCost.taxes_item"""
703
727
  model_config = ConfigDict(extra="allow", populate_by_name=True)
704
728
 
705
- city: Union[str | None, Any] = Field(default=None, description="City, district, suburb, town, or village")
706
- """City, district, suburb, town, or village"""
707
- country: Union[str | None, Any] = Field(default=None, description="Two-letter country code (ISO 3166-1 alpha-2)")
708
- """Two-letter country code (ISO 3166-1 alpha-2)"""
709
- line1: Union[str | None, Any] = Field(default=None, description="Address line 1")
710
- """Address line 1"""
711
- line2: Union[str | None, Any] = Field(default=None, description="Address line 2")
712
- """Address line 2"""
713
- postal_code: Union[str | None, Any] = Field(default=None, description="ZIP or postal code")
714
- """ZIP or postal code"""
715
- state: Union[str | None, Any] = Field(default=None, description="State, county, province, or region")
716
- """State, county, province, or region"""
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")
732
+ """The reasoning behind this tax"""
733
+ taxable_amount: Union[int | None, Any] = Field(default=None, description="The amount on which tax is calculated")
734
+ """The amount on which tax is calculated"""
717
735
 
718
- class InvoiceShippingDetails(BaseModel):
719
- """Shipping details for the invoice"""
736
+ class InvoiceShippingCost(BaseModel):
737
+ """The details of the cost of shipping"""
720
738
  model_config = ConfigDict(extra="allow", populate_by_name=True)
721
739
 
722
- address: Union[InvoiceShippingDetailsAddress, Any] = Field(default=None, description="Shipping address")
723
- """Shipping address"""
724
- name: Union[str, Any] = Field(default=None, description="Recipient name")
725
- """Recipient name"""
726
- phone: Union[str | None, Any] = Field(default=None, description="Recipient phone")
727
- """Recipient phone"""
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"""
728
750
 
729
- class InvoiceFromInvoice(BaseModel):
730
- """Details of the invoice that was cloned"""
751
+ class InvoiceDefaultTaxRatesItemFlatAmount(BaseModel):
752
+ """The amount of the tax rate when the rate_type is flat_amount"""
731
753
  model_config = ConfigDict(extra="allow", populate_by_name=True)
732
754
 
733
- action: Union[str, Any] = Field(default=None)
734
- invoice: Union[str, Any] = Field(default=None)
755
+ amount: Union[int, Any] = Field(default=None, description="Amount of the tax when the rate_type is flat_amount")
756
+ """Amount of the tax when the rate_type is flat_amount"""
757
+ currency: Union[str, Any] = Field(default=None, description="Three-letter ISO currency code")
758
+ """Three-letter ISO currency code"""
735
759
 
736
- class InvoiceCustomerAddress(BaseModel):
737
- """The customer's address"""
760
+ class InvoiceDefaultTaxRatesItem(BaseModel):
761
+ """Nested schema for Invoice.default_tax_rates_item"""
738
762
  model_config = ConfigDict(extra="allow", populate_by_name=True)
739
763
 
740
- city: Union[str | None, Any] = Field(default=None, description="City, district, suburb, town, or village")
741
- """City, district, suburb, town, or village"""
764
+ id: Union[str, Any] = Field(default=None, description="Unique identifier for the object")
765
+ """Unique identifier for the object"""
766
+ object: Union[str, Any] = Field(default=None, description="String representing the object's type")
767
+ """String representing the object's type"""
768
+ active: Union[bool, Any] = Field(default=None, description="Defaults to true")
769
+ """Defaults to true"""
742
770
  country: Union[str | None, Any] = Field(default=None, description="Two-letter country code (ISO 3166-1 alpha-2)")
743
771
  """Two-letter country code (ISO 3166-1 alpha-2)"""
744
- line1: Union[str | None, Any] = Field(default=None, description="Address line 1")
745
- """Address line 1"""
746
- line2: Union[str | None, Any] = Field(default=None, description="Address line 2")
747
- """Address line 2"""
748
- postal_code: Union[str | None, Any] = Field(default=None, description="ZIP or postal code")
749
- """ZIP or postal code"""
750
- state: Union[str | None, Any] = Field(default=None, description="State, county, province, or region")
751
- """State, county, province, or region"""
772
+ created: Union[int, Any] = Field(default=None, description="Time at which the object was created")
773
+ """Time at which the object was created"""
774
+ description: Union[str | None, Any] = Field(default=None, description="An arbitrary string attached to the tax rate for your internal use only")
775
+ """An arbitrary string attached to the tax rate for your internal use only"""
776
+ display_name: Union[str, Any] = Field(default=None, description="The display name of the tax rate")
777
+ """The display name of the tax rate"""
778
+ effective_percentage: Union[float | None, Any] = Field(default=None, description="Actual/effective tax rate percentage out of 100")
779
+ """Actual/effective tax rate percentage out of 100"""
780
+ inclusive: Union[bool, Any] = Field(default=None, description="This specifies if the tax rate is inclusive or exclusive")
781
+ """This specifies if the tax rate is inclusive or exclusive"""
782
+ jurisdiction: Union[str | None, Any] = Field(default=None, description="The jurisdiction for the tax rate")
783
+ """The jurisdiction for the tax rate"""
784
+ livemode: Union[bool, Any] = Field(default=None, description="Has the value true if the object exists in live mode")
785
+ """Has the value true if the object exists in live mode"""
786
+ metadata: Union[dict[str, str] | None, Any] = Field(default=None, description="Set of key-value pairs")
787
+ """Set of key-value pairs"""
788
+ percentage: Union[float, Any] = Field(default=None, description="Tax rate percentage out of 100")
789
+ """Tax rate percentage out of 100"""
790
+ flat_amount: Union[InvoiceDefaultTaxRatesItemFlatAmount | None, Any] = Field(default=None, description="The amount of the tax rate when the rate_type is flat_amount")
791
+ """The amount of the tax rate when the rate_type is flat_amount"""
792
+ jurisdiction_level: Union[str | None, Any] = Field(default=None, description="The level of the jurisdiction that imposes this tax rate")
793
+ """The level of the jurisdiction that imposes this tax rate"""
794
+ rate_type: Union[str | None, Any] = Field(default=None, description="Indicates the type of tax rate applied to the taxable amount")
795
+ """Indicates the type of tax rate applied to the taxable amount"""
796
+ state: Union[str | None, Any] = Field(default=None, description="ISO 3166-2 subdivision code")
797
+ """ISO 3166-2 subdivision code"""
798
+ tax_type: Union[str | None, Any] = Field(default=None, description="The high-level tax type")
799
+ """The high-level tax type"""
752
800
 
753
- class InvoiceThresholdReasonItemReasonsItem(BaseModel):
754
- """Nested schema for InvoiceThresholdReason.item_reasons_item"""
801
+ class InvoiceIssuer(BaseModel):
802
+ """The connected account that issues the invoice"""
755
803
  model_config = ConfigDict(extra="allow", populate_by_name=True)
756
804
 
757
- line_item_ids: Union[list[str], Any] = Field(default=None, description="The IDs of the line items that triggered the threshold invoice")
758
- """The IDs of the line items that triggered the threshold invoice"""
759
- usage_gte: Union[int, Any] = Field(default=None, description="The quantity threshold boundary that applied to the given line item")
760
- """The quantity threshold boundary that applied to the given line item"""
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"""
761
809
 
762
- class InvoiceThresholdReason(BaseModel):
763
- """If billing_reason is set to subscription_threshold this returns more information"""
810
+ class InvoiceTotalTaxesItem(BaseModel):
811
+ """Nested schema for Invoice.total_taxes_item"""
764
812
  model_config = ConfigDict(extra="allow", populate_by_name=True)
765
813
 
766
- amount_gte: Union[int | None, Any] = Field(default=None, description="The total invoice amount threshold boundary if it triggered the threshold invoice")
767
- """The total invoice amount threshold boundary if it triggered the threshold invoice"""
768
- item_reasons: Union[list[InvoiceThresholdReasonItemReasonsItem], Any] = Field(default=None, description="Indicates which line items triggered a threshold invoice")
769
- """Indicates which line items triggered a threshold invoice"""
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"""
770
826
 
771
- class InvoiceTotalPretaxCreditAmountsItem(BaseModel):
772
- """Nested schema for Invoice.total_pretax_credit_amounts_item"""
827
+ class InvoicePaymentsDataItem(BaseModel):
828
+ """Nested schema for InvoicePayments.data_item"""
773
829
  model_config = ConfigDict(extra="allow", populate_by_name=True)
774
830
 
775
- amount: Union[int, Any] = Field(default=None, description="The amount of the pretax credit amount")
776
- """The amount of the pretax credit amount"""
777
- credit_balance_transaction: Union[str | None, Any] = Field(default=None, description="The credit balance transaction that was applied")
778
- """The credit balance transaction that was applied"""
779
- discount: Union[str | None, Any] = Field(default=None, description="The discount that was applied")
780
- """The discount that was applied"""
781
- type: Union[str, Any] = Field(default=None, description="Type of the pretax credit amount referenced")
782
- """Type of the pretax credit amount referenced"""
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"""
783
851
 
784
- class InvoicePaymentSettings(BaseModel):
785
- """Configuration settings for the PaymentIntent that is generated when the invoice is finalized"""
852
+ class InvoicePayments(BaseModel):
853
+ """Payments for this invoice"""
786
854
  model_config = ConfigDict(extra="allow", populate_by_name=True)
787
855
 
788
- default_mandate: Union[str | None, Any] = Field(default=None, description="ID of the mandate to be used for this invoice")
789
- """ID of the mandate to be used for this invoice"""
790
- payment_method_options: Union[dict[str, Any] | None, Any] = Field(default=None, description="Payment-method-specific configuration to provide to the invoice's PaymentIntent")
791
- """Payment-method-specific configuration to provide to the invoice's PaymentIntent"""
792
- 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")
793
- """The list of payment method types to provide to the invoice's PaymentIntent"""
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"""
794
864
 
795
- class InvoiceCustomerTaxIdsItem(BaseModel):
796
- """Nested schema for Invoice.customer_tax_ids_item"""
865
+ class InvoiceParentSubscriptionDetails(BaseModel):
866
+ """Details about the subscription that generated this invoice"""
797
867
  model_config = ConfigDict(extra="allow", populate_by_name=True)
798
868
 
799
- type: Union[str, Any] = Field(default=None, description="The type of the tax ID")
800
- """The type of the tax ID"""
801
- value: Union[str | None, Any] = Field(default=None, description="The value of the tax ID")
802
- """The value of the tax ID"""
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"""
803
875
 
804
- class InvoiceRenderingPdf(BaseModel):
805
- """Invoice pdf rendering options"""
876
+ class InvoiceParentQuoteDetails(BaseModel):
877
+ """Details about the quote that generated this invoice"""
806
878
  model_config = ConfigDict(extra="allow", populate_by_name=True)
807
879
 
808
- page_size: Union[str | None, Any] = Field(default=None, description="Page size of invoice pdf")
809
- """Page size of invoice pdf"""
880
+ quote: Union[str, Any] = Field(default=None, description="The quote that generated this invoice")
881
+ """The quote that generated this invoice"""
810
882
 
811
- class InvoiceRendering(BaseModel):
812
- """The rendering-related settings that control how the invoice is displayed"""
883
+ class InvoiceParent(BaseModel):
884
+ """The parent that generated this invoice"""
813
885
  model_config = ConfigDict(extra="allow", populate_by_name=True)
814
886
 
815
- amount_tax_display: Union[str | None, Any] = Field(default=None, description="How line-item prices and amounts will be displayed with respect to tax")
816
- """How line-item prices and amounts will be displayed with respect to tax"""
817
- pdf: Union[InvoiceRenderingPdf | None, Any] = Field(default=None, description="Invoice pdf rendering options")
818
- """Invoice pdf rendering options"""
819
- template: Union[str | None, Any] = Field(default=None, description="ID of the rendering template that the invoice is formatted by")
820
- """ID of the rendering template that the invoice is formatted by"""
821
- template_version: Union[int | None, Any] = Field(default=None, description="Version of the rendering template that the invoice is using")
822
- """Version of the rendering template that the invoice is using"""
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"""
823
893
 
824
- class InvoiceLastFinalizationError(BaseModel):
825
- """The error encountered during the last finalization attempt"""
894
+ class InvoiceAutomaticTaxLiability(BaseModel):
895
+ """The account that's liable for tax"""
826
896
  model_config = ConfigDict(extra="allow", populate_by_name=True)
827
897
 
828
- advice_code: Union[str | None, Any] = Field(default=None, description="For card errors resulting from a card issuer decline")
829
- """For card errors resulting from a card issuer decline"""
830
- code: Union[str | None, Any] = Field(default=None, description="For some errors that could be handled programmatically, a short string indicating the error code")
831
- """For some errors that could be handled programmatically, a short string indicating the error code"""
832
- doc_url: Union[str | None, Any] = Field(default=None, description="A URL to more information about the error code reported")
833
- """A URL to more information about the error code reported"""
834
- message: Union[str | None, Any] = Field(default=None, description="A human-readable message providing more details about the error")
835
- """A human-readable message providing more details about the error"""
836
- network_advice_code: Union[str | None, Any] = Field(default=None, description="For card errors resulting from a card issuer decline")
837
- """For card errors resulting from a card issuer decline"""
838
- network_decline_code: Union[str | None, Any] = Field(default=None, description="For payments declined by the network")
839
- """For payments declined by the network"""
840
- param: Union[str | None, Any] = Field(default=None, description="If the error is parameter-specific, the parameter related to the error")
841
- """If the error is parameter-specific, the parameter related to the error"""
842
- payment_method_type: Union[str | None, Any] = Field(default=None, description="If the error is specific to the type of payment method")
843
- """If the error is specific to the type of payment method"""
844
- type: Union[str, Any] = Field(default=None, description="The type of error returned")
845
- """The type of error returned"""
898
+ account: Union[str | None, Any] = Field(default=None, description="The connected account being referenced when type is account")
899
+ """The connected account being referenced when type is account"""
900
+ type: Union[str, Any] = Field(default=None, description="Type of the account referenced")
901
+ """Type of the account referenced"""
902
+
903
+ class InvoiceAutomaticTax(BaseModel):
904
+ """Settings and latest results for automatic tax lookup for this invoice"""
905
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
906
+
907
+ disabled_reason: Union[str | None, Any] = Field(default=None, description="If Stripe disabled automatic tax, this enum describes why")
908
+ """If Stripe disabled automatic tax, this enum describes why"""
909
+ enabled: Union[bool, Any] = Field(default=None, description="Whether Stripe automatically computes tax on this invoice")
910
+ """Whether Stripe automatically computes tax on this invoice"""
911
+ liability: Union[InvoiceAutomaticTaxLiability | None, Any] = Field(default=None, description="The account that's liable for tax")
912
+ """The account that's liable for tax"""
913
+ provider: Union[str | None, Any] = Field(default=None, description="The tax provider powering automatic tax")
914
+ """The tax provider powering automatic tax"""
915
+ status: Union[str | None, Any] = Field(default=None, description="The status of the most recent automated tax calculation for this invoice")
916
+ """The status of the most recent automated tax calculation for this invoice"""
846
917
 
847
918
  class InvoiceDiscountCoupon(BaseModel):
848
919
  """Nested schema for InvoiceDiscount.coupon"""
@@ -882,43 +953,38 @@ class InvoiceDiscount(BaseModel):
882
953
  subscription: Union[str | None, Any] = Field(default=None)
883
954
  subscription_item: Union[str | None, Any] = Field(default=None)
884
955
 
885
- class InvoicePaymentsDataItem(BaseModel):
886
- """Nested schema for InvoicePayments.data_item"""
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"""
887
967
  model_config = ConfigDict(extra="allow", populate_by_name=True)
888
968
 
889
- id: Union[str, Any] = Field(default=None, description="Unique identifier for the object")
890
- """Unique identifier for the object"""
891
- object: Union[str, Any] = Field(default=None, description="String representing the object's type")
892
- """String representing the object's type"""
893
- amount_paid: Union[int | None, Any] = Field(default=None, description="Amount that was actually paid for this invoice")
894
- """Amount that was actually paid for this invoice"""
895
- amount_requested: Union[int, Any] = Field(default=None, description="Amount intended to be paid toward this invoice")
896
- """Amount intended to be paid toward this invoice"""
897
- created: Union[int, Any] = Field(default=None, description="Time at which the object was created")
898
- """Time at which the object was created"""
899
- currency: Union[str, Any] = Field(default=None, description="Three-letter ISO currency code")
900
- """Three-letter ISO currency code"""
901
- invoice: Union[str, Any] = Field(default=None, description="The invoice that was paid")
902
- """The invoice that was paid"""
903
- is_default: Union[bool, Any] = Field(default=None, description="Whether this is the default payment created when the invoice was finalized")
904
- """Whether this is the default payment created when the invoice was finalized"""
905
- livemode: Union[bool, Any] = Field(default=None, description="Has the value true if the object exists in live mode")
906
- """Has the value true if the object exists in live mode"""
907
- status: Union[str, Any] = Field(default=None, description="The status of the payment")
908
- """The status of the payment"""
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"""
909
973
 
910
- class InvoicePayments(BaseModel):
911
- """Payments for this invoice"""
974
+ class InvoiceTotalTaxAmountsItem(BaseModel):
975
+ """Nested schema for Invoice.total_tax_amounts_item"""
912
976
  model_config = ConfigDict(extra="allow", populate_by_name=True)
913
977
 
914
- object: Union[str, Any] = Field(default=None, description="String representing the object's type")
915
- """String representing the object's type"""
916
- data: Union[list[InvoicePaymentsDataItem], Any] = Field(default=None, description="Details about each payment")
917
- """Details about each payment"""
918
- has_more: Union[bool, Any] = Field(default=None, description="True if this list has another page of items")
919
- """True if this list has another page of items"""
920
- url: Union[str, Any] = Field(default=None, description="The URL where this list can be accessed")
921
- """The URL where this list can be accessed"""
978
+ amount: Union[int, Any] = Field(default=None, description="The amount of the tax")
979
+ """The amount of the tax"""
980
+ inclusive: Union[bool, Any] = Field(default=None, description="Whether the tax amount is included in the line item amount")
981
+ """Whether the tax amount is included in the line item amount"""
982
+ tax_rate: Union[str, Any] = Field(default=None, description="The tax rate applied")
983
+ """The tax rate applied"""
984
+ taxability_reason: Union[str | None, Any] = Field(default=None, description="The reasoning behind the tax")
985
+ """The reasoning behind the tax"""
986
+ taxable_amount: Union[int, Any] = Field(default=None, description="The amount on which tax is calculated")
987
+ """The amount on which tax is calculated"""
922
988
 
923
989
  class InvoiceCustomerShippingAddress(BaseModel):
924
990
  """Customer shipping address"""
@@ -948,136 +1014,70 @@ class InvoiceCustomerShipping(BaseModel):
948
1014
  phone: Union[str | None, Any] = Field(default=None, description="Customer phone (including extension)")
949
1015
  """Customer phone (including extension)"""
950
1016
 
951
- class InvoiceDefaultTaxRatesItemFlatAmount(BaseModel):
952
- """The amount of the tax rate when the rate_type is flat_amount"""
953
- model_config = ConfigDict(extra="allow", populate_by_name=True)
954
-
955
- amount: Union[int, Any] = Field(default=None, description="Amount of the tax when the rate_type is flat_amount")
956
- """Amount of the tax when the rate_type is flat_amount"""
957
- currency: Union[str, Any] = Field(default=None, description="Three-letter ISO currency code")
958
- """Three-letter ISO currency code"""
959
-
960
- class InvoiceDefaultTaxRatesItem(BaseModel):
961
- """Nested schema for Invoice.default_tax_rates_item"""
962
- model_config = ConfigDict(extra="allow", populate_by_name=True)
963
-
964
- id: Union[str, Any] = Field(default=None, description="Unique identifier for the object")
965
- """Unique identifier for the object"""
966
- object: Union[str, Any] = Field(default=None, description="String representing the object's type")
967
- """String representing the object's type"""
968
- active: Union[bool, Any] = Field(default=None, description="Defaults to true")
969
- """Defaults to true"""
970
- country: Union[str | None, Any] = Field(default=None, description="Two-letter country code (ISO 3166-1 alpha-2)")
971
- """Two-letter country code (ISO 3166-1 alpha-2)"""
972
- created: Union[int, Any] = Field(default=None, description="Time at which the object was created")
973
- """Time at which the object was created"""
974
- description: Union[str | None, Any] = Field(default=None, description="An arbitrary string attached to the tax rate for your internal use only")
975
- """An arbitrary string attached to the tax rate for your internal use only"""
976
- display_name: Union[str, Any] = Field(default=None, description="The display name of the tax rate")
977
- """The display name of the tax rate"""
978
- effective_percentage: Union[float | None, Any] = Field(default=None, description="Actual/effective tax rate percentage out of 100")
979
- """Actual/effective tax rate percentage out of 100"""
980
- inclusive: Union[bool, Any] = Field(default=None, description="This specifies if the tax rate is inclusive or exclusive")
981
- """This specifies if the tax rate is inclusive or exclusive"""
982
- jurisdiction: Union[str | None, Any] = Field(default=None, description="The jurisdiction for the tax rate")
983
- """The jurisdiction for the tax rate"""
984
- livemode: Union[bool, Any] = Field(default=None, description="Has the value true if the object exists in live mode")
985
- """Has the value true if the object exists in live mode"""
986
- metadata: Union[dict[str, str] | None, Any] = Field(default=None, description="Set of key-value pairs")
987
- """Set of key-value pairs"""
988
- percentage: Union[float, Any] = Field(default=None, description="Tax rate percentage out of 100")
989
- """Tax rate percentage out of 100"""
990
- flat_amount: Union[InvoiceDefaultTaxRatesItemFlatAmount | None, Any] = Field(default=None, description="The amount of the tax rate when the rate_type is flat_amount")
991
- """The amount of the tax rate when the rate_type is flat_amount"""
992
- jurisdiction_level: Union[str | None, Any] = Field(default=None, description="The level of the jurisdiction that imposes this tax rate")
993
- """The level of the jurisdiction that imposes this tax rate"""
994
- rate_type: Union[str | None, Any] = Field(default=None, description="Indicates the type of tax rate applied to the taxable amount")
995
- """Indicates the type of tax rate applied to the taxable amount"""
996
- state: Union[str | None, Any] = Field(default=None, description="ISO 3166-2 subdivision code")
997
- """ISO 3166-2 subdivision code"""
998
- tax_type: Union[str | None, Any] = Field(default=None, description="The high-level tax type")
999
- """The high-level tax type"""
1000
-
1001
- class InvoiceCustomFieldsItem(BaseModel):
1002
- """Nested schema for Invoice.custom_fields_item"""
1017
+ class InvoiceThresholdReasonItemReasonsItem(BaseModel):
1018
+ """Nested schema for InvoiceThresholdReason.item_reasons_item"""
1003
1019
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1004
1020
 
1005
- name: Union[str, Any] = Field(default=None, description="The name of the custom field")
1006
- """The name of the custom field"""
1007
- value: Union[str, Any] = Field(default=None, description="The value of the custom field")
1008
- """The value of the custom field"""
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"""
1009
1025
 
1010
- class InvoiceShippingCostTaxesItem(BaseModel):
1011
- """Nested schema for InvoiceShippingCost.taxes_item"""
1026
+ class InvoiceThresholdReason(BaseModel):
1027
+ """If billing_reason is set to subscription_threshold this returns more information"""
1012
1028
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1013
1029
 
1014
- amount: Union[int, Any] = Field(default=None, description="Amount of tax applied for this rate")
1015
- """Amount of tax applied for this rate"""
1016
- taxability_reason: Union[str | None, Any] = Field(default=None, description="The reasoning behind this tax")
1017
- """The reasoning behind this tax"""
1018
- taxable_amount: Union[int | None, Any] = Field(default=None, description="The amount on which tax is calculated")
1019
- """The amount on which tax is calculated"""
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"""
1020
1034
 
1021
- class InvoiceShippingCost(BaseModel):
1022
- """The details of the cost of shipping"""
1035
+ class InvoiceFromInvoice(BaseModel):
1036
+ """Details of the invoice that was cloned"""
1023
1037
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1024
1038
 
1025
- amount_subtotal: Union[int, Any] = Field(default=None, description="Total shipping cost before any taxes are applied")
1026
- """Total shipping cost before any taxes are applied"""
1027
- amount_tax: Union[int, Any] = Field(default=None, description="Total tax amount applied due to shipping costs")
1028
- """Total tax amount applied due to shipping costs"""
1029
- amount_total: Union[int, Any] = Field(default=None, description="Total shipping cost after taxes are applied")
1030
- """Total shipping cost after taxes are applied"""
1031
- shipping_rate: Union[str | None, Any] = Field(default=None, description="The ID of the ShippingRate for this invoice")
1032
- """The ID of the ShippingRate for this invoice"""
1033
- taxes: Union[list[InvoiceShippingCostTaxesItem] | None, Any] = Field(default=None, description="The taxes applied to the shipping rate")
1034
- """The taxes applied to the shipping rate"""
1039
+ action: Union[str, Any] = Field(default=None)
1040
+ invoice: Union[str, Any] = Field(default=None)
1035
1041
 
1036
- class InvoiceTotalTaxesItem(BaseModel):
1037
- """Nested schema for Invoice.total_taxes_item"""
1042
+ class InvoiceSubscriptionDetails(BaseModel):
1043
+ """Details about the subscription that this invoice was prepared for, if any"""
1038
1044
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1039
1045
 
1040
- amount: Union[int, Any] = Field(default=None, description="The amount of the tax")
1041
- """The amount of the tax"""
1042
- tax_behavior: Union[str, Any] = Field(default=None, description="Whether this tax is inclusive or exclusive")
1043
- """Whether this tax is inclusive or exclusive"""
1044
- tax_rate_details: Union[dict[str, Any] | None, Any] = Field(default=None, description="Additional details about the tax rate")
1045
- """Additional details about the tax rate"""
1046
- taxability_reason: Union[str, Any] = Field(default=None, description="The reasoning behind this tax")
1047
- """The reasoning behind this tax"""
1048
- taxable_amount: Union[int | None, Any] = Field(default=None, description="The amount on which tax is calculated")
1049
- """The amount on which tax is calculated"""
1050
- type: Union[str, Any] = Field(default=None, description="The type of tax information")
1051
- """The type of tax information"""
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"""
1052
1048
 
1053
- class InvoiceParentSubscriptionDetails(BaseModel):
1054
- """Details about the subscription that generated this invoice"""
1049
+ class InvoiceTotalPretaxCreditAmountsItem(BaseModel):
1050
+ """Nested schema for Invoice.total_pretax_credit_amounts_item"""
1055
1051
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1056
1052
 
1057
- metadata: Union[dict[str, str] | None, Any] = Field(default=None, description="Set of key-value pairs defined as subscription metadata")
1058
- """Set of key-value pairs defined as subscription metadata"""
1059
- subscription: Union[str, Any] = Field(default=None, description="The subscription that generated this invoice")
1060
- """The subscription that generated this invoice"""
1061
- subscription_proration_date: Union[int | None, Any] = Field(default=None, description="Only set for upcoming invoices that preview prorations")
1062
- """Only set for upcoming invoices that preview prorations"""
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"""
1063
1061
 
1064
- class InvoiceParentQuoteDetails(BaseModel):
1065
- """Details about the quote that generated this invoice"""
1062
+ class InvoicePaymentSettings(BaseModel):
1063
+ """Configuration settings for the PaymentIntent that is generated when the invoice is finalized"""
1066
1064
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1067
1065
 
1068
- quote: Union[str, Any] = Field(default=None, description="The quote that generated this invoice")
1069
- """The quote that generated this invoice"""
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"""
1070
1072
 
1071
- class InvoiceParent(BaseModel):
1072
- """The parent that generated this invoice"""
1073
+ class InvoiceTotalDiscountAmountsItem(BaseModel):
1074
+ """Nested schema for Invoice.total_discount_amounts_item"""
1073
1075
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1074
1076
 
1075
- quote_details: Union[InvoiceParentQuoteDetails | None, Any] = Field(default=None, description="Details about the quote that generated this invoice")
1076
- """Details about the quote that generated this invoice"""
1077
- subscription_details: Union[InvoiceParentSubscriptionDetails | None, Any] = Field(default=None, description="Details about the subscription that generated this invoice")
1078
- """Details about the subscription that generated this invoice"""
1079
- type: Union[str, Any] = Field(default=None, description="The type of parent that generated this invoice")
1080
- """The type of parent that generated this invoice"""
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"""
1081
1081
 
1082
1082
  class Invoice(BaseModel):
1083
1083
  """Invoice type definition"""
@@ -1183,17 +1183,14 @@ class InvoiceList(BaseModel):
1183
1183
  has_more: Union[bool, Any] = Field(default=None)
1184
1184
  url: Union[str, Any] = Field(default=None)
1185
1185
 
1186
- class ChargeRefunds(BaseModel):
1187
- """A list of refunds that have been applied to the charge"""
1186
+ class ChargeFraudDetails(BaseModel):
1187
+ """Information on fraud assessments for the charge"""
1188
1188
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1189
1189
 
1190
- object: Union[str, Any] = Field(default=None)
1191
- data: Union[list[dict[str, Any]], Any] = Field(default=None)
1192
- has_more: Union[bool, Any] = Field(default=None)
1193
- total_count: Union[int, Any] = Field(default=None, description="Total number of refunds")
1194
- """Total number of refunds"""
1195
- url: Union[str, Any] = Field(default=None, description="URL to access the refunds list")
1196
- """URL to access the refunds list"""
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`"""
1197
1194
 
1198
1195
  class ChargeOutcome(BaseModel):
1199
1196
  """Details about whether the payment was accepted, and why"""
@@ -1209,26 +1206,6 @@ class ChargeOutcome(BaseModel):
1209
1206
  seller_message: Union[str, Any] = Field(default=None)
1210
1207
  type: Union[str, Any] = Field(default=None)
1211
1208
 
1212
- class ChargePresentmentDetails(BaseModel):
1213
- """Currency presentation information for multi-currency charges"""
1214
- model_config = ConfigDict(extra="allow", populate_by_name=True)
1215
-
1216
- amount_authorized: Union[int | None, Any] = Field(default=None, description="Amount authorized in the presentment currency")
1217
- """Amount authorized in the presentment currency"""
1218
- amount_charged: Union[int | None, Any] = Field(default=None, description="Amount charged in the presentment currency")
1219
- """Amount charged in the presentment currency"""
1220
- currency: Union[str | None, Any] = Field(default=None, description="Three-letter ISO currency code for presentment")
1221
- """Three-letter ISO currency code for presentment"""
1222
-
1223
- class ChargeFraudDetails(BaseModel):
1224
- """Information on fraud assessments for the charge"""
1225
- model_config = ConfigDict(extra="allow", populate_by_name=True)
1226
-
1227
- stripe_report: Union[str | None, Any] = Field(default=None, description="Assessments from Stripe. If set, the value is `fraudulent`.")
1228
- """Assessments from Stripe. If set, the value is `fraudulent`."""
1229
- user_report: Union[str | None, Any] = Field(default=None, description="Assessments from you or your users. Possible values are `fraudulent` and `safe`")
1230
- """Assessments from you or your users. Possible values are `fraudulent` and `safe`"""
1231
-
1232
1209
  class ChargeBillingDetailsAddress(BaseModel):
1233
1210
  """Nested schema for ChargeBillingDetails.address"""
1234
1211
  model_config = ConfigDict(extra="allow", populate_by_name=True)
@@ -1250,6 +1227,32 @@ class ChargeBillingDetails(BaseModel):
1250
1227
  phone: Union[str | None, Any] = Field(default=None)
1251
1228
  tax_id: Union[str | None, Any] = Field(default=None)
1252
1229
 
1230
+ class ChargeRefunds(BaseModel):
1231
+ """A list of refunds that have been applied to the charge"""
1232
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
1233
+
1234
+ object: Union[str, Any] = Field(default=None)
1235
+ data: Union[list[dict[str, Any]], Any] = Field(default=None)
1236
+ has_more: Union[bool, Any] = Field(default=None)
1237
+ total_count: Union[int, Any] = Field(default=None, description="Total number of refunds")
1238
+ """Total number of refunds"""
1239
+ url: Union[str, Any] = Field(default=None, description="URL to access the refunds list")
1240
+ """URL to access the refunds list"""
1241
+
1242
+ class ChargePaymentMethodDetailsCardExtendedAuthorization(BaseModel):
1243
+ """Extended authorization details"""
1244
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
1245
+
1246
+ status: Union[str, Any] = Field(default=None)
1247
+
1248
+ class ChargePaymentMethodDetailsCardChecks(BaseModel):
1249
+ """Check results by Card networks on Card address and CVC"""
1250
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
1251
+
1252
+ address_line1_check: Union[str | None, Any] = Field(default=None)
1253
+ address_postal_code_check: Union[str | None, Any] = Field(default=None)
1254
+ cvc_check: Union[str | None, Any] = Field(default=None)
1255
+
1253
1256
  class ChargePaymentMethodDetailsCardNetworkToken(BaseModel):
1254
1257
  """Network token details"""
1255
1258
  model_config = ConfigDict(extra="allow", populate_by_name=True)
@@ -1275,20 +1278,6 @@ class ChargePaymentMethodDetailsCardOvercapture(BaseModel):
1275
1278
  maximum_amount_capturable: Union[int, Any] = Field(default=None)
1276
1279
  status: Union[str, Any] = Field(default=None)
1277
1280
 
1278
- class ChargePaymentMethodDetailsCardChecks(BaseModel):
1279
- """Check results by Card networks on Card address and CVC"""
1280
- model_config = ConfigDict(extra="allow", populate_by_name=True)
1281
-
1282
- address_line1_check: Union[str | None, Any] = Field(default=None)
1283
- address_postal_code_check: Union[str | None, Any] = Field(default=None)
1284
- cvc_check: Union[str | None, Any] = Field(default=None)
1285
-
1286
- class ChargePaymentMethodDetailsCardExtendedAuthorization(BaseModel):
1287
- """Extended authorization details"""
1288
- model_config = ConfigDict(extra="allow", populate_by_name=True)
1289
-
1290
- status: Union[str, Any] = Field(default=None)
1291
-
1292
1281
  class ChargePaymentMethodDetailsCard(BaseModel):
1293
1282
  """Nested schema for ChargePaymentMethodDetails.card"""
1294
1283
  model_config = ConfigDict(extra="allow", populate_by_name=True)
@@ -1345,6 +1334,17 @@ class ChargePaymentMethodDetails(BaseModel):
1345
1334
  type: Union[str, Any] = Field(default=None)
1346
1335
  card: Union[ChargePaymentMethodDetailsCard | None, Any] = Field(default=None)
1347
1336
 
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
1348
  class Charge(BaseModel):
1349
1349
  """Charge type definition"""
1350
1350
  model_config = ConfigDict(extra="allow", populate_by_name=True)
@@ -1436,8 +1436,8 @@ class RefundDestinationDetailsGbBankTransfer(BaseModel):
1436
1436
  reference_status: Union[str | None, Any] = Field(default=None, description="Status of the reference on the refund")
1437
1437
  """Status of the reference on the refund"""
1438
1438
 
1439
- class RefundDestinationDetailsP24(BaseModel):
1440
- """If this is a p24 refund, this hash contains the transaction specific details"""
1439
+ class RefundDestinationDetailsMxBankTransfer(BaseModel):
1440
+ """If this is a mx_bank_transfer refund, this hash contains the transaction specific details"""
1441
1441
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1442
1442
 
1443
1443
  reference: Union[str | None, Any] = Field(default=None, description="The reference assigned to the refund")
@@ -1445,28 +1445,34 @@ class RefundDestinationDetailsP24(BaseModel):
1445
1445
  reference_status: Union[str | None, Any] = Field(default=None, description="Status of the reference on the refund")
1446
1446
  """Status of the reference on the refund"""
1447
1447
 
1448
- class RefundDestinationDetailsThBankTransfer(BaseModel):
1449
- """If this is a th_bank_transfer refund, this hash contains the transaction specific details"""
1448
+ class RefundDestinationDetailsCard(BaseModel):
1449
+ """If this is a card refund, this hash contains the transaction specific details"""
1450
1450
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1451
1451
 
1452
- reference: Union[str | None, Any] = Field(default=None, description="The reference assigned to the refund")
1453
- """The reference assigned to the refund"""
1454
- reference_status: Union[str | None, Any] = Field(default=None, description="Status of the reference on the refund")
1455
- """Status of the reference on the refund"""
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"""
1456
1460
 
1457
- class RefundDestinationDetailsPaypal(BaseModel):
1458
- """If this is a paypal refund, this hash contains the transaction specific details"""
1461
+ class RefundDestinationDetailsSwish(BaseModel):
1462
+ """If this is a swish refund, this hash contains the transaction specific details"""
1459
1463
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1460
1464
 
1461
1465
  network_decline_code: Union[str | None, Any] = Field(default=None, description="For refunds declined by the network, a decline code provided by the network")
1462
1466
  """For refunds declined by the network, a decline code provided by the network"""
1467
+ reference: Union[str | None, Any] = Field(default=None, description="The reference assigned to the refund")
1468
+ """The reference assigned to the refund"""
1469
+ reference_status: Union[str | None, Any] = Field(default=None, description="Status of the reference on the refund")
1470
+ """Status of the reference on the refund"""
1463
1471
 
1464
- class RefundDestinationDetailsSwish(BaseModel):
1465
- """If this is a swish refund, this hash contains the transaction specific details"""
1472
+ class RefundDestinationDetailsJpBankTransfer(BaseModel):
1473
+ """If this is a jp_bank_transfer refund, this hash contains the transaction specific details"""
1466
1474
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1467
1475
 
1468
- network_decline_code: Union[str | None, Any] = Field(default=None, description="For refunds declined by the network, a decline code provided by the network")
1469
- """For refunds declined by the network, a decline code provided by the network"""
1470
1476
  reference: Union[str | None, Any] = Field(default=None, description="The reference assigned to the refund")
1471
1477
  """The reference assigned to the refund"""
1472
1478
  reference_status: Union[str | None, Any] = Field(default=None, description="Status of the reference on the refund")
@@ -1483,8 +1489,8 @@ class RefundDestinationDetailsBlik(BaseModel):
1483
1489
  reference_status: Union[str | None, Any] = Field(default=None, description="Status of the reference on the refund")
1484
1490
  """Status of the reference on the refund"""
1485
1491
 
1486
- class RefundDestinationDetailsMbWay(BaseModel):
1487
- """If this is a mb_way refund, this hash contains the transaction specific details"""
1492
+ class RefundDestinationDetailsMultibanco(BaseModel):
1493
+ """If this is a multibanco refund, this hash contains the transaction specific details"""
1488
1494
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1489
1495
 
1490
1496
  reference: Union[str | None, Any] = Field(default=None, description="The reference assigned to the refund")
@@ -1501,19 +1507,6 @@ class RefundDestinationDetailsEuBankTransfer(BaseModel):
1501
1507
  reference_status: Union[str | None, Any] = Field(default=None, description="Status of the reference on the refund")
1502
1508
  """Status of the reference on the refund"""
1503
1509
 
1504
- class RefundDestinationDetailsCard(BaseModel):
1505
- """If this is a card refund, this hash contains the transaction specific details"""
1506
- model_config = ConfigDict(extra="allow", populate_by_name=True)
1507
-
1508
- reference: Union[str | None, Any] = Field(default=None, description="Value of the reference number assigned to the refund")
1509
- """Value of the reference number assigned to the refund"""
1510
- reference_status: Union[str | None, Any] = Field(default=None, description="Status of the reference number on the refund")
1511
- """Status of the reference number on the refund"""
1512
- reference_type: Union[str | None, Any] = Field(default=None, description="Type of the reference number assigned to the refund")
1513
- """Type of the reference number assigned to the refund"""
1514
- type: Union[str, Any] = Field(default=None, description="The type of refund")
1515
- """The type of refund"""
1516
-
1517
1510
  class RefundDestinationDetailsCrypto(BaseModel):
1518
1511
  """If this is a crypto refund, this hash contains the transaction specific details"""
1519
1512
  model_config = ConfigDict(extra="allow", populate_by_name=True)
@@ -1521,8 +1514,8 @@ class RefundDestinationDetailsCrypto(BaseModel):
1521
1514
  reference: Union[str | None, Any] = Field(default=None, description="The transaction hash of the refund")
1522
1515
  """The transaction hash of the refund"""
1523
1516
 
1524
- class RefundDestinationDetailsMxBankTransfer(BaseModel):
1525
- """If this is a mx_bank_transfer refund, this hash contains the transaction specific details"""
1517
+ class RefundDestinationDetailsP24(BaseModel):
1518
+ """If this is a p24 refund, this hash contains the transaction specific details"""
1526
1519
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1527
1520
 
1528
1521
  reference: Union[str | None, Any] = Field(default=None, description="The reference assigned to the refund")
@@ -1530,8 +1523,8 @@ class RefundDestinationDetailsMxBankTransfer(BaseModel):
1530
1523
  reference_status: Union[str | None, Any] = Field(default=None, description="Status of the reference on the refund")
1531
1524
  """Status of the reference on the refund"""
1532
1525
 
1533
- class RefundDestinationDetailsUsBankTransfer(BaseModel):
1534
- """If this is a us_bank_transfer refund, this hash contains the transaction specific details"""
1526
+ class RefundDestinationDetailsMbWay(BaseModel):
1527
+ """If this is a mb_way refund, this hash contains the transaction specific details"""
1535
1528
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1536
1529
 
1537
1530
  reference: Union[str | None, Any] = Field(default=None, description="The reference assigned to the refund")
@@ -1539,8 +1532,15 @@ class RefundDestinationDetailsUsBankTransfer(BaseModel):
1539
1532
  reference_status: Union[str | None, Any] = Field(default=None, description="Status of the reference on the refund")
1540
1533
  """Status of the reference on the refund"""
1541
1534
 
1542
- class RefundDestinationDetailsMultibanco(BaseModel):
1543
- """If this is a multibanco refund, this hash contains the transaction specific details"""
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"""
1544
1544
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1545
1545
 
1546
1546
  reference: Union[str | None, Any] = Field(default=None, description="The reference assigned to the refund")
@@ -1548,8 +1548,8 @@ class RefundDestinationDetailsMultibanco(BaseModel):
1548
1548
  reference_status: Union[str | None, Any] = Field(default=None, description="Status of the reference on the refund")
1549
1549
  """Status of the reference on the refund"""
1550
1550
 
1551
- class RefundDestinationDetailsJpBankTransfer(BaseModel):
1552
- """If this is a jp_bank_transfer refund, this hash contains the transaction specific details"""
1551
+ class RefundDestinationDetailsThBankTransfer(BaseModel):
1552
+ """If this is a th_bank_transfer refund, this hash contains the transaction specific details"""
1553
1553
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1554
1554
 
1555
1555
  reference: Union[str | None, Any] = Field(default=None, description="The reference assigned to the refund")
@@ -1697,6 +1697,13 @@ class RefundList(BaseModel):
1697
1697
  has_more: Union[bool, Any] = Field(default=None)
1698
1698
  url: Union[str, Any] = Field(default=None)
1699
1699
 
1700
+ class ProductMarketingFeaturesItem(BaseModel):
1701
+ """Nested schema for Product.marketing_features_item"""
1702
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
1703
+
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"""
1706
+
1700
1707
  class ProductPackageDimensions(BaseModel):
1701
1708
  """The dimensions of this product for shipping purposes"""
1702
1709
  model_config = ConfigDict(extra="allow", populate_by_name=True)
@@ -1717,13 +1724,6 @@ class ProductFeaturesItem(BaseModel):
1717
1724
  name: Union[str, Any] = Field(default=None, description="The feature name")
1718
1725
  """The feature name"""
1719
1726
 
1720
- class ProductMarketingFeaturesItem(BaseModel):
1721
- """Nested schema for Product.marketing_features_item"""
1722
- model_config = ConfigDict(extra="allow", populate_by_name=True)
1723
-
1724
- name: Union[str | None, Any] = Field(default=None, description="The marketing feature name. Up to 80 characters long")
1725
- """The marketing feature name. Up to 80 characters long"""
1726
-
1727
1727
  class Product(BaseModel):
1728
1728
  """Product type definition"""
1729
1729
  model_config = ConfigDict(extra="allow", populate_by_name=True)
@@ -1769,7 +1769,7 @@ class ProductSearchResult(BaseModel):
1769
1769
  next_page: Union[str | None, Any] = Field(default=None)
1770
1770
  url: Union[str, Any] = Field(default=None)
1771
1771
 
1772
- class BalanceAvailableItemSourceTypes(BaseModel):
1772
+ class BalanceConnectReservedItemSourceTypes(BaseModel):
1773
1773
  """Breakdown of balance by source types"""
1774
1774
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1775
1775
 
@@ -1780,18 +1780,18 @@ class BalanceAvailableItemSourceTypes(BaseModel):
1780
1780
  fpx: Union[int | None, Any] = Field(default=None, description="Amount for fpx")
1781
1781
  """Amount for fpx"""
1782
1782
 
1783
- class BalanceAvailableItem(BaseModel):
1784
- """Nested schema for Balance.available_item"""
1783
+ class BalanceConnectReservedItem(BaseModel):
1784
+ """Nested schema for Balance.connect_reserved_item"""
1785
1785
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1786
1786
 
1787
- amount: Union[int, Any] = Field(default=None, description="Balance amount in the smallest currency unit (e.g., cents)")
1788
- """Balance amount in the smallest currency unit (e.g., cents)"""
1787
+ amount: Union[int, Any] = Field(default=None, description="Balance amount in the smallest currency unit")
1788
+ """Balance amount in the smallest currency unit"""
1789
1789
  currency: Union[str, Any] = Field(default=None, description="Three-letter ISO currency code, in lowercase")
1790
1790
  """Three-letter ISO currency code, in lowercase"""
1791
- source_types: Union[BalanceAvailableItemSourceTypes | None, Any] = Field(default=None, description="Breakdown of balance by source types")
1791
+ source_types: Union[BalanceConnectReservedItemSourceTypes | None, Any] = Field(default=None, description="Breakdown of balance by source types")
1792
1792
  """Breakdown of balance by source types"""
1793
1793
 
1794
- class BalanceInstantAvailableItemSourceTypes(BaseModel):
1794
+ class BalanceAvailableItemSourceTypes(BaseModel):
1795
1795
  """Breakdown of balance by source types"""
1796
1796
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1797
1797
 
@@ -1802,7 +1802,18 @@ class BalanceInstantAvailableItemSourceTypes(BaseModel):
1802
1802
  fpx: Union[int | None, Any] = Field(default=None, description="Amount for fpx")
1803
1803
  """Amount for fpx"""
1804
1804
 
1805
- class BalanceInstantAvailableItemNetAvailableItemSourceTypes(BaseModel):
1805
+ class BalanceAvailableItem(BaseModel):
1806
+ """Nested schema for Balance.available_item"""
1807
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
1808
+
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")
1814
+ """Breakdown of balance by source types"""
1815
+
1816
+ class BalanceRefundAndDisputePrefundingPendingItemSourceTypes(BaseModel):
1806
1817
  """Breakdown of balance by source types"""
1807
1818
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1808
1819
 
@@ -1813,31 +1824,18 @@ class BalanceInstantAvailableItemNetAvailableItemSourceTypes(BaseModel):
1813
1824
  fpx: Union[int | None, Any] = Field(default=None, description="Amount for fpx")
1814
1825
  """Amount for fpx"""
1815
1826
 
1816
- class BalanceInstantAvailableItemNetAvailableItem(BaseModel):
1817
- """Nested schema for BalanceInstantAvailableItem.net_available_item"""
1818
- model_config = ConfigDict(extra="allow", populate_by_name=True)
1819
-
1820
- amount: Union[int, Any] = Field(default=None, description="Net balance amount")
1821
- """Net balance amount"""
1822
- destination: Union[str, Any] = Field(default=None, description="ID of the external account")
1823
- """ID of the external account"""
1824
- source_types: Union[BalanceInstantAvailableItemNetAvailableItemSourceTypes | None, Any] = Field(default=None, description="Breakdown of balance by source types")
1825
- """Breakdown of balance by source types"""
1826
-
1827
- class BalanceInstantAvailableItem(BaseModel):
1828
- """Nested schema for Balance.instant_available_item"""
1827
+ class BalanceRefundAndDisputePrefundingPendingItem(BaseModel):
1828
+ """Nested schema for BalanceRefundAndDisputePrefunding.pending_item"""
1829
1829
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1830
1830
 
1831
- amount: Union[int, Any] = Field(default=None, description="Balance amount in the smallest currency unit")
1832
- """Balance amount in the smallest currency unit"""
1833
- currency: Union[str, Any] = Field(default=None, description="Three-letter ISO currency code, in lowercase")
1834
- """Three-letter ISO currency code, in lowercase"""
1835
- source_types: Union[BalanceInstantAvailableItemSourceTypes | None, Any] = Field(default=None, description="Breakdown of balance by source types")
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")
1836
1836
  """Breakdown of balance by source types"""
1837
- net_available: Union[list[BalanceInstantAvailableItemNetAvailableItem] | None, Any] = Field(default=None, description="Net balance amount available after deducting fees")
1838
- """Net balance amount available after deducting fees"""
1839
1837
 
1840
- class BalanceIssuingAvailableItemSourceTypes(BaseModel):
1838
+ class BalanceRefundAndDisputePrefundingAvailableItemSourceTypes(BaseModel):
1841
1839
  """Breakdown of balance by source types"""
1842
1840
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1843
1841
 
@@ -1848,23 +1846,25 @@ class BalanceIssuingAvailableItemSourceTypes(BaseModel):
1848
1846
  fpx: Union[int | None, Any] = Field(default=None, description="Amount for fpx")
1849
1847
  """Amount for fpx"""
1850
1848
 
1851
- class BalanceIssuingAvailableItem(BaseModel):
1852
- """Nested schema for BalanceIssuing.available_item"""
1849
+ class BalanceRefundAndDisputePrefundingAvailableItem(BaseModel):
1850
+ """Nested schema for BalanceRefundAndDisputePrefunding.available_item"""
1853
1851
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1854
1852
 
1855
1853
  amount: Union[int, Any] = Field(default=None, description="Balance amount")
1856
1854
  """Balance amount"""
1857
1855
  currency: Union[str, Any] = Field(default=None, description="Three-letter ISO currency code")
1858
1856
  """Three-letter ISO currency code"""
1859
- source_types: Union[BalanceIssuingAvailableItemSourceTypes | None, Any] = Field(default=None, description="Breakdown of balance by source types")
1857
+ source_types: Union[BalanceRefundAndDisputePrefundingAvailableItemSourceTypes | None, Any] = Field(default=None, description="Breakdown of balance by source types")
1860
1858
  """Breakdown of balance by source types"""
1861
1859
 
1862
- class BalanceIssuing(BaseModel):
1863
- """Funds that are available for use with Issuing cards"""
1860
+ class BalanceRefundAndDisputePrefunding(BaseModel):
1861
+ """Funds reserved for covering future refunds or disputes"""
1864
1862
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1865
1863
 
1866
- available: Union[list[BalanceIssuingAvailableItem], Any] = Field(default=None, description="Funds available for issuing")
1867
- """Funds available for issuing"""
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"""
1868
1868
 
1869
1869
  class BalancePendingItemSourceTypes(BaseModel):
1870
1870
  """Breakdown of balance by source types"""
@@ -1888,7 +1888,7 @@ class BalancePendingItem(BaseModel):
1888
1888
  source_types: Union[BalancePendingItemSourceTypes | None, Any] = Field(default=None, description="Breakdown of balance by source types")
1889
1889
  """Breakdown of balance by source types"""
1890
1890
 
1891
- class BalanceConnectReservedItemSourceTypes(BaseModel):
1891
+ class BalanceIssuingAvailableItemSourceTypes(BaseModel):
1892
1892
  """Breakdown of balance by source types"""
1893
1893
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1894
1894
 
@@ -1899,18 +1899,25 @@ class BalanceConnectReservedItemSourceTypes(BaseModel):
1899
1899
  fpx: Union[int | None, Any] = Field(default=None, description="Amount for fpx")
1900
1900
  """Amount for fpx"""
1901
1901
 
1902
- class BalanceConnectReservedItem(BaseModel):
1903
- """Nested schema for Balance.connect_reserved_item"""
1902
+ class BalanceIssuingAvailableItem(BaseModel):
1903
+ """Nested schema for BalanceIssuing.available_item"""
1904
1904
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1905
1905
 
1906
- amount: Union[int, Any] = Field(default=None, description="Balance amount in the smallest currency unit")
1907
- """Balance amount in the smallest currency unit"""
1908
- currency: Union[str, Any] = Field(default=None, description="Three-letter ISO currency code, in lowercase")
1909
- """Three-letter ISO currency code, in lowercase"""
1910
- source_types: Union[BalanceConnectReservedItemSourceTypes | None, Any] = Field(default=None, description="Breakdown of balance by source types")
1906
+ amount: Union[int, Any] = Field(default=None, description="Balance amount")
1907
+ """Balance amount"""
1908
+ currency: Union[str, Any] = Field(default=None, description="Three-letter ISO currency code")
1909
+ """Three-letter ISO currency code"""
1910
+ source_types: Union[BalanceIssuingAvailableItemSourceTypes | None, Any] = Field(default=None, description="Breakdown of balance by source types")
1911
1911
  """Breakdown of balance by source types"""
1912
1912
 
1913
- class BalanceRefundAndDisputePrefundingAvailableItemSourceTypes(BaseModel):
1913
+ class BalanceIssuing(BaseModel):
1914
+ """Funds that are available for use with Issuing cards"""
1915
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
1916
+
1917
+ available: Union[list[BalanceIssuingAvailableItem], Any] = Field(default=None, description="Funds available for issuing")
1918
+ """Funds available for issuing"""
1919
+
1920
+ class BalanceInstantAvailableItemNetAvailableItemSourceTypes(BaseModel):
1914
1921
  """Breakdown of balance by source types"""
1915
1922
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1916
1923
 
@@ -1921,18 +1928,18 @@ class BalanceRefundAndDisputePrefundingAvailableItemSourceTypes(BaseModel):
1921
1928
  fpx: Union[int | None, Any] = Field(default=None, description="Amount for fpx")
1922
1929
  """Amount for fpx"""
1923
1930
 
1924
- class BalanceRefundAndDisputePrefundingAvailableItem(BaseModel):
1925
- """Nested schema for BalanceRefundAndDisputePrefunding.available_item"""
1931
+ class BalanceInstantAvailableItemNetAvailableItem(BaseModel):
1932
+ """Nested schema for BalanceInstantAvailableItem.net_available_item"""
1926
1933
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1927
1934
 
1928
- amount: Union[int, Any] = Field(default=None, description="Balance amount")
1929
- """Balance amount"""
1930
- currency: Union[str, Any] = Field(default=None, description="Three-letter ISO currency code")
1931
- """Three-letter ISO currency code"""
1932
- source_types: Union[BalanceRefundAndDisputePrefundingAvailableItemSourceTypes | None, Any] = Field(default=None, description="Breakdown of balance by source types")
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")
1933
1940
  """Breakdown of balance by source types"""
1934
1941
 
1935
- class BalanceRefundAndDisputePrefundingPendingItemSourceTypes(BaseModel):
1942
+ class BalanceInstantAvailableItemSourceTypes(BaseModel):
1936
1943
  """Breakdown of balance by source types"""
1937
1944
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1938
1945
 
@@ -1943,25 +1950,18 @@ class BalanceRefundAndDisputePrefundingPendingItemSourceTypes(BaseModel):
1943
1950
  fpx: Union[int | None, Any] = Field(default=None, description="Amount for fpx")
1944
1951
  """Amount for fpx"""
1945
1952
 
1946
- class BalanceRefundAndDisputePrefundingPendingItem(BaseModel):
1947
- """Nested schema for BalanceRefundAndDisputePrefunding.pending_item"""
1953
+ class BalanceInstantAvailableItem(BaseModel):
1954
+ """Nested schema for Balance.instant_available_item"""
1948
1955
  model_config = ConfigDict(extra="allow", populate_by_name=True)
1949
1956
 
1950
- amount: Union[int, Any] = Field(default=None, description="Balance amount")
1951
- """Balance amount"""
1952
- currency: Union[str, Any] = Field(default=None, description="Three-letter ISO currency code")
1953
- """Three-letter ISO currency code"""
1954
- source_types: Union[BalanceRefundAndDisputePrefundingPendingItemSourceTypes | None, Any] = Field(default=None, description="Breakdown of balance by source types")
1957
+ amount: Union[int, Any] = Field(default=None, description="Balance amount in the smallest currency unit")
1958
+ """Balance amount in the smallest currency unit"""
1959
+ currency: Union[str, Any] = Field(default=None, description="Three-letter ISO currency code, in lowercase")
1960
+ """Three-letter ISO currency code, in lowercase"""
1961
+ source_types: Union[BalanceInstantAvailableItemSourceTypes | None, Any] = Field(default=None, description="Breakdown of balance by source types")
1955
1962
  """Breakdown of balance by source types"""
1956
-
1957
- class BalanceRefundAndDisputePrefunding(BaseModel):
1958
- """Funds reserved for covering future refunds or disputes"""
1959
- model_config = ConfigDict(extra="allow", populate_by_name=True)
1960
-
1961
- available: Union[list[BalanceRefundAndDisputePrefundingAvailableItem], Any] = Field(default=None, description="Available funds for refunds and disputes")
1962
- """Available funds for refunds and disputes"""
1963
- pending: Union[list[BalanceRefundAndDisputePrefundingPendingItem], Any] = Field(default=None, description="Pending funds for refunds and disputes")
1964
- """Pending funds for refunds and disputes"""
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
1965
 
1966
1966
  class Balance(BaseModel):
1967
1967
  """Balance type definition"""