feat: expose users.get_pricing as public SDK method, rewrite _get_pricing

adriangalilea · adriangalilea · commit d5cb29226bde · 2026-02-03T16:03:12.000+01:00
- ProductPrice model for structured pricing data
- nc.users.get_pricing() with action/product_name filters
- Rewrote DomainsAPI._get_pricing (140→35 lines) using self.client.users
- CLI: namecheap-cli account pricing [tld] [--action REGISTER|RENEW|...]
- Normalized action names to uppercase, product names to lowercase
diff --git a/README.md b/README.md
@@ -335,6 +335,18 @@ print(f"{bal.available_balance} {bal.currency}")  # '4932.96 USD'
 print(bal.funds_required_for_auto_renew)          # Decimal('20.16')
 ```
 
+### Pricing
+
+```python
+# Get registration pricing for a specific TLD
+pricing = nc.users.get_pricing("DOMAIN", action="REGISTER", product_name="com")
+for p in pricing["REGISTER"]["com"]:
+    print(f"{p.duration} year: ${p.your_price} (regular: ${p.regular_price})")
+
+# Get all domain pricing (large response — cache it)
+all_pricing = nc.users.get_pricing("DOMAIN")
+```
+
 ### Email Forwarding
 
 ```python
@@ -482,7 +494,7 @@ nc.dns.builder().a("www", "192.0.2.1", ttl=1800)  # Shows as "30 min"
 | `namecheap.domains.*` | ✅ Done | `check`, `list`, `getInfo`, `getContacts`, `getTldList`, `register`, `renew`, `setContacts`, `lock`/`unlock` |
 | `namecheap.domains.dns.*` | ✅ Done | `getHosts`, `setHosts` (builder pattern), `add`, `delete`, `export`, `getList`, `setCustom`, `setDefault`, `getEmailForwarding`, `setEmailForwarding` |
 | `namecheap.whoisguard.*` | ✅ Done | `getList`, `enable`, `disable`, `renew`, `changeEmailAddress` |
-| `namecheap.users.*` | ⚠️ Partial | `getBalances`, `getPricing` (needs debugging). Remaining methods are account management (`changePassword`, `update`, `create`, `login`, `resetPassword`) — only useful if building a reseller platform |
+| `namecheap.users.*` | ⚠️ Partial | `getBalances`, `getPricing`. Remaining methods are account management (`changePassword`, `update`, `create`, `login`, `resetPassword`) — only useful if building a reseller platform |
 | `namecheap.users.address.*` | 🚧 Planned | Saved address book for `domains.register()` — store contacts once, reuse by ID instead of passing full contact info every time |
 | `namecheap.ssl.*` | 🚧 Planned | Full SSL certificate lifecycle — purchase, activate with CSR, renew, revoke, reissue. Complex multi-step workflows with approval emails |
 | `namecheap.domains.transfer.*` | 🚧 Planned | Transfer domains into Namecheap programmatically — initiate, track status, retry |
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [project]
 name = "namecheap-python"
-version = "1.4.0"
+version = "1.5.0"
 description = "A friendly Python SDK for Namecheap API"
 authors = [{name = "Adrian Galilea Delgado", email = "adriangalilea@gmail.com"}]
 readme = "README.md"
diff --git a/src/namecheap/__init__.py b/src/namecheap/__init__.py
@@ -22,11 +22,12 @@
     DomainInfo,
     EmailForward,
     Nameservers,
+    ProductPrice,
     Tld,
     WhoisguardEntry,
 )
 
-__version__ = "1.4.0"
+__version__ = "1.5.0"
 __all__ = [
     "AccountBalance",
     "ConfigurationError",
@@ -40,6 +41,7 @@
     "Namecheap",
     "NamecheapError",
     "Nameservers",
+    "ProductPrice",
     "Tld",
     "ValidationError",
     "WhoisguardEntry",
diff --git a/src/namecheap/_api/domains.py b/src/namecheap/_api/domains.py
@@ -418,153 +418,35 @@ def unlock(self, domain: str) -> bool:
     def _get_pricing(
         self, domains: builtins.list[str]
     ) -> dict[str, dict[str, Decimal | None]]:
-        """
-        Get pricing information for domains.
-
-        Args:
-            domains: List of domain names
+        """Get 1-year registration pricing for a list of domains.
 
-        Returns:
-            Dict mapping domain to pricing info
+        Groups by TLD, fetches pricing via users.get_pricing(), and maps
+        back to individual domain names.
         """
-        pricing = {}
-        logger.debug(f"Getting pricing for domains: {domains}")
+        pricing: dict[str, dict[str, Decimal | None]] = {}
 
-        # Group domains by TLD for efficient API calls
+        # Group domains by TLD
         tld_groups: dict[str, builtins.list[str]] = {}
         for domain in domains:
-            ext = tldextract.extract(domain)
-            tld = ext.suffix
+            tld = tldextract.extract(domain).suffix
             if tld not in tld_groups:
                 tld_groups[tld] = []
             tld_groups[tld].append(domain)
 
-        logger.debug(f"TLD groups: {tld_groups}")
-
-        # Fetch pricing for each TLD group
         for tld, domain_list in tld_groups.items():
-            try:
-                logger.debug(f"Fetching pricing for TLD: {tld}")
-                # Get pricing for this TLD
-                result: Any = self._request(
-                    "namecheap.users.getPricing",
-                    {
-                        "ProductType": "DOMAIN",
-                        "ActionName": "REGISTER",
-                        "ProductName": tld,
-                    },
-                    path="UserGetPricingResult.ProductType",
-                )
-                assert isinstance(result, dict)
-                logger.debug(f"Pricing API response for {tld}: {result}")
-                logger.debug(f"Response type: {type(result)}")
-                logger.debug(
-                    f"Response keys: "
-                    f"{list(result.keys()) if isinstance(result, dict) else 'Not a dict'}"
-                )
-
-                # Extract pricing info
-                if isinstance(result, dict):
-                    logger.debug(f"Parsing pricing response for {tld}")
-
-                    # Get ProductCategory (could be a list or single dict)
-                    categories = result.get("ProductCategory", {})
-                    if not isinstance(categories, list):
-                        categories = [categories] if categories else []
-
-                    logger.debug(f"Found {len(categories)} categories")
-
-                    # Look for REGISTER category
-                    for category in categories:
-                        if not isinstance(category, dict):
-                            continue
-
-                        # Use normalized name for consistent access
-                        category_name = category.get("@Name", "")
-                        category_name_normalized = category.get(
-                            "@Name_normalized", category_name.lower()
-                        )
-                        logger.debug(
-                            f"Checking category: {category_name} "
-                            f"(normalized: {category_name_normalized})"
-                        )
-
-                        if category_name_normalized == "register":
-                            # Get products in this category
-                            products = category.get("Product", {})
-                            if not isinstance(products, list):
-                                products = [products] if products else []
-
-                            logger.debug(
-                                f"Found {len(products)} products in REGISTER category"
-                            )
-
-                            # Find the product matching our TLD
-                            for product in products:
-                                if not isinstance(product, dict):
-                                    continue
-
-                                product_name = product.get("@Name", "")
-                                logger.debug(
-                                    f"Checking product: {product_name} vs {tld}"
-                                )
-
-                                if product_name.lower() == tld.lower():
-                                    # Get price list
-                                    price_info = product.get("Price", [])
-                                    if not isinstance(price_info, list):
-                                        price_info = [price_info] if price_info else []
-
-                                    logger.debug(
-                                        f"Found {len(price_info)} price entries for {tld}"
-                                    )
-
-                                    # Find 1 year price
-                                    for price in price_info:
-                                        if not isinstance(price, dict):
-                                            continue
-
-                                        duration = price.get("@Duration", "")
-                                        if duration == "1":
-                                            regular_price = price.get("@RegularPrice")
-                                            your_price = price.get("@YourPrice")
-                                            retail_price = price.get("@RetailPrice")
-
-                                            # Get additional cost
-                                            # (normalization handles their typo)
-                                            price.get("@YourAdditionalCost", "0")
-
-                                            logger.debug(
-                                                f"Found prices for {tld}: "
-                                                f"regular={regular_price}, "
-                                                f"your={your_price}, "
-                                                f"retail={retail_price}"
-                                            )
-
-                                            # Apply to all domains with this TLD
-                                            for domain in domain_list:
-                                                pricing[domain] = {
-                                                    "regular_price": Decimal(
-                                                        regular_price
-                                                    )
-                                                    if regular_price
-                                                    else None,
-                                                    "your_price": Decimal(your_price)
-                                                    if your_price
-                                                    else None,
-                                                    "retail_price": Decimal(
-                                                        retail_price
-                                                    )
-                                                    if retail_price
-                                                    else None,
-                                                }
-                                            break
-                                    break
-                            break
-
-            except Exception as e:
-                # If pricing fails, continue without it
-                logger.error(f"Failed to get pricing for TLD {tld}: {e}")
-                logger.debug("Full error:", exc_info=True)
+            result = self.client.users.get_pricing(
+                "DOMAIN", action="REGISTER", product_name=tld
+            )
+            prices = result.get("REGISTER", {}).get(tld, [])
+
+            for p in prices:
+                if p.duration == 1:
+                    for domain in domain_list:
+                        pricing[domain] = {
+                            "regular_price": p.regular_price,
+                            "your_price": p.your_price,
+                            "retail_price": None,
+                        }
+                    break
 
         return pricing
diff --git a/src/namecheap/_api/users.py b/src/namecheap/_api/users.py
@@ -2,9 +2,9 @@
 
 from __future__ import annotations
 
-from typing import Any
+from typing import Any, Literal
 
-from namecheap.models import AccountBalance
+from namecheap.models import AccountBalance, ProductPrice
 
 from .base import BaseAPI
 
@@ -30,3 +30,73 @@ def get_balances(self) -> AccountBalance:
 
         assert result, "API returned empty result for getBalances"
         return AccountBalance.model_validate(result)
+
+    def get_pricing(
+        self,
+        product_type: Literal["DOMAIN", "SSLCERTIFICATE"] = "DOMAIN",
+        *,
+        action: str | None = None,
+        product_name: str | None = None,
+    ) -> dict[str, dict[str, list[ProductPrice]]]:
+        """
+        Get pricing for products.
+
+        Returns a nested dict: {action: {product: [prices]}}.
+        For example: {"REGISTER": {"com": [ProductPrice(duration=1, ...), ...]}}
+
+        NOTE: Cache this response — Namecheap recommends it.
+
+        Args:
+            product_type: "DOMAIN" or "SSLCERTIFICATE"
+            action: Filter by action (REGISTER, RENEW, TRANSFER, REACTIVATE)
+            product_name: Filter by product/TLD name (e.g., "com")
+
+        Returns:
+            Nested dict of action -> product -> list of ProductPrice
+
+        Examples:
+            >>> pricing = nc.users.get_pricing("DOMAIN", action="REGISTER", product_name="com")
+            >>> prices = pricing["REGISTER"]["com"]
+            >>> print(f"1-year .com: ${prices[0].your_price}")
+        """
+        params: dict[str, Any] = {"ProductType": product_type}
+        if action:
+            params["ActionName"] = action
+        if product_name:
+            params["ProductName"] = product_name
+
+        result: Any = self._request(
+            "namecheap.users.getPricing",
+            params,
+            path="UserGetPricingResult.ProductType",
+        )
+
+        assert result, "API returned empty result for getPricing"
+
+        pricing: dict[str, dict[str, list[ProductPrice]]] = {}
+
+        categories = result.get("ProductCategory", [])
+        if isinstance(categories, dict):
+            categories = [categories]
+
+        for category in categories:
+            action_name = category.get("@Name", "").upper()
+
+            products = category.get("Product", [])
+            if isinstance(products, dict):
+                products = [products]
+
+            for product in products:
+                name = product.get("@Name", "").lower()
+
+                prices = product.get("Price", [])
+                if isinstance(prices, dict):
+                    prices = [prices]
+
+                parsed = [ProductPrice.model_validate(p) for p in prices]
+
+                if action_name not in pricing:
+                    pricing[action_name] = {}
+                pricing[action_name][name] = parsed
+
+        return pricing
diff --git a/src/namecheap/models.py b/src/namecheap/models.py
@@ -423,6 +423,34 @@ def parse_id(cls, v: Any) -> int:
         return int(v) if v else 0
 
 
+class ProductPrice(BaseModel):
+    """A single price entry for a product at a specific duration."""
+
+    duration: int = Field(alias="@Duration")
+    duration_type: str = Field(alias="@DurationType", default="YEAR")
+    price: Decimal = Field(alias="@Price")
+    regular_price: Decimal = Field(alias="@RegularPrice")
+    your_price: Decimal = Field(alias="@YourPrice")
+    coupon_price: Decimal | None = Field(alias="@CouponPrice", default=None)
+    currency: str = Field(alias="@Currency", default="USD")
+
+    model_config = ConfigDict(populate_by_name=True)
+
+    @field_validator(
+        "price", "regular_price", "your_price", "coupon_price", mode="before"
+    )
+    @classmethod
+    def parse_decimal(cls, v: Any) -> Decimal | None:
+        if v is None or v == "":
+            return None
+        return Decimal(str(v))
+
+    @field_validator("duration", mode="before")
+    @classmethod
+    def parse_duration(cls, v: Any) -> int:
+        return int(v) if v else 1
+
+
 class Config(BaseModel):
     """Client configuration with validation."""
 
diff --git a/src/namecheap_cli/__main__.py b/src/namecheap_cli/__main__.py
diff --git a/uv.lock b/uv.lock
