[PM-33853] feat: Add BillingAPIService for premium upgrade endpoints by andrebispo5 · Pull Request #2496 · bitwarden/ios

andrebispo5 · 2026-03-26T10:24:57Z

🎟️ Tracking

https://bitwarden.atlassian.net/browse/PM-33853

📔 Objective

Add new billing API service with endpoints for premium upgrade flow:

createCheckoutSession() - Creates a Stripe checkout session for premium upgrade (POST /account/billing/vnext/premium/checkout)
getPortalUrl() - Creates a Stripe customer portal session for subscription management (POST /account/billing/vnext/portal-session)

This establishes the new Billing domain structure in Core/ with models, requests, and service integration into the ServiceContainer.

📸 Screenshots

N/A - API layer changes only, no UI modifications.

github-actions · 2026-03-26T10:30:58Z

Checkmarx One – Scan Summary & Details – 2705e769-655f-4bee-a84c-607b4d70ef2a

Great job! No new security vulnerabilities introduced in this pull request

Copilot

Pull request overview

Adds a new Billing domain in BitwardenShared/Core to support the premium upgrade flow by introducing a dedicated BillingAPIService, request/response models, and wiring it into the dependency injection ServiceContainer.

Changes:

Introduces BillingAPIService with createCheckoutSession() and getPortalUrl() endpoints and adds DI access via HasBillingAPIService.
Adds new Billing request/response models plus request tests and fixtures.
Updates .claude/CLAUDE.md architecture docs to include the new Billing/ top-level domain.

Reviewed changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
BitwardenShared/Core/Platform/Services/Services.swift	Adds `HasBillingAPIService` and includes it in the `Services` composition typealias.
BitwardenShared/Core/Platform/Services/ServiceContainer.swift	Exposes `billingAPIService` via the container (backed by `apiService`).
BitwardenShared/Core/Billing/Services/API/BillingAPIService.swift	Defines Billing API protocol + `APIService` conformance for premium upgrade endpoints.
BitwardenShared/Core/Billing/Services/API/Requests/CreateCheckoutSessionRequest.swift	Request for creating a Stripe checkout session.
BitwardenShared/Core/Billing/Services/API/Requests/CreateCheckoutSessionRequestTests.swift	Unit tests for request method/path/body.
BitwardenShared/Core/Billing/Services/API/Requests/GetPortalUrlRequest.swift	Request for creating a Stripe customer portal session.
BitwardenShared/Core/Billing/Services/API/Requests/GetPortalUrlRequestTests.swift	Unit tests for request method/path/body.
BitwardenShared/Core/Billing/Models/Request/CheckoutSessionRequestModel.swift	Request body model for checkout session creation.
BitwardenShared/Core/Billing/Models/Request/CheckoutSessionRequestModelTests.swift	Unit tests for encoding/initialization.
BitwardenShared/Core/Billing/Models/Response/CheckoutSessionResponseModel.swift	Response model for checkout session URL.
BitwardenShared/Core/Billing/Models/Response/CheckoutSessionResponseModelTests.swift	Decoding/init tests using fixtures.
BitwardenShared/Core/Billing/Models/Response/PortalUrlResponseModel.swift	Response model for portal URL.
BitwardenShared/Core/Billing/Models/Response/PortalUrlResponseModelTests.swift	Decoding/init tests using fixtures.
BitwardenShared/Core/Billing/Services/API/Fixtures/APITestData+Billing.swift	Adds Billing APITestData fixtures for checkout + portal sessions.
.claude/CLAUDE.md	Updates architecture documentation to reflect the new Billing domain.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-26T10:31:26Z

+import TestHelpers
+import XCTest
+
+@testable import BitwardenShared


APITestData.portalUrl is defined in Core/Billing/Services/API/Fixtures/ which is excluded from the main framework and compiled into BitwardenSharedMocks. This test file doesn’t import BitwardenSharedMocks, so it won’t compile (the portalUrl fixture won’t be visible). Add @testable import BitwardenSharedMocks (consistent with other response model decoding tests that use APITestData).

Suggested change

@testable import BitwardenShared

@testable import BitwardenShared

@testable import BitwardenSharedMocks

Copilot · 2026-03-26T10:31:26Z

+import TestHelpers
+import XCTest
+
+@testable import BitwardenShared


APITestData.checkoutSession is defined in Core/Billing/Services/API/Fixtures/ which is compiled into BitwardenSharedMocks. This test file doesn’t import BitwardenSharedMocks, so it won’t compile (the checkoutSession fixture won’t be visible). Add @testable import BitwardenSharedMocks (consistent with other response model decoding tests that use APITestData).

Suggested change

@testable import BitwardenShared

@testable import BitwardenShared

@testable import BitwardenSharedMocks

Copilot · 2026-03-26T10:31:27Z

+struct PortalUrlResponseModel: JSONResponse, Equatable {
+    // MARK: Properties
+
+    /// The Stripe customer portal URL.
+    let url: String
+}


This response is a URL but is modeled as String. Elsewhere in this codebase, response URLs are modeled as URL (e.g., SaveAttachmentResponse.url, DownloadAttachmentResponse.url, SendFileResponseModel.url) which gives type-safety and decoding validation. Consider changing url to URL and updating the related tests/fixtures accordingly.

Copilot · 2026-03-26T10:31:27Z

+struct CheckoutSessionResponseModel: JSONResponse, Equatable {
+    // MARK: Properties
+
+    /// The Stripe checkout URL for premium upgrade.
+    let checkoutSessionUrl: String
+}


This value is a URL but is modeled as String. Elsewhere in this codebase, response URLs are modeled as URL (e.g., SaveAttachmentResponse.url, DownloadAttachmentResponse.url, SendFileResponseModel.url) which gives type-safety and decoding validation. Consider changing checkoutSessionUrl to URL and updating the related tests/fixtures accordingly.

Copilot · 2026-03-26T10:31:27Z

+extension APIService: BillingAPIService {
+    /// The platform identifier for iOS.
+    private static let platform = "ios"
+
+    func createCheckoutSession() async throws -> CheckoutSessionResponseModel {
+        try await apiService.send(
+            CreateCheckoutSessionRequest(
+                requestModel: CheckoutSessionRequestModel(platform: Self.platform),
+            ),
+        )
+    }
+
+    func getPortalUrl() async throws -> PortalUrlResponseModel {
+        try await apiService.send(GetPortalUrlRequest())
+    }


There are request/model tests, but there’s no unit test covering the APIService conformance to BillingAPIService to ensure it sends the expected request (path, method, and body content like platform). Other API services in this repo typically have service-level tests (e.g., ConfigAPIServiceTests, DeviceAPIServiceTests). Add BillingAPIServiceTests verifying createCheckoutSession() and getPortalUrl() build the correct HTTP requests.

codecov · 2026-03-26T10:46:02Z

Codecov Report

❌ Patch coverage is 97.05882% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 86.92%. Comparing base (b0d061c) to head (ee364d8).
⚠️ Report is 8 commits behind head on main.

Files with missing lines	Patch %	Lines
...ared/Core/Platform/Services/ServiceContainer.swift	0.00%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2496      +/-   ##
==========================================
+ Coverage   86.90%   86.92%   +0.01%     
==========================================
  Files        1845     1852       +7     
  Lines      163218   163591     +373     
==========================================
+ Hits       141847   142200     +353     
- Misses      21371    21391      +20

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

…L type

…ionUrl property to URL type

fedemkr

Looks good, just a few ⛏️ .
🤔 One thing I think we could remove unless I'm missing something is any reference to Stripe as we don't make any requests to Stripe directly so we can leave it here more generic, so if the server would change the service there won't be any need to change all the comments. What do you think?

fedemkr · 2026-03-27T15:51:03Z

+
+@testable import BitwardenShared
+
+class CheckoutSessionRequestModelTests: BitwardenTestCase {


⛏️ No need for these tests as it's testing basic swift out of the box features like init without any logic. This file can be deleted

fedemkr · 2026-03-27T15:51:33Z

+
+// MARK: - CheckoutSessionResponseModelTests
+
+class CheckoutSessionResponseModelTests: BitwardenTestCase {


⛏️ No need for these tests as it's testing basic swift out of the box features like init without any logic. This file can be deleted

fedemkr · 2026-03-27T15:51:46Z

+
+// MARK: - PortalUrlResponseModelTests
+
+class PortalUrlResponseModelTests: BitwardenTestCase {


⛏️ No need for these tests as it's testing basic swift out of the box features like init without any logic. This file can be deleted

…2496)

andrebispo5 added 9 commits March 20, 2026 08:53

[PM-33853] Add Billing directory to allowed Core/UI subdirectories

b2ce808

[PM-33853] Add CheckoutSessionRequestModel

5e1a30f

[PM-33853] Add CheckoutSessionResponseModel

c4118b9

[PM-33853] Add PortalUrlResponseModel

ab570b9

[PM-33853] Add CreateCheckoutSessionRequest

079bfb5

[PM-33853] Add GetPortalUrlRequest

57c13e8

[PM-33853] Add BillingAPIService

f608e0b

[PM-33853] Add BillingAPIService to ServiceContainer

f89498b

Merge branch 'main' into pm-33853/premium-upgrade-billing-endpoint

20db50d

andrebispo5 requested review from a team and matt-livefront as code owners March 26, 2026 10:24

Copilot AI review requested due to automatic review settings March 26, 2026 10:24

github-actions bot added app:password-manager Bitwarden Password Manager app context t:feature t:llm Change Type - LLM related change (e.g. CLAUDE.md files) labels Mar 26, 2026

Copilot started reviewing on behalf of andrebispo5 March 26, 2026 10:25 View session

Copilot AI reviewed Mar 26, 2026

View reviewed changes

andrebispo5 added 2 commits March 27, 2026 10:41

[PM-33853] refactor: Change PortalUrlResponseModel url property to UR…

5f365d3

…L type

[PM-33853] refactor: Change CheckoutSessionResponseModel checkoutSess…

7a7c276

…ionUrl property to URL type

fedemkr reviewed Mar 27, 2026

View reviewed changes

[PM-33853] refactor: Address review feedback

50ed4c2

github-actions bot removed the t:llm Change Type - LLM related change (e.g. CLAUDE.md files) label Mar 27, 2026

andrebispo5 mentioned this pull request Mar 27, 2026

[PM-33853] llm: Add Billing domain to CLAUDE.md #2500

Merged

[PM-33853] test: Add BillingAPIServiceTests

ee364d8

fedemkr approved these changes Mar 27, 2026

View reviewed changes

andrebispo5 enabled auto-merge (squash) March 27, 2026 17:12

andrebispo5 merged commit daaf1e8 into main Mar 27, 2026
16 checks passed

andrebispo5 deleted the pm-33853/premium-upgrade-billing-endpoint branch March 27, 2026 17:23

morganzellers-bw pushed a commit that referenced this pull request Mar 30, 2026

[PM-33853] feat: Add BillingAPIService for premium upgrade endpoints (#…

8900fed

…2496)

	@testable import BitwardenShared
	@testable import BitwardenShared
	@testable import BitwardenSharedMocks


		@testable import BitwardenShared

		class CheckoutSessionRequestModelTests: BitwardenTestCase {


		// MARK: - CheckoutSessionResponseModelTests

		class CheckoutSessionResponseModelTests: BitwardenTestCase {


		// MARK: - PortalUrlResponseModelTests

		class PortalUrlResponseModelTests: BitwardenTestCase {

Conversation

andrebispo5 commented Mar 26, 2026

🎟️ Tracking

📔 Objective

📸 Screenshots

Uh oh!

github-actions bot commented Mar 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Great job! No new security vulnerabilities introduced in this pull request

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 26, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 26, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 26, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 26, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 26, 2026

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Mar 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

fedemkr left a comment

Choose a reason for hiding this comment

Uh oh!

fedemkr Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

fedemkr Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

fedemkr Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions bot commented Mar 26, 2026 •

edited

Loading

codecov bot commented Mar 26, 2026 •

edited

Loading