feat: Add on_resume support to subscription resume and pause operations (#86)

davidgrayston-paddle · web-flow · commit c2ba603c22b6 · 2024-12-19T09:43:17.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 Check our main [developer changelog](https://developer.paddle.com/?utm_source=dx&utm_medium=paddle-python-sdk) for information about changes to the Paddle Billing platform, the Paddle API, and other developer tools.
 
+## 1.4.0 - 2024-12-19
+
+### Added
+
+- Added `on_resume` support to subscription resume and pause operations
+
 ## 1.3.1 - 2024-12-17
 
 ### Fixed
diff --git a/paddle_billing/Client.py b/paddle_billing/Client.py
@@ -204,7 +204,7 @@ def build_request_session(self) -> Session:
                 "Authorization": f"Bearer {self.__api_key}",
                 "Content-Type": "application/json",
                 "Paddle-Version": str(self.use_api_version),
-                "User-Agent": "PaddleSDK/python 1.3.1",
+                "User-Agent": "PaddleSDK/python 1.4.0",
             }
         )
 
diff --git a/paddle_billing/Entities/Subscriptions/SubscriptionOnResume.py b/paddle_billing/Entities/Subscriptions/SubscriptionOnResume.py
@@ -0,0 +1,6 @@
+from paddle_billing.PaddleStrEnum import PaddleStrEnum, PaddleStrEnumMeta
+
+
+class SubscriptionOnResume(PaddleStrEnum, metaclass=PaddleStrEnumMeta):
+    ContinueExistingBillingPeriod: "SubscriptionOnResume" = "continue_existing_billing_period"
+    StartNewBillingPeriod: "SubscriptionOnResume" = "start_new_billing_period"
diff --git a/paddle_billing/Entities/Subscriptions/__init__.py b/paddle_billing/Entities/Subscriptions/__init__.py
@@ -9,6 +9,7 @@
 from paddle_billing.Entities.Subscriptions.SubscriptionManagementUrls import SubscriptionManagementUrls
 from paddle_billing.Entities.Subscriptions.SubscriptionNextTransaction import SubscriptionNextTransaction
 from paddle_billing.Entities.Subscriptions.SubscriptionOnPaymentFailure import SubscriptionOnPaymentFailure
+from paddle_billing.Entities.Subscriptions.SubscriptionOnResume import SubscriptionOnResume
 from paddle_billing.Entities.Subscriptions.SubscriptionPreviewSubscriptionUpdateSummary import (
     SubscriptionPreviewSubscriptionUpdateSummary,
 )
diff --git a/paddle_billing/Resources/Subscriptions/Operations/PauseSubscription.py b/paddle_billing/Resources/Subscriptions/Operations/PauseSubscription.py
@@ -2,10 +2,12 @@
 
 from paddle_billing.Operation import Operation
 from paddle_billing.Entities.DateTime import DateTime
-from paddle_billing.Entities.Subscriptions import SubscriptionEffectiveFrom
+from paddle_billing.Entities.Subscriptions import SubscriptionEffectiveFrom, SubscriptionOnResume
+from paddle_billing.Undefined import Undefined
 
 
 @dataclass
 class PauseSubscription(Operation):
     effective_from: SubscriptionEffectiveFrom | None = None
     resume_at: DateTime | None = None
+    on_resume: SubscriptionOnResume | Undefined = Undefined()
diff --git a/paddle_billing/Resources/Subscriptions/Operations/ResumeSubscription.py b/paddle_billing/Resources/Subscriptions/Operations/ResumeSubscription.py
@@ -2,9 +2,11 @@
 
 from paddle_billing.Operation import Operation
 from paddle_billing.Entities.DateTime import DateTime
-from paddle_billing.Entities.Subscriptions import SubscriptionResumeEffectiveFrom
+from paddle_billing.Entities.Subscriptions import SubscriptionResumeEffectiveFrom, SubscriptionOnResume
+from paddle_billing.Undefined import Undefined
 
 
 @dataclass
 class ResumeSubscription(Operation):
     effective_from: SubscriptionResumeEffectiveFrom | DateTime | None = None
+    on_resume: SubscriptionOnResume | Undefined = Undefined()
diff --git a/setup.py b/setup.py
@@ -2,7 +2,7 @@
 
 
 setup(
-    version="1.3.1",
+    version="1.4.0",
     author="Paddle and contributors",
     author_email="team-dx@paddle.com",
     description="Paddle's Python SDK for Paddle Billing",
diff --git a/tests/Functional/Resources/Subscriptions/_fixtures/request/pause_resume_existing_billing_period.json b/tests/Functional/Resources/Subscriptions/_fixtures/request/pause_resume_existing_billing_period.json
@@ -0,0 +1,5 @@
+{
+    "effective_from": "next_billing_period",
+    "resume_at": "2023-10-09T16:30:00.000000Z",
+    "on_resume": "continue_existing_billing_period"
+}
diff --git a/tests/Functional/Resources/Subscriptions/_fixtures/request/pause_resume_new_billing_period.json b/tests/Functional/Resources/Subscriptions/_fixtures/request/pause_resume_new_billing_period.json
@@ -0,0 +1,5 @@
+{
+    "effective_from": "next_billing_period",
+    "resume_at": "2023-10-09T16:30:00.000000Z",
+    "on_resume": "start_new_billing_period"
+}
diff --git a/tests/Functional/Resources/Subscriptions/_fixtures/request/resume_existing_billing_period.json b/tests/Functional/Resources/Subscriptions/_fixtures/request/resume_existing_billing_period.json
@@ -0,0 +1,4 @@
+{
+    "effective_from": "immediately",
+    "on_resume": "continue_existing_billing_period"
+}
diff --git a/tests/Functional/Resources/Subscriptions/_fixtures/request/resume_new_billing_period.json b/tests/Functional/Resources/Subscriptions/_fixtures/request/resume_new_billing_period.json
@@ -0,0 +1,4 @@
+{
+    "effective_from": "immediately",
+    "on_resume": "start_new_billing_period"
+}
diff --git a/tests/Functional/Resources/Subscriptions/test_SubscriptionsClient.py b/tests/Functional/Resources/Subscriptions/test_SubscriptionsClient.py
@@ -26,6 +26,7 @@
 from paddle_billing.Entities.Subscriptions import (
     SubscriptionEffectiveFrom,
     SubscriptionOnPaymentFailure,
+    SubscriptionOnResume,
     SubscriptionProrationBillingMode,
     SubscriptionResumeEffectiveFrom,
     SubscriptionScheduledChangeAction,
@@ -516,11 +517,37 @@ def test_get_subscription_returns_transaction_line_item_proration(
                 ReadsFixtures.read_raw_json_fixture("response/full_entity"),
                 "/subscriptions/sub_01h8bx8fmywym11t6swgzba704/pause",
             ),
+            (
+                "sub_01h8bx8fmywym11t6swgzba704",
+                PauseSubscription(
+                    SubscriptionEffectiveFrom.NextBillingPeriod,
+                    DateTime("2023-10-09T16:30:00Z"),
+                    SubscriptionOnResume.ContinueExistingBillingPeriod,
+                ),
+                ReadsFixtures.read_raw_json_fixture("request/pause_resume_existing_billing_period"),
+                200,
+                ReadsFixtures.read_raw_json_fixture("response/full_entity"),
+                "/subscriptions/sub_01h8bx8fmywym11t6swgzba704/pause",
+            ),
+            (
+                "sub_01h8bx8fmywym11t6swgzba704",
+                PauseSubscription(
+                    SubscriptionEffectiveFrom.NextBillingPeriod,
+                    DateTime("2023-10-09T16:30:00Z"),
+                    SubscriptionOnResume.StartNewBillingPeriod,
+                ),
+                ReadsFixtures.read_raw_json_fixture("request/pause_resume_new_billing_period"),
+                200,
+                ReadsFixtures.read_raw_json_fixture("response/full_entity"),
+                "/subscriptions/sub_01h8bx8fmywym11t6swgzba704/pause",
+            ),
         ],
         ids=[
             "Pause subscription",
             "Pause subscription as of next billing period",
             "Pause subscription as of next billing period and resume at date",
+            "Pause subscription resume in existing billing period",
+            "Pause subscription resume in new billing period",
         ],
     )
     def test_pause_subscription_uses_expected_payload(
@@ -583,11 +610,33 @@ def test_pause_subscription_uses_expected_payload(
                 ReadsFixtures.read_raw_json_fixture("response/full_entity"),
                 "/subscriptions/sub_01h8bx8fmywym11t6swgzba704/resume",
             ),
+            (
+                "sub_01h8bx8fmywym11t6swgzba704",
+                ResumeSubscription(
+                    SubscriptionResumeEffectiveFrom.Immediately, SubscriptionOnResume.ContinueExistingBillingPeriod
+                ),
+                ReadsFixtures.read_raw_json_fixture("request/resume_existing_billing_period"),
+                200,
+                ReadsFixtures.read_raw_json_fixture("response/full_entity"),
+                "/subscriptions/sub_01h8bx8fmywym11t6swgzba704/resume",
+            ),
+            (
+                "sub_01h8bx8fmywym11t6swgzba704",
+                ResumeSubscription(
+                    SubscriptionResumeEffectiveFrom.Immediately, SubscriptionOnResume.StartNewBillingPeriod
+                ),
+                ReadsFixtures.read_raw_json_fixture("request/resume_new_billing_period"),
+                200,
+                ReadsFixtures.read_raw_json_fixture("response/full_entity"),
+                "/subscriptions/sub_01h8bx8fmywym11t6swgzba704/resume",
+            ),
         ],
         ids=[
             "Resume subscription",
             "Resume subscription with a billing period",
             "Resume subscription with a new date",
+            "Resume subscription in existing billing period",
+            "Resume subscription in new billing period",
         ],
     )
     def test_resume_subscription_uses_expected_payload(

Original file line number	Diff line number	Diff line change
`@@ -204,7 +204,7 @@ def build_request_session(self) -> Session:`
`204`	`204`	`"Authorization": f"Bearer {self.__api_key}",`
`205`	`205`	`"Content-Type": "application/json",`
`206`	`206`	`"Paddle-Version": str(self.use_api_version),`
`207`		`- "User-Agent": "PaddleSDK/python 1.3.1",`
	`207`	`+ "User-Agent": "PaddleSDK/python 1.4.0",`
`208`	`208`	`}`
`209`	`209`	`)`
`210`	`210`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@`
`9`	`9`	`from paddle_billing.Entities.Subscriptions.SubscriptionManagementUrls import SubscriptionManagementUrls`
`10`	`10`	`from paddle_billing.Entities.Subscriptions.SubscriptionNextTransaction import SubscriptionNextTransaction`
`11`	`11`	`from paddle_billing.Entities.Subscriptions.SubscriptionOnPaymentFailure import SubscriptionOnPaymentFailure`
	`12`	`+from paddle_billing.Entities.Subscriptions.SubscriptionOnResume import SubscriptionOnResume`
`12`	`13`	`from paddle_billing.Entities.Subscriptions.SubscriptionPreviewSubscriptionUpdateSummary import (`
`13`	`14`	`SubscriptionPreviewSubscriptionUpdateSummary,`
`14`	`15`	`)`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +    "effective_from": "immediately",
 +    "on_resume": "continue_existing_billing_period"
 +}