messagebird · Schema

Balance

Properties

Name Type Description
payment string The payment type for the account. Can be prepaid or postpaid.
type string The type of balance.
amount number The available balance amount.
View JSON Schema on GitHub

JSON Schema

messagebird-balance-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Balance",
  "title": "Balance",
  "type": "object",
  "properties": {
    "payment": {
      "type": "string",
      "description": "The payment type for the account. Can be prepaid or postpaid.",
      "enum": [
        "prepaid",
        "postpaid"
      ]
    },
    "type": {
      "type": "string",
      "description": "The type of balance.",
      "enum": [
        "credits",
        "euros"
      ]
    },
    "amount": {
      "type": "number",
      "format": "double",
      "description": "The available balance amount."
    }
  }
}