---
updatedAt: 2026-09-01T01:26:58.000Z
agentTools:
  projectIndex: https://apidocs.bct.host/llms.txt
---

# Balance Snapshot Subscription Status

Query the current PI balance snapshot subscription status for the authenticated user. Returns the latest subscription record including status, subscribe date, and total subscription count.

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Balance and Position Snapshot",
    "description": "PI Balance Snapshot API service providing subscription management and daily historical account group balance snapshot queries.",
    "version": "3.0.0"
  },
  "servers": [
    {
      "url": "https://trade-hk.osl.com"
    }
  ],
  "paths": {
    "/api/3/accountGroup/piBalanceSnapshot/status": {
      "post": {
        "summary": "Balance Snapshot Subscription Status",
        "description": "Query the current PI balance snapshot subscription status for the authenticated user. Returns the latest subscription record including status, subscribe date, and total subscription count.",
        "operationId": "piBalanceSnapshotStatus",
        "tags": [
          "PiBalanceSnapshot"
        ],
        "security": [
          {
            "apiKeyAuth": [],
            "hmacSignature": []
          }
        ],
        "responses": {
          "200": {
            "description": "Query successful",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SnapshotStatusResponse"
                },
                "examples": {
                  "activeSubscription": {
                    "summary": "User has an active subscription",
                    "value": {
                      "userUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
                      "subscribed": true,
                      "status": "active",
                      "subscribeDate": "2026-08-20T08:00:00.000Z",
                      "recordId": "12345",
                      "totalSubscriptions": 1
                    }
                  },
                  "noSubscription": {
                    "summary": "User has no subscription",
                    "value": {
                      "userUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
                      "subscribed": false,
                      "status": "inactive",
                      "subscribeDate": null,
                      "recordId": null,
                      "totalSubscriptions": 0
                    }
                  },
                  "disabledSubscription": {
                    "summary": "Subscription disabled by admin",
                    "value": {
                      "userUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
                      "subscribed": false,
                      "status": "disabled",
                      "subscribeDate": "2026-08-15T08:00:00.000Z",
                      "recordId": "12345",
                      "totalSubscriptions": 1
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "apiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "Rest-Key",
        "description": "API Key"
      },
      "hmacSignature": {
        "type": "apiKey",
        "in": "header",
        "name": "Rest-Sign",
        "description": "HMAC signature"
      }
    },
    "schemas": {
      "SnapshotStatusResponse": {
        "type": "object",
        "properties": {
          "userUuid": {
            "type": "string",
            "format": "uuid",
            "description": "User UUID"
          },
          "subscribed": {
            "type": "boolean",
            "description": "Whether the user is currently subscribed"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "inactive",
              "disabled",
              "suspended"
            ],
            "description": "Current subscription status. 'active' = subscribed, 'inactive' = no subscription record, 'disabled' = disabled by admin, 'suspended' = suspended by admin"
          },
          "subscribeDate": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "Date when the user subscribed (null if no subscription)"
          },
          "recordId": {
            "type": "string",
            "nullable": true,
            "description": "Subscription record ID (null if no subscription)"
          },
          "totalSubscriptions": {
            "type": "integer",
            "description": "Total number of subscription records for this user"
          }
        }
      },
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "error": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "description": "Error name"
              },
              "message": {
                "type": "string",
                "description": "Error description"
              }
            }
          }
        }
      }
    }
  }
}
```