--- title: Create Billing Schedule slug: create-billing-schedule docTags: createdAt: 2026-08-25T19:28:59.170Z --- { "id": "8so0LVtLTIf3_yACpevNK", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://api.nue.io/billing/schedules", "servers": [ { "url": "https://api.nue.io/billing/schedules", "description": "Nue Production API Endpoint" }, { "url": "https://api.sandbox.nue.io/billing/schedules", "description": "Nue Sandbox API Endpoint" } ], "name": "Create Billing Schedule", "description": "

Create a billing schedule to automatically generate invoices for your customers on a recurring basis (daily, weekly, monthly) or on-demand. Billing schedules define when invoices are created, which customers to bill, and what products or services to include. You can filter by specific customers, orders, or product price models.

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "*/*", "application/json" ], "default": "*/*" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "

Billing schedule configuration. Define when to run billing, which customers to include, and invoice generation settings.

", "schema": [ { "name": "createdThrough", "kind": "optional", "type": "string", "description": "

Source of creation (API, UI, etc.)

", "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", "description": "Date when the billing schedule should start running", "example": "2024-06-01", "format": "date" }, { "name": "invoiceDate", "kind": "optional", "type": "string", "description": "Date to use on generated invoices", "example": "2024-06-01", "format": "date" }, { "name": "scheduleType", "kind": "required", "type": "string", "description": "

Type of schedule - Recurring runs automatically, On Demand runs manually

", "example": "Recurring", "enum": [ "Recurring", "On Demand" ] }, { "name": "recurringSchedule", "kind": "optional", "type": "string", "description": "

Cron expression defining when to run (format: seconds minutes hours day-of-month month day-of-week year). Example: '0 0 3 * * ? *' means 3

AM daily

", "example": "0 0 3 * * ? *" }, { "name": "customerFilter", "kind": "optional", "type": "string", "description": "

GraphQL filter to select which customers to bill. Format: {field:{operator:[values]}}

", "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": "

GraphQL filter to select products by price model (recurring, one-time, usage-based)

", "example": "{priceModel:{_in:[\"recurring\"]}}" }, { "name": "zoneId", "kind": "optional", "type": "string", "description": "Timezone offset for schedule execution", "example": "-07:00" }, { "name": "description", "kind": "required", "type": "string", "description": "

Human-readable description of the billing schedule purpose

", "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", "description": "

How to handle missed billing cycles - Simulation previews, Execution creates actual invoices

", "example": "Simulation", "enum": [ "Simulation", "Execution" ] } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "apiKeyAuth", "name": "nue-api-key", "kind": "optional", "type": "apiKey", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "Created", "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": "s5G9DKr-AOT8AArIz_xOo", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.nue.io/billing/schedules \\\n --header 'accept: */*' \\\n --header 'content-type: application/json' \\\n --data '{\n \"scheduleType\": \"Recurring\",\n \"description\": \"Monthly billing schedule for recurring subscriptions\"\n }'" }, { "id": "KKRxWAORSVXsZsqsefpTR", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"*/*\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"scheduleType\": \"Recurring\",\n \"description\": \"Monthly billing schedule for recurring subscriptions\"\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.nue.io/billing/schedules\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "PmcjrObwslxuroUfgqxKI", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/billing/schedules\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"*/*\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"scheduleType\": \"Recurring\",\n \"description\": \"Monthly billing schedule for recurring subscriptions\"\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "LCKX8E2wi3yH5AbxdSPbp", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/billing/schedules\"\n\npayload = json.dumps({\n \"scheduleType\": \"Recurring\",\n \"description\": \"Monthly billing schedule for recurring subscriptions\"\n})\nheaders = {\n 'accept': '*/*',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "s5G9DKr-AOT8AArIz_xOo" }, "results": { "languages": [ { "id": "VAQiPoPL2CMhNdU6i1Rv0", "language": "201", "code": "// Created\n" }, { "id": "cwhuboyTf6mMpf8h71Hdz", "language": "400", "code": "// Bad Request\n{\n \"title\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\"\n}" }, { "id": "BrparCUgYDnhBTHUMJTTN", "language": "404", "code": "// Not Found\n" } ], "selectedLanguageId": "VAQiPoPL2CMhNdU6i1Rv0" } }, "children": [ { "text": "" } ] }