Skip to content

armgit / mwmbl

Public Imported from GitHub
0

An open source, non-profit web search engine

Add membership tier change endpoint

Claude5ce543225ebe
diff --git a/mwmbl/platform/api.py b/mwmbl/platform/api.py
index b66c9e0..f0f0c2f 100644
--- a/mwmbl/platform/api.py
+++ b/mwmbl/platform/api.py
@@ -14,7 +14,12 @@ from ninja.pagination import paginate
from ninja_jwt.authentication import JWTAuth
from polar_sdk import Polar
from polar_sdk import models as polar_models
-from polar_sdk.models import SubscriptionCancel, SubscriptionStatus
+from polar_sdk.models import (
+ SubscriptionCancel,
+ SubscriptionProrationBehavior,
+ SubscriptionStatus,
+ SubscriptionUpdateBase,
+)
from polar_sdk.webhooks import WebhookVerificationError
from mwmbl import membership, pricing
@@ -61,6 +66,7 @@ from mwmbl.platform.schemas import (
MarketingConsentListResponse,
MarketingConsentRequest,
MarketingConsentResponse,
+ MembershipChangeRequest,
MembershipCheckoutRequest,
MembershipResponse,
MembershipTierResponse,
@@ -1411,7 +1417,9 @@ def cancel_membership(request):
)
except polar_models.AlreadyCanceledSubscription:
raise InvalidRequest("Membership is already canceled.", status=409)
- return _save_cancellation(user_membership, result, cancel_at_period_end=True)
+ return _save_membership_update(
+ user_membership, current_period_end=result.current_period_end, cancel_at_period_end=True
+ )
@router.post(
@@ -1437,21 +1445,57 @@ def uncancel_membership(request):
)
except polar_models.AlreadyCanceledSubscription:
raise InvalidRequest("Membership has already ended.", status=409)
- return _save_cancellation(user_membership, result, cancel_at_period_end=False)
+ return _save_membership_update(
+ user_membership, current_period_end=result.current_period_end, cancel_at_period_end=False
+ )
-def _save_cancellation(user_membership, subscription, cancel_at_period_end):
- """Record a cancel or uncancel on the Membership row, unless a webhook changed it during the Polar call.
+ "/membership/change",
+ auth=JWTAuth(),
+ response=MembershipResponse,
+ summary="Change membership tier",
+ description="Moves the membership to another tier straight away. The price difference for the rest of "
+ "the current period is added to the next invoice.",
+ tags=["Membership"],
+)
+def change_membership(request, body: MembershipChangeRequest):
+ check_email_verified(request)
+ user_membership = Membership.objects.filter(user=request.user).first()
+ if user_membership is None:
+ raise InvalidRequest("Not a member.", status=404)
+ if user_membership.tier == body.tier:
+ raise InvalidRequest("Already on this tier.", status=409)
+ # Changing tier would leave the cancellation in place, which is rarely what anyone wants;
+ # making them uncancel first keeps the outcome explicit.
+ if user_membership.cancel_at_period_end:
+ raise InvalidRequest("Membership is scheduled to cancel. Uncancel it before changing tier.", status=409)
+ product_id = membership.product_ids()[body.tier]
+ if not product_id:
+ raise InvalidRequest("Membership is not configured. Contact support.", status=503)
+ try:
+ with Polar(access_token=settings.POLAR_ACCESS_TOKEN, server=settings.POLAR_SERVER) as polar:
+ result = polar.subscriptions.update(
+ id=user_membership.polar_subscription_id,
+ subscription_update=SubscriptionUpdateBase(
+ product_id=product_id,
+ proration_behavior=SubscriptionProrationBehavior.PRORATE,
+ ),
+ )
+ except polar_models.AlreadyCanceledSubscription:
+ raise InvalidRequest("Membership has already ended.", status=409)
+ return _save_membership_update(user_membership, tier=body.tier, current_period_end=result.current_period_end)
- Only the two changed fields are written, and only while the row still points at the same
+
+def _save_membership_update(user_membership, **changes):
+ """Record a change made in Polar on the Membership row, unless a webhook changed it during the Polar call.
+
+ Only the changed fields are written, and only while the row still points at the same
subscription, so a webhook that deleted the row or moved it to another subscription wins.
"""
Membership.objects.filter(
pk=user_membership.pk, polar_subscription_id=user_membership.polar_subscription_id
- ).update(
- current_period_end=subscription.current_period_end,
- cancel_at_period_end=cancel_at_period_end,
- )
+ ).update(**changes)
current_membership = Membership.objects.filter(user=user_membership.user).first()
if current_membership is None:
raise InvalidRequest("Not a member.", status=404)
diff --git a/mwmbl/platform/schemas.py b/mwmbl/platform/schemas.py
index f7f19ab..c69a8d1 100644
--- a/mwmbl/platform/schemas.py
+++ b/mwmbl/platform/schemas.py
@@ -67,6 +67,10 @@ class MembershipCheckoutRequest(Schema):
embed_origin: Optional[str] = None
+class MembershipChangeRequest(Schema):
+ tier: MembershipTier
+
+
class UpdateSpendLimitRequest(Schema):
max_monthly_spend_cents: int = Field(ge=0)
diff --git a/test/test_membership.py b/test/test_membership.py
index 9ed824c..5d75d33 100644
--- a/test/test_membership.py
+++ b/test/test_membership.py
@@ -6,6 +6,7 @@ Covers:
- GET /api/v1/platform/membership
- POST /api/v1/platform/membership/checkout
- POST /api/v1/platform/membership/cancel and /uncancel
+- POST /api/v1/platform/membership/change
- Membership subscription events on POST /api/v1/platform/billing/webhook
"""
@@ -421,6 +422,124 @@ def test_cancel_membership_does_not_overwrite_a_subscription_changed_during_the_
assert member.cancel_at_period_end is False
+# ---------------------------------------------------------------------------
+# Change tier
+# ---------------------------------------------------------------------------
+
+
+def _post_change(api_client, user, tier, polar_update_result=None, polar_update_error=None):
+ with patch("mwmbl.platform.api.Polar") as MockPolar:
+ mock_polar = MockPolar.return_value.__enter__.return_value
+ mock_polar.subscriptions.update.return_value = polar_update_result
+ mock_polar.subscriptions.update.side_effect = polar_update_error
+ response = api_client.post(
+ "/api/v1/platform/membership/change",
+ data={"tier": tier},
+ content_type="application/json",
+ **auth_headers(user),
+ )
+ return response, mock_polar
+
+
+@PRODUCT_SETTINGS
+def test_change_membership_switches_product_with_proration(api_client, user):
+ Membership.objects.create(user=user, tier=MembershipTier.SAPLING, polar_subscription_id="sub_member")
+ period_end = datetime(2026, 11, 1, tzinfo=timezone.utc)
+
+ response, mock_polar = _post_change(
+ api_client,
+ user,
+ "canopy",
+ polar_update_result=_polar_subscription(product_id="prod_canopy", current_period_end=period_end),
+ )
+
+ assert response.status_code == 200
+ assert response.json()["tier"] == "canopy"
+ update_params = mock_polar.subscriptions.update.call_args[1]
+ assert update_params["id"] == "sub_member"
+ assert update_params["subscription_update"].product_id == "prod_canopy"
+ assert update_params["subscription_update"].proration_behavior == "prorate"
+ member = Membership.objects.get(user=user)
+ assert member.tier == MembershipTier.CANOPY
+ assert member.current_period_end == period_end
+
+
+@PRODUCT_SETTINGS
+def test_change_membership_not_a_member_returns_404(api_client, user):
+ response, mock_polar = _post_change(api_client, user, "canopy")
+
+ assert response.status_code == 404
+ mock_polar.subscriptions.update.assert_not_called()
+
+
+@PRODUCT_SETTINGS
+def test_change_membership_to_current_tier_returns_409(api_client, user):
+ Membership.objects.create(user=user, tier=MembershipTier.SAPLING, polar_subscription_id="sub_member")
+
+ response, mock_polar = _post_change(api_client, user, "sapling")
+
+ assert response.status_code == 409
+ mock_polar.subscriptions.update.assert_not_called()
+
+
+@PRODUCT_SETTINGS
+def test_change_membership_while_cancelling_returns_409(api_client, user):
+ Membership.objects.create(
+ user=user, tier=MembershipTier.SAPLING, polar_subscription_id="sub_member", cancel_at_period_end=True
+ )
+
+ response, mock_polar = _post_change(api_client, user, "sprout")
+
+ assert response.status_code == 409
+ mock_polar.subscriptions.update.assert_not_called()
+
+
+@PRODUCT_SETTINGS
+def test_change_membership_already_canceled_in_polar_returns_409(api_client, user):
+ Membership.objects.create(user=user, tier=MembershipTier.SAPLING, polar_subscription_id="sub_member")
+
+ response, _ = _post_change(api_client, user, "canopy", polar_update_error=_already_canceled_error())
+
+ assert response.status_code == 409
+ assert Membership.objects.get(user=user).tier == MembershipTier.SAPLING
+
+
+@override_settings(POLAR_PRODUCT_ID_CANOPY="")
+def test_change_membership_not_configured_returns_503(api_client, user):
+ Membership.objects.create(user=user, tier=MembershipTier.SAPLING, polar_subscription_id="sub_member")
+
+ response, mock_polar = _post_change(api_client, user, "canopy")
+
+ assert response.status_code == 503
+ mock_polar.subscriptions.update.assert_not_called()
+
+
+@PRODUCT_SETTINGS
+def test_change_membership_requires_verified_email(api_client, user):
+ Membership.objects.create(user=user, tier=MembershipTier.SAPLING, polar_subscription_id="sub_member")
+ EmailAddress.objects.filter(user=user).update(verified=False)
+
+ response, _ = _post_change(api_client, user, "canopy")
+
+ assert response.status_code == 403
+
+
+def test_change_membership_unauthenticated(api_client):
+ response = api_client.post(
+ "/api/v1/platform/membership/change", data={"tier": "canopy"}, content_type="application/json"
+ )
+
+ assert response.status_code == 401
+
+
# ---------------------------------------------------------------------------
# Webhook
# ---------------------------------------------------------------------------