billingEventsPostRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/payrix/main/json-schema/payrix-billing-events-post-request-schema.json",
  "title": "billingEventsPostRequest",
  "x-generated": "2026-09-21",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/payrix-billing-events-api-openapi.yml#/components/schemas/billingEventsPostRequest",
  "required": [
    "billing",
    "event"
  ],
  "type": "object",
  "properties": {
    "billing": {
      "type": "string",
      "description": "The billing to which this billingEvent applies."
    },
    "event": {
      "allOf": [
        {
          "$ref": "#/$defs/billingEvent"
        },
        {
          "description": "The type of event that triggers billing.\n\n<details>\n<summary>Valid Values</summary>\n\n- `fees` - **Fee.** Fee events trigger the billing configuration.\n- `chargebacks` - **Chargebacks.** Chargeback events trigger the billing configuration.\n- `returns` - **Returns.** Return events trigger the billing configuration.\n- `profitShares` - **Profit Shares.** Profit Sharing events trigger the billing configuration.\n- `revShares` - **RevShares.** Rev Sharing events trigger the billing configuration.\n\n</details>"
        }
      ]
    },
    "eventSchedule": {
      "type": "string",
      "description": "The record ID of a specific schedule for the event chosen for which the billing configuration applies, all other records of the same event are excluded."
    },
    "deductFromBalance": {
      "allOf": [
        {
          "$ref": "#/$defs/billingEventsDeductFromBalance"
        },
        {
          "description": "Whether to deduct the billing amount from the entity's account balance.\n\n<details>\n<summary>Valid Values</summary>\n\n- `0` - **Do not deduct from balance.**\n- `1` - **Deduct from balance.**\n\n</details>"
        }
      ]
    },
    "inactive": {
      "allOf": [
        {
          "$ref": "#/$defs/inactive"
        },
        {
          "description": "Whether this resource is marked as inactive.\n\n<details>\n<summary>Valid Values</summary>\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n</details>"
        }
      ]
    },
    "frozen": {
      "allOf": [
        {
          "$ref": "#/$defs/frozen"
        },
        {
          "description": "Whether this resource is marked as frozen.\n\n<details>\n<summary>Valid Values</summary>\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n</details>"
        }
      ]
    }
  },
  "$defs": {
    "billingEvent": {
      "title": "billingEvent",
      "enum": [
        "fees",
        "chargebacks",
        "returns",
        "profitShares",
        "revShares"
      ],
      "type": "string"
    },
    "billingEventsDeductFromBalance": {
      "title": "billingEventsDeductFromBalance",
      "enum": [
        0,
        1
      ],
      "type": "integer"
    },
    "frozen": {
      "title": "frozen",
      "enum": [
        0,
        1
      ],
      "type": "integer"
    },
    "inactive": {
      "title": "inactive",
      "enum": [
        0,
        1
      ],
      "type": "integer"
    }
  }
}