[AC-2576] Replace Billing commands and queries with services (#4070)

* Replace SubscriberQueries with SubscriberService * Replace OrganizationBillingQueries with OrganizationBillingService * Replace ProviderBillingQueries with ProviderBillingService, move to Commercial * Replace AssignSeatsToClientOrganizationCommand with ProviderBillingService, move to commercial * Replace ScaleSeatsCommand with ProviderBillingService and move to Commercial * Replace CancelSubscriptionCommand with SubscriberService * Replace CreateCustomerCommand with ProviderBillingService and move to Commercial * Replace StartSubscriptionCommand with ProviderBillingService and moved to Commercial * Replaced RemovePaymentMethodCommand with SubscriberService * Formatting * Used dotnet format this time * Changing ProviderBillingService to scoped * Found circular dependency' * One more time with feeling * Formatting * Fix error in remove org from provider * Missed test fix in conflit * [AC-1937] Server: Implement endpoint to retrieve provider payment information (#4107) * Move the gettax and paymentmethod from stripepayment class Signed-off-by: Cy Okeke <cokeke@bitwarden.com> * Add the method to retrieve the tax and payment details Signed-off-by: Cy Okeke <cokeke@bitwarden.com> * Add unit tests for the paymentInformation method Signed-off-by: Cy Okeke <cokeke@bitwarden.com> * Add the endpoint to retrieve paymentinformation Signed-off-by: Cy Okeke <cokeke@bitwarden.com> * Add unit tests to the SubscriberService Signed-off-by: Cy Okeke <cokeke@bitwarden.com> * Remove the getTaxInfoAsync update reference Signed-off-by: Cy Okeke <cokeke@bitwarden.com> --------- Signed-off-by: Cy Okeke <cokeke@bitwarden.com> --------- Signed-off-by: Cy Okeke <cokeke@bitwarden.com> Co-authored-by: cyprain-okeke <108260115+cyprain-okeke@users.noreply.github.com>
2026-01-04 01:23:25 +00:00 · 2024-05-23 10:17:00 -04:00
parent a9ab894893
commit 06910175e2
56 changed files with 3452 additions and 3426 deletions
--- a/src/Api/AdminConsole/Controllers/OrganizationsController.cs
+++ b/src/Api/AdminConsole/Controllers/OrganizationsController.cs
@@ -19,8 +19,8 @@ using Bit.Core.AdminConsole.Repositories;
 using Bit.Core.Auth.Enums;
 using Bit.Core.Auth.Repositories;
 using Bit.Core.Auth.Services;
-using Bit.Core.Billing.Commands;
 using Bit.Core.Billing.Extensions;
+using Bit.Core.Billing.Services;
 using Bit.Core.Context;
 using Bit.Core.Enums;
 using Bit.Core.Exceptions;
@@ -55,7 +55,7 @@ public class OrganizationsController : Controller
    private readonly IPushNotificationService _pushNotificationService;
    private readonly IOrganizationEnableCollectionEnhancementsCommand _organizationEnableCollectionEnhancementsCommand;
    private readonly IProviderRepository _providerRepository;
-    private readonly IScaleSeatsCommand _scaleSeatsCommand;
+    private readonly IProviderBillingService _providerBillingService;
    private readonly IDataProtectorTokenFactory<OrgDeleteTokenable> _orgDeleteTokenDataFactory;

    public OrganizationsController(
@@ -76,7 +76,7 @@ public class OrganizationsController : Controller
        IPushNotificationService pushNotificationService,
        IOrganizationEnableCollectionEnhancementsCommand organizationEnableCollectionEnhancementsCommand,
        IProviderRepository providerRepository,
-        IScaleSeatsCommand scaleSeatsCommand,
+        IProviderBillingService providerBillingService,
        IDataProtectorTokenFactory<OrgDeleteTokenable> orgDeleteTokenDataFactory)
    {
        _organizationRepository = organizationRepository;
@@ -96,7 +96,7 @@ public class OrganizationsController : Controller
        _pushNotificationService = pushNotificationService;
        _organizationEnableCollectionEnhancementsCommand = organizationEnableCollectionEnhancementsCommand;
        _providerRepository = providerRepository;
-        _scaleSeatsCommand = scaleSeatsCommand;
+        _providerBillingService = providerBillingService;
        _orgDeleteTokenDataFactory = orgDeleteTokenDataFactory;
    }

@@ -274,7 +274,7 @@ public class OrganizationsController : Controller

            if (provider.IsBillable())
            {
-                await _scaleSeatsCommand.ScalePasswordManagerSeats(
+                await _providerBillingService.ScaleSeats(
                    provider,
                    organization.PlanType,
                    -organization.Seats ?? 0);
@@ -305,7 +305,7 @@ public class OrganizationsController : Controller
            var provider = await _providerRepository.GetByOrganizationIdAsync(organization.Id);
            if (provider.IsBillable())
            {
-                await _scaleSeatsCommand.ScalePasswordManagerSeats(
+                await _providerBillingService.ScaleSeats(
                    provider,
                    organization.PlanType,
                    -organization.Seats ?? 0);
--- a/src/Api/AdminConsole/Controllers/ProviderOrganizationsController.cs
+++ b/src/Api/AdminConsole/Controllers/ProviderOrganizationsController.cs
@@ -4,8 +4,6 @@ using Bit.Api.Models.Response;
 using Bit.Core.AdminConsole.Providers.Interfaces;
 using Bit.Core.AdminConsole.Repositories;
 using Bit.Core.AdminConsole.Services;
-using Bit.Core.Billing.Commands;
-using Bit.Core.Billing.Extensions;
 using Bit.Core.Context;
 using Bit.Core.Exceptions;
 using Bit.Core.Repositories;
@@ -26,7 +24,6 @@ public class ProviderOrganizationsController : Controller
    private readonly IProviderRepository _providerRepository;
    private readonly IProviderService _providerService;
    private readonly IRemoveOrganizationFromProviderCommand _removeOrganizationFromProviderCommand;
-    private readonly IRemovePaymentMethodCommand _removePaymentMethodCommand;
    private readonly IUserService _userService;

    public ProviderOrganizationsController(
@@ -36,7 +33,6 @@ public class ProviderOrganizationsController : Controller
        IProviderRepository providerRepository,
        IProviderService providerService,
        IRemoveOrganizationFromProviderCommand removeOrganizationFromProviderCommand,
-        IRemovePaymentMethodCommand removePaymentMethodCommand,
        IUserService userService)
    {
        _currentContext = currentContext;
@@ -45,7 +41,6 @@ public class ProviderOrganizationsController : Controller
        _providerRepository = providerRepository;
        _providerService = providerService;
        _removeOrganizationFromProviderCommand = removeOrganizationFromProviderCommand;
-        _removePaymentMethodCommand = removePaymentMethodCommand;
        _userService = userService;
    }

@@ -112,10 +107,5 @@ public class ProviderOrganizationsController : Controller
            provider,
            providerOrganization,
            organization);
-
-        if (organization.IsStripeEnabled())
-        {
-            await _removePaymentMethodCommand.RemovePaymentMethod(organization);
-        }
    }
 }
--- a/src/Api/AdminConsole/Controllers/ProvidersController.cs
+++ b/src/Api/AdminConsole/Controllers/ProvidersController.cs
@@ -3,7 +3,7 @@ using Bit.Api.AdminConsole.Models.Response.Providers;
 using Bit.Core;
 using Bit.Core.AdminConsole.Repositories;
 using Bit.Core.AdminConsole.Services;
-using Bit.Core.Billing.Commands;
+using Bit.Core.Billing.Services;
 using Bit.Core.Context;
 using Bit.Core.Exceptions;
 using Bit.Core.Models.Business;
@@ -24,13 +24,13 @@ public class ProvidersController : Controller
    private readonly ICurrentContext _currentContext;
    private readonly GlobalSettings _globalSettings;
    private readonly IFeatureService _featureService;
-    private readonly IStartSubscriptionCommand _startSubscriptionCommand;
    private readonly ILogger<ProvidersController> _logger;
+    private readonly IProviderBillingService _providerBillingService;

    public ProvidersController(IUserService userService, IProviderRepository providerRepository,
        IProviderService providerService, ICurrentContext currentContext, GlobalSettings globalSettings,
-        IFeatureService featureService, IStartSubscriptionCommand startSubscriptionCommand,
-        ILogger<ProvidersController> logger)
+        IFeatureService featureService, ILogger<ProvidersController> logger,
+        IProviderBillingService providerBillingService)
    {
        _userService = userService;
        _providerRepository = providerRepository;
@@ -38,8 +38,8 @@ public class ProvidersController : Controller
        _currentContext = currentContext;
        _globalSettings = globalSettings;
        _featureService = featureService;
-        _startSubscriptionCommand = startSubscriptionCommand;
        _logger = logger;
+        _providerBillingService = providerBillingService;
    }

    [HttpGet("{id:guid}")]
@@ -112,7 +112,9 @@ public class ProvidersController : Controller

            try
            {
-                await _startSubscriptionCommand.StartSubscription(provider, taxInfo);
+                await _providerBillingService.CreateCustomer(provider, taxInfo);
+
+                await _providerBillingService.StartSubscription(provider);
            }
            catch
            {
--- a/src/Api/Auth/Controllers/AccountsController.cs
+++ b/src/Api/Auth/Controllers/AccountsController.cs
@@ -21,9 +21,8 @@ using Bit.Core.Auth.Services;
 using Bit.Core.Auth.UserFeatures.UserKey;
 using Bit.Core.Auth.UserFeatures.UserMasterPassword.Interfaces;
 using Bit.Core.Auth.Utilities;
-using Bit.Core.Billing.Commands;
 using Bit.Core.Billing.Models;
-using Bit.Core.Billing.Queries;
+using Bit.Core.Billing.Services;
 using Bit.Core.Context;
 using Bit.Core.Entities;
 using Bit.Core.Enums;
@@ -67,8 +66,7 @@ public class AccountsController : Controller
    private readonly ISetInitialMasterPasswordCommand _setInitialMasterPasswordCommand;
    private readonly IRotateUserKeyCommand _rotateUserKeyCommand;
    private readonly IFeatureService _featureService;
-    private readonly ICancelSubscriptionCommand _cancelSubscriptionCommand;
-    private readonly ISubscriberQueries _subscriberQueries;
+    private readonly ISubscriberService _subscriberService;
    private readonly IReferenceEventService _referenceEventService;
    private readonly ICurrentContext _currentContext;

@@ -102,8 +100,7 @@ public class AccountsController : Controller
        ISetInitialMasterPasswordCommand setInitialMasterPasswordCommand,
        IRotateUserKeyCommand rotateUserKeyCommand,
        IFeatureService featureService,
-        ICancelSubscriptionCommand cancelSubscriptionCommand,
-        ISubscriberQueries subscriberQueries,
+        ISubscriberService subscriberService,
        IReferenceEventService referenceEventService,
        ICurrentContext currentContext,
        IRotationValidator<IEnumerable<CipherWithIdRequestModel>, IEnumerable<Cipher>> cipherValidator,
@@ -131,8 +128,7 @@ public class AccountsController : Controller
        _setInitialMasterPasswordCommand = setInitialMasterPasswordCommand;
        _rotateUserKeyCommand = rotateUserKeyCommand;
        _featureService = featureService;
-        _cancelSubscriptionCommand = cancelSubscriptionCommand;
-        _subscriberQueries = subscriberQueries;
+        _subscriberService = subscriberService;
        _referenceEventService = referenceEventService;
        _currentContext = currentContext;
        _cipherValidator = cipherValidator;
@@ -798,9 +794,7 @@ public class AccountsController : Controller
            throw new UnauthorizedAccessException();
        }

-        var subscription = await _subscriberQueries.GetSubscriptionOrThrow(user);
-
-        await _cancelSubscriptionCommand.CancelSubscription(subscription,
+        await _subscriberService.CancelSubscription(user,
            new OffboardingSurveyResponse
            {
                UserId = user.Id,
@@ -841,7 +835,7 @@ public class AccountsController : Controller
            throw new UnauthorizedAccessException();
        }

-        var taxInfo = await _paymentService.GetTaxInfoAsync(user);
+        var taxInfo = await _subscriberService.GetTaxInformationAsync(user);
        return new TaxInfoResponseModel(taxInfo);
    }

--- a/src/Api/Billing/Controllers/OrganizationBillingController.cs
+++ b/src/Api/Billing/Controllers/OrganizationBillingController.cs
@@ -1,8 +1,7 @@
 using Bit.Api.Billing.Models.Responses;
 using Bit.Api.Models.Response;
-using Bit.Core.Billing.Queries;
+using Bit.Core.Billing.Services;
 using Bit.Core.Context;
-using Bit.Core.Exceptions;
 using Bit.Core.Repositories;
 using Bit.Core.Services;
 using Bit.Core.Utilities;
@@ -14,15 +13,15 @@ namespace Bit.Api.Billing.Controllers;
 [Route("organizations/{organizationId:guid}/billing")]
 [Authorize("Application")]
 public class OrganizationBillingController(
-    IOrganizationBillingQueries organizationBillingQueries,
    ICurrentContext currentContext,
+    IOrganizationBillingService organizationBillingService,
    IOrganizationRepository organizationRepository,
    IPaymentService paymentService) : Controller
 {
    [HttpGet("metadata")]
    public async Task<IResult> GetMetadataAsync([FromRoute] Guid organizationId)
    {
-        var metadata = await organizationBillingQueries.GetMetadata(organizationId);
+        var metadata = await organizationBillingService.GetMetadata(organizationId);

        if (metadata == null)
        {
@@ -36,20 +35,24 @@ public class OrganizationBillingController(

    [HttpGet]
    [SelfHosted(NotSelfHostedOnly = true)]
-    public async Task<BillingResponseModel> GetBilling(Guid organizationId)
+    public async Task<IResult> GetBillingAsync(Guid organizationId)
    {
        if (!await currentContext.ViewBillingHistory(organizationId))
        {
-            throw new NotFoundException();
+            return TypedResults.Unauthorized();
        }

        var organization = await organizationRepository.GetByIdAsync(organizationId);
+
        if (organization == null)
        {
-            throw new NotFoundException();
+            return TypedResults.NotFound();
        }

        var billingInfo = await paymentService.GetBillingAsync(organization);
-        return new BillingResponseModel(billingInfo);
+
+        var response = new BillingResponseModel(billingInfo);
+
+        return TypedResults.Ok(response);
    }
 }
--- a/src/Api/Billing/Controllers/OrganizationsController.cs
+++ b/src/Api/Billing/Controllers/OrganizationsController.cs
@@ -5,10 +5,9 @@ using Bit.Api.Models.Request;
 using Bit.Api.Models.Request.Organizations;
 using Bit.Api.Models.Response;
 using Bit.Core.AdminConsole.Entities;
-using Bit.Core.Billing.Commands;
 using Bit.Core.Billing.Constants;
 using Bit.Core.Billing.Models;
-using Bit.Core.Billing.Queries;
+using Bit.Core.Billing.Services;
 using Bit.Core.Context;
 using Bit.Core.Enums;
 using Bit.Core.Exceptions;
@@ -42,9 +41,8 @@ public class OrganizationsController(
    IUpdateSecretsManagerSubscriptionCommand updateSecretsManagerSubscriptionCommand,
    IUpgradeOrganizationPlanCommand upgradeOrganizationPlanCommand,
    IAddSecretsManagerSubscriptionCommand addSecretsManagerSubscriptionCommand,
-    ICancelSubscriptionCommand cancelSubscriptionCommand,
-    ISubscriberQueries subscriberQueries,
-    IReferenceEventService referenceEventService)
+    IReferenceEventService referenceEventService,
+    ISubscriberService subscriberService)
    : Controller
 {
    [HttpGet("{id}/billing-status")]
@@ -261,9 +259,7 @@ public class OrganizationsController(
            throw new NotFoundException();
        }

-        var subscription = await subscriberQueries.GetSubscriptionOrThrow(organization);
-
-        await cancelSubscriptionCommand.CancelSubscription(subscription,
+        await subscriberService.CancelSubscription(organization,
            new OffboardingSurveyResponse
            {
                UserId = currentContext.UserId!.Value,
@@ -308,7 +304,7 @@ public class OrganizationsController(
            throw new NotFoundException();
        }

-        var taxInfo = await paymentService.GetTaxInfoAsync(organization);
+        var taxInfo = await subscriberService.GetTaxInformationAsync(organization);
        return new TaxInfoResponseModel(taxInfo);
    }

--- a/src/Api/Billing/Controllers/ProviderBillingController.cs
+++ b/src/Api/Billing/Controllers/ProviderBillingController.cs
@@ -1,6 +1,6 @@
 using Bit.Api.Billing.Models.Responses;
 using Bit.Core;
-using Bit.Core.Billing.Queries;
+using Bit.Core.Billing.Services;
 using Bit.Core.Context;
 using Bit.Core.Services;
 using Microsoft.AspNetCore.Authorization;
@@ -13,7 +13,7 @@ namespace Bit.Api.Billing.Controllers;
 public class ProviderBillingController(
    ICurrentContext currentContext,
    IFeatureService featureService,
-    IProviderBillingQueries providerBillingQueries) : Controller
+    IProviderBillingService providerBillingService) : Controller
 {
    [HttpGet("subscription")]
    public async Task<IResult> GetSubscriptionAsync([FromRoute] Guid providerId)
@@ -28,7 +28,7 @@ public class ProviderBillingController(
            return TypedResults.Unauthorized();
        }

-        var providerSubscriptionDTO = await providerBillingQueries.GetSubscriptionDTO(providerId);
+        var providerSubscriptionDTO = await providerBillingService.GetSubscriptionDTO(providerId);

        if (providerSubscriptionDTO == null)
        {
@@ -41,4 +41,31 @@ public class ProviderBillingController(

        return TypedResults.Ok(providerSubscriptionResponse);
    }
+
+    [HttpGet("payment-information")]
+    public async Task<IResult> GetPaymentInformationAsync([FromRoute] Guid providerId)
+    {
+        if (!featureService.IsEnabled(FeatureFlagKeys.EnableConsolidatedBilling))
+        {
+            return TypedResults.NotFound();
+        }
+
+        if (!currentContext.ProviderProviderAdmin(providerId))
+        {
+            return TypedResults.Unauthorized();
+        }
+
+        var providerPaymentInformationDto = await providerBillingService.GetPaymentInformationAsync(providerId);
+
+        if (providerPaymentInformationDto == null)
+        {
+            return TypedResults.NotFound();
+        }
+
+        var (paymentSource, taxInfo) = providerPaymentInformationDto;
+
+        var providerPaymentInformationResponse = PaymentInformationResponse.From(paymentSource, taxInfo);
+
+        return TypedResults.Ok(providerPaymentInformationResponse);
+    }
 }
--- a/src/Api/Billing/Controllers/ProviderClientsController.cs
+++ b/src/Api/Billing/Controllers/ProviderClientsController.cs
@@ -2,7 +2,7 @@
 using Bit.Core;
 using Bit.Core.AdminConsole.Repositories;
 using Bit.Core.AdminConsole.Services;
-using Bit.Core.Billing.Commands;
+using Bit.Core.Billing.Services;
 using Bit.Core.Context;
 using Bit.Core.Enums;
 using Bit.Core.Models.Business;
@@ -14,16 +14,14 @@ namespace Bit.Api.Billing.Controllers;

 [Route("providers/{providerId:guid}/clients")]
 public class ProviderClientsController(
-    IAssignSeatsToClientOrganizationCommand assignSeatsToClientOrganizationCommand,
-    ICreateCustomerCommand createCustomerCommand,
    ICurrentContext currentContext,
    IFeatureService featureService,
    ILogger<ProviderClientsController> logger,
    IOrganizationRepository organizationRepository,
+    IProviderBillingService providerBillingService,
    IProviderOrganizationRepository providerOrganizationRepository,
    IProviderRepository providerRepository,
    IProviderService providerService,
-    IScaleSeatsCommand scaleSeatsCommand,
    IUserService userService) : Controller
 {
    [HttpPost]
@@ -83,12 +81,12 @@ public class ProviderClientsController(
            return TypedResults.Problem();
        }

-        await scaleSeatsCommand.ScalePasswordManagerSeats(
+        await providerBillingService.ScaleSeats(
            provider,
            requestBody.PlanType,
            requestBody.Seats);

-        await createCustomerCommand.CreateCustomer(
+        await providerBillingService.CreateCustomerForClientOrganization(
            provider,
            clientOrganization);

@@ -135,7 +133,7 @@ public class ProviderClientsController(

        if (clientOrganization.Seats != requestBody.AssignedSeats)
        {
-            await assignSeatsToClientOrganizationCommand.AssignSeatsToClientOrganization(
+            await providerBillingService.AssignSeatsToClientOrganization(
                provider,
                clientOrganization,
                requestBody.AssignedSeats);
--- a/src/Api/Billing/Models/Responses/PaymentInformationResponse.cs
+++ b/src/Api/Billing/Models/Responses/PaymentInformationResponse.cs
@@ -0,0 +1,37 @@
+using Bit.Core.Enums;
+using Bit.Core.Models.Business;
+
+namespace Bit.Api.Billing.Models.Responses;
+
+public record PaymentInformationResponse(PaymentMethod PaymentMethod, TaxInformation TaxInformation)
+{
+    public static PaymentInformationResponse From(BillingInfo.BillingSource billingSource, TaxInfo taxInfo)
+    {
+        var paymentMethodDto = new PaymentMethod(
+            billingSource.Type, billingSource.Description, billingSource.CardBrand
+        );
+
+        var taxInformationDto = new TaxInformation(
+            taxInfo.BillingAddressCountry, taxInfo.BillingAddressPostalCode, taxInfo.TaxIdNumber,
+            taxInfo.BillingAddressLine1, taxInfo.BillingAddressLine2, taxInfo.BillingAddressCity,
+            taxInfo.BillingAddressState
+        );
+
+        return new PaymentInformationResponse(paymentMethodDto, taxInformationDto);
+    }
+
+}
+
+public record PaymentMethod(
+    PaymentMethodType Type,
+    string Description,
+    string CardBrand);
+
+public record TaxInformation(
+    string Country,
+    string PostalCode,
+    string TaxId,
+    string Line1,
+    string Line2,
+    string City,
+    string State);