Skip to content

Deprecate PaymentSheet Constructors and FlowController.create() #10833

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Jun 13, 2025
Merged

Deprecate PaymentSheet Constructors and FlowController.create() #10833

Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
51eedb7
Update MIGRATING.md
cttsai-stripe May 20, 2025
4edccda
Deprecate PaymentSheet constructors
cttsai-stripe May 20, 2025
ab74053
Deprecate FlowController.create()
cttsai-stripe May 20, 2025
65f43a5
Deprecate rememberPaymentSheet and rememberPaymentSheetFlowController
cttsai-stripe May 20, 2025
cd3cccb
Suppress deprecation
cttsai-stripe May 21, 2025
3c4e5ef
Add replaceWith to deprecated Compose annotations
cttsai-stripe Jun 11, 2025
ed5a5e8
Update CHANGELOG.md and MIGRATING.md
cttsai-stripe Jun 11, 2025
ea07c01
Fix lint
cttsai-stripe Jun 11, 2025
ce3a2f2
Update CHANGELOG.md
cttsai-stripe Jun 12, 2025
73b8964
Apply suggestions from code review
cttsai-stripe Jun 12, 2025
0933629
Update MIGRATING.md
cttsai-stripe Jun 12, 2025
4e54149
Replace Builder with PaymentSheet.Builder
cttsai-stripe Jun 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

### PaymentSheet
* [ADDED][10935](https://github.com/stripe/stripe-android/pull/10935) Add `formInsetValues` method to `PaymentSheet.Appearance.Builder`.
* [DEPRECATED][10833](https://github.com/stripe/stripe-android/pull/10833) Deprecated PaymentSheet/FlowController constructors, create methods, and Compose remember functions in favor of new Builder pattern APIs.

## 21.17.0 - 2025-06-09

Expand Down
10 changes: 10 additions & 0 deletions MIGRATING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# Migration Guide

## Migrating from versions < 21.18.0
- Changes to `PaymentSheet`:
* The constructors have been deprecated and will be removed in a future release. Use `PaymentSheet.Builder` instead.
- Changes to `PaymentSheet.FlowController`:
* `FlowController.create()` has been deprecated and will be removed in a future release. Use `FlowController.Builder` instead.
- Changes to `rememberPaymentSheet`:
* The functions have been deprecated and will be removed in a future release. Use `PaymentSheet.Builder` with `remember` instead.
- Changes to `rememberPaymentSheetFlowController`:
* The functions have been deprecated and will be removed in a future release. Use `FlowController.Builder` with `remember` instead.

## Migrating from versions < 21.0.0
- Basic Integration has been removed. [Please use Mobile Payment Element instead](https://docs.stripe.com/payments/mobile/migrating-to-mobile-payment-element-from-basic-integration).
- Card image verification has been removed. [Please use card OCR instead](https://github.com/stripe/stripe-android/tree/master/stripecardscan#credit-card-ocr).
Expand Down
2 changes: 2 additions & 0 deletions paymentsheet/src/androidTest/java/com/stripe/android/paymentsheet/FlowControllerTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -338,6 +338,7 @@ internal class FlowControllerTest {
scenario.onActivity {
PaymentConfiguration.init(it, "pk_test_123")

@Suppress("Deprecation")
val unsynchronizedController = PaymentSheet.FlowController.create(
activity = it,
paymentOptionCallback = { paymentOption ->
Expand Down Expand Up @@ -404,6 +405,7 @@ internal class FlowControllerTest {
scenario.moveToState(Lifecycle.State.CREATED)
scenario.onActivity {
PaymentConfiguration.init(it, "pk_test_123")
@Suppress("Deprecation")
flowController = PaymentSheet.FlowController.create(
activity = it,
paymentOptionCallback = {
Expand Down
9 changes: 5 additions & 4 deletions .../androidTest/java/com/stripe/android/paymentsheet/PaymentSheetBillingConfigurationTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import com.stripe.android.networktesting.RequestMatchers.method
import com.stripe.android.networktesting.RequestMatchers.not
import com.stripe.android.networktesting.RequestMatchers.path
import com.stripe.android.networktesting.testBodyFromFile
import com.stripe.android.paymentsheet.PaymentSheet.Builder
import com.stripe.android.paymentsheet.utils.IntegrationType
import com.stripe.android.paymentsheet.utils.PaymentSheetLayoutType
import com.stripe.android.paymentsheet.utils.PaymentSheetLayoutTypeProvider
Expand Down Expand Up @@ -53,10 +54,10 @@ internal class PaymentSheetBillingConfigurationTest {
lateinit var paymentSheet: PaymentSheet
scenario.onActivity {
PaymentConfiguration.init(it, "pk_test_123")
paymentSheet = PaymentSheet(it) { result ->
paymentSheet = Builder { result ->
assertThat(result).isInstanceOf(PaymentSheetResult.Completed::class.java)
countDownLatch.countDown()
}
}.build(it)
}
scenario.moveToState(Lifecycle.State.RESUMED)
scenario.onActivity {
Expand Down Expand Up @@ -130,10 +131,10 @@ internal class PaymentSheetBillingConfigurationTest {
lateinit var paymentSheet: PaymentSheet
scenario.onActivity {
PaymentConfiguration.init(it, "pk_test_123")
paymentSheet = PaymentSheet(it) { result ->
paymentSheet = Builder { result ->
assertThat(result).isInstanceOf(PaymentSheetResult.Completed::class.java)
countDownLatch.countDown()
}
}.build(it)
}
scenario.moveToState(Lifecycle.State.RESUMED)
scenario.onActivity {
Expand Down
32 changes: 32 additions & 0 deletions paymentsheet/src/main/java/com/stripe/android/paymentsheet/FlowControllerCompose.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,14 @@ import java.util.UUID
* @param paymentResultCallback Called when a [PaymentSheetResult] is available.
*/
@Composable
@Deprecated(
message = "This will be removed in a future release. Use FlowController.Builder instead.",
replaceWith = ReplaceWith(
"remember(paymentOptionCallback, paymentResultCallback) { " +
"PaymentSheet.FlowController.Builder(paymentResultCallback, paymentOptionCallback) " +
"}.build()"
)
)
fun rememberPaymentSheetFlowController(
paymentOptionCallback: PaymentOptionCallback,
paymentResultCallback: PaymentSheetResultCallback,
Expand Down Expand Up @@ -49,6 +57,15 @@ fun rememberPaymentSheetFlowController(
* @param paymentResultCallback Called when a [PaymentSheetResult] is available.
*/
@Composable
@Deprecated(
message = "This will be removed in a future release. Use FlowController.Builder instead.",
replaceWith = ReplaceWith(
"remember(createIntentCallback, paymentOptionCallback, paymentResultCallback) { " +
"PaymentSheet.FlowController.Builder(paymentResultCallback, paymentOptionCallback)" +
".createIntentCallback(createIntentCallback) " +
"}.build()"
)
)
fun rememberPaymentSheetFlowController(
createIntentCallback: CreateIntentCallback,
paymentOptionCallback: PaymentOptionCallback,
Expand Down Expand Up @@ -82,6 +99,21 @@ fun rememberPaymentSheetFlowController(
* @param paymentResultCallback Called when a [PaymentSheetResult] is available.
*/
@Composable
@Deprecated(
message = "This will be removed in a future release. Use FlowController.Builder instead.",
replaceWith = ReplaceWith(
"remember(" +
"createIntentCallback, " +
"externalPaymentMethodConfirmHandler, " +
"paymentOptionCallback, " +
"paymentResultCallback" +
") { " +
"PaymentSheet.FlowController.Builder(paymentResultCallback, paymentOptionCallback)" +
".createIntentCallback(createIntentCallback)" +
".externalPaymentMethodConfirmHandler(externalPaymentMethodConfirmHandler) " +
"}.build()"
)
)
fun rememberPaymentSheetFlowController(
createIntentCallback: CreateIntentCallback? = null,
externalPaymentMethodConfirmHandler: ExternalPaymentMethodConfirmHandler,
Expand Down
120 changes: 120 additions & 0 deletions paymentsheet/src/main/java/com/stripe/android/paymentsheet/PaymentSheet.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,10 @@ class PaymentSheet internal constructor(
* @param activity The Activity that is presenting [PaymentSheet].
* @param callback Called with the result of the payment after [PaymentSheet] is dismissed.
*/
@Deprecated(
message = "This will be removed in a future release.",
replaceWith = ReplaceWith("Builder(callback).build(activity)")
)
constructor(
activity: ComponentActivity,
callback: PaymentSheetResultCallback
Expand All @@ -73,6 +77,14 @@ class PaymentSheet internal constructor(
* @param externalPaymentMethodConfirmHandler Called when a user confirms payment with an external payment method.
* @param callback Called with the result of the payment after [PaymentSheet] is dismissed.
*/
@Deprecated(
message = "This will be removed in a future release.",
replaceWith = ReplaceWith(
"Builder(callback)" +
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do these need a prefix? If not, why not?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You mean paymentResultCallback? No, we don't need that because the original constructor is

constructor(
        activity: ComponentActivity,
        externalPaymentMethodConfirmHandler: ExternalPaymentMethodConfirmHandler,
        callback: PaymentSheetResultCallback,
    )

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was referring to the Builder call. I thought it would need to be PaymentSheet.Builder or similar.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If using Android Studio to execute the replaceWith action, the IDE will add the import itself.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll add the prefix in case the users are using more than one Builder, eg. AlertDialog.Builder, etc.

".externalPaymentMethodConfirmHandler(externalPaymentMethodConfirmHandler)" +
".build(activity)"
)
)
constructor(
activity: ComponentActivity,
externalPaymentMethodConfirmHandler: ExternalPaymentMethodConfirmHandler,
Expand All @@ -96,6 +108,14 @@ class PaymentSheet internal constructor(
* @param paymentResultCallback Called with the result of the payment or setup after
* [PaymentSheet] is dismissed.
*/
@Deprecated(
message = "This will be removed in a future release.",
replaceWith = ReplaceWith(
"Builder(paymentResultCallback)" +
".createIntentCallback(createIntentCallback)" +
".build(activity)"
)
)
constructor(
activity: ComponentActivity,
createIntentCallback: CreateIntentCallback,
Expand All @@ -121,6 +141,15 @@ class PaymentSheet internal constructor(
* @param paymentResultCallback Called with the result of the payment or setup after
* [PaymentSheet] is dismissed.
*/
@Deprecated(
message = "This will be removed in a future release.",
replaceWith = ReplaceWith(
"Builder(paymentResultCallback)" +
".createIntentCallback(createIntentCallback)" +
".externalPaymentMethodConfirmHandler(externalPaymentMethodConfirmHandler)" +
".build(activity)"
)
)
constructor(
activity: ComponentActivity,
createIntentCallback: CreateIntentCallback,
Expand All @@ -143,6 +172,10 @@ class PaymentSheet internal constructor(
* @param fragment the Fragment that is presenting the payment sheet.
* @param callback called with the result of the payment after the payment sheet is dismissed.
*/
@Deprecated(
message = "This will be removed in a future release.",
replaceWith = ReplaceWith("Builder(callback).build(fragment)")
)
constructor(
fragment: Fragment,
callback: PaymentSheetResultCallback
Expand All @@ -158,6 +191,14 @@ class PaymentSheet internal constructor(
* @param externalPaymentMethodConfirmHandler Called when a user confirms payment with an external payment method.
* @param callback called with the result of the payment after the payment sheet is dismissed.
*/
@Deprecated(
message = "This will be removed in a future release.",
replaceWith = ReplaceWith(
"Builder(callback)" +
".externalPaymentMethodConfirmHandler(externalPaymentMethodConfirmHandler)" +
".build(fragment)"
)
)
constructor(
fragment: Fragment,
externalPaymentMethodConfirmHandler: ExternalPaymentMethodConfirmHandler,
Expand All @@ -181,6 +222,14 @@ class PaymentSheet internal constructor(
* @param paymentResultCallback Called with the result of the payment or setup after
* [PaymentSheet] is dismissed.
*/
@Deprecated(
message = "This will be removed in a future release.",
replaceWith = ReplaceWith(
"Builder(paymentResultCallback)" +
".createIntentCallback(createIntentCallback)" +
".build(fragment)"
)
)
constructor(
fragment: Fragment,
createIntentCallback: CreateIntentCallback,
Expand All @@ -206,6 +255,15 @@ class PaymentSheet internal constructor(
* @param paymentResultCallback Called with the result of the payment or setup after
* [PaymentSheet] is dismissed.
*/
@Deprecated(
message = "This will be removed in a future release.",
replaceWith = ReplaceWith(
"Builder(paymentResultCallback)" +
".createIntentCallback(createIntentCallback)" +
".externalPaymentMethodConfirmHandler(externalPaymentMethodConfirmHandler)" +
".build(fragment)"
)
)
constructor(
fragment: Fragment,
createIntentCallback: CreateIntentCallback,
Expand Down Expand Up @@ -2648,6 +2706,12 @@ class PaymentSheet internal constructor(
* [PaymentSheet] is dismissed.
*/
@JvmStatic
@Deprecated(
message = "This will be removed in a future release.",
replaceWith = ReplaceWith(
"FlowController.Builder(paymentResultCallback, paymentOptionCallback).build(activity)"
)
)
fun create(
activity: ComponentActivity,
paymentOptionCallback: PaymentOptionCallback,
Expand Down Expand Up @@ -2675,6 +2739,14 @@ class PaymentSheet internal constructor(
* [PaymentSheet] is dismissed.
*/
@JvmStatic
@Deprecated(
message = "This will be removed in a future release.",
replaceWith = ReplaceWith(
"FlowController.Builder(paymentResultCallback, paymentOptionCallback)" +
".externalPaymentMethodConfirmHandler(externalPaymentMethodConfirmHandler)" +
".build(activity)"
)
)
fun create(
activity: ComponentActivity,
externalPaymentMethodConfirmHandler: ExternalPaymentMethodConfirmHandler,
Expand Down Expand Up @@ -2705,6 +2777,14 @@ class PaymentSheet internal constructor(
* [PaymentSheet] is dismissed.
*/
@JvmStatic
@Deprecated(
message = "This will be removed in a future release.",
replaceWith = ReplaceWith(
"FlowController.Builder(paymentResultCallback, paymentOptionCallback)" +
".createIntentCallback(createIntentCallback)" +
".build(activity)"
)
)
fun create(
activity: ComponentActivity,
paymentOptionCallback: PaymentOptionCallback,
Expand Down Expand Up @@ -2739,6 +2819,15 @@ class PaymentSheet internal constructor(
* [PaymentSheet] is dismissed.
*/
@JvmStatic
@Deprecated(
message = "This will be removed in a future release.",
replaceWith = ReplaceWith(
"FlowController.Builder(paymentResultCallback, paymentOptionCallback)" +
".createIntentCallback(createIntentCallback)" +
".externalPaymentMethodConfirmHandler(externalPaymentMethodConfirmHandler)" +
".build(activity)"
)
)
fun create(
activity: ComponentActivity,
paymentOptionCallback: PaymentOptionCallback,
Expand Down Expand Up @@ -2768,6 +2857,12 @@ class PaymentSheet internal constructor(
* @param paymentResultCallback called when a [PaymentSheetResult] is available.
*/
@JvmStatic
@Deprecated(
message = "This will be removed in a future release.",
replaceWith = ReplaceWith(
"FlowController.Builder(paymentResultCallback, paymentOptionCallback).build(fragment)"
)
)
fun create(
fragment: Fragment,
paymentOptionCallback: PaymentOptionCallback,
Expand All @@ -2793,6 +2888,14 @@ class PaymentSheet internal constructor(
* @param paymentResultCallback called when a [PaymentSheetResult] is available.
*/
@JvmStatic
@Deprecated(
message = "This will be removed in a future release.",
replaceWith = ReplaceWith(
"FlowController.Builder(paymentResultCallback, paymentOptionCallback)" +
".externalPaymentMethodConfirmHandler(externalPaymentMethodConfirmHandler)" +
".build(fragment)"
)
)
fun create(
fragment: Fragment,
externalPaymentMethodConfirmHandler: ExternalPaymentMethodConfirmHandler,
Expand Down Expand Up @@ -2823,6 +2926,14 @@ class PaymentSheet internal constructor(
* [PaymentSheet] is dismissed.
*/
@JvmStatic
@Deprecated(
message = "This will be removed in a future release.",
replaceWith = ReplaceWith(
"FlowController.Builder(paymentResultCallback, paymentOptionCallback)" +
".createIntentCallback(createIntentCallback)" +
".build(fragment)"
)
)
fun create(
fragment: Fragment,
paymentOptionCallback: PaymentOptionCallback,
Expand Down Expand Up @@ -2857,6 +2968,15 @@ class PaymentSheet internal constructor(
* [PaymentSheet] is dismissed.
*/
@JvmStatic
@Deprecated(
message = "This will be removed in a future release.",
replaceWith = ReplaceWith(
"FlowController.Builder(paymentResultCallback, paymentOptionCallback)" +
".createIntentCallback(createIntentCallback)" +
".externalPaymentMethodConfirmHandler(externalPaymentMethodConfirmHandler)" +
".build(fragment)"
)
)
fun create(
fragment: Fragment,
paymentOptionCallback: PaymentOptionCallback,
Expand Down
Loading
Loading