Added new billing amount breakdown #1562

stechiu · 2025-04-28T19:38:12Z

We are expanding support of RBA metadata to the PayPal Checkout Vault with Purchase flow. New parameters have been added to RBA, particularly Billing Amount Breakdown.

Path: /v1/paypal_hermes/create_payment_resource

Post Body:

"plan_metadata": {
        "billing_cycles": [{
            "billing_frequency": 1,
            "billing_frequency_unit": "MONTH",
            "number_of_executions": 1,
            "sequence": 1,
            "start_date": "2024-04-06T00:00:00Z",
            "trial": true,
            "pricing_scheme": {
                "pricing_model": "FIXED",
                "price": "9.99",
                "reload_threshold_amount": "99.99"
            }
        }],
        "currency_iso_code": "USD",
        "name": "Netflix w/ Ads",
🆕      "unit_amount": "20.00",
        "product_description": "iPhone 13",
        "product_quantity": 1,
        "one_time_fee_amount": "9.99",
        "shipping_amount": "1.99",
        "product_price": "19.99",
        "tax_amount": "0.59",
        "total_amount": "32.56",
🆕      "amount_breakdown": {
          "item_total": "20.00",
          "shipping": "0.99",
          "handling": "0.99",
          "tax_total": "1.99",
          "insurance": "0",
          "shipping_discount": "0",
          "discount" : "0"
        }
    }
}

Summary of changes

Add unitAmount of type String to BTPayPalRecurringBillingDetails
Add new BTRecurringBillingAmountBreakdown class: itemTotal, shipping, handling, taxTotal, insurance, shippingDiscount, discount
Add amountBreakdown of type BTRecurringBillingAmountBreakdown to BTPayPalRecurringBillingDetails
Add recurringBillingDetails and recurringBillingPlanType to BTPayPalCheckoutRequest

Checklist

Added a changelog entry
Tested and confirmed payment flows affected by this change are functioning as expected

Authors

List GitHub usernames for everyone who contributed to this pull request.

@stechiu

Sources/BraintreePayPal/BTPayPalCheckoutRequest.swift

UnitTests/BraintreePayPalTests/BTPayPalVaultRequest_Tests.swift

Sources/BraintreePayPal/RecurringBillingMetadata/BTRecurringBillingAmountBreakdown.swift

Sources/BraintreePayPal/RecurringBillingMetadata/BTPayPalRecurringBillingDetails.swift

UnitTests/BraintreePayPalTests/BTPayPalVaultRequest_Tests.swift

Sources/BraintreePayPal/BTPayPalCheckoutRequest.swift

CHANGELOG.md

UnitTests/BraintreePayPalTests/BTPayPalCheckoutRequest_Tests.swift

Sources/BraintreePayPal/BTPayPalCheckoutRequest.swift

Sources/BraintreePayPal/BTPayPalVaultRequest.swift

Sources/BraintreePayPal/RecurringBillingMetadata/BTAmountBreakdown.swift

CHANGELOG.md

Sources/BraintreePayPal/BTPayPalCheckoutRequest.swift

Sources/BraintreePayPal/BTPayPalVaultRequest.swift

Sources/BraintreePayPal/BTPayPalCheckoutRequest.swift

Sources/BraintreePayPal/BTPayPalVaultRequest.swift

Sources/BraintreePayPal/RecurringBillingMetadata/BTAmountBreakdown.swift

…down.swift Co-authored-by: Jax DesMarais-Leder <jdesmarais@paypal.com>

… into rba-amount

Sources/BraintreePayPal/RecurringBillingMetadata/BTAmountBreakdown.swift

Sources/BraintreePayPal/BTPayPalVaultBaseRequest.swift

Sources/BraintreePayPal/RecurringBillingMetadata/BTAmountBreakdown.swift

…down.swift Co-authored-by: Rich Herrera <ricardherrera@paypal.com>

…down.swift Co-authored-by: Jax DesMarais-Leder <jdesmarais@paypal.com>

… into rba-amount

Sources/BraintreePayPal/BTPayPalVaultBaseRequest.swift

Co-authored-by: Jax DesMarais-Leder <jdesmarais@paypal.com>

agedd · 2025-05-13T17:38:46Z

Sources/BraintreePayPal/RecurringBillingMetadata/BTAmountBreakdown.swift

+import Foundation
+
+/// A recurring billing amount breakdown.
+///


nit: remove extra comment line

Suggested change

///

///

I had suggested this in an earlier PR to improve readability. :)

agedd · 2025-05-13T17:40:12Z

UnitTests/BraintreePayPalTests/BTPayPalLineItem_Tests.swift

@@ -5,7 +5,7 @@ import XCTest
 class BTPayPalLineItem_Tests: XCTestCase {

    func testUPCTypeStringReturnsCorrectValue() {
-        var lineItem = BTPayPalLineItem(quantity: "1", unitAmount: "10", name: "item-name", kind: .debit)
+        let lineItem = BTPayPalLineItem(quantity: "1", unitAmount: "10", name: "item-name", kind: .debit)


curious why we need to change from var to let here

agedd

looks great to me, just added a few minor comments

jaxdesmarais · 2025-05-13T18:02:00Z

Sources/BraintreePayPal/RecurringBillingMetadata/BTAmountBreakdown.swift

+import Foundation
+
+/// A recurring billing amount breakdown.
+///


I had suggested this in an earlier PR to improve readability. :)

… into rba-amount

Added new billing amount breakdown

974ca5d

stechiu requested a review from a team as a code owner April 28, 2025 19:38

stechiu added 3 commits April 28, 2025 12:44

Updated optional types

824c491

Removed unnecessary parameters

b77fab0

Fixed Lint error and unit tests

de85d09

stechiu changed the base branch from main to checkout-rba-metadata-feature April 28, 2025 22:08

richherrera reviewed Apr 28, 2025

View reviewed changes

Sources/BraintreePayPal/BTPayPalCheckoutRequest.swift Show resolved Hide resolved

UnitTests/BraintreePayPalTests/BTPayPalVaultRequest_Tests.swift Outdated Show resolved Hide resolved

stechiu added 2 commits April 29, 2025 22:19

Added CHANGELOG

48805db

Added docstrings and unit tests

2d06b01

sarahkoop reviewed May 1, 2025

View reviewed changes

Sources/BraintreePayPal/RecurringBillingMetadata/BTRecurringBillingAmountBreakdown.swift Outdated Show resolved Hide resolved

sarahkoop reviewed May 1, 2025

View reviewed changes

Sources/BraintreePayPal/RecurringBillingMetadata/BTRecurringBillingAmountBreakdown.swift Outdated Show resolved Hide resolved

sarahkoop reviewed May 1, 2025

View reviewed changes

Sources/BraintreePayPal/RecurringBillingMetadata/BTPayPalRecurringBillingDetails.swift Outdated Show resolved Hide resolved

sarahkoop reviewed May 1, 2025

View reviewed changes

UnitTests/BraintreePayPalTests/BTPayPalVaultRequest_Tests.swift Outdated Show resolved Hide resolved

stechiu added 3 commits May 2, 2025 12:41

Addressed PR comments

0368140

Removed extra comma

8b78bf2

Fixed unit tests

87762da

richherrera reviewed May 5, 2025

View reviewed changes

stechiu added 5 commits May 5, 2025 13:11

Addressed PR comments

dc5dae1

Removed gateway requests. Updated unit tests

1be5bc2

Addressed swift lint error

ccebe92

Fixed lint error

ee8b052

Lint error

c04d323

jaxdesmarais reviewed May 6, 2025

View reviewed changes

richherrera reviewed May 6, 2025

View reviewed changes

Sources/BraintreePayPal/BTPayPalCheckoutRequest.swift Show resolved Hide resolved

Sources/BraintreePayPal/BTPayPalVaultRequest.swift Outdated Show resolved Hide resolved

stechiu added 2 commits May 6, 2025 11:56

Addressed PR comments

bbfd26c

Updated doc strings

a36c350

agedd reviewed May 6, 2025

View reviewed changes

Sources/BraintreePayPal/BTPayPalVaultRequest.swift Outdated Show resolved Hide resolved

agedd reviewed May 6, 2025

View reviewed changes

Sources/BraintreePayPal/BTPayPalVaultRequest.swift Outdated Show resolved Hide resolved

jaxdesmarais reviewed May 7, 2025

View reviewed changes

Update Sources/BraintreePayPal/RecurringBillingMetadata/BTAmountBreak…

ee428f7

…down.swift Co-authored-by: Jax DesMarais-Leder <jdesmarais@paypal.com>

stechiu added 4 commits May 7, 2025 11:59

Addressed PR comments

24bea55

Merge branch 'rba-amount' of https://github.com/braintree/braintree_ios…

9084ee2

… into rba-amount

Removed unit test

485bd1b

Added back unit test

02ffc61

richherrera approved these changes May 8, 2025

View reviewed changes

Sources/BraintreePayPal/RecurringBillingMetadata/BTAmountBreakdown.swift Outdated Show resolved Hide resolved

richherrera self-requested a review May 8, 2025 15:20

richherrera reviewed May 8, 2025

View reviewed changes

Sources/BraintreePayPal/BTPayPalVaultBaseRequest.swift Show resolved Hide resolved

richherrera self-requested a review May 8, 2025 15:36

jaxdesmarais reviewed May 8, 2025

View reviewed changes

Sources/BraintreePayPal/BTPayPalVaultBaseRequest.swift Show resolved Hide resolved

Sources/BraintreePayPal/RecurringBillingMetadata/BTAmountBreakdown.swift Outdated Show resolved Hide resolved

stechiu and others added 4 commits May 8, 2025 15:12

Update Sources/BraintreePayPal/RecurringBillingMetadata/BTAmountBreak…

54b4a3a

…down.swift Co-authored-by: Rich Herrera <ricardherrera@paypal.com>

Update Sources/BraintreePayPal/RecurringBillingMetadata/BTAmountBreak…

4ba42e5

…down.swift Co-authored-by: Jax DesMarais-Leder <jdesmarais@paypal.com>

Addressed PR comments

02487ae

Merge branch 'rba-amount' of https://github.com/braintree/braintree_ios…

2630b4a

… into rba-amount

jaxdesmarais reviewed May 9, 2025

View reviewed changes

Sources/BraintreePayPal/BTPayPalVaultBaseRequest.swift Outdated Show resolved Hide resolved

Added missing doc strings

042112d

jaxdesmarais reviewed May 12, 2025

View reviewed changes

Sources/BraintreePayPal/BTPayPalVaultBaseRequest.swift Outdated Show resolved Hide resolved

Update Sources/BraintreePayPal/BTPayPalVaultBaseRequest.swift

e972725

Co-authored-by: Jax DesMarais-Leder <jdesmarais@paypal.com>

agedd reviewed May 13, 2025

View reviewed changes

agedd approved these changes May 13, 2025

View reviewed changes

richherrera approved these changes May 13, 2025

View reviewed changes

jaxdesmarais approved these changes May 13, 2025

View reviewed changes

stechiu added 2 commits May 13, 2025 11:10

Addressed PR comments

6dd5f88

Merge branch 'rba-amount' of https://github.com/braintree/braintree_ios…

2074dda

… into rba-amount

stechiu merged commit 5b0fd05 into checkout-rba-metadata-feature May 13, 2025
7 checks passed

stechiu deleted the rba-amount branch May 13, 2025 18:34

Added new billing amount breakdown #1562

Added new billing amount breakdown #1562

Uh oh!

Conversation

stechiu commented Apr 28, 2025

Summary of changes

Checklist

Authors

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

agedd May 13, 2025

Choose a reason for hiding this comment

Uh oh!

jaxdesmarais May 13, 2025

Choose a reason for hiding this comment

Uh oh!

agedd May 13, 2025

Choose a reason for hiding this comment

Uh oh!

agedd left a comment

Choose a reason for hiding this comment

Uh oh!

jaxdesmarais May 13, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!