Skip to content

Upgrading stripe 2 to 3

Breaking2.76.0 → 3.5.0Breaking4New8Changed3Fixed2Other2

Full comparisonBack to stripe
BreakingUpgrade verdict

3 breaking changes.

In plain terms
  • The way code works with orders has been redesigned. Some old order actions are gone and new ones are available.
  • Two order-related data types are no longer part of the library.
  • The function for refreshing a financial connections account has a new name.
Must act 3 items need code or config changes

stripe publishes an official migration guide for version 3. It covers more than the release notes do.

Migration guide ↗

What you must change

Breaking3
Replaces the legacy Order API with the new Order API, adding cancel, list_line_items, reopen, and submit and removing pay and return_order.
Ordercancellist_line_itemsreopensubmitpayreturn_orderOrderItem
3.0.0GitHub ReleaseSummarizedView source
Removes the OrderItem and OrderReturn resources.
OrderItemOrderReturn
3.0.0GitHub ReleaseSummarizedView source
Renames financial_connections.account.refresh to financial_connections.refresh_account.
financial_connections.account.refreshfinancial_connections.refresh_account
3.0.0GitHub ReleaseSummarizedView source

API changes

Generated by DepDelta from published Python source. Not mixed with prose notes.

  • removed: export OrderReturn
  • added: export apps
  • added: export treasury
  • changed: method Account.persons(**params) → method Account.persons(idempotency_key=…, **params)
  • added: export Secret
  • added: class Secret(CreateableAPIResource, ListableAPIResource)
  • added: field Secret.OBJECT_NAME
  • added: static method Secret.delete_where(api_key=…, stripe_version=…, stripe_account=…, **params)
  • added: static method Secret.find(api_key=…, stripe_version=…, stripe_account=…, **params)
  • added: static method Balance.class_url()
  • added: class Customer.TestHelpers(APIResourceTestHelpers)
  • added: method Customer.TestHelpers.fund_cash_balance(idempotency_key=…, **params)
  • added: method Customer.retrieve_payment_method(payment_method, idempotency_key=…, **params)
  • added: static method Customer.modify_cash_balance(customer, nested_id=…, api_key=…, stripe_version=…, stripe_account=…, **params)
  • added: static method Customer.retrieve_cash_balance(customer, nested_id=…, api_key=…, stripe_version=…, stripe_account=…, **params)
  • removed: method Account.refresh(idempotency_key=…, **params)
  • changed: class Account(APIResource) → class Account(ListableAPIResource)
  • added: method Account.list_owners(idempotency_key=…, **params)
  • added: method Account.refresh_account(idempotency_key=…, **params)
  • added: class Card.TestHelpers(APIResourceTestHelpers)
  • added: method Card.TestHelpers.deliver_card(idempotency_key=…, **params)
  • added: method Card.TestHelpers.fail_card(idempotency_key=…, **params)
  • added: method Card.TestHelpers.return_card(idempotency_key=…, **params)
  • added: method Card.TestHelpers.ship_card(idempotency_key=…, **params)
  • removed: method Order.pay(idempotency_key=…, **params)
  • removed: method Order.return_order(idempotency_key=…, **params)
  • added: method Order.cancel(idempotency_key=…, **params)
  • added: method Order.list_line_items(idempotency_key=…, **params)
  • added: method Order.reopen(idempotency_key=…, **params)
  • added: method Order.submit(idempotency_key=…, **params)
  • removed: class OrderReturn(ListableAPIResource)
  • removed: field OrderReturn.OBJECT_NAME
  • added: export CreditReversal
  • added: export DebitReversal
  • added: export FinancialAccount
  • added: export InboundTransfer
  • added: export OutboundPayment
  • added: export OutboundTransfer
  • added: export ReceivedCredit
  • added: export ReceivedDebit
  • added: export Transaction
  • added: export TransactionEntry
  • added: class CreditReversal(CreateableAPIResource, ListableAPIResource)
  • added: field CreditReversal.OBJECT_NAME
  • added: class DebitReversal(CreateableAPIResource, ListableAPIResource)
  • added: field DebitReversal.OBJECT_NAME
  • added: class FinancialAccount(CreateableAPIResource, ListableAPIResource, UpdateableAPIResource)
  • added: field FinancialAccount.OBJECT_NAME
  • added: method FinancialAccount.retrieve_features(idempotency_key=…, **params)
  • added: method FinancialAccount.update_features(idempotency_key=…, **params)
  • added: class InboundTransfer(CreateableAPIResource, ListableAPIResource)
  • added: class InboundTransfer.TestHelpers(APIResourceTestHelpers)
  • added: field InboundTransfer.OBJECT_NAME
  • added: method InboundTransfer.TestHelpers.fail(idempotency_key=…, **params)
  • added: method InboundTransfer.TestHelpers.return_inbound_transfer(idempotency_key=…, **params)
  • added: method InboundTransfer.TestHelpers.succeed(idempotency_key=…, **params)
  • added: method InboundTransfer.cancel(idempotency_key=…, **params)
  • added: class OutboundPayment(CreateableAPIResource, ListableAPIResource)
  • added: class OutboundPayment.TestHelpers(APIResourceTestHelpers)
  • added: field OutboundPayment.OBJECT_NAME
  • added: method OutboundPayment.TestHelpers.fail(idempotency_key=…, **params)
  • added: method OutboundPayment.TestHelpers.post(idempotency_key=…, **params)
  • added: method OutboundPayment.TestHelpers.return_outbound_payment(idempotency_key=…, **params)
  • added: method OutboundPayment.cancel(idempotency_key=…, **params)
  • added: class OutboundTransfer(CreateableAPIResource, ListableAPIResource)
  • added: class OutboundTransfer.TestHelpers(APIResourceTestHelpers)
  • added: field OutboundTransfer.OBJECT_NAME
  • added: method OutboundTransfer.TestHelpers.fail(idempotency_key=…, **params)
  • added: method OutboundTransfer.TestHelpers.post(idempotency_key=…, **params)
  • added: method OutboundTransfer.TestHelpers.return_outbound_transfer(idempotency_key=…, **params)
  • added: method OutboundTransfer.cancel(idempotency_key=…, **params)
  • added: class ReceivedCredit(ListableAPIResource)
  • added: class ReceivedCredit.TestHelpers(APIResourceTestHelpers)
  • added: field ReceivedCredit.OBJECT_NAME
  • added: static method ReceivedCredit.TestHelpers.create(api_key=…, stripe_version=…, stripe_account=…, **params)
  • added: class ReceivedDebit(ListableAPIResource)
  • added: class ReceivedDebit.TestHelpers(APIResourceTestHelpers)
  • added: field ReceivedDebit.OBJECT_NAME
  • added: static method ReceivedDebit.TestHelpers.create(api_key=…, stripe_version=…, stripe_account=…, **params)
  • added: class Transaction(ListableAPIResource)
  • added: field Transaction.OBJECT_NAME
  • added: class TransactionEntry(ListableAPIResource)
  • added: field TransactionEntry.OBJECT_NAME
  • added: static method TransactionEntry.class_url()
  • added: function assertNotRegex(self, *args, **kwargs)
  • added: variable spec_from_loader