paid-python 1.12.0__tar.gz → 2.0.0__tar.gz

paid_python-2.0.0/PKG-INFO

@@ -0,0 +1,792 @@
+Metadata-Version: 2.1
+Name: paid-python
+Version: 2.0.0
+Summary: 
+Requires-Python: >=3.10,<3.14
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: OS Independent
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Dist: httpx (>=0.21.2)
+Requires-Dist: mutagen (>=1.47.0)
+Requires-Dist: openinference-instrumentation-anthropic (>=0.1.20,<1.0.0)
+Requires-Dist: openinference-instrumentation-bedrock (>=0.1.0)
+Requires-Dist: openinference-instrumentation-claude-agent-sdk (>=0.1.0)
+Requires-Dist: openinference-instrumentation-google-genai (>=0.1.8)
+Requires-Dist: openinference-instrumentation-instructor (>=0.1.0)
+Requires-Dist: openinference-instrumentation-langchain (>=0.1.55)
+Requires-Dist: openinference-instrumentation-openai (>=0.1.40)
+Requires-Dist: openinference-instrumentation-openai-agents (>=1.0.0)
+Requires-Dist: opentelemetry-api (>=1.23.0)
+Requires-Dist: opentelemetry-exporter-otlp-proto-http (>=1.23.0)
+Requires-Dist: opentelemetry-instrumentation-cohere (>=0.51.0)
+Requires-Dist: opentelemetry-sdk (>=1.23.0)
+Requires-Dist: pydantic (>=1.9.2)
+Requires-Dist: pydantic-core (>=2.18.2)
+Requires-Dist: typing_extensions (>=4.0.0)
+Requires-Dist: wrapt (<2)
+Project-URL: Repository, https://github.com/paid-ai/paid-python
+Description-Content-Type: text/markdown
+
+<div align="center">
+    <picture>
+        <source media="(prefers-color-scheme: dark)" srcset="./assets/paid_light.svg" width=600>
+        <source media="(prefers-color-scheme: light)" srcset="./assets/paid_dark.svg" width=600>
+        <img alt="Fallback image description" src="./assets/paid_light.svg" width=600>
+    </picture>
+</div>
+
+#
+
+<div align="center">
+    <a href="https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2FAgentPaid%2Fpaid-python">
+        <img src="https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen" alt="fern shield">
+    </a>
+    <a href="https://pypi.org/project/paid-python">
+        <img src="https://img.shields.io/pypi/v/paid-python" alt="pypi shield">
+    </a>
+</div>
+
+Paid is the all-in-one, drop-in Business Engine for AI Agents that handles your pricing, subscriptions, margins, billing, and renewals with just 5 lines of code.
+The Paid Python library provides convenient access to the Paid API from Python applications.
+
+## Documentation
+
+See the full API docs [here](https://paid.docs.buildwithfern.com/api-reference/api-reference/customers/list)
+
+## Installation
+
+You can install the package using pip:
+
+```bash
+pip install paid-python
+```
+
+## Usage
+
+The client needs to be configured with your account's API key, which is available in the [Paid dashboard](https://app.paid.ai/agent-integration/api-keys).
+
+```python
+from paid import Paid
+
+client = Paid(token="API_KEY")
+
+client.customers.create_customer(
+    name="name"
+)
+```
+
+## Request And Response Types
+
+The SDK provides Python classes for all request and response types. These are automatically handled when making API calls.
+
+```python
+# Example of creating a customer
+response = client.customers.create_customer(
+    name="John Doe",
+)
+
+# Access response data
+print(response.name)
+print(response.email)
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), the SDK will raise an appropriate error.
+
+```python
+from paid import BadRequestError, NotFoundError
+from paid.core.api_error import ApiError
+
+try:
+    client.customers.create_customer(name="John Doe")
+except BadRequestError as e:
+    print(e.status_code)  # 400
+    print(e.body)         # ErrorResponse with error details
+except NotFoundError as e:
+    print(e.status_code)  # 404
+    print(e.body)
+except ApiError as e:
+    # Catch-all for other API errors
+    print(e.status_code)
+    print(e.body)
+```
+
+## Logging
+
+Supported log levels are `DEBUG`, `INFO`, `WARNING`, `ERROR`, and `CRITICAL`.
+
+For example, to set the log level to debug, you can set the environment variable:
+
+```bash
+export PAID_LOG_LEVEL=DEBUG
+```
+
+Defaults to ERROR.
+
+## Environment Variables
+
+The Paid SDK supports the following environment variables for configuration:
+
+### `PAID_API_KEY`
+
+Your Paid API key for authentication. This is used as a fallback when you don't explicitly pass the `token` parameter to the `Paid()` client or `initialize_tracing()`.
+
+```bash
+export PAID_API_KEY="your_api_key_here"
+```
+
+### `PAID_ENABLED`
+
+Controls whether Paid tracing is enabled. Set to `false` (case-insensitive) to disable all tracing functionality.
+
+```bash
+export PAID_ENABLED=false
+```
+
+This is useful for:
+
+- Development/testing environments where tracing isn't needed
+- Temporarily disabling tracing without modifying code
+- Feature flagging in different deployment environments
+
+Defaults to `true` if not set.
+
+### `PAID_LOG_LEVEL`
+
+Sets the logging level for Paid SDK operations. See the [Logging](#logging) section for details.
+
+### `PAID_OTEL_COLLECTOR_ENDPOINT`
+
+Overrides the default OpenTelemetry collector endpoint URL. Only needed if you want to route traces to a custom endpoint.
+
+```bash
+export PAID_OTEL_COLLECTOR_ENDPOINT="https://your-custom-endpoint.com:4318/v1/traces"
+```
+
+Defaults to `https://collector.agentpaid.io:4318/v1/traces`.
+
+## Cost Tracking via OTEL tracing
+
+### Simple Decorator and Context Manager Methods
+
+The easiest way to add cost tracking is using the `@paid_tracing` decorator or context manager:
+
+> **Important:** Always call `initialize_tracing()` and `paid_autoinstrument()` once at startup before using `paid_tracing`. `initialize_tracing` also accepts optional arguments like OTEL collector endpoint and api key if you want to reroute your tracing somewhere else.
+
+#### As a Decorator
+
+```python
+from paid.tracing import paid_tracing, initialize_tracing, paid_autoinstrument
+
+initialize_tracing()
+paid_autoinstrument()  # instruments all supported libraries by default
+
+@paid_tracing("<external_customer_id>", external_product_id="<optional_external_product_id>")
+def some_agent_workflow():  # your function
+    # Your logic - use any AI providers and send signals with signal().
+    # This function is typically an event processor that should lead to AI calls or events emitted as Paid signals
+```
+
+#### As a Context Manager
+
+You can also use `paid_tracing` as a context manager with `with` statements:
+
+```python
+from paid.tracing import paid_tracing, initialize_tracing, paid_autoinstrument
+
+initialize_tracing()
+paid_autoinstrument()  # instruments all supported libraries by default
+
+# Synchronous
+with paid_tracing("customer_123", external_product_id="product_456"):
+    result = workflow()
+
+# Asynchronous
+async with paid_tracing("customer_123", external_product_id="product_456"):
+    result = await workflow()
+```
+
+Both approaches:
+
+- Handle both sync and async functions/code blocks
+- Gracefully fall back to normal execution if tracing fails
+- Support the same parameters: `external_customer_id`, `external_product_id`, `tracing_token`, `store_prompt`, `metadata`
+
+### Using AI Provider SDKs
+
+After calling `initialize_tracing()` and `paid_autoinstrument()`, use your AI provider SDKs directly — no wrapper classes needed:
+
+```python
+from openai import OpenAI
+from paid.tracing import paid_tracing, initialize_tracing, paid_autoinstrument
+
+initialize_tracing()
+paid_autoinstrument(libraries=["openai"])
+
+openai_client = OpenAI(api_key="<OPENAI_API_KEY>")
+
+@paid_tracing("your_external_customer_id", external_product_id="your_external_product_id")
+def image_generate():
+    response = openai_client.images.generate(
+        model="dall-e-3",
+        prompt="A sunset over mountains",
+        size="1024x1024",
+        quality="hd",
+        style="vivid",
+        n=1
+    )
+    return response
+
+image_generate()
+```
+
+### Passing User Metadata
+
+You can attach custom metadata to your traces by passing a `metadata` dictionary to the `paid_tracing()` decorator or context manager. This metadata will be stored with the trace and can be used to filter and query traces later.
+
+<details>
+<summary><strong>Python - Decorator</strong></summary>
+
+```python
+from paid.tracing import paid_tracing, signal, initialize_tracing, paid_autoinstrument
+from openai import OpenAI
+
+initialize_tracing()
+paid_autoinstrument(libraries=["openai"])
+
+openai_client = OpenAI(api_key="<OPENAI_API_KEY>")
+
+@paid_tracing(
+    "customer_123",
+    external_product_id="product_123",
+    metadata={
+        "campaign_id": "campaign_456",
+        "environment": "production",
+        "user_tier": "enterprise"
+    }
+)
+def process_event(event):
+    """Process event with custom metadata"""
+    response = openai_client.chat.completions.create(
+        model="gpt-4",
+        messages=[{"role": "user", "content": event.content}]
+    )
+
+    signal("event_processed", enable_cost_tracing=True)
+    return response
+
+process_event(incoming_event)
+```
+
+</details>
+
+<details>
+<summary><strong>Python - Context Manager</strong></summary>
+
+```python
+from paid.tracing import paid_tracing, signal, initialize_tracing, paid_autoinstrument
+from openai import OpenAI
+
+initialize_tracing()
+paid_autoinstrument(libraries=["openai"])
+
+openai_client = OpenAI(api_key="<OPENAI_API_KEY>")
+
+def process_event(event):
+    """Process event with custom metadata"""
+    response = openai_client.chat.completions.create(
+        model="gpt-4",
+        messages=[{"role": "user", "content": event.content}]
+    )
+
+    signal("event_processed", enable_cost_tracing=True)
+    return response
+
+# Pass metadata to context manager
+with paid_tracing(
+    "customer_123",
+    external_product_id="product_123",
+    metadata={
+        "campaign_id": "campaign_456",
+        "environment": "production",
+        "user_tier": "enterprise"
+    }
+):
+    process_event(incoming_event)
+```
+
+</details>
+
+#### Querying Traces by Metadata
+
+Once you've added metadata to your traces, you can filter traces using the metadata parameter in the traces API endpoint:
+
+```bash
+# Filter by single metadata field
+curl -G "https://api.paid.ai/api/organizations/{orgId}/traces" \
+  --data-urlencode 'metadata={"campaign_id":"campaign_456"}' \
+  -H "Authorization: Bearer YOUR_API_KEY"
+
+# Filter by multiple metadata fields (all must match)
+curl -G "https://api.paid.ai/api/organizations/{orgId}/traces" \
+  --data-urlencode 'metadata={"campaign_id":"campaign_456","environment":"production"}' \
+  -H "Authorization: Bearer YOUR_API_KEY"
+```
+
+### Auto-Instrumentation (OpenTelemetry Instrumentors)
+
+For maximum convenience, you can use OpenTelemetry auto-instrumentation to automatically track costs without modifying your AI library calls. This approach uses official OpenTelemetry instrumentors for supported AI libraries.
+
+#### Quick Start
+
+```python
+from paid import Paid
+from paid.tracing import paid_autoinstrument, initialize_tracing, paid_tracing
+from openai import OpenAI
+
+# Initialize Paid SDK
+client = Paid(token="PAID_API_KEY")
+initialize_tracing()
+paid_autoinstrument(libraries=["openai"])
+
+# Now all OpenAI calls will be automatically traced
+openai_client = OpenAI(api_key="<OPENAI_API_KEY>")
+
+@paid_tracing("your_external_customer_id", external_product_id="your_external_product_id")
+def chat_with_gpt():
+    response = openai_client.chat.completions.create(
+        model="gpt-4",
+        messages=[{"role": "user", "content": "Hello!"}]
+    )
+    return response
+
+chat_with_gpt()  # Costs are automatically tracked!
+```
+
+#### Supported Libraries
+
+Auto-instrumentation supports the following AI libraries:
+
+```
+anthropic          - Anthropic SDK
+gemini             - Google Generative AI (google-generativeai)
+openai             - OpenAI Python SDK
+openai-agents      - OpenAI Agents SDK
+claude-agent-sdk   - Claude Agent SDK
+bedrock            - AWS Bedrock (boto3)
+langchain          - LangChain framework
+instructor         - Instructor
+cohere             - Cohere SDK
+```
+
+#### Selective Instrumentation
+
+If you only want to instrument specific libraries, pass them to `paid_autoinstrument()`:
+
+```python
+from paid.tracing import paid_autoinstrument
+
+# Instrument only Anthropic and OpenAI
+paid_autoinstrument(libraries=["anthropic", "openai"])
+```
+
+#### How It Works
+
+- Auto-instrumentation uses official OpenTelemetry instrumentors for each AI library
+- It automatically wraps library calls without requiring you to use Paid wrapper classes
+- Works seamlessly with `@paid_tracing()` decorator or context manager
+- Costs are tracked in the same way as when using manual wrappers
+- Should be called once during application startup, typically before creating AI client instances
+
+## Signaling via OTEL tracing
+
+Signals allow you to emit events within your tracing context. They have access to all tracing information, so you need fewer arguments compared to manual API calls.
+Use the `signal()` function which must be called within an active `@paid_tracing()` context (decorator or context manager).
+
+Here's an example of how to use it:
+
+```python
+from paid.tracing import paid_tracing, signal, initialize_tracing, paid_autoinstrument
+
+initialize_tracing()
+paid_autoinstrument()
+
+@paid_tracing("your_external_customer_id", external_product_id="your_external_product_id")
+def do_work():
+    # ...do some work...
+    signal(
+        event_name="<your_signal_name>",
+        data={ } # optional data (ex. manual cost tracking data)
+    )
+
+do_work()
+```
+
+Same approach with context manager:
+
+```python
+from paid.tracing import paid_tracing, signal, initialize_tracing, paid_autoinstrument
+
+initialize_tracing()
+paid_autoinstrument()
+
+def do_work():
+    # ...do some work...
+    signal(
+        event_name="<your_signal_name>",
+        data={ } # optional data (ex. manual cost tracking data)
+    )
+
+# Use context manager instead
+with paid_tracing("your_external_customer_id", external_product_id="your_external_product_id"):
+    do_work()
+```
+
+### Signal-costs - Attaching cost traces to a signal
+
+If you want a signal to carry information about costs,
+then the signal should be sent from the same tracing context
+as the wrappers and hooks that recorded those costs.
+
+This will look something like this:
+
+```python
+from paid.tracing import paid_tracing, signal, initialize_tracing, paid_autoinstrument
+
+initialize_tracing()
+paid_autoinstrument()
+
+@paid_tracing("your_external_customer_id", external_product_id="your_external_product_id")
+def do_work():
+    # ... your workflow logic
+    # ... your AI calls (auto-instrumented)
+    signal(
+        event_name="<your_signal_name>",
+        data={ }, # optional data (ex. manual cost tracking data)
+        enable_cost_tracing=True, # set this flag to associate it with costs
+    )
+    # ... your workflow logic
+    # ... your AI calls (auto-instrumented, can be sent after the signal too)
+
+do_work()
+```
+
+Then, all of the costs traced in @paid_tracing() context are related to that signal.
+
+### Signal-costs - Distributed tracing
+
+Sometimes your agent workflow cannot fit into a single traceable function like above,
+because it has to be disjoint for whatever reason. It could even be running across different machines.
+
+For such cases, you can pass a tracing token directly to `@paid_tracing()` or context manager to link distributed traces together.
+
+#### Using `tracing_token` parameter (Recommended)
+
+The simplest way to implement distributed tracing is to pass the token directly to the decorator or context manager:
+
+```python
+from paid.tracing import paid_tracing, signal, generate_tracing_token, initialize_tracing, paid_autoinstrument
+from openai import OpenAI
+
+initialize_tracing()
+paid_autoinstrument(libraries=["openai"])
+
+openai_client = OpenAI(api_key="<OPENAI_API_KEY>")
+
+# Process 1: Generate token and do initial work
+token = generate_tracing_token()
+print(f"Tracing token: {token}")
+
+# Store token for other processes (e.g., in Redis, database, message queue)
+save_to_storage("workflow_123", token)
+
+@paid_tracing("customer_123", tracing_token=token, external_product_id="product_123")
+def process_part_1():
+    # AI calls here will be traced
+    response = openai_client.chat.completions.create(
+        model="gpt-4",
+        messages=[{"role": "user", "content": "Analyze data"}]
+    )
+    # Signal without cost tracing
+    signal("part_1_complete", enable_cost_tracing=False)
+
+process_part_1()
+
+# Process 2 (different machine/process): Retrieve and use token
+token = load_from_storage("workflow_123")
+
+@paid_tracing("customer_123", tracing_token=token, external_product_id="product_123")
+def process_part_2():
+    # AI calls here will be linked to the same trace
+    response = openai_client.chat.completions.create(
+        model="gpt-4",
+        messages=[{"role": "user", "content": "Generate response"}]
+    )
+    # Signal WITH cost tracing - links all costs from both processes
+    signal("workflow_complete", enable_cost_tracing=True)
+
+process_part_2()
+# No cleanup needed - token is scoped to the decorated function
+```
+
+Using context manager instead of decorator:
+
+```python
+from paid.tracing import paid_tracing, signal, generate_tracing_token, initialize_tracing, paid_autoinstrument
+from openai import OpenAI
+
+initialize_tracing()
+paid_autoinstrument(libraries=["openai"])
+
+openai_client = OpenAI(api_key="<OPENAI_API_KEY>")
+
+# Process 1: Generate token and do initial work
+token = generate_tracing_token()
+save_to_storage("workflow_123", token)
+
+with paid_tracing("customer_123", external_product_id="product_123", tracing_token=token):
+    response = openai_client.chat.completions.create(
+        model="gpt-4",
+        messages=[{"role": "user", "content": "Analyze data"}]
+    )
+    signal("part_1_complete", enable_cost_tracing=False)
+
+# Process 2: Retrieve and use the same token
+token = load_from_storage("workflow_123")
+
+with paid_tracing("customer_123", external_product_id="product_123", tracing_token=token):
+    response = openai_client.chat.completions.create(
+        model="gpt-4",
+        messages=[{"role": "user", "content": "Generate response"}]
+    )
+    signal("workflow_complete", enable_cost_tracing=True)
+```
+
+## Manual Cost Tracking
+
+If you would prefer to not use Paid to track your costs automatically but you want to send us the costs yourself,
+then you can use manual cost tracking mechanism. Just attach the cost information in the following format to a signal payload:
+
+```python
+from paid import Paid, Signal, CustomerByExternalId, ProductByExternalId
+
+client = Paid(token="<PAID_API_KEY>")
+
+signal = Signal(
+    event_name="<your_signal_name>",
+    customer=CustomerByExternalId(external_customer_id="<your_external_customer_id>"),
+    attribution=ProductByExternalId(external_product_id="<your_external_product_id>"),
+    data={
+        "costData": {
+            "vendor": "<any_vendor_name>",  # can be anything, traces are grouped by vendors in the UI
+            "cost": {
+                "amount": 0.002,
+                "currency": "USD"
+            },
+            "gen_ai.response.model": "<ai_model_name>", # optional, but will be displayed on UI
+            "start_time": "2024-01-01T11:45:00.000Z",  # optional, affects where trace is on the timeline
+        }
+    }
+)
+
+client.signals.create_signals(signals=[signal])
+```
+
+Alternatively the same `costData` payload can be passed to OTLP signaling mechanism:
+
+```python
+from paid.tracing import paid_tracing, signal, initialize_tracing, paid_autoinstrument
+
+initialize_tracing()
+paid_autoinstrument()
+
+@paid_tracing("your_external_customer_id", external_product_id="your_external_product_id")
+def do_work():
+    # ...do some work...
+    signal(
+        event_name="<your_signal_name>",
+        data={
+            "costData": {
+                "vendor": "<any_vendor_name>", # can be anything, traces are grouped by vendors in the UI
+                "cost": {
+                    "amount": 0.002,
+                    "currency": "USD"
+                },
+                "gen_ai.response.model": "<ai_model_name>", # optional, but will be displayed on UI
+                "start_time": "2024-01-01T11:45:00.000Z",  # optional, affects where trace is on the timeline
+            }
+        }
+    )
+
+do_work()
+```
+
+### Manual Usage Tracking
+
+If you would prefer to send us raw usage manually (without wrappers) and have us compute the cost, you can attach usage data in the following format:
+
+```python
+from paid import Paid, Signal, CustomerByExternalId, ProductByExternalId
+
+client = Paid(token="<PAID_API_KEY>")
+
+signal = Signal(
+    event_name="<your_signal_name>",
+    customer=CustomerByExternalId(external_customer_id="<your_external_customer_id>"),
+    attribution=ProductByExternalId(external_product_id="<your_external_product_id>"),
+    data={
+        "costData": {
+            "vendor": "<any_vendor_name>",  # can be anything, traces are grouped by vendors in the UI
+            "attributes": {
+                "gen_ai.response.model": "gpt-4.1-mini",
+                "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,
+            },
+        }
+    }
+)
+
+client.signals.create_signals(signals=[signal])
+```
+
+Same but via OTEL signaling:
+
+```python
+from paid.tracing import paid_tracing, signal, initialize_tracing, paid_autoinstrument
+
+initialize_tracing()
+paid_autoinstrument()
+
+@paid_tracing("your_external_customer_id", external_product_id="your_external_product_id")
+def do_work():
+    # ...do some work...
+    signal(
+        event_name="<your_signal_name>",
+        data={
+            "costData": {
+                "vendor": "<any_vendor_name>", # can be anything, traces are grouped by vendors in the UI
+                "attributes": {
+                    "gen_ai.response.model": "gpt-4.1-mini",
+                    "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,
+                },
+            }
+        }
+    )
+
+do_work()
+```
+
+## Async Support
+
+All of the functionality from above is available in async flavor too.
+
+### Async Client
+
+Use `AsyncPaid` instead of `Paid` for async operations:
+
+```python
+from paid import AsyncPaid
+
+client = AsyncPaid(token="API_KEY")
+
+# Async API calls
+customer = await client.customers.create_customer(name="John Doe")
+```
+
+### Async Cost Tracking with Decorator
+
+The `@paid_tracing` decorator automatically handles both sync and async functions:
+
+```python
+from openai import AsyncOpenAI
+from paid.tracing import paid_tracing, initialize_tracing, paid_autoinstrument
+
+initialize_tracing()
+paid_autoinstrument(libraries=["openai"])
+
+openai_client = AsyncOpenAI(api_key="<OPENAI_API_KEY>")
+
+@paid_tracing("your_external_customer_id", external_product_id="your_external_product_id")
+async def generate_image():
+    response = await openai_client.images.generate(
+        model="dall-e-3",
+        prompt="A sunset over mountains",
+        size="1024x1024",
+        quality="hd",
+        n=1
+    )
+    return response
+
+# Call the async function
+await generate_image()
+```
+
+### Async Signaling
+
+The `signal()` function works seamlessly in async contexts:
+
+```python
+from paid.tracing import paid_tracing, signal, initialize_tracing, paid_autoinstrument
+from openai import AsyncOpenAI
+
+initialize_tracing()
+paid_autoinstrument(libraries=["openai"])
+
+openai_client = AsyncOpenAI(api_key="<OPENAI_API_KEY>")
+
+@paid_tracing("your_external_customer_id", external_product_id="your_external_product_id")
+async def do_work():
+    # Perform async AI operations
+    response = await openai_client.chat.completions.create(
+        model="gpt-4",
+        messages=[{"role": "user", "content": "Hello!"}]
+    )
+
+    # Send signal (works in async context)
+    signal(
+        event_name="<your_signal_name>",
+        enable_cost_tracing=True  # Associate with traced costs
+    )
+
+    return response
+
+# Execute
+await do_work()
+```
+
+### Paid OTEL Tracer Provider
+
+If you would like to use the Paid OTEL tracer provider:
+
+```python
+from paid.tracing import get_paid_tracer_provider
+paid_tracer_provider = get_paid_tracer_provider()
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!
+