Plane docs
ApiSchemas

SpendLimitExceededEncoded

One shape from the contract, as it appears on the wire.

Used by sessions.create, sessions.send

JSON Schema

{
  "type": "object",
  "properties": {
    "_tag": {
      "type": "string",
      "enum": [
        "SpendLimitExceeded"
      ]
    },
    "scope": {
      "$ref": "#/components/schemas/SpendScope"
    },
    "metric": {
      "$ref": "#/components/schemas/SpendMetric"
    },
    "window": {
      "$ref": "#/components/schemas/SpendWindow"
    },
    "limit": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "string",
          "enum": [
            "Infinity",
            "-Infinity",
            "NaN"
          ]
        }
      ]
    },
    "used": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "string",
          "enum": [
            "Infinity",
            "-Infinity",
            "NaN"
          ]
        }
      ]
    },
    "period": {
      "$ref": "#/components/schemas/Period"
    },
    "resetsAt": {
      "type": "string"
    }
  },
  "required": [
    "_tag",
    "scope",
    "metric",
    "window",
    "limit",
    "used",
    "period",
    "resetsAt"
  ],
  "additionalProperties": false
}

On this page