paid-python 1.5.0__tar.gz → 1.7.0__tar.gz

{paid_python-1.5.0 → paid_python-1.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: paid-python
-Version: 1.5.0
+Version: 1.7.0
 Summary: 
 Requires-Python: >=3.10,<3.14
 Classifier: Intended Audience :: Developers
@@ -651,6 +651,7 @@ signal = Signal(
                 "gen_ai.usage.input_tokens": 100,
                 "gen_ai.usage.output_tokens": 300,
                 "gen_ai.usage.cached_input_tokens": 600,
+                "gen_ai.usage.cache_creation_input_tokens": 200,
             },
         }
     }
@@ -680,6 +681,7 @@ def do_work():
                     "gen_ai.usage.input_tokens": 100,
                     "gen_ai.usage.output_tokens": 300,
                     "gen_ai.usage.cached_input_tokens": 600,
+                    "gen_ai.usage.cache_creation_input_tokens": 200,
                 },
             }
         }

{paid_python-1.5.0 → paid_python-1.7.0}/README.md

@@ -613,6 +613,7 @@ signal = Signal(
                 "gen_ai.usage.input_tokens": 100,
                 "gen_ai.usage.output_tokens": 300,
                 "gen_ai.usage.cached_input_tokens": 600,
+                "gen_ai.usage.cache_creation_input_tokens": 200,
             },
         }
     }
@@ -642,6 +643,7 @@ def do_work():
                     "gen_ai.usage.input_tokens": 100,
                     "gen_ai.usage.output_tokens": 300,
                     "gen_ai.usage.cached_input_tokens": 600,
+                    "gen_ai.usage.cache_creation_input_tokens": 200,
                 },
             }
         }

{paid_python-1.5.0 → paid_python-1.7.0}/pyproject.toml

@@ -4,7 +4,7 @@ dynamic = ["version"]
 
 [tool.poetry]
 name = "paid-python"
-version = "1.5.0"
+version = "1.7.0"
 description = ""
 readme = "README.md"
 authors = []
@@ -64,7 +64,7 @@ claude-agent-sdk = ">=0.1.0,<0.1.49"
 google-genai = ">=1.19.0"
 instructor = ">=1.0.0"
 langchain-core = ">=0.1.0"
-mistralai = ">=1.9.0,<2.0.0"
+mistralai = ">=1.9.0 <2.0.0"
 openai = ">=1.12.0"
 openai-agents = ">=0.2.0"
 pydantic-ai = ">=1.41.0"

{paid_python-1.5.0 → paid_python-1.7.0}/src/paid/__init__.py

@@ -19,7 +19,26 @@ if typing.TYPE_CHECKING:
         ContactListResponse,
         ContactRolesItem,
         CreateOrderLineAttributeRequest,
+        CreateOrderLineAttributeRequestPricing,
+        CreateOrderLineAttributeRequestPricingBillingFrequency,
+        CreateOrderLineAttributeRequestPricingBillingType,
+        CreateOrderLineAttributeRequestPricingChargeType,
+        CreateOrderLineAttributeRequestPricingCreditBenefitsItem,
+        CreateOrderLineAttributeRequestPricingCreditBenefitsItemAllocationCadence,
+        CreateOrderLineAttributeRequestPricingCreditBenefitsItemCreditGrantTiming,
+        CreateOrderLineAttributeRequestPricingCreditBenefitsItemRecipient,
+        CreateOrderLineAttributeRequestPricingCreditBenefitsItemRolloverDurationUnit,
+        CreateOrderLineAttributeRequestPricingPricePoints,
+        CreateOrderLineAttributeRequestPricingPricePointsTiersItem,
+        CreateOrderLineAttributeRequestPricingPricePointsTiersItemTierBillingType,
+        CreateOrderLineAttributeRequestPricingPricingModel,
+        CreateOrderLineAttributeRequestPricingSignalType,
         CreateOrderLineRequest,
+        CreditBalance,
+        CreditBalanceListResponse,
+        CreditBalanceRecipient,
+        CreditCurrency,
+        CreditCurrencyListResponse,
         Customer,
         CustomerAttribution,
         CustomerBillingAddress,
@@ -27,6 +46,8 @@ if typing.TYPE_CHECKING:
         CustomerById,
         CustomerCreationState,
         CustomerListResponse,
+        CustomerPortal,
+        CustomerPortalStatus,
         EmptyResponse,
         ErrorResponse,
         Invoice,
@@ -55,7 +76,7 @@ if typing.TYPE_CHECKING:
         UpdateProductRequest,
     )
     from .errors import BadRequestError, ForbiddenError, InternalServerError, NotFoundError
-    from . import checkouts, contacts, customers, invoices, orders, products, signals
+    from . import checkouts, contacts, credits, customer_portals, customers, invoices, orders, products, signals
     from .checkouts import ListCheckoutsRequestStatus
     from .client import AsyncPaid, Paid
     from .contacts import CreateContactRequestRolesItem
@@ -77,7 +98,26 @@ _dynamic_imports: typing.Dict[str, str] = {
     "ContactRolesItem": ".types",
     "CreateContactRequestRolesItem": ".contacts",
     "CreateOrderLineAttributeRequest": ".types",
+    "CreateOrderLineAttributeRequestPricing": ".types",
+    "CreateOrderLineAttributeRequestPricingBillingFrequency": ".types",
+    "CreateOrderLineAttributeRequestPricingBillingType": ".types",
+    "CreateOrderLineAttributeRequestPricingChargeType": ".types",
+    "CreateOrderLineAttributeRequestPricingCreditBenefitsItem": ".types",
+    "CreateOrderLineAttributeRequestPricingCreditBenefitsItemAllocationCadence": ".types",
+    "CreateOrderLineAttributeRequestPricingCreditBenefitsItemCreditGrantTiming": ".types",
+    "CreateOrderLineAttributeRequestPricingCreditBenefitsItemRecipient": ".types",
+    "CreateOrderLineAttributeRequestPricingCreditBenefitsItemRolloverDurationUnit": ".types",
+    "CreateOrderLineAttributeRequestPricingPricePoints": ".types",
+    "CreateOrderLineAttributeRequestPricingPricePointsTiersItem": ".types",
+    "CreateOrderLineAttributeRequestPricingPricePointsTiersItemTierBillingType": ".types",
+    "CreateOrderLineAttributeRequestPricingPricingModel": ".types",
+    "CreateOrderLineAttributeRequestPricingSignalType": ".types",
     "CreateOrderLineRequest": ".types",
+    "CreditBalance": ".types",
+    "CreditBalanceListResponse": ".types",
+    "CreditBalanceRecipient": ".types",
+    "CreditCurrency": ".types",
+    "CreditCurrencyListResponse": ".types",
     "Customer": ".types",
     "CustomerAttribution": ".types",
     "CustomerBillingAddress": ".types",
@@ -85,6 +125,8 @@ _dynamic_imports: typing.Dict[str, str] = {
     "CustomerById": ".types",
     "CustomerCreationState": ".types",
     "CustomerListResponse": ".types",
+    "CustomerPortal": ".types",
+    "CustomerPortalStatus": ".types",
     "EmptyResponse": ".types",
     "ErrorResponse": ".types",
     "ForbiddenError": ".errors",
@@ -120,6 +162,8 @@ _dynamic_imports: typing.Dict[str, str] = {
     "__version__": ".version",
     "checkouts": ".checkouts",
     "contacts": ".contacts",
+    "credits": ".credits",
+    "customer_portals": ".customer_portals",
     "customers": ".customers",
     "invoices": ".invoices",
     "orders": ".orders",
@@ -165,7 +209,26 @@ __all__ = [
     "ContactRolesItem",
     "CreateContactRequestRolesItem",
     "CreateOrderLineAttributeRequest",
+    "CreateOrderLineAttributeRequestPricing",
+    "CreateOrderLineAttributeRequestPricingBillingFrequency",
+    "CreateOrderLineAttributeRequestPricingBillingType",
+    "CreateOrderLineAttributeRequestPricingChargeType",
+    "CreateOrderLineAttributeRequestPricingCreditBenefitsItem",
+    "CreateOrderLineAttributeRequestPricingCreditBenefitsItemAllocationCadence",
+    "CreateOrderLineAttributeRequestPricingCreditBenefitsItemCreditGrantTiming",
+    "CreateOrderLineAttributeRequestPricingCreditBenefitsItemRecipient",
+    "CreateOrderLineAttributeRequestPricingCreditBenefitsItemRolloverDurationUnit",
+    "CreateOrderLineAttributeRequestPricingPricePoints",
+    "CreateOrderLineAttributeRequestPricingPricePointsTiersItem",
+    "CreateOrderLineAttributeRequestPricingPricePointsTiersItemTierBillingType",
+    "CreateOrderLineAttributeRequestPricingPricingModel",
+    "CreateOrderLineAttributeRequestPricingSignalType",
     "CreateOrderLineRequest",
+    "CreditBalance",
+    "CreditBalanceListResponse",
+    "CreditBalanceRecipient",
+    "CreditCurrency",
+    "CreditCurrencyListResponse",
     "Customer",
     "CustomerAttribution",
     "CustomerBillingAddress",
@@ -173,6 +236,8 @@ __all__ = [
     "CustomerById",
     "CustomerCreationState",
     "CustomerListResponse",
+    "CustomerPortal",
+    "CustomerPortalStatus",
     "EmptyResponse",
     "ErrorResponse",
     "ForbiddenError",
@@ -208,6 +273,8 @@ __all__ = [
     "__version__",
     "checkouts",
     "contacts",
+    "credits",
+    "customer_portals",
     "customers",
     "invoices",
     "orders",

{paid_python-1.5.0 → paid_python-1.7.0}/src/paid/client.py

@@ -11,6 +11,8 @@ from .environment import PaidEnvironment
 if typing.TYPE_CHECKING:
     from .checkouts.client import AsyncCheckoutsClient, CheckoutsClient
     from .contacts.client import AsyncContactsClient, ContactsClient
+    from .credits.client import AsyncCreditsClient, CreditsClient
+    from .customer_portals.client import AsyncCustomerPortalsClient, CustomerPortalsClient
     from .customers.client import AsyncCustomersClient, CustomersClient
     from .invoices.client import AsyncInvoicesClient, InvoicesClient
     from .orders.client import AsyncOrdersClient, OrdersClient
@@ -89,7 +91,9 @@ class Paid:
         self._orders: typing.Optional[OrdersClient] = None
         self._invoices: typing.Optional[InvoicesClient] = None
         self._signals: typing.Optional[SignalsClient] = None
+        self._credits: typing.Optional[CreditsClient] = None
         self._checkouts: typing.Optional[CheckoutsClient] = None
+        self._customer_portals: typing.Optional[CustomerPortalsClient] = None
 
     @property
     def products(self):
@@ -139,6 +143,14 @@ class Paid:
             self._signals = SignalsClient(client_wrapper=self._client_wrapper)
         return self._signals
 
+    @property
+    def credits(self):
+        if self._credits is None:
+            from .credits.client import CreditsClient  # noqa: E402
+
+            self._credits = CreditsClient(client_wrapper=self._client_wrapper)
+        return self._credits
+
     @property
     def checkouts(self):
         if self._checkouts is None:
@@ -147,6 +159,14 @@ class Paid:
             self._checkouts = CheckoutsClient(client_wrapper=self._client_wrapper)
         return self._checkouts
 
+    @property
+    def customer_portals(self):
+        if self._customer_portals is None:
+            from .customer_portals.client import CustomerPortalsClient  # noqa: E402
+
+            self._customer_portals = CustomerPortalsClient(client_wrapper=self._client_wrapper)
+        return self._customer_portals
+
 
 class AsyncPaid:
     """
@@ -219,7 +239,9 @@ class AsyncPaid:
         self._orders: typing.Optional[AsyncOrdersClient] = None
         self._invoices: typing.Optional[AsyncInvoicesClient] = None
         self._signals: typing.Optional[AsyncSignalsClient] = None
+        self._credits: typing.Optional[AsyncCreditsClient] = None
         self._checkouts: typing.Optional[AsyncCheckoutsClient] = None
+        self._customer_portals: typing.Optional[AsyncCustomerPortalsClient] = None
 
     @property
     def products(self):
@@ -269,6 +291,14 @@ class AsyncPaid:
             self._signals = AsyncSignalsClient(client_wrapper=self._client_wrapper)
         return self._signals
 
+    @property
+    def credits(self):
+        if self._credits is None:
+            from .credits.client import AsyncCreditsClient  # noqa: E402
+
+            self._credits = AsyncCreditsClient(client_wrapper=self._client_wrapper)
+        return self._credits
+
     @property
     def checkouts(self):
         if self._checkouts is None:
@@ -277,6 +307,14 @@ class AsyncPaid:
             self._checkouts = AsyncCheckoutsClient(client_wrapper=self._client_wrapper)
         return self._checkouts
 
+    @property
+    def customer_portals(self):
+        if self._customer_portals is None:
+            from .customer_portals.client import AsyncCustomerPortalsClient  # noqa: E402
+
+            self._customer_portals = AsyncCustomerPortalsClient(client_wrapper=self._client_wrapper)
+        return self._customer_portals
+
 
 def _get_base_url(*, base_url: typing.Optional[str] = None, environment: PaidEnvironment) -> str:
     if base_url is not None:

{paid_python-1.5.0 → paid_python-1.7.0}/src/paid/core/client_wrapper.py

@@ -24,12 +24,12 @@ class BaseClientWrapper:
         import platform
 
         headers: typing.Dict[str, str] = {
-            "User-Agent": "paid-python/1.5.0",
+            "User-Agent": "paid-python/1.7.0",
             "X-Fern-Language": "Python",
             "X-Fern-Runtime": f"python/{platform.python_version()}",
             "X-Fern-Platform": f"{platform.system().lower()}/{platform.release()}",
             "X-Fern-SDK-Name": "paid-python",
-            "X-Fern-SDK-Version": "1.5.0",
+            "X-Fern-SDK-Version": "1.7.0",
             **(self.get_custom_headers() or {}),
         }
         headers["Authorization"] = f"Bearer {self._get_token()}"

paid_python-1.7.0/src/paid/credits/client.py

@@ -0,0 +1,104 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.request_options import RequestOptions
+from ..types.credit_currency_list_response import CreditCurrencyListResponse
+from .raw_client import AsyncRawCreditsClient, RawCreditsClient
+
+
+class CreditsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawCreditsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawCreditsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawCreditsClient
+        """
+        return self._raw_client
+
+    def list_credit_currencies(
+        self, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> CreditCurrencyListResponse:
+        """
+        List credit currencies for the organization
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreditCurrencyListResponse
+            200
+
+        Examples
+        --------
+        from paid import Paid
+
+        client = Paid(
+            token="YOUR_TOKEN",
+        )
+        client.credits.list_credit_currencies()
+        """
+        _response = self._raw_client.list_credit_currencies(request_options=request_options)
+        return _response.data
+
+
+class AsyncCreditsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawCreditsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawCreditsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawCreditsClient
+        """
+        return self._raw_client
+
+    async def list_credit_currencies(
+        self, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> CreditCurrencyListResponse:
+        """
+        List credit currencies for the organization
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreditCurrencyListResponse
+            200
+
+        Examples
+        --------
+        import asyncio
+
+        from paid import AsyncPaid
+
+        client = AsyncPaid(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.credits.list_credit_currencies()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.list_credit_currencies(request_options=request_options)
+        return _response.data

paid_python-1.7.0/src/paid/credits/raw_client.py

@@ -0,0 +1,140 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from json.decoder import JSONDecodeError
+
+from ..core.api_error import ApiError
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.http_response import AsyncHttpResponse, HttpResponse
+from ..core.pydantic_utilities import parse_obj_as
+from ..core.request_options import RequestOptions
+from ..errors.forbidden_error import ForbiddenError
+from ..errors.internal_server_error import InternalServerError
+from ..types.credit_currency_list_response import CreditCurrencyListResponse
+from ..types.error_response import ErrorResponse
+
+
+class RawCreditsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def list_credit_currencies(
+        self, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[CreditCurrencyListResponse]:
+        """
+        List credit currencies for the organization
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[CreditCurrencyListResponse]
+            200
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "credits/currencies",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    CreditCurrencyListResponse,
+                    parse_obj_as(
+                        type_=CreditCurrencyListResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    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)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+
+class AsyncRawCreditsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def list_credit_currencies(
+        self, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[CreditCurrencyListResponse]:
+        """
+        List credit currencies for the organization
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[CreditCurrencyListResponse]
+            200
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "credits/currencies",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    CreditCurrencyListResponse,
+                    parse_obj_as(
+                        type_=CreditCurrencyListResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    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)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)

paid_python-1.7.0/src/paid/customer_portals/client.py

@@ -0,0 +1,152 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.request_options import RequestOptions
+from ..types.customer_portal import CustomerPortal
+from .raw_client import AsyncRawCustomerPortalsClient, RawCustomerPortalsClient
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class CustomerPortalsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawCustomerPortalsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawCustomerPortalsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawCustomerPortalsClient
+        """
+        return self._raw_client
+
+    def create_customer_portal(
+        self,
+        *,
+        customer_id: typing.Optional[str] = OMIT,
+        external_customer_id: typing.Optional[str] = OMIT,
+        return_url: typing.Optional[str] = OMIT,
+        expires_at: typing.Optional[dt.datetime] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CustomerPortal:
+        """
+        Creates a portal session for the customer. Returns a short-lived URL to the customer portal.
+
+        Parameters
+        ----------
+        customer_id : typing.Optional[str]
+            The Paid customer ID (display ID or UUID). Either this or externalCustomerId must be provided.
+
+        external_customer_id : typing.Optional[str]
+            Your external customer ID. Either this or customerId must be provided.
+
+        return_url : typing.Optional[str]
+
+        expires_at : typing.Optional[dt.datetime]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CustomerPortal
+            201
+
+        Examples
+        --------
+        from paid import Paid
+
+        client = Paid(
+            token="YOUR_TOKEN",
+        )
+        client.customer_portals.create_customer_portal()
+        """
+        _response = self._raw_client.create_customer_portal(
+            customer_id=customer_id,
+            external_customer_id=external_customer_id,
+            return_url=return_url,
+            expires_at=expires_at,
+            request_options=request_options,
+        )
+        return _response.data
+
+
+class AsyncCustomerPortalsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawCustomerPortalsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawCustomerPortalsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawCustomerPortalsClient
+        """
+        return self._raw_client
+
+    async def create_customer_portal(
+        self,
+        *,
+        customer_id: typing.Optional[str] = OMIT,
+        external_customer_id: typing.Optional[str] = OMIT,
+        return_url: typing.Optional[str] = OMIT,
+        expires_at: typing.Optional[dt.datetime] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CustomerPortal:
+        """
+        Creates a portal session for the customer. Returns a short-lived URL to the customer portal.
+
+        Parameters
+        ----------
+        customer_id : typing.Optional[str]
+            The Paid customer ID (display ID or UUID). Either this or externalCustomerId must be provided.
+
+        external_customer_id : typing.Optional[str]
+            Your external customer ID. Either this or customerId must be provided.
+
+        return_url : typing.Optional[str]
+
+        expires_at : typing.Optional[dt.datetime]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CustomerPortal
+            201
+
+        Examples
+        --------
+        import asyncio
+
+        from paid import AsyncPaid
+
+        client = AsyncPaid(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.customer_portals.create_customer_portal()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create_customer_portal(
+            customer_id=customer_id,
+            external_customer_id=external_customer_id,
+            return_url=return_url,
+            expires_at=expires_at,
+            request_options=request_options,
+        )
+        return _response.data