Go Boilerplate

GitHub Repository

Minimal Go + Dodo Payments ボイラープレート

概要

このGo boilerplateは、pricing pageからDodo Payments productsを販売する最小限のGoサーバーです。checkout sessionを作成し、webhookを検証・処理して、Customer Portalを開きます。独自のGo backendの出発点としてクローンしてください。

このboilerplateにはGo 1.24.4以降が必要で、go.modに設定されたバージョンを使用します。cmd、internal、templatesのレイアウトを使用し、Go HTML templatesでpricing pageをレンダリングして、dodopayments-go SDK経由でDodo Payments APIを呼び出します。

特徴

Quick Setup: repositoryをクローンし、.envにAPI keysを追加して、make runでserverを起動します。
Payment Integration: dodopayments-go SDKでcheckout sessionを作成するcheckout flowです。
Modern UI: Go HTML templatesとTailwind CSSで構築したダークテーマのpricing pageです。
Webhook Handling: eventを処理する前に、各webhookのsignatureを検証します。
Customer Portal: Customer Portalを通じたセルフサービスのsubscription managementです。
Go Best Practices: cmd、internal、templatesを使用した整理されたproject layoutです。
Pre-filled Checkout: customer’s nameとemailをcheckoutに渡すため、customerは再入力する必要がありません。

前提条件

開始する前に、次のものが必要です：

Go 1.24.4以降。go versionでversionを確認します。
Dodo Payments account。dashboardでAPI keyとwebhook signing keyを作成します。
少なくとも1つのproduct。dashboardのProductsで作成します。

クイックスタート

Clone the Repository

git clone https://github.com/dodopayments/go-boilerplate.git
cd go-boilerplate

Install Dependencies

make install

make installはgo mod downloadを実行し、その後go mod tidyを実行します。makeなしでmodulesをダウンロードするには、次を実行します：

go mod download

Get API Credentials

Dodo Paymentsに登録し、dashboardから両方のkeyをコピーします：

API Key: Developer → API Keys
Webhook Key: Developer → Webhooks。各webhook endpointには独自のsigning keyがあります。local serverに到達するendpointを作成する方法は、LocallyでのWebhookのテストを参照してください。

開発中は、両方のkeyをtest modeで作成します。test modeに切り替えるには、dashboard sidebarのLive Mode switchをオフにします。

Configure Environment Variables

templateから、project rootに.env fileを作成します：

cp .env.example .env

.envに次の値を設定します：

.env

DODO_PAYMENTS_API_KEY=your_api_key_here
DODO_PAYMENTS_WEBHOOK_KEY=your_webhook_signing_key_here
DODO_PAYMENTS_RETURN_URL=http://localhost:8000
DODO_PAYMENTS_ENVIRONMENT=test_mode
PORT=8000

serverはstartup時にこれらのvariablesを読み込みます：

Variable	Required	Default	Purpose
`DODO_PAYMENTS_API_KEY`	Yes	None	Dodo Payments APIへのrequestを認証します。
`DODO_PAYMENTS_WEBHOOK_KEY`	Yes	None	受信したwebhookのsignatureを検証します。
`DODO_PAYMENTS_RETURN_URL`	No	`http://localhost:8080`	payment後にcheckoutがcustomerをredirectするURLです。
`DODO_PAYMENTS_ENVIRONMENT`	No	`test_mode`	`test_mode`または`live_mode`です。
`PORT`	No	`8000`	serverがlistenするportです。

いずれかのrequired keyが欠けている場合、serverはstartup時に終了します。.env.exampleはPORTとDODO_PAYMENTS_RETURN_URLをport 8080に設定します。このpageではport 8000を使用するため、表示されているように両方を8000に設定するか、このpageのcommands内の8000を8080に置き換えます。

.env fileをversion controlにcommitしないでください。repositoryの.gitignoreはすでにこれを除外しています。

Add Your Products

internal/lib/products.goのsample productを自分のproductsに置き換えます。dashboardのProductsから各product IDをコピーします：

var Products = []Product{
    {
        ProductID:   "pdt_001", // Replace with your product ID
        Name:        "Basic Plan",
        Description: "Get access to basic features and support",
        Price:       9999, // in cents
        Features: []string{
            "Access to basic features",
            "Email support",
            "1 Team member",
            "Basic analytics",
        },
    },
    // ... add more products
}

Priceは、pricing pageに表示するpriceだけを、最小のcurrency unitで設定します。9999は$99.99として表示されます。checkoutではDodo Paymentsのproduct priceが請求されます。

Run the Development Server

make run

make runはserverをbin/serverにbuildして起動します。binaryを先にbuildせずserverを実行するには、次を実行します：

go run cmd/server/main.go

http://localhost:8000を開いてpricing pageを確認します。

productsが一覧表示され、購入可能なダークテーマのpricing pageが表示されます。

Project Structure

repositoryのlayoutは次のとおりです：

go-boilerplate/
├── cmd/
│   └── server/             # Application entry point (main.go)
├── internal/
│   ├── api/                # API handlers: checkout.go, portal.go, webhook.go
│   ├── core/               # Configuration loading (config.go)
│   └── lib/                # Shared logic: products.go, customers.go
├── templates/              # HTML templates: base.html, index.html
├── Makefile                # Build and run commands
├── go.mod                  # Go module definition
├── go.sum                  # Dependency checksums
├── .env.example            # Environment template
└── README.md

API Endpoints

boilerplateには、次のpre-configured endpointsが含まれています：

Endpoint	Method	Description
`/`	GET	`internal/lib/products.go`のproductsを一覧表示するpricing pageです。
`/api/checkout`	POST	checkout sessionを作成します。`product_id`と、任意の`quantity`（defaultは`1`）および`customer`（`email`、`name`、`phone`）を送信します。`session_id`と`checkout_url`を返します。
`/api/webhook`	POST	Dodo Payments webhookを検証して処理します。signature checkに失敗すると`401`を返します。
`/api/customer-portal`	POST	`portal_url`にCustomer Portal linkを返します。`customer_id`、または任意の`name`を伴う`email`を送信します。emailだけの場合、handlerはcustomerを検索し、存在しなければ作成します。
`/health`	GET	health checkです。`OK`を返します。

Customization

Update Product Information

internal/lib/products.goを編集して、次を変更します：

Product IDs（Dodo Payments dashboardのProductsから取得）
Names
pricing pageに表示されるpricing
Features
Descriptions

var Products = []Product{
    {
        ProductID:   "pdt_001", // Replace with your product ID
        Name:        "Basic Plan",
        Description: "Get access to basic features and support",
        Price:       9999,
        Features: []string{
            "Access to basic features",
            "Email support",
            "1 Team member",
            "Basic analytics",
        },
    },
}

pricing page templateはすべてのpriceに/mo suffixを追加し、Priceが100000以上の場合はpriceの代わりにCustomを表示します。変更するにはtemplates/index.htmlを編集します。

Pre-fill Customer Data

.envでは、handleCheckout functionがhardcoded customer dataを/api/checkoutに送信します。signed-in userのdataに置き換えてください：

const customerData = {
    name: "John Doe",       // Replace with actual logged-in user's name
    email: "john@example.com"  // Replace with actual logged-in user's email
};

handlePortal functionはこのcustomer dataを再利用し、同じsample nameとemailにfallbackします。production appでは、両方のfunctionにauthentication systemからこれらのvaluesをinjectしてください。

Webhook Events

internal/api/webhook.goは、client.Webhooks.UnwrapとDODO_PAYMENTS_WEBHOOK_KEYのkeyで各requestを検証し、typeによってeventをrouteします。これらのeventsにはhandlerがあり、各handlerはevent dataをlogに記録します：

Event	Description
`payment.succeeded`	paymentがsuccessfulになったときにtriggerされます
`payment.failed`	payment attemptが失敗したときにtriggerされます
`subscription.active`	subscriptionがactiveになったときにtriggerされます
`subscription.renewed`	subscriptionが次のbilling periodにrenewされたときにtriggerされます
`subscription.updated`	subscription fieldが変更されたときにtriggerされます
`subscription.cancelled`	subscriptionがcancelされたときにtriggerされます

handlerはsubscription.on_hold、subscription.failed、subscription.expired、subscription.plan_changedもactionなしで受け付け、その他すべてのevent typeをunhandledとしてlogに記録します。検証済みのすべてのeventに対して200で応答します。すべてのevent typeについては、Webhook Event Guideを参照してください。 handler functionsにbusiness logicを追加して、次を実行します：

databaseのuser permissionsを更新する
confirmation emailsを送信する
digital productsへのaccessをprovisionする
analyticsとmetricsをtrackする

Testing Webhooks Locally

Dodo Paymentsはlocalhostに到達できません。development中にwebhookを受信するには、ngrokなどのtunnelでlocal serverを公開します：

ngrok http 8000

Dodo Payments Dashboardで、ngrokが出力したforwarding URLの末尾に/api/webhookを付けたURLでendpointを追加します：

https://your-ngrok-url.ngrok.io/api/webhook

endpointのsigning keyをDODO_PAYMENTS_WEBHOOK_KEYにコピーし、serverを再起動します。

Deployment

Build for Production

make buildはserverをbin/serverにcompileします：

make build

makeなしでbinaryをbuildして起動するには、次を実行します：

go build -o bin/server cmd/server/main.go
./bin/server

Deploy to Vercel

[

](https://vercel.com/new/clone?repository-url=https://github.com/dodopayments/go-boilerplate) deploy後、.env fileのvariablesをVercel project settingsに追加します。.envはrepositoryに含まれていないためです。その後、dashboardのwebhook endpointをhttps://yourdomain.com/api/webhookに設定します。

Docker

project rootにDockerfileを作成します。build stageではgo.modに合わせてGo 1.24.4以降を使用する必要があります：

FROM golang:1.24-alpine AS builder

WORKDIR /app
COPY go.mod go.sum ./
RUN go mod download

COPY . .
RUN go build -o bin/server cmd/server/main.go

FROM alpine:latest
WORKDIR /app
COPY --from=builder /app/bin/server .
COPY --from=builder /app/templates ./templates

EXPOSE 8000
CMD ["./server"]

final imageはtemplates/をbinaryの隣にcopyします。serverがworking directoryからtemplatesをloadするためです。imageをbuildして実行します：

docker build -t go-dodo .
docker run -p 8000:8000 --env-file .env go-dodo

containerは.envのPORT valueでlistenするため、port mappingと一致するようPORT=8000を維持します。

Production Considerations

productionにdeployする前に：

DODO_PAYMENTS_ENVIRONMENTをlive_modeに設定します。
dashboardのlive mode API keyを使用します。
webhook endpointをproduction domainに向け、そのendpointのsigning keyを使用します。
DODO_PAYMENTS_RETURN_URLをproduction domain上のpageに設定します。
すべてのendpointをHTTPSで提供します。

Troubleshooting

Build errors or missing dependencies

go versionがGo 1.24.4以降を示していることを確認し、modulesを再度downloadします：

go mod tidy
go mod download

Checkout session creation fails

Common causes:

product IDが無効です。API keyと同じmodeのProductsに存在することを確認してください。
.envのAPI keyまたはDODO_PAYMENTS_ENVIRONMENTが間違っています。test mode keyにはtest_modeが必要です。
正確なerrorについてはserver logsを確認してください。handlerは500を返す前に、失敗したすべてのrequestをlogに記録します。

Webhooks not receiving events

local testingでは、ngrokでserverを公開します：

ngrok http 8000

Dodo Payments dashboardのwebhook URLをngrok URLに設定します。次に.envのDODO_PAYMENTS_WEBHOOK_KEYを、そのendpointのsigning keyに設定します。serverがwebhook verification failedをlogに記録する場合、keyがendpointと一致していません。

Templates not loading

serverはworking directoryからtemplates/base.htmlとtemplates/index.htmlをloadします。project rootからserverを起動するか、cmd/server/main.goのtemplate pathsを変更してください。

Learn More

Go SDK

Go SDKの完全なdocumentation

Webhooks Documentation

すべてのwebhook eventsとbest practicesを学ぶ

Checkout Sessions

checkout session configurationを詳しく確認する

API Reference

Dodo Payments APIの完全なdocumentation

Support

boilerplateについてサポートが必要な場合：

Discord communityで質問します。
GitHub repositoryでissuesとupdatesを確認します。
support teamに連絡します。

Getting Started

Features

Integrate

Merchant of Record

Miscellaneous

GitHub Repository

概要

特徴

前提条件

クイックスタート

Project Structure

API Endpoints

Customization

Update Product Information

Pre-fill Customer Data

Webhook Events

Testing Webhooks Locally

Deployment

Build for Production

Deploy to Vercel

Docker

Production Considerations

Troubleshooting

Learn More

Go SDK

Webhooks Documentation

Checkout Sessions

API Reference

Support

GitHub Repository

​概要

​特徴

​前提条件

​クイックスタート

​Project Structure

​API Endpoints

​Customization

​Update Product Information

​Pre-fill Customer Data

​Webhook Events

​Testing Webhooks Locally

​Deployment

​Build for Production

​Deploy to Vercel

​Docker

​Production Considerations

​Troubleshooting

​Learn More

Go SDK

Webhooks Documentation

Checkout Sessions

API Reference

​Support

概要

特徴

前提条件

クイックスタート

Project Structure

API Endpoints

Customization

Update Product Information

Pre-fill Customer Data

Webhook Events

Testing Webhooks Locally

Deployment

Build for Production

Deploy to Vercel

Docker

Production Considerations

Troubleshooting

Learn More

Support