Skip to content

Commit

Permalink
Update generated code for v1121
Browse files Browse the repository at this point in the history
  • Loading branch information
stripe-openapi[bot] committed Jul 9, 2024
1 parent eba5b86 commit 1e3fb36
Show file tree
Hide file tree
Showing 12 changed files with 11 additions and 36 deletions.
2 changes: 1 addition & 1 deletion OPENAPI_VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v1116
v1121
2 changes: 1 addition & 1 deletion types/BillingPortal/Sessions.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ declare module 'stripe' {
* Create sessions on-demand when customers intend to manage their subscriptions
* and billing details.
*
* Learn more in the [integration guide](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal).
* Related guide: [Customer management](https://stripe.com/customer-management)
*/
interface Session {
/**
Expand Down
2 changes: 1 addition & 1 deletion types/CustomerSessions.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ declare module 'stripe' {
/**
* This hash contains whether the Payment Element is enabled and the features it supports.
*/
payment_element?: Components.PaymentElement;
payment_element: Components.PaymentElement;

/**
* This hash contains whether the pricing table is enabled.
Expand Down
6 changes: 3 additions & 3 deletions types/FinancialConnections/Institutions.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ declare module 'stripe' {
namespace Stripe {
namespace FinancialConnections {
/**
* An institution represents a banking institution which may be available for an end user to select in the Financial Connections authentication flow.
* An institution represents a financial institution to which an end user can connect using the Financial Connections authentication flow.
*/
interface Institution {
/**
Expand All @@ -30,7 +30,7 @@ declare module 'stripe' {
name: string;

/**
* A list of routing numbers which are known to correspond to this institution.
* A list of routing numbers which are known to correspond to this institution. Due to the many to many relationship between institutions and routing numbers, this list may not be comprehensive and routing numbers may also be shared between institutions.
*/
routing_numbers: Array<string>;

Expand All @@ -40,7 +40,7 @@ declare module 'stripe' {
status: Institution.Status;

/**
* The URL for this institution's website.
* A URL corresponding to this institution. This URL is also displayed in the authentication flow to help end users confirm that they are authenticating with the right institution.
*/
url: string | null;
}
Expand Down
5 changes: 0 additions & 5 deletions types/Invoices.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -868,10 +868,6 @@ declare module 'stripe' {
| 'bank_account_unverified'
| 'bank_account_verification_failed'
| 'billing_invalid_mandate'
| 'billing_policy_remote_function_response_invalid'
| 'billing_policy_remote_function_timeout'
| 'billing_policy_remote_function_unexpected_status_code'
| 'billing_policy_remote_function_unreachable'
| 'bitcoin_upgrade_required'
| 'capture_charge_authorization_expired'
| 'capture_unauthorized_payment'
Expand Down Expand Up @@ -949,7 +945,6 @@ declare module 'stripe' {
| 'parameters_exclusive'
| 'payment_intent_action_required'
| 'payment_intent_authentication_failure'
| 'payment_intent_fx_quote_invalid'
| 'payment_intent_incompatible_payment_method'
| 'payment_intent_invalid_parameter'
| 'payment_intent_konbini_rejected_confirmation_number'
Expand Down
5 changes: 0 additions & 5 deletions types/PaymentIntents.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -405,10 +405,6 @@ declare module 'stripe' {
| 'bank_account_unverified'
| 'bank_account_verification_failed'
| 'billing_invalid_mandate'
| 'billing_policy_remote_function_response_invalid'
| 'billing_policy_remote_function_timeout'
| 'billing_policy_remote_function_unexpected_status_code'
| 'billing_policy_remote_function_unreachable'
| 'bitcoin_upgrade_required'
| 'capture_charge_authorization_expired'
| 'capture_unauthorized_payment'
Expand Down Expand Up @@ -486,7 +482,6 @@ declare module 'stripe' {
| 'parameters_exclusive'
| 'payment_intent_action_required'
| 'payment_intent_authentication_failure'
| 'payment_intent_fx_quote_invalid'
| 'payment_intent_incompatible_payment_method'
| 'payment_intent_invalid_parameter'
| 'payment_intent_konbini_rejected_confirmation_number'
Expand Down
2 changes: 1 addition & 1 deletion types/Plans.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ declare module 'stripe' {
/**
* The meter tracking the usage of a metered price
*/
meter?: string | null;
meter: string | null;

/**
* A brief description of the plan, hidden from customers.
Expand Down
2 changes: 1 addition & 1 deletion types/Prices.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ declare module 'stripe' {
/**
* The meter tracking the usage of a metered price
*/
meter?: string | null;
meter: string | null;

/**
* Default number of trial days when subscribing a customer to this price using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).
Expand Down
5 changes: 0 additions & 5 deletions types/QuotePreviewInvoices.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -845,10 +845,6 @@ declare module 'stripe' {
| 'bank_account_unverified'
| 'bank_account_verification_failed'
| 'billing_invalid_mandate'
| 'billing_policy_remote_function_response_invalid'
| 'billing_policy_remote_function_timeout'
| 'billing_policy_remote_function_unexpected_status_code'
| 'billing_policy_remote_function_unreachable'
| 'bitcoin_upgrade_required'
| 'capture_charge_authorization_expired'
| 'capture_unauthorized_payment'
Expand Down Expand Up @@ -926,7 +922,6 @@ declare module 'stripe' {
| 'parameters_exclusive'
| 'payment_intent_action_required'
| 'payment_intent_authentication_failure'
| 'payment_intent_fx_quote_invalid'
| 'payment_intent_incompatible_payment_method'
| 'payment_intent_invalid_parameter'
| 'payment_intent_konbini_rejected_confirmation_number'
Expand Down
5 changes: 0 additions & 5 deletions types/SetupAttempts.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -645,10 +645,6 @@ declare module 'stripe' {
| 'bank_account_unverified'
| 'bank_account_verification_failed'
| 'billing_invalid_mandate'
| 'billing_policy_remote_function_response_invalid'
| 'billing_policy_remote_function_timeout'
| 'billing_policy_remote_function_unexpected_status_code'
| 'billing_policy_remote_function_unreachable'
| 'bitcoin_upgrade_required'
| 'capture_charge_authorization_expired'
| 'capture_unauthorized_payment'
Expand Down Expand Up @@ -726,7 +722,6 @@ declare module 'stripe' {
| 'parameters_exclusive'
| 'payment_intent_action_required'
| 'payment_intent_authentication_failure'
| 'payment_intent_fx_quote_invalid'
| 'payment_intent_incompatible_payment_method'
| 'payment_intent_invalid_parameter'
| 'payment_intent_konbini_rejected_confirmation_number'
Expand Down
5 changes: 0 additions & 5 deletions types/SetupIntents.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -311,10 +311,6 @@ declare module 'stripe' {
| 'bank_account_unverified'
| 'bank_account_verification_failed'
| 'billing_invalid_mandate'
| 'billing_policy_remote_function_response_invalid'
| 'billing_policy_remote_function_timeout'
| 'billing_policy_remote_function_unexpected_status_code'
| 'billing_policy_remote_function_unreachable'
| 'bitcoin_upgrade_required'
| 'capture_charge_authorization_expired'
| 'capture_unauthorized_payment'
Expand Down Expand Up @@ -392,7 +388,6 @@ declare module 'stripe' {
| 'parameters_exclusive'
| 'payment_intent_action_required'
| 'payment_intent_authentication_failure'
| 'payment_intent_fx_quote_invalid'
| 'payment_intent_incompatible_payment_method'
| 'payment_intent_invalid_parameter'
| 'payment_intent_konbini_rejected_confirmation_number'
Expand Down
6 changes: 3 additions & 3 deletions types/SubscriptionsResource.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2271,19 +2271,19 @@ declare module 'stripe' {
/**
* Updates an existing subscription to match the specified parameters.
* When changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes.
* To preview how the proration is calculated, use the [upcoming invoice](https://stripe.com/docs/api/invoices/upcoming) endpoint.
* To preview how the proration is calculated, use the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint.
*
* By default, we prorate subscription changes. For example, if a customer signs up on May 1 for a 100 price, they'll be billed 100 immediately. If on May 15 they switch to a 200 price, then on June 1 they'll be billed 250 (200 for a renewal of her subscription, plus a 50 prorating adjustment for half of the previous month's 100 difference). Similarly, a downgrade generates a credit that is applied to the next invoice. We also prorate when you make quantity changes.
*
* Switching prices does not normally change the billing date or generate an immediate charge unless:
*
*
* The billing interval is changed (for example, from monthly to yearly).
* The subscription moves from free to paid, or paid to free.
* The subscription moves from free to paid.
* A trial starts or ends.
*
*
* In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date.
* In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. Learn about how [Stripe immediately attempts payment for subscription changes](https://stripe.com/billing/subscriptions/upgrade-downgrade#immediate-payment).
*
* If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription's renewal date, you need to manually [invoice the customer](https://stripe.com/docs/api/invoices/create).
*
Expand Down

0 comments on commit 1e3fb36

Please sign in to comment.