帳號與工作空間

取得帳務狀態

讀取使用者的帳務方案、付款狀態、目前週期日期及配額用量（成功發布、待處理排程貼文、已連結帳號）。大量排程前請先檢查。

POST /identity-api/billing/status

契約檢閱日期： 2026-10-21 · sha256:563d2d581da0ad29

閱讀 Markdown 下載公開契約下載 OpenAPI

概覽

讀取使用者的帳務方案、付款狀態、目前週期日期及配額用量（成功發布、待處理排程貼文、已連結帳號）。大量排程前請先檢查。

成功 HTTP 回應可能表示請求已接受，並非已完成。背景工作請儲存回傳 ID，持續檢查同一操作直到完成。已排程或已接受的貼文，只有平台確認後才算已發布；用戶端逾時無法證明結果。

驗證與權限

接受的憑證類別: user_session, delegated_oauth, personal_access_token
委派能力: agent:operate
最低工作空間角色: 此契約沒有最低工作空間角色要求；擁有權與授權檢查仍然適用。
存取範圍: 此使用者有權存取的資源
需要所有工作空間同意: 否
變更狀態: 否
操作完成時: synchronous_http_response

權杖只能使用其擁有者持有的權利。每次請求會檢查工作空間成員資格、資源擁有權、所選工作空間及已授予能力。core 與 full 設定檔只變更顯示的工具，不會授予存取權。

請求欄位

「必填」是指在其父物件及所選分支內必填。必填子欄位不會使選填父物件變成必填。下列規則與欄位名稱均複製自契約。

請求欄位
欄位 / 分支	類型 / 必填	約束
`$`	`object`在父物件中必填	`additionalProperties: false`

完整 JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

回應與完成

成功 HTTP 狀態：200。操作完成時： synchronous_http_response.

「必填」是指在其父物件及所選分支內必填。必填子欄位不會使選填父物件變成必填。下列規則與欄位名稱均複製自契約。

回應與完成
欄位 / 分支	類型 / 必填	約束
`$`	`object`在父物件中必填	—
`billing_account_id`	`string`在父物件中必填	`format: "uuid"` `pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}\|00000000-0000-0000-0000-000000000000\|ffffffff-ffff-ffff-ffff-ffffffffffff)$"`
`plan_key`	`string`在父物件中必填	`enum: ["free","founding_pro"]`
`plan_version`	`integer`在父物件中必填	`maximum: 9007199254740991` `exclusiveMinimum: 0`
`payment_state`	`string`在父物件中必填	`minLength: 1` `maxLength: 64`
`entitlement_source`	`string`在父物件中必填	`enum: ["default","stripe","internal_test","reconciliation","manual"]`
`has_stripe_customer`	`boolean`在父物件中必填	—
`checkout_enabled`	`boolean`在父物件中必填	—
`cycle`	`object`在父物件中必填	—
`cycle.period_start`	`string`在父物件中必填	`format: "date-time"` `pattern: "^(?:(?:\\d\\d[2468][048]\|\\d\\d[13579][26]\|\\d\\d0[48]\|[02468][048]00\|[13579][26]00)-02-29\|\\d{4}-(?:(?:0[13578]\|1[02])-(?:0[1-9]\|[12]\\d\|3[01])\|(?:0[469]\|11)-(?:0[1-9]\|[12]\\d\|30)\|(?:02)-(?:0[1-9]\|1\\d\|2[0-8])))T(?:(?:[01]\\d\|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z\|([+-](?:[01]\\d\|2[0-3]):[0-5]\\d)))$"`
`cycle.period_end`	`string`在父物件中必填	`format: "date-time"` `pattern: "^(?:(?:\\d\\d[2468][048]\|\\d\\d[13579][26]\|\\d\\d0[48]\|[02468][048]00\|[13579][26]00)-02-29\|\\d{4}-(?:(?:0[13578]\|1[02])-(?:0[1-9]\|[12]\\d\|3[01])\|(?:0[469]\|11)-(?:0[1-9]\|[12]\\d\|30)\|(?:02)-(?:0[1-9]\|1\\d\|2[0-8])))T(?:(?:[01]\\d\|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z\|([+-](?:[01]\\d\|2[0-3]):[0-5]\\d)))$"`
`cycle.reset_at`	`string`在父物件中必填	`format: "date-time"` `pattern: "^(?:(?:\\d\\d[2468][048]\|\\d\\d[13579][26]\|\\d\\d0[48]\|[02468][048]00\|[13579][26]00)-02-29\|\\d{4}-(?:(?:0[13578]\|1[02])-(?:0[1-9]\|[12]\\d\|3[01])\|(?:0[469]\|11)-(?:0[1-9]\|[12]\\d\|30)\|(?:02)-(?:0[1-9]\|1\\d\|2[0-8])))T(?:(?:[01]\\d\|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z\|([+-](?:[01]\\d\|2[0-3]):[0-5]\\d)))$"`
`quota`	`object`在父物件中必填	—
`quota.successful_destination_publishes`	`object`在父物件中必填	—
`quota.successful_destination_publishes.limit`	`integer`在父物件中必填	`minimum: 0` `maximum: 9007199254740991`
`quota.successful_destination_publishes.reserved`	`integer`在父物件中必填	`minimum: 0` `maximum: 9007199254740991`
`quota.successful_destination_publishes.consumed`	`integer`在父物件中必填	`minimum: 0` `maximum: 9007199254740991`
`quota.successful_destination_publishes.remaining`	`integer`在父物件中必填	`minimum: 0` `maximum: 9007199254740991`
`quota.pending_scheduled_posts`	`object`在父物件中必填	—
`quota.pending_scheduled_posts.limit`	`integer`在父物件中必填	`minimum: 0` `maximum: 9007199254740991`
`quota.pending_scheduled_posts.active`	`integer`在父物件中必填	`minimum: 0` `maximum: 9007199254740991`
`quota.pending_scheduled_posts.remaining`	`integer`在父物件中必填	`minimum: 0` `maximum: 9007199254740991`
`quota.connected_social_accounts`	`object`在父物件中必填	—
`quota.connected_social_accounts.limit`	`integer`在父物件中必填	`minimum: 0` `maximum: 9007199254740991`
`quota.connected_social_accounts.active`	`integer`在父物件中必填	`minimum: 0` `maximum: 9007199254740991`
`quota.connected_social_accounts.remaining`	`integer`在父物件中必填	`minimum: 0` `maximum: 9007199254740991`
`history_days`	`integer`在父物件中必填	`maximum: 9007199254740991` `exclusiveMinimum: 0`
`capabilities`	`object`在父物件中必填	`additionalProperties: {}`
`capabilities.*`	`any JSON value`選填／項目	—

完整 JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "billing_account_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "plan_key": {
      "type": "string",
      "enum": [
        "free",
        "founding_pro"
      ]
    },
    "plan_version": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "payment_state": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "entitlement_source": {
      "type": "string",
      "enum": [
        "default",
        "stripe",
        "internal_test",
        "reconciliation",
        "manual"
      ]
    },
    "has_stripe_customer": {
      "type": "boolean"
    },
    "checkout_enabled": {
      "type": "boolean"
    },
    "cycle": {
      "type": "object",
      "properties": {
        "period_start": {
          "type": "string",
          "format": "date-time",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
        },
        "period_end": {
          "type": "string",
          "format": "date-time",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
        },
        "reset_at": {
          "type": "string",
          "format": "date-time",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
        }
      },
      "required": [
        "period_start",
        "period_end",
        "reset_at"
      ]
    },
    "quota": {
      "type": "object",
      "properties": {
        "successful_destination_publishes": {
          "type": "object",
          "properties": {
            "limit": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            },
            "reserved": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            },
            "consumed": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            },
            "remaining": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          },
          "required": [
            "limit",
            "reserved",
            "consumed",
            "remaining"
          ]
        },
        "pending_scheduled_posts": {
          "type": "object",
          "properties": {
            "limit": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            },
            "active": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            },
            "remaining": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          },
          "required": [
            "limit",
            "active",
            "remaining"
          ]
        },
        "connected_social_accounts": {
          "type": "object",
          "properties": {
            "limit": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            },
            "active": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            },
            "remaining": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          },
          "required": [
            "limit",
            "active",
            "remaining"
          ]
        }
      },
      "required": [
        "successful_destination_publishes",
        "pending_scheduled_posts",
        "connected_social_accounts"
      ]
    },
    "history_days": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "capabilities": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    }
  },
  "required": [
    "billing_account_id",
    "plan_key",
    "plan_version",
    "payment_state",
    "entitlement_source",
    "has_stripe_customer",
    "checkout_enabled",
    "cycle",
    "quota",
    "history_days",
    "capabilities"
  ]
}

錯誤與安全重試

檢查 HTTP 狀態和回應內容。400 驗證錯誤可能包含 ZodError；處理常式錯誤使用 error、message 和 code 欄位。保留 request_id 或 x-request-id 以便診斷，但不要保留憑證。先解決 401/403 存取錯誤再重試，並在收到 429 時遵循 Retry-After。如寫入結果不確定或回傳 5xx，先讀取現有結果。僅在支援時重複使用冪等鍵；重試行為因操作而異，並不保證恰好傳送一次。

故障排查指南

範例

這些範例使用已依結構描述檢查的虛構值。請將 ID 替換為您有權使用的 ID、將媒體替換為已就緒素材，並將日期替換為已確認的發布時間。提交寫入前，請檢查帳號資格。本頁不會傳送 API 請求。

在伺服器上將 SOSOAPI_ACCESS_TOKEN 設為此操作接受的憑證，且不要放入瀏覽器程式碼。代理程式請使用 sosoapi auth login 透過瀏覽器登入，並由 CLI 更新憑證。

request.json

{}

cURL

curl --request POST \
  "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/identity-api/billing/status" \
  -H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  --data-binary @request.json

JavaScript

// Server-side JavaScript. Do not print tokens or credential-bearing responses.
const token = process.env.SOSOAPI_ACCESS_TOKEN;
if (!token) throw new Error("Set an accepted credential for this operation");
const response = await fetch("https://gqeshlawtcexsapabaui.supabase.co/functions/v1/identity-api/billing/status", {
  method: "POST",
  headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
  body: JSON.stringify({})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.

CLI

npx sosoapi api post /identity-api/billing/status < request.json

合成回應範例

{
  "billing_account_id": "11111111-1111-4111-8111-111111111111",
  "plan_key": "free",
  "plan_version": 1,
  "payment_state": "example",
  "entitlement_source": "default",
  "has_stripe_customer": false,
  "checkout_enabled": false,
  "cycle": {
    "period_start": "2099-01-15T09:00:00Z",
    "period_end": "2099-01-15T09:00:00Z",
    "reset_at": "2099-01-15T09:00:00Z"
  },
  "quota": {
    "successful_destination_publishes": {
      "limit": 0,
      "reserved": 0,
      "consumed": 0,
      "remaining": 0
    },
    "pending_scheduled_posts": {
      "limit": 0,
      "active": 0,
      "remaining": 0
    },
    "connected_social_accounts": {
      "limit": 0,
      "active": 0,
      "remaining": 0
    }
  },
  "history_days": 1,
  "capabilities": {}
}

MCP： sosoapi_get_billing_status

全部 API 操作驗證與權限