BillingAutomationPaymentPlanAddParameters

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BillingAutomationPaymentPlanAddParameters",
  "title": "BillingAutomationPaymentPlanAddParameters",
  "required": [
    "AccessToken",
    "BillingAutomationId",
    "Client",
    "ClientToken",
    "CustomerId",
    "Name",
    "PaymentOffsetDays",
    "PaymentRequest"
  ],
  "type": "object",
  "properties": {
    "ClientToken": {
      "minLength": 1,
      "type": "string",
      "description": "Token identifying the client application."
    },
    "AccessToken": {
      "minLength": 1,
      "type": "string",
      "description": "Access token of the client application."
    },
    "Client": {
      "minLength": 1,
      "type": "string",
      "description": "Name and version of the client application."
    },
    "EnterpriseId": {
      "type": "string",
      "description": "Unique identifier of the enterprise. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise.",
      "format": "uuid",
      "nullable": true
    },
    "BillingAutomationId": {
      "type": "string",
      "description": "Unique identifier of the `Billing automation` associated with the payment plan.",
      "format": "uuid"
    },
    "CustomerId": {
      "type": "string",
      "description": "Unique identifier of the `Customer` associated with the payment plan.",
      "format": "uuid"
    },
    "Name": {
      "maxLength": 255,
      "minLength": 1,
      "type": "string",
      "description": "Name of the payment plan."
    },
    "PaymentRequest": {
      "title": "Billing automation payment plan payment request",
      "allOf": [
        {
          "$ref": "#/components/schemas/BillingAutomationPaymentPlanPaymentRequest"
        }
      ],
      "description": "Data related to the payment request associated with the payment plan created."
    },
    "PaymentOffsetDays": {
      "type": "integer",
      "description": "Number of days since the bill creation when the payment will be charged.",
      "format": "int32"
    },
    "StartMonth": {
      "type": "string",
      "description": "Specifies the month when the payment plan begins collecting payments, in the 'YYYY-MM' format. The month must be in the future. If a value is not set, it'll start with the earliest available bill created from billing automation.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "x-schema-id": "BillingAutomationPaymentPlanAddParameters"
}