diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION index e881245dd5..dae9a81fbb 100644 --- a/OPENAPI_VERSION +++ b/OPENAPI_VERSION @@ -1 +1 @@ -v433 \ No newline at end of file +v446 \ No newline at end of file diff --git a/types/AccountsResource.d.ts b/types/AccountsResource.d.ts index 03baf9b59b..0b50c6fbf8 100644 --- a/types/AccountsResource.d.ts +++ b/types/AccountsResource.d.ts @@ -1122,7 +1122,7 @@ declare module 'stripe' { /** * The user agent of the browser from which the account representative accepted the service agreement. */ - user_agent?: string; + user_agent?: Stripe.Emptyable; } } @@ -1255,7 +1255,7 @@ declare module 'stripe' { /** * The user agent of the browser from which the account representative accepted the service agreement. */ - user_agent?: string; + user_agent?: Stripe.Emptyable; } } } @@ -2365,7 +2365,7 @@ declare module 'stripe' { /** * The user agent of the browser from which the account representative accepted the service agreement. */ - user_agent?: string; + user_agent?: Stripe.Emptyable; } } @@ -2498,7 +2498,7 @@ declare module 'stripe' { /** * The user agent of the browser from which the account representative accepted the service agreement. */ - user_agent?: string; + user_agent?: Stripe.Emptyable; } } } diff --git a/types/ApplicationFees.d.ts b/types/ApplicationFees.d.ts index c695fdeb20..d363672a26 100644 --- a/types/ApplicationFees.d.ts +++ b/types/ApplicationFees.d.ts @@ -22,12 +22,12 @@ declare module 'stripe' { account: string | Stripe.Account; /** - * Amount earned, in %s. + * Amount earned, in cents (or local equivalent). */ amount: number; /** - * Amount in %s refunded (can be less than the amount attribute on the fee if a partial refund was issued) + * Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the fee if a partial refund was issued) */ amount_refunded: number; diff --git a/types/BalanceTransactions.d.ts b/types/BalanceTransactions.d.ts index c529bb336f..bd0088f1a6 100644 --- a/types/BalanceTransactions.d.ts +++ b/types/BalanceTransactions.d.ts @@ -20,7 +20,7 @@ declare module 'stripe' { object: 'balance_transaction'; /** - * Gross amount of the transaction, in %s. + * Gross amount of the transaction, in cents (or local equivalent). */ amount: number; @@ -50,17 +50,17 @@ declare module 'stripe' { exchange_rate: number | null; /** - * Fees (in %s) paid for this transaction. + * Fees (in cents (or local equivalent)) paid for this transaction. */ fee: number; /** - * Detailed breakdown of fees (in %s) paid for this transaction. + * Detailed breakdown of fees (in cents (or local equivalent)) paid for this transaction. */ fee_details: Array; /** - * Net amount of the transaction, in %s. + * Net amount of the transaction, in cents (or local equivalent). */ net: number; diff --git a/types/BillingPortal/ConfigurationsResource.d.ts b/types/BillingPortal/ConfigurationsResource.d.ts index dd0b835e49..e761f2a448 100644 --- a/types/BillingPortal/ConfigurationsResource.d.ts +++ b/types/BillingPortal/ConfigurationsResource.d.ts @@ -40,7 +40,7 @@ declare module 'stripe' { /** * The messaging shown to customers in the portal. */ - headline?: string; + headline?: Stripe.Emptyable; /** * A link to the business's publicly available privacy policy. @@ -289,7 +289,7 @@ declare module 'stripe' { /** * The messaging shown to customers in the portal. */ - headline?: string; + headline?: Stripe.Emptyable; /** * A link to the business's publicly available privacy policy. diff --git a/types/Charges.d.ts b/types/Charges.d.ts index 59ae4aec6b..6eb006ce48 100644 --- a/types/Charges.d.ts +++ b/types/Charges.d.ts @@ -27,12 +27,12 @@ declare module 'stripe' { amount: number; /** - * Amount in %s captured (can be less than the amount attribute on the charge if a partial capture was made). + * Amount in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made). */ amount_captured: number; /** - * Amount in %s refunded (can be less than the amount attribute on the charge if a partial refund was issued). + * Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued). */ amount_refunded: number; diff --git a/types/Checkout/Sessions.d.ts b/types/Checkout/Sessions.d.ts index 5c89f64efb..7dbc24ea01 100644 --- a/types/Checkout/Sessions.d.ts +++ b/types/Checkout/Sessions.d.ts @@ -1600,7 +1600,7 @@ declare module 'stripe' { taxability_reason: Tax.TaxabilityReason | null; /** - * The amount on which tax is calculated, in %s. + * The amount on which tax is calculated, in cents (or local equivalent). */ taxable_amount: number | null; } @@ -1742,7 +1742,7 @@ declare module 'stripe' { taxability_reason: Tax.TaxabilityReason | null; /** - * The amount on which tax is calculated, in %s. + * The amount on which tax is calculated, in cents (or local equivalent). */ taxable_amount: number | null; } diff --git a/types/Checkout/SessionsResource.d.ts b/types/Checkout/SessionsResource.d.ts index 532be47de4..8e286ac9f0 100644 --- a/types/Checkout/SessionsResource.d.ts +++ b/types/Checkout/SessionsResource.d.ts @@ -2018,7 +2018,7 @@ declare module 'stripe' { interface SubscriptionData { /** - * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. To use an application fee percent, the request must be made on behalf of another account, using the `Stripe-Account` header or an OAuth key. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). + * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. To use an application fee percent, the request must be made on behalf of another account, using the `Stripe-Account` header or an OAuth key. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ application_fee_percent?: number; @@ -2042,7 +2042,7 @@ declare module 'stripe' { /** * The subscription's description, meant to be displayable to the customer. * Use this field to optionally store an explanation of the subscription - * for rendering in Stripe hosted surfaces. + * for rendering in the [customer portal](https://stripe.com/docs/customer-management). */ description?: string; @@ -2095,7 +2095,7 @@ declare module 'stripe' { interface TransferData { /** - * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount is transferred to the destination. + * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. */ amount_percent?: number; diff --git a/types/ConnectCollectionTransfers.d.ts b/types/ConnectCollectionTransfers.d.ts index 7cec7cfa64..d2f01d580c 100644 --- a/types/ConnectCollectionTransfers.d.ts +++ b/types/ConnectCollectionTransfers.d.ts @@ -17,7 +17,7 @@ declare module 'stripe' { object: 'connect_collection_transfer'; /** - * Amount transferred, in %s. + * Amount transferred, in cents (or local equivalent). */ amount: number; diff --git a/types/Coupons.d.ts b/types/Coupons.d.ts index d8c6909f46..cbab9ef4f0 100644 --- a/types/Coupons.d.ts +++ b/types/Coupons.d.ts @@ -75,7 +75,7 @@ declare module 'stripe' { name: string | null; /** - * Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a %s100 invoice %s50 instead. + * Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a $ (or local equivalent)100 invoice $ (or local equivalent)50 instead. */ percent_off: number | null; diff --git a/types/CreditNoteLineItems.d.ts b/types/CreditNoteLineItems.d.ts index c994f82182..293f7a4921 100644 --- a/types/CreditNoteLineItems.d.ts +++ b/types/CreditNoteLineItems.d.ts @@ -17,12 +17,12 @@ declare module 'stripe' { object: 'credit_note_line_item'; /** - * The integer amount in %s representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts. + * The integer amount in cents (or local equivalent) representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts. */ amount: number; /** - * The integer amount in %s representing the amount being credited for this line item, excluding all tax and discounts. + * The integer amount in cents (or local equivalent) representing the amount being credited for this line item, excluding all tax and discounts. */ amount_excluding_tax: number | null; @@ -32,7 +32,7 @@ declare module 'stripe' { description: string | null; /** - * The integer amount in %s representing the discount being credited for this line item. + * The integer amount in cents (or local equivalent) representing the discount being credited for this line item. */ discount_amount: number; @@ -82,7 +82,7 @@ declare module 'stripe' { unit_amount_decimal: string | null; /** - * The amount in %s representing the unit amount being credited for this line item, excluding all tax and discounts. + * The amount in cents (or local equivalent) representing the unit amount being credited for this line item, excluding all tax and discounts. */ unit_amount_excluding_tax: string | null; } @@ -90,7 +90,7 @@ declare module 'stripe' { namespace CreditNoteLineItem { interface DiscountAmount { /** - * The amount, in %s, of the discount. + * The amount, in cents (or local equivalent), of the discount. */ amount: number; @@ -102,7 +102,7 @@ declare module 'stripe' { interface TaxAmount { /** - * The amount, in %s, of the tax. + * The amount, in cents (or local equivalent), of the tax. */ amount: number; @@ -122,7 +122,7 @@ declare module 'stripe' { taxability_reason: TaxAmount.TaxabilityReason | null; /** - * The amount on which tax is calculated, in %s. + * The amount on which tax is calculated, in cents (or local equivalent). */ taxable_amount: number | null; } diff --git a/types/CreditNotes.d.ts b/types/CreditNotes.d.ts index 2fb7ad0f5d..e09a5a8522 100644 --- a/types/CreditNotes.d.ts +++ b/types/CreditNotes.d.ts @@ -19,7 +19,7 @@ declare module 'stripe' { object: 'credit_note'; /** - * The integer amount in %s representing the total amount of the credit note, including tax. + * The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax. */ amount: number; @@ -52,7 +52,7 @@ declare module 'stripe' { | null; /** - * The integer amount in %s representing the total amount of discount that was credited. + * The integer amount in cents (or local equivalent) representing the total amount of discount that was credited. */ discount_amount: number; @@ -127,12 +127,12 @@ declare module 'stripe' { status: CreditNote.Status; /** - * The integer amount in %s representing the amount of the credit note, excluding exclusive tax and invoice level discounts. + * The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts. */ subtotal: number; /** - * The integer amount in %s representing the amount of the credit note, excluding all tax and invoice level discounts. + * The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts. */ subtotal_excluding_tax: number | null; @@ -142,12 +142,12 @@ declare module 'stripe' { tax_amounts: Array; /** - * The integer amount in %s representing the total amount of the credit note, including tax and all discount. + * The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount. */ total: number; /** - * The integer amount in %s representing the total amount of the credit note, excluding tax, but including discounts. + * The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts. */ total_excluding_tax: number | null; @@ -165,7 +165,7 @@ declare module 'stripe' { namespace CreditNote { interface DiscountAmount { /** - * The amount, in %s, of the discount. + * The amount, in cents (or local equivalent), of the discount. */ amount: number; @@ -228,7 +228,7 @@ declare module 'stripe' { taxability_reason: Tax.TaxabilityReason | null; /** - * The amount on which tax is calculated, in %s. + * The amount on which tax is calculated, in cents (or local equivalent). */ taxable_amount: number | null; } @@ -260,7 +260,7 @@ declare module 'stripe' { interface TaxAmount { /** - * The amount, in %s, of the tax. + * The amount, in cents (or local equivalent), of the tax. */ amount: number; @@ -280,7 +280,7 @@ declare module 'stripe' { taxability_reason: TaxAmount.TaxabilityReason | null; /** - * The amount on which tax is calculated, in %s. + * The amount on which tax is calculated, in cents (or local equivalent). */ taxable_amount: number | null; } diff --git a/types/FeeRefunds.d.ts b/types/FeeRefunds.d.ts index 4c86313781..7d33feb85d 100644 --- a/types/FeeRefunds.d.ts +++ b/types/FeeRefunds.d.ts @@ -21,7 +21,7 @@ declare module 'stripe' { object: 'fee_refund'; /** - * Amount, in %s. + * Amount, in cents (or local equivalent). */ amount: number; diff --git a/types/InvoiceLineItems.d.ts b/types/InvoiceLineItems.d.ts index 44de5ed9ba..c855408511 100644 --- a/types/InvoiceLineItems.d.ts +++ b/types/InvoiceLineItems.d.ts @@ -17,12 +17,12 @@ declare module 'stripe' { object: 'line_item'; /** - * The amount, in %s. + * The amount, in cents (or local equivalent). */ amount: number; /** - * The integer amount in %s representing the amount for this line item, excluding all tax and discounts. + * The integer amount in cents (or local equivalent) representing the amount for this line item, excluding all tax and discounts. */ amount_excluding_tax: number | null; @@ -119,7 +119,7 @@ declare module 'stripe' { type: InvoiceLineItem.Type; /** - * The amount in %s representing the unit amount for this line item, excluding all tax and discounts. + * The amount in cents (or local equivalent) representing the unit amount for this line item, excluding all tax and discounts. */ unit_amount_excluding_tax: string | null; } @@ -127,7 +127,7 @@ declare module 'stripe' { namespace InvoiceLineItem { interface DiscountAmount { /** - * The amount, in %s, of the discount. + * The amount, in cents (or local equivalent), of the discount. */ amount: number; @@ -172,7 +172,7 @@ declare module 'stripe' { interface TaxAmount { /** - * The amount, in %s, of the tax. + * The amount, in cents (or local equivalent), of the tax. */ amount: number; @@ -192,7 +192,7 @@ declare module 'stripe' { taxability_reason: TaxAmount.TaxabilityReason | null; /** - * The amount on which tax is calculated, in %s. + * The amount on which tax is calculated, in cents (or local equivalent). */ taxable_amount: number | null; } diff --git a/types/Invoices.d.ts b/types/Invoices.d.ts index 2a28a3e4cf..ab445c31ba 100644 --- a/types/Invoices.d.ts +++ b/types/Invoices.d.ts @@ -70,12 +70,12 @@ declare module 'stripe' { amount_due: number; /** - * The amount, in %s, that was paid. + * The amount, in cents (or local equivalent), that was paid. */ amount_paid: number; /** - * The difference between amount_due and amount_paid, in %s. + * The difference between amount_due and amount_paid, in cents (or local equivalent). */ amount_remaining: number; @@ -94,7 +94,7 @@ declare module 'stripe' { | null; /** - * The fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid. + * The fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid. */ application_fee_amount: number | null; @@ -378,6 +378,11 @@ declare module 'stripe' { */ subscription: string | Stripe.Subscription | null; + /** + * Details about the subscription that created this invoice. + */ + subscription_details?: Invoice.SubscriptionDetails | null; + /** * Only set for upcoming invoices that preview prorations. The time used to calculate prorations. */ @@ -389,7 +394,7 @@ declare module 'stripe' { subtotal: number; /** - * The integer amount in %s representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated + * The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated */ subtotal_excluding_tax: number | null; @@ -416,7 +421,7 @@ declare module 'stripe' { total_discount_amounts: Array | null; /** - * The integer amount in %s representing the total amount of the invoice including all discounts but excluding all tax. + * The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax. */ total_excluding_tax: number | null; @@ -1111,7 +1116,7 @@ declare module 'stripe' { taxability_reason: Tax.TaxabilityReason | null; /** - * The amount on which tax is calculated, in %s. + * The amount on which tax is calculated, in cents (or local equivalent). */ taxable_amount: number | null; } @@ -1187,6 +1192,13 @@ declare module 'stripe' { voided_at: number | null; } + interface SubscriptionDetails { + /** + * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will reflect the metadata of the subscription at the time of invoice creation. *Note: This attribute is populated only for invoices created on or after June 29, 2023.* + */ + metadata?: Stripe.Metadata | null; + } + interface ThresholdReason { /** * The total invoice amount threshold boundary if it triggered the threshold invoice. @@ -1215,7 +1227,7 @@ declare module 'stripe' { interface TotalDiscountAmount { /** - * The amount, in %s, of the discount. + * The amount, in cents (or local equivalent), of the discount. */ amount: number; @@ -1227,7 +1239,7 @@ declare module 'stripe' { interface TotalTaxAmount { /** - * The amount, in %s, of the tax. + * The amount, in cents (or local equivalent), of the tax. */ amount: number; @@ -1247,7 +1259,7 @@ declare module 'stripe' { taxability_reason: TotalTaxAmount.TaxabilityReason | null; /** - * The amount on which tax is calculated, in %s. + * The amount on which tax is calculated, in cents (or local equivalent). */ taxable_amount: number | null; } @@ -1273,7 +1285,7 @@ declare module 'stripe' { interface TransferData { /** - * The amount in %s that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination. + * The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination. */ amount: number | null; diff --git a/types/InvoicesResource.d.ts b/types/InvoicesResource.d.ts index 6327c71a50..31bcfc6bb2 100644 --- a/types/InvoicesResource.d.ts +++ b/types/InvoicesResource.d.ts @@ -201,7 +201,7 @@ declare module 'stripe' { /** * ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set. */ - default_mandate?: string; + default_mandate?: Stripe.Emptyable; /** * Payment-method-specific configuration to provide to the invoice's PaymentIntent. @@ -609,7 +609,7 @@ declare module 'stripe' { /** * Recipient phone (including extension) */ - phone?: string; + phone?: Stripe.Emptyable; } interface TransferData { @@ -676,7 +676,7 @@ declare module 'stripe' { /** * ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source. */ - default_source?: string; + default_source?: Stripe.Emptyable; /** * The tax rates that will apply to any line item that does not have `tax_rates` set. Pass an empty string to remove previously-defined tax rates. @@ -794,7 +794,7 @@ declare module 'stripe' { /** * ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set. */ - default_mandate?: string; + default_mandate?: Stripe.Emptyable; /** * Payment-method-specific configuration to provide to the invoice's PaymentIntent. @@ -1197,7 +1197,7 @@ declare module 'stripe' { /** * Recipient phone (including extension) */ - phone?: string; + phone?: Stripe.Emptyable; } interface TransferData { @@ -1288,12 +1288,12 @@ declare module 'stripe' { currency?: string; /** - * The identifier of the customer whose upcoming invoice you'd like to retrieve. + * The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. */ customer?: string; /** - * Details about the customer you want to invoice or overrides for an existing customer. + * Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. */ customer_details?: InvoiceListUpcomingLinesParams.CustomerDetails; @@ -1833,7 +1833,7 @@ declare module 'stripe' { /** * ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the payment_method param or the invoice's default_payment_method or default_source, if set. */ - mandate?: string; + mandate?: Stripe.Emptyable; /** * Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `true` (off-session). @@ -1873,12 +1873,12 @@ declare module 'stripe' { currency?: string; /** - * The identifier of the customer whose upcoming invoice you'd like to retrieve. + * The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. */ customer?: string; /** - * Details about the customer you want to invoice or overrides for an existing customer. + * Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. */ customer_details?: InvoiceRetrieveUpcomingParams.CustomerDetails; diff --git a/types/Issuing/CardholdersResource.d.ts b/types/Issuing/CardholdersResource.d.ts index 5a144a1a29..43012ec55a 100644 --- a/types/Issuing/CardholdersResource.d.ts +++ b/types/Issuing/CardholdersResource.d.ts @@ -122,7 +122,7 @@ declare module 'stripe' { card_issuing?: Individual.CardIssuing; /** - * The date of birth of this cardholder. + * The date of birth of this cardholder. Cardholders must be older than 13 years old. */ dob?: Individual.Dob; @@ -165,7 +165,7 @@ declare module 'stripe' { /** * The user agent of the browser from which the cardholder accepted the Authorized User Terms. */ - user_agent?: string; + user_agent?: Stripe.Emptyable; } } @@ -1273,7 +1273,7 @@ declare module 'stripe' { card_issuing?: Individual.CardIssuing; /** - * The date of birth of this cardholder. + * The date of birth of this cardholder. Cardholders must be older than 13 years old. */ dob?: Individual.Dob; @@ -1316,7 +1316,7 @@ declare module 'stripe' { /** * The user agent of the browser from which the cardholder accepted the Authorized User Terms. */ - user_agent?: string; + user_agent?: Stripe.Emptyable; } } diff --git a/types/Issuing/DisputesResource.d.ts b/types/Issuing/DisputesResource.d.ts index 91bc308980..aed35226b6 100644 --- a/types/Issuing/DisputesResource.d.ts +++ b/types/Issuing/DisputesResource.d.ts @@ -102,7 +102,7 @@ declare module 'stripe' { /** * Reason for canceling the order. */ - cancellation_reason?: string; + cancellation_reason?: Stripe.Emptyable; /** * Date when the cardholder expected to receive the product. @@ -112,12 +112,12 @@ declare module 'stripe' { /** * Explanation of why the cardholder is disputing this transaction. */ - explanation?: string; + explanation?: Stripe.Emptyable; /** * Description of the merchandise or service that was purchased. */ - product_description?: string; + product_description?: Stripe.Emptyable; /** * Whether the product was a merchandise or service. @@ -165,7 +165,7 @@ declare module 'stripe' { /** * Explanation of why the cardholder is disputing this transaction. */ - explanation?: string; + explanation?: Stripe.Emptyable; /** * Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one. @@ -182,7 +182,7 @@ declare module 'stripe' { /** * Explanation of why the cardholder is disputing this transaction. */ - explanation?: string; + explanation?: Stripe.Emptyable; } interface MerchandiseNotAsDescribed { @@ -194,7 +194,7 @@ declare module 'stripe' { /** * Explanation of why the cardholder is disputing this transaction. */ - explanation?: string; + explanation?: Stripe.Emptyable; /** * Date when the product was received. @@ -204,7 +204,7 @@ declare module 'stripe' { /** * Description of the cardholder's attempt to return the product. */ - return_description?: string; + return_description?: Stripe.Emptyable; /** * Result of cardholder's attempt to return the product. @@ -237,12 +237,12 @@ declare module 'stripe' { /** * Explanation of why the cardholder is disputing this transaction. */ - explanation?: string; + explanation?: Stripe.Emptyable; /** * Description of the merchandise or service that was purchased. */ - product_description?: string; + product_description?: Stripe.Emptyable; /** * Whether the product was a merchandise or service. @@ -263,12 +263,12 @@ declare module 'stripe' { /** * Explanation of why the cardholder is disputing this transaction. */ - explanation?: string; + explanation?: Stripe.Emptyable; /** * Description of the merchandise or service that was purchased. */ - product_description?: string; + product_description?: Stripe.Emptyable; /** * Whether the product was a merchandise or service. @@ -303,12 +303,12 @@ declare module 'stripe' { /** * Reason for canceling the order. */ - cancellation_reason?: string; + cancellation_reason?: Stripe.Emptyable; /** * Explanation of why the cardholder is disputing this transaction. */ - explanation?: string; + explanation?: Stripe.Emptyable; /** * Date when the product was received. @@ -421,7 +421,7 @@ declare module 'stripe' { /** * Reason for canceling the order. */ - cancellation_reason?: string; + cancellation_reason?: Stripe.Emptyable; /** * Date when the cardholder expected to receive the product. @@ -431,12 +431,12 @@ declare module 'stripe' { /** * Explanation of why the cardholder is disputing this transaction. */ - explanation?: string; + explanation?: Stripe.Emptyable; /** * Description of the merchandise or service that was purchased. */ - product_description?: string; + product_description?: Stripe.Emptyable; /** * Whether the product was a merchandise or service. @@ -484,7 +484,7 @@ declare module 'stripe' { /** * Explanation of why the cardholder is disputing this transaction. */ - explanation?: string; + explanation?: Stripe.Emptyable; /** * Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one. @@ -501,7 +501,7 @@ declare module 'stripe' { /** * Explanation of why the cardholder is disputing this transaction. */ - explanation?: string; + explanation?: Stripe.Emptyable; } interface MerchandiseNotAsDescribed { @@ -513,7 +513,7 @@ declare module 'stripe' { /** * Explanation of why the cardholder is disputing this transaction. */ - explanation?: string; + explanation?: Stripe.Emptyable; /** * Date when the product was received. @@ -523,7 +523,7 @@ declare module 'stripe' { /** * Description of the cardholder's attempt to return the product. */ - return_description?: string; + return_description?: Stripe.Emptyable; /** * Result of cardholder's attempt to return the product. @@ -556,12 +556,12 @@ declare module 'stripe' { /** * Explanation of why the cardholder is disputing this transaction. */ - explanation?: string; + explanation?: Stripe.Emptyable; /** * Description of the merchandise or service that was purchased. */ - product_description?: string; + product_description?: Stripe.Emptyable; /** * Whether the product was a merchandise or service. @@ -582,12 +582,12 @@ declare module 'stripe' { /** * Explanation of why the cardholder is disputing this transaction. */ - explanation?: string; + explanation?: Stripe.Emptyable; /** * Description of the merchandise or service that was purchased. */ - product_description?: string; + product_description?: Stripe.Emptyable; /** * Whether the product was a merchandise or service. @@ -622,12 +622,12 @@ declare module 'stripe' { /** * Reason for canceling the order. */ - cancellation_reason?: string; + cancellation_reason?: Stripe.Emptyable; /** * Explanation of why the cardholder is disputing this transaction. */ - explanation?: string; + explanation?: Stripe.Emptyable; /** * Date when the product was received. diff --git a/types/LineItems.d.ts b/types/LineItems.d.ts index 4d1d3bddf2..69caa2683b 100644 --- a/types/LineItems.d.ts +++ b/types/LineItems.d.ts @@ -102,7 +102,7 @@ declare module 'stripe' { taxability_reason: Tax.TaxabilityReason | null; /** - * The amount on which tax is calculated, in %s. + * The amount on which tax is calculated, in cents (or local equivalent). */ taxable_amount: number | null; } diff --git a/types/PaymentIntents.d.ts b/types/PaymentIntents.d.ts index 4f57c157d1..94e0dcb19a 100644 --- a/types/PaymentIntents.d.ts +++ b/types/PaymentIntents.d.ts @@ -1936,6 +1936,11 @@ declare module 'stripe' { interface UsBankAccount { financial_connections?: UsBankAccount.FinancialConnections; + /** + * Preferred transaction settlement speed + */ + preferred_settlement_speed?: UsBankAccount.PreferredSettlementSpeed; + /** * Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -1972,6 +1977,8 @@ declare module 'stripe' { | 'transactions'; } + type PreferredSettlementSpeed = 'fastest' | 'standard'; + type SetupFutureUsage = 'none' | 'off_session' | 'on_session'; type VerificationMethod = 'automatic' | 'instant' | 'microdeposits'; diff --git a/types/PaymentIntentsResource.d.ts b/types/PaymentIntentsResource.d.ts index ef0665c3f7..1318bb0a3c 100644 --- a/types/PaymentIntentsResource.d.ts +++ b/types/PaymentIntentsResource.d.ts @@ -479,12 +479,12 @@ declare module 'stripe' { /** * Full name. */ - name?: string; + name?: Stripe.Emptyable; /** * Billing phone number (including extension). */ - phone?: string; + phone?: Stripe.Emptyable; } interface Blik {} @@ -1601,7 +1601,7 @@ declare module 'stripe' { /** * An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores. Must not consist of only zeroes and could be rejected in case of insufficient uniqueness. We recommend to use the customer's phone number. */ - confirmation_number?: string; + confirmation_number?: Stripe.Emptyable; /** * The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. Defaults to 3 days. @@ -1616,7 +1616,7 @@ declare module 'stripe' { /** * A product descriptor of up to 22 characters, which will appear to customers at the convenience store. */ - product_description?: string; + product_description?: Stripe.Emptyable; /** * Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1872,6 +1872,13 @@ declare module 'stripe' { */ networks?: UsBankAccount.Networks; + /** + * Preferred transaction settlement speed + */ + preferred_settlement_speed?: Stripe.Emptyable< + UsBankAccount.PreferredSettlementSpeed + >; + /** * Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -1921,6 +1928,8 @@ declare module 'stripe' { type Requested = 'ach' | 'us_domestic_wire'; } + type PreferredSettlementSpeed = 'fastest' | 'standard'; + type SetupFutureUsage = 'none' | 'off_session' | 'on_session'; type VerificationMethod = 'automatic' | 'instant' | 'microdeposits'; @@ -2392,12 +2401,12 @@ declare module 'stripe' { /** * Full name. */ - name?: string; + name?: Stripe.Emptyable; /** * Billing phone number (including extension). */ - phone?: string; + phone?: Stripe.Emptyable; } interface Blik {} @@ -3514,7 +3523,7 @@ declare module 'stripe' { /** * An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores. Must not consist of only zeroes and could be rejected in case of insufficient uniqueness. We recommend to use the customer's phone number. */ - confirmation_number?: string; + confirmation_number?: Stripe.Emptyable; /** * The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. Defaults to 3 days. @@ -3529,7 +3538,7 @@ declare module 'stripe' { /** * A product descriptor of up to 22 characters, which will appear to customers at the convenience store. */ - product_description?: string; + product_description?: Stripe.Emptyable; /** * Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -3785,6 +3794,13 @@ declare module 'stripe' { */ networks?: UsBankAccount.Networks; + /** + * Preferred transaction settlement speed + */ + preferred_settlement_speed?: Stripe.Emptyable< + UsBankAccount.PreferredSettlementSpeed + >; + /** * Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -3834,6 +3850,8 @@ declare module 'stripe' { type Requested = 'ach' | 'us_domestic_wire'; } + type PreferredSettlementSpeed = 'fastest' | 'standard'; + type SetupFutureUsage = 'none' | 'off_session' | 'on_session'; type VerificationMethod = 'automatic' | 'instant' | 'microdeposits'; @@ -4445,12 +4463,12 @@ declare module 'stripe' { /** * Full name. */ - name?: string; + name?: Stripe.Emptyable; /** * Billing phone number (including extension). */ - phone?: string; + phone?: Stripe.Emptyable; } interface Blik {} @@ -5567,7 +5585,7 @@ declare module 'stripe' { /** * An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores. Must not consist of only zeroes and could be rejected in case of insufficient uniqueness. We recommend to use the customer's phone number. */ - confirmation_number?: string; + confirmation_number?: Stripe.Emptyable; /** * The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. Defaults to 3 days. @@ -5582,7 +5600,7 @@ declare module 'stripe' { /** * A product descriptor of up to 22 characters, which will appear to customers at the convenience store. */ - product_description?: string; + product_description?: Stripe.Emptyable; /** * Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -5838,6 +5856,13 @@ declare module 'stripe' { */ networks?: UsBankAccount.Networks; + /** + * Preferred transaction settlement speed + */ + preferred_settlement_speed?: Stripe.Emptyable< + UsBankAccount.PreferredSettlementSpeed + >; + /** * Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -5887,6 +5912,8 @@ declare module 'stripe' { type Requested = 'ach' | 'us_domestic_wire'; } + type PreferredSettlementSpeed = 'fastest' | 'standard'; + type SetupFutureUsage = 'none' | 'off_session' | 'on_session'; type VerificationMethod = 'automatic' | 'instant' | 'microdeposits'; diff --git a/types/PaymentLinks.d.ts b/types/PaymentLinks.d.ts index a88a2b7252..97d3a9711d 100644 --- a/types/PaymentLinks.d.ts +++ b/types/PaymentLinks.d.ts @@ -38,7 +38,7 @@ declare module 'stripe' { application_fee_amount: number | null; /** - * This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. + * This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. */ application_fee_percent: number | null; @@ -737,7 +737,7 @@ declare module 'stripe' { interface TransferData { /** - * The amount in %s that will be transferred to the destination account. By default, the entire amount is transferred to the destination. + * The amount in cents (or local equivalent) that will be transferred to the destination account. By default, the entire amount is transferred to the destination. */ amount: number | null; diff --git a/types/PaymentLinksResource.d.ts b/types/PaymentLinksResource.d.ts index 53a63a85e8..cd71dbf406 100644 --- a/types/PaymentLinksResource.d.ts +++ b/types/PaymentLinksResource.d.ts @@ -24,7 +24,7 @@ declare module 'stripe' { application_fee_amount?: number; /** - * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field. + * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field. */ application_fee_percent?: number; diff --git a/types/PaymentMethodsResource.d.ts b/types/PaymentMethodsResource.d.ts index a3f9b424fc..1d911788b8 100644 --- a/types/PaymentMethodsResource.d.ts +++ b/types/PaymentMethodsResource.d.ts @@ -263,12 +263,12 @@ declare module 'stripe' { /** * Full name. */ - name?: string; + name?: Stripe.Emptyable; /** * Billing phone number (including extension). */ - phone?: string; + phone?: Stripe.Emptyable; } interface Blik {} @@ -694,12 +694,12 @@ declare module 'stripe' { /** * Full name. */ - name?: string; + name?: Stripe.Emptyable; /** * Billing phone number (including extension). */ - phone?: string; + phone?: Stripe.Emptyable; } interface Blik {} diff --git a/types/Payouts.d.ts b/types/Payouts.d.ts index c7a1a9c933..aed011602e 100644 --- a/types/Payouts.d.ts +++ b/types/Payouts.d.ts @@ -24,7 +24,7 @@ declare module 'stripe' { object: 'payout'; /** - * Amount (in %s) to be transferred to your bank account or debit card. + * Amount (in cents (or local equivalent)) to be transferred to your bank account or debit card. */ amount: number; diff --git a/types/Plans.d.ts b/types/Plans.d.ts index 81ebb5ac7e..1a66f60286 100644 --- a/types/Plans.d.ts +++ b/types/Plans.d.ts @@ -34,12 +34,12 @@ declare module 'stripe' { aggregate_usage: Plan.AggregateUsage | null; /** - * The unit amount in %s to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. + * The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. */ amount: number | null; /** - * The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. + * The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. */ amount_decimal: string | null; diff --git a/types/Prices.d.ts b/types/Prices.d.ts index 3bcb1a447e..da0ae66145 100644 --- a/types/Prices.d.ts +++ b/types/Prices.d.ts @@ -111,12 +111,12 @@ declare module 'stripe' { type: Price.Type; /** - * The unit amount in %s to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. + * The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. */ unit_amount: number | null; /** - * The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. + * The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. */ unit_amount_decimal: string | null; } @@ -141,12 +141,12 @@ declare module 'stripe' { tiers?: Array; /** - * The unit amount in %s to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. + * The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. */ unit_amount: number | null; /** - * The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. + * The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. */ unit_amount_decimal: string | null; } diff --git a/types/ProductsResource.d.ts b/types/ProductsResource.d.ts index b666c96bb1..3ea85151c8 100644 --- a/types/ProductsResource.d.ts +++ b/types/ProductsResource.d.ts @@ -278,7 +278,7 @@ declare module 'stripe' { /** * A short one-line description of the product, meant to be displayable to the customer. May only be set if `type=good`. */ - caption?: string; + caption?: Stripe.Emptyable; /** * An array of Connect application names or identifiers that should not be able to order the SKUs for this product. May only be set if `type=good`. @@ -293,7 +293,7 @@ declare module 'stripe' { /** * The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes. */ - description?: string; + description?: Stripe.Emptyable; /** * Specifies which fields in the response should be expanded. @@ -343,7 +343,7 @@ declare module 'stripe' { /** * A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. May only be set if `type=service`. */ - unit_label?: string; + unit_label?: Stripe.Emptyable; /** * A URL of a publicly-accessible webpage for this product. diff --git a/types/Quotes.d.ts b/types/Quotes.d.ts index cbf737fcc8..f1fe00ed24 100644 --- a/types/Quotes.d.ts +++ b/types/Quotes.d.ts @@ -42,7 +42,7 @@ declare module 'stripe' { application_fee_amount: number | null; /** - * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. Only applicable if there are line items with recurring prices on the quote. + * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. Only applicable if there are line items with recurring prices on the quote. */ application_fee_percent: number | null; @@ -295,7 +295,7 @@ declare module 'stripe' { taxability_reason: Tax.TaxabilityReason | null; /** - * The amount on which tax is calculated, in %s. + * The amount on which tax is calculated, in cents (or local equivalent). */ taxable_amount: number | null; } @@ -412,7 +412,7 @@ declare module 'stripe' { taxability_reason: Tax.TaxabilityReason | null; /** - * The amount on which tax is calculated, in %s. + * The amount on which tax is calculated, in cents (or local equivalent). */ taxable_amount: number | null; } @@ -565,7 +565,7 @@ declare module 'stripe' { taxability_reason: Tax.TaxabilityReason | null; /** - * The amount on which tax is calculated, in %s. + * The amount on which tax is calculated, in cents (or local equivalent). */ taxable_amount: number | null; } @@ -596,12 +596,12 @@ declare module 'stripe' { interface TransferData { /** - * The amount in %s that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination. + * The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination. */ amount: number | null; /** - * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount will be transferred to the destination. + * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount will be transferred to the destination. */ amount_percent: number | null; diff --git a/types/QuotesResource.d.ts b/types/QuotesResource.d.ts index 75abef7d99..dce061cf63 100644 --- a/types/QuotesResource.d.ts +++ b/types/QuotesResource.d.ts @@ -9,7 +9,7 @@ declare module 'stripe' { application_fee_amount?: Stripe.Emptyable; /** - * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field. + * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field. */ application_fee_percent?: Stripe.Emptyable; @@ -36,7 +36,7 @@ declare module 'stripe' { /** * A description that will be displayed on the quote PDF. If no value is passed, the default description configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. */ - description?: string; + description?: Stripe.Emptyable; /** * The discounts applied to the quote. You can only set up to one discount. @@ -56,7 +56,7 @@ declare module 'stripe' { /** * A footer that will be displayed on the quote PDF. If no value is passed, the default footer configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. */ - footer?: string; + footer?: Stripe.Emptyable; /** * Clone an existing quote. The new quote will be created in `status=draft`. When using this parameter, you cannot specify any other parameters except for `expires_at`. @@ -66,7 +66,7 @@ declare module 'stripe' { /** * A header that will be displayed on the quote PDF. If no value is passed, the default header configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. */ - header?: string; + header?: Stripe.Emptyable; /** * All invoices will be billed using the specified settings. @@ -245,7 +245,7 @@ declare module 'stripe' { amount?: number; /** - * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount is transferred to the destination. There must be at least 1 line item with a recurring price to use this field. + * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. There must be at least 1 line item with a recurring price to use this field. */ amount_percent?: number; @@ -270,7 +270,7 @@ declare module 'stripe' { application_fee_amount?: Stripe.Emptyable; /** - * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field. + * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field. */ application_fee_percent?: Stripe.Emptyable; @@ -297,7 +297,7 @@ declare module 'stripe' { /** * A description that will be displayed on the quote PDF. */ - description?: string; + description?: Stripe.Emptyable; /** * The discounts applied to the quote. You can only set up to one discount. @@ -317,12 +317,12 @@ declare module 'stripe' { /** * A footer that will be displayed on the quote PDF. */ - footer?: string; + footer?: Stripe.Emptyable; /** * A header that will be displayed on the quote PDF. */ - header?: string; + header?: Stripe.Emptyable; /** * All invoices will be billed using the specified settings. @@ -469,7 +469,7 @@ declare module 'stripe' { /** * The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription. */ - description?: string; + description?: Stripe.Emptyable; /** * When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value `current_period_end` can be provided to update a subscription at the end of its current period. The `effective_date` is ignored if it is in the past when the quote is accepted. @@ -489,7 +489,7 @@ declare module 'stripe' { amount?: number; /** - * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount is transferred to the destination. There must be at least 1 line item with a recurring price to use this field. + * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. There must be at least 1 line item with a recurring price to use this field. */ amount_percent?: number; diff --git a/types/Radar/ValueLists.d.ts b/types/Radar/ValueLists.d.ts index 13f6a64ac5..c1231307cb 100644 --- a/types/Radar/ValueLists.d.ts +++ b/types/Radar/ValueLists.d.ts @@ -37,7 +37,7 @@ declare module 'stripe' { deleted?: void; /** - * The type of items in the value list. One of `card_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, or `customer_id`. + * The type of items in the value list. One of `card_fingerprint`, `us_bank_account_fingerprint`, `sepa_debit_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, or `customer_id`. */ item_type: ValueList.ItemType; @@ -71,7 +71,9 @@ declare module 'stripe' { | 'customer_id' | 'email' | 'ip_address' - | 'string'; + | 'sepa_debit_fingerprint' + | 'string' + | 'us_bank_account_fingerprint'; } /** diff --git a/types/Radar/ValueListsResource.d.ts b/types/Radar/ValueListsResource.d.ts index ed7a799ff8..9a3d9ea18e 100644 --- a/types/Radar/ValueListsResource.d.ts +++ b/types/Radar/ValueListsResource.d.ts @@ -20,7 +20,7 @@ declare module 'stripe' { expand?: Array; /** - * Type of the items in the value list. One of `card_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, or `customer_id`. Use `string` if the item type is unknown or mixed. + * Type of the items in the value list. One of `card_fingerprint`, `us_bank_account_fingerprint`, `sepa_debit_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, or `customer_id`. Use `string` if the item type is unknown or mixed. */ item_type?: ValueListCreateParams.ItemType; @@ -39,7 +39,9 @@ declare module 'stripe' { | 'customer_id' | 'email' | 'ip_address' - | 'string'; + | 'sepa_debit_fingerprint' + | 'string' + | 'us_bank_account_fingerprint'; } interface ValueListRetrieveParams { diff --git a/types/Refunds.d.ts b/types/Refunds.d.ts index e083d2193b..de9dea55c7 100644 --- a/types/Refunds.d.ts +++ b/types/Refunds.d.ts @@ -21,7 +21,7 @@ declare module 'stripe' { object: 'refund'; /** - * Amount, in %s. + * Amount, in cents (or local equivalent). */ amount: number; diff --git a/types/SetupIntentsResource.d.ts b/types/SetupIntentsResource.d.ts index 238ec3e901..8bf99a2a81 100644 --- a/types/SetupIntentsResource.d.ts +++ b/types/SetupIntentsResource.d.ts @@ -412,12 +412,12 @@ declare module 'stripe' { /** * Full name. */ - name?: string; + name?: Stripe.Emptyable; /** * Billing phone number (including extension). */ - phone?: string; + phone?: Stripe.Emptyable; } interface Blik {} @@ -1326,12 +1326,12 @@ declare module 'stripe' { /** * Full name. */ - name?: string; + name?: Stripe.Emptyable; /** * Billing phone number (including extension). */ - phone?: string; + phone?: Stripe.Emptyable; } interface Blik {} @@ -2327,12 +2327,12 @@ declare module 'stripe' { /** * Full name. */ - name?: string; + name?: Stripe.Emptyable; /** * Billing phone number (including extension). */ - phone?: string; + phone?: Stripe.Emptyable; } interface Blik {} diff --git a/types/SubscriptionSchedules.d.ts b/types/SubscriptionSchedules.d.ts index 4f6c59298b..3cc2412c23 100644 --- a/types/SubscriptionSchedules.d.ts +++ b/types/SubscriptionSchedules.d.ts @@ -115,7 +115,7 @@ declare module 'stripe' { interface DefaultSettings { /** - * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account during this phase of the schedule. + * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account during this phase of the schedule. */ application_fee_percent: number | null; @@ -195,7 +195,7 @@ declare module 'stripe' { interface TransferData { /** - * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount is transferred to the destination. + * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. */ amount_percent: number | null; @@ -215,7 +215,7 @@ declare module 'stripe' { add_invoice_items: Array; /** - * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account during this phase of the schedule. + * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account during this phase of the schedule. */ application_fee_percent: number | null; @@ -403,7 +403,7 @@ declare module 'stripe' { interface TransferData { /** - * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount is transferred to the destination. + * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. */ amount_percent: number | null; diff --git a/types/SubscriptionSchedulesResource.d.ts b/types/SubscriptionSchedulesResource.d.ts index 28ff4e5c1a..d9365da30f 100644 --- a/types/SubscriptionSchedulesResource.d.ts +++ b/types/SubscriptionSchedulesResource.d.ts @@ -47,7 +47,7 @@ declare module 'stripe' { namespace SubscriptionScheduleCreateParams { interface DefaultSettings { /** - * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). + * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ application_fee_percent?: number; @@ -81,7 +81,7 @@ declare module 'stripe' { /** * Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription. */ - description?: string; + description?: Stripe.Emptyable; /** * All invoices will be billed using the specified settings. @@ -132,7 +132,7 @@ declare module 'stripe' { interface TransferData { /** - * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount is transferred to the destination. + * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. */ amount_percent?: number; @@ -152,7 +152,7 @@ declare module 'stripe' { add_invoice_items?: Array; /** - * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). + * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ application_fee_percent?: number; @@ -199,7 +199,7 @@ declare module 'stripe' { /** * Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription. */ - description?: string; + description?: Stripe.Emptyable; /** * The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set. @@ -443,7 +443,7 @@ declare module 'stripe' { interface TransferData { /** - * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount is transferred to the destination. + * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. */ amount_percent?: number; @@ -497,7 +497,7 @@ declare module 'stripe' { namespace SubscriptionScheduleUpdateParams { interface DefaultSettings { /** - * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). + * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ application_fee_percent?: number; @@ -531,7 +531,7 @@ declare module 'stripe' { /** * Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription. */ - description?: string; + description?: Stripe.Emptyable; /** * All invoices will be billed using the specified settings. @@ -582,7 +582,7 @@ declare module 'stripe' { interface TransferData { /** - * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount is transferred to the destination. + * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. */ amount_percent?: number; @@ -602,7 +602,7 @@ declare module 'stripe' { add_invoice_items?: Array; /** - * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). + * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ application_fee_percent?: number; @@ -649,7 +649,7 @@ declare module 'stripe' { /** * Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription. */ - description?: string; + description?: Stripe.Emptyable; /** * The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set. @@ -898,7 +898,7 @@ declare module 'stripe' { interface TransferData { /** - * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount is transferred to the destination. + * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. */ amount_percent?: number; diff --git a/types/Subscriptions.d.ts b/types/Subscriptions.d.ts index db0eef3e24..eca6165d01 100644 --- a/types/Subscriptions.d.ts +++ b/types/Subscriptions.d.ts @@ -28,7 +28,7 @@ declare module 'stripe' { | null; /** - * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. + * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. */ application_fee_percent: number | null; @@ -587,7 +587,7 @@ declare module 'stripe' { interface TransferData { /** - * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount is transferred to the destination. + * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. */ amount_percent: number | null; diff --git a/types/SubscriptionsResource.d.ts b/types/SubscriptionsResource.d.ts index 453b246f66..f86978bf80 100644 --- a/types/SubscriptionsResource.d.ts +++ b/types/SubscriptionsResource.d.ts @@ -14,7 +14,7 @@ declare module 'stripe' { add_invoice_items?: Array; /** - * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). + * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ application_fee_percent?: number; @@ -627,7 +627,7 @@ declare module 'stripe' { interface TransferData { /** - * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount is transferred to the destination. + * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. */ amount_percent?: number; @@ -672,7 +672,7 @@ declare module 'stripe' { add_invoice_items?: Array; /** - * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). + * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ application_fee_percent?: number; @@ -731,7 +731,7 @@ declare module 'stripe' { /** * ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). */ - default_source?: string; + default_source?: Stripe.Emptyable; /** * The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. Pass an empty string to remove previously-defined tax rates. @@ -741,7 +741,7 @@ declare module 'stripe' { /** * The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces. */ - description?: string; + description?: Stripe.Emptyable; /** * Specifies which fields in the response should be expanded. @@ -915,7 +915,7 @@ declare module 'stripe' { /** * Additional comments about why the user canceled the subscription, if the subscription was cancelled explicitly by the user. */ - comment?: string; + comment?: Stripe.Emptyable; /** * The customer submitted reason for why they cancelled, if the subscription was cancelled explicitly by the user. @@ -1340,7 +1340,7 @@ declare module 'stripe' { interface TransferData { /** - * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount is transferred to the destination. + * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. */ amount_percent?: number; @@ -1469,7 +1469,7 @@ declare module 'stripe' { /** * Additional comments about why the user canceled the subscription, if the subscription was cancelled explicitly by the user. */ - comment?: string; + comment?: Stripe.Emptyable; /** * The customer submitted reason for why they cancelled, if the subscription was cancelled explicitly by the user. @@ -1517,7 +1517,7 @@ declare module 'stripe' { /** * Additional comments about why the user canceled the subscription, if the subscription was cancelled explicitly by the user. */ - comment?: string; + comment?: Stripe.Emptyable; /** * The customer submitted reason for why they cancelled, if the subscription was cancelled explicitly by the user. diff --git a/types/Tax/CalculationsResource.d.ts b/types/Tax/CalculationsResource.d.ts index 17a5c09bc8..ee41b68a8c 100644 --- a/types/Tax/CalculationsResource.d.ts +++ b/types/Tax/CalculationsResource.d.ts @@ -73,7 +73,7 @@ declare module 'stripe' { /** * City, district, suburb, town, or village. */ - city?: string; + city?: Stripe.Emptyable; /** * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). @@ -83,22 +83,22 @@ declare module 'stripe' { /** * Address line 1 (e.g., street, PO Box, or company name). */ - line1?: string; + line1?: Stripe.Emptyable; /** * Address line 2 (e.g., apartment, suite, unit, or building). */ - line2?: string; + line2?: Stripe.Emptyable; /** * ZIP or postal code. */ - postal_code?: string; + postal_code?: Stripe.Emptyable; /** * State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix. Example: "NY" or "TX". */ - state?: string; + state?: Stripe.Emptyable; } type AddressSource = 'billing' | 'shipping'; diff --git a/types/Terminal/LocationsResource.d.ts b/types/Terminal/LocationsResource.d.ts index f47f7c3cde..9aaf15950d 100644 --- a/types/Terminal/LocationsResource.d.ts +++ b/types/Terminal/LocationsResource.d.ts @@ -80,7 +80,7 @@ declare module 'stripe' { /** * The ID of a configuration that will be used to customize all readers in this location. */ - configuration_overrides?: string; + configuration_overrides?: Stripe.Emptyable; /** * A name for the location. diff --git a/types/Terminal/ReadersResource.d.ts b/types/Terminal/ReadersResource.d.ts index d3bd02fcc3..6cded930dc 100644 --- a/types/Terminal/ReadersResource.d.ts +++ b/types/Terminal/ReadersResource.d.ts @@ -46,7 +46,7 @@ declare module 'stripe' { /** * The new label of the reader. */ - label?: string; + label?: Stripe.Emptyable; /** * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. diff --git a/types/TransferReversals.d.ts b/types/TransferReversals.d.ts index e2bb7f6d9a..fa18d81a24 100644 --- a/types/TransferReversals.d.ts +++ b/types/TransferReversals.d.ts @@ -29,7 +29,7 @@ declare module 'stripe' { object: 'transfer_reversal'; /** - * Amount, in %s. + * Amount, in cents (or local equivalent). */ amount: number; diff --git a/types/Transfers.d.ts b/types/Transfers.d.ts index 13f19a98ae..a2226909cc 100644 --- a/types/Transfers.d.ts +++ b/types/Transfers.d.ts @@ -26,12 +26,12 @@ declare module 'stripe' { object: 'transfer'; /** - * Amount in %s to be transferred. + * Amount in cents (or local equivalent) to be transferred. */ amount: number; /** - * Amount in %s reversed (can be less than the amount attribute on the transfer if a partial reversal was issued). + * Amount in cents (or local equivalent) reversed (can be less than the amount attribute on the transfer if a partial reversal was issued). */ amount_reversed: number; diff --git a/types/Treasury/OutboundPaymentsResource.d.ts b/types/Treasury/OutboundPaymentsResource.d.ts index 52071e77b2..e13788bc70 100644 --- a/types/Treasury/OutboundPaymentsResource.d.ts +++ b/types/Treasury/OutboundPaymentsResource.d.ts @@ -108,12 +108,12 @@ declare module 'stripe' { /** * Full name. */ - name?: string; + name?: Stripe.Emptyable; /** * Billing phone number (including extension). */ - phone?: string; + phone?: Stripe.Emptyable; } type Type = 'financial_account' | 'us_bank_account'; diff --git a/types/WebhookEndpointsResource.d.ts b/types/WebhookEndpointsResource.d.ts index 47e789ad5f..29dc421bbf 100644 --- a/types/WebhookEndpointsResource.d.ts +++ b/types/WebhookEndpointsResource.d.ts @@ -26,7 +26,7 @@ declare module 'stripe' { /** * An optional description of what the webhook is used for. */ - description?: string; + description?: Stripe.Emptyable; /** * Specifies which fields in the response should be expanded. @@ -378,7 +378,7 @@ declare module 'stripe' { /** * An optional description of what the webhook is used for. */ - description?: string; + description?: Stripe.Emptyable; /** * Disable the webhook endpoint if set to true.