税率

税率とは

TaxRate (税率)APIは、商品やサービスに対して適用される税金の割合や計算方法を定義するオブジェクトです。消費税などの税率を管理し、決済時に適切な税額を自動計算できます。

商品と価格との関係

税率は、商品と価格と組み合わせて使用します。

現在、税率は Checkout v2 利用時の line_items の指定時のみで利用できます。

Checkout SessionAPIの line_items に価格と税率を指定することで、決済時に自動的に税額が計算されます。

税率は外税（税抜）または内税（税込）のいずれかが指定できます。これは、価格に税金を含めて表示するか、別途加算するかを制御するための設定です。

計算された税額は Checkout Session の line_items の amount_tax に表示されます。今後、税率は集計機能など様々な機能で利用可能になる予定です。

Checkout Session での使用例

商品、価格、税率を作成し、Checkout SessionAPIの line_items の tax_rates に指定することで税率を適用できます。

curl https://api.pay.jp/v2/checkout/sessions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "success_url": "https://example.com/success",
    "mode": "payment",
    "line_items": [
      {
        "price": "price_xxxxx",
        "quantity": 1,
        "tax_rates": ["txr_xxxxx"]
      }
    ]
  }'

税抜と税込

税率は、価格とは別に税率を加算する外税方式（税抜価格方式）か、価格に税率を含める内税方式（税込価格方式）かのいずれかを指定できます。 inclusive プロパティで、税金の計算方法を決定します。

税抜価格

価格とは別で税金を加算します。標準的な外税方式（税抜価格方式）です。

inclusive=false に設定することで、外税方式を指定できます。

curl https://api.pay.jp/v2/tax_rates \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "display_name": "消費税（外税10%）",
    "percentage": 10,
    "inclusive": false
  }'

税込価格

価格に税金が含まれているものとして計算します。総額表示に対応する内税方式（税込価格方式）です。

inclusive=true に設定することで、内税方式を指定できます。

curl https://api.pay.jp/v2/tax_rates \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "display_name": "消費税（内税10%）",
    "percentage": 10,
    "inclusive": true
  }'

注意点

作成後に変更できないプロパティ

過去の取引の正確性を保つため、以下のプロパティは作成後に変更できません。税率を変更する場合は新しい税率オブジェクトを作成する必要があります。

percentage （税率）
inclusive （税抜/税込）

無効化した税率の挙動

税率を無効化（active=false）した場合、Checkout Session など、支払いを作成する際に指定できなくなります。作成済みの支払いでは引き続き使用できます。

税額の端数処理

税額計算で端数が発生する場合、四捨五入での端数処理が適用されます。税額は常に整数値（円単位）で返されます。

税抜価格	税率	税額（端数処理前）	税額（端数処理後）
1,000円	10%	100.0円	100円
1,111円	10%	111.1円	111円
1,115円	10%	111.5円	112円

税率

On this page