===========================================
Async Plan Module
===========================================

This wrapper class facilitates asynchronous integration with Paystack Plans API.
The Plans API allows you to create and manage installment payment options on your integration.

---------

.. py:class:: AsyncPlanClientAPI(secret_key: str = None)

    Paystack Plan API Reference: `Plans`_

    .. py:method:: async create_plan(name: str, amount: int, interval: str, currency: str, invoice_limit: int, send_invoices: bool, send_sms: bool, description: str | None = None)→ PayStackResponse

        Create a plan

        :param name: The name of the plan
        :type name: str
        :param amount: The amount of the plan
        :type amount: int
        :param interval: The interval of the plan
        :type interval: str
        :param currency: The currency of the plan
        :type currency: str
        :param invoice_limit: The invoice limit of the plan
        :type invoice_limit: int
        :param send_invoices: Whether or not to send invoices
        :type send_invoices: bool
        :param send_sms: Whether or not to send SMS
        :type send_sms: bool
        :param description: The description of the plan
        :type description: str, optional

        :return: The response from the API
        :rtype: PayStackResponse object

    .. py:method:: async fetch_plan(id_or_code: str)→ PayStackResponse

        Fetch a plan

        :param id_or_code: The id or code of the plan
        :type id_or_code: str

        :return: The response from the API
        :rtype: PayStackResponse object

    .. py:method:: async list_plans(per_page: int | None = 50, page: int | None = 1, status: str | None = None, interval: str | None = None, amount: int | None = None)→ PayStackResponse

        List plans

        :param per_page: The number of plans per page
        :type per_page: int, optional
        :param page: The page number
        :type page: int, optional
        :param status:  Filter list by plans with specified status
        :type status: str, optional
        :param interval: Filter list by plans with specified interval
        :type interval: str, optional
        :param amount: The amount of the plans
        :type amount: int, optional

        :return: The response from the API
        :rtype: PayStackResponse object

    .. py:method:: async update_plan(id_or_code: str, name: str, amount: int, interval: str, send_invoices: bool, send_sms: bool, currency: str, invoice_limit: int, description: str | None = None)→ PayStackResponse

        Update a plan

        :param id_or_code: The id or code of the plan
        :type id_or_code: str
        :param name: The name of the plan
        :type name: str
        :param amount: The amount of the plan
        :type amount: int
        :param interval: The interval of the plan.
        :type interval: str
        :param send_invoices: Whether or not to send invoices
        :type send_invoices: bool
        :param send_sms: Whether or not to send SMS
        :type send_sms: bool
        :param currency: The currency of the plan
        :type currency: str
        :param invoice_limit: The invoice limit of the plan
        :type invoice_limit: int
        :param description: The description of the plan
        :type description: str, optional

        :return: The response from the API
        :rtype: PayStackResponse object


You can use the tool kit in the helpers module as reference to get the string value of the Interval enum class to pass into the ``interval`` parameter :doc:`toolkit`

.. _Plans: https://paystack.com/docs/api/plan/