---
title: Update Billing Schedule
slug: update-billing-schedule
docTags: 
createdAt: 2026-08-25T19:28:59.170Z
---

{
  "id": "rYqUOHQqIQtLQKHc9zxfB",
  "type": "api-oas-v2",
  "data": {
    "method": "PATCH",
    "url": "https://api.nue.io/billing/schedules/{id}",
    "servers": [
      {
        "url": "https://api.nue.io/billing/schedules/{id}",
        "description": "Nue Production API Endpoint"
      },
      {
        "url": "https://api.sandbox.nue.io/billing/schedules/{id}",
        "description": "Nue Sandbox API Endpoint"
      }
    ],
    "name": "Update Billing Schedule",
    "description": "Update a billing schedule. Only draft billing schedules can be updated.",
    "contentType": "application/json",
    "request": {
      "pathParameters": [
        {
          "kind": "required",
          "name": "id",
          "type": "string<uuid>",
          "description": "",
          "format": "uuid"
        }
      ],
      "headerParameters": [
        {
          "name": "accept",
          "type": "string",
          "kind": "optional",
          "description": "Generated from available response content types",
          "enum": [
            "application/json",
            "*/*"
          ],
          "default": "application/json"
        }
      ],
      "queryParameters": [],
      "bodyDataParameters": [
        {
          "kind": "required",
          "name": "body",
          "type": "object",
          "description": "See metadata of BillingSchedule",
          "schema": [
            {
              "name": "createdThrough",
              "kind": "optional",
              "type": "string",
              "description": "<p>Source of creation (API, UI, etc.)</p>",
              "example": "API"
            },
            {
              "name": "autoActivate",
              "kind": "optional",
              "type": "boolean",
              "description": "Whether to automatically activate the schedule after creation",
              "example": true
            },
            {
              "name": "scheduleStartDate",
              "kind": "optional",
              "type": "string<date>",
              "description": "Date when the billing schedule should start running",
              "example": "2024-06-01",
              "format": "date"
            },
            {
              "name": "invoiceDate",
              "kind": "optional",
              "type": "string<date>",
              "description": "Date to use on generated invoices",
              "example": "2024-06-01",
              "format": "date"
            },
            {
              "name": "scheduleType",
              "kind": "optional",
              "type": "string<Recurring | On Demand>",
              "description": "<p>Type of schedule - Recurring runs automatically, On Demand runs manually</p>",
              "example": "Recurring",
              "enum": [
                "Recurring",
                "On Demand"
              ]
            },
            {
              "name": "recurringSchedule",
              "kind": "optional",
              "type": "string",
              "description": "<p>Cron expression defining when to run (format: seconds minutes hours day-of-month month day-of-week year). Example: '0 0 3 * * ? *' means 3</p><div></div> AM daily<p></p>",
              "example": "0 0 3 * * ? *"
            },
            {
              "name": "customerFilter",
              "kind": "optional",
              "type": "string",
              "description": "<p>GraphQL filter to select which customers to bill. Format: {field:{operator:[values]}}</p>",
              "example": "{id:{_in:[\"customer-id-123\"]}}"
            },
            {
              "name": "orderFilter",
              "kind": "optional",
              "type": "string",
              "description": "GraphQL filter to select which orders to include in billing",
              "example": "{id:{_in:[\"order-id-456\"]}}"
            },
            {
              "name": "productFilter",
              "kind": "optional",
              "type": "string",
              "description": "<p>GraphQL filter to select products by price model (recurring, one-time, usage-based)</p>",
              "example": "{priceModel:{_in:[\"recurring\"]}}"
            },
            {
              "name": "zoneId",
              "kind": "optional",
              "type": "string",
              "description": "Timezone offset for schedule execution",
              "example": "-07:00"
            },
            {
              "name": "description",
              "kind": "optional",
              "type": "string",
              "description": "<p>Human-readable description of the billing schedule purpose</p>",
              "example": "Monthly billing schedule for recurring subscriptions"
            },
            {
              "name": "cleanCatchUp",
              "kind": "optional",
              "type": "boolean",
              "description": "Whether to clean up missed billing cycles when catching up",
              "example": true
            },
            {
              "name": "catchUpMode",
              "kind": "optional",
              "type": "string<Simulation | Execution>",
              "description": "<p>How to handle missed billing cycles - Simulation previews, Execution creates actual invoices</p>",
              "example": "Simulation",
              "enum": [
                "Simulation",
                "Execution"
              ]
            }
          ],
          "isExpanded": true
        }
      ],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "apiKeyAuth",
          "name": "nue-api-key",
          "kind": "optional",
          "type": "apiKey",
          "in": "header"
        }
      ],
      "cookieParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "OK",
        "jsonExample": "",
        "isExpanded": true
      },
      {
        "statusCode": "400",
        "description": "Bad Request",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "schema": [
              {
                "name": "title",
                "kind": "optional",
                "type": "string",
                "description": ""
              },
              {
                "name": "message",
                "kind": "optional",
                "type": "string",
                "description": ""
              },
              {
                "name": "errorCode",
                "kind": "optional",
                "type": "string",
                "description": ""
              }
            ],
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "404",
        "description": "Not Found",
        "jsonExample": "",
        "isExpanded": true
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "vneXT1lp5xgXUrILgXFV5",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request PATCH \\\n     --url https://api.nue.io/billing/schedules/{id} \\\n     --header 'accept: application/json'"
        },
        {
          "id": "l5flMC6kA83dJ1FW-jykK",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'PATCH',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://api.nue.io/billing/schedules/{id}\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "FAHgjhWyDeoAoKC6ruzom",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/billing/schedules/{id}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Patch.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "XBE9LiMZ4rCCwFti0DRSb",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/billing/schedules/{id}\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"PATCH\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "vneXT1lp5xgXUrILgXFV5"
    },
    "results": {
      "languages": [
        {
          "id": "62lbZDgqUr-Qb1jRjXxOM",
          "language": "200",
          "code": "// OK\n"
        },
        {
          "id": "yoLCDewijMWC5eeA3KW82",
          "language": "400",
          "code": "// Bad Request\n{\n  \"title\": \"\",\n  \"message\": \"\",\n  \"errorCode\": \"\"\n}"
        },
        {
          "id": "lryUQ9gS1JGQUYXdg0RQo",
          "language": "404",
          "code": "// Not Found\n"
        }
      ],
      "selectedLanguageId": "62lbZDgqUr-Qb1jRjXxOM"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}