pinelabs-python 0.1.0__py3-none-any.whl

pinelabs/subscriptions_plans/raw_client.py

@@ -0,0 +1,1111 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+from json.decoder import JSONDecodeError
+
+from ..core.api_error import ApiError
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.datetime_utils import serialize_datetime
+from ..core.http_response import AsyncHttpResponse, HttpResponse
+from ..core.jsonable_encoder import encode_path_param
+from ..core.parse_error import ParsingError
+from ..core.pydantic_utilities import parse_obj_as
+from ..core.request_options import RequestOptions
+from ..core.serialization import convert_and_respect_annotation_metadata
+from ..errors.bad_request_error import BadRequestError
+from ..errors.internal_server_error import InternalServerError
+from ..errors.not_found_error import NotFoundError
+from ..errors.unprocessable_entity_error import UnprocessableEntityError
+from ..types.error_response import ErrorResponse
+from ..types.list_plans_response import ListPlansResponse
+from ..types.plan_response import PlanResponse
+from ..types.subscription_amount import SubscriptionAmount
+from .types.create_plan_request_frequency import CreatePlanRequestFrequency
+from .types.list_plans_request_amount_range import ListPlansRequestAmountRange
+from pydantic import ValidationError
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class RawSubscriptionsPlansClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def list_plans(
+        self,
+        *,
+        plan_id: typing.Optional[str] = None,
+        start_date: typing.Optional[dt.datetime] = None,
+        end_date: typing.Optional[dt.datetime] = None,
+        amount: typing.Optional[int] = None,
+        amount_range: typing.Optional[ListPlansRequestAmountRange] = None,
+        frequency: typing.Optional[str] = None,
+        size: typing.Optional[int] = None,
+        page: typing.Optional[int] = None,
+        sort: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[ListPlansResponse]:
+        """
+        Retrieves all subscription plans. Supports filtering by plan_id,
+        date range, amount, frequency, and pagination.
+
+        Parameters
+        ----------
+        plan_id : typing.Optional[str]
+            Filter by plan ID.
+
+        start_date : typing.Optional[dt.datetime]
+            Filter plans with start date after this value (ISO 8601 UTC).
+
+        end_date : typing.Optional[dt.datetime]
+            Filter plans with end date before this value (ISO 8601 UTC).
+
+        amount : typing.Optional[int]
+            Filter by amount value.
+
+        amount_range : typing.Optional[ListPlansRequestAmountRange]
+            Amount comparison operator.
+
+        frequency : typing.Optional[str]
+            Filter by billing frequency.
+
+        size : typing.Optional[int]
+            Number of items per page.
+
+        page : typing.Optional[int]
+            Page number.
+
+        sort : typing.Optional[str]
+            Sort field and direction.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[ListPlansResponse]
+            Plans retrieved successfully.
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "ps/api/v1/public/plans",
+            method="GET",
+            params={
+                "plan_id": plan_id,
+                "start_date": serialize_datetime(start_date) if start_date is not None else None,
+                "end_date": serialize_datetime(end_date) if end_date is not None else None,
+                "amount": amount,
+                "amount_range": amount_range,
+                "frequency": frequency,
+                "size": size,
+                "page": page,
+                "sort": sort,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    ListPlansResponse,
+                    parse_obj_as(
+                        type_=ListPlansResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    def create_plan(
+        self,
+        *,
+        plan_name: str,
+        frequency: CreatePlanRequestFrequency,
+        amount: SubscriptionAmount,
+        max_limit_amount: SubscriptionAmount,
+        end_date: dt.datetime,
+        merchant_plan_reference: str,
+        plan_description: typing.Optional[str] = OMIT,
+        initial_debit_amount: typing.Optional[SubscriptionAmount] = OMIT,
+        trial_period_in_days: typing.Optional[int] = OMIT,
+        start_date: typing.Optional[dt.datetime] = OMIT,
+        merchant_metadata: typing.Optional[typing.Dict[str, str]] = OMIT,
+        auto_debit_ot: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[PlanResponse]:
+        """
+        Creates a new subscription plan that serves as a reusable template
+        defining the pricing structure, billing frequency, and payment terms.
+        Plans must be created before subscriptions can be set up.
+
+        Parameters
+        ----------
+        plan_name : str
+            Subscription plan name.
+
+        frequency : CreatePlanRequestFrequency
+            Frequency of recurring transactions for this particular plan.
+
+        amount : SubscriptionAmount
+
+        max_limit_amount : SubscriptionAmount
+
+        end_date : dt.datetime
+            The ISO 8601 UTC Timestamp when the subscription plan expires.
+
+        merchant_plan_reference : str
+            **Idempotency Key.** Unique identifier of the merchant plan reference. Duplicate requests with the same `merchant_plan_reference` will return the existing plan instead of creating a new one.
+
+        plan_description : typing.Optional[str]
+            Corresponding description for a plan.
+
+        initial_debit_amount : typing.Optional[SubscriptionAmount]
+
+        trial_period_in_days : typing.Optional[int]
+            Duration of the trial period in days.
+
+        start_date : typing.Optional[dt.datetime]
+            The ISO 8601 UTC Timestamp when the subscription plan is active and available for use.
+
+        merchant_metadata : typing.Optional[typing.Dict[str, str]]
+            Key-value pairs for additional information. Max 10 pairs, 256 chars each.
+
+        auto_debit_ot : typing.Optional[str]
+            Indicates whether auto-debit is enabled for one-time payments under the subscription plan.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[PlanResponse]
+            Plan created successfully.
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "ps/api/v1/public/plans",
+            method="POST",
+            json={
+                "plan_name": plan_name,
+                "plan_description": plan_description,
+                "frequency": frequency,
+                "amount": convert_and_respect_annotation_metadata(
+                    object_=amount, annotation=SubscriptionAmount, direction="write"
+                ),
+                "max_limit_amount": convert_and_respect_annotation_metadata(
+                    object_=max_limit_amount, annotation=SubscriptionAmount, direction="write"
+                ),
+                "initial_debit_amount": convert_and_respect_annotation_metadata(
+                    object_=initial_debit_amount, annotation=SubscriptionAmount, direction="write"
+                ),
+                "trial_period_in_days": trial_period_in_days,
+                "start_date": start_date,
+                "end_date": end_date,
+                "merchant_metadata": merchant_metadata,
+                "merchant_plan_reference": merchant_plan_reference,
+                "auto_debit_ot": auto_debit_ot,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    PlanResponse,
+                    parse_obj_as(
+                        type_=PlanResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    def get_plan_by_id(
+        self, plan_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[PlanResponse]:
+        """
+        Retrieves a specific subscription plan by its plan ID.
+
+        Parameters
+        ----------
+        plan_id : str
+            Unique identifier for the subscription plan.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[PlanResponse]
+            Plan retrieved successfully.
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"ps/api/v1/public/plans/{encode_path_param(plan_id)}",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    PlanResponse,
+                    parse_obj_as(
+                        type_=PlanResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    def delete_plan(
+        self, plan_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[None]:
+        """
+        Deletes a subscription plan by its plan ID.
+
+        Parameters
+        ----------
+        plan_id : str
+            Unique identifier for the subscription plan.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[None]
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"ps/api/v1/public/plans/{encode_path_param(plan_id)}",
+            method="DELETE",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return HttpResponse(response=_response, data=None)
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    def update_plan(
+        self,
+        plan_id: str,
+        *,
+        plan_name: typing.Optional[str] = OMIT,
+        plan_description: typing.Optional[str] = OMIT,
+        amount: typing.Optional[SubscriptionAmount] = OMIT,
+        max_limit_amount: typing.Optional[SubscriptionAmount] = OMIT,
+        trial_period_in_days: typing.Optional[int] = OMIT,
+        end_date: typing.Optional[dt.datetime] = OMIT,
+        merchant_metadata: typing.Optional[typing.Dict[str, str]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[PlanResponse]:
+        """
+        Updates an existing subscription plan. Existing subscriptions under
+        this plan will remain unaffected. The changes will apply only to
+        new subscriptions created under this plan.
+
+        Parameters
+        ----------
+        plan_id : str
+            Unique identifier for the subscription plan.
+
+        plan_name : typing.Optional[str]
+            Subscription plan name.
+
+        plan_description : typing.Optional[str]
+            Corresponding description for a plan.
+
+        amount : typing.Optional[SubscriptionAmount]
+
+        max_limit_amount : typing.Optional[SubscriptionAmount]
+
+        trial_period_in_days : typing.Optional[int]
+            Duration of the trial period in days.
+
+        end_date : typing.Optional[dt.datetime]
+            The ISO 8601 UTC Timestamp when the subscription plan expires.
+
+        merchant_metadata : typing.Optional[typing.Dict[str, str]]
+            Key-value pairs for additional information. Max 10 pairs, 256 chars each.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[PlanResponse]
+            Plan updated successfully.
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"ps/api/v1/public/plans/{encode_path_param(plan_id)}",
+            method="PATCH",
+            json={
+                "plan_name": plan_name,
+                "plan_description": plan_description,
+                "amount": convert_and_respect_annotation_metadata(
+                    object_=amount, annotation=SubscriptionAmount, direction="write"
+                ),
+                "max_limit_amount": convert_and_respect_annotation_metadata(
+                    object_=max_limit_amount, annotation=SubscriptionAmount, direction="write"
+                ),
+                "trial_period_in_days": trial_period_in_days,
+                "end_date": end_date,
+                "merchant_metadata": merchant_metadata,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    PlanResponse,
+                    parse_obj_as(
+                        type_=PlanResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    def get_plan_by_merchant_reference(
+        self, merchant_plan_reference: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[PlanResponse]:
+        """
+        Retrieves a specific subscription plan by the merchant plan reference.
+
+        Parameters
+        ----------
+        merchant_plan_reference : str
+            Unique identifier of the merchant plan reference.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[PlanResponse]
+            Plan retrieved successfully.
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"ps/api/v1/public/plans/reference/{encode_path_param(merchant_plan_reference)}",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    PlanResponse,
+                    parse_obj_as(
+                        type_=PlanResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+
+class AsyncRawSubscriptionsPlansClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def list_plans(
+        self,
+        *,
+        plan_id: typing.Optional[str] = None,
+        start_date: typing.Optional[dt.datetime] = None,
+        end_date: typing.Optional[dt.datetime] = None,
+        amount: typing.Optional[int] = None,
+        amount_range: typing.Optional[ListPlansRequestAmountRange] = None,
+        frequency: typing.Optional[str] = None,
+        size: typing.Optional[int] = None,
+        page: typing.Optional[int] = None,
+        sort: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[ListPlansResponse]:
+        """
+        Retrieves all subscription plans. Supports filtering by plan_id,
+        date range, amount, frequency, and pagination.
+
+        Parameters
+        ----------
+        plan_id : typing.Optional[str]
+            Filter by plan ID.
+
+        start_date : typing.Optional[dt.datetime]
+            Filter plans with start date after this value (ISO 8601 UTC).
+
+        end_date : typing.Optional[dt.datetime]
+            Filter plans with end date before this value (ISO 8601 UTC).
+
+        amount : typing.Optional[int]
+            Filter by amount value.
+
+        amount_range : typing.Optional[ListPlansRequestAmountRange]
+            Amount comparison operator.
+
+        frequency : typing.Optional[str]
+            Filter by billing frequency.
+
+        size : typing.Optional[int]
+            Number of items per page.
+
+        page : typing.Optional[int]
+            Page number.
+
+        sort : typing.Optional[str]
+            Sort field and direction.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[ListPlansResponse]
+            Plans retrieved successfully.
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "ps/api/v1/public/plans",
+            method="GET",
+            params={
+                "plan_id": plan_id,
+                "start_date": serialize_datetime(start_date) if start_date is not None else None,
+                "end_date": serialize_datetime(end_date) if end_date is not None else None,
+                "amount": amount,
+                "amount_range": amount_range,
+                "frequency": frequency,
+                "size": size,
+                "page": page,
+                "sort": sort,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    ListPlansResponse,
+                    parse_obj_as(
+                        type_=ListPlansResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    async def create_plan(
+        self,
+        *,
+        plan_name: str,
+        frequency: CreatePlanRequestFrequency,
+        amount: SubscriptionAmount,
+        max_limit_amount: SubscriptionAmount,
+        end_date: dt.datetime,
+        merchant_plan_reference: str,
+        plan_description: typing.Optional[str] = OMIT,
+        initial_debit_amount: typing.Optional[SubscriptionAmount] = OMIT,
+        trial_period_in_days: typing.Optional[int] = OMIT,
+        start_date: typing.Optional[dt.datetime] = OMIT,
+        merchant_metadata: typing.Optional[typing.Dict[str, str]] = OMIT,
+        auto_debit_ot: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[PlanResponse]:
+        """
+        Creates a new subscription plan that serves as a reusable template
+        defining the pricing structure, billing frequency, and payment terms.
+        Plans must be created before subscriptions can be set up.
+
+        Parameters
+        ----------
+        plan_name : str
+            Subscription plan name.
+
+        frequency : CreatePlanRequestFrequency
+            Frequency of recurring transactions for this particular plan.
+
+        amount : SubscriptionAmount
+
+        max_limit_amount : SubscriptionAmount
+
+        end_date : dt.datetime
+            The ISO 8601 UTC Timestamp when the subscription plan expires.
+
+        merchant_plan_reference : str
+            **Idempotency Key.** Unique identifier of the merchant plan reference. Duplicate requests with the same `merchant_plan_reference` will return the existing plan instead of creating a new one.
+
+        plan_description : typing.Optional[str]
+            Corresponding description for a plan.
+
+        initial_debit_amount : typing.Optional[SubscriptionAmount]
+
+        trial_period_in_days : typing.Optional[int]
+            Duration of the trial period in days.
+
+        start_date : typing.Optional[dt.datetime]
+            The ISO 8601 UTC Timestamp when the subscription plan is active and available for use.
+
+        merchant_metadata : typing.Optional[typing.Dict[str, str]]
+            Key-value pairs for additional information. Max 10 pairs, 256 chars each.
+
+        auto_debit_ot : typing.Optional[str]
+            Indicates whether auto-debit is enabled for one-time payments under the subscription plan.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[PlanResponse]
+            Plan created successfully.
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "ps/api/v1/public/plans",
+            method="POST",
+            json={
+                "plan_name": plan_name,
+                "plan_description": plan_description,
+                "frequency": frequency,
+                "amount": convert_and_respect_annotation_metadata(
+                    object_=amount, annotation=SubscriptionAmount, direction="write"
+                ),
+                "max_limit_amount": convert_and_respect_annotation_metadata(
+                    object_=max_limit_amount, annotation=SubscriptionAmount, direction="write"
+                ),
+                "initial_debit_amount": convert_and_respect_annotation_metadata(
+                    object_=initial_debit_amount, annotation=SubscriptionAmount, direction="write"
+                ),
+                "trial_period_in_days": trial_period_in_days,
+                "start_date": start_date,
+                "end_date": end_date,
+                "merchant_metadata": merchant_metadata,
+                "merchant_plan_reference": merchant_plan_reference,
+                "auto_debit_ot": auto_debit_ot,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    PlanResponse,
+                    parse_obj_as(
+                        type_=PlanResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    async def get_plan_by_id(
+        self, plan_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[PlanResponse]:
+        """
+        Retrieves a specific subscription plan by its plan ID.
+
+        Parameters
+        ----------
+        plan_id : str
+            Unique identifier for the subscription plan.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[PlanResponse]
+            Plan retrieved successfully.
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"ps/api/v1/public/plans/{encode_path_param(plan_id)}",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    PlanResponse,
+                    parse_obj_as(
+                        type_=PlanResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    async def delete_plan(
+        self, plan_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[None]:
+        """
+        Deletes a subscription plan by its plan ID.
+
+        Parameters
+        ----------
+        plan_id : str
+            Unique identifier for the subscription plan.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[None]
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"ps/api/v1/public/plans/{encode_path_param(plan_id)}",
+            method="DELETE",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return AsyncHttpResponse(response=_response, data=None)
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    async def update_plan(
+        self,
+        plan_id: str,
+        *,
+        plan_name: typing.Optional[str] = OMIT,
+        plan_description: typing.Optional[str] = OMIT,
+        amount: typing.Optional[SubscriptionAmount] = OMIT,
+        max_limit_amount: typing.Optional[SubscriptionAmount] = OMIT,
+        trial_period_in_days: typing.Optional[int] = OMIT,
+        end_date: typing.Optional[dt.datetime] = OMIT,
+        merchant_metadata: typing.Optional[typing.Dict[str, str]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[PlanResponse]:
+        """
+        Updates an existing subscription plan. Existing subscriptions under
+        this plan will remain unaffected. The changes will apply only to
+        new subscriptions created under this plan.
+
+        Parameters
+        ----------
+        plan_id : str
+            Unique identifier for the subscription plan.
+
+        plan_name : typing.Optional[str]
+            Subscription plan name.
+
+        plan_description : typing.Optional[str]
+            Corresponding description for a plan.
+
+        amount : typing.Optional[SubscriptionAmount]
+
+        max_limit_amount : typing.Optional[SubscriptionAmount]
+
+        trial_period_in_days : typing.Optional[int]
+            Duration of the trial period in days.
+
+        end_date : typing.Optional[dt.datetime]
+            The ISO 8601 UTC Timestamp when the subscription plan expires.
+
+        merchant_metadata : typing.Optional[typing.Dict[str, str]]
+            Key-value pairs for additional information. Max 10 pairs, 256 chars each.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[PlanResponse]
+            Plan updated successfully.
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"ps/api/v1/public/plans/{encode_path_param(plan_id)}",
+            method="PATCH",
+            json={
+                "plan_name": plan_name,
+                "plan_description": plan_description,
+                "amount": convert_and_respect_annotation_metadata(
+                    object_=amount, annotation=SubscriptionAmount, direction="write"
+                ),
+                "max_limit_amount": convert_and_respect_annotation_metadata(
+                    object_=max_limit_amount, annotation=SubscriptionAmount, direction="write"
+                ),
+                "trial_period_in_days": trial_period_in_days,
+                "end_date": end_date,
+                "merchant_metadata": merchant_metadata,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    PlanResponse,
+                    parse_obj_as(
+                        type_=PlanResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    async def get_plan_by_merchant_reference(
+        self, merchant_plan_reference: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[PlanResponse]:
+        """
+        Retrieves a specific subscription plan by the merchant plan reference.
+
+        Parameters
+        ----------
+        merchant_plan_reference : str
+            Unique identifier of the merchant plan reference.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[PlanResponse]
+            Plan retrieved successfully.
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"ps/api/v1/public/plans/reference/{encode_path_param(merchant_plan_reference)}",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    PlanResponse,
+                    parse_obj_as(
+                        type_=PlanResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)