MerchantStatus

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/osis-co/json-schema/osis-co-merchant-status-schema.json",
  "title": "MerchantStatus",
  "x-generated": "2026-10-31",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/osis-co-openapi.json#/components/schemas/MerchantStatus",
  "type": "object",
  "properties": {
    "payments": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean",
          "description": "True if you can use the Payments API right now. False until the current terms are accepted, and while suspended."
        },
        "terms_version": {
          "type": [
            "string",
            "null"
          ]
        },
        "terms_accepted_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "terms_current": {
          "type": "boolean",
          "description": "False if the terms changed since you accepted them."
        },
        "suspended": {
          "type": "boolean"
        },
        "suspended_reason": {
          "type": [
            "string",
            "null"
          ]
        },
        "curated": {
          "type": "boolean",
          "description": "True when Comms reviewed this workspace's catalog. These workspaces sell only reviewed products."
        }
      },
      "required": [
        "enabled",
        "terms_version",
        "terms_accepted_at",
        "terms_current",
        "suspended",
        "suspended_reason",
        "curated"
      ]
    },
    "shopify": {
      "type": [
        "object",
        "null"
      ],
      "description": "Null if you've never connected a store.",
      "properties": {
        "shop_domain": {
          "type": "string"
        },
        "shop_name": {
          "type": [
            "string",
            "null"
          ]
        },
        "status": {
          "type": "string",
          "enum": [
            "active",
            "uninstalled"
          ]
        },
        "install_method": {
          "type": "string",
          "enum": [
            "oauth",
            "manual"
          ],
          "description": "oauth: installed the Comms app. manual: connected by Comms for you."
        },
        "installed_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "uninstalled_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "needs_reconnect": {
          "type": "boolean",
          "description": "True when Shopify stopped letting Comms reach the store. Reopen Comms from Shopify to authorize the same store again."
        }
      },
      "required": [
        "shop_domain",
        "shop_name",
        "status",
        "install_method",
        "installed_at",
        "uninstalled_at",
        "needs_reconnect"
      ]
    },
    "install_available": {
      "type": "boolean",
      "description": "False if the Comms Shopify app can't take installs right now."
    },
    "terms": {
      "type": "object",
      "properties": {
        "current_version": {
          "type": "string"
        },
        "url": {
          "type": "string",
          "format": "uri"
        }
      },
      "required": [
        "current_version",
        "url"
      ]
    },
    "whop": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "company_id": {
          "type": "string"
        },
        "company_name": {
          "type": [
            "string",
            "null"
          ]
        },
        "status": {
          "type": "string",
          "enum": [
            "active",
            "disconnected"
          ]
        },
        "webhook_configured": {
          "type": "boolean"
        },
        "connected_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      }
    }
  },
  "required": [
    "payments",
    "shopify",
    "install_available",
    "terms"
  ]
}