Audit Events

Appearance

課金 ​

イベント一覧 ​

イベントリソース説明
billing.create_subscriptionbillingサブスクリプションが作成された。
billing.update_subscriptionbillingサブスクリプションが更新された。
billing.cancel_subscriptionbillingサブスクリプションが解約された。
billing.update_plan_for_freebilling無料プランのまま、プランまたは課金サイクルが変更された。
billing.update_plan_for_trialbillingトライアルプランのまま、プランまたは課金サイクルが変更された。
billing.create_portal_sessionbilling支払い情報を管理するカスタマーポータルのセッションが作成された。
billing.preview_updatebillingプラン変更内容のプレビューが取得された。

イベント詳細 ​

billing.create_subscription 準備中 ​

サブスクリプションが作成された。

フィールド値
event.codebilling.create_subscription
scope.typeworkspace
resource.typebilling
references（なし）
query（なし）
changeplan, billing_cycle
grant（なし）
extra（なし）

change ​

名前モード型必須説明
plan値string必須—
billing_cycle値string必須—

サンプル ​

json
{
  "event": {
    "code": "billing.create_subscription",
    ...
  },
  "scope": {
    "type": "workspace",
    ...
  },
  "resource": {
    "type": "billing",
    "uid": null,
    "name": null,
    "path": "billing",
    "parts": [
      {
        "type": "billing",
        "uid": null,
        "name": null
      }
    ],
    ...
  },
  "change": {
    "fields": [
      {
        "name": "plan",
        "new": "business"
      },
      {
        "name": "billing_cycle",
        "new": "monthly"
      }
    ]
  },
  ...
}

billing.update_subscription 準備中 ​

サブスクリプションが更新された。

フィールド値
event.codebilling.update_subscription
scope.typeworkspace
resource.typebilling
references（なし）
query（なし）
changeplan, billing_cycle
grant（なし）
extra（なし）

change ​

名前モード型必須説明
plan値string必須—
billing_cycle値string必須—

サンプル ​

json
{
  "event": {
    "code": "billing.update_subscription",
    ...
  },
  "scope": {
    "type": "workspace",
    ...
  },
  "resource": {
    "type": "billing",
    "uid": null,
    "name": null,
    "path": "billing",
    "parts": [
      {
        "type": "billing",
        "uid": null,
        "name": null
      }
    ],
    ...
  },
  "change": {
    "fields": [
      {
        "name": "plan",
        "old": "starter",
        "new": "business"
      },
      {
        "name": "billing_cycle",
        "old": "monthly",
        "new": "yearly"
      }
    ]
  },
  ...
}

billing.cancel_subscription 準備中 ​

サブスクリプションが解約された。

フィールド値
event.codebilling.cancel_subscription
scope.typeworkspace
resource.typebilling
references（なし）
query（なし）
changeplan, billing_cycle
grant（なし）
extra（なし）

change ​

名前モード型必須説明
plan値string必須—
billing_cycle値string必須—

サンプル ​

json
{
  "event": {
    "code": "billing.cancel_subscription",
    ...
  },
  "scope": {
    "type": "workspace",
    ...
  },
  "resource": {
    "type": "billing",
    "uid": null,
    "name": null,
    "path": "billing",
    "parts": [
      {
        "type": "billing",
        "uid": null,
        "name": null
      }
    ],
    ...
  },
  "change": {
    "fields": [
      {
        "name": "plan",
        "old": "business"
      },
      {
        "name": "billing_cycle",
        "old": "monthly"
      }
    ]
  },
  ...
}

billing.update_plan_for_free 準備中 ​

無料プランのまま、プランまたは課金サイクルが変更された。

フィールド値
event.codebilling.update_plan_for_free
scope.typeworkspace
resource.typebilling
references（なし）
query（なし）
changeplan, billing_cycle
grant（なし）
extra（なし）

change ​

名前モード型必須説明
plan値string必須—
billing_cycle値string必須—

サンプル ​

json
{
  "event": {
    "code": "billing.update_plan_for_free",
    ...
  },
  "scope": {
    "type": "workspace",
    ...
  },
  "resource": {
    "type": "billing",
    "uid": null,
    "name": null,
    "path": "billing",
    "parts": [
      {
        "type": "billing",
        "uid": null,
        "name": null
      }
    ],
    ...
  },
  "change": {
    "fields": [
      {
        "name": "plan",
        "old": "starter",
        "new": "business"
      },
      {
        "name": "billing_cycle",
        "old": "monthly",
        "new": "yearly"
      }
    ]
  },
  ...
}

billing.update_plan_for_trial 準備中 ​

トライアルプランのまま、プランまたは課金サイクルが変更された。

フィールド値
event.codebilling.update_plan_for_trial
scope.typeworkspace
resource.typebilling
references（なし）
query（なし）
changeplan, billing_cycle
grant（なし）
extra（なし）

change ​

名前モード型必須説明
plan値string必須—
billing_cycle値string必須—

サンプル ​

json
{
  "event": {
    "code": "billing.update_plan_for_trial",
    ...
  },
  "scope": {
    "type": "workspace",
    ...
  },
  "resource": {
    "type": "billing",
    "uid": null,
    "name": null,
    "path": "billing",
    "parts": [
      {
        "type": "billing",
        "uid": null,
        "name": null
      }
    ],
    ...
  },
  "change": {
    "fields": [
      {
        "name": "plan",
        "old": "starter",
        "new": "business"
      },
      {
        "name": "billing_cycle",
        "old": "monthly",
        "new": "yearly"
      }
    ]
  },
  ...
}

billing.create_portal_session 準備中 ​

支払い情報を管理するカスタマーポータルのセッションが作成された。

フィールド値
event.codebilling.create_portal_session
scope.typeworkspace
resource.typebilling
references（なし）
query（なし）
change（なし）
grant（なし）
extraflow_type, return_url

extra ​

名前型必須説明
flow_typestring必須カスタマーポータルで開くフローの種類
return_urlstring必須カスタマーポータルから戻る先の URL
sensitivity: pii

サンプル ​

json
{
  "event": {
    "code": "billing.create_portal_session",
    ...
  },
  "scope": {
    "type": "workspace",
    ...
  },
  "resource": {
    "type": "billing",
    "uid": null,
    "name": null,
    "path": "billing",
    "parts": [
      {
        "type": "billing",
        "uid": null,
        "name": null
      }
    ],
    ...
  },
  "extra": {
    "flow_type": "subscription_update",
    "return_url": "https://app.example.com/settings"
  },
  ...
}

billing.preview_update 準備中 ​

プラン変更内容のプレビューが取得された。

フィールド値
event.codebilling.preview_update
scope.typeworkspace
resource.typebilling
references（なし）
query（なし）
change（なし）
grant（なし）
extraplan, billing_cycle

extra ​

名前型必須説明
planstring必須プレビュー対象のプラン。実際の契約は変更されません。
billing_cyclestring必須プレビュー対象の課金サイクル。実際の契約は変更されません。

サンプル ​

json
{
  "event": {
    "code": "billing.preview_update",
    ...
  },
  "scope": {
    "type": "workspace",
    ...
  },
  "resource": {
    "type": "billing",
    "uid": null,
    "name": null,
    "path": "billing",
    "parts": [
      {
        "type": "billing",
        "uid": null,
        "name": null
      }
    ],
    ...
  },
  "extra": {
    "plan": "business",
    "billing_cycle": "monthly"
  },
  ...
}

Codatum Audit Events 監査ログイベントカタログ

© Codatum Inc.