Python - Dodo Payments Documentation

Python SDKは、Dodo Payments APIに対してPythonicなインターフェースを提供し、リクエストとレスポンスの型定義を持つ同期および非同期クライアントを提供します。Python 3.9以上をサポートし、包括的なテストカバレッジが含まれています。

インストール

pipを使用してSDKをインストールします:

pip install dodopayments

aiohttpを使用して非同期パフォーマンスを向上させるためには:

pip install dodopayments[aiohttp]

この SDK には Python 3.9 以上が必要です。最高の体験とセキュリティアップデートのため、最新の安定版 Python を使用することを推奨します。

クイックスタート

同期クライアント

import os
from dodopayments import DodoPayments

client = DodoPayments(
    bearer_token=os.environ.get("DODO_PAYMENTS_API_KEY"),  # This is the default and can be omitted
    environment="test_mode",  # defaults to "live_mode"
)

checkout_session_response = client.checkout_sessions.create(
    product_cart=[
        {
            "product_id": "product_id",
            "quantity": 1
        }
    ],
)
print(checkout_session_response.session_id)

非同期クライアント

import os
import asyncio
from dodopayments import AsyncDodoPayments

client = AsyncDodoPayments(
    bearer_token=os.environ.get("DODO_PAYMENTS_API_KEY"),
    environment="test_mode",
)

async def main() -> None:
    checkout_session_response = await client.checkout_sessions.create(
        product_cart=[
            {
                "product_id": "product_id",
                "quantity": 1,
            }
        ],
    )
    print(checkout_session_response.session_id)

asyncio.run(main())

API キーは常に環境変数を使って安全に保管してください。決してバージョン管理にコミットしないでください。

コア機能

Pythonic Interface

PEP 8 のガイドラインと Python の慣習に従った、クリーンで慣用的な Python コード

Async/Await

asyncio を使った非同期操作と、オプションの aiohttp 統合を完全サポート

Type Hints

IDE サポートと mypy による型チェックを向上させる、完全な型ヒント

Auto-Pagination

シンプルな反復処理でリスト応答の自動ページング

設定

環境変数

環境変数を使用して設定します:

.env

DODO_PAYMENTS_API_KEY=your_api_key_here

タイムアウト

リクエストのタイムアウトをグローバルまたはリクエストごとに設定します:

import httpx
from dodopayments import DodoPayments

# Configure default for all requests (default is 1 minute)
client = DodoPayments(
    timeout=20.0,  # 20 seconds
)

# More granular control
client = DodoPayments(
    timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),
)

# Override per-request
client.with_options(timeout=5.0).checkout_sessions.create(
    product_cart=[
        {
            "product_id": "product_id",
            "quantity": 1,
        }
    ],
)

リトライ

自動リトライの動作を設定します:

from dodopayments import DodoPayments

# Configure default for all requests (default is 2)
client = DodoPayments(
    max_retries=0,  # disable retries
)

# Override per-request
client.with_options(max_retries=5).checkout_sessions.create(
    product_cart=[
        {
            "product_id": "product_id",
            "quantity": 1,
        }
    ],
)

一般的な操作

チェックアウトセッションの作成

チェックアウトセッションを生成します:

session = client.checkout_sessions.create(
    product_cart=[
        {
            "product_id": "prod_123",
            "quantity": 1
        }
    ],
    return_url="https://yourdomain.com/return"
)

print(f"Checkout URL: {session.checkout_url}")

顧客の管理

顧客情報を作成および取得します:

# Create a customer
customer = client.customers.create(
    email="customer@example.com",
    name="John Doe",
    metadata={
        "user_id": "12345"
    }
)

# Retrieve customer
customer = client.customers.retrieve("cus_123")
print(f"Customer: {customer.name} ({customer.email})")

サブスクリプションの管理

定期的なサブスクリプションを作成および管理します:

# Create a subscription
subscription = client.subscriptions.create(
    billing={
        "country": "US",
        "city": "San Francisco",
        "state": "CA",
        "street": "1 Market St",
        "zipcode": "94105",
    },
    customer={"customer_id": "cus_123"},  # or {"email": "...", "name": "..."} for a new customer
    product_id="pdt_456",
    quantity=1,
)

# Charge an on-demand subscription
# product_price is in the lowest currency denomination (e.g., 2500 = $25.00 USD)
charge_response = client.subscriptions.charge(
    subscription_id=subscription.subscription_id,
    product_price=2500,
)

# Retrieve usage history (for metered subscriptions)
usage_history = client.subscriptions.retrieve_usage_history(
    subscription_id=subscription.subscription_id,
    start_date="2024-01-01T00:00:00Z",
)

billing には最低でも2文字のISO国コードが必要です。customer は、既存のカスタマーを追加するための {"customer_id": ...} か、新しいカスタマーを作成するための {"email": ..., "name": ...} のどちらかを受け付けます。product_price は最小通貨単位で指定されます。

Usage-Based Billing

Ingest Usage Events

使用量ベースの請求のためにカスタムイベントを追跡します:

response = client.usage_events.ingest(
    events=[
        {
            "event_id": "api_call_12345",
            "customer_id": "cus_abc123",
            "event_name": "api_request",
            "timestamp": "2024-01-15T10:30:00Z",
            "metadata": {
                "endpoint": "/api/v1/users",
                "method": "GET",
                "tokens_used": "150"
            }
        }
    ]
)

List and Retrieve Events

# Get a specific event
event = client.usage_events.retrieve("api_call_12345")

# List events with filtering
events = client.usage_events.list(
    customer_id="cus_abc123",
    event_name="api_request",
    limit=20
)

for event in events.data:
    print(f"Event: {event.event_id} at {event.timestamp}")

Pagination

Auto-Pagination

すべてのアイテムを自動で反復処理します:

from dodopayments import DodoPayments

client = DodoPayments()
all_payments = []

# Automatically fetches more pages as needed
for payment in client.payments.list():
    all_payments.append(payment)
print(all_payments)

Async Pagination

import asyncio
from dodopayments import AsyncDodoPayments

client = AsyncDodoPayments()

async def main() -> None:
    all_payments = []
    # Iterate through items across all pages
    async for payment in client.payments.list():
        all_payments.append(payment)
    print(all_payments)

asyncio.run(main())

Manual Pagination

ページネーションをより制御するには:

# Access items from current page
first_page = client.payments.list()
for payment in first_page.items:
    print(payment.brand_id)

# Check for more pages
if first_page.has_next_page():
    next_page = first_page.get_next_page()
    print(f"Fetched {len(next_page.items)} more items")

HTTP Client Configuration

基盤となる httpx クライアントをカスタマイズします:

import httpx
from dodopayments import DodoPayments, DefaultHttpxClient

client = DodoPayments(
    base_url="http://my.test.server.example.com:8083",
    http_client=DefaultHttpxClient(
        proxy="http://my.test.proxy.example.com",
        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
    ),
)

Async with aiohttp

aiohttp を使用して非同期パフォーマンスを向上させます:

import asyncio
from dodopayments import DefaultAioHttpClient
from dodopayments import AsyncDodoPayments

async def main() -> None:
    async with AsyncDodoPayments(
        bearer_token="My Bearer Token",
        http_client=DefaultAioHttpClient(),
    ) as client:
        checkout_session_response = await client.checkout_sessions.create(
            product_cart=[
                {
                    "product_id": "product_id",
                    "quantity": 1,
                }
            ],
        )
        print(checkout_session_response.session_id)

asyncio.run(main())

Logging

環境変数を設定してログを有効にします:

export DODO_PAYMENTS_LOG=info

または、デバッグレベルのログには:

export DODO_PAYMENTS_LOG=debug

Framework Integration

FastAPI

from fastapi import FastAPI, HTTPException
from dodopayments import AsyncDodoPayments
from pydantic import BaseModel
import os

app = FastAPI()
dodo = AsyncDodoPayments(bearer_token=os.getenv("DODO_API_KEY"))

class CheckoutRequest(BaseModel):
    product_id: str
    quantity: int

@app.post("/create-checkout")
async def create_checkout(request: CheckoutRequest):
    try:
        session = await dodo.checkout_sessions.create(
            product_cart=[{
                "product_id": request.product_id,
                "quantity": request.quantity
            }],
            return_url="https://yourdomain.com/return"
        )
        return {"checkout_url": session.checkout_url}
    except Exception as e:
        raise HTTPException(status_code=400, detail=str(e))

Django

from django.http import JsonResponse
from django.views.decorators.http import require_POST
from django.views.decorators.csrf import csrf_exempt
from dodopayments import DodoPayments
import os
import json

client = DodoPayments(bearer_token=os.getenv("DODO_PAYMENTS_API_KEY"))

@csrf_exempt
@require_POST
def create_checkout(request):
    try:
        data = json.loads(request.body)
        session = client.checkout_sessions.create(
            product_cart=[{
                "product_id": data.get("product_id"),
                "quantity": data.get("quantity", 1)
            }],
            return_url="https://yourdomain.com/return"
        )
        return JsonResponse({
            "status": "success",
            "checkout_url": session.checkout_url,
            "session_id": session.session_id
        })
    except Exception as e:
        return JsonResponse({
            "status": "error",
            "message": str(e)
        }, status=400)

Resources

GitHub Repository

ソースコードを表示し、貢献する

API Reference

完全なAPIドキュメント

Discord Community

開発者とつながり、助けを得る

Report Issues

バグを報告したり機能をリクエストしたりする

Support

Python SDK に関する支援が必要ですか?

Discord: コミュニティサーバーに参加してリアルタイムサポートを受ける
Email: support@dodopayments.com にメールする
GitHub: リポジトリで問題をオープンする

Contributing

貢献を歓迎します！コントリビューションガイドラインを確認して始めましょう。

​インストール

​クイックスタート

​同期クライアント

​非同期クライアント

​コア機能

Pythonic Interface

Async/Await

Type Hints

Auto-Pagination

​設定

​環境変数

​タイムアウト

​リトライ

​一般的な操作

​チェックアウトセッションの作成

​顧客の管理

​サブスクリプションの管理

​Usage-Based Billing

​Ingest Usage Events

​List and Retrieve Events

​Pagination

​Auto-Pagination

​Async Pagination

​Manual Pagination

​HTTP Client Configuration

​Async with aiohttp

​Logging

​Framework Integration

​FastAPI

​Django

​Resources

GitHub Repository

API Reference

Discord Community

Report Issues

​Support

​Contributing

インストール

クイックスタート

同期クライアント

非同期クライアント

コア機能

設定

環境変数

タイムアウト

リトライ

一般的な操作

チェックアウトセッションの作成

顧客の管理

サブスクリプションの管理

Usage-Based Billing

Ingest Usage Events

List and Retrieve Events

Pagination

Auto-Pagination

Async Pagination

Manual Pagination

HTTP Client Configuration

Async with aiohttp

Logging

Framework Integration

FastAPI

Django

Resources

Support

Contributing