feat: add checkout endpoint

Author: justanotherbyte

autumn/aio/client.py

@@ -10,7 +10,7 @@
 
 if TYPE_CHECKING:
     from typing_extensions import Self
-    from .shed import AttachParams, CheckParams, TrackParams
+    from .shed import AttachParams, CheckParams, TrackParams, CheckoutParams
 
 __all__ = ("AsyncClient",)
 
@@ -42,6 +42,7 @@ class AsyncClient(Client):
     attach: AttachParams  # type: ignore
     check: CheckParams  # type: ignore
     track: TrackParams  # type: ignore
+    checkout: CheckoutParams # type: ignore
 
     def __init__(self, token: str, *, base_url: Optional[str] = None):
         from .. import BASE_URL, VERSION

autumn/aio/shed.py

@@ -12,6 +12,7 @@
         AttachResponse,
         CheckResponse,
         TrackResponse,
+        CheckoutResponse,
     )
 
 
@@ -63,3 +64,13 @@ def __call__(
         properties: Optional[Dict[str, Any]] = None,
         customer_data: Optional[CustomerData] = None,
     ) -> Awaitable[TrackResponse]: ...
+
+
+class CheckoutParams(Protocol):
+    def __call__(
+        self,
+        customer_id: str,
+        product_id: str,
+        *,
+        success_url: Optional[str] = None,
+    ) -> Awaitable[CheckoutResponse]: ...

autumn/asgi/app.py

@@ -24,6 +24,7 @@
     check_route,
     track_route,
     cancel_route,
+    checkout_route,
     billing_portal_route,
 )
 from .routes.customers import create_customer_route, pricing_table_route
@@ -80,6 +81,7 @@ def __init__(
                     billing_portal_route,
                     methods={"POST"},
                 ),
+                Route("/checkout/", checkout_route, methods={"POST"}),
                 Route(
                     "/customers/", create_customer_route, methods={"POST", "OPTIONS"}
                 ),

autumn/asgi/routes/core.py

@@ -51,3 +51,11 @@ async def billing_portal_route(request: Request):
     customer_id = identify["customer_id"]
     response = await autumn.customers.get_billing_portal(customer_id, **json)
     return _build_response(response)
+
+
+async def checkout_route(request: Request):
+    identify, autumn, json = await _extract(request)
+
+    customer_id = identify["customer_id"]
+    response = await autumn.checkout(customer_id, **json)
+    return _build_response(response)

autumn/client.py

@@ -10,6 +10,7 @@
 from .models.response import (
     AttachResponse,
     CheckResponse,
+    CheckoutResponse,
     TrackResponse,
 )
 
@@ -237,3 +238,13 @@ def track(
         """
         payload = _build_payload(locals(), self.track)
         return self.http.request("POST", "/track", TrackResponse, json=payload)
+
+    def checkout(
+        self,
+        customer_id: str,
+        product_id: str,
+        *,
+        success_url: Optional[str] = None,
+    ) -> CheckoutResponse:
+        payload = _build_payload(locals(), self.checkout)
+        return self.http.request("POST", "/checkout", CheckoutResponse, json=payload)

autumn/models/meta.py

@@ -5,6 +5,8 @@
 
 from pydantic import BaseModel
 
+from .products import ProductItem
+
 if TYPE_CHECKING:
     from typing import Dict, Any
 
@@ -31,3 +33,14 @@ class CustomerData(BaseModel):
     name: Optional[str] = None
     email: Optional[str] = None
     fingerprint: Optional[str] = None
+
+
+class CheckoutLine(BaseModel):
+    description: str
+    amount: int
+    item: ProductItem
+
+
+class Cycle(BaseModel):
+    starts_at: int
+    total: int

autumn/models/products.py

@@ -66,14 +66,14 @@ class FreeTrial(BaseModel):
 
 
 class Product(BaseModel):
-    autumn_id: str
+    autumn_id: Optional[str] = None
     created_at: float
     id: str
     name: str
     env: Literal["sandbox", "live"]
     is_add_on: bool
     is_default: bool
-    group: str
+    group: Optional[str] = None
     version: float
     items: List[ProductItem]
     free_trial: Optional[FreeTrial] = None

autumn/models/response.py

@@ -2,8 +2,8 @@
 
 from pydantic import BaseModel
 
-from .meta import AppEnv
-from .products import ProductItem, FreeTrial
+from .meta import AppEnv, CheckoutLine, AttachOption, Cycle
+from .products import ProductItem, FreeTrial, Product
 from .customers import PricingTableProduct
 from .features import FeaturePreview
 from .products import ProductPreview
@@ -46,6 +46,19 @@ class UsageResponse(BaseModel):
     feature_id: str
 
 
+class CheckoutResponse(BaseModel):
+    url: Optional[str] = None
+    customer_id: str
+    has_prorations: bool
+    total: float
+    currency: str
+    lines: List[CheckoutLine]
+    options: List[AttachOption]
+    product: Product
+    current_product: Optional[Product] = None
+    next_cycle: Optional[Cycle] = None
+
+
 class BillingPortalResponse(BaseModel):
     url: str
     customer_id: str

pyproject.toml

@@ -34,15 +34,12 @@ docs = [
     "sphinx-autodoc-typehints>=2.3.0",
     "sphinx-tabs>=3.4.7",
 ]
-tests = [
-    "pytest>=8.4.1",
-    "pytest-asyncio>=1.1.0",
-    "pytest-cov>=6.2.1",
-]
+tests = ["pytest>=8.4.1", "pytest-asyncio>=1.1.0", "pytest-cov>=6.2.1"]
 dev = ["litestar>=2.16.0", "uvicorn>=0.34.3"]
 
 [tool.pytest.ini_options]
 pythonpath = ["."]
+asyncio_mode = "auto"
 
 [tool.pyright]
 typeCheckingMode = "standard"

tests/test_sandbox.py

@@ -25,7 +25,6 @@ async def test_customers(autumn: Autumn):
 
     updated_customer = await autumn.customers.get(customer.id) # type: ignore
     assert updated_customer.name == "ay-rod"
-
     await autumn.customers.get_billing_portal(customer.id) # type: ignore
 
     await autumn.customers.delete(customer.id) # type: ignore
@@ -53,3 +52,22 @@ async def test_products(autumn: Autumn):
 
     await autumn.products.delete(default.id) # type: ignore
     await autumn.products.delete(add_on.id) # type: ignore
+
+@pytest.mark.asyncio
+async def test_checkout(autumn: Autumn):
+    customer = await autumn.customers.create(
+        "test_customer_id",
+        name="John Yeo",
+        email="[email protected]"
+    )
+    product = await autumn.products.create(
+        "test_product_id",
+        name="Test Product",
+        is_add_on=False,
+        is_default=False,
+    )
+
+    await autumn.checkout(customer.id, product.id) # type: ignore
+
+    await autumn.customers.delete(customer.id) # type: ignore
+    await autumn.products.delete(product.id) # type: ignore