chore: update subscription API to include allowed payment methods in requests and responses

Author: jimmyn

.openapi-generator/FILES

@@ -96,6 +96,7 @@ Monei/model/subscription_interval.py
 Monei/model/subscription_last_payment.py
 Monei/model/subscription_payment_method.py
 Monei/model/subscription_payment_method_card.py
+Monei/model/subscription_payment_methods.py
 Monei/model/subscription_retry_schedule.py
 Monei/model/subscription_retry_schedule_inner.py
 Monei/model/subscription_status.py
@@ -109,3 +110,4 @@ Monei/model_utils.py
 Monei/models/__init__.py
 Monei/rest.py
 test/__init__.py
+test/test_subscription_payment_methods.py

Monei/api/subscriptions_api.py

@@ -431,7 +431,7 @@ def __init__(self, api_client=None):
     def activate(self, id, **kwargs):
         """Activate Subscription  # noqa: E501
 
-        Activates a subscription by attaching a payment method and initiating the billing cycle.  **Activation Process**:  1. This endpoint transitions a `PENDING` subscription to `ACTIVE` status 2. An initial payment is created to validate the payment method:    - For regular subscriptions: First billing cycle payment is processed immediately    - For trial subscriptions: A zero-amount payment is created to verify the payment method  **Payment Method Updates**: If the subscription is already active, this endpoint can be used to update the payment method. The update process creates a zero-amount payment to verify the new payment method works correctly.  **Important Notes**:  - Subscription billing begins immediately upon successful activation (unless in trial period) - The payment method provided will be used for all future recurring charges - Activation failures (due to invalid payment method) will keep the subscription in `PENDING` status   # noqa: E501
+        Activates a subscription by attaching a payment method and initiating the billing cycle.  **Activation Process**:  1. This endpoint transitions a `PENDING` subscription to `ACTIVE` status 2. An initial payment is created to validate the payment method:    - For regular subscriptions: First billing cycle payment is processed immediately    - For trial subscriptions: A zero-amount payment is created to verify the payment method  **Payment Method Updates**: If the subscription is already active, this endpoint can be used to update the payment method. The update process creates a zero-amount payment to verify the new payment method works correctly.  **Important Notes**:  - Subscription billing begins immediately upon successful activation (unless in trial period) - The payment method provided will be used for all future recurring charges - Activation failures (due to invalid payment method) will keep the subscription in `PENDING` status - You can specify `allowedPaymentMethods` to restrict which payment methods (e.g., `card`, `bizum`) are accepted for the subscription   # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -559,7 +559,7 @@ def cancel(self, id, **kwargs):
     def create(self, create_subscription_request, **kwargs):
         """Create Subscription  # noqa: E501
 
-        Creates a new subscription with the specified parameters.  **Subscription Lifecycle**:  1. When first created, the subscription has a `PENDING` status 2. To initiate billing, you must call the [activate endpoint](https://docs.monei.com/apis/rest/subscriptions-activate/) with payment details 3. Once activated, the subscription will automatically bill according to the configured interval  **Key Configuration Parameters**:  - **Billing settings**: Amount, currency, interval (daily, weekly, monthly, yearly) - **Schedule customization**: Interval count, trial period duration - **Customer information**: Contact details, billing and shipping addresses - **Communication**: Callback URLs for webhook notifications about subscription events  **Best Practices**:  - Set clear, descriptive names for subscriptions to help with identification - Configure appropriate webhook notifications to monitor subscription status changes - Consider offering trial periods to increase customer conversion rates - Use metadata to store additional information relevant to your business logic   # noqa: E501
+        Creates a new subscription with the specified parameters.  **Subscription Lifecycle**:  1. When first created, the subscription has a `PENDING` status 2. To initiate billing, you must call the [activate endpoint](https://docs.monei.com/apis/rest/subscriptions-activate/) with payment details 3. Once activated, the subscription will automatically bill according to the configured interval  **Key Configuration Parameters**:  - **Billing settings**: Amount, currency, interval (daily, weekly, monthly, yearly) - **Schedule customization**: Interval count, trial period duration - **Allowed payment methods**: An array of strings specifying which payment methods are allowed for this subscription (e.g., `card`, `bizum`) - **Customer information**: Contact details, billing and shipping addresses - **Communication**: Callback URLs for webhook notifications about subscription events  **Best Practices**:  - Set clear, descriptive names for subscriptions to help with identification - Configure appropriate webhook notifications to monitor subscription status changes - Consider offering trial periods to increase customer conversion rates - Use metadata to store additional information relevant to your business logic   # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -940,7 +940,7 @@ def send_status(self, id, **kwargs):
     def update(self, id, update_subscription_request, **kwargs):
         """Update Subscription  # noqa: E501
 
-        Updates the configuration of an existing subscription.  **Modifiable Parameters**:  - Billing information (amount, description) - Customer details (contact information, billing/shipping addresses) - Subscription settings (cancelAtPeriodEnd, pauseAtPeriodEnd, skipIntervalCount) - Metadata (for your internal tracking)  **Update Effects**:  - Amount changes apply to the next billing cycle - Customer information updates take effect immediately - Setting `cancelAtPeriodEnd` to true will end the subscription after the current period - Setting `pauseAtPeriodEnd` to true will pause billing after the current period - Setting `skipIntervalCount` skips billing for the specified number of intervals without changing subscription status  **Note**: Some fundamental properties cannot be changed once a subscription is created, including currency and billing interval. To modify these, you would need to cancel the existing subscription and create a new one.   # noqa: E501
+        Updates the configuration of an existing subscription.  **Modifiable Parameters**:  - Billing information (amount, description, allowedPaymentMethods) - Customer details (contact information, billing/shipping addresses) - Subscription settings (cancelAtPeriodEnd, pauseAtPeriodEnd, skipIntervalCount) - Metadata (for your internal tracking)  **Update Effects**:  - Amount changes apply to the next billing cycle - Customer information updates take effect immediately - Setting `cancelAtPeriodEnd` to true will end the subscription after the current period - Setting `pauseAtPeriodEnd` to true will pause billing after the current period - Setting `skipIntervalCount` skips billing for the specified number of intervals without changing subscription status  **Note**: Some fundamental properties cannot be changed once a subscription is created, including currency and billing interval. To modify these, you would need to cancel the existing subscription and create a new one.   # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 

Monei/model/activate_subscription_request.py

@@ -28,6 +28,12 @@
 from Monei.exceptions import ApiAttributeError
 
 
+def lazy_import():
+    from Monei.model.subscription_payment_methods import SubscriptionPaymentMethods
+
+    globals()["SubscriptionPaymentMethods"] = SubscriptionPaymentMethods
+
+
 class ActivateSubscriptionRequest(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
@@ -62,6 +68,7 @@ def additional_properties_type():
         This must be a method because a model may have properties that are
         of type self, this must run after the class is loaded
         """
+        lazy_import()
         return (
             bool,
             date,
@@ -86,6 +93,7 @@ def openapi_types():
             openapi_types (dict): The key is attribute name
                 and the value is attribute type.
         """
+        lazy_import()
         return {
             "payment_token": (
                 bool,
@@ -110,6 +118,7 @@ def openapi_types():
                 str,
                 none_type,
             ),  # noqa: E501
+            "allowed_payment_methods": (SubscriptionPaymentMethods,),  # noqa: E501
             "sequence_id": (str,),  # noqa: E501
             "complete_url": (str,),  # noqa: E501
             "fail_url": (str,),  # noqa: E501
@@ -127,6 +136,7 @@ def discriminator():
         "payment_token": "paymentToken",  # noqa: E501
         "session_id": "sessionId",  # noqa: E501
         "add_amount": "addAmount",  # noqa: E501
+        "allowed_payment_methods": "allowedPaymentMethods",  # noqa: E501
         "sequence_id": "sequenceId",  # noqa: E501
         "complete_url": "completeUrl",  # noqa: E501
         "fail_url": "failUrl",  # noqa: E501
@@ -177,6 +187,7 @@ def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
             payment_token (bool, date, datetime, dict, float, int, list, str, none_type): A payment token generated by monei.js [Components](https://docs.monei.com/monei-js/overview/) or a paymentToken [saved after a previous successful payment](https://docs.monei.com/guides/save-payment-method/). In case of the first one, you will also need to send the `sessionId` used to generate the token in the first place. . [optional]  # noqa: E501
             session_id (str): A unique identifier within your system that adds security to the payment process. You need to pass the same session ID as the one used on the frontend to initialize MONEI Component (if you needed to). This is required if a payment token (not permanent) was already generated in the frontend. . [optional]  # noqa: E501
             add_amount (bool, date, datetime, dict, float, int, list, str, none_type): The amount to be added to the subscription's initial payment. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge 1.00 USD). . [optional]  # noqa: E501
+            allowed_payment_methods (SubscriptionPaymentMethods): [optional]  # noqa: E501
             sequence_id (str): A permanent identifier that refers to the initial payment of a sequence of payments. This value needs to be sent in the path for `RECURRING` payments. . [optional]  # noqa: E501
             complete_url (str): The URL the customer will be directed to after transaction completed (successful or failed - except if `failUrl` is provided). . [optional]  # noqa: E501
             fail_url (str): The URL the customer will be directed to after transaction has failed, instead of `completeUrl` (used in hosted payment page). This allows to provide two different URLs for successful and failed payments. . [optional]  # noqa: E501
@@ -275,6 +286,7 @@ def __init__(self, *args, **kwargs):  # noqa: E501
             payment_token (bool, date, datetime, dict, float, int, list, str, none_type): A payment token generated by monei.js [Components](https://docs.monei.com/monei-js/overview/) or a paymentToken [saved after a previous successful payment](https://docs.monei.com/guides/save-payment-method/). In case of the first one, you will also need to send the `sessionId` used to generate the token in the first place. . [optional]  # noqa: E501
             session_id (str): A unique identifier within your system that adds security to the payment process. You need to pass the same session ID as the one used on the frontend to initialize MONEI Component (if you needed to). This is required if a payment token (not permanent) was already generated in the frontend. . [optional]  # noqa: E501
             add_amount (bool, date, datetime, dict, float, int, list, str, none_type): The amount to be added to the subscription's initial payment. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge 1.00 USD). . [optional]  # noqa: E501
+            allowed_payment_methods (SubscriptionPaymentMethods): [optional]  # noqa: E501
             sequence_id (str): A permanent identifier that refers to the initial payment of a sequence of payments. This value needs to be sent in the path for `RECURRING` payments. . [optional]  # noqa: E501
             complete_url (str): The URL the customer will be directed to after transaction completed (successful or failed - except if `failUrl` is provided). . [optional]  # noqa: E501
             fail_url (str): The URL the customer will be directed to after transaction has failed, instead of `completeUrl` (used in hosted payment page). This allows to provide two different URLs for successful and failed payments. . [optional]  # noqa: E501

Monei/model/create_subscription_request.py

@@ -33,12 +33,14 @@ def lazy_import():
     from Monei.model.payment_customer import PaymentCustomer
     from Monei.model.payment_shipping_details import PaymentShippingDetails
     from Monei.model.subscription_interval import SubscriptionInterval
+    from Monei.model.subscription_payment_methods import SubscriptionPaymentMethods
     from Monei.model.subscription_retry_schedule import SubscriptionRetrySchedule
 
     globals()["PaymentBillingDetails"] = PaymentBillingDetails
     globals()["PaymentCustomer"] = PaymentCustomer
     globals()["PaymentShippingDetails"] = PaymentShippingDetails
     globals()["SubscriptionInterval"] = SubscriptionInterval
+    globals()["SubscriptionPaymentMethods"] = SubscriptionPaymentMethods
     globals()["SubscriptionRetrySchedule"] = SubscriptionRetrySchedule
 
 
@@ -107,6 +109,7 @@ def openapi_types():
             "currency": (str,),  # noqa: E501
             "interval": (SubscriptionInterval,),  # noqa: E501
             "interval_count": (int,),  # noqa: E501
+            "allowed_payment_methods": (SubscriptionPaymentMethods,),  # noqa: E501
             "description": (str,),  # noqa: E501
             "customer": (PaymentCustomer,),  # noqa: E501
             "billing_details": (PaymentBillingDetails,),  # noqa: E501
@@ -130,6 +133,7 @@ def discriminator():
         "currency": "currency",  # noqa: E501
         "interval": "interval",  # noqa: E501
         "interval_count": "intervalCount",  # noqa: E501
+        "allowed_payment_methods": "allowedPaymentMethods",  # noqa: E501
         "description": "description",  # noqa: E501
         "customer": "customer",  # noqa: E501
         "billing_details": "billingDetails",  # noqa: E501
@@ -190,6 +194,7 @@ def _from_openapi_data(
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
             interval_count (int): Number of intervals between subscription payments.. [optional]  # noqa: E501
+            allowed_payment_methods (SubscriptionPaymentMethods): [optional]  # noqa: E501
             description (str): An arbitrary string attached to the subscription. Often useful for displaying to users. . [optional]  # noqa: E501
             customer (PaymentCustomer): [optional]  # noqa: E501
             billing_details (PaymentBillingDetails): [optional]  # noqa: E501
@@ -299,6 +304,7 @@ def __init__(self, amount, currency, interval, *args, **kwargs):  # noqa: E501
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
             interval_count (int): Number of intervals between subscription payments.. [optional]  # noqa: E501
+            allowed_payment_methods (SubscriptionPaymentMethods): [optional]  # noqa: E501
             description (str): An arbitrary string attached to the subscription. Often useful for displaying to users. . [optional]  # noqa: E501
             customer (PaymentCustomer): [optional]  # noqa: E501
             billing_details (PaymentBillingDetails): [optional]  # noqa: E501

Monei/model/subscription.py

@@ -36,6 +36,7 @@ def lazy_import():
     from Monei.model.subscription_interval import SubscriptionInterval
     from Monei.model.subscription_last_payment import SubscriptionLastPayment
     from Monei.model.subscription_payment_method import SubscriptionPaymentMethod
+    from Monei.model.subscription_payment_methods import SubscriptionPaymentMethods
     from Monei.model.subscription_retry_schedule import SubscriptionRetrySchedule
     from Monei.model.subscription_status import SubscriptionStatus
 
@@ -46,6 +47,7 @@ def lazy_import():
     globals()["SubscriptionInterval"] = SubscriptionInterval
     globals()["SubscriptionLastPayment"] = SubscriptionLastPayment
     globals()["SubscriptionPaymentMethod"] = SubscriptionPaymentMethod
+    globals()["SubscriptionPaymentMethods"] = SubscriptionPaymentMethods
     globals()["SubscriptionRetrySchedule"] = SubscriptionRetrySchedule
     globals()["SubscriptionStatus"] = SubscriptionStatus
 
@@ -119,6 +121,7 @@ def openapi_types():
             "interval": (SubscriptionInterval,),  # noqa: E501
             "interval_count": (int,),  # noqa: E501
             "currency": (str,),  # noqa: E501
+            "allowed_payment_methods": (SubscriptionPaymentMethods,),  # noqa: E501
             "description": (str,),  # noqa: E501
             "customer": (PaymentCustomer,),  # noqa: E501
             "billing_details": (PaymentBillingDetails,),  # noqa: E501
@@ -160,6 +163,7 @@ def discriminator():
         "interval": "interval",  # noqa: E501
         "interval_count": "intervalCount",  # noqa: E501
         "currency": "currency",  # noqa: E501
+        "allowed_payment_methods": "allowedPaymentMethods",  # noqa: E501
         "description": "description",  # noqa: E501
         "customer": "customer",  # noqa: E501
         "billing_details": "billingDetails",  # noqa: E501
@@ -247,6 +251,7 @@ def _from_openapi_data(
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
             currency (str): Three-letter [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217), in uppercase. Must be a supported currency. . [optional]  # noqa: E501
+            allowed_payment_methods (SubscriptionPaymentMethods): [optional]  # noqa: E501
             description (str): An arbitrary string attached to the subscription. Often useful for displaying to users. . [optional]  # noqa: E501
             customer (PaymentCustomer): [optional]  # noqa: E501
             billing_details (PaymentBillingDetails): [optional]  # noqa: E501
@@ -389,6 +394,7 @@ def __init__(
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
             currency (str): Three-letter [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217), in uppercase. Must be a supported currency. . [optional]  # noqa: E501
+            allowed_payment_methods (SubscriptionPaymentMethods): [optional]  # noqa: E501
             description (str): An arbitrary string attached to the subscription. Often useful for displaying to users. . [optional]  # noqa: E501
             customer (PaymentCustomer): [optional]  # noqa: E501
             billing_details (PaymentBillingDetails): [optional]  # noqa: E501