Pricing API

• pricingUnits
  • getプライシングユニットの一覧を取得
  • postプライシングユニットを作成
  • getプライシングユニットを取得
  • delプライシングユニットを削除
  • patchプライシングユニットを更新
• pricingMenus
  • getプライシング機能メニュー一覧を取得
  • postプライシング機能メニューを作成
  • getプライシング機能メニューを取得
  • delプライシング機能メニューを削除
  • patchプライシング機能メニューを更新
• pricingPlans
  • get料金プラン一覧を取得
  • post料金プランを作成
  • get料金プランを取得
  • del料金プランを削除
  • patch料金プランを更新
  • patch使用済みフラグ更新
  • patchstripe連携
  • delstripe上の商品情報を削除
  • del全てのPlans,Menus,Units,Metersの削除
• metering
  • get指定した日付のメータリングユニットカウントを取得
  • put指定したタイムスタンプのメータリングユニットカウントを更新
  • del指定したタイムスタンプのメータリングユニットカウントを削除
  • get当日のメータリングユニットカウントを取得
  • put現在時刻のメータリングユニットカウントを更新
  • get当月のメータリングユニットカウントを取得
  • get指定月のメータリングユニットカウントを取得
  • get指定日の全メータリングユニットカウントを取得
  • get指定月の全メータリングユニットカウントを取得
  • get指定した日時期間のメータリングユニットカウントを取得
  • postメータリングユニットの作成
  • getメータリングユニットを取得
  • patchメータリングユニットを更新
  • delメータリングユニットを削除
• taxRate
  • post税率の作成
  • get税率を取得します
  • patch税率を更新
• error
  • getステータスコード500でサーバーエラーを返却

API docs by Redocly

SaaSus Pricing API Schema (1.0.0)

SaaSus Pricing API Schema

pricingUnits

プライシングユニット

プライシングユニットの一覧を取得

料金のベースとなる最小の計測単位を取得します。 「固定ユニット」(type=fixed)は基本料金などの月額固定料金の単位、 「使用量ユニット」(type=usage)はユーザ数課金などの１単位あたりごとに料金が発生する単位、 「段階ユニット」(type=tiered)は携帯電話の段階的パケット料金のように利用量の段階ごとに一定の料金の単位、 「段階的使用量ユニット」(type=tiered_usage)はボリュームディスカウントのように利用量に応じて１単位あたりの料金が変化していく単位、となります。

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/pricing/units

Response samples

• 200
• 500

Content type

application/json

{

• "units": [

  • {

    • "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
    • "metering_unit_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
    • "recurring_interval": "month",
    • "used": false,
    • "upper_count": 100,
    • "metering_unit_name": "test_unit",
    • "aggregate_usage": "sum",
    • "name": "storage_unit",
    • "display_name": "ストレージユニット",
    • "description": "KB unit for storage usage",
    • "type": "fixed",
    • "currency": "JPY",
    • "tiers": [

      • {

        • "up_to": 5,
        • "unit_amount": 1000,
        • "flat_amount": 500,
        • "inf": true

        }

      ]

    }

  ]

}

プライシングユニットを作成

プライシングユニットを作成します。

Authorizations:

Bearer

Request Body schema: application/json

upper_count required	integer 上限値
metering_unit_name required	string 計測ユニット名
aggregate_usage	string (AggregateUsage) Enum: "sum" "max" 使用量の集計方法 sum: 期間内の使用量の合計 max: 期間内の使用量の最大値
name required	string 名前
display_name required	string 表示名
description required	string 説明
type required	string (UnitType) 計測単位の種別 fixed: 固定ユニット usage: 使用量ユニット tiered: 段階ユニット tiered_usage: 段階的使用量ユニット fixedusagetieredtiered_usagetiered_usage
currency required	string (Currency) Enum: "JPY" "USD" 計測単位の通貨
required	Array of objects (従量課金情報)

Responses

Production API Server

https://api.saasus.io/v1/pricing/units

Request samples

• Payload

Content type

application/json

Example

tiered_usagetieredusagefixedtiered_usage

{

• "upper_count": 100,
• "metering_unit_name": "test_unit",
• "aggregate_usage": "sum",
• "name": "storage_unit",
• "display_name": "ストレージユニット",
• "description": "KB unit for storage usage",
• "type": "tiered_usage",
• "currency": "JPY",
• "tiers": [

  • {

    • "up_to": 5,
    • "unit_amount": 1000,
    • "flat_amount": 500,
    • "inf": true

    }

  ]

}

Response samples

• 201
• 500

Content type

application/json

Example

tiered_usagetieredusagefixedtiered_usage

{

• "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "metering_unit_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "recurring_interval": "month",
• "used": false,
• "upper_count": 100,
• "metering_unit_name": "test_unit",
• "aggregate_usage": "sum",
• "name": "storage_unit",
• "display_name": "ストレージユニット",
• "description": "KB unit for storage usage",
• "type": "tiered_usage",
• "currency": "JPY",
• "tiers": [

  • {

    • "up_to": 5,
    • "unit_amount": 1000,
    • "flat_amount": 500,
    • "inf": true

    }

  ]

}

プライシングユニットを取得

プライシングユニットを取得します。

Authorizations:

Bearer

path Parameters

pricing_unit_id required

string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775 ユニットID

Responses

Production API Server

https://api.saasus.io/v1/pricing/units/{pricing_unit_id}

Response samples

• 200
• 500

Content type

application/json

Example

tiered_usagetieredusagefixedtiered_usage

{

• "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "metering_unit_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "recurring_interval": "month",
• "used": false,
• "upper_count": 100,
• "metering_unit_name": "test_unit",
• "aggregate_usage": "sum",
• "name": "storage_unit",
• "display_name": "ストレージユニット",
• "description": "KB unit for storage usage",
• "type": "tiered_usage",
• "currency": "JPY",
• "tiers": [

  • {

    • "up_to": 5,
    • "unit_amount": 1000,
    • "flat_amount": 500,
    • "inf": true

    }

  ]

}

プライシングユニットを削除

プライシングユニットを削除します。

Authorizations:

Bearer

path Parameters

pricing_unit_id required

string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775 ユニットID

Responses

Production API Server

https://api.saasus.io/v1/pricing/units/{pricing_unit_id}

Response samples

• 500

Content type

application/json

{

• "type": "string",
• "message": "string"

}

プライシングユニットを更新

プライシングユニット情報を更新します。

Authorizations:

Bearer

path Parameters

pricing_unit_id required

string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775 ユニットID

Request Body schema: application/json

upper_count required	integer 上限値
metering_unit_name required	string 計測ユニット名
aggregate_usage	string (AggregateUsage) Enum: "sum" "max" 使用量の集計方法 sum: 期間内の使用量の合計 max: 期間内の使用量の最大値
name required	string 名前
display_name required	string 表示名
description required	string 説明
type required	string (UnitType) 計測単位の種別 fixed: 固定ユニット usage: 使用量ユニット tiered: 段階ユニット tiered_usage: 段階的使用量ユニット fixedusagetieredtiered_usagetiered_usage
currency required	string (Currency) Enum: "JPY" "USD" 計測単位の通貨
required	Array of objects (従量課金情報)

Responses

Production API Server

https://api.saasus.io/v1/pricing/units/{pricing_unit_id}

Request samples

• Payload

Content type

application/json

Example

tiered_usagetieredusagefixedtiered_usage

{

• "upper_count": 100,
• "metering_unit_name": "test_unit",
• "aggregate_usage": "sum",
• "name": "storage_unit",
• "display_name": "ストレージユニット",
• "description": "KB unit for storage usage",
• "type": "tiered_usage",
• "currency": "JPY",
• "tiers": [

  • {

    • "up_to": 5,
    • "unit_amount": 1000,
    • "flat_amount": 500,
    • "inf": true

    }

  ]

}

Response samples

• 500

Content type

application/json

{

• "type": "string",
• "message": "string"

}

pricingMenus

プライシング機能メニュー

プライシング機能メニュー一覧を取得

機能メニュー一覧を取得します。計測単位を複数まとめて、１つの機能メニューとして定義します。ここで定義した機能メニューを複数合わせ１つの料金プランとします。

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/pricing/menus

Response samples

• 200
• 500

Content type

application/json

{

• "pricing_menus": [

  • {

    • "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
    • "name": "Ten Users Menu",
    • "display_name": "10ユーザーメニュー",
    • "description": "Can use 10 users.",
    • "used": false,
    • "units": [

      • {

        • "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
        • "metering_unit_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
        • "recurring_interval": "month",
        • "used": false,
        • "upper_count": 100,
        • "metering_unit_name": "test_unit",
        • "aggregate_usage": "sum",
        • "name": "storage_unit",
        • "display_name": "ストレージユニット",
        • "description": "KB unit for storage usage",
        • "type": "fixed",
        • "currency": "JPY",
        • "tiers": [

          • {

            • "up_to": 5,
            • "unit_amount": 1000,
            • "flat_amount": 500,
            • "inf": true

            }

          ]

        }

      ]

    }

  ]

}

プライシング機能メニューを作成

プライシング機能メニューを作成します。

Authorizations:

Bearer

Request Body schema: application/json

name required	string メニュー名
display_name required	string メニュー表示名
description required	string メニュー説明
unit_ids required	Array of strings (Uuid) 追加するユニットID

Responses

Production API Server

https://api.saasus.io/v1/pricing/menus

Request samples

• Payload

Content type

application/json

{

• "name": "Ten Users Menu",
• "display_name": "10ユーザーメニュー",
• "description": "Can use 10 users.",
• "unit_ids": [

  • "69e732d6-8ecc-45c4-c2eb-8438f7ffe775"

  ]

}

Response samples

• 201
• 500

Content type

application/json

{

• "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "name": "Ten Users Menu",
• "display_name": "10ユーザーメニュー",
• "description": "Can use 10 users.",
• "used": false,
• "units": [

  • {

    • "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
    • "metering_unit_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
    • "recurring_interval": "month",
    • "used": false,
    • "upper_count": 100,
    • "metering_unit_name": "test_unit",
    • "aggregate_usage": "sum",
    • "name": "storage_unit",
    • "display_name": "ストレージユニット",
    • "description": "KB unit for storage usage",
    • "type": "fixed",
    • "currency": "JPY",
    • "tiers": [

      • {

        • "up_to": 5,
        • "unit_amount": 1000,
        • "flat_amount": 500,
        • "inf": true

        }

      ]

    }

  ]

}

プライシング機能メニューを取得

プライシング機能メニューを取得します。

Authorizations:

Bearer

path Parameters

menu_id required

string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775 メニューID

Responses

Production API Server

https://api.saasus.io/v1/pricing/menus/{menu_id}

Response samples

• 200
• 500

Content type

application/json

{

• "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "name": "Ten Users Menu",
• "display_name": "10ユーザーメニュー",
• "description": "Can use 10 users.",
• "used": false,
• "units": [

  • {

    • "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
    • "metering_unit_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
    • "recurring_interval": "month",
    • "used": false,
    • "upper_count": 100,
    • "metering_unit_name": "test_unit",
    • "aggregate_usage": "sum",
    • "name": "storage_unit",
    • "display_name": "ストレージユニット",
    • "description": "KB unit for storage usage",
    • "type": "fixed",
    • "currency": "JPY",
    • "tiers": [

      • {

        • "up_to": 5,
        • "unit_amount": 1000,
        • "flat_amount": 500,
        • "inf": true

        }

      ]

    }

  ]

}

プライシング機能メニューを削除

プライシング機能メニューを削除します。

Authorizations:

Bearer

path Parameters

menu_id required

string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775 メニューID

Responses

Production API Server

https://api.saasus.io/v1/pricing/menus/{menu_id}

Response samples

• 404
• 500

Content type

application/json

{

• "type": "string",
• "message": "string"

}

プライシング機能メニューを更新

プライシング機能メニューを更新します。

Authorizations:

Bearer

path Parameters

menu_id required

string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775 メニューID

Request Body schema: application/json

name required	string メニュー名
display_name required	string メニュー表示名
description required	string メニュー説明
unit_ids required	Array of strings (Uuid) 追加するユニットID

Responses

Production API Server

https://api.saasus.io/v1/pricing/menus/{menu_id}

Request samples

• Payload

Content type

application/json

{

• "name": "Ten Users Menu",
• "display_name": "10ユーザーメニュー",
• "description": "Can use 10 users.",
• "unit_ids": [

  • "69e732d6-8ecc-45c4-c2eb-8438f7ffe775"

  ]

}

Response samples

• 500

Content type

application/json

{

• "type": "string",
• "message": "string"

}

pricingPlans

料金プラン

料金プラン一覧を取得

料金プラン一覧を取得します。機能メニューを複数まとめて、１つの料金プランとして定義します。ここで定義した料金プランを各テナントは選ぶことができます。もし特定テナント特有の料金（プライベートプライシング）がある場合は、そのテナント専用の料金プランを作成して結びつけます。

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/pricing/plans

Response samples

• 200
• 500

Content type

application/json

{

• "pricing_plans": [

  • {

    • "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
    • "name": "Standard Plan",
    • "display_name": "スタンダードプラン",
    • "description": "Standard Plan for normal use",
    • "used": false,
    • "pricing_menus": [

      • {

        • "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
        • "name": "Ten Users Menu",
        • "display_name": "10ユーザーメニュー",
        • "description": "Can use 10 users.",
        • "used": false,
        • "units": [

          • {

            • "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
            • "metering_unit_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
            • "recurring_interval": "month",
            • "used": false,
            • "upper_count": 100,
            • "metering_unit_name": "test_unit",
            • "aggregate_usage": "sum",
            • "name": "storage_unit",
            • "display_name": "ストレージユニット",
            • "description": "KB unit for storage usage",
            • "type": "fixed",
            • "currency": "JPY",
            • "tiers": [

              • {

                • "up_to": 5,
                • "unit_amount": 1000,
                • "flat_amount": 500,
                • "inf": true

                }

              ]

            }

          ]

        }

      ]

    }

  ]

}

料金プランを作成

料金プランを作成します。

Authorizations:

Bearer

Request Body schema: application/json

name required	string 料金プラン名
display_name required	string 料金プラン表示名
description required	string 料金プラン説明
menu_ids required	Array of strings (Uuid) メニューID（料金プランに追加するメニューID）

Responses

Production API Server

https://api.saasus.io/v1/pricing/plans

Request samples

• Payload

Content type

application/json

{

• "name": "Standard Plan",
• "display_name": "スタンダードプラン",
• "description": "Standard Plan for normal use",
• "menu_ids": [

  • "69e732d6-8ecc-45c4-c2eb-8438f7ffe775"

  ]

}

Response samples

• 201
• 500

Content type

application/json

{

• "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "name": "Standard Plan",
• "display_name": "スタンダードプラン",
• "description": "Standard Plan for normal use",
• "used": false,
• "pricing_menus": [

  • {

    • "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
    • "name": "Ten Users Menu",
    • "display_name": "10ユーザーメニュー",
    • "description": "Can use 10 users.",
    • "used": false,
    • "units": [

      • {

        • "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
        • "metering_unit_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
        • "recurring_interval": "month",
        • "used": false,
        • "upper_count": 100,
        • "metering_unit_name": "test_unit",
        • "aggregate_usage": "sum",
        • "name": "storage_unit",
        • "display_name": "ストレージユニット",
        • "description": "KB unit for storage usage",
        • "type": "fixed",
        • "currency": "JPY",
        • "tiers": [

          • {

            • "up_to": 5,
            • "unit_amount": 1000,
            • "flat_amount": 500,
            • "inf": true

            }

          ]

        }

      ]

    }

  ]

}

料金プランを取得

料金プランを取得します。

Authorizations:

Bearer

path Parameters

plan_id required

string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775 料金プランID

Responses

Production API Server

https://api.saasus.io/v1/pricing/plans/{plan_id}

Response samples

• 200
• 500

Content type

application/json

{

• "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "name": "Standard Plan",
• "display_name": "スタンダードプラン",
• "description": "Standard Plan for normal use",
• "used": false,
• "pricing_menus": [

  • {

    • "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
    • "name": "Ten Users Menu",
    • "display_name": "10ユーザーメニュー",
    • "description": "Can use 10 users.",
    • "used": false,
    • "units": [

      • {

        • "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
        • "metering_unit_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
        • "recurring_interval": "month",
        • "used": false,
        • "upper_count": 100,
        • "metering_unit_name": "test_unit",
        • "aggregate_usage": "sum",
        • "name": "storage_unit",
        • "display_name": "ストレージユニット",
        • "description": "KB unit for storage usage",
        • "type": "fixed",
        • "currency": "JPY",
        • "tiers": [

          • {

            • "up_to": 5,
            • "unit_amount": 1000,
            • "flat_amount": 500,
            • "inf": true

            }

          ]

        }

      ]

    }

  ]

}

料金プランを削除

料金プランを削除します。

Authorizations:

Bearer

path Parameters

plan_id required

string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775 料金プランID

Responses

Production API Server

https://api.saasus.io/v1/pricing/plans/{plan_id}

Response samples

• 404
• 500

Content type

application/json

{

• "type": "string",
• "message": "string"

}

料金プランを更新

料金プランを更新します。

Authorizations:

Bearer

path Parameters

plan_id required

string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775 料金プランID

Request Body schema: application/json

name required	string 料金プラン名
display_name required	string 料金プラン表示名
description required	string 料金プラン説明
menu_ids required	Array of strings (Uuid) メニューID（料金プランに追加するメニューID）

Responses

Production API Server

https://api.saasus.io/v1/pricing/plans/{plan_id}

Request samples

• Payload

Content type

application/json

{

• "name": "Standard Plan",
• "display_name": "スタンダードプラン",
• "description": "Standard Plan for normal use",
• "menu_ids": [

  • "69e732d6-8ecc-45c4-c2eb-8438f7ffe775"

  ]

}

Response samples

• 500

Content type

application/json

{

• "type": "string",
• "message": "string"

}

使用済みフラグ更新

料金プランと配下のメニュー・ユニットを使用済みに更新します。

Authorizations:

Bearer

Request Body schema: application/json

plan_ids required

Array of strings (Uuid)

Responses

Production API Server

https://api.saasus.io/v1/pricing/plans/used

Request samples

• Payload

Content type

application/json

{

• "plan_ids": [

  • "69e732d6-8ecc-45c4-c2eb-8438f7ffe775"

  ]

}

Response samples

• 500

Content type

application/json

{

• "type": "string",
• "message": "string"

}

stripe連携

stripeへ情報を連携します。

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/pricing/stripe/init

Response samples

• 500

Content type

application/json

{

• "type": "string",
• "message": "string"

}

stripe上の商品情報を削除

stripe上の商品情報を削除します。

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/pricing/stripe

Response samples

• 500

Content type

application/json

{

• "type": "string",
• "message": "string"

}

全てのPlans,Menus,Units,Metersの削除

無条件に全料金プラン、メニュー、ユニット、メーター、税率を削除します。

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/pricing/plans-initialization

Response samples

• 500

Content type

application/json

{

• "type": "string",
• "message": "string"

}

metering

計測

指定した日付のメータリングユニットカウントを取得

指定した日付のメータリングユニットカウントを取得します。

Authorizations:

Bearer

path Parameters

tenant_id required	string Example: 46af35b5-60de-4cd8-9412-19a3a5d1f838 テナントID
metering_unit_name required	string Example: storage_unit 計測ユニット名
date required	string Example: 2022-01-01 日

Responses

Production API Server

https://api.saasus.io/v1/pricing/metering/tenants/{tenant_id}/units/{metering_unit_name}/date/{date}

Response samples

• 200
• 500

Content type

application/json

{

• "metering_unit_name": "storage_unit",
• "date": "2022-01-01",
• "count": 10000

}

指定したタイムスタンプのメータリングユニットカウントを更新

指定したタイムスタンプのメータリングユニットカウントを更新します。

Authorizations:

Bearer

path Parameters

tenant_id required	string Example: 46af35b5-60de-4cd8-9412-19a3a5d1f838 テナントID
metering_unit_name required	string Example: storage_unit 計測ユニット名
timestamp required	integer Example: 1640995200 タイムスタンプ

Request Body schema: application/json

method required	string (メータリングユニットカウント更新方法) Enum: "add" "sub" "direct" 更新方法 add: 加算 sub: 減算 direct: 上書き
count required	integer 件数

Responses

Production API Server

https://api.saasus.io/v1/pricing/metering/tenants/{tenant_id}/units/{metering_unit_name}/timestamp/{timestamp}

Request samples

• Payload

Content type

application/json

{

• "method": "add",
• "count": 10000

}

Response samples

• 200
• 500

Content type

application/json

{

• "metering_unit_name": "storage_unit",
• "timestamp": 1640995200,
• "count": 10000

}

指定したタイムスタンプのメータリングユニットカウントを削除

指定したタイムスタンプのメータリングユニットカウントを削除します。

Authorizations:

Bearer

path Parameters

tenant_id required	string Example: 46af35b5-60de-4cd8-9412-19a3a5d1f838 テナントID
metering_unit_name required	string Example: storage_unit 計測ユニット名
timestamp required	integer Example: 1640995200 タイムスタンプ

Responses

Production API Server

https://api.saasus.io/v1/pricing/metering/tenants/{tenant_id}/units/{metering_unit_name}/timestamp/{timestamp}

Response samples

• 500

Content type

application/json

{

• "type": "string",
• "message": "string"

}

当日のメータリングユニットカウントを取得

当日のメータリングユニットカウントを取得します。

Authorizations:

Bearer

path Parameters

tenant_id required	string Example: 46af35b5-60de-4cd8-9412-19a3a5d1f838 テナントID
metering_unit_name required	string Example: storage_unit 計測ユニット名

Responses

Production API Server

https://api.saasus.io/v1/pricing/metering/tenants/{tenant_id}/units/{metering_unit_name}/today

Response samples

• 200
• 500

Content type

application/json

{

• "metering_unit_name": "storage_unit",
• "date": "2022-01-01",
• "count": 10000

}

現在時刻のメータリングユニットカウントを更新

現在時刻のメータリングユニットカウントを更新します。

Authorizations:

Bearer

path Parameters

tenant_id required	string Example: 46af35b5-60de-4cd8-9412-19a3a5d1f838 テナントID
metering_unit_name required	string Example: storage_unit 計測ユニット名

Request Body schema: application/json

method required	string (メータリングユニットカウント更新方法) Enum: "add" "sub" "direct" 更新方法 add: 加算 sub: 減算 direct: 上書き
count required	integer 件数

Responses

Production API Server

https://api.saasus.io/v1/pricing/metering/tenants/{tenant_id}/units/{metering_unit_name}/now

Request samples

• Payload

Content type

application/json

{

• "method": "add",
• "count": 10000

}

Response samples

• 200
• 500

Content type

application/json

{

• "metering_unit_name": "storage_unit",
• "timestamp": 1640995200,
• "count": 10000

}

当月のメータリングユニットカウントを取得

当月のメータリングユニットカウントを取得します。

Authorizations:

Bearer

path Parameters

tenant_id required	string Example: 46af35b5-60de-4cd8-9412-19a3a5d1f838 テナントID
metering_unit_name required	string Example: storage_unit 計測ユニット名

Responses

Production API Server

https://api.saasus.io/v1/pricing/metering/tenants/{tenant_id}/units/{metering_unit_name}/thismonth

Response samples

• 200
• 500

Content type

application/json

{

• "metering_unit_name": "storage_unit",
• "month": "2022-05",
• "count": 10000

}

指定月のメータリングユニットカウントを取得

指定した月のメータリングユニットカウントを取得します。

Authorizations:

Bearer

path Parameters

tenant_id required	string Example: 46af35b5-60de-4cd8-9412-19a3a5d1f838 テナントID
metering_unit_name required	string Example: storage_unit 計測ユニット名
month required	string Example: 2022-01 月

Responses

Production API Server

https://api.saasus.io/v1/pricing/metering/tenants/{tenant_id}/units/{metering_unit_name}/month/{month}

Response samples

• 200
• 500

Content type

application/json

{

• "metering_unit_name": "storage_unit",
• "month": "2022-05",
• "count": 10000

}

指定日の全メータリングユニットカウントを取得

指定した日の全メータリングユニットカウントを取得します。

Authorizations:

Bearer

path Parameters

tenant_id required	string Example: 46af35b5-60de-4cd8-9412-19a3a5d1f838 テナントID
date required	string Example: 2022-01-01 日

Responses

Production API Server

https://api.saasus.io/v1/pricing/metering/tenants/{tenant_id}/units/date/{date}

Response samples

• 200
• 500

Content type

application/json

{

• "counts": [

  • {

    • "metering_unit_name": "storage_unit",
    • "date": "2022-01-01",
    • "count": 10000

    }

  ]

}

指定月の全メータリングユニットカウントを取得

指定した月の全メータリングユニットカウントを取得します。

Authorizations:

Bearer

path Parameters

tenant_id required	string Example: 46af35b5-60de-4cd8-9412-19a3a5d1f838 テナントID
month required	string Example: 2022-01 月

Responses

Production API Server

https://api.saasus.io/v1/pricing/metering/tenants/{tenant_id}/units/month/{month}

Response samples

• 200
• 500

Content type

application/json

{

• "counts": [

  • {

    • "metering_unit_name": "storage_unit",
    • "month": "2022-05",
    • "count": 10000

    }

  ]

}

指定した日時期間のメータリングユニットカウントを取得

指定した日時期間のメータリングユニットカウントを取得します。

Authorizations:

Bearer

path Parameters

tenant_id required	string Example: 46af35b5-60de-4cd8-9412-19a3a5d1f838 テナントID
metering_unit_name required	string Example: storage_unit 計測ユニット名

query Parameters

start_timestamp	integer Example: start_timestamp=1640995200 開始日時
end_timestamp	integer Example: end_timestamp=1640995200 終了日時

Responses

Production API Server

https://api.saasus.io/v1/pricing/metering/tenants/{tenant_id}/units/{metering_unit_name}/date-period

Response samples

• 200
• 500

Content type

application/json

{

• "metering_unit_name": "storage_unit",
• "counts": [

  • {

    • "timestamp": 1640995200,
    • "count": 10000

    }

  ]

}

メータリングユニットの作成

メータリングユニットを作成します。

Authorizations:

Bearer

Request Body schema: application/json

unit_name required	string 計測ユニット名
aggregate_usage	string (AggregateUsage) Enum: "sum" "max" 使用量の集計方法 sum: 期間内の使用量の合計 max: 期間内の使用量の最大値
display_name required	string 表示名
description required	string 説明

Responses

Production API Server

https://api.saasus.io/v1/pricing/metering/units

Request samples

• Payload

Content type

application/json

{

• "unit_name": "storage_unit",
• "aggregate_usage": "sum",
• "display_name": "User Count Meter",
• "description": "Number of users count"

}

Response samples

• 201
• 400
• 500

Content type

application/json

{

• "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "used": false,
• "unit_name": "storage_unit",
• "aggregate_usage": "sum",
• "display_name": "User Count Meter",
• "description": "Number of users count"

}

メータリングユニットを取得

全てのメータリングユニットを取得します。

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/pricing/metering/units

Response samples

• 200
• 500

Content type

application/json

{

• "units": [

  • {

    • "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
    • "used": false,
    • "unit_name": "storage_unit",
    • "aggregate_usage": "sum",
    • "display_name": "User Count Meter",
    • "description": "Number of users count"

    }

  ]

}

メータリングユニットを更新

メータリングユニットを更新します。

Authorizations:

Bearer

path Parameters

metering_unit_id required

string Example: 46af35b5-60de-4cd8-9412-19a3a5d1f838 メータリングユニットID

Request Body schema: application/json

unit_name required	string 計測ユニット名
aggregate_usage	string (AggregateUsage) Enum: "sum" "max" 使用量の集計方法 sum: 期間内の使用量の合計 max: 期間内の使用量の最大値
display_name required	string 表示名
description required	string 説明

Responses

Production API Server

https://api.saasus.io/v1/pricing/metering/units/{metering_unit_id}

Request samples

• Payload

Content type

application/json

{

• "unit_name": "storage_unit",
• "aggregate_usage": "sum",
• "display_name": "User Count Meter",
• "description": "Number of users count"

}

Response samples

• 400
• 500

Content type

application/json

{

• "type": "string",
• "message": "string"

}

メータリングユニットを削除

メータリングユニットを削除します。

Authorizations:

Bearer

path Parameters

metering_unit_id required

string Example: 46af35b5-60de-4cd8-9412-19a3a5d1f838 メータリングユニットID

Responses

Production API Server

https://api.saasus.io/v1/pricing/metering/units/{metering_unit_id}

Response samples

• 404
• 500

Content type

application/json

{

• "type": "string",
• "message": "string"

}

taxRate

税率

税率の作成

税率を作成します。

Authorizations:

Bearer

Request Body schema: application/json

name required	string 税率の名前
display_name required	string 表示名
percentage required	number 税率
inclusive required	boolean 内税かどうか
country required	string^[A-Z]{2}$ ISO 3166-1 alpha-2 の国コード
description required	string 説明

Responses

Production API Server

https://api.saasus.io/v1/pricing/tax-rates

Request samples

• Payload

Content type

application/json

{

• "name": "japanese_consumption_tax_inclusive",
• "display_name": "消費税(外税)",
• "percentage": 10,
• "inclusive": false,
• "country": "JP",
• "description": "SaaSusとの連携用の税率"

}

Response samples

• 201
• 400
• 500

Content type

application/json

{

• "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "name": "japanese_consumption_tax_inclusive",
• "display_name": "消費税(外税)",
• "percentage": 10,
• "inclusive": false,
• "country": "JP",
• "description": "SaaSusとの連携用の税率"

}

税率を取得します

税率を取得します。

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/pricing/tax-rates

Response samples

• 200
• 500

Content type

application/json

{

• "tax_rates": [

  • {

    • "id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
    • "name": "japanese_consumption_tax_inclusive",
    • "display_name": "消費税(外税)",
    • "percentage": 10,
    • "inclusive": false,
    • "country": "JP",
    • "description": "SaaSusとの連携用の税率"

    }

  ]

}

税率を更新

税率を更新します。

Authorizations:

Bearer

path Parameters

tax_rate_id required

string (Uuid) Example: 69e732d6-8ecc-45c4-c2eb-8438f7ffe775 税率ID

Request Body schema: application/json

display_name required	string 表示名
description required	string 説明

Responses

Production API Server

https://api.saasus.io/v1/pricing/tax-rates/{tax_rate_id}

Request samples

• Payload

Content type

application/json

{

• "display_name": "消費税(外税)",
• "description": "SaaSusとの連携用の税率"

}

Response samples

• 400
• 500

Content type

application/json

{

• "type": "string",
• "message": "string"

}

error

テスト用途のエラー

ステータスコード500でサーバーエラーを返却

テスト用途で使用するエンドポイントです。ステータスコード500でサーバーエラーを返却します。

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/pricing/errors/internal-server-error

Response samples

• 500

Content type

application/json

{

• "type": "string",
• "message": "string"

}