diff --git a/types/2019-12-03/Accounts.d.ts b/types/2019-12-03/Accounts.d.ts index 17e8d9eebe..9530f6c0e7 100644 --- a/types/2019-12-03/Accounts.d.ts +++ b/types/2019-12-03/Accounts.d.ts @@ -261,7 +261,7 @@ declare module 'stripe' { line2: string | null; /** - * Zip/Postal Code. + * ZIP or postal code. */ postal_code: string | null; @@ -298,7 +298,7 @@ declare module 'stripe' { line2: string | null; /** - * Zip/Postal Code. + * ZIP or postal code. */ postal_code: string | null; @@ -802,6 +802,9 @@ declare module 'stripe' { */ dob?: Individual.Dob | null; + /** + * The individual's email address. + */ email?: string; /** @@ -1394,6 +1397,9 @@ declare module 'stripe' { */ dob?: Individual.Dob | null; + /** + * The individual's email address. + */ email?: string; /** diff --git a/types/2019-12-03/AlipayAccounts.d.ts b/types/2019-12-03/AlipayAccounts.d.ts index d456dde4a4..fbe89bafa8 100644 --- a/types/2019-12-03/AlipayAccounts.d.ts +++ b/types/2019-12-03/AlipayAccounts.d.ts @@ -19,6 +19,9 @@ declare module 'stripe' { */ created: number; + /** + * The ID of the customer associated with this Alipay Account. + */ customer?: string | Stripe.Customer | Stripe.DeletedCustomer | null; deleted?: void; diff --git a/types/2019-12-03/BalanceTransactions.d.ts b/types/2019-12-03/BalanceTransactions.d.ts index 5f6a6ca0eb..a727b72867 100644 --- a/types/2019-12-03/BalanceTransactions.d.ts +++ b/types/2019-12-03/BalanceTransactions.d.ts @@ -39,6 +39,9 @@ declare module 'stripe' { */ description: string | null; + /** + * The exchange rate used, if applicable, for this transaction. Specifically, if money was converted from currency A to currency B, then the `amount` in currency A, times `exchange_rate`, would be the `amount` in currency B. For example, suppose you charged a customer 10.00 EUR. Then the PaymentIntent's `amount` would be `1000` and `currency` would be `eur`. Suppose this was converted into 12.34 USD in your Stripe account. Then the BalanceTransaction's `amount` would be `1234`, `currency` would be `usd`, and `exchange_rate` would be `1.234`. + */ exchange_rate: number | null; /** @@ -101,6 +104,9 @@ declare module 'stripe' { */ amount: number; + /** + * ID of the Connect application that earned the fee. + */ application: string | null; /** @@ -163,6 +169,9 @@ declare module 'stripe' { created?: RangeQueryParam | number; + /** + * Only return transactions in a certain currency. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency?: string; /** diff --git a/types/2019-12-03/BankAccounts.d.ts b/types/2019-12-03/BankAccounts.d.ts index cab0cc3f69..7ed881b3f6 100644 --- a/types/2019-12-03/BankAccounts.d.ts +++ b/types/2019-12-03/BankAccounts.d.ts @@ -14,6 +14,9 @@ declare module 'stripe' { */ object: 'bank_account'; + /** + * The ID of the account that the bank account is associated with. + */ account?: string | Stripe.Account | null; /** @@ -41,6 +44,9 @@ declare module 'stripe' { */ currency: string; + /** + * The ID of the customer that the bank account is associated with. + */ customer?: string | Stripe.Customer | Stripe.DeletedCustomer | null; /** @@ -55,6 +61,9 @@ declare module 'stripe' { */ fingerprint: string | null; + /** + * The last four digits of the bank account number. + */ last4: string; /** diff --git a/types/2019-12-03/BitcoinReceivers.d.ts b/types/2019-12-03/BitcoinReceivers.d.ts index 1359cb757b..3664825b6c 100644 --- a/types/2019-12-03/BitcoinReceivers.d.ts +++ b/types/2019-12-03/BitcoinReceivers.d.ts @@ -54,6 +54,9 @@ declare module 'stripe' { */ currency: string; + /** + * The customer ID of the bitcoin receiver. + */ customer?: string | null; deleted?: void; @@ -93,6 +96,9 @@ declare module 'stripe' { */ payment?: string | null; + /** + * The refund address of this bitcoin receiver. + */ refund_address: string | null; /** @@ -105,6 +111,9 @@ declare module 'stripe' { */ uncaptured_funds: boolean; + /** + * Indicate if this source is used for payment. + */ used_for_payment: boolean | null; } diff --git a/types/2019-12-03/Charges.d.ts b/types/2019-12-03/Charges.d.ts index 533af86119..dc4aeda7f1 100644 --- a/types/2019-12-03/Charges.d.ts +++ b/types/2019-12-03/Charges.d.ts @@ -1339,6 +1339,9 @@ declare module 'stripe' { namespace ChargeUpdateParams { interface FraudDetails { + /** + * Either `safe` or `fraudulent`. + */ user_report: FraudDetails.UserReport | null; } diff --git a/types/2019-12-03/CreditNotes.d.ts b/types/2019-12-03/CreditNotes.d.ts index 8efe6b6a4f..92b2189e9a 100644 --- a/types/2019-12-03/CreditNotes.d.ts +++ b/types/2019-12-03/CreditNotes.d.ts @@ -45,7 +45,7 @@ declare module 'stripe' { /** * The integer amount in **%s** representing the amount of the discount that was credited. */ - discount_amount?: number; + discount_amount: number; /** * ID of the invoice. @@ -55,7 +55,7 @@ declare module 'stripe' { /** * Line items that make up the credit note */ - lines?: ApiList; + lines: ApiList; /** * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. @@ -80,7 +80,7 @@ declare module 'stripe' { /** * Amount that was credited outside of Stripe. */ - out_of_band_amount?: number | null; + out_of_band_amount: number | null; /** * The link to download the PDF of the credit note. @@ -105,17 +105,17 @@ declare module 'stripe' { /** * The integer amount in **%s** representing the amount of the credit note, excluding tax and discount. */ - subtotal?: number; + subtotal: number; /** * The aggregate amounts calculated per tax rate for all line items. */ - tax_amounts?: Array; + tax_amounts: Array; /** * The integer amount in **%s** representing the total amount of the credit note, including tax and discount. */ - total?: number; + total: number; /** * Type of this credit note, one of `post_payment` or `pre_payment`. A `pre_payment` credit note means it was issued when the invoice was open. A `post_payment` credit note means it was issued when the invoice was paid. diff --git a/types/2019-12-03/CustomerSources.d.ts b/types/2019-12-03/CustomerSources.d.ts index f4b74171c9..65be255a56 100644 --- a/types/2019-12-03/CustomerSources.d.ts +++ b/types/2019-12-03/CustomerSources.d.ts @@ -120,16 +120,34 @@ declare module 'stripe' { namespace Owner { interface Address { + /** + * City, district, suburb, town, or village. + */ city?: string; + /** + * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + */ country?: string; + /** + * Address line 1 (e.g., street, PO Box, or company name). + */ line1?: string; + /** + * Address line 2 (e.g., apartment, suite, unit, or building). + */ line2?: string; + /** + * ZIP or postal code. + */ postal_code?: string; + /** + * State, county, province, or region. + */ state?: string; } } diff --git a/types/2019-12-03/Discounts.d.ts b/types/2019-12-03/Discounts.d.ts index 2ec8a443cd..7bab0fb39e 100644 --- a/types/2019-12-03/Discounts.d.ts +++ b/types/2019-12-03/Discounts.d.ts @@ -11,6 +11,9 @@ declare module 'stripe' { coupon: Stripe.Coupon; + /** + * The ID of the customer associated with this discount. + */ customer: string | Stripe.Customer | Stripe.DeletedCustomer | null; deleted?: void; diff --git a/types/2019-12-03/Disputes.d.ts b/types/2019-12-03/Disputes.d.ts index 2ea202f748..24c3796277 100644 --- a/types/2019-12-03/Disputes.d.ts +++ b/types/2019-12-03/Disputes.d.ts @@ -282,80 +282,137 @@ declare module 'stripe' { namespace DisputeUpdateParams { interface Evidence { /** - * Has a maximum character count of 20,000. + * Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product. This information should include IP addresses, corresponding timestamps, and any detailed recorded activity. Has a maximum character count of 20,000. */ access_activity_log?: string; + /** + * The billing address provided by the customer. + */ billing_address?: string; + /** + * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer. + */ cancellation_policy?: string; /** - * Has a maximum character count of 20,000. + * An explanation of how and when the customer was shown your refund policy prior to purchase. Has a maximum character count of 20,000. */ cancellation_policy_disclosure?: string; /** - * Has a maximum character count of 20,000. + * A justification for why the customer's subscription was not canceled. Has a maximum character count of 20,000. */ cancellation_rebuttal?: string; + /** + * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any communication with the customer that you feel is relevant to your case. Examples include emails proving that the customer received the product or service, or demonstrating their use of or satisfaction with the product or service. + */ customer_communication?: string; + /** + * The email address of the customer. + */ customer_email_address?: string; + /** + * The name of the customer. + */ customer_name?: string; + /** + * The IP address that the customer used when making the purchase. + */ customer_purchase_ip?: string; + /** + * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature. + */ customer_signature?: string; + /** + * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation for the prior charge that can uniquely identify the charge, such as a receipt, shipping label, work order, etc. This document should be paired with a similar document from the disputed payment that proves the two payments are separate. + */ duplicate_charge_documentation?: string; /** - * Has a maximum character count of 20,000. + * An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate. Has a maximum character count of 20,000. */ duplicate_charge_explanation?: string; + /** + * The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge. + */ duplicate_charge_id?: string; /** - * Has a maximum character count of 20,000. + * A description of the product or service that was sold. Has a maximum character count of 20,000. */ product_description?: string; + /** + * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any receipt or message sent to the customer notifying them of the charge. + */ receipt?: string; + /** + * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer. + */ refund_policy?: string; /** - * Has a maximum character count of 20,000. + * Documentation demonstrating that the customer was shown your refund policy prior to purchase. Has a maximum character count of 20,000. */ refund_policy_disclosure?: string; /** - * Has a maximum character count of 20,000. + * A justification for why the customer is not entitled to a refund. Has a maximum character count of 20,000. */ refund_refusal_explanation?: string; + /** + * The date on which the customer received or began receiving the purchased service, in a clear human-readable format. + */ service_date?: string; + /** + * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a service was provided to the customer. This could include a copy of a signed contract, work order, or other form of written agreement. + */ service_documentation?: string; + /** + * The address to which a physical product was shipped. You should try to include as complete address information as possible. + */ shipping_address?: string; + /** + * The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. If multiple carriers were used for this purchase, please separate them with commas. + */ shipping_carrier?: string; + /** + * The date on which a physical product began its route to the shipping address, in a clear human-readable format. + */ shipping_date?: string; + /** + * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a product was shipped to the customer at the same address the customer provided to you. This could include a copy of the shipment receipt, shipping label, etc. It should show the customer's full shipping address, if possible. + */ shipping_documentation?: string; + /** + * The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas. + */ shipping_tracking_number?: string; + /** + * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements. + */ uncategorized_file?: string; /** - * Has a maximum character count of 20,000. + * Any additional evidence or statements. Has a maximum character count of 20,000. */ uncategorized_text?: string; } diff --git a/types/2019-12-03/Files.d.ts b/types/2019-12-03/Files.d.ts index 245c61d441..a2ffe15d43 100644 --- a/types/2019-12-03/Files.d.ts +++ b/types/2019-12-03/Files.d.ts @@ -24,6 +24,9 @@ declare module 'stripe' { */ filename: string | null; + /** + * A list of [file links](https://stripe.com/docs/api#file_links) that point at this file. + */ links?: ApiList | null; /** diff --git a/types/2019-12-03/InvoiceLineItems.d.ts b/types/2019-12-03/InvoiceLineItems.d.ts index dafa934cf8..aaf55f9fec 100644 --- a/types/2019-12-03/InvoiceLineItems.d.ts +++ b/types/2019-12-03/InvoiceLineItems.d.ts @@ -34,6 +34,9 @@ declare module 'stripe' { */ discountable: boolean; + /** + * The ID of the [invoice item](https://stripe.com/docs/api/invoiceitems) associated with this line item if any. + */ invoice_item?: string; /** @@ -205,7 +208,11 @@ declare module 'stripe' { subscription_prorate?: boolean; /** - * Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The value defaults to `create_prorations`, indicating that proration invoice items should be created. Prorations can be disabled by setting the value to `none`. Passing `always_invoice` will cause an invoice to immediately be created for any prorations. + * Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. Valid values are `create_prorations`, `none`, or `always_invoice`. + * + * Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`. + * + * Prorations can be disabled by passing `none`. */ subscription_proration_behavior?: InvoiceLineItemListUpcomingParams.SubscriptionProrationBehavior; diff --git a/types/2019-12-03/Invoices.d.ts b/types/2019-12-03/Invoices.d.ts index 09e5f417bb..e82dfaeacd 100644 --- a/types/2019-12-03/Invoices.d.ts +++ b/types/2019-12-03/Invoices.d.ts @@ -89,6 +89,9 @@ declare module 'stripe' { */ custom_fields: Array | null; + /** + * The ID of the customer who will be billed. + */ customer: string | Stripe.Customer | Stripe.DeletedCustomer; /** @@ -148,6 +151,9 @@ declare module 'stripe' { */ description: string | null; + /** + * Describes the current discount applied to this invoice, if there is one. + */ discount: Stripe.Discount | null; /** @@ -479,6 +485,9 @@ declare module 'stripe' { } interface InvoiceCreateParams { + /** + * The ID of the customer who will be billed. + */ customer: string; /** @@ -521,6 +530,9 @@ declare module 'stripe' { */ default_tax_rates?: Array; + /** + * An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. + */ description?: string; /** @@ -635,6 +647,9 @@ declare module 'stripe' { */ default_tax_rates?: Array | ''; + /** + * An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. + */ description?: string; /** @@ -859,7 +874,11 @@ declare module 'stripe' { subscription_prorate?: boolean; /** - * Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The value defaults to `create_prorations`, indicating that proration invoice items should be created. Prorations can be disabled by setting the value to `none`. Passing `always_invoice` will cause an invoice to immediately be created for any prorations. + * Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. Valid values are `create_prorations`, `none`, or `always_invoice`. + * + * Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`. + * + * Prorations can be disabled by passing `none`. */ subscription_proration_behavior?: InvoiceRetrieveUpcomingParams.SubscriptionProrationBehavior; diff --git a/types/2019-12-03/Issuing/Authorizations.d.ts b/types/2019-12-03/Issuing/Authorizations.d.ts index 10a02a9322..3589123ef5 100644 --- a/types/2019-12-03/Issuing/Authorizations.d.ts +++ b/types/2019-12-03/Issuing/Authorizations.d.ts @@ -35,6 +35,9 @@ declare module 'stripe' { */ authorized_currency: string; + /** + * List of balance transactions associated with this authorization. + */ balance_transactions: Array; card: Stripe.Issuing.Card; @@ -59,6 +62,9 @@ declare module 'stripe' { */ held_currency: string; + /** + * If set `true`, you may provide [held_amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-held_amount) to control how much to hold for the authorization. + */ is_held_amount_controllable: boolean; /** @@ -83,6 +89,9 @@ declare module 'stripe' { */ pending_held_amount: number; + /** + * History of every time the authorization was approved/denied (whether approved/denied by you directly, or by Stripe based on your authorization_controls). If the merchant changes the authorization by performing an [incremental authorization or partial capture](https://stripe.com/docs/issuing/authorizations/special_scenarios#incremental-authorizations), you can look at request_history to see the previous states of the authorization. + */ request_history: Array; /** @@ -90,6 +99,9 @@ declare module 'stripe' { */ status: Authorization.Status; + /** + * List of [transactions](https://stripe.com/docs/api/issuing/transactions) associated with this authorization. + */ transactions: Array; verification_data: Authorization.VerificationData; diff --git a/types/2019-12-03/Issuing/Cardholders.d.ts b/types/2019-12-03/Issuing/Cardholders.d.ts index ae8ff49c14..7a0e98b550 100644 --- a/types/2019-12-03/Issuing/Cardholders.d.ts +++ b/types/2019-12-03/Issuing/Cardholders.d.ts @@ -1009,6 +1009,9 @@ declare module 'stripe' { interface Billing { address: Address; + /** + * The cardholder's billing name. + */ name: string | null; } @@ -2095,21 +2098,42 @@ declare module 'stripe' { } interface Billing { + /** + * The cardholder's billing address. + */ address: Billing.Address; } namespace Billing { interface Address { + /** + * City, district, suburb, town, or village. + */ city: string; + /** + * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + */ country: string; + /** + * Address line 1 (e.g., street, PO Box, or company name). + */ line1: string; + /** + * Address line 2 (e.g., apartment, suite, unit, or building). + */ line2?: string; + /** + * ZIP or postal code. + */ postal_code: string; + /** + * State, county, province, or region. + */ state?: string; } } @@ -3170,21 +3194,42 @@ declare module 'stripe' { } interface Billing { + /** + * The cardholder's billing address. + */ address: Billing.Address; } namespace Billing { interface Address { + /** + * City, district, suburb, town, or village. + */ city: string; + /** + * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + */ country: string; + /** + * Address line 1 (e.g., street, PO Box, or company name). + */ line1: string; + /** + * Address line 2 (e.g., apartment, suite, unit, or building). + */ line2?: string; + /** + * ZIP or postal code. + */ postal_code: string; + /** + * State, county, province, or region. + */ state?: string; } } diff --git a/types/2019-12-03/Issuing/Cards.d.ts b/types/2019-12-03/Issuing/Cards.d.ts index f54cda126a..47f002a40c 100644 --- a/types/2019-12-03/Issuing/Cards.d.ts +++ b/types/2019-12-03/Issuing/Cards.d.ts @@ -2082,8 +2082,14 @@ declare module 'stripe' { type ReplacementReason = 'damage' | 'expiration' | 'loss' | 'theft'; interface Shipping { + /** + * The address that the card is shipped to. + */ address: Shipping.Address; + /** + * The name printed on the shipping label when shipping the card. + */ name: string; /** @@ -2094,16 +2100,34 @@ declare module 'stripe' { namespace Shipping { interface Address { + /** + * City, district, suburb, town, or village. + */ city: string; + /** + * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + */ country: string; + /** + * Address line 1 (e.g., street, PO Box, or company name). + */ line1: string; + /** + * Address line 2 (e.g., apartment, suite, unit, or building). + */ line2?: string; + /** + * ZIP or postal code. + */ postal_code: string; + /** + * State, county, province, or region. + */ state?: string; } diff --git a/types/2019-12-03/Issuing/Transactions.d.ts b/types/2019-12-03/Issuing/Transactions.d.ts index 26d173e512..cc20afc1f9 100644 --- a/types/2019-12-03/Issuing/Transactions.d.ts +++ b/types/2019-12-03/Issuing/Transactions.d.ts @@ -25,6 +25,9 @@ declare module 'stripe' { */ authorization: string | Stripe.Issuing.Authorization | null; + /** + * ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions) associated with this transaction. + */ balance_transaction: string | Stripe.BalanceTransaction | null; /** @@ -47,6 +50,9 @@ declare module 'stripe' { */ currency: string; + /** + * If you've disputed the transaction, the ID of the [dispute object](https://stripe.com/docs/api/issuing/disputes/object). + */ dispute: string | Stripe.Issuing.Dispute | null; /** diff --git a/types/2019-12-03/Orders.d.ts b/types/2019-12-03/Orders.d.ts index 49c12ea66c..7c18870969 100644 --- a/types/2019-12-03/Orders.d.ts +++ b/types/2019-12-03/Orders.d.ts @@ -19,6 +19,9 @@ declare module 'stripe' { */ amount: number; + /** + * The total amount that was returned to the customer. + */ amount_returned: number | null; /** @@ -26,6 +29,9 @@ declare module 'stripe' { */ application: string | null; + /** + * A fee in cents that will be applied to the order and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation. + */ application_fee: number | null; /** @@ -53,6 +59,9 @@ declare module 'stripe' { */ email: string | null; + /** + * External coupon code to load for this order. + */ external_coupon_code?: string; /** @@ -70,6 +79,9 @@ declare module 'stripe' { */ metadata: Metadata; + /** + * A list of returns that have taken place for this order. + */ returns: ApiList | null; /** @@ -97,6 +109,9 @@ declare module 'stripe' { */ status_transitions: Order.StatusTransitions | null; + /** + * Time at which the object was last updated. Measured in seconds since the Unix epoch. + */ updated: number | null; /** @@ -182,12 +197,24 @@ declare module 'stripe' { } interface StatusTransitions { + /** + * The time that the order was canceled. + */ canceled: number | null; + /** + * The time that the order was fulfilled. + */ fulfiled: number | null; + /** + * The time that the order was paid. + */ paid: number | null; + /** + * The time that the order was returned. + */ returned: number | null; } } diff --git a/types/2019-12-03/PaymentMethods.d.ts b/types/2019-12-03/PaymentMethods.d.ts index dd1b2ef3ff..24dfae4f1d 100644 --- a/types/2019-12-03/PaymentMethods.d.ts +++ b/types/2019-12-03/PaymentMethods.d.ts @@ -424,16 +424,34 @@ declare module 'stripe' { namespace BillingDetails { interface Address { + /** + * City, district, suburb, town, or village. + */ city?: string; + /** + * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + */ country?: string; + /** + * Address line 1 (e.g., street, PO Box, or company name). + */ line1?: string; + /** + * Address line 2 (e.g., apartment, suite, unit, or building). + */ line2?: string; + /** + * ZIP or postal code. + */ postal_code?: string; + /** + * State, county, province, or region. + */ state?: string; } } @@ -487,6 +505,9 @@ declare module 'stripe' { } interface SepaDebit { + /** + * IBAN of the bank account. + */ iban: string; } @@ -511,6 +532,9 @@ declare module 'stripe' { */ billing_details?: PaymentMethodUpdateParams.BillingDetails; + /** + * If this is a `card` PaymentMethod, this hash contains the user's card details. + */ card?: PaymentMethodUpdateParams.Card; /** @@ -523,6 +547,9 @@ declare module 'stripe' { */ metadata?: MetadataParam; + /** + * If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account. + */ sepa_debit?: PaymentMethodUpdateParams.SepaDebit; } @@ -551,16 +578,34 @@ declare module 'stripe' { namespace BillingDetails { interface Address { + /** + * City, district, suburb, town, or village. + */ city?: string; + /** + * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + */ country?: string; + /** + * Address line 1 (e.g., street, PO Box, or company name). + */ line1?: string; + /** + * Address line 2 (e.g., apartment, suite, unit, or building). + */ line2?: string; + /** + * ZIP or postal code. + */ postal_code?: string; + /** + * State, county, province, or region. + */ state?: string; } } diff --git a/types/2019-12-03/Persons.d.ts b/types/2019-12-03/Persons.d.ts index ce87840ad1..00224c1a15 100644 --- a/types/2019-12-03/Persons.d.ts +++ b/types/2019-12-03/Persons.d.ts @@ -138,7 +138,7 @@ declare module 'stripe' { line2: string | null; /** - * Zip/Postal Code. + * ZIP or postal code. */ postal_code: string | null; @@ -175,7 +175,7 @@ declare module 'stripe' { line2: string | null; /** - * Zip/Postal Code. + * ZIP or postal code. */ postal_code: string | null; diff --git a/types/2019-12-03/Products.d.ts b/types/2019-12-03/Products.d.ts index 4a5a3cb13c..8f0584cf50 100644 --- a/types/2019-12-03/Products.d.ts +++ b/types/2019-12-03/Products.d.ts @@ -91,6 +91,9 @@ declare module 'stripe' { */ unit_label: string | null; + /** + * Time at which the object was last updated. Measured in seconds since the Unix epoch. + */ updated: number; /** diff --git a/types/2019-12-03/SKUs.d.ts b/types/2019-12-03/SKUs.d.ts index c8b35e15f6..ed545ba438 100644 --- a/types/2019-12-03/SKUs.d.ts +++ b/types/2019-12-03/SKUs.d.ts @@ -70,6 +70,9 @@ declare module 'stripe' { */ product: string | Stripe.Product; + /** + * Time at which the object was last updated. Measured in seconds since the Unix epoch. + */ updated: number; } diff --git a/types/2019-12-03/Sources.d.ts b/types/2019-12-03/Sources.d.ts index feccd4d994..9204e5706e 100644 --- a/types/2019-12-03/Sources.d.ts +++ b/types/2019-12-03/Sources.d.ts @@ -926,16 +926,34 @@ declare module 'stripe' { namespace Owner { interface Address { + /** + * City, district, suburb, town, or village. + */ city?: string; + /** + * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + */ country?: string; + /** + * Address line 1 (e.g., street, PO Box, or company name). + */ line1?: string; + /** + * Address line 2 (e.g., apartment, suite, unit, or building). + */ line2?: string; + /** + * ZIP or postal code. + */ postal_code?: string; + /** + * State, county, province, or region. + */ state?: string; } } @@ -1200,16 +1218,34 @@ declare module 'stripe' { namespace Owner { interface Address { + /** + * City, district, suburb, town, or village. + */ city?: string; + /** + * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + */ country?: string; + /** + * Address line 1 (e.g., street, PO Box, or company name). + */ line1?: string; + /** + * Address line 2 (e.g., apartment, suite, unit, or building). + */ line2?: string; + /** + * ZIP or postal code. + */ postal_code?: string; + /** + * State, county, province, or region. + */ state?: string; } } diff --git a/types/2019-12-03/SubscriptionItems.d.ts b/types/2019-12-03/SubscriptionItems.d.ts index 725232172a..c7e64aa464 100644 --- a/types/2019-12-03/SubscriptionItems.d.ts +++ b/types/2019-12-03/SubscriptionItems.d.ts @@ -112,12 +112,16 @@ declare module 'stripe' { plan?: string; /** - * Flag indicating whether to [prorate](https://stripe.com/docs/billing/subscriptions/prorations) switching plans during a billing cycle. + * Flag indicating whether to [prorate](https://stripe.com/docs/billing/subscriptions/prorations) switching plans during a billing cycle. This field has been deprecated and will be removed in a future API version. Use `proration_behavior=create_prorations` as a replacement for `prorate=true` and `proration_behavior=none` for `prorate=false`. */ prorate?: boolean; /** - * Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) resulting from the `billing_cycle_anchor`. The value defaults to `create_prorations`, indicating that proration invoice items should be created. Prorations can be disabled by setting the value to `none`. `always_invoice` cannot be passed. + * Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. Valid values are `create_prorations`, `none`, or `always_invoice`. + * + * Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`. + * + * Prorations can be disabled by passing `none`. */ proration_behavior?: SubscriptionItemCreateParams.ProrationBehavior; @@ -176,6 +180,9 @@ declare module 'stripe' { */ metadata?: MetadataParam; + /** + * Indicates if a customer is on or off-session while an invoice payment is attempted. + */ off_session?: boolean; /** @@ -191,12 +198,16 @@ declare module 'stripe' { plan?: string; /** - * Flag indicating whether to [prorate](https://stripe.com/docs/billing/subscriptions/prorations) switching plans during a billing cycle. + * Flag indicating whether to [prorate](https://stripe.com/docs/billing/subscriptions/prorations) switching plans during a billing cycle. This field has been deprecated and will be removed in a future API version. Use `proration_behavior=create_prorations` as a replacement for `prorate=true` and `proration_behavior=none` for `prorate=false`. */ prorate?: boolean; /** - * Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The value defaults to `create_prorations`, indicating that proration invoice items should be created. Prorations can be disabled by setting the value to `none`. Passing `always_invoice` will cause an invoice to immediately be created for any prorations. + * Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. Valid values are `create_prorations`, `none`, or `always_invoice`. + * + * Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`. + * + * Prorations can be disabled by passing `none`. */ proration_behavior?: SubscriptionItemUpdateParams.ProrationBehavior; diff --git a/types/2019-12-03/SubscriptionSchedules.d.ts b/types/2019-12-03/SubscriptionSchedules.d.ts index bce5986cef..871565ddab 100644 --- a/types/2019-12-03/SubscriptionSchedules.d.ts +++ b/types/2019-12-03/SubscriptionSchedules.d.ts @@ -89,8 +89,14 @@ declare module 'stripe' { namespace SubscriptionSchedule { interface CurrentPhase { + /** + * The end of this phase of the subscription schedule. + */ end_date: number; + /** + * The start of this phase of the subscription schedule. + */ start_date: number; } @@ -167,6 +173,9 @@ declare module 'stripe' { */ default_payment_method: string | Stripe.PaymentMethod | null; + /** + * The default tax rates to apply to the subscription during this phase of the subscription schedule. + */ default_tax_rates?: Array | null; /** @@ -359,6 +368,9 @@ declare module 'stripe' { type CollectionMethod = 'charge_automatically' | 'send_invoice'; interface InvoiceSettings { + /** + * Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`. + */ days_until_due?: number; } } @@ -448,6 +460,9 @@ declare module 'stripe' { type CollectionMethod = 'charge_automatically' | 'send_invoice'; interface InvoiceSettings { + /** + * Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`. + */ days_until_due?: number; } @@ -562,6 +577,9 @@ declare module 'stripe' { type CollectionMethod = 'charge_automatically' | 'send_invoice'; interface InvoiceSettings { + /** + * Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`. + */ days_until_due?: number; } } @@ -656,6 +674,9 @@ declare module 'stripe' { type CollectionMethod = 'charge_automatically' | 'send_invoice'; interface InvoiceSettings { + /** + * Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`. + */ days_until_due?: number; } diff --git a/types/2019-12-03/Subscriptions.d.ts b/types/2019-12-03/Subscriptions.d.ts index 67bdfe1153..c1dc631e9e 100644 --- a/types/2019-12-03/Subscriptions.d.ts +++ b/types/2019-12-03/Subscriptions.d.ts @@ -367,12 +367,14 @@ declare module 'stripe' { pending_invoice_item_interval?: SubscriptionCreateParams.PendingInvoiceItemInterval | null; /** - * Boolean (defaults to `true`) telling us whether to [credit for unused time](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g. when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. If `false`, the anchor period will be free (similar to a trial) and no proration adjustments will be created. + * Boolean (defaults to `true`) telling us whether to [credit for unused time](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g. when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. If `false`, the anchor period will be free (similar to a trial) and no proration adjustments will be created. This field has been deprecated and will be removed in a future API version. Use `proration_behavior=create_prorations` as a replacement for `prorate=true` and `proration_behavior=none` for `prorate=false`. */ prorate?: boolean; /** - * Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) resulting from the `billing_cycle_anchor`. The value defaults to `create_prorations`, indicating that proration invoice items should be created. Prorations can be disabled by setting the value to `none`. `always_invoice` cannot be passed. + * Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) resulting from the `billing_cycle_anchor`. Valid values are `create_prorations` or `none`. + * + * Passing `create_prorations` will cause proration invoice items to be created when applicable. Prorations can be disabled by passing `none`. If no value is passed, the default is `create_prorations`. */ proration_behavior?: SubscriptionCreateParams.ProrationBehavior; @@ -580,12 +582,16 @@ declare module 'stripe' { pending_invoice_item_interval?: SubscriptionUpdateParams.PendingInvoiceItemInterval | null; /** - * Boolean (defaults to `true`) telling us whether to [credit for unused time](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g. when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. If `false`, the anchor period will be free (similar to a trial) and no proration adjustments will be created. + * Boolean (defaults to `true`) telling us whether to [credit for unused time](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g. when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. If `false`, the anchor period will be free (similar to a trial) and no proration adjustments will be created. This field has been deprecated and will be removed in a future API version. Use `proration_behavior=create_prorations` as a replacement for `prorate=true` and `proration_behavior=none` for `prorate=false`. */ prorate?: boolean; /** - * Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The value defaults to `create_prorations`, indicating that proration invoice items should be created. Prorations can be disabled by setting the value to `none`. Passing `always_invoice` will cause an invoice to immediately be created for any prorations. + * Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. Valid values are `create_prorations`, `none`, or `always_invoice`. + * + * Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`. + * + * Prorations can be disabled by passing `none`. */ proration_behavior?: SubscriptionUpdateParams.ProrationBehavior; diff --git a/types/2019-12-03/Terminal/Locations.d.ts b/types/2019-12-03/Terminal/Locations.d.ts index b880d486f7..5f1a6428c8 100644 --- a/types/2019-12-03/Terminal/Locations.d.ts +++ b/types/2019-12-03/Terminal/Locations.d.ts @@ -79,16 +79,34 @@ declare module 'stripe' { namespace LocationCreateParams { interface Address { + /** + * City, district, suburb, town, or village. + */ city?: string; + /** + * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + */ country: string; + /** + * Address line 1 (e.g., street, PO Box, or company name). + */ line1?: string; + /** + * Address line 2 (e.g., apartment, suite, unit, or building). + */ line2?: string; + /** + * ZIP or postal code. + */ postal_code?: string; + /** + * State, county, province, or region. + */ state?: string; } } @@ -124,16 +142,34 @@ declare module 'stripe' { namespace LocationUpdateParams { interface Address { + /** + * City, district, suburb, town, or village. + */ city?: string; + /** + * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + */ country: string; + /** + * Address line 1 (e.g., street, PO Box, or company name). + */ line1?: string; + /** + * Address line 2 (e.g., apartment, suite, unit, or building). + */ line2?: string; + /** + * ZIP or postal code. + */ postal_code?: string; + /** + * State, county, province, or region. + */ state?: string; } }