|
1 | 1 | # Changelog
|
| 2 | +## 18.0.0 - 2025-04-01 |
| 3 | +* [#2279](https://github.com/stripe/stripe-node/pull/2279) Support for APIs in the new API version 2025-03-31.basil |
| 4 | + |
| 5 | + This release changes the pinned API version to `2025-03-31.basil`. |
| 6 | + |
| 7 | + ### ⚠️ Breaking changes due to changes in the Stripe API |
| 8 | + |
| 9 | + Please review details for the breaking changes and alternatives in the [Stripe API changelog](https://docs.stripe.com/changelog/acacia) before upgrading. |
| 10 | + |
| 11 | + * Remove support for resources `SubscriptionItemUsageRecordSummary` and `SubscriptionItemUsageRecord` |
| 12 | + * Remove support for `listUpcomingLines` and `retrieveUpcoming` methods on resource `Invoice` |
| 13 | + * Remove support for `createUsageRecord` and `listUsageRecordSummaries` methods on resource `SubscriptionItems` |
| 14 | + * Remove support for `invoice` on `Charge` and `PaymentIntent` |
| 15 | + * Remove support for `shipping_details` on `Checkout.Session` |
| 16 | + * Remove support for `carrier`, `phone`, and `tracking_number` on `Checkout.Session.collected_information.shipping_details`. Make `name` and `address` required instead of optional. |
| 17 | + * Remove support for `refund` on `CreditNoteCreateParams`, `CreditNoteListPreviewLineItemsParams`, `CreditNotePreviewParams`, and `CreditNote` |
| 18 | + * Remove support for `tax_amounts` on `CreditNoteLineItem`, `CreditNote`, and `InvoiceLineItem` |
| 19 | + * Remove support for `amount_excluding_tax` and `unit_amount_excluding_tax` on `CreditNoteLineItem` and `InvoiceLineItem` |
| 20 | + * Remove support for `coupon` on `CustomerCreateParams`, `CustomerUpdateParams`, `InvoiceCreatePreviewParams.schedule_details.phases[]`, `InvoiceCreatePreviewParams`, `SubscriptionCreateParams`, `SubscriptionSchedule.phases[]`, `SubscriptionScheduleCreateParams.phases[]`, `SubscriptionScheduleUpdateParams.phases[]`, and `SubscriptionUpdateParams` |
| 21 | + * Remove support for `promotion_code` on `CustomerCreateParams`, `CustomerUpdateParams`, `SubscriptionCreateParams`, and `SubscriptionUpdateParams` |
| 22 | + * Remove support for `price` on `InvoiceAddLinesParams.lines[]`, `InvoiceItemCreateParams`, `InvoiceItemUpdateParams`, `InvoiceItem`, `InvoiceLineItemUpdateParams`, `InvoiceLineItem`, and `InvoiceUpdateLinesParams.lines[]. Use `pricing` instead. |
| 23 | + * Remove support for `billing_thresholds` on `InvoiceCreatePreviewParams.schedule_details.phases[].items[]`, `InvoiceCreatePreviewParams.schedule_details.phases[]`, `InvoiceCreatePreviewParams.subscription_details.items[]`, `SubscriptionCreateParams.items[]`, `SubscriptionCreateParams`, `SubscriptionItemCreateParams`, `SubscriptionItemUpdateParams`, `SubscriptionItem`, `SubscriptionSchedule.default_settings`, `SubscriptionSchedule.phases[].items[]`, `SubscriptionSchedule.phases[]`, `SubscriptionScheduleCreateParams.default_settings`, `SubscriptionScheduleCreateParams.phases[].items[]`, `SubscriptionScheduleCreateParams.phases[]`, `SubscriptionScheduleUpdateParams.default_settings`, `SubscriptionScheduleUpdateParams.phases[].items[]`, `SubscriptionScheduleUpdateParams.phases[]`, `SubscriptionUpdateParams.items[]`, `SubscriptionUpdateParams`, and `Subscription` |
| 24 | + * Remove support for `application_fee_amount`, `charge`, `paid_out_of_band`, `paid`, `payment_intent`, `quote`, `subscription`, `subscription_details`, `subscription_proration_date`, `tax`, `total_tax_amounts`, and `transfer_data` on `Invoice` |
| 25 | + * Remove support for `discount` on `Invoice` and `Subscription` |
| 26 | + * Remove support for `invoice_item`, `proration_details`, `proration`, `tax_rates`, and `type` on `InvoiceLineItem` |
| 27 | + * Remove support for `plan` and `subscription_item` on `InvoiceItem` and `InvoiceLineItem` |
| 28 | + * Remove support for `unit_amount` on `InvoiceItemCreateParams`, `InvoiceItemUpdateParams`, and `InvoiceItem` |
| 29 | + * Remove support for `subscription` and `unit_amount_decimal` on `InvoiceItem` |
| 30 | + * Remove support for `naver_pay` on `PaymentMethodUpdateParams` |
| 31 | + * Remove support for `aggregate_usage` on `PlanCreateParams`, `Plan`, `Price.recurring`, and `PriceCreateParams.recurring` |
| 32 | + * Remove support for `current_period_end` and `current_period_start` on `Subscription` |
| 33 | + * `page` has been removed from all V2 list method params (e.g. `EventService.list()`); use the [auto paginator](https://github.com/stripe/stripe-node?tab=readme-ov-file#auto-pagination) or the `next_page_url` and `previous_page_url` fields instead ([more info](https://docs.stripe.com/api-v2-overview#list-pagination)) |
| 34 | + |
| 35 | + ### Changes |
| 36 | + |
| 37 | + * Change `Checkout.Session.collected_information` to be required |
| 38 | + * Change `Checkout.Session.collected_information.shipping_details` to be required |
| 39 | + * Change `Checkout.Session.collected_information.shipping_details.address` to be required |
| 40 | + * Change `Checkout.Session.collected_information.shipping_details.name` to be required |
| 41 | + * Change `PaymentIntentConfirmParams.payment_method_options.wechat_pay.client`, `PaymentIntentCreateParams.payment_method_options.wechat_pay.client`, and `PaymentIntentUpdateParams.payment_method_options.wechat_pay.client` to be optional |
| 42 | + * Change `political_exposure` on resources `Person` and `Token` and params `Token.CreateParams` from string to enum("existing" | "none") |
| 43 | + |
| 44 | + ### Additions |
| 45 | + |
| 46 | + * Add support for new resource `InvoicePayment` |
| 47 | + * Add support for `list` and `retrieve` methods on resource `InvoicePayment` |
| 48 | + * Add support for `billie_payments`, `nz_bank_account_becs_debit_payments`, and `satispay_payments` on `Account.capabilities`, `AccountCreateParams.capabilities`, and `AccountUpdateParams.capabilities` |
| 49 | + * Add support for `hosted_payment_method_save` on `Account.settings.invoices` and `AccountUpdateParams.settings.invoices` |
| 50 | + * Add support for `invoices` on `AccountCreateParams.settings` |
| 51 | + * Add support for new values `information_missing`, `invalid_signator`, `verification_failed_authorizer_authority`, and `verification_rejected_ownership_exemption_reason` on enums `Account.future_requirements.errors[].code`, `Account.requirements.errors[].code`, `AccountCapability.future_requirements.errors[].code`, `AccountCapability.requirements.errors[].code`, `AccountPerson.future_requirements.errors[].code`, `AccountPerson.requirements.errors[].code`, `BankAccount.future_requirements.errors[].code`, and `BankAccount.requirements.errors[].code` |
| 52 | + * Add support for new values `forwarding_api_retryable_upstream_error` and `setup_intent_mobile_wallet_unsupported` on enums `Invoice.last_finalization_error.code`, `PaymentIntent.last_payment_error.code`, `SetupAttempt.setup_error.code`, `SetupIntent.last_setup_error.code`, and `StripeError.code` |
| 53 | + * Add support for new values `stripe_balance_payment_debit_reversal` and `stripe_balance_payment_debit` on enum `BalanceTransaction.type` |
| 54 | + * Add support for new value `last` on enums `Billing.Meter.default_aggregation.formula` and `Billing.MeterCreateParams.default_aggregation.formula` |
| 55 | + * Add support for `presentment_details` on `Charge`, `Checkout.Session`, `PaymentIntent`, and `Refund` |
| 56 | + * Add support for `billie` and `satispay` on `Charge.payment_method_details`, `ConfirmationToken.payment_method_preview`, `ConfirmationTokenCreateParams.testHelpers.payment_method_data`, `CustomerPaymentMethod`, `PaymentIntentConfirmParams.payment_method_data`, `PaymentIntentCreateParams.payment_method_data`, `PaymentIntentUpdateParams.payment_method_data`, `PaymentMethodConfigurationCreateParams`, `PaymentMethodConfigurationUpdateParams`, `PaymentMethodConfiguration`, `PaymentMethodCreateParams`, `PaymentMethod`, `SetupIntentConfirmParams.payment_method_data`, `SetupIntentCreateParams.payment_method_data`, and `SetupIntentUpdateParams.payment_method_data` |
| 57 | + * Add support for `nz_bank_account` on `Charge.payment_method_details`, `ConfirmationToken.payment_method_preview`, `ConfirmationTokenCreateParams.testHelpers.payment_method_data`, `CustomerPaymentMethod`, `Mandate.payment_method_details`, `PaymentIntent.payment_method_options`, `PaymentIntentConfirmParams.payment_method_data`, `PaymentIntentConfirmParams.payment_method_options`, `PaymentIntentCreateParams.payment_method_data`, `PaymentIntentCreateParams.payment_method_options`, `PaymentIntentUpdateParams.payment_method_data`, `PaymentIntentUpdateParams.payment_method_options`, `PaymentMethodConfigurationCreateParams`, `PaymentMethodConfigurationUpdateParams`, `PaymentMethodConfiguration`, `PaymentMethodCreateParams`, `PaymentMethod`, `SetupAttempt.payment_method_details`, `SetupIntentConfirmParams.payment_method_data`, `SetupIntentCreateParams.payment_method_data`, and `SetupIntentUpdateParams.payment_method_data` |
| 58 | + * Add support for `optional_items` on `Checkout.SessionCreateParams`, `Checkout.Session`, `PaymentLinkCreateParams`, and `PaymentLink` |
| 59 | + * Add support for `permissions` on `Checkout.SessionCreateParams` and `Checkout.Session` |
| 60 | + * Add support for new values `billie` and `satispay` on enum `Checkout.SessionCreateParams.payment_method_types` |
| 61 | + * Add support for new value `custom` on enums `Checkout.Session.ui_mode` and `Checkout.SessionCreateParams.ui_mode` |
| 62 | + * Add support for `shipping_options` on `Checkout.SessionUpdateParams` |
| 63 | + * Add support for new values `billie`, `nz_bank_account`, and `satispay` on enums `ConfirmationTokenCreateParams.testHelpers.payment_method_data.type`, `PaymentIntentConfirmParams.payment_method_data.type`, `PaymentIntentCreateParams.payment_method_data.type`, `PaymentIntentUpdateParams.payment_method_data.type`, `SetupIntentConfirmParams.payment_method_data.type`, `SetupIntentCreateParams.payment_method_data.type`, and `SetupIntentUpdateParams.payment_method_data.type` |
| 64 | + * Add support for `buyer_id` on `ConfirmationToken.payment_method_preview.naver_pay`, `CustomerPaymentMethod.naver_pay`, and `PaymentMethod.naver_pay` |
| 65 | + * Add support for new values `billie`, `nz_bank_account`, and `satispay` on enums `ConfirmationToken.payment_method_preview.type`, `CustomerPaymentMethod.type`, and `PaymentMethod.type` |
| 66 | + * Add support for `refunds` on `CreditNoteCreateParams`, `CreditNoteListPreviewLineItemsParams`, `CreditNotePreviewParams`, and `CreditNote` |
| 67 | + * Add support for `total_taxes` on `CreditNote` and `Invoice` |
| 68 | + * Add support for `taxes` on `CreditNoteLineItem` and `InvoiceLineItem` |
| 69 | + * Add support for `checkout_session` on `CustomerBalanceTransaction` |
| 70 | + * Add support for new values `checkout_session_subscription_payment_canceled` and `checkout_session_subscription_payment` on enum `CustomerBalanceTransaction.type` |
| 71 | + * Add support for new values `billie`, `nz_bank_account`, and `satispay` on enums `CustomerPaymentMethodListParams.type`, `PaymentMethodCreateParams.type`, and `PaymentMethodListParams.type` |
| 72 | + * Add support for new value `invoice.overpaid` on enum `Event.type` |
| 73 | + * Add support for new values `klarna` and `nz_bank_account` on enums `Invoice.payment_settings.payment_method_types`, `InvoiceCreateParams.payment_settings.payment_method_types`, `InvoiceUpdateParams.payment_settings.payment_method_types`, `Subscription.payment_settings.payment_method_types`, `SubscriptionCreateParams.payment_settings.payment_method_types`, and `SubscriptionUpdateParams.payment_settings.payment_method_types` |
| 74 | + * Add support for `pricing` on `InvoiceAddLinesParams.lines[]`, `InvoiceItemCreateParams`, `InvoiceItemUpdateParams`, `InvoiceItem`, `InvoiceLineItemUpdateParams`, `InvoiceLineItem`, and `InvoiceUpdateLinesParams.lines[]` |
| 75 | + * Add support for `taxability_reason` on `InvoiceAddLinesParams.lines[].tax_amounts[]`, `InvoiceLineItemUpdateParams.tax_amounts[]`, and `InvoiceUpdateLinesParams.lines[].tax_amounts[]` |
| 76 | + * Add support for `jurisdiction_level` on `InvoiceAddLinesParams.lines[].tax_amounts[].tax_rate_data`, `InvoiceLineItemUpdateParams.tax_amounts[].tax_rate_data`, and `InvoiceUpdateLinesParams.lines[].tax_amounts[].tax_rate_data` |
| 77 | + * Add support for `amount_overpaid`, `confirmation_secret`, and `payments` on `Invoice` |
| 78 | + * Add support for `parent` on `InvoiceItem`, `InvoiceLineItem`, and `Invoice` |
| 79 | + * Add support for new value `expired` on enums `Issuing.Authorization.status` and `Issuing.AuthorizationListParams.status` |
| 80 | + * Add support for new value `network_fallback` on enum `Issuing.Authorization.request_history[].reason` |
| 81 | + * Add support for `naver_pay` on `Mandate.payment_method_details` and `SetupAttempt.payment_method_details` |
| 82 | + * Add support for `setup_future_usage` on `PaymentIntent.payment_method_options.naver_pay`, `PaymentIntentConfirmParams.payment_method_options.naver_pay`, `PaymentIntentCreateParams.payment_method_options.naver_pay`, and `PaymentIntentUpdateParams.payment_method_options.naver_pay` |
| 83 | + * Add support for new value `expired` on enum `PaymentIntent.cancellation_reason` |
| 84 | + * Add support for `default_value` on `PaymentLink.custom_fields[].dropdown`, `PaymentLink.custom_fields[].numeric`, `PaymentLink.custom_fields[].text`, `PaymentLinkCreateParams.custom_fields[].dropdown`, `PaymentLinkCreateParams.custom_fields[].numeric`, `PaymentLinkCreateParams.custom_fields[].text`, `PaymentLinkUpdateParams.custom_fields[].dropdown`, `PaymentLinkUpdateParams.custom_fields[].numeric`, and `PaymentLinkUpdateParams.custom_fields[].text` |
| 85 | + * Add support for new values `billie` and `satispay` on enums `PaymentLink.payment_method_types`, `PaymentLinkCreateParams.payment_method_types`, and `PaymentLinkUpdateParams.payment_method_types` |
| 86 | + * Add support for `nz_bank_transfer` on `Refund.destination_details` |
| 87 | + * Add support for new value `canceled` on enum `Review.closed_reason` |
| 88 | + * Add support for `current_period_end` and `current_period_start` on `SubscriptionItem` |
| 89 | + * Add support for `wifi` on `Terminal.ConfigurationCreateParams`, `Terminal.ConfigurationUpdateParams`, and `Terminal.Configuration` |
| 90 | + * Add support for new value `invoice.overpaid` on enums `WebhookEndpointCreateParams.enabled_events` and `WebhookEndpointUpdateParams.enabled_events` |
| 91 | + * Add support for new values `2025-03-01.dashboard` and `2025-03-31.basil` on enum `WebhookEndpointCreateParams.api_version` |
| 92 | + |
| 93 | +### ⚠️ Other Breaking changes in the SDK |
| 94 | +* [#2277](https://github.com/stripe/stripe-node/pull/2277) Swap Stripe.webhooks from a factory function to a static property |
| 95 | + - `Stripe.webhooks` and `Stripe().webhooks` are no longer functions (just plain objects) |
| 96 | + - if you were already treating those properties as plain objects (per the types), then you can ignore this change |
| 97 | + - if you were calling `Stripe.webhooks().someMethod()`, you should use `Stripe.webhooks.someMethod()` instead |
| 98 | + - there shouldn't be user-facing functionality changing, just a slight breaking change in our internal organization |
| 99 | +* [#2286](https://github.com/stripe/stripe-node/pull/2286) Remove types that were marked as deprecated in Feb 2024 |
| 100 | + * Remove `AccountDebitSource` in favor of `Account` |
| 101 | + * Remove `CapabilityListParams` in favor of `AccountListCapabilitiesParams` |
| 102 | + * Remove `CapabilityRetrieveParams` in favor of `AccountRetrieveCapabilityParams` |
| 103 | + * Remove `CapabilityUpdateParams` in favor of `AccountUpdateCapabilityParams` |
| 104 | + * Remove `CashBalanceRetrieveParams` in favor of `CustomerRetrieveCashBalanceParams` |
| 105 | + * Remove `CashBalanceUpdateParams` in favor of `CustomerUpdateCashBalanceParams` |
| 106 | + * Remove `CreditNoteLineItemListParams` in favor of `CreditNoteListLineItemsParams` |
| 107 | + * Remove `CustomerBalanceTransactionCreateParams` in favor of `CustomerCreateBalanceTransactionParams` |
| 108 | + * Remove `CustomerBalanceTransactionListParams` in favor of `CustomerListBalanceTransactionsParams` |
| 109 | + * Remove `CustomerBalanceTransactionRetrieveParams` in favor of `CustomerRetrieveBalanceTransactionParams` |
| 110 | + * Remove `CustomerBalanceTransactionUpdateParams` in favor of `CustomerUpdateBalanceTransactionParams` |
| 111 | + * Remove `CustomerCashBalanceTransactionListParams` in favor of `CustomerListCashBalanceTransactionsParams` |
| 112 | + * Remove `CustomerCashBalanceTransactionRetrieveParams` in favor of `CustomerRetrieveCashBalanceTransactionParams` |
| 113 | + * Remove `CustomerSourceCreateParams` in favor of `CustomerCreateSourceParams` |
| 114 | + * Remove `CustomerSourceDeleteParams` in favor of `CustomerDeleteSourceParams` |
| 115 | + * Remove `CustomerSourceListParams` in favor of `CustomerListSourcesParams` |
| 116 | + * Remove `CustomerSourceRetrieveParams` in favor of `CustomerRetrieveSourceParams` |
| 117 | + * Remove `CustomerSourceUpdateParams` in favor of `CustomerUpdateSourceParams` |
| 118 | + * Remove `CustomerSourceVerifyParams` in favor of `CustomerVerifySourceParams` |
| 119 | + * Remove `ExternalAccountCreateParams` in favor of `AccountCreateExternalAccountParams` |
| 120 | + * Remove `ExternalAccountDeleteParams` in favor of `AccountDeleteExternalAccountParams` |
| 121 | + * Remove `ExternalAccountListParams` in favor of `AccountListExternalAccountsParams` |
| 122 | + * Remove `ExternalAccountRetrieveParams` in favor of `AccountRetrieveExternalAccountParams` |
| 123 | + * Remove `ExternalAccountUpdateParams` in favor of `AccountUpdateExternalAccountParams` |
| 124 | + * Remove `FeeRefundCreateParams` in favor of `ApplicationFeeCreateRefundParams` |
| 125 | + * Remove `FeeRefundListParams` in favor of `ApplicationFeeListRefundsParams` |
| 126 | + * Remove `FeeRefundRetrieveParams` in favor of `ApplicationFeeRetrieveRefundParams` |
| 127 | + * Remove `FeeRefundUpdateParams` in favor of `ApplicationFeeUpdateRefundParams` |
| 128 | + * Remove `InvoiceLineItemListParams` in favor of `InvoiceListLineItemsParams` |
| 129 | + * Remove `InvoiceLineItemUpdateParams` in favor of `InvoiceUpdateLineItemParams` |
| 130 | + * Remove `LoginLinkCreateParams` in favor of `AccountCreateLoginLinkParams` |
| 131 | + * Remove `PersonCreateParams` in favor of `AccountCreatePersonParams` |
| 132 | + * Remove `PersonDeleteParams` in favor of `AccountDeletePersonParams` |
| 133 | + * Remove `PersonListParams` in favor of `AccountListPersonsParams` |
| 134 | + * Remove `PersonRetrieveParams` in favor of `AccountRetrievePersonParams` |
| 135 | + * Remove `PersonUpdateParams` in favor of `AccountUpdatePersonParams` |
| 136 | + * Remove `TransferReversalCreateParams` in favor of `TransferCreateReversalParams` |
| 137 | + * Remove `TransferReversalListParams` in favor of `TransferListReversalsParams` |
| 138 | + * Remove `TransferReversalRetrieveParams` in favor of `TransferRetrieveReversalParams` |
| 139 | + * Remove `TransferReversalUpdateParams` in favor of `TransferUpdateReversalParams` |
| 140 | + |
2 | 141 | ## 17.7.0 - 2025-02-24
|
3 | 142 | * [#2256](https://github.com/stripe/stripe-node/pull/2256) Update generated code
|
4 | 143 | * Add support for `prices` on `Billing.CreditBalanceSummaryRetrieveParams.filter.applicability_scope`, `Billing.CreditGrant.applicability_config.scope`, and `Billing.CreditGrantCreateParams.applicability_config.scope`
|
|
0 commit comments