Skip to content

Migration guide for v10

Kamil Pajdzik edited this page Oct 6, 2022 · 2 revisions

Changes in 10.0.0 - 2022-08-01

Major version release for API version 2020-08-27. "⚠️" symbol highlights breaking changes.

⚠️ Changed

  • Change type of business_profile, business_type, country, default_currency, and settings properties on Account resource to be nullable.
  • Change type of currency property on Checkout.Session resource from string to 'cad' | 'usd'.
  • Change location of TypeScript definitions for CreditNoteLineItemListPreviewParams, CreditNoteLineItemListPreviewParams.Line, CreditNoteLineItemListPreviewParams.Line.Type, and CreditNoteLineItemListPreviewParams.Line.Reason interfaces from CreditNoteLineItems.d.ts to CreditNotes.d.ts.
  • Change type of address, currency, delinquent, discount, invoice_prefix, name, phone, and preferred_locales properties on Customer resource to be nullable.
  • Rename InvoiceRetrieveUpcomingParams to InvoiceListUpcomingLinesParams.
  • Change type of id property on Invoice resource to be nullable. The definition is used for both Invoice and UpcomingInvoice and does not always have an ID.

⚠️ Removed

  • Remove for AlipayAccount, DeletedAlipayAccount, BitcoinReceiver, DeletedBitcoinReceiver, BitcoinTransaction, and BitcoinTransactionListParams definitions.
  • Remove AlipayAccount and BitcoinReceiver from CustomerSource.
  • Remove Stripe.DeletedAlipayAccount and Stripe.DeletedBitcoinReceiver from possible values of source property in PaymentIntent.
  • Remove IssuerFraudRecord, IssuerFraudRecordRetrieveParams, IssuerFraudRecordListParams, and IssuerFraudRecordsResource, definitions.
  • Remove treasury.received_credit.reversed webhook event constant. Please use treasury.received_credit.returned instead.
  • Remove order.payment_failed, transfer.failed, and transfer.paid. The events were deprecated.
  • Remove retrieveDetails method from Issuing.Card resource. The method was unsupported. Read more at https://stripe.com/docs/issuing/cards/virtual.
  • Remove Issuing.CardDetails and CardRetrieveDetailsParams definition.
  • Remove IssuerFraudRecords resource.
  • Remove Recipient resource andrecipient property from Card resource.
  • Remove InvoiceMarkUncollectibleParams definition.
  • Remove deprecated Stripe.Errors and StripeError (and derived StripeCardError, StripeInvalidRequestError, StripeAPIError, StripeAuthenticationError, StripePermissionError, StripeRateLimitError, StripeConnectionError, StripeSignatureVerificationError, StripeIdempotencyError, and StripeInvalidGrantError) definitions.
  • Remove redirect_url from LoginLinks definition. The property is no longer supported.
  • Remove LineItemListParams definition. The interface was no longer in use.

⚠️ Renamed

  • Rename listUpcomingLineItems method on Invoice resource to listUpcomingLines.
  • Rename InvoiceLineItemListUpcomingParams to InvoiceListUpcomingLinesParams.
  • Rename InvoiceRetrieveUpcomingParams to InvoiceListUpcomingLinesParams.

Read more at https://stripe.com/docs/upgrades