mirror of
https://github.com/bitwarden/server.git
synced 2025-04-05 05:00:19 -05:00
68b421fa2b
* Refactor: Update metadata in OrganizationSignup and OrganizationUpgrade This commit moves the IsFromSecretsManagerTrial flag from the OrganizationUpgrade to the OrganizationSignup because it will only be passed in on organization creation. Additionally, it removes the nullable boolean 'provider' flag passed to OrganizationService.SignUpAsync and instead adds that boolean flag to the OrganizationSignup which seems more appropriate. * Introduce OrganizationSale While I'm trying to ingrain a singular model that can be used to purchase or upgrade organizations, I disliked my previously implemented OrganizationSubscriptionPurchase for being a little too wordy and specific. This sale class aligns more closely with the work we need to complete against Stripe and also uses a private constructor so that it can only be created and utilized via an Organiztion and either OrganizationSignup or OrganizationUpgrade object. * Use OrganizationSale in OrganizationBillingService This commit renames the OrganizationBillingService.PurchaseSubscription to Finalize and passes it the OrganizationSale object. It also updates the method so that, if the organization already has a customer, it retrieves that customer instead of automatically trying to create one which we'll need for upgraded free organizations. * Add functionality for free organization upgrade This commit adds an UpdatePaymentMethod to the OrganizationBillingService that will check if a customer exists for the organization and if not, creates one with the updated payment source and tax information. Then, in the UpgradeOrganizationPlanCommand, we can use the OrganizationUpgrade to get an OrganizationSale and finalize it, which will create a subscription using the customer created as part of the payment method update that takes place right before it on the client-side. Additionally, it adds some tax ID backfill logic to SubscriberService.UpdateTaxInformation * (No Logic) Re-order OrganizationBillingService methods alphabetically * (No Logic) Run dotnet format
47 lines
2.6 KiB
C#
47 lines
2.6 KiB
C#
using Bit.Core.AdminConsole.Entities;
|
|
using Bit.Core.Billing.Models;
|
|
using Bit.Core.Billing.Models.Sales;
|
|
|
|
namespace Bit.Core.Billing.Services;
|
|
|
|
public interface IOrganizationBillingService
|
|
{
|
|
/// <summary>
|
|
/// <para>Establishes the billing configuration for a Bitwarden <see cref="Organization"/> using the provided <paramref name="sale"/>.</para>
|
|
/// <para>
|
|
/// The method first checks to see if the
|
|
/// provided <see cref="OrganizationSale.Organization"/> already has a Stripe <see cref="Stripe.Customer"/> using the <see cref="Organization.GatewayCustomerId"/>.
|
|
/// If it doesn't, the method creates one using the <paramref name="sale"/>'s <see cref="OrganizationSale.CustomerSetup"/>. The method then creates a Stripe <see cref="Stripe.Subscription"/>
|
|
/// for the created or existing customer using the provided <see cref="OrganizationSale.SubscriptionSetup"/>.
|
|
/// </para>
|
|
/// </summary>
|
|
/// <param name="sale">The purchase details necessary to establish the Stripe entities responsible for billing the organization.</param>
|
|
/// <example>
|
|
/// <code>
|
|
/// var sale = OrganizationSale.From(organization, organizationSignup);
|
|
/// await organizationBillingService.Finalize(sale);
|
|
/// </code>
|
|
/// </example>
|
|
Task Finalize(OrganizationSale sale);
|
|
|
|
/// <summary>
|
|
/// Retrieve metadata about the organization represented bsy the provided <paramref name="organizationId"/>.
|
|
/// </summary>
|
|
/// <param name="organizationId">The ID of the organization to retrieve metadata for.</param>
|
|
/// <returns>An <see cref="OrganizationMetadata"/> record.</returns>
|
|
Task<OrganizationMetadata> GetMetadata(Guid organizationId);
|
|
|
|
/// <summary>
|
|
/// Updates the provided <paramref name="organization"/>'s payment source and tax information.
|
|
/// If the <paramref name="organization"/> does not have a Stripe <see cref="Stripe.Customer"/>, this method will create one using the provided
|
|
/// <paramref name="tokenizedPaymentSource"/> and <paramref name="taxInformation"/>.
|
|
/// </summary>
|
|
/// <param name="organization">The <paramref name="organization"/> to update the payment source and tax information for.</param>
|
|
/// <param name="tokenizedPaymentSource">The tokenized payment source (ex. Credit Card) to attach to the <paramref name="organization"/>.</param>
|
|
/// <param name="taxInformation">The <paramref name="organization"/>'s updated tax information.</param>
|
|
Task UpdatePaymentMethod(
|
|
Organization organization,
|
|
TokenizedPaymentSource tokenizedPaymentSource,
|
|
TaxInformation taxInformation);
|
|
}
|