Org

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Org",
  "title": "Org",
  "type": "object",
  "properties": {
    "hipaaEnabled": {
      "type": "boolean",
      "description": "When this is enabled, logs, recordings, and transcriptions will be stored in HIPAA-compliant storage. Defaults to false.\nWhen HIPAA is enabled, only HIPAA-compliant providers will be available for LLM, Voice, and Transcriber respectively.\nThis is due to the compliance requirements of HIPAA. Other providers may not meet these requirements.",
      "example": false
    },
    "subscription": {
      "$ref": "#/components/schemas/Subscription"
    },
    "subscriptionId": {
      "type": "string",
      "description": "This is the ID of the subscription the org belongs to."
    },
    "id": {
      "type": "string",
      "description": "This is the unique identifier for the org."
    },
    "createdAt": {
      "format": "date-time",
      "type": "string",
      "description": "This is the ISO 8601 date-time string of when the org was created."
    },
    "updatedAt": {
      "format": "date-time",
      "type": "string",
      "description": "This is the ISO 8601 date-time string of when the org was last updated."
    },
    "stripeSubscriptionId": {
      "type": "string",
      "description": "This is the subscription for the org."
    },
    "stripeSubscriptionItemId": {
      "type": "string",
      "description": "This is the subscription's subscription item."
    },
    "stripeSubscriptionCurrentPeriodStart": {
      "format": "date-time",
      "type": "string",
      "description": "This is the subscription's current period start."
    },
    "stripeSubscriptionStatus": {
      "type": "string",
      "description": "This is the subscription's status."
    },
    "jwtSecret": {
      "type": "string",
      "description": "This is the secret key used for signing JWT tokens for the org."
    },
    "minutesUsed": {
      "type": "number",
      "description": "This is the total number of call minutes used by this org across all time."
    },
    "name": {
      "type": "string",
      "description": "This is the name of the org. This is just for your own reference.",
      "maxLength": 40
    },
    "channel": {
      "type": "string",
      "description": "This is the channel of the org. There is the cluster the API traffic for the org will be directed.",
      "enum": [
        "daily",
        "default",
        "weekly",
        "intuit",
        "hcs"
      ]
    },
    "billingLimit": {
      "type": "number",
      "description": "This is the monthly billing limit for the org. To go beyond $1000/mo, please contact us at support@vapi.ai.",
      "minimum": 0,
      "maximum": 1000
    },
    "server": {
      "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server",
      "allOf": [
        {
          "$ref": "#/components/schemas/Server"
        }
      ]
    },
    "concurrencyLimit": {
      "type": "number",
      "description": "This is the concurrency limit for the org. This is the maximum number of calls that can be active at any given time. To go beyond 10, please contact us at support@vapi.ai.",
      "deprecated": true,
      "minimum": 1,
      "maximum": 10
    },
    "compliancePlan": {
      "description": "Stores the information about the compliance plan enforced at the organization level. Currently pciEnabled is supported through this field.\nWhen this is enabled, any logs, recordings, or transcriptions will be shipped to the customer endpoints if provided else lost.\nAt the end of the call, you will receive an end-of-call-report message to store on your server, if webhook is provided.\nDefaults to false.\nWhen PCI is enabled, only PCI-compliant Providers will be available for LLM, Voice and transcribers.\nThis is due to the compliance requirements of PCI. Other providers may not meet these requirements.",
      "allOf": [
        {
          "$ref": "#/components/schemas/CompliancePlan"
        }
      ]
    }
  },
  "required": [
    "id",
    "createdAt",
    "updatedAt"
  ]
}