{"openapi": "3.1.0", "info": {"title": "Lightyear API", "version": "0.1.0", "description": "\n# Authentication\n\nThe Lightyear API supports two authentication methods, both using the\n[HTTP Authorization header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization):\n\n- **OAuth 2.0 Client Credentials** (recommended) \u2014 exchange your API key and secret for short-lived bearer tokens.\n- **HMAC** \u2014 sign each request with a SHA256 HMAC of its path, body, and timestamp.\n\nThe authentication method is chosen when an API key is created and cannot be changed afterwards.\n\n## OAuth 2.0 Client Credentials\n\nAPI keys created with the OAuth 2.0 authentication method exchange their credentials for short-lived bearer\ntokens ([RFC 6749 client credentials grant](https://datatracker.ietf.org/doc/html/rfc6749#section-4.4)).\nThis is the simplest option, and works out of the box with platforms that have built-in OAuth 2.0 support\n(e.g. ServiceNow outbound REST).\n\n1. Request a token from `POST /developer/oauth/token` with a form-encoded body of `grant_type=client_credentials`.\n   Send your API key and secret as the client id and client secret, either via HTTP Basic auth or as\n   `client_id`/`client_secret` body parameters. The `scope` parameter is accepted and ignored; tokens carry\n   the same access as the API key itself.\n2. Send the returned token on API requests: `Authorization: Bearer <access_token>`.\n3. Tokens expire after the `expires_in` seconds in the token response (currently 1 hour); request a new token\n   when you receive a `401`.\n\n### Examples\n\n```bash\n# Request a token\ncurl -u $API_KEY:$API_SECRET \\\n  -d grant_type=client_credentials \\\n  https://api.lightyear.ai/developer/oauth/token\n\n# Use the returned access_token on API requests\ncurl -H \"Authorization: Bearer $ACCESS_TOKEN\" https://api.lightyear.ai/developer/team/v1\n```\n\n#### NodeJS Example\n\n```node\nconst clientId = '39a9487b65fd435bbb19e795707be059'; // replace with your key\nconst clientSecret = 'c039fb44156b4c83941b3df66f740aae'; // replace with your secret\nconst host = 'https://api.lightyear.ai';\n\nconst basicAuth = Buffer.from(`${clientId}:${clientSecret}`).toString('base64');\n\nfetch(host + '/developer/oauth/token', {\n    method: 'POST',\n    headers: {\n        Authorization: `Basic ${basicAuth}`,\n        'Content-Type': 'application/x-www-form-urlencoded',\n    },\n    body: 'grant_type=client_credentials',\n})\n    .then((res) => res.json())\n    .then(({ access_token }) =>\n        fetch(host + '/developer/team/v1', {\n            headers: { Authorization: `Bearer ${access_token}` },\n        })\n    )\n    .then((res) => res.json())\n    .then(console.log);\n```\n\n#### Python Example\n\nNote: requires the requests library\n\n```python\nimport requests\n\nfrom pprint import pprint\n\nclient_id = '39a9487b65fd435bbb19e795707be059' # replace with your key\nclient_secret = 'c039fb44156b4c83941b3df66f740aae' # replace with your secret\nhost = 'https://api.lightyear.ai'\n\ntoken_res = requests.post(\n    f\"{host}/developer/oauth/token\",\n    auth=(client_id, client_secret),  # HTTP Basic auth\n    data={\"grant_type\": \"client_credentials\"},\n)\naccess_token = token_res.json()[\"access_token\"]\n\nheaders = {\n    \"Authorization\": f\"Bearer {access_token}\",\n}\n\nres = requests.get(f\"{host}/developer/team/v1\", headers=headers)\ndata = res.json()\npprint(data)\n```\n\n## HMAC\n\nAPI keys created with the HMAC authentication method sign every request with a SHA256 hash-based\nmessage authentication code (HMAC). No token round-trip is required, and the signature also covers\nthe request body.\n\n### HTTP Authorization header components\n\nThe auth-scheme is `LY-HMAC`. \n\nThe auth-params are `Key`, `Timestamp`, and `Signature`. Order of the auth-params is not important, but they should be separated by a comma:\n- `Key` is your Lightyear API Key\n- `Timestamp` is the current Unix timestamp in seconds\n- `Signature` is the SHA256 HMAC of the request in hex format\n    - The secret for HMAC is your Lightyear API Secret.\n    - The message for HMAC is derived from the following parts of the request. Combine them with `::` (two colons) - e.g. `path::body::timestamp`.\n        - The request path (starting with `/developer/`), including query parameters\n        - The request body (if any). Use an empty string if there is no body.\n        - The Timestamp auth-param\n\n### Examples\n\n```text\nAuthorization: LY-HMAC Key=00ca8f097c0b4dd69548b29e7803fe11,Timestamp=1697728487,Signature=8eb1805f9d4c4d583d84063d3a611f9a7d269bca890fca62d83c68ee2db85009\n```\n\n#### NodeJS Example\n\n```node\nconst crypto = require('crypto');\n\nconst key = '39a9487b65fd435bbb19e795707be059';\nconst secret = 'c039fb44156b4c83941b3df66f740aae';\nconst timestamp = Math.floor(Date.now() / 1000);\n\nconst body = ''; // replace with how to get body of request, leave blank for GET requests\nconst host = 'https://api.lightyear.ai';\nconst pathWithQueryString = '/developer/team/v1'; // replace with how to get path with query of the request\nconst url = host + pathWithQueryString;\n\nconst msg = pathWithQueryString + '::' + body + '::' + timestamp;\n\n\nconst signature =  crypto.createHmac('sha256', secret).update(msg).digest('hex')\n\nconst headers = {\n    Authorization: `LY-HMAC Key=${key},Timestamp=${timestamp},Signature=${signature}`,\n};\n\nfetch(url, { headers})\n    .then((res) => res.json())\n    .then(console.log);\n```\n\n#### Python Example\n\nNote: requires the requests library\n\n```python\nimport hmac\nimport requests\nimport time\n\nfrom pprint import pprint\n\nkey = '39a9487b65fd435bbb19e795707be059' # replace with your key\nsecret = 'c039fb44156b4c83941b3df66f740aae' # replace with your secret\ntimestamp = int(time.time())\n\nbody = '' # replace with how to get body of request, leave blank for GET requests\nhost = 'https://api.lightyear.ai'\npath_with_query_string = '/developer/team/v1' # replace with how to get path with query of the request\nurl = host + path_with_query_string\n\nmsg = f\"{path_with_query_string}::{body}::{timestamp}\"\n\nhmac_auth = hmac.new(key=secret.encode(), msg=msg.encode(), digestmod=\"sha256\")\nsignature = hmac_auth.hexdigest()\n\nheaders = {\n    \"Authorization\": f\"LY-HMAC Key={key},Timestamp={timestamp},Signature={signature}\",\n}\n\nres = requests.get(url, headers=headers)\ndata = res.json()\npprint(data)\n```\n\n## IP Allowlists\n\nTeams can restrict API access to a set of source IP addresses from the IP Allowlists page under\nSecurity in the Lightyear dashboard. When your team has an allowlist that covers API requests,\nevery request under `/developer/` \u2014 including `POST /developer/oauth/token` \u2014 must originate from\nan address on it. Requests from any other address receive a `403` whose `detail` names the\nrejected address, so you can add it to the allowlist or route traffic through a permitted egress.\nTeams with no allowlist are unaffected.\n\n# Webhooks\n\nWebhooks let you receive real-time HTTP notifications when events occur in your Lightyear account. Instead of polling the API, register an endpoint URL and Lightyear will `POST` event payloads to it as they happen.\n\nManage your webhook subscriptions from the [Webhooks settings page](https://app.lightyear.ai/dashboard/settings/api).\n\n## Supported Event Types\n\n| Event Type | Description | Payload |\n|---|---|---|\n| `service.updated` | A service's details, status, or step changed | `data` matches [GET /services/{id}/v1](#tag/Services/operation/lightyear_api_views_services_api_get_service_v1) |\n| `invoice.created` | A new provider invoice was received | `data` matches [GET /invoices/{id}/v1](#tag/Invoices/operation/lightyear_api_views_invoices_api_get_invoice_v1) |\n| `invoice.closed` | A provider invoice was closed | `data` matches [GET /invoices/{id}/v1](#tag/Invoices/operation/lightyear_api_views_invoices_api_get_invoice_v1) |\n| `consolidated_invoice.opened` | A new consolidated bill was opened | `data` matches [GET /consolidated-bills/{id}/v1](#tag/Consolidated-Bills/operation/lightyear_api_views_consolidated_bills_api_get_consolidated_bill_v1) |\n| `consolidated_invoice.paid` | A consolidated bill was marked as paid | `data` matches [GET /consolidated-bills/{id}/v1](#tag/Consolidated-Bills/operation/lightyear_api_views_consolidated_bills_api_get_consolidated_bill_v1) |\n| `service.quotes_created` | New quotes are available for a service | `resource_type` is `service`, `resource_id` is the service ID. `data` is an **array** of all listed quotes for the service, each matching a quote object from [GET /services/{id}/quotes/v1](#tag/Services/operation/lightyear_api_views_services_api_get_service_quotes_v1) |\n| `quote.updated` | An existing quote was updated | `resource_type` is `quote`, `resource_id` is the quote ID. `data` is a single quote object matching a quote from [GET /services/{id}/quotes/v1](#tag/Services/operation/lightyear_api_views_services_api_get_service_quotes_v1) |\n\n## Webhook Payload Envelope\n\nEvery webhook delivery is an HTTP `POST` with a JSON body wrapped in a standard envelope:\n\n```json\n{\n  \"version\": \"v1\",\n  \"event_type\": \"service.updated\",\n  \"resource_type\": \"service\",\n  \"resource_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"resource_url\": \"https://app.lightyear.ai/...\",\n  \"event_occurred_at\": \"2025-07-15T14:30:00.000000+00:00\",\n  \"webhook_timestamp\": \"2025-07-15T14:30:01.123456+00:00\",\n  \"data\": { ... }\n}\n```\n\n| Field | Type | Description |\n|---|---|---|\n| `version` | string | Webhook protocol version (currently `v1`) |\n| `event_type` | string | One of the event types listed above |\n| `resource_type` | string | The type of resource (`service`, `invoice`, `consolidated_invoice`, `quote`) |\n| `resource_id` | string (UUID) | The ID of the affected resource. For `service.quotes_created` this is the service ID; for `quote.updated` this is the quote ID. |\n| `resource_url` | string or null | A link to view the resource in the Lightyear dashboard |\n| `event_occurred_at` | string (ISO 8601) | When the event originally occurred |\n| `webhook_timestamp` | string (ISO 8601) | When the webhook was dispatched |\n| `data` | object or array | The resource payload. Usually an object matching the corresponding API GET response. For `service.quotes_created`, this is an **array** of quote objects. |\n\n## Webhook Headers\n\nEvery delivery includes these headers:\n\n| Header | Description |\n|---|---|\n| `Content-Type` | Always `application/json` |\n| `User-Agent` | `Bandwdth-Webhooks/1.0` |\n| `X-Webhook-Id` | The ID of the webhook subscription |\n| `X-Delivery-Id` | Unique ID for this delivery attempt (use for idempotency) |\n| `X-Webhook-Version` | Webhook protocol version (`v1`) |\n| `X-Webhook-Timestamp` | Unix timestamp used in signature (HMAC only) |\n| `X-Webhook-Signature` | HMAC-SHA256 signature(s) (HMAC only) |\n\n## Security & Authentication\n\nLightyear supports two authentication methods for webhook deliveries:\n\n### HMAC-SHA256 (Recommended)\n\nEach delivery is signed with your webhook secret. The signature is sent in the `X-Webhook-Signature` header.\n\n**How the signature is computed:**\n\n1. A Unix timestamp is generated and sent in the `X-Webhook-Timestamp` header\n2. The signed message is `{timestamp}.{request_body}` (the timestamp, a period, and the raw JSON body)\n3. The HMAC-SHA256 of this message is computed using your webhook secret\n4. The signature header value is `sha256={hex_digest}`\n\n### Static Token\n\nA shared secret token is sent in a configurable header (default: `X-Webhook-Secret`). Your endpoint checks that the header value matches the expected token.\n\n### Webhook Endpoint Requirements\n\n- **HTTPS only** \u2014 All webhook URLs must use HTTPS. HTTP URLs are rejected.\n- **No redirects** \u2014 Webhook deliveries do not follow HTTP redirects (3xx responses are treated as failures).\n- **No private IPs** \u2014 URLs must not resolve to private, loopback, or link-local IP addresses (SSRF protection).\n- **Respond with 2xx** \u2014 Return any `2xx` status code within 10 seconds to acknowledge receipt.\n\n## Validating Webhooks\n\n**Always validate incoming webhooks before processing the payload.** This confirms the request came from Lightyear and hasn't been tampered with.\n\n### HMAC-SHA256 Validation\n\n#### Step-by-Step\n\n1. Extract the `X-Webhook-Timestamp` header\n2. Extract the `X-Webhook-Signature` header (may contain multiple comma-separated signatures during key rotation)\n3. Read the raw request body as a string (do not parse JSON first)\n4. Compute `HMAC-SHA256(your_secret, \"{timestamp}.{raw_body}\")`\n5. Format as `sha256={hex_digest}`\n6. Compare your computed signature against each signature in the header using a **constant-time** comparison\n7. Optionally reject requests where the timestamp is more than 5 minutes old to prevent replay attacks\n\n#### Python Example (HMAC)\n\n```python\nimport hashlib\nimport hmac\nimport json\nimport time\n\nfrom flask import Flask, request, abort\n\napp = Flask(__name__)\n\nWEBHOOK_SECRET = \"your_webhook_secret_here\"  # min 32 characters\nTIMESTAMP_TOLERANCE_SECONDS = 300  # 5 minutes\n\n\ndef verify_webhook_signature(\n    payload_body: bytes, signature_header: str, timestamp_header: str, secret: str\n) -> bool:\n    '''Verify the HMAC-SHA256 signature of a webhook delivery.'''\n    # Guard against replay attacks\n    try:\n        ts = int(timestamp_header)\n    except (ValueError, TypeError):\n        return False\n    if abs(time.time() - ts) > TIMESTAMP_TOLERANCE_SECONDS:\n        return False\n\n    # Compute expected signature\n    message = f\"{timestamp_header}.{payload_body.decode('utf-8')}\".encode()\n    expected = (\n        \"sha256=\" + hmac.new(secret.encode(), message, hashlib.sha256).hexdigest()\n    )\n\n    # The header may have multiple comma-separated signatures (during key rotation)\n    signatures = [s.strip() for s in signature_header.split(\",\")]\n    return any(hmac.compare_digest(expected, sig) for sig in signatures)\n\n\n@app.route(\"/webhooks/lightyear\", methods=[\"POST\"])\ndef handle_webhook():\n    payload = request.get_data()\n    sig_header = request.headers.get(\"X-Webhook-Signature\", \"\")\n    ts_header = request.headers.get(\"X-Webhook-Timestamp\", \"\")\n\n    if not verify_webhook_signature(payload, sig_header, ts_header, WEBHOOK_SECRET):\n        abort(401, \"Invalid signature\")\n\n    event = json.loads(payload)\n    event_type = event[\"event_type\"]\n    delivery_id = request.headers.get(\"X-Delivery-Id\")\n\n    # TODO: Check delivery_id for idempotency (skip if already processed)\n\n    print(f\"Received {event_type} for {event['resource_type']} {event['resource_id']}\")\n\n    print(event[\"data\"])\n\n    return \"\", 200\n\n\nif __name__ == \"__main__\":\n    app.run(port=3000)\n```\n\n#### Node.js Example (HMAC)\n\n```node\nconst crypto = require(\"crypto\");\nconst express = require(\"express\");\n\nconst app = express();\n\nconst WEBHOOK_SECRET = \"your_webhook_secret_here\"; // min 32 characters\nconst TIMESTAMP_TOLERANCE_SECONDS = 300; // 5 minutes\n\n// IMPORTANT: Use raw body for signature verification\napp.use(\"/webhooks/lightyear\", express.raw({ type: \"application/json\" }));\n\nfunction verifyWebhookSignature(\n  payloadBody,\n  signatureHeader,\n  timestampHeader,\n  secret,\n) {\n  // Guard against replay attacks\n  const ts = parseInt(timestampHeader, 10);\n  if (\n    isNaN(ts) ||\n    Math.abs(Date.now() / 1000 - ts) > TIMESTAMP_TOLERANCE_SECONDS\n  ) {\n    return false;\n  }\n\n  // Compute expected signature\n  const message = `${timestampHeader}.${payloadBody.toString(\"utf-8\")}`;\n  const expected =\n    \"sha256=\" +\n    crypto.createHmac(\"sha256\", secret).update(message).digest(\"hex\");\n\n  // The header may have multiple comma-separated signatures (during key rotation)\n  const signatures = signatureHeader.split(\",\").map((s) => s.trim());\n  return signatures.some((sig) => {\n    try {\n      return crypto.timingSafeEqual(Buffer.from(expected), Buffer.from(sig));\n    } catch {\n      return false;\n    }\n  });\n}\n\napp.post(\"/webhooks/lightyear\", (req, res) => {\n  const sigHeader = req.headers[\"x-webhook-signature\"] || \"\";\n  const tsHeader = req.headers[\"x-webhook-timestamp\"] || \"\";\n\n  if (!verifyWebhookSignature(req.body, sigHeader, tsHeader, WEBHOOK_SECRET)) {\n    return res.status(401).send(\"Invalid signature\");\n  }\n\n  const event = JSON.parse(req.body.toString());\n  const deliveryId = req.headers[\"x-delivery-id\"];\n\n  // TODO: Check deliveryId for idempotency (skip if already processed)\n\n  console.log(\n    `Received ${event.event_type} for ${event.resource_type} ${event.resource_id}`,\n  );\n\n  console.log(JSON.stringify(event.data));\n\n  res.status(200).send();\n});\n\napp.listen(3000, () => console.log(\"Webhook receiver listening on port 3000\"));\n```\n\n### Static Token Validation\n\nWith static token authentication, Lightyear sends a shared secret in a configurable header (default: `X-Webhook-Secret`). Your endpoint simply checks that the header value matches your expected token.\n\n#### Python Example (Static Token)\n\n```python\nimport hmac\n\nfrom flask import Flask, request, abort\n\napp = Flask(__name__)\n\nWEBHOOK_TOKEN = \"your_static_token_here\"  # min 32 characters\nTOKEN_HEADER = \"X-Webhook-Secret\"  # configurable in your webhook settings\n\n\n@app.route(\"/webhooks/lightyear\", methods=[\"POST\"])\ndef handle_webhook():\n    token = request.headers.get(TOKEN_HEADER, \"\")\n\n    if not hmac.compare_digest(token, WEBHOOK_TOKEN):\n        abort(401, \"Invalid token\")\n\n    event = request.get_json()\n    event_type = event[\"event_type\"]\n    delivery_id = request.headers.get(\"X-Delivery-Id\")\n\n    # TODO: Check delivery_id for idempotency (skip if already processed)\n\n    print(f\"Received {event_type} for {event['resource_type']} {event['resource_id']}\")\n\n    print(event[\"data\"])\n\n    return \"\", 200\n\n\nif __name__ == \"__main__\":\n    app.run(port=3000)\n```\n\n#### Node.js Example (Static Token)\n\n```node\nconst crypto = require(\"crypto\");\nconst express = require(\"express\");\n\nconst app = express();\napp.use(express.json());\n\nconst WEBHOOK_TOKEN = \"your_static_token_here\"; // min 32 characters\nconst TOKEN_HEADER = \"x-webhook-secret\"; // configurable in your webhook settings (lowercase for Express)\n\napp.post(\"/webhooks/lightyear\", (req, res) => {\n  const token = req.headers[TOKEN_HEADER] || \"\";\n\n  const tokenBuf = Buffer.from(token);\n  const expectedBuf = Buffer.from(WEBHOOK_TOKEN);\n  if (\n    tokenBuf.length !== expectedBuf.length ||\n    !crypto.timingSafeEqual(tokenBuf, expectedBuf)\n  ) {\n    return res.status(401).send(\"Invalid token\");\n  }\n\n  const event = req.body;\n  const deliveryId = req.headers[\"x-delivery-id\"];\n\n  // TODO: Check deliveryId for idempotency (skip if already processed)\n\n  console.log(\n    `Received ${event.event_type} for ${event.resource_type} ${event.resource_id}`,\n  );\n\n  console.log(JSON.stringify(event.data));\n\n  res.status(200).send();\n});\n\napp.listen(3000, () => console.log(\"Webhook receiver listening on port 3000\"));\n```\n\n## Retry Policy\n\nIf your endpoint does not return a `2xx` response (or is unreachable), Lightyear retries the delivery with **exponential backoff**:\n\n| Attempt | Approximate Delay |\n|---|---|\n| 1 | Immediate to 1 minute |\n| 2 | ~15 minutes |\n| 3 | ~30 minutes |\n| 4 | ~1 hour |\n| 5 | ~2 hours |\n\nAfter **5 failed attempts**, the delivery is marked as permanently failed. Each retry uses the same `X-Delivery-Id`, so use it for idempotency.\n\n## Event Deduplication\n\nLightyear deduplicates rapid-fire events for the same resource. If a resource triggers the same event type multiple times within **60 seconds**, only the latest event is delivered. This prevents noisy webhook bursts during bulk operations.\n\n## Testing Webhooks Locally\n\nDuring development you can use a tunneling tool to expose your local server to the internet:\n\n### Using ngrok\n1. Start your local webhook receiver\n\n```bash\npython app.py  # or: node app.js\n```\n\n2. In a separate terminal, start ngrok\n\n```bash\nngrok http 3000\n```\n\nExample output:\n\n```text\n## Example output                                                                                                                              \n# ngrok                                                                                                                                                      (Ctrl+C to quit)\n                                                                                                                                                                                                                                                      \n# Session Status                online                                                                                                                                                                                                                                                         \n# Version                       3.36.1                                                                                                                                       \n# Region                        United States (us)                                                                                                                           \n# Latency                       33ms                                                                                                                                         \n# Web Interface                 http://127.0.0.1:4040                                                                                                                        \n# Forwarding                    https://random-name.ngrok-free.dev -> http://localhost:3000                                                                \n                                                                                                                                                                           \n# Connections                   ttl     opn     rt1     rt5     p50     p90                                                                                                  \n#                               0       0       0.00    0.00    0.00    0.00   \n```\n\n3. Copy the HTTPS forwarding URL (e.g., https://random-name.ngrok-free.dev)\n4. Create a new webhook subscription on the [Webhooks settings page](https://app.lightyear.ai/dashboard/settings/api) in the Lightyear platform (Settings \u2192 API \u2192 Webhooks).\n    - Enter the HTTPS forwarding URL + the path to your webhook receiver endpoint as the webhook URL (e.g. https://random-name.ngrok-free.dev/webhooks/lightyear)\n    - copy the WEBHOOK_TOKEN or WEBHOOK_SECRET from your sample app\n    - Select the event types you want to receive\n    - Click \"Save\"\n5. Test the webhook by triggering an event in the Lightyear platform (e.g. update service details)\n6. Wait 1 minute and watch for the event in your local server's console output\n\n### Tips for Local Testing\n\n- Always use the **HTTPS** URL provided by the tunnel (Lightyear rejects HTTP)\n- Tunnel URLs change on restart \u2014 update your webhook registration each time (or use a stable subdomain)\n- Log the raw request body and headers to debug signature validation issues\n- Use the `X-Delivery-Id` header to correlate deliveries in the Lightyear dashboard\n\n## Key Rotation\n\nRotating your webhook credentials ensures continuity \u2014 no missed deliveries during the switch. The rotation behavior differs by authentication type.\n\n### HMAC-SHA256 Rotation\n\n1. **Initiate rotation** \u2014 Add a new secret through the Lightyear dashboard or API. Lightyear stores both the old and new secrets.\n2. **Overlap window** \u2014 For the next **24 hours**, every delivery includes **two signatures** in the `X-Webhook-Signature` header (comma-separated): one signed with the new secret and one with the old.\n3. **Update your receiver** \u2014 Deploy your new secret. During the overlap window, your validation code should accept a match against *either* signature (the sample code above already handles this).\n4. **Automatic expiry** \u2014 After 24 hours the old secret is discarded and only the new signature is sent.\n\n### Static Token Rotation\n\nStatic token rotation works differently \u2014 only one token can be sent at a time, so Lightyear continues sending the **old token** for a **24-hour grace period** after you initiate rotation, giving you time to deploy the new token to your receiver before it takes effect.\n\n1. **Initiate rotation** \u2014 Generate a new token through the Lightyear dashboard or API.\n2. **Grace period** \u2014 For the next **24 hours**, deliveries continue using the **old token**. Use this window to update your receiver to accept the new token.\n3. **Automatic switchover** \u2014 After 24 hours the old token is discarded and deliveries begin using the new token.\n\n> **Important:** Unlike HMAC-SHA256 rotation, static token rotation does *not* send both values simultaneously. Make sure your receiver is updated to accept the new token before the 24-hour grace period expires.\n\n### Rotation Checklist\n\n1. Initiate credential rotation in Lightyear\n2. Deploy the new secret/token to your receiver (you have 24 hours)\n3. Verify deliveries are succeeding after the switchover\n4. No further action needed \u2014 the old credential expires automatically\n\n## Origin IP Addresses\n\nTo further secure your webhook endpoint, you can restrict inbound traffic to Lightyear's origin IP addresses.\n```json\n{\n  \"ips\": [\n    \"3.150.176.172\",\n    \"3.135.92.9\",\n    \"3.135.105.48\"\n  ]\n}\n```\n\n## Best Practices\n\n1. **Always verify signatures** \u2014 Never process a webhook payload without validating the HMAC signature first\n2. **Respond quickly** \u2014 Return `200` immediately and process the event asynchronously. Deliveries time out after 10 seconds.\n3. **Implement idempotency** \u2014 Use `X-Delivery-Id` to deduplicate. The same delivery may arrive more than once due to retries.\n4. **Use HTTPS** \u2014 Your endpoint must be HTTPS. Self-signed certificates are not accepted.\n5. **Monitor delivery health** \u2014 Check the Lightyear dashboard for failed deliveries and address issues promptly.\n6. **Rotate secrets periodically** \u2014 Rotate your webhook secret on a regular cadence (e.g., every 90 days) as a security best practice.\n", "termsOfService": "https://lightyear.ai/terms-of-use", "x-logo": {"url": "https://lightyear.ai/images/home/lightyear-logo.svg", "altText": "Lightyear Logo"}}, "paths": {"/developer/oauth/token": {"post": {"operationId": "lightyear_api_views_oauth_api_create_token_v1", "summary": "Create Token V1", "parameters": [], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TokenOutV1"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TokenErrorOutV1"}}}}, "401": {"description": "Unauthorized", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TokenErrorOutV1"}}}}}, "tags": ["OAuth"], "description": "OAuth2 client credentials token endpoint (RFC 6749). Send `grant_type=client_credentials` as a form-encoded body, with your API key and secret as the client id and client secret via HTTP Basic auth or the `client_id`/`client_secret` body parameters. The returned bearer token is sent on subsequent requests as `Authorization: Bearer <access_token>`.", "security": []}}, "/developer/contracts/v1": {"get": {"operationId": "lightyear_api_views_contracts_api_list_contracts_v1", "summary": "List Contracts V1", "parameters": [{"in": "query", "name": "updated_since", "schema": {"anyOf": [{"format": "date-time", "type": "string"}, {"type": "null"}], "description": "Return only contracts updated at or after this ISO-8601 datetime, for delta sync, e.g. `?updated_since=2026-08-19T15:30:00Z`.<br/><br/>A contract counts as updated when its own record, its services, or its files change. Compare against the `updated_at` field in the response and checkpoint from it rather than your own clock. Deleted or deactivated records simply stop appearing in results \u2014 run a periodic full reconciliation pass to catch removals. To avoid missing writes that commit while a sync is running, overlap watermarks: pass the time your previous sync run <i>started</i>, not when it finished. Naive datetimes are treated as UTC.", "title": "Updated Since"}, "required": false, "description": "Return only contracts updated at or after this ISO-8601 datetime, for delta sync, e.g. `?updated_since=2026-08-19T15:30:00Z`.<br/><br/>A contract counts as updated when its own record, its services, or its files change. Compare against the `updated_at` field in the response and checkpoint from it rather than your own clock. Deleted or deactivated records simply stop appearing in results \u2014 run a periodic full reconciliation pass to catch removals. To avoid missing writes that commit while a sync is running, overlap watermarks: pass the time your previous sync run <i>started</i>, not when it finished. Naive datetimes are treated as UTC."}, {"in": "query", "name": "page", "schema": {"default": 1, "minimum": 1, "title": "Page", "type": "integer"}, "required": false}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PagedContractOutV1"}}}}}, "tags": ["Contracts"], "security": [{"LightyearOAuthBearerAuth": []}, {"LightyearHMACAuth": []}]}}, "/developer/contracts/{id}/v1": {"get": {"operationId": "lightyear_api_views_contracts_api_get_contract_v1", "summary": "Get Contract V1", "parameters": [{"in": "path", "name": "id", "schema": {"format": "uuid", "title": "Id", "type": "string"}, "required": true}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ContractDetailOutV1"}}}}}, "tags": ["Contracts"], "security": [{"LightyearOAuthBearerAuth": []}, {"LightyearHMACAuth": []}]}}, "/developer/contracts/documents/{contract_file_id}/signed/v1": {"post": {"operationId": "lightyear_api_views_contracts_api_upload_signed_document", "summary": "Upload Signed Document", "parameters": [{"in": "path", "name": "contract_file_id", "schema": {"format": "uuid", "title": "Contract File Id", "type": "string"}, "required": true}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ContractFileOutV1"}}}}}, "description": "Upload a signed version of an existing contract document.", "tags": ["Contracts"], "requestBody": {"content": {"multipart/form-data": {"schema": {"properties": {"file": {"format": "binary", "title": "File", "type": "string"}}, "required": ["file"], "title": "FileParams", "type": "object"}}}, "required": true}, "security": [{"LightyearOAuthBearerAuth": []}, {"LightyearHMACAuth": []}]}}, "/developer/contracts/{id}/documents/{document_id}/v1": {"get": {"operationId": "lightyear_api_views_contracts_api_download_contract_document_v1", "summary": "Download Contract Document V1", "parameters": [{"in": "path", "name": "id", "schema": {"format": "uuid", "title": "Id", "type": "string"}, "required": true}, {"in": "path", "name": "document_id", "schema": {"format": "uuid", "title": "Document Id", "type": "string"}, "required": true}], "responses": {"200": {"description": "OK", "content": {"application/pdf": {"schema": {"type": "string", "format": "binary"}}, "*/*": {"schema": {"type": "string", "format": "binary"}}}}}, "tags": ["Contracts"], "security": [{"LightyearOAuthBearerAuth": []}, {"LightyearHMACAuth": []}]}}, "/developer/locations/v1": {"get": {"operationId": "lightyear_api_views_locations_api_list_locations_v1", "summary": "List Locations V1", "parameters": [{"in": "query", "name": "updated_since", "schema": {"anyOf": [{"format": "date-time", "type": "string"}, {"type": "null"}], "description": "Return only locations updated at or after this ISO-8601 datetime, for delta sync, e.g. `?updated_since=2026-08-19T15:30:00Z`.<br/><br/>A location counts as updated when its own record changes (name, status, custom fields) or when a service is associated with it. Compare against the `updated_at` field in the response and checkpoint from it rather than your own clock. Deleted or deactivated records simply stop appearing in results \u2014 run a periodic full reconciliation pass to catch removals. To avoid missing writes that commit while a sync is running, overlap watermarks: pass the time your previous sync run <i>started</i>, not when it finished. Naive datetimes are treated as UTC.", "title": "Updated Since"}, "required": false, "description": "Return only locations updated at or after this ISO-8601 datetime, for delta sync, e.g. `?updated_since=2026-08-19T15:30:00Z`.<br/><br/>A location counts as updated when its own record changes (name, status, custom fields) or when a service is associated with it. Compare against the `updated_at` field in the response and checkpoint from it rather than your own clock. Deleted or deactivated records simply stop appearing in results \u2014 run a periodic full reconciliation pass to catch removals. To avoid missing writes that commit while a sync is running, overlap watermarks: pass the time your previous sync run <i>started</i>, not when it finished. Naive datetimes are treated as UTC."}, {"in": "query", "name": "page", "schema": {"default": 1, "minimum": 1, "title": "Page", "type": "integer"}, "required": false}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PagedLocationOutV1"}}}}}, "tags": ["Locations"], "security": [{"LightyearOAuthBearerAuth": []}, {"LightyearHMACAuth": []}]}, "post": {"operationId": "lightyear_api_views_locations_api_create_address", "summary": "Create Address", "parameters": [], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/LocationOutV1"}}}}}, "tags": ["Locations"], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/LocationInV1"}}}, "required": true}, "security": [{"LightyearOAuthBearerAuth": []}, {"LightyearHMACAuth": []}]}}, "/developer/locations/{id}/v1": {"put": {"operationId": "lightyear_api_views_locations_api_update_location", "summary": "Update Location", "parameters": [{"in": "path", "name": "id", "schema": {"format": "uuid", "title": "Id", "type": "string"}, "required": true}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/LocationOutV1"}}}}}, "description": "Update a location's name, status, and/or custom columns.", "tags": ["Locations"], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/LocationUpdateInV1"}}}, "required": true}, "security": [{"LightyearOAuthBearerAuth": []}, {"LightyearHMACAuth": []}]}}, "/developer/projects/v1": {"post": {"operationId": "lightyear_api_views_projects_api_create_project_v1", "summary": "Create Project V1", "parameters": [], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ProjectOutV1"}}}}}, "description": "This endpoint is designed for scenarios where multiple services should be evaluated together as part of the same project rather than as separate, independent services.\n\n**When to use this endpoint:**\n- You have multiple services that are part of the same initiative that you would like to evaluate from a bulk perspective\n- Services share common project-level notes or requirements\n- Services should be tracked and managed together throughout the evaluation process\n- You are evaluating multiple WAN connections for a site, and will not choose to move forward with all of them\n\nAll services within a project will be created with the same project name and can include both project-level notes (applied to all services) and service-specific comments. More detailed request config documentation can be found in the Create Service Request Config documentation.", "tags": ["Projects"], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/ProjectCreateV1"}}}, "required": true}, "security": [{"LightyearOAuthBearerAuth": []}, {"LightyearHMACAuth": []}]}}, "/developer/services/v1": {"get": {"operationId": "lightyear_api_views_services_api_list_services_v1", "summary": "List Services V1", "parameters": [{"in": "query", "name": "status", "schema": {"anyOf": [{"items": {"$ref": "#/components/schemas/ApiServiceStatusChoices"}, "type": "array"}, {"type": "null"}], "description": "Filter services by status. If omitted, all statuses are returned. Repeat the param to combine values, e.g. `?status=in_progress&status=active`.<br/><br/>Status maps to a service's `current_step` as follows:<ul><li><code>in_progress</code> \u2014 <code>contract_requested</code>, <code>contract_received</code>, <code>order_submitted</code>, <code>pending_installation</code></li><li><code>active</code> \u2014 <code>service_installed</code> (installed and billing)</li><li><code>inactive</code> \u2014 manually deactivated services (e.g. terminated)</li></ul>", "title": "Status"}, "required": false, "description": "Filter services by status. If omitted, all statuses are returned. Repeat the param to combine values, e.g. `?status=in_progress&status=active`.<br/><br/>Status maps to a service's `current_step` as follows:<ul><li><code>in_progress</code> \u2014 <code>contract_requested</code>, <code>contract_received</code>, <code>order_submitted</code>, <code>pending_installation</code></li><li><code>active</code> \u2014 <code>service_installed</code> (installed and billing)</li><li><code>inactive</code> \u2014 manually deactivated services (e.g. terminated)</li></ul>"}, {"in": "query", "name": "tags", "schema": {"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "null"}], "description": "Filter services by tag labels applied via the Manage Tags UI. Match is case-insensitive but exact \u2014 `?tags=phase` will not match a tag labelled `Phase Two`. Repeat the param to combine values with OR, e.g. `?tags=Priority&tags=Urgent`. Spaces in labels should be URL-encoded \u2014 either `%20` or `+` works, e.g. `?tags=Phase%20Two` or `?tags=Phase+Two`.", "title": "Tags"}, "required": false, "description": "Filter services by tag labels applied via the Manage Tags UI. Match is case-insensitive but exact \u2014 `?tags=phase` will not match a tag labelled `Phase Two`. Repeat the param to combine values with OR, e.g. `?tags=Priority&tags=Urgent`. Spaces in labels should be URL-encoded \u2014 either `%20` or `+` works, e.g. `?tags=Phase%20Two` or `?tags=Phase+Two`."}, {"in": "query", "name": "project_id", "schema": {"anyOf": [{"format": "uuid", "type": "string"}, {"type": "null"}], "description": "Filter services to those in a single project. This is the `id` returned from `POST /developer/projects/v1`.", "title": "Project Id"}, "required": false, "description": "Filter services to those in a single project. This is the `id` returned from `POST /developer/projects/v1`."}, {"in": "query", "name": "current_step", "schema": {"anyOf": [{"items": {"$ref": "#/components/schemas/CurrentStepChoices"}, "type": "array"}, {"type": "null"}], "description": "Filter services by their current step in the Lightyear lifecycle. Repeat the param to combine values, e.g. `?current_step=out_for_quote&current_step=quote_received`.", "title": "Current Step"}, "required": false, "description": "Filter services by their current step in the Lightyear lifecycle. Repeat the param to combine values, e.g. `?current_step=out_for_quote&current_step=quote_received`."}, {"in": "query", "name": "updated_since", "schema": {"anyOf": [{"format": "date-time", "type": "string"}, {"type": "null"}], "description": "Return only services updated at or after this ISO-8601 datetime, for delta sync, e.g. `?updated_since=2026-08-19T15:30:00Z`.<br/><br/>A service counts as updated when its own record <i>or</i> sync-relevant related data changes: service details, locations and their addresses, provider sub-components, the contract, or tags \u2014 the same changes that would alter the response of `GET /developer/services/{id}/v1`. Compare against the `updated_at` field in the response and checkpoint from it rather than your own clock. Deleted or deactivated records simply stop appearing in results \u2014 run a periodic full reconciliation pass to catch removals. To avoid missing writes that commit while a sync is running, overlap watermarks: pass the time your previous sync run <i>started</i>, not when it finished. Naive datetimes are treated as UTC.", "title": "Updated Since"}, "required": false, "description": "Return only services updated at or after this ISO-8601 datetime, for delta sync, e.g. `?updated_since=2026-08-19T15:30:00Z`.<br/><br/>A service counts as updated when its own record <i>or</i> sync-relevant related data changes: service details, locations and their addresses, provider sub-components, the contract, or tags \u2014 the same changes that would alter the response of `GET /developer/services/{id}/v1`. Compare against the `updated_at` field in the response and checkpoint from it rather than your own clock. Deleted or deactivated records simply stop appearing in results \u2014 run a periodic full reconciliation pass to catch removals. To avoid missing writes that commit while a sync is running, overlap watermarks: pass the time your previous sync run <i>started</i>, not when it finished. Naive datetimes are treated as UTC."}, {"in": "query", "name": "page", "schema": {"default": 1, "minimum": 1, "title": "Page", "type": "integer"}, "required": false}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PagedServiceWithCancellationOutV1"}}}}}, "tags": ["Services"], "security": [{"LightyearOAuthBearerAuth": []}, {"LightyearHMACAuth": []}]}, "post": {"operationId": "lightyear_api_views_services_api_create_service_request_v1", "summary": "Create Service Request V1", "parameters": [], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/PostOrderSubmissionServiceDetailOutV1"}, {"$ref": "#/components/schemas/PreOrderSubmissionServiceDetailOutV1"}], "title": "Response"}}}}}, "tags": ["Services"], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/ServiceInV1"}}}, "required": true}, "security": [{"LightyearOAuthBearerAuth": []}, {"LightyearHMACAuth": []}]}}, "/developer/services/{id}/v1": {"put": {"operationId": "lightyear_api_views_services_api_update_service", "summary": "Update Service", "parameters": [{"in": "path", "name": "id", "schema": {"format": "uuid", "title": "Id", "type": "string"}, "required": true}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/PostOrderSubmissionServiceDetailOutV1"}, {"$ref": "#/components/schemas/PreOrderSubmissionServiceDetailOutV1"}], "title": "Response"}}}}}, "description": "Update a service if it is past Contract Requested. Most fields are only editable past Order Submitted, exceptions are listed in the field description. Currently only supports certain fields, contact the Lightyear team if you need other fields updated.", "tags": ["Services"], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/ServiceUpdateInV1"}}}, "required": true}, "security": [{"LightyearOAuthBearerAuth": []}, {"LightyearHMACAuth": []}]}, "get": {"operationId": "lightyear_api_views_services_api_get_service_v1", "summary": "Get Service V1", "parameters": [{"in": "path", "name": "id", "schema": {"format": "uuid", "title": "Id", "type": "string"}, "required": true}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/PostOrderSubmissionServiceDetailOutV1"}, {"$ref": "#/components/schemas/PreOrderSubmissionServiceDetailOutV1"}], "title": "Response"}}}}}, "tags": ["Services"], "security": [{"LightyearOAuthBearerAuth": []}, {"LightyearHMACAuth": []}]}}, "/developer/services/{id}/quotes/v1": {"get": {"operationId": "lightyear_api_views_services_api_get_service_quotes_v1", "summary": "Get Service Quotes V1", "parameters": [{"in": "path", "name": "id", "schema": {"format": "uuid", "title": "Id", "type": "string"}, "required": true}, {"in": "query", "name": "page", "schema": {"default": 1, "minimum": 1, "title": "Page", "type": "integer"}, "required": false}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PagedQuoteOutV1"}}}}}, "tags": ["Services"], "security": [{"LightyearOAuthBearerAuth": []}, {"LightyearHMACAuth": []}]}}, "/developer/services/{id}/install-tracking/v1": {"get": {"operationId": "lightyear_api_views_services_api_get_service_install_tracking_v1", "summary": "Get Service Install Tracking V1", "parameters": [{"in": "path", "name": "id", "schema": {"format": "uuid", "title": "Id", "type": "string"}, "required": true}, {"in": "query", "name": "page", "schema": {"default": 1, "minimum": 1, "title": "Page", "type": "integer"}, "required": false}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PagedInstallTrackingLocationOutV1"}}}}}, "tags": ["Services"], "security": [{"LightyearOAuthBearerAuth": []}, {"LightyearHMACAuth": []}]}}, "/developer/services/{id}/events/v1": {"get": {"operationId": "lightyear_api_views_services_api_get_service_events_v1", "summary": "Get Service Events V1", "parameters": [{"in": "path", "name": "id", "schema": {"format": "uuid", "title": "Id", "type": "string"}, "required": true}, {"in": "query", "name": "page", "schema": {"default": 1, "minimum": 1, "title": "Page", "type": "integer"}, "required": false}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PagedEventOutV1"}}}}}, "tags": ["Services"], "security": [{"LightyearOAuthBearerAuth": []}, {"LightyearHMACAuth": []}]}}, "/developer/team/v1": {"get": {"operationId": "lightyear_api_views_team_api_team_v1", "summary": "Team V1", "parameters": [], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TeamOutV1"}}}}}, "tags": ["Team"], "security": [{"LightyearOAuthBearerAuth": []}, {"LightyearHMACAuth": []}]}}, "/developer/team/users/v1": {"get": {"operationId": "lightyear_api_views_team_api_list_team_users_v1", "summary": "List Team Users V1", "parameters": [{"in": "query", "name": "page", "schema": {"default": 1, "minimum": 1, "title": "Page", "type": "integer"}, "required": false}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PagedTeamUserOutV1"}}}}}, "tags": ["Team"], "security": [{"LightyearOAuthBearerAuth": []}, {"LightyearHMACAuth": []}], "description": "Lists all active users on your Lightyear team"}}, "/developer/team/contacts/v1": {"get": {"operationId": "lightyear_api_views_team_api_list_team_contacts_v1", "summary": "List Team Contacts V1", "parameters": [{"in": "query", "name": "page", "schema": {"default": 1, "minimum": 1, "title": "Page", "type": "integer"}, "required": false}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PagedContactDashboardOutV1"}}}}}, "tags": ["Team"], "security": [{"LightyearOAuthBearerAuth": []}, {"LightyearHMACAuth": []}], "description": "Lists contacts outside of your Lightyear users that you want to share information with."}}, "/developer/team/documents/v1": {"get": {"operationId": "lightyear_api_views_team_api_list_team_documents_v1", "summary": "List Team Documents V1", "parameters": [{"in": "query", "name": "page", "schema": {"default": 1, "minimum": 1, "title": "Page", "type": "integer"}, "required": false}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PagedTeamDocumentOutV1"}}}}}, "tags": ["Team"], "security": [{"LightyearOAuthBearerAuth": []}, {"LightyearHMACAuth": []}]}}, "/developer/team/documents/{id}/v1": {"get": {"operationId": "lightyear_api_views_team_api_download_team_document_v1", "summary": "Download Team Document V1", "parameters": [{"in": "path", "name": "id", "schema": {"title": "Id", "type": "string"}, "required": true}], "responses": {"200": {"description": "OK", "content": {"application/pdf": {"schema": {"type": "string", "format": "binary"}}, "*/*": {"schema": {"type": "string", "format": "binary"}}}}}, "tags": ["Team"], "security": [{"LightyearOAuthBearerAuth": []}, {"LightyearHMACAuth": []}]}}, "/developer/tickets/v1": {"get": {"operationId": "lightyear_api_views_tickets_api_list_tickets_v1", "summary": "List Tickets V1", "parameters": [{"in": "query", "name": "updated_since", "schema": {"anyOf": [{"format": "date-time", "type": "string"}, {"type": "null"}], "description": "Return only tickets updated at or after this ISO-8601 datetime, for delta sync, e.g. `?updated_since=2026-08-19T15:30:00Z`.<br/><br/>A ticket counts as updated when its own record, its messages, or its attachments change. Changes to the associated service do not count \u2014 sync services via `GET /developer/services/v1`. Compare against the `updated_at` field in the response and checkpoint from it rather than your own clock. Deleted or deactivated records simply stop appearing in results \u2014 run a periodic full reconciliation pass to catch removals. To avoid missing writes that commit while a sync is running, overlap watermarks: pass the time your previous sync run <i>started</i>, not when it finished. Naive datetimes are treated as UTC.", "title": "Updated Since"}, "required": false, "description": "Return only tickets updated at or after this ISO-8601 datetime, for delta sync, e.g. `?updated_since=2026-08-19T15:30:00Z`.<br/><br/>A ticket counts as updated when its own record, its messages, or its attachments change. Changes to the associated service do not count \u2014 sync services via `GET /developer/services/v1`. Compare against the `updated_at` field in the response and checkpoint from it rather than your own clock. Deleted or deactivated records simply stop appearing in results \u2014 run a periodic full reconciliation pass to catch removals. To avoid missing writes that commit while a sync is running, overlap watermarks: pass the time your previous sync run <i>started</i>, not when it finished. Naive datetimes are treated as UTC."}, {"in": "query", "name": "page", "schema": {"default": 1, "minimum": 1, "title": "Page", "type": "integer"}, "required": false}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PagedTicketOutV1"}}}}}, "tags": ["Tickets"], "security": [{"LightyearOAuthBearerAuth": []}, {"LightyearHMACAuth": []}]}, "post": {"operationId": "lightyear_api_views_tickets_api_create_ticket", "summary": "Create Ticket", "parameters": [], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TicketDetailOutV1"}}}}}, "description": "Create a new ticket for an installed service.", "tags": ["Tickets"], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/TicketInV1"}}}, "required": true}, "security": [{"LightyearOAuthBearerAuth": []}, {"LightyearHMACAuth": []}]}}, "/developer/tickets/{id}/v1": {"get": {"operationId": "lightyear_api_views_tickets_api_get_ticket_v1", "summary": "Get Ticket V1", "parameters": [{"in": "path", "name": "id", "schema": {"format": "uuid", "title": "Id", "type": "string"}, "required": true}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TicketDetailOutV1"}}}}}, "tags": ["Tickets"], "security": [{"LightyearOAuthBearerAuth": []}, {"LightyearHMACAuth": []}]}}, "/developer/tickets/{id}/documents/{document_id}/v1": {"get": {"operationId": "lightyear_api_views_tickets_api_download_ticket_document_v1", "summary": "Download Ticket Document V1", "parameters": [{"in": "path", "name": "id", "schema": {"format": "uuid", "title": "Id", "type": "string"}, "required": true}, {"in": "path", "name": "document_id", "schema": {"format": "uuid", "title": "Document Id", "type": "string"}, "required": true}], "responses": {"200": {"description": "OK", "content": {"application/pdf": {"schema": {"type": "string", "format": "binary"}}, "*/*": {"schema": {"type": "string", "format": "binary"}}}}}, "tags": ["Tickets"], "security": [{"LightyearOAuthBearerAuth": []}, {"LightyearHMACAuth": []}]}}, "/developer/action-items/v1": {"get": {"operationId": "lightyear_api_views_action_items_api_list_action_items_v1", "summary": "List Action Items V1", "parameters": [{"in": "query", "name": "updated_since", "schema": {"anyOf": [{"format": "date-time", "type": "string"}, {"type": "null"}], "description": "Return only action items updated at or after this ISO-8601 datetime, for delta sync, e.g. `?updated_since=2026-08-19T15:30:00Z`.<br/><br/>An action item counts as updated when its own record, its comments, or its attachments change. Compare against the `updated_at` field in the response and checkpoint from it rather than your own clock. Deleted or deactivated records simply stop appearing in results \u2014 run a periodic full reconciliation pass to catch removals. To avoid missing writes that commit while a sync is running, overlap watermarks: pass the time your previous sync run <i>started</i>, not when it finished. Naive datetimes are treated as UTC.", "title": "Updated Since"}, "required": false, "description": "Return only action items updated at or after this ISO-8601 datetime, for delta sync, e.g. `?updated_since=2026-08-19T15:30:00Z`.<br/><br/>An action item counts as updated when its own record, its comments, or its attachments change. Compare against the `updated_at` field in the response and checkpoint from it rather than your own clock. Deleted or deactivated records simply stop appearing in results \u2014 run a periodic full reconciliation pass to catch removals. To avoid missing writes that commit while a sync is running, overlap watermarks: pass the time your previous sync run <i>started</i>, not when it finished. Naive datetimes are treated as UTC."}, {"in": "query", "name": "page", "schema": {"default": 1, "minimum": 1, "title": "Page", "type": "integer"}, "required": false}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PagedActionItemOutV1"}}}}}, "tags": ["Action Items"], "security": [{"LightyearOAuthBearerAuth": []}, {"LightyearHMACAuth": []}]}}, "/developer/action-items/{id}/v1": {"get": {"operationId": "lightyear_api_views_action_items_api_get_action_item_v1", "summary": "Get Action Item V1", "parameters": [{"in": "path", "name": "id", "schema": {"format": "uuid", "title": "Id", "type": "string"}, "required": true}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ActionItemDetailOutV1"}}}}}, "tags": ["Action Items"], "security": [{"LightyearOAuthBearerAuth": []}, {"LightyearHMACAuth": []}]}}, "/developer/invoices/v1": {"get": {"operationId": "lightyear_api_views_invoices_api_list_invoices_v1", "summary": "List Invoices V1", "parameters": [{"in": "query", "name": "status", "schema": {"anyOf": [{"items": {"$ref": "#/components/schemas/InvoiceStatusChoices"}, "type": "array"}, {"type": "null"}], "description": "Filter by invoice status. Defaults to all visible statuses: ['OPEN', 'CLOSED', 'PAYMENT_ISSUED', 'SENT']", "title": "Status"}, "required": false, "description": "Filter by invoice status. Defaults to all visible statuses: ['OPEN', 'CLOSED', 'PAYMENT_ISSUED', 'SENT']"}, {"in": "query", "name": "provider", "schema": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Filter by provider name (case-insensitive partial match). <br/><b>Example:</b> \"Lumen\"", "title": "Provider"}, "required": false, "description": "Filter by provider name (case-insensitive partial match). <br/><b>Example:</b> \"Lumen\""}, {"in": "query", "name": "issue_date_from", "schema": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Filter invoices with issue date on or after this date. <br/><b>Example:</b> \"2024-01-01\"", "title": "Issue Date From"}, "required": false, "description": "Filter invoices with issue date on or after this date. <br/><b>Example:</b> \"2024-01-01\""}, {"in": "query", "name": "issue_date_to", "schema": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Filter invoices with issue date on or before this date. <br/><b>Example:</b> \"2024-12-31\"", "title": "Issue Date To"}, "required": false, "description": "Filter invoices with issue date on or before this date. <br/><b>Example:</b> \"2024-12-31\""}, {"in": "query", "name": "amount_min", "schema": {"anyOf": [{"minimum": 0.0, "type": "number"}, {"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Filter invoices with total amount greater than or equal to this value. <br/><b>Example:</b> 1000.00", "title": "Amount Min"}, "required": false, "description": "Filter invoices with total amount greater than or equal to this value. <br/><b>Example:</b> 1000.00"}, {"in": "query", "name": "amount_max", "schema": {"anyOf": [{"minimum": 0.0, "type": "number"}, {"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Filter invoices with total amount less than or equal to this value. <br/><b>Example:</b> 5000.00", "title": "Amount Max"}, "required": false, "description": "Filter invoices with total amount less than or equal to this value. <br/><b>Example:</b> 5000.00"}, {"in": "query", "name": "page", "schema": {"default": 1, "minimum": 1, "title": "Page", "type": "integer"}, "required": false}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PagedInvoiceOutV1"}}}}}, "tags": ["Invoices"], "security": [{"LightyearOAuthBearerAuth": []}, {"LightyearHMACAuth": []}]}}, "/developer/invoices/{id}/v1": {"get": {"operationId": "lightyear_api_views_invoices_api_get_invoice_v1", "summary": "Get Invoice V1", "parameters": [{"in": "path", "name": "id", "schema": {"format": "uuid", "title": "Id", "type": "string"}, "required": true}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InvoiceDetailOutV1"}}}}}, "tags": ["Invoices"], "security": [{"LightyearOAuthBearerAuth": []}, {"LightyearHMACAuth": []}]}}, "/developer/consolidated-bills/v1": {"get": {"operationId": "lightyear_api_views_consolidated_bills_api_list_consolidated_bills_v1", "summary": "List Consolidated Bills V1", "parameters": [{"in": "query", "name": "status", "schema": {"anyOf": [{"items": {"$ref": "#/components/schemas/ConsolidatedInvoiceStatusChoices"}, "type": "array"}, {"type": "null"}], "description": "Filter by consolidated bill status. Defaults to all visible statuses: ['OPEN', 'PAID']", "title": "Status"}, "required": false, "description": "Filter by consolidated bill status. Defaults to all visible statuses: ['OPEN', 'PAID']"}, {"in": "query", "name": "due_date_from", "schema": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Filter bills with due date on or after this date. <br/><b>Example:</b> \"2025-01-01\"", "title": "Due Date From"}, "required": false, "description": "Filter bills with due date on or after this date. <br/><b>Example:</b> \"2025-01-01\""}, {"in": "query", "name": "due_date_to", "schema": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Filter bills with due date on or before this date. <br/><b>Example:</b> \"2025-12-31\"", "title": "Due Date To"}, "required": false, "description": "Filter bills with due date on or before this date. <br/><b>Example:</b> \"2025-12-31\""}, {"in": "query", "name": "amount_min", "schema": {"anyOf": [{"minimum": 0.0, "type": "number"}, {"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Filter bills with total amount greater than or equal to this value. <br/><b>Example:</b> 1000.00", "title": "Amount Min"}, "required": false, "description": "Filter bills with total amount greater than or equal to this value. <br/><b>Example:</b> 1000.00"}, {"in": "query", "name": "amount_max", "schema": {"anyOf": [{"minimum": 0.0, "type": "number"}, {"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Filter bills with total amount less than or equal to this value. <br/><b>Example:</b> 100000.00", "title": "Amount Max"}, "required": false, "description": "Filter bills with total amount less than or equal to this value. <br/><b>Example:</b> 100000.00"}, {"in": "query", "name": "page", "schema": {"default": 1, "minimum": 1, "title": "Page", "type": "integer"}, "required": false}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PagedConsolidatedBillOutV1"}}}}}, "tags": ["Consolidated Bills"], "security": [{"LightyearOAuthBearerAuth": []}, {"LightyearHMACAuth": []}]}}, "/developer/consolidated-bills/{id}/v1": {"get": {"operationId": "lightyear_api_views_consolidated_bills_api_get_consolidated_bill_v1", "summary": "Get Consolidated Bill V1", "parameters": [{"in": "path", "name": "id", "schema": {"format": "uuid", "title": "Id", "type": "string"}, "required": true}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ConsolidatedBillDetailOutV1"}}}}}, "tags": ["Consolidated Bills"], "security": [{"LightyearOAuthBearerAuth": []}, {"LightyearHMACAuth": []}]}}}, "components": {"schemas": {"TokenOutV1": {"properties": {"access_token": {"description": "The bearer token to send on subsequent API requests", "title": "Access Token", "type": "string"}, "token_type": {"description": "Always \"Bearer\"", "title": "Token Type", "type": "string"}, "expires_in": {"description": "Token lifetime in seconds", "title": "Expires In", "type": "integer"}}, "required": ["access_token", "token_type", "expires_in"], "title": "TokenOutV1", "type": "object"}, "TokenErrorOutV1": {"properties": {"error": {"description": "RFC 6749 error code, e.g. \"invalid_client\", \"invalid_request\", or \"unsupported_grant_type\"", "title": "Error", "type": "string"}, "error_description": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Human readable details about the error", "title": "Error Description"}}, "required": ["error"], "title": "TokenErrorOutV1", "type": "object"}, "Input": {"properties": {"page": {"default": 1, "minimum": 1, "title": "Page", "type": "integer"}}, "title": "Input", "type": "object"}, "AccountOutV1": {"properties": {"first_name": {"description": "First Name of the Account. <br/><b>Example:</b> \"John\"", "title": "First Name", "type": "string"}, "last_name": {"description": "Last Name of the Account. <br/><b>Example:</b> \"Smith\"", "title": "Last Name", "type": "string"}, "email": {"description": "Email of the Account. <br/><b>Example:</b> \"john@example.com\"", "title": "Email", "type": "string"}}, "required": ["first_name", "last_name", "email"], "title": "AccountOutV1", "type": "object"}, "BasicLocationOutV1": {"properties": {"id": {"description": "ID of the Location.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Label for this location. <br/><b>Example:</b> \"LA Headquarters\"", "title": "Name", "type": "string"}, "address": {"description": "Full location address including floor, building, suite if applicable. <br/><b>Example:</b> \"123 Main St Unit B, Los Angeles, CA 90013, US\"", "title": "Address", "type": "string"}}, "required": ["id", "name", "address"], "title": "BasicLocationOutV1", "type": "object"}, "CancelStatusChoices": {"enum": ["not_cancelled", "cancel_requested", "cancelled"], "title": "CancelStatusChoices", "type": "string"}, "ContractFileOutV1": {"properties": {"id": {"description": "ID of the Contract File.", "format": "uuid", "title": "Id", "type": "string"}, "created_at": {"description": "Date and time when the contract file was created.", "format": "date-time", "title": "Created At", "type": "string"}, "name": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Name of the file including extension. <br/><b>Example:</b> \"my_file.pdf\"", "title": "Name"}, "file_url": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "URL to download the file. <br/><b>Example:</b> https://api.lightyear.ai/developer/contracts/aab3bdf7-457a-4823-80d1-24bd57845525/documents/5acb8c1d-deba-48c1-8837-39613a49a095/v1", "title": "File Url"}, "signed_by": {"anyOf": [{"$ref": "#/components/schemas/AccountOutV1"}, {"type": "null"}], "description": "Name of the individual who signed the file."}, "signed_date": {"anyOf": [{"format": "date-time", "type": "string"}, {"type": "null"}], "description": "Date the file was signed", "title": "Signed Date"}}, "required": ["id", "created_at"], "title": "ContractFileOutV1", "type": "object"}, "ContractOutV1": {"properties": {"id": {"description": "ID of the Contract.", "format": "uuid", "title": "Id", "type": "string"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Name of the Provider on the Contract. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "notice_period": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Notice period in days for contract ending/renewal. <br/><b>Example:</b> 30", "title": "Notice Period"}, "auto_renew_term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "The term that the contract will be on if it auto-renews (in months). <br/><b>Example:</b> 12", "title": "Auto Renew Term"}, "total_mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost for all services in this contract in the currency listed in \"total_mrc_code\". <br/><b>Example:</b> 100.00", "title": "Total Mrc Value"}, "total_mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Total Mrc Code"}, "total_mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost for all services in this contract in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Total Mrc Usd"}, "current_step": {"$ref": "#/components/schemas/CurrentStepChoices", "description": "Current step of the services on this contract. <br/><b>Example:</b> \"service_installed\""}, "cancelled": {"$ref": "#/components/schemas/CancelStatusChoices", "description": "Cancellation status of the services on this contract. <br/><b>Example:</b> \"not_cancelled\""}, "procured_by_lightyear": {"description": "Whether or not the quotes and installation process was managed by Lightyear", "title": "Procured By Lightyear", "type": "boolean"}, "contract_files": {"description": "List of files associated with the contract.", "items": {"$ref": "#/components/schemas/ContractFileOutV1"}, "title": "Contract Files", "type": "array"}, "services": {"description": "List of services associated with the contract.", "items": {"$ref": "#/components/schemas/ServiceOutV1"}, "title": "Services", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this contract, its services, or its files changed. Use with the `updated_since` filter on `GET /developer/contracts/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}}, "required": ["id", "auto_renew_term", "current_step", "cancelled", "procured_by_lightyear", "contract_files", "services", "updated_at"], "title": "ContractOutV1", "type": "object"}, "CurrentStepChoices": {"enum": ["info_received", "out_for_quote", "quote_received", "contract_requested", "contract_received", "order_submitted", "pending_installation", "service_installed"], "title": "CurrentStepChoices", "type": "string"}, "PagedContractOutV1": {"properties": {"items": {"items": {"$ref": "#/components/schemas/ContractOutV1"}, "title": "Items", "type": "array"}, "total_items": {"examples": [1], "title": "Total Items", "type": "integer"}, "total_pages": {"examples": [1], "title": "Total Pages", "type": "integer"}, "page": {"examples": [1], "title": "Page", "type": "integer"}, "per_page": {"examples": [100], "title": "Per Page", "type": "integer"}}, "required": ["items", "total_items", "total_pages", "page", "per_page"], "title": "PagedContractOutV1", "type": "object"}, "ServiceOutV1": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"$ref": "#/components/schemas/ServiceTypeChoices", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\""}, "current_step": {"$ref": "#/components/schemas/CurrentStepChoices", "description": "Current step of the service. <br/><b>Example:</b> \"service_installed\""}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/BasicLocationOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at"], "title": "ServiceOutV1", "type": "object"}, "ServiceStatusChoices": {"enum": ["onboarding", "active", "inactive", "in_progress"], "title": "ServiceStatusChoices", "type": "string"}, "ServiceTypeChoices": {"enum": ["wan_dark_fiber", "wan_wavelength", "wan_point_to_point", "wan_mpls", "wan_sd_wan", "wan_vpls", "internet", "voice_phone_lines", "voice_sip", "voice_pri", "voice_ucaas", "colocation", "direct_cloud_connect", "tv", "music", "security", "cross_connect", "mobile_line", "voice_voip_line", "voice_pots_line", "voice_pots_piab", "voice_long_distance", "voice_toll_free", "voice_rcf_line", "voice_ucaas_inv", "voice_hosted_voip", "voice_sip_ccp", "voice_voip_feature", "voice_voip_minutes", "voice_dids", "voice_pri_bri", "voice_other"], "title": "ServiceTypeChoices", "type": "string"}, "ContactDashboardOutV1": {"properties": {"name": {"description": "Name of the Contact. <br/><b>Example:</b> \"John Doe\"", "title": "Name", "type": "string"}, "email": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Email of the Contact. <br/><b>Example:</b> \"john@example.com\"", "title": "Email"}, "phone": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Phone Number of the Contact. <br/><b>Example:</b> \"555-5555-5555\"", "title": "Phone"}}, "required": ["name"], "title": "ContactDashboardOutV1", "type": "object"}, "ContractDetailOutV1": {"properties": {"id": {"description": "ID of the Contract.", "format": "uuid", "title": "Id", "type": "string"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Name of the Provider on the Contract. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "notice_period": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Notice period in days for contract ending/renewal. <br/><b>Example:</b> 30", "title": "Notice Period"}, "auto_renew_term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "The term that the contract will be on if it auto-renews (in months). <br/><b>Example:</b> 12", "title": "Auto Renew Term"}, "total_mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost for all services in this contract in the currency listed in \"total_mrc_code\". <br/><b>Example:</b> 100.00", "title": "Total Mrc Value"}, "total_mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Total Mrc Code"}, "total_mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost for all services in this contract in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Total Mrc Usd"}, "current_step": {"$ref": "#/components/schemas/CurrentStepChoices", "description": "Current step of the services on this contract. <br/><b>Example:</b> \"service_installed\""}, "cancelled": {"$ref": "#/components/schemas/CancelStatusChoices", "description": "Cancellation status of the services on this contract. <br/><b>Example:</b> \"not_cancelled\""}, "procured_by_lightyear": {"description": "Whether or not the quotes and installation process was managed by Lightyear", "title": "Procured By Lightyear", "type": "boolean"}, "contract_files": {"description": "List of files associated with the contract.", "items": {"$ref": "#/components/schemas/ContractFileOutV1"}, "title": "Contract Files", "type": "array"}, "services": {"description": "List of services associated with the contract.", "items": {"$ref": "#/components/schemas/ServiceOutV1"}, "title": "Services", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this contract, its services, or its files changed. Use with the `updated_since` filter on `GET /developer/contracts/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "legal_entity": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Legal Entity used for the Contract creation. <br/><b>Example:</b> \"ACME Inc\"", "title": "Legal Entity"}, "billing_address": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing address assigned by the user for the respective Contract. <br/>Example: \"123 Main St Unit B, Los Angeles, CA 90013, US\"", "title": "Billing Address"}, "billing_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the billing contact."}, "service_types": {"description": "List of service types associated with the contract.", "items": {"$ref": "#/components/schemas/ServiceTypeChoices"}, "title": "Service Types", "type": "array"}}, "required": ["id", "auto_renew_term", "current_step", "cancelled", "procured_by_lightyear", "contract_files", "services", "updated_at", "service_types"], "title": "ContractDetailOutV1", "type": "object"}, "CustomFieldOutV1": {"properties": {"key": {"description": "Machine-readable key for the custom field. <br/><b>Example:</b> \"circuitType\"", "title": "Key", "type": "string"}, "label": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Human-readable label configured by your team. <br/><b>Example:</b> \"Circuit Type\"", "title": "Label"}, "value": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Value of the custom field. <br/><b>Example:</b> \"Enterprise Network\"", "title": "Value"}}, "required": ["key"], "title": "CustomFieldOutV1", "type": "object"}, "LocationOutV1": {"properties": {"id": {"description": "ID of the Location.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Label for this location. <br/><b>Example:</b> \"LA Headquarters\"", "title": "Name", "type": "string"}, "address": {"description": "Full location address including floor, building, suite if applicable. <br/><b>Example:</b> \"123 Main St Unit B, Los Angeles, CA 90013, US\"", "title": "Address", "type": "string"}, "street": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Street segment of the location address. <br/><b>Example:</b> \"123 Main St\"", "title": "Street"}, "city": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "City segment of the location address. <br/><b>Example:</b> \"Los Angeles\"", "title": "City"}, "county": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "County segment of the location address. <br/><b>Example:</b> \"Los Angeles County\"", "title": "County"}, "state_province": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "State or Province segment of the location address. <br/><b>Example:</b> \"California\"", "title": "State Province"}, "postal_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Postal Code segment of the location address. <br/><b>Example:</b> \"90013\"", "title": "Postal Code"}, "country": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Country segment of the location address. <br/><b>Example:</b> \"US\"", "title": "Country"}, "address_line_two": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Location address field containing floor, building, or unit. <br/><b>Example:</b> \"B\"", "title": "Address Line Two"}, "lat": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Latitude of the location address. <br/><b>Example:</b> 34.0452", "title": "Lat"}, "lng": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Longitude of the location address. <br/><b>Example:</b> -118.2410", "title": "Lng"}, "data_center": {"default": false, "description": "Whether or not the location is a data center.", "title": "Data Center", "type": "boolean"}, "new_construction": {"default": false, "description": "Whether or not the location is new construction.", "title": "New Construction", "type": "boolean"}, "tower": {"default": false, "description": "Whether or not the location is a tower.", "title": "Tower", "type": "boolean"}, "handoff_details": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Handoff details that were provided by the user for this location. <br/><b>Example:</b> \"Rack\"", "title": "Handoff Details"}, "comments": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Comments that were provided by the user for this location. <br/><b>Example:</b> \"Site Operation Hours - Mon - Fri:  8:00 \u2013 5:00 PM\"", "title": "Comments"}, "status": {"description": "Status of the location. <br/><b>Example:</b> \"active\"", "title": "Status", "type": "string"}, "service_ids": {"description": "List of Service IDs associated with the location.", "items": {"format": "uuid", "type": "string"}, "title": "Service Ids", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this location. Settings can be found at /developer/team/v1 under key custom_fields_settings.addresses", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this location or its service associations changed. Use with the `updated_since` filter on `GET /developer/locations/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}}, "required": ["id", "name", "address", "status", "service_ids", "updated_at"], "title": "LocationOutV1", "type": "object"}, "PagedLocationOutV1": {"properties": {"items": {"items": {"$ref": "#/components/schemas/LocationOutV1"}, "title": "Items", "type": "array"}, "total_items": {"examples": [1], "title": "Total Items", "type": "integer"}, "total_pages": {"examples": [1], "title": "Total Pages", "type": "integer"}, "page": {"examples": [1], "title": "Page", "type": "integer"}, "per_page": {"examples": [100], "title": "Per Page", "type": "integer"}}, "required": ["items", "total_items", "total_pages", "page", "per_page"], "title": "PagedLocationOutV1", "type": "object"}, "LocationInV1": {"properties": {"name": {"description": "Label for this location. <br/><b>Example:</b> \"LA Headquarters\"", "title": "Name", "type": "string"}, "street": {"description": "Street segment of the location address. <br/><b>Example:</b> \"123 Main St\"", "title": "Street", "type": "string"}, "city": {"description": "City segment of the location address. <br/><b>Example:</b> \"Los Angeles\"", "title": "City", "type": "string"}, "county": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "County segment of the location address. <br/><b>Example:</b> \"Los Angeles County\"", "title": "County"}, "address_line_two": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Location address field containing floor, building, or unit. <br/><b>Example:</b> \"B\"", "title": "Address Line Two"}, "state_province": {"description": "State or Province segment of the location address. <br/><b>Example:</b> \"California\"", "title": "State Province", "type": "string"}, "postal_code": {"description": "Postal Code segment of the location address. <br/><b>Example:</b> \"90013\"", "title": "Postal Code", "type": "string"}, "country": {"description": "Country segment of the location address. <br/><b>Example:</b> \"US\"", "title": "Country", "type": "string"}, "lat": {"anyOf": [{"maximum": 90.0, "minimum": -90.0, "type": "number"}, {"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Latitude of the location address. Used to show your sites on a map. <br/><b>Example:</b> 34.0452", "title": "Lat"}, "lng": {"anyOf": [{"maximum": 180.0, "minimum": -180.0, "type": "number"}, {"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Longitude of the location address. Used to show your sites on a map. <br/><b>Example:</b> -118.2410", "title": "Lng"}, "data_center": {"default": false, "description": "Whether or not the location is a data center.", "title": "Data Center", "type": "boolean"}, "new_construction": {"default": false, "description": "Whether or not the location is new construction.", "title": "New Construction", "type": "boolean"}, "tower": {"default": false, "description": "Whether or not the location is a tower.", "title": "Tower", "type": "boolean"}, "handoff_details": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Handoff details for this location. <br/><b>Example:</b> \"Rack\"", "title": "Handoff Details"}, "comments": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Comments for this location. <br/><b>Example:</b> \"Site Operation Hours - Mon - Fri:  8:00 \u2013 5:00 PM\"", "title": "Comments"}}, "required": ["name", "street", "city", "state_province", "postal_code", "country"], "title": "LocationInV1", "type": "object"}, "LocationUpdateInV1": {"properties": {"name": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Updated label for this location. Must be unique within your team. <br/><b>Example:</b> \"LA Headquarters\"", "title": "Name"}, "status": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Status of the location. Accepted values: \"active\", \"closed\". <br/><b>Example:</b> \"active\"", "title": "Status"}, "custom_fields": {"anyOf": [{"additionalProperties": true, "type": "object"}, {"type": "null"}], "description": "Updated custom fields for this location. Fields configured by your team. Settings can be found at /developer/team/v1 under key custom_fields_settings.addresses", "title": "Custom Fields"}}, "title": "LocationUpdateInV1", "type": "object"}, "ProjectOutV1": {"properties": {"id": {"description": "Project ID", "format": "uuid", "title": "Id", "type": "string"}, "display_id": {"description": "Human-readable project ID. <br/><b>Example:</b> \"GIHTQT5\"", "title": "Display Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "team_id": {"description": "ID of the owning team", "format": "uuid", "title": "Team Id", "type": "string"}, "current_step": {"description": "Current project step. <br/><b>Example:</b> \"InfoReceived\"", "title": "Current Step", "type": "string"}, "services_count": {"description": "Number of services in project", "title": "Services Count", "type": "integer"}}, "required": ["id", "display_id", "project_name", "team_id", "current_step", "services_count"], "title": "ProjectOutV1", "type": "object"}, "InternetRequestConfigInV1": {"properties": {"download_speeds": {"description": "Download speed in mb/s. <br/><b>Example:</b> [500, 1000]", "items": {"enum": [10, 20, 50, 100, 200, 250, 300, 500, 1000, 2000, 5000, 10000, 40000, 100000, 400000, 800000], "type": "integer"}, "maxItems": 3, "minItems": 1, "title": "Download Speeds", "type": "array"}, "types": {"description": "Internet Types <br/><b>Example:</b> [\"Dedicated\", \"Broadband\"]", "items": {"$ref": "#/components/schemas/InternetTypeChoices"}, "minItems": 1, "title": "Types", "type": "array"}, "static_ips": {"anyOf": [{"enum": ["/26", "/27", "/28", "/29", "/30", "I need more", "None"], "type": "string"}, {"type": "null"}], "default": "None", "description": "Static IPs <br/><b>Example:</b> \"/29\"", "title": "Static Ips"}, "committed_burstable_rate": {"anyOf": [{"enum": ["10 mb/s", "50 mb/s", "100 mb/s", "200 mb/s", "300 mb/s", "500 mb/s", "1 gb/s", "2 gb/s", "3 gb/s", "4 gb/s", "5 gb/s", "10 gb/s", "20 gb/s", "40 gb/s", "100 gb/s"], "type": "string"}, {"const": "Not Burstable / Fixed Billing", "type": "string"}, {"type": "null"}], "default": "Not Burstable / Fixed Billing", "description": "Committed Bandwidth <br/><b>Example:</b> \"1 gb/s\"", "title": "Committed Burstable Rate"}, "burstable_bandwidth": {"anyOf": [{"enum": ["10 mb/s", "50 mb/s", "100 mb/s", "200 mb/s", "300 mb/s", "500 mb/s", "1 gb/s", "2 gb/s", "3 gb/s", "4 gb/s", "5 gb/s", "10 gb/s", "20 gb/s", "40 gb/s", "100 gb/s"], "type": "string"}, {"type": "null"}], "description": "Burstable Bandwidth \u2014 the maximum speed the circuit may burst to. Set it alongside a Committed Bandwidth speed. <br/><b>Example:</b> \"10 gb/s\"", "title": "Burstable Bandwidth"}, "managed_router": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "default": false, "description": "Whether you need a managed router <br/><b>Example:</b> true", "title": "Managed Router"}, "wifi_included": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "default": false, "description": "Whether wifi is included <br/><b>Example:</b> true", "title": "Wifi Included"}, "network_firewall": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "default": false, "description": "Network Firewall <br/><b>Example:</b> true", "title": "Network Firewall"}, "border_gateway_protocol": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "default": false, "description": "Border gateway protocol <br/><b>Example:</b> true", "title": "Border Gateway Protocol"}, "transports_dedicated": {"anyOf": [{"items": {"enum": ["Fiber", "FixedWireless"], "type": "string"}, "type": "array"}, {"type": "null"}], "default": ["Fiber"], "description": "Transports for dedicated internet. <br/><b>Example:</b> [\"Fiber\"]", "title": "Transports Dedicated"}, "transports_broadband": {"anyOf": [{"items": {"enum": ["Coax", "Fiber", "Copper", "FixedWireless", "Satellite", "Cellular"], "type": "string"}, "type": "array"}, {"type": "null"}], "default": ["Coax", "Fiber"], "description": "Transports for broadband internet. <br/><b>Example:</b> [\"Coax\", \"Fiber\"]", "title": "Transports Broadband"}}, "required": ["download_speeds", "types"], "title": "InternetRequestConfigInV1", "type": "object"}, "InternetTypeChoices": {"enum": ["Broadband", "Dedicated"], "title": "InternetTypeChoices", "type": "string"}, "ProjectCreateV1": {"properties": {"project_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Name of the project associated with the service. This will default to the service type and location name if not provided. 'Internet (NYC HQ)'", "title": "Project Name"}, "notes": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Additional notes or requirements for this project. These will be added to each service in the project. <br/><b>Example:</b> \"High priority installation needed by Q1\"", "title": "Notes"}, "services": {"description": "Services to add to project (minimum 1 required). Each service will be validated according to its type requirements. The project_name field will be ignored since it's provided at the project level.", "items": {"$ref": "#/components/schemas/ServiceInBaseV1"}, "minItems": 1, "title": "Services", "type": "array"}}, "required": ["services"], "title": "ProjectCreateV1", "type": "object"}, "RequestConfigInV1": {"properties": {"terms": {"description": "Terms in months. <br/><b>Example:</b> [60]", "items": {"enum": [12, 24, 36, 48, 60], "type": "integer"}, "maxItems": 3, "minItems": 1, "title": "Terms", "type": "array"}, "provider_allow": {"default": [], "description": "Preferred providers. <br/><b>Example:</b> [\"AT&T\", \"Lumen\"]", "items": {"type": "string"}, "title": "Provider Allow", "type": "array"}, "provider_deny": {"default": [], "description": "Providers you don't want quotes from. <br/><b>Example:</b> [\"AT&T\", \"Lumen\"]", "items": {"type": "string"}, "title": "Provider Deny", "type": "array"}, "comments": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Any additional comments or requirements for the request.", "title": "Comments"}, "detail_data": {"anyOf": [{"$ref": "#/components/schemas/InternetRequestConfigInV1"}, {"$ref": "#/components/schemas/WanRequestConfigInV1"}, {"$ref": "#/components/schemas/VoicePhoneLinesRequestConfigInV1"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> \n    {\"types\": [\"Dedicated\"], \"download_speeds\": [1000, 2000] }\n</b>", "title": "Detail Data"}}, "required": ["terms", "detail_data"], "title": "RequestConfigInV1", "type": "object"}, "ServiceInBaseV1": {"properties": {"location_ids": {"items": {"format": "uuid", "type": "string"}, "title": "Location Ids", "type": "array"}, "service_type": {"description": "In the platform, `wan_point_to_point` is \"Ethernet P2P\" and `wan_wavelength` is \"Wavelength P2P\". For other service types, please use the platform. <br/><b>Example:</b> \"internet\"", "enum": ["internet", "wan_point_to_point", "wan_wavelength", "voice_phone_lines"], "title": "Service Type", "type": "string"}, "request_config": {"$ref": "#/components/schemas/RequestConfigInV1"}}, "required": ["location_ids", "service_type", "request_config"], "title": "ServiceInBaseV1", "type": "object"}, "VoicePhoneLinesRequestConfigInV1": {"properties": {"phone_line_type": {"anyOf": [{"items": {"enum": ["POTS", "VoIP"], "type": "string"}, "type": "array"}, {"type": "null"}], "description": "Phone Line Types <br/><b>Example:</b> [\"POTS\", \"VoIP\"]", "title": "Phone Line Type"}, "lines": {"description": "Number of phone lines. <br/><b>Example:</b> 5", "title": "Lines", "type": "integer"}, "equipment": {"description": "Equipment needed. <br/><b>Example:</b> Cisco 8800 Series", "title": "Equipment", "type": "string"}, "long_distance": {"description": "Data options for long distance <br/><b>Example:</b> ['Metered', 'Unlimited']", "items": {"enum": ["Metered", "Unlimited"], "type": "string"}, "title": "Long Distance", "type": "array"}, "toll_free_options": {"description": "Data options for toll free <br/><b>Example:</b> ['Metered', 'Unlimited']", "items": {"enum": ["Metered", "Unlimited"], "type": "string"}, "title": "Toll Free Options", "type": "array"}}, "required": ["phone_line_type", "lines", "equipment", "long_distance", "toll_free_options"], "title": "VoicePhoneLinesRequestConfigInV1", "type": "object"}, "WanRequestConfigInV1": {"properties": {"bandwidths": {"description": "Speed in mb/s. <br/><b>Example:</b> [500, 1000]", "items": {"enum": [50, 100, 250, 500, 1000, 2000, 5000, 10000, 40000, 100000, 400000, 600000, 800000], "type": "integer"}, "maxItems": 3, "minItems": 1, "title": "Bandwidths", "type": "array"}, "router": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "default": false, "description": "Whether you need a managed router <br/><b>Example:</b> true", "title": "Router"}}, "required": ["bandwidths"], "title": "WanRequestConfigInV1", "type": "object"}, "ApiServiceStatusChoices": {"enum": ["in_progress", "active", "inactive"], "title": "ApiServiceStatusChoices", "type": "string"}, "ListServicesFiltersV1": {"properties": {"status": {"anyOf": [{"items": {"$ref": "#/components/schemas/ApiServiceStatusChoices"}, "type": "array"}, {"type": "null"}], "description": "Filter services by status. If omitted, all statuses are returned. Repeat the param to combine values, e.g. `?status=in_progress&status=active`.<br/><br/>Status maps to a service's `current_step` as follows:<ul><li><code>in_progress</code> \u2014 <code>contract_requested</code>, <code>contract_received</code>, <code>order_submitted</code>, <code>pending_installation</code></li><li><code>active</code> \u2014 <code>service_installed</code> (installed and billing)</li><li><code>inactive</code> \u2014 manually deactivated services (e.g. terminated)</li></ul>", "title": "Status"}, "tags": {"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "null"}], "description": "Filter services by tag labels applied via the Manage Tags UI. Match is case-insensitive but exact \u2014 `?tags=phase` will not match a tag labelled `Phase Two`. Repeat the param to combine values with OR, e.g. `?tags=Priority&tags=Urgent`. Spaces in labels should be URL-encoded \u2014 either `%20` or `+` works, e.g. `?tags=Phase%20Two` or `?tags=Phase+Two`.", "title": "Tags"}, "project_id": {"anyOf": [{"format": "uuid", "type": "string"}, {"type": "null"}], "description": "Filter services to those in a single project. This is the `id` returned from `POST /developer/projects/v1`.", "title": "Project Id"}, "current_step": {"anyOf": [{"items": {"$ref": "#/components/schemas/CurrentStepChoices"}, "type": "array"}, {"type": "null"}], "description": "Filter services by their current step in the Lightyear lifecycle. Repeat the param to combine values, e.g. `?current_step=out_for_quote&current_step=quote_received`.", "title": "Current Step"}, "updated_since": {"anyOf": [{"format": "date-time", "type": "string"}, {"type": "null"}], "description": "Return only services updated at or after this ISO-8601 datetime, for delta sync, e.g. `?updated_since=2026-08-19T15:30:00Z`.<br/><br/>A service counts as updated when its own record <i>or</i> sync-relevant related data changes: service details, locations and their addresses, provider sub-components, the contract, or tags \u2014 the same changes that would alter the response of `GET /developer/services/{id}/v1`. Compare against the `updated_at` field in the response and checkpoint from it rather than your own clock. Deleted or deactivated records simply stop appearing in results \u2014 run a periodic full reconciliation pass to catch removals. To avoid missing writes that commit while a sync is running, overlap watermarks: pass the time your previous sync run <i>started</i>, not when it finished. Naive datetimes are treated as UTC.", "title": "Updated Since"}}, "title": "ListServicesFiltersV1", "type": "object"}, "PagedServiceWithCancellationOutV1": {"properties": {"items": {"items": {"$ref": "#/components/schemas/ServiceWithCancellationOutV1"}, "title": "Items", "type": "array"}, "total_items": {"examples": [1], "title": "Total Items", "type": "integer"}, "total_pages": {"examples": [1], "title": "Total Pages", "type": "integer"}, "page": {"examples": [1], "title": "Page", "type": "integer"}, "per_page": {"examples": [100], "title": "Per Page", "type": "integer"}}, "required": ["items", "total_items", "total_pages", "page", "per_page"], "title": "PagedServiceWithCancellationOutV1", "type": "object"}, "ServiceWithCancellationOutV1": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"$ref": "#/components/schemas/ServiceTypeChoices", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\""}, "current_step": {"$ref": "#/components/schemas/CurrentStepChoices", "description": "Current step of the service. <br/><b>Example:</b> \"service_installed\""}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/BasicLocationOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at"], "title": "ServiceWithCancellationOutV1", "type": "object"}, "ActionItemOutV1": {"properties": {"id": {"description": "ID of the Action Item.", "format": "uuid", "title": "Id", "type": "string"}, "created_at": {"description": "Date and time when the action item was created.", "format": "date-time", "title": "Created At", "type": "string"}, "type": {"$ref": "#/components/schemas/ActionItemTypeChoices", "description": "Type of the action item suggesting the response type needed. <br/><b>Example:</b> \"Document Request\""}, "task": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Description of the requested action item. <br/><b>Example:</b> \"Confirm Building Owner Contact info\"", "title": "Task"}, "due_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Due date for completing the action item.", "title": "Due Date"}, "status": {"$ref": "#/components/schemas/ActionItemStatusChoices", "description": "Current status of the action item. <br/><b>Example:</b> \"Closed\""}, "completed_at": {"anyOf": [{"format": "date-time", "type": "string"}, {"type": "null"}], "description": "Date and time when the action item was marked as complete.", "title": "Completed At"}, "completed_by": {"anyOf": [{"$ref": "#/components/schemas/AccountOutV1"}, {"type": "null"}], "description": "User who completed the action item. <br/><b>Example:</b> \"John Doe\""}, "assignee": {"anyOf": [{"$ref": "#/components/schemas/AccountOutV1"}, {"type": "null"}], "description": "Assigned user responsible for completing the action item. <br/><b>Example:</b> \"John Doe\""}, "service_id": {"anyOf": [{"format": "uuid", "type": "string"}, {"type": "null"}], "description": "ID of associated service (if applicable). <br/><b>Example:</b> \"123e4567-e89b-12d3-a456-426614174000\"", "title": "Service Id"}, "attachments": {"description": "Attachments related to this action item.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Attachments", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this action item, its comments, or its attachments changed. Use with the `updated_since` filter on `GET /developer/action-items/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}}, "required": ["id", "created_at", "type", "status", "attachments", "updated_at"], "title": "ActionItemOutV1", "type": "object"}, "ActionItemStatusChoices": {"enum": ["OPEN", "COMPLETED", "CANCELLED", "CLOSED"], "title": "ActionItemStatusChoices", "type": "string"}, "ActionItemTypeChoices": {"enum": ["DOCUMENT_REQUEST", "SIGNATURE_REQUEST", "INFORMATION_REQUEST", "ACTION_REQUEST"], "title": "ActionItemTypeChoices", "type": "string"}, "ColocationDetailsOutV1IgnoreExtra": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "specific_address": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Specific Address"}, "space": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Space"}, "space_cost_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Space Cost Value"}, "space_cost_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Space Cost Code"}, "power": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Power"}, "power_cost_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Power Cost Value"}, "power_cost_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Power Cost Code"}, "interconnectivity": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Interconnectivity"}, "interconnectivity_cost": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Interconnectivity Cost"}, "interconnectivity_cost_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Interconnectivity Cost Value"}, "interconnectivity_cost_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Interconnectivity Cost Code"}, "roof_rights": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Roof Rights"}, "office_space": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Office Space"}, "smart_hands": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Smart Hands"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}, "space_cost_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Space Cost Usd"}, "power_cost_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Power Cost Usd"}, "interconnectivity_cost_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Interconnectivity Cost Usd"}}, "title": "ColocationDetailsOutV1IgnoreExtra", "type": "object"}, "ColocationDetailsOutV1IgnoreExtraOptional": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "specific_address": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Specific Address"}, "space": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Space"}, "space_cost_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Space Cost Value"}, "space_cost_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Space Cost Code"}, "power": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Power"}, "power_cost_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Power Cost Value"}, "power_cost_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Power Cost Code"}, "interconnectivity": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Interconnectivity"}, "interconnectivity_cost": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Interconnectivity Cost"}, "interconnectivity_cost_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Interconnectivity Cost Value"}, "interconnectivity_cost_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Interconnectivity Cost Code"}, "roof_rights": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Roof Rights"}, "office_space": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Office Space"}, "smart_hands": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Smart Hands"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}, "space_cost_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Space Cost Usd"}, "power_cost_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Power Cost Usd"}, "interconnectivity_cost_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Interconnectivity Cost Usd"}}, "title": "ColocationDetailsOutV1IgnoreExtraOptional", "type": "object"}, "CrossConnectCableChoices": {"enum": ["Ethernet", "Single-Mode Fiber", "Multi-Mode Fiber"], "title": "CrossConnectCableChoices", "type": "string"}, "CrossConnectDetailsOutV1IgnoreExtra": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "connection_a": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Connection A"}, "connection_z": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Connection Z"}, "cable_type": {"anyOf": [{"$ref": "#/components/schemas/CrossConnectCableChoices"}, {"type": "null"}]}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "CrossConnectDetailsOutV1IgnoreExtra", "type": "object"}, "CrossConnectDetailsOutV1IgnoreExtraOptional": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "connection_a": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Connection A"}, "connection_z": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Connection Z"}, "cable_type": {"anyOf": [{"$ref": "#/components/schemas/CrossConnectCableChoices"}, {"type": "null"}]}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "CrossConnectDetailsOutV1IgnoreExtraOptional", "type": "object"}, "DarkFiberContractTypeChoices": {"enum": ["IRU", "Lease"], "title": "DarkFiberContractTypeChoices", "type": "string"}, "DirectCloudConnectDetailsOutV1IgnoreExtra": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "download_speed": {"title": "Download Speed", "type": "number"}, "upload_speed": {"title": "Upload Speed", "type": "number"}, "transport": {"title": "Transport", "type": "string"}, "sla": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Sla"}, "latency": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Latency"}, "jitter": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Jitter"}, "packet_loss": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Packet Loss"}, "ulc": {"title": "Ulc", "type": "string"}, "transport_capacity": {"title": "Transport Capacity", "type": "number"}, "cloud_provider": {"title": "Cloud Provider", "type": "string"}, "geo": {"title": "Geo", "type": "string"}, "region": {"title": "Region", "type": "string"}, "on_ramp_location": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "On Ramp Location"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "DirectCloudConnectDetailsOutV1IgnoreExtra", "type": "object"}, "DirectCloudConnectDetailsOutV1IgnoreExtraOptional": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "download_speed": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Download Speed"}, "upload_speed": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Upload Speed"}, "transport": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Transport"}, "sla": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Sla"}, "latency": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Latency"}, "jitter": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Jitter"}, "packet_loss": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Packet Loss"}, "ulc": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Ulc"}, "transport_capacity": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Transport Capacity"}, "cloud_provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Cloud Provider"}, "geo": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Geo"}, "region": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Region"}, "on_ramp_location": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "On Ramp Location"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "DirectCloudConnectDetailsOutV1IgnoreExtraOptional", "type": "object"}, "FlatIpData": {"properties": {"ipv4": {"allOf": [{"$ref": "#/components/schemas/FlatIpFields_IPv4Address_"}], "default": {}}, "ipv6": {"allOf": [{"$ref": "#/components/schemas/FlatIpFields_IPv6Address_"}], "default": {}}, "ip_address_architecture": {"const": "flat", "title": "Ip Address Architecture", "type": "string"}}, "required": ["ip_address_architecture"], "title": "FlatIpData", "type": "object"}, "FlatIpFields_IPv4Address_": {"properties": {"wan_ip_block": {"anyOf": [{"format": "ipv4", "type": "string"}, {"type": "null"}], "title": "Wan Ip Block"}, "wan_gateway_ip": {"anyOf": [{"format": "ipv4", "type": "string"}, {"type": "null"}], "title": "Wan Gateway Ip"}, "wan_usable_ip_range": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Wan Usable Ip Range"}, "wan_subnet_mask": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Wan Subnet Mask"}, "dns1": {"anyOf": [{"format": "ipv4", "type": "string"}, {"type": "null"}], "title": "Dns1"}, "dns2": {"anyOf": [{"format": "ipv4", "type": "string"}, {"type": "null"}], "title": "Dns2"}, "notes": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Notes"}, "bgp_neighbor1": {"anyOf": [{"format": "ipv4", "type": "string"}, {"type": "null"}], "title": "Bgp Neighbor1"}, "bgp_neighbor2": {"anyOf": [{"format": "ipv4", "type": "string"}, {"type": "null"}], "title": "Bgp Neighbor2"}}, "title": "FlatIpFields[IPv4Address]", "type": "object"}, "FlatIpFields_IPv6Address_": {"properties": {"wan_ip_block": {"anyOf": [{"format": "ipv6", "type": "string"}, {"type": "null"}], "title": "Wan Ip Block"}, "wan_gateway_ip": {"anyOf": [{"format": "ipv6", "type": "string"}, {"type": "null"}], "title": "Wan Gateway Ip"}, "wan_usable_ip_range": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Wan Usable Ip Range"}, "wan_subnet_mask": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Wan Subnet Mask"}, "dns1": {"anyOf": [{"format": "ipv6", "type": "string"}, {"type": "null"}], "title": "Dns1"}, "dns2": {"anyOf": [{"format": "ipv6", "type": "string"}, {"type": "null"}], "title": "Dns2"}, "notes": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Notes"}, "bgp_neighbor1": {"anyOf": [{"format": "ipv6", "type": "string"}, {"type": "null"}], "title": "Bgp Neighbor1"}, "bgp_neighbor2": {"anyOf": [{"format": "ipv6", "type": "string"}, {"type": "null"}], "title": "Bgp Neighbor2"}}, "title": "FlatIpFields[IPv6Address]", "type": "object"}, "HandOffTypeChoices": {"enum": ["ethernet", "smf", "mmf", "base_TX_100", "base_TX_1000", "base_T_1000", "base_SX_1000_MMF", "base_SX_1000_SMF", "base_LX_1000_SMF_LC", "base_LX_1000_SMF_SC", "base_LR_SMF_LC_10G", "base_LR_SMF_SC_10G", "base_LW_SMF_LC_10G", "base_LW_SMF_SC_10G", "base_ER_SMF_LC_10G", "base_ER_SMF_SC_10G", "base_SR_MMF_LC_10G", "base_SR_MMF_SC_10G", "base_SW_MMF_LC_10G", "base_SW_MMF_SC_10G", "base1000_SX_1G_SX", "base1000_LX_1G_LX", "baseSR_10G_10G_SR", "baseLR_10G_10G_LR", "baseER_10G_10G_ER", "baseZR_10G_10G_ZR", "smf_100G", "mmf_100G", "smf_400G", "mmf_400G", "smf_800G", "mmf_800G"], "title": "HandOffTypeChoices", "type": "string"}, "InstallStatusChoices": {"enum": ["ON_TRACK", "ON_HOLD_CUSTOMER", "DELAYED", "DELAYED_PENDING_CUSTOMER_SITE_READINESS", "DELAYED_AWAITING_CUSTOMER_RESPONSE", "DELAYED_ROE", "CANCELLED", "CANCEL_REQUESTED", "INSTALLED_PENDING_CARRIER_DETAILS", "AWAITING_CUSTOMER_CONFIRMATION", "CUSTOMER_DENIED_ACCEPTANCE", "INSTALLED"], "title": "InstallStatusChoices", "type": "string"}, "InternetDetailsOutV1IgnoreExtra": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "type": {"allOf": [{"$ref": "#/components/schemas/InternetTypeChoices"}]}, "wan_label": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Wan Label"}, "transport": {"allOf": [{"$ref": "#/components/schemas/InternetTransportChoices"}]}, "border_gateway_protocol": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Border Gateway Protocol"}, "transport_capacity": {"title": "Transport Capacity", "type": "number"}, "ulc": {"title": "Ulc", "type": "string"}, "download_speed": {"title": "Download Speed", "type": "number"}, "upload_speed": {"title": "Upload Speed", "type": "number"}, "sla": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Sla"}, "managed_router": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Managed Router"}, "wifi_included": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Wifi Included"}, "network_asn": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Network Asn"}, "static_ips": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Static Ips"}, "fixed_bandwidth": {"enum": ["Fixed", "Burstable"], "title": "Fixed Bandwidth", "type": "string"}, "committed_burstable_rate": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Committed Burstable Rate"}, "burstable_bandwidth": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Burstable Bandwidth"}, "committed_rate_cost_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Committed Rate Cost Value"}, "committed_rate_cost_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Committed Rate Cost Code"}, "burst_utilization_rate_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Burst Utilization Rate Value"}, "burst_utilization_rate_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Burst Utilization Rate Code"}, "network_firewall": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Network Firewall"}, "primary_dns_server": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Primary Dns Server"}, "secondary_dns_server": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Secondary Dns Server"}, "construction_cost_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Construction Cost Value"}, "construction_cost_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Construction Cost Code"}, "has_construction": {"anyOf": [{"enum": ["TBD", "Yes", "No", ""], "type": "string"}, {"type": "null"}], "title": "Has Construction"}, "customer_requested_handoff": {"anyOf": [{"$ref": "#/components/schemas/HandOffTypeChoices"}, {"type": "null"}]}, "delivery_point": {"anyOf": [{"$ref": "#/components/schemas/ProviderDeliveryPointChoices"}, {"type": "null"}]}, "address_a_provider_install_demarc": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Address A Provider Install Demarc"}, "modem_mac": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Modem Mac"}, "modem_serial": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Modem Serial"}, "modem_make_model": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Modem Make Model"}, "ip_data": {"anyOf": [{"$ref": "#/components/schemas/FlatIpData"}, {"$ref": "#/components/schemas/WanLanIpData"}, {"type": "null"}], "title": "Ip Data"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}, "committed_rate_cost_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Committed Rate Cost Usd"}, "burst_utilization_rate_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Burst Utilization Rate Usd"}, "construction_cost_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Construction Cost Usd"}}, "title": "InternetDetailsOutV1IgnoreExtra", "type": "object"}, "InternetDetailsOutV1IgnoreExtraOptional": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "type": {"anyOf": [{"$ref": "#/components/schemas/InternetTypeChoices"}, {"type": "null"}]}, "wan_label": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Wan Label"}, "transport": {"anyOf": [{"$ref": "#/components/schemas/InternetTransportChoices"}, {"type": "null"}]}, "border_gateway_protocol": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Border Gateway Protocol"}, "transport_capacity": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Transport Capacity"}, "ulc": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Ulc"}, "download_speed": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Download Speed"}, "upload_speed": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Upload Speed"}, "sla": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Sla"}, "managed_router": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Managed Router"}, "wifi_included": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Wifi Included"}, "network_asn": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Network Asn"}, "static_ips": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Static Ips"}, "fixed_bandwidth": {"anyOf": [{"enum": ["Fixed", "Burstable"], "type": "string"}, {"type": "null"}], "title": "Fixed Bandwidth"}, "committed_burstable_rate": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Committed Burstable Rate"}, "burstable_bandwidth": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Burstable Bandwidth"}, "committed_rate_cost_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Committed Rate Cost Value"}, "committed_rate_cost_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Committed Rate Cost Code"}, "burst_utilization_rate_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Burst Utilization Rate Value"}, "burst_utilization_rate_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Burst Utilization Rate Code"}, "network_firewall": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Network Firewall"}, "primary_dns_server": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Primary Dns Server"}, "secondary_dns_server": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Secondary Dns Server"}, "construction_cost_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Construction Cost Value"}, "construction_cost_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Construction Cost Code"}, "has_construction": {"anyOf": [{"enum": ["TBD", "Yes", "No", ""], "type": "string"}, {"type": "null"}], "title": "Has Construction"}, "customer_requested_handoff": {"anyOf": [{"$ref": "#/components/schemas/HandOffTypeChoices"}, {"type": "null"}]}, "delivery_point": {"anyOf": [{"$ref": "#/components/schemas/ProviderDeliveryPointChoices"}, {"type": "null"}]}, "address_a_provider_install_demarc": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Address A Provider Install Demarc"}, "modem_mac": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Modem Mac"}, "modem_serial": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Modem Serial"}, "modem_make_model": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Modem Make Model"}, "ip_data": {"anyOf": [{"$ref": "#/components/schemas/FlatIpData"}, {"$ref": "#/components/schemas/WanLanIpData"}, {"type": "null"}], "title": "Ip Data"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}, "committed_rate_cost_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Committed Rate Cost Usd"}, "burst_utilization_rate_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Burst Utilization Rate Usd"}, "construction_cost_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Construction Cost Usd"}}, "title": "InternetDetailsOutV1IgnoreExtraOptional", "type": "object"}, "InternetRequestConfigOutV1": {"properties": {"download_speeds": {"anyOf": [{"items": {"type": "integer"}, "type": "array"}, {"type": "null"}], "description": "Download speed in mb/s. <br/><b>Example:</b> [500, 1000]", "title": "Download Speeds"}, "types": {"anyOf": [{"items": {"$ref": "#/components/schemas/InternetTypeChoices"}, "type": "array"}, {"type": "null"}], "description": "Internet Types <br/><b>Example:</b> [\"Dedicated\", \"Broadband\"]", "title": "Types"}, "static_ips": {"anyOf": [{"enum": ["/26", "/27", "/28", "/29", "/30", "I need more", "None"], "type": "string"}, {"type": "null"}], "default": "None", "description": "Static IPs <br/><b>Example:</b> \"/29\"", "title": "Static Ips"}, "committed_burstable_rate": {"anyOf": [{"type": "string"}, {"type": "null"}], "default": "Not Burstable / Fixed Billing", "description": "Committed Bandwidth <br/><b>Example:</b> \"1 gb/s\"", "title": "Committed Burstable Rate"}, "burstable_bandwidth": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Burstable Bandwidth <br/><b>Example:</b> \"10 gb/s\"", "title": "Burstable Bandwidth"}, "managed_router": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "default": false, "description": "Whether you need a managed router <br/><b>Example:</b> true", "title": "Managed Router"}, "wifi_included": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "default": false, "description": "Whether wifi is included <br/><b>Example:</b> true", "title": "Wifi Included"}, "network_firewall": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "default": false, "description": "Network Firewall <br/><b>Example:</b> true", "title": "Network Firewall"}, "border_gateway_protocol": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "default": false, "description": "Border gateway protocol <br/><b>Example:</b> true", "title": "Border Gateway Protocol"}, "transports_dedicated": {"anyOf": [{"items": {"enum": ["Fiber", "FixedWireless"], "type": "string"}, "type": "array"}, {"type": "null"}], "default": ["Fiber"], "description": "Transports for dedicated internet. <br/><b>Example:</b> [\"Fiber\"]", "title": "Transports Dedicated"}, "transports_broadband": {"anyOf": [{"items": {"enum": ["Coax", "Fiber", "Copper", "FixedWireless", "Satellite", "Cellular"], "type": "string"}, "type": "array"}, {"type": "null"}], "default": ["Coax", "Fiber"], "description": "Transports for broadband internet. <br/><b>Example:</b> [\"Coax\", \"Fiber\"]", "title": "Transports Broadband"}, "broadband_min_download": {"anyOf": [{"type": "number"}, {"type": "null"}], "description": "Minimum download speed in Mbps for broadband internet requests. <br/><b>Example:</b> 100", "title": "Broadband Min Download"}, "broadband_min_upload": {"anyOf": [{"type": "number"}, {"type": "null"}], "description": "Minimum upload speed in Mbps for broadband internet requests. <br/><b>Example:</b> 20", "title": "Broadband Min Upload"}}, "required": ["download_speeds", "types"], "title": "InternetRequestConfigOutV1", "type": "object"}, "InternetTransportChoices": {"enum": ["Coax", "Cellular", "Copper", "Fiber", "FixedWireless", "Satellite"], "title": "InternetTransportChoices", "type": "string"}, "LocationDetailOutV1": {"properties": {"id": {"description": "ID of the Location.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Label for this location. <br/><b>Example:</b> \"LA Headquarters\"", "title": "Name", "type": "string"}, "address": {"description": "Full location address including floor, building, suite if applicable. <br/><b>Example:</b> \"123 Main St Unit B, Los Angeles, CA 90013, US\"", "title": "Address", "type": "string"}, "onsite_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the onsite contact at the location."}, "secondary_onsite_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the secondary onsite contact at the location."}, "customer_requested_handoff": {"anyOf": [{"$ref": "#/components/schemas/HandOffTypeChoices"}, {"type": "null"}], "description": "The type of handoff requested by the customer. <br/><b>Example:</b> \"ethernet\""}, "carrier_handoff": {"anyOf": [{"$ref": "#/components/schemas/HandOffTypeChoices"}, {"type": "null"}], "description": "The type of handoff provided by the carrier. <br/><b>Example:</b> \"base_LX_1000_SMF_LC\""}, "scheduled_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation is scheduled to occur.", "title": "Scheduled Install Date"}, "original_target_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The original target date for the installation.", "title": "Original Target Date"}, "actual_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The actual date the installation occurred.", "title": "Actual Install Date"}, "provider_install_demarc": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "The location of the provider install demarcation point. <br/><b>Example:</b> \"Suite 100\"", "title": "Provider Install Demarc"}}, "required": ["id", "name", "address"], "title": "LocationDetailOutV1", "type": "object"}, "MediumChoices": {"enum": ["Satellite", "Cable", "OTT"], "title": "MediumChoices", "type": "string"}, "MobileLineDetailsOutV1IgnoreExtra": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "line_number": {"title": "Line Number", "type": "string"}, "device_model": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Device Model"}, "device_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Device Id"}, "user": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "User"}, "msid": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Msid"}, "imei": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Imei"}, "plan": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Plan"}, "network_technology": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Network Technology"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "MobileLineDetailsOutV1IgnoreExtra", "type": "object"}, "MobileLineDetailsOutV1IgnoreExtraOptional": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "line_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Line Number"}, "device_model": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Device Model"}, "device_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Device Id"}, "user": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "User"}, "msid": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Msid"}, "imei": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Imei"}, "plan": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Plan"}, "network_technology": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Network Technology"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "MobileLineDetailsOutV1IgnoreExtraOptional", "type": "object"}, "MusicDetailsOutV1IgnoreExtra": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "MusicDetailsOutV1IgnoreExtra", "type": "object"}, "MusicDetailsOutV1IgnoreExtraOptional": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "MusicDetailsOutV1IgnoreExtraOptional", "type": "object"}, "PhoneNumberOutV1": {"properties": {"type": {"$ref": "#/components/schemas/PhoneNumberTypeChoices", "description": "Type of phone number. <br/><b>Example:</b> \"fax\""}, "number": {"description": "Physical number attributed to the phone number. <br/><b>Example:</b> \"555-555-5555\"", "title": "Number", "type": "string"}, "notes": {"description": "Notes added by the user about the phone number. <br/><b>Example:</b> \"This is the fax number for the office\"", "title": "Notes", "type": "string"}}, "required": ["type", "number"], "title": "PhoneNumberOutV1", "type": "object"}, "PhoneNumberTypeChoices": {"enum": ["phone", "fax", "alarm_line", "elevator", "intercom"], "title": "PhoneNumberTypeChoices", "type": "string"}, "PostOrderSubmissionServiceDetailOutV1": {"discriminator": {"mapping": {"colocation": "#/components/schemas/ServiceDetailOutBaseV1_Literal_Colocation__ColocationDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__", "cross_connect": "#/components/schemas/ServiceDetailOutBaseV1_Literal_CrossConnect__CrossConnectDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__", "direct_cloud_connect": "#/components/schemas/ServiceDetailOutBaseV1_Literal_DirectCloudConnect__DirectCloudConnectDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__", "internet": "#/components/schemas/ServiceDetailOutBaseV1_Literal_Internet__InternetDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__", "mobile_line": "#/components/schemas/ServiceDetailOutBaseV1_Literal_MobileLine__MobileLineDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__", "music": "#/components/schemas/ServiceDetailOutBaseV1_Literal_Music__MusicDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__", "security": "#/components/schemas/ServiceDetailOutBaseV1_Literal_Security__SecurityDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__", "tv": "#/components/schemas/ServiceDetailOutBaseV1_Literal_Tv__TvDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__", "voice_dids": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceDids__VoiceDidsDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__", "voice_hosted_voip": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceHostedVoip__VoiceHostedVoipDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__", "voice_long_distance": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceLongDistance__VoiceLongDistanceDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__", "voice_other": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceOther__VoiceOtherDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__", "voice_phone_lines": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoicePhoneLines__VoicePhoneLinesDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__", "voice_pots_line": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoicePotsLine__VoicePotsLineDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__", "voice_pots_piab": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoicePotsPiab__VoicePotsPiabDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__", "voice_pri": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoicePri__VoicePriDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__", "voice_pri_bri": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoicePriBri__VoicePriBriDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__", "voice_rcf_line": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceRcfLine__VoiceRcfLineDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__", "voice_sip": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceSip__VoiceSipDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__", "voice_sip_ccp": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceSipCcp__VoiceSipCcpDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__", "voice_toll_free": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceTollFree__VoiceTollFreeDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__", "voice_ucaas": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceUcaas__VoiceUcaasDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__", "voice_ucaas_inv": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceUcaasInv__VoiceUcaasInvDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__", "voice_voip_feature": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceVoipFeature__VoiceVoipFeatureDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__", "voice_voip_line": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceVoipLine__VoiceVoipLineDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__", "voice_voip_minutes": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceVoipMinutes__VoiceVoipMinutesDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__", "wan_dark_fiber": "#/components/schemas/ServiceDetailOutBaseV1_Literal_WanDarkFiber__WanDarkFiberDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__", "wan_mpls": "#/components/schemas/ServiceDetailOutBaseV1_Literal_WanMpls__WanMplsDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__", "wan_point_to_point": "#/components/schemas/ServiceDetailOutBaseV1_Literal_WanPointToPoint__WanPointToPointDetailsOutOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__", "wan_sd_wan": "#/components/schemas/ServiceDetailOutBaseV1_Literal_WanSdWan__WanSdWanDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__", "wan_vpls": "#/components/schemas/ServiceDetailOutBaseV1_Literal_WanVpls__WanVplsDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__", "wan_wavelength": "#/components/schemas/ServiceDetailOutBaseV1_Literal_WanWavelength__WanWavelengthDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__"}, "propertyName": "service_type"}, "oneOf": [{"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_Internet__InternetDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_CrossConnect__CrossConnectDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_WanDarkFiber__WanDarkFiberDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_WanWavelength__WanWavelengthDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_WanPointToPoint__WanPointToPointDetailsOutOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_WanMpls__WanMplsDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_WanSdWan__WanSdWanDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_WanVpls__WanVplsDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoicePhoneLines__VoicePhoneLinesDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceSip__VoiceSipDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoicePri__VoicePriDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceUcaas__VoiceUcaasDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceVoipLine__VoiceVoipLineDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoicePotsLine__VoicePotsLineDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoicePotsPiab__VoicePotsPiabDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceLongDistance__VoiceLongDistanceDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceTollFree__VoiceTollFreeDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceRcfLine__VoiceRcfLineDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceUcaasInv__VoiceUcaasInvDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceHostedVoip__VoiceHostedVoipDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceSipCcp__VoiceSipCcpDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceVoipFeature__VoiceVoipFeatureDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceVoipMinutes__VoiceVoipMinutesDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceDids__VoiceDidsDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoicePriBri__VoicePriBriDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceOther__VoiceOtherDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_Colocation__ColocationDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_DirectCloudConnect__DirectCloudConnectDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_Tv__TvDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_Music__MusicDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_Security__SecurityDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_MobileLine__MobileLineDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__"}]}, "PreOrderSubmissionServiceDetailOutV1": {"discriminator": {"mapping": {"colocation": "#/components/schemas/ServiceDetailOutBaseV1_Literal_Colocation__ColocationDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__", "cross_connect": "#/components/schemas/ServiceDetailOutBaseV1_Literal_CrossConnect__CrossConnectDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__", "direct_cloud_connect": "#/components/schemas/ServiceDetailOutBaseV1_Literal_DirectCloudConnect__DirectCloudConnectDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__", "internet": "#/components/schemas/ServiceDetailOutBaseV1_Literal_Internet__InternetDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__", "mobile_line": "#/components/schemas/ServiceDetailOutBaseV1_Literal_MobileLine__MobileLineDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__", "music": "#/components/schemas/ServiceDetailOutBaseV1_Literal_Music__MusicDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__", "security": "#/components/schemas/ServiceDetailOutBaseV1_Literal_Security__SecurityDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__", "tv": "#/components/schemas/ServiceDetailOutBaseV1_Literal_Tv__TvDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__", "voice_dids": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceDids__VoiceDidsDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__", "voice_hosted_voip": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceHostedVoip__VoiceHostedVoipDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__", "voice_long_distance": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceLongDistance__VoiceLongDistanceDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__", "voice_other": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceOther__VoiceOtherDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__", "voice_phone_lines": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoicePhoneLines__VoicePhoneLinesDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__", "voice_pots_line": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoicePotsLine__VoicePotsLineDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__", "voice_pots_piab": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoicePotsPiab__VoicePotsPiabDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__", "voice_pri": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoicePri__VoicePriDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__", "voice_pri_bri": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoicePriBri__VoicePriBriDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__", "voice_rcf_line": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceRcfLine__VoiceRcfLineDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__", "voice_sip": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceSip__VoiceSipDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__", "voice_sip_ccp": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceSipCcp__VoiceSipCcpDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__", "voice_toll_free": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceTollFree__VoiceTollFreeDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__", "voice_ucaas": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceUcaas__VoiceUcaasDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__", "voice_ucaas_inv": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceUcaasInv__VoiceUcaasInvDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__", "voice_voip_feature": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceVoipFeature__VoiceVoipFeatureDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__", "voice_voip_line": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceVoipLine__VoiceVoipLineDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__", "voice_voip_minutes": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceVoipMinutes__VoiceVoipMinutesDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__", "wan_dark_fiber": "#/components/schemas/ServiceDetailOutBaseV1_Literal_WanDarkFiber__WanDarkFiberDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__", "wan_mpls": "#/components/schemas/ServiceDetailOutBaseV1_Literal_WanMpls__WanMplsDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__", "wan_point_to_point": "#/components/schemas/ServiceDetailOutBaseV1_Literal_WanPointToPoint__WanPointToPointDetailsOutOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__", "wan_sd_wan": "#/components/schemas/ServiceDetailOutBaseV1_Literal_WanSdWan__WanSdWanDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__", "wan_vpls": "#/components/schemas/ServiceDetailOutBaseV1_Literal_WanVpls__WanVplsDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__", "wan_wavelength": "#/components/schemas/ServiceDetailOutBaseV1_Literal_WanWavelength__WanWavelengthDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__"}, "propertyName": "service_type"}, "oneOf": [{"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_Internet__InternetDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_CrossConnect__CrossConnectDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_WanDarkFiber__WanDarkFiberDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_WanWavelength__WanWavelengthDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_WanPointToPoint__WanPointToPointDetailsOutOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_WanMpls__WanMplsDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_WanSdWan__WanSdWanDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_WanVpls__WanVplsDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoicePhoneLines__VoicePhoneLinesDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceSip__VoiceSipDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoicePri__VoicePriDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceUcaas__VoiceUcaasDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceVoipLine__VoiceVoipLineDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoicePotsLine__VoicePotsLineDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoicePotsPiab__VoicePotsPiabDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceLongDistance__VoiceLongDistanceDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceTollFree__VoiceTollFreeDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceRcfLine__VoiceRcfLineDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceUcaasInv__VoiceUcaasInvDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceHostedVoip__VoiceHostedVoipDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceSipCcp__VoiceSipCcpDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceVoipFeature__VoiceVoipFeatureDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceVoipMinutes__VoiceVoipMinutesDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceDids__VoiceDidsDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoicePriBri__VoicePriBriDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_VoiceOther__VoiceOtherDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_Colocation__ColocationDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_DirectCloudConnect__DirectCloudConnectDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_Tv__TvDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_Music__MusicDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_Security__SecurityDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__"}, {"$ref": "#/components/schemas/ServiceDetailOutBaseV1_Literal_MobileLine__MobileLineDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__"}]}, "ProviderDeliveryPointChoices": {"enum": ["MPOE", "SUITE", "MMR"], "title": "ProviderDeliveryPointChoices", "type": "string"}, "ProviderSubComponentOutV1": {"properties": {"provider_service_id": {"description": "Provider service / circuit identifier for sub-component service", "title": "Provider Service Id", "type": "string"}, "address_location_a": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "A-side address for sub-component service", "title": "Address Location A"}, "address_location_z": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Z-side address for sub-component service (if applicable)", "title": "Address Location Z"}, "alt_provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Alternate provider service / circuit identifier for sub-component service", "title": "Alt Provider Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Specific provider product name for sub-component service", "title": "Provider Product Name"}, "mrc_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "description": "Monthly recurring cost for sub-component service", "title": "Mrc Value"}}, "required": ["provider_service_id"], "title": "ProviderSubComponentOutV1", "type": "object"}, "RequestConfigOutV1": {"properties": {"terms": {"description": "Terms in months. <br/><b>Example:</b> [60]", "items": {"type": "integer"}, "title": "Terms", "type": "array"}, "provider_allow": {"default": [], "description": "Preferred providers. <br/><b>Example:</b> [\"AT&T\", \"Lumen\"]", "items": {"type": "string"}, "title": "Provider Allow", "type": "array"}, "provider_deny": {"default": [], "description": "Providers you don't want quotes from. <br/><b>Example:</b> [\"AT&T\", \"Lumen\"]", "items": {"type": "string"}, "title": "Provider Deny", "type": "array"}, "comments": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Any additional comments or requirements for the request.", "title": "Comments"}, "detail_data": {"anyOf": [{"$ref": "#/components/schemas/InternetRequestConfigOutV1"}, {"$ref": "#/components/schemas/WanRequestConfigOutV1"}, {"$ref": "#/components/schemas/VoicePhoneLinesRequestConfigOutV1"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> \n    {\"types\": [\"Dedicated\"], \"download_speeds\": [1000, 2000] }\n</b>", "title": "Detail Data"}}, "required": ["terms", "detail_data"], "title": "RequestConfigOutV1", "type": "object"}, "SecurityDetailsOutV1IgnoreExtra": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "number_of_cameras": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Number Of Cameras"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "SecurityDetailsOutV1IgnoreExtra", "type": "object"}, "SecurityDetailsOutV1IgnoreExtraOptional": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "number_of_cameras": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Number Of Cameras"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "SecurityDetailsOutV1IgnoreExtraOptional", "type": "object"}, "ServiceDetailOutBaseV1_Literal_Colocation__ColocationDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "colocation", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["info_received", "out_for_quote", "quote_received", "contract_requested", "contract_received"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/ColocationDetailsOutV1IgnoreExtraOptional"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.Colocation], ColocationDetailsOutV1IgnoreExtraOptional, Literal[CurrentStepChoices.InfoReceived, CurrentStepChoices.OutForQuote, CurrentStepChoices.QuoteReceived, CurrentStepChoices.ContractRequested, CurrentStepChoices.ContractReceived]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_Colocation__ColocationDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "colocation", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["order_submitted", "pending_installation", "service_installed"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/ColocationDetailsOutV1IgnoreExtra"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.Colocation], ColocationDetailsOutV1IgnoreExtra, Literal[CurrentStepChoices.OrderSubmitted, CurrentStepChoices.PendingInstallation, CurrentStepChoices.ServiceInstalled]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_CrossConnect__CrossConnectDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "cross_connect", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["info_received", "out_for_quote", "quote_received", "contract_requested", "contract_received"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/CrossConnectDetailsOutV1IgnoreExtraOptional"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.CrossConnect], CrossConnectDetailsOutV1IgnoreExtraOptional, Literal[CurrentStepChoices.InfoReceived, CurrentStepChoices.OutForQuote, CurrentStepChoices.QuoteReceived, CurrentStepChoices.ContractRequested, CurrentStepChoices.ContractReceived]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_CrossConnect__CrossConnectDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "cross_connect", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["order_submitted", "pending_installation", "service_installed"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/CrossConnectDetailsOutV1IgnoreExtra"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.CrossConnect], CrossConnectDetailsOutV1IgnoreExtra, Literal[CurrentStepChoices.OrderSubmitted, CurrentStepChoices.PendingInstallation, CurrentStepChoices.ServiceInstalled]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_DirectCloudConnect__DirectCloudConnectDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "direct_cloud_connect", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["info_received", "out_for_quote", "quote_received", "contract_requested", "contract_received"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/DirectCloudConnectDetailsOutV1IgnoreExtraOptional"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.DirectCloudConnect], DirectCloudConnectDetailsOutV1IgnoreExtraOptional, Literal[CurrentStepChoices.InfoReceived, CurrentStepChoices.OutForQuote, CurrentStepChoices.QuoteReceived, CurrentStepChoices.ContractRequested, CurrentStepChoices.ContractReceived]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_DirectCloudConnect__DirectCloudConnectDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "direct_cloud_connect", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["order_submitted", "pending_installation", "service_installed"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/DirectCloudConnectDetailsOutV1IgnoreExtra"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.DirectCloudConnect], DirectCloudConnectDetailsOutV1IgnoreExtra, Literal[CurrentStepChoices.OrderSubmitted, CurrentStepChoices.PendingInstallation, CurrentStepChoices.ServiceInstalled]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_Internet__InternetDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "internet", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["info_received", "out_for_quote", "quote_received", "contract_requested", "contract_received"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/InternetDetailsOutV1IgnoreExtraOptional"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.Internet], InternetDetailsOutV1IgnoreExtraOptional, Literal[CurrentStepChoices.InfoReceived, CurrentStepChoices.OutForQuote, CurrentStepChoices.QuoteReceived, CurrentStepChoices.ContractRequested, CurrentStepChoices.ContractReceived]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_Internet__InternetDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "internet", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["order_submitted", "pending_installation", "service_installed"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/InternetDetailsOutV1IgnoreExtra"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.Internet], InternetDetailsOutV1IgnoreExtra, Literal[CurrentStepChoices.OrderSubmitted, CurrentStepChoices.PendingInstallation, CurrentStepChoices.ServiceInstalled]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_MobileLine__MobileLineDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "mobile_line", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["info_received", "out_for_quote", "quote_received", "contract_requested", "contract_received"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/MobileLineDetailsOutV1IgnoreExtraOptional"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.MobileLine], MobileLineDetailsOutV1IgnoreExtraOptional, Literal[CurrentStepChoices.InfoReceived, CurrentStepChoices.OutForQuote, CurrentStepChoices.QuoteReceived, CurrentStepChoices.ContractRequested, CurrentStepChoices.ContractReceived]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_MobileLine__MobileLineDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "mobile_line", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["order_submitted", "pending_installation", "service_installed"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/MobileLineDetailsOutV1IgnoreExtra"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.MobileLine], MobileLineDetailsOutV1IgnoreExtra, Literal[CurrentStepChoices.OrderSubmitted, CurrentStepChoices.PendingInstallation, CurrentStepChoices.ServiceInstalled]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_Music__MusicDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "music", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["info_received", "out_for_quote", "quote_received", "contract_requested", "contract_received"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/MusicDetailsOutV1IgnoreExtraOptional"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.Music], MusicDetailsOutV1IgnoreExtraOptional, Literal[CurrentStepChoices.InfoReceived, CurrentStepChoices.OutForQuote, CurrentStepChoices.QuoteReceived, CurrentStepChoices.ContractRequested, CurrentStepChoices.ContractReceived]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_Music__MusicDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "music", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["order_submitted", "pending_installation", "service_installed"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/MusicDetailsOutV1IgnoreExtra"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.Music], MusicDetailsOutV1IgnoreExtra, Literal[CurrentStepChoices.OrderSubmitted, CurrentStepChoices.PendingInstallation, CurrentStepChoices.ServiceInstalled]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_Security__SecurityDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "security", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["info_received", "out_for_quote", "quote_received", "contract_requested", "contract_received"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/SecurityDetailsOutV1IgnoreExtraOptional"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.Security], SecurityDetailsOutV1IgnoreExtraOptional, Literal[CurrentStepChoices.InfoReceived, CurrentStepChoices.OutForQuote, CurrentStepChoices.QuoteReceived, CurrentStepChoices.ContractRequested, CurrentStepChoices.ContractReceived]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_Security__SecurityDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "security", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["order_submitted", "pending_installation", "service_installed"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/SecurityDetailsOutV1IgnoreExtra"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.Security], SecurityDetailsOutV1IgnoreExtra, Literal[CurrentStepChoices.OrderSubmitted, CurrentStepChoices.PendingInstallation, CurrentStepChoices.ServiceInstalled]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_Tv__TvDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "tv", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["info_received", "out_for_quote", "quote_received", "contract_requested", "contract_received"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/TvDetailsOutV1IgnoreExtraOptional"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.Tv], TvDetailsOutV1IgnoreExtraOptional, Literal[CurrentStepChoices.InfoReceived, CurrentStepChoices.OutForQuote, CurrentStepChoices.QuoteReceived, CurrentStepChoices.ContractRequested, CurrentStepChoices.ContractReceived]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_Tv__TvDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "tv", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["order_submitted", "pending_installation", "service_installed"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/TvDetailsOutV1IgnoreExtra"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.Tv], TvDetailsOutV1IgnoreExtra, Literal[CurrentStepChoices.OrderSubmitted, CurrentStepChoices.PendingInstallation, CurrentStepChoices.ServiceInstalled]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_VoiceDids__VoiceDidsDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "voice_dids", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["info_received", "out_for_quote", "quote_received", "contract_requested", "contract_received"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/VoiceDidsDetailsOutV1IgnoreExtraOptional"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.VoiceDids], VoiceDidsDetailsOutV1IgnoreExtraOptional, Literal[CurrentStepChoices.InfoReceived, CurrentStepChoices.OutForQuote, CurrentStepChoices.QuoteReceived, CurrentStepChoices.ContractRequested, CurrentStepChoices.ContractReceived]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_VoiceDids__VoiceDidsDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "voice_dids", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["order_submitted", "pending_installation", "service_installed"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/VoiceDidsDetailsOutV1IgnoreExtra"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.VoiceDids], VoiceDidsDetailsOutV1IgnoreExtra, Literal[CurrentStepChoices.OrderSubmitted, CurrentStepChoices.PendingInstallation, CurrentStepChoices.ServiceInstalled]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_VoiceHostedVoip__VoiceHostedVoipDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "voice_hosted_voip", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["info_received", "out_for_quote", "quote_received", "contract_requested", "contract_received"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/VoiceHostedVoipDetailsOutV1IgnoreExtraOptional"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.VoiceHostedVoip], VoiceHostedVoipDetailsOutV1IgnoreExtraOptional, Literal[CurrentStepChoices.InfoReceived, CurrentStepChoices.OutForQuote, CurrentStepChoices.QuoteReceived, CurrentStepChoices.ContractRequested, CurrentStepChoices.ContractReceived]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_VoiceHostedVoip__VoiceHostedVoipDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "voice_hosted_voip", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["order_submitted", "pending_installation", "service_installed"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/VoiceHostedVoipDetailsOutV1IgnoreExtra"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.VoiceHostedVoip], VoiceHostedVoipDetailsOutV1IgnoreExtra, Literal[CurrentStepChoices.OrderSubmitted, CurrentStepChoices.PendingInstallation, CurrentStepChoices.ServiceInstalled]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_VoiceLongDistance__VoiceLongDistanceDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "voice_long_distance", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["info_received", "out_for_quote", "quote_received", "contract_requested", "contract_received"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/VoiceLongDistanceDetailsOutV1IgnoreExtraOptional"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.VoiceLongDistance], VoiceLongDistanceDetailsOutV1IgnoreExtraOptional, Literal[CurrentStepChoices.InfoReceived, CurrentStepChoices.OutForQuote, CurrentStepChoices.QuoteReceived, CurrentStepChoices.ContractRequested, CurrentStepChoices.ContractReceived]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_VoiceLongDistance__VoiceLongDistanceDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "voice_long_distance", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["order_submitted", "pending_installation", "service_installed"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/VoiceLongDistanceDetailsOutV1IgnoreExtra"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.VoiceLongDistance], VoiceLongDistanceDetailsOutV1IgnoreExtra, Literal[CurrentStepChoices.OrderSubmitted, CurrentStepChoices.PendingInstallation, CurrentStepChoices.ServiceInstalled]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_VoiceOther__VoiceOtherDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "voice_other", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["info_received", "out_for_quote", "quote_received", "contract_requested", "contract_received"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/VoiceOtherDetailsOutV1IgnoreExtraOptional"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.VoiceOther], VoiceOtherDetailsOutV1IgnoreExtraOptional, Literal[CurrentStepChoices.InfoReceived, CurrentStepChoices.OutForQuote, CurrentStepChoices.QuoteReceived, CurrentStepChoices.ContractRequested, CurrentStepChoices.ContractReceived]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_VoiceOther__VoiceOtherDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "voice_other", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["order_submitted", "pending_installation", "service_installed"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/VoiceOtherDetailsOutV1IgnoreExtra"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.VoiceOther], VoiceOtherDetailsOutV1IgnoreExtra, Literal[CurrentStepChoices.OrderSubmitted, CurrentStepChoices.PendingInstallation, CurrentStepChoices.ServiceInstalled]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_VoicePhoneLines__VoicePhoneLinesDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "voice_phone_lines", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["info_received", "out_for_quote", "quote_received", "contract_requested", "contract_received"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/VoicePhoneLinesDetailsOutV1IgnoreExtraOptional"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.VoicePhoneLines], VoicePhoneLinesDetailsOutV1IgnoreExtraOptional, Literal[CurrentStepChoices.InfoReceived, CurrentStepChoices.OutForQuote, CurrentStepChoices.QuoteReceived, CurrentStepChoices.ContractRequested, CurrentStepChoices.ContractReceived]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_VoicePhoneLines__VoicePhoneLinesDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "voice_phone_lines", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["order_submitted", "pending_installation", "service_installed"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/VoicePhoneLinesDetailsOutV1IgnoreExtra"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.VoicePhoneLines], VoicePhoneLinesDetailsOutV1IgnoreExtra, Literal[CurrentStepChoices.OrderSubmitted, CurrentStepChoices.PendingInstallation, CurrentStepChoices.ServiceInstalled]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_VoicePotsLine__VoicePotsLineDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "voice_pots_line", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["info_received", "out_for_quote", "quote_received", "contract_requested", "contract_received"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/VoicePotsLineDetailsOutV1IgnoreExtraOptional"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.VoicePotsLine], VoicePotsLineDetailsOutV1IgnoreExtraOptional, Literal[CurrentStepChoices.InfoReceived, CurrentStepChoices.OutForQuote, CurrentStepChoices.QuoteReceived, CurrentStepChoices.ContractRequested, CurrentStepChoices.ContractReceived]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_VoicePotsLine__VoicePotsLineDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "voice_pots_line", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["order_submitted", "pending_installation", "service_installed"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/VoicePotsLineDetailsOutV1IgnoreExtra"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.VoicePotsLine], VoicePotsLineDetailsOutV1IgnoreExtra, Literal[CurrentStepChoices.OrderSubmitted, CurrentStepChoices.PendingInstallation, CurrentStepChoices.ServiceInstalled]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_VoicePotsPiab__VoicePotsPiabDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "voice_pots_piab", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["info_received", "out_for_quote", "quote_received", "contract_requested", "contract_received"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/VoicePotsPiabDetailsOutV1IgnoreExtraOptional"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.VoicePotsPiab], VoicePotsPiabDetailsOutV1IgnoreExtraOptional, Literal[CurrentStepChoices.InfoReceived, CurrentStepChoices.OutForQuote, CurrentStepChoices.QuoteReceived, CurrentStepChoices.ContractRequested, CurrentStepChoices.ContractReceived]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_VoicePotsPiab__VoicePotsPiabDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "voice_pots_piab", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["order_submitted", "pending_installation", "service_installed"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/VoicePotsPiabDetailsOutV1IgnoreExtra"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.VoicePotsPiab], VoicePotsPiabDetailsOutV1IgnoreExtra, Literal[CurrentStepChoices.OrderSubmitted, CurrentStepChoices.PendingInstallation, CurrentStepChoices.ServiceInstalled]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_VoicePriBri__VoicePriBriDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "voice_pri_bri", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["info_received", "out_for_quote", "quote_received", "contract_requested", "contract_received"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/VoicePriBriDetailsOutV1IgnoreExtraOptional"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.VoicePriBri], VoicePriBriDetailsOutV1IgnoreExtraOptional, Literal[CurrentStepChoices.InfoReceived, CurrentStepChoices.OutForQuote, CurrentStepChoices.QuoteReceived, CurrentStepChoices.ContractRequested, CurrentStepChoices.ContractReceived]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_VoicePriBri__VoicePriBriDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "voice_pri_bri", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["order_submitted", "pending_installation", "service_installed"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/VoicePriBriDetailsOutV1IgnoreExtra"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.VoicePriBri], VoicePriBriDetailsOutV1IgnoreExtra, Literal[CurrentStepChoices.OrderSubmitted, CurrentStepChoices.PendingInstallation, CurrentStepChoices.ServiceInstalled]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_VoicePri__VoicePriDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "voice_pri", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["info_received", "out_for_quote", "quote_received", "contract_requested", "contract_received"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/VoicePriDetailsOutV1IgnoreExtraOptional"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.VoicePri], VoicePriDetailsOutV1IgnoreExtraOptional, Literal[CurrentStepChoices.InfoReceived, CurrentStepChoices.OutForQuote, CurrentStepChoices.QuoteReceived, CurrentStepChoices.ContractRequested, CurrentStepChoices.ContractReceived]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_VoicePri__VoicePriDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "voice_pri", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["order_submitted", "pending_installation", "service_installed"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/VoicePriDetailsOutV1IgnoreExtra"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.VoicePri], VoicePriDetailsOutV1IgnoreExtra, Literal[CurrentStepChoices.OrderSubmitted, CurrentStepChoices.PendingInstallation, CurrentStepChoices.ServiceInstalled]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_VoiceRcfLine__VoiceRcfLineDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "voice_rcf_line", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["info_received", "out_for_quote", "quote_received", "contract_requested", "contract_received"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/VoiceRcfLineDetailsOutV1IgnoreExtraOptional"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.VoiceRcfLine], VoiceRcfLineDetailsOutV1IgnoreExtraOptional, Literal[CurrentStepChoices.InfoReceived, CurrentStepChoices.OutForQuote, CurrentStepChoices.QuoteReceived, CurrentStepChoices.ContractRequested, CurrentStepChoices.ContractReceived]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_VoiceRcfLine__VoiceRcfLineDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "voice_rcf_line", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["order_submitted", "pending_installation", "service_installed"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/VoiceRcfLineDetailsOutV1IgnoreExtra"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.VoiceRcfLine], VoiceRcfLineDetailsOutV1IgnoreExtra, Literal[CurrentStepChoices.OrderSubmitted, CurrentStepChoices.PendingInstallation, CurrentStepChoices.ServiceInstalled]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_VoiceSipCcp__VoiceSipCcpDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "voice_sip_ccp", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["info_received", "out_for_quote", "quote_received", "contract_requested", "contract_received"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/VoiceSipCcpDetailsOutV1IgnoreExtraOptional"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.VoiceSipCcp], VoiceSipCcpDetailsOutV1IgnoreExtraOptional, Literal[CurrentStepChoices.InfoReceived, CurrentStepChoices.OutForQuote, CurrentStepChoices.QuoteReceived, CurrentStepChoices.ContractRequested, CurrentStepChoices.ContractReceived]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_VoiceSipCcp__VoiceSipCcpDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "voice_sip_ccp", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["order_submitted", "pending_installation", "service_installed"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/VoiceSipCcpDetailsOutV1IgnoreExtra"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.VoiceSipCcp], VoiceSipCcpDetailsOutV1IgnoreExtra, Literal[CurrentStepChoices.OrderSubmitted, CurrentStepChoices.PendingInstallation, CurrentStepChoices.ServiceInstalled]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_VoiceSip__VoiceSipDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "voice_sip", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["info_received", "out_for_quote", "quote_received", "contract_requested", "contract_received"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/VoiceSipDetailsOutV1IgnoreExtraOptional"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.VoiceSip], VoiceSipDetailsOutV1IgnoreExtraOptional, Literal[CurrentStepChoices.InfoReceived, CurrentStepChoices.OutForQuote, CurrentStepChoices.QuoteReceived, CurrentStepChoices.ContractRequested, CurrentStepChoices.ContractReceived]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_VoiceSip__VoiceSipDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "voice_sip", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["order_submitted", "pending_installation", "service_installed"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/VoiceSipDetailsOutV1IgnoreExtra"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.VoiceSip], VoiceSipDetailsOutV1IgnoreExtra, Literal[CurrentStepChoices.OrderSubmitted, CurrentStepChoices.PendingInstallation, CurrentStepChoices.ServiceInstalled]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_VoiceTollFree__VoiceTollFreeDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "voice_toll_free", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["info_received", "out_for_quote", "quote_received", "contract_requested", "contract_received"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/VoiceTollFreeDetailsOutV1IgnoreExtraOptional"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.VoiceTollFree], VoiceTollFreeDetailsOutV1IgnoreExtraOptional, Literal[CurrentStepChoices.InfoReceived, CurrentStepChoices.OutForQuote, CurrentStepChoices.QuoteReceived, CurrentStepChoices.ContractRequested, CurrentStepChoices.ContractReceived]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_VoiceTollFree__VoiceTollFreeDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "voice_toll_free", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["order_submitted", "pending_installation", "service_installed"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/VoiceTollFreeDetailsOutV1IgnoreExtra"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.VoiceTollFree], VoiceTollFreeDetailsOutV1IgnoreExtra, Literal[CurrentStepChoices.OrderSubmitted, CurrentStepChoices.PendingInstallation, CurrentStepChoices.ServiceInstalled]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_VoiceUcaasInv__VoiceUcaasInvDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "voice_ucaas_inv", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["info_received", "out_for_quote", "quote_received", "contract_requested", "contract_received"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/VoiceUcaasInvDetailsOutV1IgnoreExtraOptional"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.VoiceUcaasInv], VoiceUcaasInvDetailsOutV1IgnoreExtraOptional, Literal[CurrentStepChoices.InfoReceived, CurrentStepChoices.OutForQuote, CurrentStepChoices.QuoteReceived, CurrentStepChoices.ContractRequested, CurrentStepChoices.ContractReceived]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_VoiceUcaasInv__VoiceUcaasInvDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "voice_ucaas_inv", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["order_submitted", "pending_installation", "service_installed"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/VoiceUcaasInvDetailsOutV1IgnoreExtra"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.VoiceUcaasInv], VoiceUcaasInvDetailsOutV1IgnoreExtra, Literal[CurrentStepChoices.OrderSubmitted, CurrentStepChoices.PendingInstallation, CurrentStepChoices.ServiceInstalled]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_VoiceUcaas__VoiceUcaasDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "voice_ucaas", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["info_received", "out_for_quote", "quote_received", "contract_requested", "contract_received"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/VoiceUcaasDetailsOutV1IgnoreExtraOptional"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.VoiceUcaas], VoiceUcaasDetailsOutV1IgnoreExtraOptional, Literal[CurrentStepChoices.InfoReceived, CurrentStepChoices.OutForQuote, CurrentStepChoices.QuoteReceived, CurrentStepChoices.ContractRequested, CurrentStepChoices.ContractReceived]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_VoiceUcaas__VoiceUcaasDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "voice_ucaas", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["order_submitted", "pending_installation", "service_installed"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/VoiceUcaasDetailsOutV1IgnoreExtra"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.VoiceUcaas], VoiceUcaasDetailsOutV1IgnoreExtra, Literal[CurrentStepChoices.OrderSubmitted, CurrentStepChoices.PendingInstallation, CurrentStepChoices.ServiceInstalled]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_VoiceVoipFeature__VoiceVoipFeatureDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "voice_voip_feature", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["info_received", "out_for_quote", "quote_received", "contract_requested", "contract_received"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/VoiceVoipFeatureDetailsOutV1IgnoreExtraOptional"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.VoiceVoipFeature], VoiceVoipFeatureDetailsOutV1IgnoreExtraOptional, Literal[CurrentStepChoices.InfoReceived, CurrentStepChoices.OutForQuote, CurrentStepChoices.QuoteReceived, CurrentStepChoices.ContractRequested, CurrentStepChoices.ContractReceived]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_VoiceVoipFeature__VoiceVoipFeatureDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "voice_voip_feature", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["order_submitted", "pending_installation", "service_installed"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/VoiceVoipFeatureDetailsOutV1IgnoreExtra"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.VoiceVoipFeature], VoiceVoipFeatureDetailsOutV1IgnoreExtra, Literal[CurrentStepChoices.OrderSubmitted, CurrentStepChoices.PendingInstallation, CurrentStepChoices.ServiceInstalled]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_VoiceVoipLine__VoiceVoipLineDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "voice_voip_line", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["info_received", "out_for_quote", "quote_received", "contract_requested", "contract_received"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/VoiceVoipLineDetailsOutV1IgnoreExtraOptional"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.VoiceVoipLine], VoiceVoipLineDetailsOutV1IgnoreExtraOptional, Literal[CurrentStepChoices.InfoReceived, CurrentStepChoices.OutForQuote, CurrentStepChoices.QuoteReceived, CurrentStepChoices.ContractRequested, CurrentStepChoices.ContractReceived]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_VoiceVoipLine__VoiceVoipLineDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "voice_voip_line", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["order_submitted", "pending_installation", "service_installed"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/VoiceVoipLineDetailsOutV1IgnoreExtra"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.VoiceVoipLine], VoiceVoipLineDetailsOutV1IgnoreExtra, Literal[CurrentStepChoices.OrderSubmitted, CurrentStepChoices.PendingInstallation, CurrentStepChoices.ServiceInstalled]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_VoiceVoipMinutes__VoiceVoipMinutesDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "voice_voip_minutes", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["info_received", "out_for_quote", "quote_received", "contract_requested", "contract_received"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/VoiceVoipMinutesDetailsOutV1IgnoreExtraOptional"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.VoiceVoipMinutes], VoiceVoipMinutesDetailsOutV1IgnoreExtraOptional, Literal[CurrentStepChoices.InfoReceived, CurrentStepChoices.OutForQuote, CurrentStepChoices.QuoteReceived, CurrentStepChoices.ContractRequested, CurrentStepChoices.ContractReceived]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_VoiceVoipMinutes__VoiceVoipMinutesDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "voice_voip_minutes", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["order_submitted", "pending_installation", "service_installed"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/VoiceVoipMinutesDetailsOutV1IgnoreExtra"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.VoiceVoipMinutes], VoiceVoipMinutesDetailsOutV1IgnoreExtra, Literal[CurrentStepChoices.OrderSubmitted, CurrentStepChoices.PendingInstallation, CurrentStepChoices.ServiceInstalled]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_WanDarkFiber__WanDarkFiberDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "wan_dark_fiber", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["info_received", "out_for_quote", "quote_received", "contract_requested", "contract_received"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/WanDarkFiberDetailsOutV1IgnoreExtraOptional"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.WanDarkFiber], WanDarkFiberDetailsOutV1IgnoreExtraOptional, Literal[CurrentStepChoices.InfoReceived, CurrentStepChoices.OutForQuote, CurrentStepChoices.QuoteReceived, CurrentStepChoices.ContractRequested, CurrentStepChoices.ContractReceived]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_WanDarkFiber__WanDarkFiberDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "wan_dark_fiber", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["order_submitted", "pending_installation", "service_installed"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/WanDarkFiberDetailsOutV1IgnoreExtra"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.WanDarkFiber], WanDarkFiberDetailsOutV1IgnoreExtra, Literal[CurrentStepChoices.OrderSubmitted, CurrentStepChoices.PendingInstallation, CurrentStepChoices.ServiceInstalled]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_WanMpls__WanMplsDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "wan_mpls", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["info_received", "out_for_quote", "quote_received", "contract_requested", "contract_received"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/WanMplsDetailsOutV1IgnoreExtraOptional"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.WanMpls], WanMplsDetailsOutV1IgnoreExtraOptional, Literal[CurrentStepChoices.InfoReceived, CurrentStepChoices.OutForQuote, CurrentStepChoices.QuoteReceived, CurrentStepChoices.ContractRequested, CurrentStepChoices.ContractReceived]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_WanMpls__WanMplsDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "wan_mpls", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["order_submitted", "pending_installation", "service_installed"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/WanMplsDetailsOutV1IgnoreExtra"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.WanMpls], WanMplsDetailsOutV1IgnoreExtra, Literal[CurrentStepChoices.OrderSubmitted, CurrentStepChoices.PendingInstallation, CurrentStepChoices.ServiceInstalled]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_WanPointToPoint__WanPointToPointDetailsOutOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "wan_point_to_point", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["info_received", "out_for_quote", "quote_received", "contract_requested", "contract_received"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/WanPointToPointDetailsOutOutV1IgnoreExtraOptional"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.WanPointToPoint], WanPointToPointDetailsOutOutV1IgnoreExtraOptional, Literal[CurrentStepChoices.InfoReceived, CurrentStepChoices.OutForQuote, CurrentStepChoices.QuoteReceived, CurrentStepChoices.ContractRequested, CurrentStepChoices.ContractReceived]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_WanPointToPoint__WanPointToPointDetailsOutOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "wan_point_to_point", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["order_submitted", "pending_installation", "service_installed"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/WanPointToPointDetailsOutOutV1IgnoreExtra"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.WanPointToPoint], WanPointToPointDetailsOutOutV1IgnoreExtra, Literal[CurrentStepChoices.OrderSubmitted, CurrentStepChoices.PendingInstallation, CurrentStepChoices.ServiceInstalled]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_WanSdWan__WanSdWanDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "wan_sd_wan", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["info_received", "out_for_quote", "quote_received", "contract_requested", "contract_received"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/WanSdWanDetailsOutV1IgnoreExtraOptional"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.WanSdWan], WanSdWanDetailsOutV1IgnoreExtraOptional, Literal[CurrentStepChoices.InfoReceived, CurrentStepChoices.OutForQuote, CurrentStepChoices.QuoteReceived, CurrentStepChoices.ContractRequested, CurrentStepChoices.ContractReceived]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_WanSdWan__WanSdWanDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "wan_sd_wan", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["order_submitted", "pending_installation", "service_installed"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/WanSdWanDetailsOutV1IgnoreExtra"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.WanSdWan], WanSdWanDetailsOutV1IgnoreExtra, Literal[CurrentStepChoices.OrderSubmitted, CurrentStepChoices.PendingInstallation, CurrentStepChoices.ServiceInstalled]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_WanVpls__WanVplsDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "wan_vpls", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["info_received", "out_for_quote", "quote_received", "contract_requested", "contract_received"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/WanVplsDetailsOutV1IgnoreExtraOptional"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.WanVpls], WanVplsDetailsOutV1IgnoreExtraOptional, Literal[CurrentStepChoices.InfoReceived, CurrentStepChoices.OutForQuote, CurrentStepChoices.QuoteReceived, CurrentStepChoices.ContractRequested, CurrentStepChoices.ContractReceived]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_WanVpls__WanVplsDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "wan_vpls", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["order_submitted", "pending_installation", "service_installed"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/WanVplsDetailsOutV1IgnoreExtra"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.WanVpls], WanVplsDetailsOutV1IgnoreExtra, Literal[CurrentStepChoices.OrderSubmitted, CurrentStepChoices.PendingInstallation, CurrentStepChoices.ServiceInstalled]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_WanWavelength__WanWavelengthDetailsOutV1IgnoreExtraOptional_Literal_InfoReceived_OutForQuote_QuoteReceived_ContractRequested_ContractReceived__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "wan_wavelength", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["info_received", "out_for_quote", "quote_received", "contract_requested", "contract_received"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/WanWavelengthDetailsOutV1IgnoreExtraOptional"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.WanWavelength], WanWavelengthDetailsOutV1IgnoreExtraOptional, Literal[CurrentStepChoices.InfoReceived, CurrentStepChoices.OutForQuote, CurrentStepChoices.QuoteReceived, CurrentStepChoices.ContractRequested, CurrentStepChoices.ContractReceived]]", "type": "object"}, "ServiceDetailOutBaseV1_Literal_WanWavelength__WanWavelengthDetailsOutV1IgnoreExtra_Literal_OrderSubmitted_PendingInstallation_ServiceInstalled__": {"properties": {"id": {"description": "ID of the Service.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"description": "Condensed name of the service provided by Lightyear. <br/><b>Example:</b> \"LA Headquarters (Internet)\" or \"SF Office - LA Headquarters (Wavelength P2P)\"", "title": "Name", "type": "string"}, "project_id": {"description": "ID of the project associated with the service. Can be used with `GET /developer/services/v1?project_id=...` to list sibling services.", "format": "uuid", "title": "Project Id", "type": "string"}, "project_name": {"description": "Name that the user has given to the project associated with the service. <br/><b>Example:</b> \"Internet (NYC HQ)\"", "title": "Project Name", "type": "string"}, "service_type": {"const": "wan_wavelength", "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type", "type": "string"}, "current_step": {"description": "Current step of the service. <br/><b>Example:</b> \"service_installed\"", "enum": ["order_submitted", "pending_installation", "service_installed"], "title": "Current Step", "type": "string"}, "status": {"anyOf": [{"$ref": "#/components/schemas/ServiceStatusChoices"}, {"type": "null"}], "description": "Whether the service is currently in progress, active, or inactive. <br/><b>Example:</b> \"Active\""}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Mrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) and PIN (if applicable) for the service. <br/><b>Example:</b> \"1234567890 (PIN 1234)\"", "title": "Billing Account Number"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Contract Provider of the service. <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "description": {"description": "A short description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Description", "type": "string"}, "locations": {"description": "List of locations associated with the service.", "items": {"$ref": "#/components/schemas/LocationDetailOutV1"}, "title": "Locations", "type": "array"}, "tags": {"description": "List of tag labels applied to the service by your team. <br/><b>Example:</b> [\"Priority\", \"Needs Review\"]", "items": {"type": "string"}, "title": "Tags", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this service or its sync-relevant related data (service details, locations and their addresses, provider sub-components, the contract, tags) changed. Use with the `updated_since` filter on `GET /developer/services/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "cancelled": {"allOf": [{"$ref": "#/components/schemas/CancelStatusChoices"}], "default": "not_cancelled", "description": "Cancellation state of the service. <br/><b>Example:</b> \"not_cancelled\""}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "install_status": {"$ref": "#/components/schemas/InstallStatusChoices", "description": "Status of the installation (if it is currently in progress). <br/><b>Example:</b> \"In Progress\""}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three letter currency code for the NRC Value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 100.00", "title": "Nrc Usd"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}]}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider if applicable. <br/><b>Example:</b> \"1234567890\"", "title": "Provider Sub Account Id"}, "auto_renew_decision": {"description": "Whether or not the user would like this service to auto renew at contract end. <br/><b>Example:</b> true", "title": "Auto Renew Decision", "type": "boolean"}, "auto_reshop_decision": {"description": "Whether or not the user would like this service to be auto reshopped by Lightyear at contract end. <br/><b>Example:</b> true", "title": "Auto Reshop Decision", "type": "boolean"}, "auto_reshop_period": {"description": "Number of days before the contract end date to start the auto-reshop process. <br/><b>Example:</b> 30", "title": "Auto Reshop Period", "type": "integer"}, "order_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Order number for the service. <br/><b>Example:</b> \"1234567890\"", "title": "Order Number"}, "requested_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation was requested to occur during the intake questionnaire.", "title": "Requested Install Date"}, "files": {"description": "List of files associated with the service.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Files", "type": "array"}, "custom_fields": {"description": "Custom fields configured by your team for this service. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "details": {"anyOf": [{"$ref": "#/components/schemas/WanWavelengthDetailsOutV1IgnoreExtra"}, {"type": "null"}], "description": "Additional details relevant to the service. This format can be different depending on service type. <br/><b>Example:</b> {\n    \"sla\": 99.99,\n    \"ulc\": \"Lumen\",\n    \"type\": \"Dedicated\",\n    \"transport\": \"Fiber\",\n    \"static_ips\": \"/26\",\n    \"network_asn\": \"3356\",\n    \"upload_speed\": 500,\n    \"download_speed\": 500,\n    \"delivery_point\": \"SUITE\",\n    \"managed_router\": \"No\",\n    \"fixed_bandwidth\": \"Fixed\",\n    \"network_firewall\": false,\n    \"transport_capacity\": 1000,\n    \"border_gateway_protocol\": false,\n}"}, "action_items": {"description": "List of action items associated with the service.", "items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Action Items", "type": "array"}, "phone_numbers": {"description": "List of phone numbers associated with the service.", "items": {"$ref": "#/components/schemas/PhoneNumberOutV1"}, "title": "Phone Numbers", "type": "array"}, "provider_sub_components": {"description": "Provider services in their Inventory & Billing records that compose this overall service", "items": {"$ref": "#/components/schemas/ProviderSubComponentOutV1"}, "title": "Provider Sub Components", "type": "array"}, "installation_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the installation contact for the service."}, "request_config": {"anyOf": [{"$ref": "#/components/schemas/RequestConfigOutV1"}, {"type": "null"}], "description": "Request configuration for the service."}, "technical_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Contact information for the technical contact for the service."}}, "required": ["id", "name", "project_id", "project_name", "service_type", "current_step", "updated_at", "install_status", "auto_renew_decision", "auto_reshop_decision", "auto_reshop_period"], "title": "ServiceDetailOutBaseV1[Literal[ServiceTypeChoices.WanWavelength], WanWavelengthDetailsOutV1IgnoreExtra, Literal[CurrentStepChoices.OrderSubmitted, CurrentStepChoices.PendingInstallation, CurrentStepChoices.ServiceInstalled]]", "type": "object"}, "ServiceOrderTypeChoices": {"enum": ["NEW_ORDER", "RENEWAL", "UPGRADE", "DOWNGRADE", "MOVE", "CHANGE"], "title": "ServiceOrderTypeChoices", "type": "string"}, "TeamAttachmentCategoryChoices": {"enum": ["CHAT", "OTHER", "DOCUMENT_REQUEST", "NIM", "BILL_CONSOLIDATION", "AGENT_CUSTOMER_LOA", "MSA", "CONTRACT", "KMZ", "KMZ_QUOTE", "TICKET", "CUSTOM_CHARGES_TEMPLATE", "LOA_CFA", "INSTALL_TEST_RESULTS", "INSTALL_COMPLETION_NOTICE", "INSTALL_TECHNICAL_DETAILS", "IPJ_FORM", "CERTIFICATE_OF_INSURANCE", "IP_CONFIGURATIONS", "INVOICE", "RIGHT_OF_ENTRY", "SERVICE_ORDER_ACCEPTANCE", "SCOPE_OF_WORK", "DMARC_PHOTOS", "FOC_CONFIRMATION", "ESCALATION_ORG", "CUSTOMER_SITE_REQUIREMENTS", "QUOTE", "COUNTER_SIGNED_CONTRACT", "SITE_PHOTOS", "AMENDMENT_ADDENDUM", "COMMIT_DATE", "CANCELLATION_CONFIRMATION", "BUILDING_ACCESS_AGREEMENT", "CARRIER_PORTAL_CREDENTIALS", "SITE_MAP"], "title": "TeamAttachmentCategoryChoices", "type": "string"}, "TeamDocumentOutV1": {"properties": {"id": {"description": "ID of the Team Document.", "format": "uuid", "title": "Id", "type": "string"}, "category": {"$ref": "#/components/schemas/TeamAttachmentCategoryChoices", "description": "Category of the Team Document. <br/><b>Example:</b> \"Contract\""}, "created_at": {"description": "Date and time when the team document was created. <br/><b>Example:</b> \"2021-01-01T00:00:00Z\"", "format": "date-time", "title": "Created At", "type": "string"}, "name": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Name of the Team Document file including the extension. <br/><b>Example:</b> \"my_file.pdf\"", "title": "Name"}, "file_url": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "URL to download the file. <br/><b>Example:</b> \"https://api.lightyear.ai/developer/team/documents/0261abc1-afb6-4f78-9d8e-83f64a928bd8/v1\"", "title": "File Url"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Provider associated with the Team Document (if applicable). <br/><b>Example:</b> \"AT&T\"", "title": "Provider"}, "signed_by": {"anyOf": [{"$ref": "#/components/schemas/AccountOutV1"}, {"type": "null"}], "description": "Name of the individual who signed the file."}, "signed_date": {"anyOf": [{"format": "date-time", "type": "string"}, {"type": "null"}], "description": "Date and time the file was signed", "title": "Signed Date"}}, "required": ["id", "category", "created_at"], "title": "TeamDocumentOutV1", "type": "object"}, "TvDetailsOutV1IgnoreExtra": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "medium": {"allOf": [{"$ref": "#/components/schemas/MediumChoices"}]}, "package": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Package"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "TvDetailsOutV1IgnoreExtra", "type": "object"}, "TvDetailsOutV1IgnoreExtraOptional": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "medium": {"anyOf": [{"$ref": "#/components/schemas/MediumChoices"}, {"type": "null"}]}, "package": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Package"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "TvDetailsOutV1IgnoreExtraOptional", "type": "object"}, "VoiceDidsDetailsOutV1IgnoreExtra": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "quantity": {"title": "Quantity", "type": "integer"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "VoiceDidsDetailsOutV1IgnoreExtra", "type": "object"}, "VoiceDidsDetailsOutV1IgnoreExtraOptional": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "quantity": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Quantity"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "VoiceDidsDetailsOutV1IgnoreExtraOptional", "type": "object"}, "VoiceHostedVoipDetailsOutV1IgnoreExtra": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "license_count": {"title": "License Count", "type": "integer"}, "license_type": {"title": "License Type", "type": "string"}, "desktop_phones": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Desktop Phones"}, "soft_phones": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Soft Phones"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "VoiceHostedVoipDetailsOutV1IgnoreExtra", "type": "object"}, "VoiceHostedVoipDetailsOutV1IgnoreExtraOptional": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "license_count": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "License Count"}, "license_type": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "License Type"}, "desktop_phones": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Desktop Phones"}, "soft_phones": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Soft Phones"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "VoiceHostedVoipDetailsOutV1IgnoreExtraOptional", "type": "object"}, "VoiceLongDistanceDetailsOutV1IgnoreExtra": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "access": {"enum": ["Switched", "Dedicated"], "title": "Access", "type": "string"}, "usage_charge_rate": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Usage Charge Rate"}, "round_up_rate": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Round Up Rate"}, "minimum_call_time": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Minimum Call Time"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "VoiceLongDistanceDetailsOutV1IgnoreExtra", "type": "object"}, "VoiceLongDistanceDetailsOutV1IgnoreExtraOptional": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "access": {"anyOf": [{"enum": ["Switched", "Dedicated"], "type": "string"}, {"type": "null"}], "title": "Access"}, "usage_charge_rate": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Usage Charge Rate"}, "round_up_rate": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Round Up Rate"}, "minimum_call_time": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Minimum Call Time"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "VoiceLongDistanceDetailsOutV1IgnoreExtraOptional", "type": "object"}, "VoiceOtherDetailsOutV1IgnoreExtra": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "description": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Description"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "VoiceOtherDetailsOutV1IgnoreExtra", "type": "object"}, "VoiceOtherDetailsOutV1IgnoreExtraOptional": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "description": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Description"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "VoiceOtherDetailsOutV1IgnoreExtraOptional", "type": "object"}, "VoicePhoneDataChoices": {"enum": ["Metered", "Unlimited"], "title": "VoicePhoneDataChoices", "type": "string"}, "VoicePhoneLinesDetailsOutV1IgnoreExtra": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "lines": {"title": "Lines", "type": "integer"}, "phone_line_type": {"allOf": [{"$ref": "#/components/schemas/VoicePhoneLinesTypeChoices"}]}, "equipment": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Equipment"}, "long_distance": {"anyOf": [{"$ref": "#/components/schemas/VoicePhoneDataChoices"}, {"type": "null"}]}, "toll_free_options": {"anyOf": [{"$ref": "#/components/schemas/VoicePhoneDataChoices"}, {"type": "null"}]}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "VoicePhoneLinesDetailsOutV1IgnoreExtra", "type": "object"}, "VoicePhoneLinesDetailsOutV1IgnoreExtraOptional": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "lines": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Lines"}, "phone_line_type": {"anyOf": [{"$ref": "#/components/schemas/VoicePhoneLinesTypeChoices"}, {"type": "null"}]}, "equipment": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Equipment"}, "long_distance": {"anyOf": [{"$ref": "#/components/schemas/VoicePhoneDataChoices"}, {"type": "null"}]}, "toll_free_options": {"anyOf": [{"$ref": "#/components/schemas/VoicePhoneDataChoices"}, {"type": "null"}]}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "VoicePhoneLinesDetailsOutV1IgnoreExtraOptional", "type": "object"}, "VoicePhoneLinesRequestConfigOutV1": {"properties": {"phone_line_type": {"anyOf": [{"items": {"enum": ["POTS", "VoIP"], "type": "string"}, "type": "array"}, {"type": "null"}], "description": "Phone Line Types <br/><b>Example:</b> [\"POTS\", \"VoIP\"]", "title": "Phone Line Type"}, "lines": {"description": "Number of phone lines. <br/><b>Example:</b> 5", "title": "Lines", "type": "integer"}, "equipment": {"description": "Equipment needed. <br/><b>Example:</b> Cisco 8800 Series", "title": "Equipment", "type": "string"}, "long_distance": {"description": "Data options for long distance <br/><b>Example:</b> ['Metered', 'Unlimited']", "items": {"enum": ["Metered", "Unlimited"], "type": "string"}, "title": "Long Distance", "type": "array"}, "toll_free_options": {"description": "Data options for toll free <br/><b>Example:</b> ['Metered', 'Unlimited']", "items": {"enum": ["Metered", "Unlimited"], "type": "string"}, "title": "Toll Free Options", "type": "array"}}, "required": ["phone_line_type", "lines", "equipment", "long_distance", "toll_free_options"], "title": "VoicePhoneLinesRequestConfigOutV1", "type": "object"}, "VoicePhoneLinesTypeChoices": {"enum": ["POTS", "VoIP"], "title": "VoicePhoneLinesTypeChoices", "type": "string"}, "VoicePotsLineDetailsOutV1IgnoreExtra": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "phone_number": {"title": "Phone Number", "type": "string"}, "use_case": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Use Case"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "VoicePotsLineDetailsOutV1IgnoreExtra", "type": "object"}, "VoicePotsLineDetailsOutV1IgnoreExtraOptional": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "phone_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Phone Number"}, "use_case": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Use Case"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "VoicePotsLineDetailsOutV1IgnoreExtraOptional", "type": "object"}, "VoicePotsPiabDetailsOutV1IgnoreExtra": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "phone_number": {"title": "Phone Number", "type": "string"}, "use_case": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Use Case"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "VoicePotsPiabDetailsOutV1IgnoreExtra", "type": "object"}, "VoicePotsPiabDetailsOutV1IgnoreExtraOptional": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "phone_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Phone Number"}, "use_case": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Use Case"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "VoicePotsPiabDetailsOutV1IgnoreExtraOptional", "type": "object"}, "VoicePriBriDetailsOutV1IgnoreExtra": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "type": {"enum": ["PRI", "BRI"], "title": "Type", "type": "string"}, "trunks": {"title": "Trunks", "type": "integer"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "VoicePriBriDetailsOutV1IgnoreExtra", "type": "object"}, "VoicePriBriDetailsOutV1IgnoreExtraOptional": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "type": {"anyOf": [{"enum": ["PRI", "BRI"], "type": "string"}, {"type": "null"}], "title": "Type"}, "trunks": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Trunks"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "VoicePriBriDetailsOutV1IgnoreExtraOptional", "type": "object"}, "VoicePriDetailsOutV1IgnoreExtra": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "trunks": {"title": "Trunks", "type": "integer"}, "dids": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Dids"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "VoicePriDetailsOutV1IgnoreExtra", "type": "object"}, "VoicePriDetailsOutV1IgnoreExtraOptional": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "trunks": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Trunks"}, "dids": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Dids"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "VoicePriDetailsOutV1IgnoreExtraOptional", "type": "object"}, "VoiceRcfLineDetailsOutV1IgnoreExtra": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "phone_number": {"title": "Phone Number", "type": "string"}, "forward_to_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Forward To Number"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "VoiceRcfLineDetailsOutV1IgnoreExtra", "type": "object"}, "VoiceRcfLineDetailsOutV1IgnoreExtraOptional": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "phone_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Phone Number"}, "forward_to_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Forward To Number"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "VoiceRcfLineDetailsOutV1IgnoreExtraOptional", "type": "object"}, "VoiceSipCcpDetailsOutV1IgnoreExtra": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "ccp_quantity": {"title": "Ccp Quantity", "type": "integer"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "VoiceSipCcpDetailsOutV1IgnoreExtra", "type": "object"}, "VoiceSipCcpDetailsOutV1IgnoreExtraOptional": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "ccp_quantity": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Ccp Quantity"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "VoiceSipCcpDetailsOutV1IgnoreExtraOptional", "type": "object"}, "VoiceSipDetailsOutV1IgnoreExtra": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "trunks": {"title": "Trunks", "type": "integer"}, "dids": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Dids"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "VoiceSipDetailsOutV1IgnoreExtra", "type": "object"}, "VoiceSipDetailsOutV1IgnoreExtraOptional": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "trunks": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Trunks"}, "dids": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Dids"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "VoiceSipDetailsOutV1IgnoreExtraOptional", "type": "object"}, "VoiceTollFreeDetailsOutV1IgnoreExtra": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "phone_number": {"title": "Phone Number", "type": "string"}, "access": {"anyOf": [{"enum": ["Switched", "Dedicated"], "type": "string"}, {"type": "null"}], "title": "Access"}, "usage_rate": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Usage Rate"}, "round_up_rate": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Round Up Rate"}, "minimum_call_time": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Minimum Call Time"}, "forward_to_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Forward To Number"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "VoiceTollFreeDetailsOutV1IgnoreExtra", "type": "object"}, "VoiceTollFreeDetailsOutV1IgnoreExtraOptional": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "phone_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Phone Number"}, "access": {"anyOf": [{"enum": ["Switched", "Dedicated"], "type": "string"}, {"type": "null"}], "title": "Access"}, "usage_rate": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Usage Rate"}, "round_up_rate": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Round Up Rate"}, "minimum_call_time": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Minimum Call Time"}, "forward_to_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Forward To Number"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "VoiceTollFreeDetailsOutV1IgnoreExtraOptional", "type": "object"}, "VoiceUcaasDetailsOutV1IgnoreExtra": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "hosted_pbx": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Hosted Pbx"}, "user_licenses": {"title": "User Licenses", "type": "integer"}, "local_numbers": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Local Numbers"}, "toll_free": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Toll Free"}, "desktop_phones": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Desktop Phones"}, "soft_phones": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Soft Phones"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "VoiceUcaasDetailsOutV1IgnoreExtra", "type": "object"}, "VoiceUcaasDetailsOutV1IgnoreExtraOptional": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "hosted_pbx": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Hosted Pbx"}, "user_licenses": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "User Licenses"}, "local_numbers": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Local Numbers"}, "toll_free": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Toll Free"}, "desktop_phones": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Desktop Phones"}, "soft_phones": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Soft Phones"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "VoiceUcaasDetailsOutV1IgnoreExtraOptional", "type": "object"}, "VoiceUcaasInvDetailsOutV1IgnoreExtra": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "license_count": {"title": "License Count", "type": "integer"}, "license_type": {"title": "License Type", "type": "string"}, "pbx_provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Pbx Provider"}, "desktop_phones": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Desktop Phones"}, "soft_phones": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Soft Phones"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "VoiceUcaasInvDetailsOutV1IgnoreExtra", "type": "object"}, "VoiceUcaasInvDetailsOutV1IgnoreExtraOptional": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "license_count": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "License Count"}, "license_type": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "License Type"}, "pbx_provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Pbx Provider"}, "desktop_phones": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Desktop Phones"}, "soft_phones": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Soft Phones"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "VoiceUcaasInvDetailsOutV1IgnoreExtraOptional", "type": "object"}, "VoiceVoipFeatureDetailsOutV1IgnoreExtra": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "feature_name": {"title": "Feature Name", "type": "string"}, "feature_quantity": {"title": "Feature Quantity", "type": "integer"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "VoiceVoipFeatureDetailsOutV1IgnoreExtra", "type": "object"}, "VoiceVoipFeatureDetailsOutV1IgnoreExtraOptional": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "feature_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Feature Name"}, "feature_quantity": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Feature Quantity"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "VoiceVoipFeatureDetailsOutV1IgnoreExtraOptional", "type": "object"}, "VoiceVoipLineDetailsOutV1IgnoreExtra": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "phone_number": {"title": "Phone Number", "type": "string"}, "use_case": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Use Case"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "VoiceVoipLineDetailsOutV1IgnoreExtra", "type": "object"}, "VoiceVoipLineDetailsOutV1IgnoreExtraOptional": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "phone_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Phone Number"}, "use_case": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Use Case"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "VoiceVoipLineDetailsOutV1IgnoreExtraOptional", "type": "object"}, "VoiceVoipMinutesDetailsOutV1IgnoreExtra": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "prepaid_minutes": {"title": "Prepaid Minutes", "type": "integer"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "VoiceVoipMinutesDetailsOutV1IgnoreExtra", "type": "object"}, "VoiceVoipMinutesDetailsOutV1IgnoreExtraOptional": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "prepaid_minutes": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Prepaid Minutes"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "VoiceVoipMinutesDetailsOutV1IgnoreExtraOptional", "type": "object"}, "WanDarkFiberDetailsOutV1IgnoreExtra": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "strands": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Strands"}, "handoff_details": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Handoff Details"}, "contract_type": {"anyOf": [{"$ref": "#/components/schemas/DarkFiberContractTypeChoices"}, {"type": "null"}]}, "provider_om": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Om"}, "iru": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Iru"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "WanDarkFiberDetailsOutV1IgnoreExtra", "type": "object"}, "WanDarkFiberDetailsOutV1IgnoreExtraOptional": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "strands": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Strands"}, "handoff_details": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Handoff Details"}, "contract_type": {"anyOf": [{"$ref": "#/components/schemas/DarkFiberContractTypeChoices"}, {"type": "null"}]}, "provider_om": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Om"}, "iru": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Iru"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "WanDarkFiberDetailsOutV1IgnoreExtraOptional", "type": "object"}, "WanLanIpData": {"properties": {"ipv4": {"allOf": [{"$ref": "#/components/schemas/WanLanIpFields_IPv4Address_"}], "default": {}}, "ipv6": {"allOf": [{"$ref": "#/components/schemas/WanLanIpFields_IPv6Address_"}], "default": {}}, "ip_address_architecture": {"const": "wan_lan", "title": "Ip Address Architecture", "type": "string"}}, "required": ["ip_address_architecture"], "title": "WanLanIpData", "type": "object"}, "WanLanIpFields_IPv4Address_": {"properties": {"wan_ip_block": {"anyOf": [{"format": "ipv4", "type": "string"}, {"type": "null"}], "title": "Wan Ip Block"}, "wan_gateway_ip": {"anyOf": [{"format": "ipv4", "type": "string"}, {"type": "null"}], "title": "Wan Gateway Ip"}, "wan_usable_ip_range": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Wan Usable Ip Range"}, "wan_subnet_mask": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Wan Subnet Mask"}, "dns1": {"anyOf": [{"format": "ipv4", "type": "string"}, {"type": "null"}], "title": "Dns1"}, "dns2": {"anyOf": [{"format": "ipv4", "type": "string"}, {"type": "null"}], "title": "Dns2"}, "notes": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Notes"}, "bgp_neighbor1": {"anyOf": [{"format": "ipv4", "type": "string"}, {"type": "null"}], "title": "Bgp Neighbor1"}, "bgp_neighbor2": {"anyOf": [{"format": "ipv4", "type": "string"}, {"type": "null"}], "title": "Bgp Neighbor2"}, "lan_ip_block": {"anyOf": [{"format": "ipv4", "type": "string"}, {"type": "null"}], "title": "Lan Ip Block"}, "lan_gateway_ip": {"anyOf": [{"format": "ipv4", "type": "string"}, {"type": "null"}], "title": "Lan Gateway Ip"}, "lan_subnet_mask": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lan Subnet Mask"}, "lan_usable_ip_range": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lan Usable Ip Range"}}, "title": "WanLanIpFields[IPv4Address]", "type": "object"}, "WanLanIpFields_IPv6Address_": {"properties": {"wan_ip_block": {"anyOf": [{"format": "ipv6", "type": "string"}, {"type": "null"}], "title": "Wan Ip Block"}, "wan_gateway_ip": {"anyOf": [{"format": "ipv6", "type": "string"}, {"type": "null"}], "title": "Wan Gateway Ip"}, "wan_usable_ip_range": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Wan Usable Ip Range"}, "wan_subnet_mask": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Wan Subnet Mask"}, "dns1": {"anyOf": [{"format": "ipv6", "type": "string"}, {"type": "null"}], "title": "Dns1"}, "dns2": {"anyOf": [{"format": "ipv6", "type": "string"}, {"type": "null"}], "title": "Dns2"}, "notes": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Notes"}, "bgp_neighbor1": {"anyOf": [{"format": "ipv6", "type": "string"}, {"type": "null"}], "title": "Bgp Neighbor1"}, "bgp_neighbor2": {"anyOf": [{"format": "ipv6", "type": "string"}, {"type": "null"}], "title": "Bgp Neighbor2"}, "lan_ip_block": {"anyOf": [{"format": "ipv6", "type": "string"}, {"type": "null"}], "title": "Lan Ip Block"}, "lan_gateway_ip": {"anyOf": [{"format": "ipv6", "type": "string"}, {"type": "null"}], "title": "Lan Gateway Ip"}, "lan_subnet_mask": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lan Subnet Mask"}, "lan_usable_ip_range": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lan Usable Ip Range"}}, "title": "WanLanIpFields[IPv6Address]", "type": "object"}, "WanMplsDetailsOutV1IgnoreExtra": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "bandwidth": {"title": "Bandwidth", "type": "number"}, "qos": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Qos"}, "sla": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Sla"}, "latency": {"title": "Latency", "type": "string"}, "jitter": {"title": "Jitter", "type": "integer"}, "packet_loss": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Packet Loss"}, "router": {"title": "Router", "type": "boolean"}, "interface_type": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Interface Type"}, "available_traffic_queues": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Available Traffic Queues"}, "ulc": {"title": "Ulc", "type": "string"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "WanMplsDetailsOutV1IgnoreExtra", "type": "object"}, "WanMplsDetailsOutV1IgnoreExtraOptional": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "bandwidth": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Bandwidth"}, "qos": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Qos"}, "sla": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Sla"}, "latency": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Latency"}, "jitter": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Jitter"}, "packet_loss": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Packet Loss"}, "router": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Router"}, "interface_type": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Interface Type"}, "available_traffic_queues": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Available Traffic Queues"}, "ulc": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Ulc"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "WanMplsDetailsOutV1IgnoreExtraOptional", "type": "object"}, "WanPointToPointDetailsOutOutV1IgnoreExtra": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "capacity": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Capacity"}, "bandwidth": {"title": "Bandwidth", "type": "number"}, "sla": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Sla"}, "latency": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Latency"}, "jitter": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Jitter"}, "packet_loss": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Packet Loss"}, "router": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Router"}, "protected": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Protected"}, "interface_type": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Interface Type"}, "ulc_location_a": {"title": "Ulc Location A", "type": "string"}, "ulc_location_z": {"title": "Ulc Location Z", "type": "string"}, "routing": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Routing"}, "fixed_bandwidth": {"anyOf": [{"enum": ["Fixed", "Burstable"], "type": "string"}, {"type": "null"}], "title": "Fixed Bandwidth"}, "committed_burstable_rate": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Committed Burstable Rate"}, "burstable_bandwidth": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Burstable Bandwidth"}, "committed_rate_cost_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Committed Rate Cost Value"}, "committed_rate_cost_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Committed Rate Cost Code"}, "burst_utilization_rate_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Burst Utilization Rate Value"}, "burst_utilization_rate_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Burst Utilization Rate Code"}, "construction_cost_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Construction Cost Value"}, "construction_cost_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Construction Cost Code"}, "has_construction": {"anyOf": [{"enum": ["TBD", "Yes", "No", ""], "type": "string"}, {"type": "null"}], "title": "Has Construction"}, "delivery_point": {"anyOf": [{"$ref": "#/components/schemas/ProviderDeliveryPointChoices"}, {"type": "null"}]}, "address_a_provider_install_demarc": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Address A Provider Install Demarc"}, "address_z_provider_install_demarc": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Address Z Provider Install Demarc"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}, "committed_rate_cost_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Committed Rate Cost Usd"}, "burst_utilization_rate_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Burst Utilization Rate Usd"}, "construction_cost_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Construction Cost Usd"}}, "title": "WanPointToPointDetailsOutOutV1IgnoreExtra", "type": "object"}, "WanPointToPointDetailsOutOutV1IgnoreExtraOptional": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "capacity": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Capacity"}, "bandwidth": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Bandwidth"}, "sla": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Sla"}, "latency": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Latency"}, "jitter": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Jitter"}, "packet_loss": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Packet Loss"}, "router": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Router"}, "protected": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Protected"}, "interface_type": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Interface Type"}, "ulc_location_a": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Ulc Location A"}, "ulc_location_z": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Ulc Location Z"}, "routing": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Routing"}, "fixed_bandwidth": {"anyOf": [{"enum": ["Fixed", "Burstable"], "type": "string"}, {"type": "null"}], "title": "Fixed Bandwidth"}, "committed_burstable_rate": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Committed Burstable Rate"}, "burstable_bandwidth": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Burstable Bandwidth"}, "committed_rate_cost_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Committed Rate Cost Value"}, "committed_rate_cost_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Committed Rate Cost Code"}, "burst_utilization_rate_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Burst Utilization Rate Value"}, "burst_utilization_rate_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Burst Utilization Rate Code"}, "construction_cost_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Construction Cost Value"}, "construction_cost_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Construction Cost Code"}, "has_construction": {"anyOf": [{"enum": ["TBD", "Yes", "No", ""], "type": "string"}, {"type": "null"}], "title": "Has Construction"}, "delivery_point": {"anyOf": [{"$ref": "#/components/schemas/ProviderDeliveryPointChoices"}, {"type": "null"}]}, "address_a_provider_install_demarc": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Address A Provider Install Demarc"}, "address_z_provider_install_demarc": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Address Z Provider Install Demarc"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}, "committed_rate_cost_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Committed Rate Cost Usd"}, "burst_utilization_rate_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Burst Utilization Rate Usd"}, "construction_cost_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Construction Cost Usd"}}, "title": "WanPointToPointDetailsOutOutV1IgnoreExtraOptional", "type": "object"}, "WanRequestConfigOutV1": {"properties": {"bandwidths": {"description": "Speed in mb/s. <br/><b>Example:</b> [500, 1000]", "items": {"type": "integer"}, "minItems": 1, "title": "Bandwidths", "type": "array"}, "router": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "default": false, "description": "Whether you need a managed router <br/><b>Example:</b> true", "title": "Router"}}, "required": ["bandwidths"], "title": "WanRequestConfigOutV1", "type": "object"}, "WanSdWanDetailsOutV1IgnoreExtra": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "capacity": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Capacity"}, "throughput": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Throughput"}, "sla": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Sla"}, "latency": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Latency"}, "jitter": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Jitter"}, "packet_loss": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Packet Loss"}, "hardware_appliance": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Hardware Appliance"}, "high_availability": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "High Availability"}, "hot_spare": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Hot Spare"}, "wan_interface": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Wan Interface"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "WanSdWanDetailsOutV1IgnoreExtra", "type": "object"}, "WanSdWanDetailsOutV1IgnoreExtraOptional": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "capacity": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Capacity"}, "throughput": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Throughput"}, "sla": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Sla"}, "latency": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Latency"}, "jitter": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Jitter"}, "packet_loss": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Packet Loss"}, "hardware_appliance": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Hardware Appliance"}, "high_availability": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "High Availability"}, "hot_spare": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Hot Spare"}, "wan_interface": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Wan Interface"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "WanSdWanDetailsOutV1IgnoreExtraOptional", "type": "object"}, "WanVplsDetailsOutV1IgnoreExtra": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "capacity": {"title": "Capacity", "type": "number"}, "bandwidth": {"title": "Bandwidth", "type": "number"}, "sla": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Sla"}, "latency": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Latency"}, "jitter": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Jitter"}, "packet_loss": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Packet Loss"}, "protected": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Protected"}, "fixed_bandwidth": {"enum": ["Fixed", "Burstable"], "title": "Fixed Bandwidth", "type": "string"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "WanVplsDetailsOutV1IgnoreExtra", "type": "object"}, "WanVplsDetailsOutV1IgnoreExtraOptional": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "capacity": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Capacity"}, "bandwidth": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Bandwidth"}, "sla": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Sla"}, "latency": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Latency"}, "jitter": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Jitter"}, "packet_loss": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Packet Loss"}, "protected": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Protected"}, "fixed_bandwidth": {"anyOf": [{"enum": ["Fixed", "Burstable"], "type": "string"}, {"type": "null"}], "title": "Fixed Bandwidth"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}}, "title": "WanVplsDetailsOutV1IgnoreExtraOptional", "type": "object"}, "WanWavelengthDetailsOutV1IgnoreExtra": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "capacity": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Capacity"}, "bandwidth": {"title": "Bandwidth", "type": "number"}, "sla": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Sla"}, "latency": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Latency"}, "jitter": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Jitter"}, "packet_loss": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Packet Loss"}, "router": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Router"}, "protected": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Protected"}, "interface_type": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Interface Type"}, "route_miles": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Route Miles"}, "ulc_location_a": {"title": "Ulc Location A", "type": "string"}, "ulc_location_z": {"title": "Ulc Location Z", "type": "string"}, "throughput": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Throughput"}, "routing": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Routing"}, "fixed_bandwidth": {"anyOf": [{"enum": ["Fixed", "Burstable"], "type": "string"}, {"type": "null"}], "title": "Fixed Bandwidth"}, "committed_burstable_rate": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Committed Burstable Rate"}, "burst_utilization_rate_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Burst Utilization Rate Value"}, "burst_utilization_rate_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Burst Utilization Rate Code"}, "construction_cost_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Construction Cost Value"}, "construction_cost_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Construction Cost Code"}, "has_construction": {"anyOf": [{"enum": ["TBD", "Yes", "No", ""], "type": "string"}, {"type": "null"}], "title": "Has Construction"}, "delivery_point": {"anyOf": [{"$ref": "#/components/schemas/ProviderDeliveryPointChoices"}, {"type": "null"}]}, "address_a_provider_install_demarc": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Address A Provider Install Demarc"}, "address_z_provider_install_demarc": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Address Z Provider Install Demarc"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}, "burst_utilization_rate_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Burst Utilization Rate Usd"}, "construction_cost_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Construction Cost Usd"}}, "title": "WanWavelengthDetailsOutV1IgnoreExtra", "type": "object"}, "WanWavelengthDetailsOutV1IgnoreExtraOptional": {"properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "capacity": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Capacity"}, "bandwidth": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Bandwidth"}, "sla": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Sla"}, "latency": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Latency"}, "jitter": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Jitter"}, "packet_loss": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Packet Loss"}, "router": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Router"}, "protected": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Protected"}, "interface_type": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Interface Type"}, "route_miles": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Route Miles"}, "ulc_location_a": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Ulc Location A"}, "ulc_location_z": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Ulc Location Z"}, "throughput": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Throughput"}, "routing": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Routing"}, "fixed_bandwidth": {"anyOf": [{"enum": ["Fixed", "Burstable"], "type": "string"}, {"type": "null"}], "title": "Fixed Bandwidth"}, "committed_burstable_rate": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Committed Burstable Rate"}, "burst_utilization_rate_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Burst Utilization Rate Value"}, "burst_utilization_rate_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Burst Utilization Rate Code"}, "construction_cost_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Construction Cost Value"}, "construction_cost_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Construction Cost Code"}, "has_construction": {"anyOf": [{"enum": ["TBD", "Yes", "No", ""], "type": "string"}, {"type": "null"}], "title": "Has Construction"}, "delivery_point": {"anyOf": [{"$ref": "#/components/schemas/ProviderDeliveryPointChoices"}, {"type": "null"}]}, "address_a_provider_install_demarc": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Address A Provider Install Demarc"}, "address_z_provider_install_demarc": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Address Z Provider Install Demarc"}, "termination_fee_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Usd"}, "burst_utilization_rate_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Burst Utilization Rate Usd"}, "construction_cost_usd": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Construction Cost Usd"}}, "title": "WanWavelengthDetailsOutV1IgnoreExtraOptional", "type": "object"}, "ServiceInV1": {"properties": {"project_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Name of the project associated with the service. This will default to the service type and location name if not provided. 'Internet (NYC HQ)'", "title": "Project Name"}, "notes": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Additional notes or requirements for this project. These will be added to each service in the project. <br/><b>Example:</b> \"High priority installation needed by Q1\"", "title": "Notes"}, "location_ids": {"items": {"format": "uuid", "type": "string"}, "title": "Location Ids", "type": "array"}, "service_type": {"description": "In the platform, `wan_point_to_point` is \"Ethernet P2P\" and `wan_wavelength` is \"Wavelength P2P\". For other service types, please use the platform. <br/><b>Example:</b> \"internet\"", "enum": ["internet", "wan_point_to_point", "wan_wavelength", "voice_phone_lines"], "title": "Service Type", "type": "string"}, "request_config": {"$ref": "#/components/schemas/RequestConfigInV1"}}, "required": ["location_ids", "service_type", "request_config"], "title": "ServiceInV1", "type": "object"}, "ColocationDetailsBaseOptional": {"additionalProperties": false, "properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "specific_address": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Specific Address"}, "space": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Space"}, "space_cost_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Space Cost Value"}, "space_cost_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Space Cost Code"}, "power": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Power"}, "power_cost_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Power Cost Value"}, "power_cost_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Power Cost Code"}, "interconnectivity": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Interconnectivity"}, "interconnectivity_cost": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Interconnectivity Cost"}, "interconnectivity_cost_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Interconnectivity Cost Value"}, "interconnectivity_cost_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Interconnectivity Cost Code"}, "roof_rights": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Roof Rights"}, "office_space": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Office Space"}, "smart_hands": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Smart Hands"}}, "title": "ColocationDetailsBaseOptional", "type": "object"}, "CrossConnectDetailsBaseOptional": {"additionalProperties": false, "properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "connection_a": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Connection A"}, "connection_z": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Connection Z"}, "cable_type": {"anyOf": [{"$ref": "#/components/schemas/CrossConnectCableChoices"}, {"type": "null"}]}}, "title": "CrossConnectDetailsBaseOptional", "type": "object"}, "DirectCloudConnectDetailsBaseOptional": {"additionalProperties": false, "properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "download_speed": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Download Speed"}, "upload_speed": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Upload Speed"}, "transport": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Transport"}, "sla": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Sla"}, "latency": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Latency"}, "jitter": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Jitter"}, "packet_loss": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Packet Loss"}, "ulc": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Ulc"}, "transport_capacity": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Transport Capacity"}, "cloud_provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Cloud Provider"}, "geo": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Geo"}, "region": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Region"}, "on_ramp_location": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "On Ramp Location"}}, "title": "DirectCloudConnectDetailsBaseOptional", "type": "object"}, "InternetDetailsBaseOptional": {"additionalProperties": false, "properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "type": {"anyOf": [{"$ref": "#/components/schemas/InternetTypeChoices"}, {"type": "null"}]}, "wan_label": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Wan Label"}, "transport": {"anyOf": [{"$ref": "#/components/schemas/InternetTransportChoices"}, {"type": "null"}]}, "border_gateway_protocol": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Border Gateway Protocol"}, "transport_capacity": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Transport Capacity"}, "ulc": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Ulc"}, "download_speed": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Download Speed"}, "upload_speed": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Upload Speed"}, "sla": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Sla"}, "managed_router": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Managed Router"}, "wifi_included": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Wifi Included"}, "network_asn": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Network Asn"}, "static_ips": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Static Ips"}, "fixed_bandwidth": {"anyOf": [{"enum": ["Fixed", "Burstable"], "type": "string"}, {"type": "null"}], "title": "Fixed Bandwidth"}, "committed_burstable_rate": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Committed Burstable Rate"}, "burstable_bandwidth": {"anyOf": [{"enum": ["10 mb/s", "50 mb/s", "100 mb/s", "200 mb/s", "300 mb/s", "500 mb/s", "1 gb/s", "2 gb/s", "3 gb/s", "4 gb/s", "5 gb/s", "10 gb/s", "20 gb/s", "40 gb/s", "100 gb/s"], "type": "string"}, {"type": "null"}], "title": "Burstable Bandwidth"}, "committed_rate_cost_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Committed Rate Cost Value"}, "committed_rate_cost_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Committed Rate Cost Code"}, "burst_utilization_rate_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Burst Utilization Rate Value"}, "burst_utilization_rate_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Burst Utilization Rate Code"}, "network_firewall": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Network Firewall"}, "primary_dns_server": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Primary Dns Server"}, "secondary_dns_server": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Secondary Dns Server"}, "construction_cost_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Construction Cost Value"}, "construction_cost_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Construction Cost Code"}, "has_construction": {"anyOf": [{"enum": ["TBD", "Yes", "No", ""], "type": "string"}, {"type": "null"}], "title": "Has Construction"}, "customer_requested_handoff": {"anyOf": [{"$ref": "#/components/schemas/HandOffTypeChoices"}, {"type": "null"}]}, "delivery_point": {"anyOf": [{"$ref": "#/components/schemas/ProviderDeliveryPointChoices"}, {"type": "null"}]}, "address_a_provider_install_demarc": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Address A Provider Install Demarc"}, "modem_mac": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Modem Mac"}, "modem_serial": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Modem Serial"}, "modem_make_model": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Modem Make Model"}}, "title": "InternetDetailsBaseOptional", "type": "object"}, "MobileLineDetailsBaseOptional": {"additionalProperties": false, "properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "line_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Line Number"}, "device_model": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Device Model"}, "device_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Device Id"}, "user": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "User"}, "msid": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Msid"}, "imei": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Imei"}, "plan": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Plan"}, "network_technology": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Network Technology"}}, "title": "MobileLineDetailsBaseOptional", "type": "object"}, "MusicDetailsBaseOptional": {"additionalProperties": false, "properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}}, "title": "MusicDetailsBaseOptional", "type": "object"}, "SecurityDetailsBaseOptional": {"additionalProperties": false, "properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "number_of_cameras": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Number Of Cameras"}}, "title": "SecurityDetailsBaseOptional", "type": "object"}, "ServiceUpdateInV1": {"additionalProperties": false, "properties": {"term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Term of the service in months. <br/><b>Example:</b> 12", "title": "Term"}, "mrc_code": {"anyOf": [{"maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string"}, {"type": "null"}], "description": "Three letter currency code. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"minimum": 0.0, "type": "number"}, {"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost of the service in the currency listed in \"mrc_code\". <br/><b>Example:</b> 100.00", "title": "Mrc Value"}, "nrc_code": {"anyOf": [{"maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string"}, {"type": "null"}], "description": "Three letter currency code. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"minimum": 0.0, "type": "number"}, {"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost of the service in the currency listed in \"nrc_code\". <br/><b>Example:</b> 100.00", "title": "Nrc Value"}, "install_interval": {"anyOf": [{"minimum": 0, "type": "integer"}, {"type": "null"}], "description": "Interval in days for the installation as contracted. <br/><b>Example:</b> 30", "title": "Install Interval"}, "start_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service was started. <br/><b>Example:</b> \"2021-01-01\"", "title": "Start Date"}, "end_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the service is scheduled to end based on the contract. <br/><b>Example:</b> \"2022-01-01\"", "title": "End Date"}, "provider_sub_account_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Sub Account Number from the provider", "title": "Provider Sub Account Id"}, "order_type": {"anyOf": [{"$ref": "#/components/schemas/ServiceOrderTypeChoices"}, {"type": "null"}], "description": "Order Type can only be edited in Contract Requested or Contract Received"}, "notice_period": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "This may update multiple services if there are more on the same contract. Notice period in days for contract ending/renewal. <br/><b>Example:</b> 30", "title": "Notice Period"}, "auto_renew_term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "This may update multiple services if there are more on the same contract. The term that the contract will be on if it auto-renews (in months). <br/><b>Example:</b> 12", "title": "Auto Renew Term"}, "custom_fields": {"anyOf": [{"additionalProperties": true, "type": "object"}, {"type": "null"}], "description": "Fields configured by your team. Settings can be found at /developer/team/v1 under key custom_fields_settings.service_details. Custom Fields can be edited anytime after Contract Requested.", "title": "Custom Fields"}, "details": {"anyOf": [{"additionalProperties": true, "type": "object"}, {"$ref": "#/components/schemas/InternetDetailsBaseOptional"}, {"$ref": "#/components/schemas/CrossConnectDetailsBaseOptional"}, {"$ref": "#/components/schemas/WanDarkFiberDetailsBaseOptional"}, {"$ref": "#/components/schemas/WanWavelengthDetailsBaseOptional"}, {"$ref": "#/components/schemas/WanPointToPointDetailsBaseOptional"}, {"$ref": "#/components/schemas/WanMplsDetailsBaseOptional"}, {"$ref": "#/components/schemas/WanSdWanDetailsBaseOptional"}, {"$ref": "#/components/schemas/WanVplsDetailsBaseOptional"}, {"$ref": "#/components/schemas/VoicePhoneLinesDetailsBaseOptional"}, {"$ref": "#/components/schemas/VoiceSipDetailsBaseOptional"}, {"$ref": "#/components/schemas/VoicePriDetailsBaseOptional"}, {"$ref": "#/components/schemas/VoiceUcaasDetailsBaseOptional"}, {"$ref": "#/components/schemas/VoiceVoipLineDetailsBaseOptional"}, {"$ref": "#/components/schemas/VoicePotsLineDetailsBaseOptional"}, {"$ref": "#/components/schemas/VoicePotsPiabDetailsBaseOptional"}, {"$ref": "#/components/schemas/VoiceLongDistanceDetailsBaseOptional"}, {"$ref": "#/components/schemas/VoiceTollFreeDetailsBaseOptional"}, {"$ref": "#/components/schemas/VoiceRcfLineDetailsBaseOptional"}, {"$ref": "#/components/schemas/VoiceUcaasInvDetailsBaseOptional"}, {"$ref": "#/components/schemas/VoiceHostedVoipDetailsBaseOptional"}, {"$ref": "#/components/schemas/VoiceSipCcpDetailsBaseOptional"}, {"$ref": "#/components/schemas/VoiceVoipFeatureDetailsBaseOptional"}, {"$ref": "#/components/schemas/VoiceVoipMinutesDetailsBaseOptional"}, {"$ref": "#/components/schemas/VoiceDidsDetailsBaseOptional"}, {"$ref": "#/components/schemas/VoicePriBriDetailsBaseOptional"}, {"$ref": "#/components/schemas/VoiceOtherDetailsBaseOptional"}, {"$ref": "#/components/schemas/ColocationDetailsBaseOptional"}, {"$ref": "#/components/schemas/DirectCloudConnectDetailsBaseOptional"}, {"$ref": "#/components/schemas/TvDetailsBaseOptional"}, {"$ref": "#/components/schemas/MusicDetailsBaseOptional"}, {"$ref": "#/components/schemas/SecurityDetailsBaseOptional"}, {"$ref": "#/components/schemas/MobileLineDetailsBaseOptional"}], "description": "Additional details relevant to the service. This format can be different depending on service type.", "title": "Details"}}, "title": "ServiceUpdateInV1", "type": "object"}, "TvDetailsBaseOptional": {"additionalProperties": false, "properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "medium": {"anyOf": [{"$ref": "#/components/schemas/MediumChoices"}, {"type": "null"}]}, "package": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Package"}}, "title": "TvDetailsBaseOptional", "type": "object"}, "VoiceDidsDetailsBaseOptional": {"additionalProperties": false, "properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "quantity": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Quantity"}}, "title": "VoiceDidsDetailsBaseOptional", "type": "object"}, "VoiceHostedVoipDetailsBaseOptional": {"additionalProperties": false, "properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "license_count": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "License Count"}, "license_type": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "License Type"}, "desktop_phones": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Desktop Phones"}, "soft_phones": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Soft Phones"}}, "title": "VoiceHostedVoipDetailsBaseOptional", "type": "object"}, "VoiceLongDistanceDetailsBaseOptional": {"additionalProperties": false, "properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "access": {"anyOf": [{"enum": ["Switched", "Dedicated"], "type": "string"}, {"type": "null"}], "title": "Access"}, "usage_charge_rate": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Usage Charge Rate"}, "round_up_rate": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Round Up Rate"}, "minimum_call_time": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Minimum Call Time"}}, "title": "VoiceLongDistanceDetailsBaseOptional", "type": "object"}, "VoiceOtherDetailsBaseOptional": {"additionalProperties": false, "properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "description": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Description"}}, "title": "VoiceOtherDetailsBaseOptional", "type": "object"}, "VoicePhoneLinesDetailsBaseOptional": {"additionalProperties": false, "properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "lines": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Lines"}, "phone_line_type": {"anyOf": [{"$ref": "#/components/schemas/VoicePhoneLinesTypeChoices"}, {"type": "null"}]}, "equipment": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Equipment"}, "long_distance": {"anyOf": [{"$ref": "#/components/schemas/VoicePhoneDataChoices"}, {"type": "null"}]}, "toll_free_options": {"anyOf": [{"$ref": "#/components/schemas/VoicePhoneDataChoices"}, {"type": "null"}]}}, "title": "VoicePhoneLinesDetailsBaseOptional", "type": "object"}, "VoicePotsLineDetailsBaseOptional": {"additionalProperties": false, "properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "phone_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Phone Number"}, "use_case": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Use Case"}}, "title": "VoicePotsLineDetailsBaseOptional", "type": "object"}, "VoicePotsPiabDetailsBaseOptional": {"additionalProperties": false, "properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "phone_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Phone Number"}, "use_case": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Use Case"}}, "title": "VoicePotsPiabDetailsBaseOptional", "type": "object"}, "VoicePriBriDetailsBaseOptional": {"additionalProperties": false, "properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "type": {"anyOf": [{"enum": ["PRI", "BRI"], "type": "string"}, {"type": "null"}], "title": "Type"}, "trunks": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Trunks"}}, "title": "VoicePriBriDetailsBaseOptional", "type": "object"}, "VoicePriDetailsBaseOptional": {"additionalProperties": false, "properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "trunks": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Trunks"}, "dids": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Dids"}}, "title": "VoicePriDetailsBaseOptional", "type": "object"}, "VoiceRcfLineDetailsBaseOptional": {"additionalProperties": false, "properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "phone_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Phone Number"}, "forward_to_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Forward To Number"}}, "title": "VoiceRcfLineDetailsBaseOptional", "type": "object"}, "VoiceSipCcpDetailsBaseOptional": {"additionalProperties": false, "properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "ccp_quantity": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Ccp Quantity"}}, "title": "VoiceSipCcpDetailsBaseOptional", "type": "object"}, "VoiceSipDetailsBaseOptional": {"additionalProperties": false, "properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "trunks": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Trunks"}, "dids": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Dids"}}, "title": "VoiceSipDetailsBaseOptional", "type": "object"}, "VoiceTollFreeDetailsBaseOptional": {"additionalProperties": false, "properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "phone_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Phone Number"}, "access": {"anyOf": [{"enum": ["Switched", "Dedicated"], "type": "string"}, {"type": "null"}], "title": "Access"}, "usage_rate": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Usage Rate"}, "round_up_rate": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Round Up Rate"}, "minimum_call_time": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Minimum Call Time"}, "forward_to_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Forward To Number"}}, "title": "VoiceTollFreeDetailsBaseOptional", "type": "object"}, "VoiceUcaasDetailsBaseOptional": {"additionalProperties": false, "properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "hosted_pbx": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Hosted Pbx"}, "user_licenses": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "User Licenses"}, "local_numbers": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Local Numbers"}, "toll_free": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Toll Free"}, "desktop_phones": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Desktop Phones"}, "soft_phones": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Soft Phones"}}, "title": "VoiceUcaasDetailsBaseOptional", "type": "object"}, "VoiceUcaasInvDetailsBaseOptional": {"additionalProperties": false, "properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "license_count": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "License Count"}, "license_type": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "License Type"}, "pbx_provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Pbx Provider"}, "desktop_phones": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Desktop Phones"}, "soft_phones": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Soft Phones"}}, "title": "VoiceUcaasInvDetailsBaseOptional", "type": "object"}, "VoiceVoipFeatureDetailsBaseOptional": {"additionalProperties": false, "properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "feature_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Feature Name"}, "feature_quantity": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Feature Quantity"}}, "title": "VoiceVoipFeatureDetailsBaseOptional", "type": "object"}, "VoiceVoipLineDetailsBaseOptional": {"additionalProperties": false, "properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "phone_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Phone Number"}, "use_case": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Use Case"}}, "title": "VoiceVoipLineDetailsBaseOptional", "type": "object"}, "VoiceVoipMinutesDetailsBaseOptional": {"additionalProperties": false, "properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "prepaid_minutes": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Prepaid Minutes"}}, "title": "VoiceVoipMinutesDetailsBaseOptional", "type": "object"}, "WanDarkFiberDetailsBaseOptional": {"additionalProperties": false, "properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "strands": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Strands"}, "handoff_details": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Handoff Details"}, "contract_type": {"anyOf": [{"$ref": "#/components/schemas/DarkFiberContractTypeChoices"}, {"type": "null"}]}, "provider_om": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Om"}, "iru": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Iru"}}, "title": "WanDarkFiberDetailsBaseOptional", "type": "object"}, "WanMplsDetailsBaseOptional": {"additionalProperties": false, "properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "bandwidth": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Bandwidth"}, "qos": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Qos"}, "sla": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Sla"}, "latency": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Latency"}, "jitter": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Jitter"}, "packet_loss": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Packet Loss"}, "router": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Router"}, "interface_type": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Interface Type"}, "available_traffic_queues": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Available Traffic Queues"}, "ulc": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Ulc"}}, "title": "WanMplsDetailsBaseOptional", "type": "object"}, "WanPointToPointDetailsBaseOptional": {"additionalProperties": false, "properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "capacity": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Capacity"}, "bandwidth": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Bandwidth"}, "sla": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Sla"}, "latency": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Latency"}, "jitter": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Jitter"}, "packet_loss": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Packet Loss"}, "router": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Router"}, "protected": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Protected"}, "interface_type": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Interface Type"}, "ulc_location_a": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Ulc Location A"}, "ulc_location_z": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Ulc Location Z"}, "routing": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Routing"}, "fixed_bandwidth": {"anyOf": [{"enum": ["Fixed", "Burstable"], "type": "string"}, {"type": "null"}], "title": "Fixed Bandwidth"}, "committed_burstable_rate": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Committed Burstable Rate"}, "burstable_bandwidth": {"anyOf": [{"enum": ["10 mb/s", "50 mb/s", "100 mb/s", "200 mb/s", "300 mb/s", "500 mb/s", "1 gb/s", "2 gb/s", "3 gb/s", "4 gb/s", "5 gb/s", "10 gb/s", "20 gb/s", "40 gb/s", "100 gb/s"], "type": "string"}, {"type": "null"}], "title": "Burstable Bandwidth"}, "committed_rate_cost_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Committed Rate Cost Value"}, "committed_rate_cost_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Committed Rate Cost Code"}, "burst_utilization_rate_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Burst Utilization Rate Value"}, "burst_utilization_rate_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Burst Utilization Rate Code"}, "construction_cost_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Construction Cost Value"}, "construction_cost_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Construction Cost Code"}, "has_construction": {"anyOf": [{"enum": ["TBD", "Yes", "No", ""], "type": "string"}, {"type": "null"}], "title": "Has Construction"}, "delivery_point": {"anyOf": [{"$ref": "#/components/schemas/ProviderDeliveryPointChoices"}, {"type": "null"}]}, "address_a_provider_install_demarc": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Address A Provider Install Demarc"}, "address_z_provider_install_demarc": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Address Z Provider Install Demarc"}}, "title": "WanPointToPointDetailsBaseOptional", "type": "object"}, "WanSdWanDetailsBaseOptional": {"additionalProperties": false, "properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "capacity": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Capacity"}, "throughput": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Throughput"}, "sla": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Sla"}, "latency": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Latency"}, "jitter": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Jitter"}, "packet_loss": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Packet Loss"}, "hardware_appliance": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Hardware Appliance"}, "high_availability": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "High Availability"}, "hot_spare": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Hot Spare"}, "wan_interface": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Wan Interface"}}, "title": "WanSdWanDetailsBaseOptional", "type": "object"}, "WanVplsDetailsBaseOptional": {"additionalProperties": false, "properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "capacity": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Capacity"}, "bandwidth": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Bandwidth"}, "sla": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Sla"}, "latency": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Latency"}, "jitter": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Jitter"}, "packet_loss": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Packet Loss"}, "protected": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Protected"}, "fixed_bandwidth": {"anyOf": [{"enum": ["Fixed", "Burstable"], "type": "string"}, {"type": "null"}], "title": "Fixed Bandwidth"}}, "title": "WanVplsDetailsBaseOptional", "type": "object"}, "WanWavelengthDetailsBaseOptional": {"additionalProperties": false, "properties": {"taxes_and_fees": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Taxes And Fees"}, "provider_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Service Id"}, "billing_end_date": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Billing End Date"}, "termination_fee_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Termination Fee Code"}, "termination_fee_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Termination Fee Value"}, "alt_provider_service_id1": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id1"}, "alt_provider_service_id2": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Alt Provider Service Id2"}, "lmp_service_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Lmp Service Id"}, "provider_product_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Provider Product Name"}, "capacity": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Capacity"}, "bandwidth": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Bandwidth"}, "sla": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Sla"}, "latency": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Latency"}, "jitter": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Jitter"}, "packet_loss": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Packet Loss"}, "router": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Router"}, "protected": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "title": "Protected"}, "interface_type": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Interface Type"}, "route_miles": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Route Miles"}, "ulc_location_a": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Ulc Location A"}, "ulc_location_z": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Ulc Location Z"}, "throughput": {"anyOf": [{"type": "integer"}, {"type": "null"}], "title": "Throughput"}, "routing": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Routing"}, "fixed_bandwidth": {"anyOf": [{"enum": ["Fixed", "Burstable"], "type": "string"}, {"type": "null"}], "title": "Fixed Bandwidth"}, "committed_burstable_rate": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Committed Burstable Rate"}, "burst_utilization_rate_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Burst Utilization Rate Value"}, "burst_utilization_rate_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Burst Utilization Rate Code"}, "construction_cost_value": {"anyOf": [{"type": "number"}, {"type": "null"}], "title": "Construction Cost Value"}, "construction_cost_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Construction Cost Code"}, "has_construction": {"anyOf": [{"enum": ["TBD", "Yes", "No", ""], "type": "string"}, {"type": "null"}], "title": "Has Construction"}, "delivery_point": {"anyOf": [{"$ref": "#/components/schemas/ProviderDeliveryPointChoices"}, {"type": "null"}]}, "address_a_provider_install_demarc": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Address A Provider Install Demarc"}, "address_z_provider_install_demarc": {"anyOf": [{"type": "string"}, {"type": "null"}], "title": "Address Z Provider Install Demarc"}}, "title": "WanWavelengthDetailsBaseOptional", "type": "object"}, "BundledQuoteOutV1": {"properties": {"id": {"description": "ID of the quote.", "format": "uuid", "title": "Id", "type": "string"}, "service_id": {"description": "ID of the service this quote belongs to.", "format": "uuid", "title": "Service Id", "type": "string"}, "service_type": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Service type for this quote. <br/><b>Example:</b> \"internet\"", "title": "Service Type"}, "provider": {"description": "Provider name. <br/><b>Example:</b> \"AT&T\"", "title": "Provider", "type": "string"}, "status": {"description": "Quote status. Possible values: \"Available\", \"Pending\", \"No Bid\". <br/><b>Example:</b> \"Available\"", "title": "Status", "type": "string"}, "address": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Formatted address of the service location. <br/><b>Example:</b> \"123 Main St, Los Angeles, CA 90013, US\"", "title": "Address"}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three-letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost in the currency listed in \"mrc_code\". <br/><b>Example:</b> 500.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 500.00", "title": "Mrc Usd"}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three-letter currency code for the NRC value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost in the currency listed in \"nrc_code\". <br/><b>Example:</b> 1000.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 1000.00", "title": "Nrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Contract term in months. <br/><b>Example:</b> 36", "title": "Term"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Installation interval in days. <br/><b>Example:</b> 30", "title": "Install Interval"}, "selected": {"description": "Whether this quote has been selected. <br/><b>Example:</b> false", "title": "Selected", "type": "boolean"}, "recommended": {"description": "Whether this quote is recommended by Lightyear. <br/><b>Example:</b> true", "title": "Recommended", "type": "boolean"}, "is_expired": {"description": "Whether this quote has expired. <br/><b>Example:</b> false", "title": "Is Expired", "type": "boolean"}, "comments": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Comments on the quote. <br/><b>Example:</b> \"Premium fiber route\"", "title": "Comments"}, "detail": {"anyOf": [{"additionalProperties": true, "type": "object"}, {"type": "null"}], "description": "Quote detail containing service-specific configuration data.", "title": "Detail"}}, "required": ["id", "service_id", "provider", "status", "selected", "recommended", "is_expired"], "title": "BundledQuoteOutV1", "type": "object"}, "PagedQuoteOutV1": {"properties": {"items": {"items": {"$ref": "#/components/schemas/QuoteOutV1"}, "title": "Items", "type": "array"}, "total_items": {"examples": [1], "title": "Total Items", "type": "integer"}, "total_pages": {"examples": [1], "title": "Total Pages", "type": "integer"}, "page": {"examples": [1], "title": "Page", "type": "integer"}, "per_page": {"examples": [100], "title": "Per Page", "type": "integer"}}, "required": ["items", "total_items", "total_pages", "page", "per_page"], "title": "PagedQuoteOutV1", "type": "object"}, "QuoteOutV1": {"properties": {"id": {"description": "ID of the quote.", "format": "uuid", "title": "Id", "type": "string"}, "service_id": {"description": "ID of the service this quote belongs to.", "format": "uuid", "title": "Service Id", "type": "string"}, "service_type": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Service type for this quote. <br/><b>Example:</b> \"internet\"", "title": "Service Type"}, "provider": {"description": "Provider name. <br/><b>Example:</b> \"AT&T\"", "title": "Provider", "type": "string"}, "status": {"description": "Quote status. Possible values: \"Available\", \"Pending\", \"No Bid\". <br/><b>Example:</b> \"Available\"", "title": "Status", "type": "string"}, "address": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Formatted address of the service location. <br/><b>Example:</b> \"123 Main St, Los Angeles, CA 90013, US\"", "title": "Address"}, "mrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three-letter currency code for the MRC value. <br/><b>Example:</b> \"USD\"", "title": "Mrc Code"}, "mrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost in the currency listed in \"mrc_code\". <br/><b>Example:</b> 500.00", "title": "Mrc Value"}, "mrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Monthly recurring cost in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 500.00", "title": "Mrc Usd"}, "nrc_code": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Three-letter currency code for the NRC value. <br/><b>Example:</b> \"USD\"", "title": "Nrc Code"}, "nrc_value": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost in the currency listed in \"nrc_code\". <br/><b>Example:</b> 1000.00", "title": "Nrc Value"}, "nrc_usd": {"anyOf": [{"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Non-recurring cost in USD (subject to daily exchange rate fluctuations). <br/><b>Example:</b> 1000.00", "title": "Nrc Usd"}, "term": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Contract term in months. <br/><b>Example:</b> 36", "title": "Term"}, "install_interval": {"anyOf": [{"type": "integer"}, {"type": "null"}], "description": "Installation interval in days. <br/><b>Example:</b> 30", "title": "Install Interval"}, "selected": {"description": "Whether this quote has been selected. <br/><b>Example:</b> false", "title": "Selected", "type": "boolean"}, "recommended": {"description": "Whether this quote is recommended by Lightyear. <br/><b>Example:</b> true", "title": "Recommended", "type": "boolean"}, "is_expired": {"description": "Whether this quote has expired. <br/><b>Example:</b> false", "title": "Is Expired", "type": "boolean"}, "comments": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Comments on the quote. <br/><b>Example:</b> \"Premium fiber route\"", "title": "Comments"}, "quote_bundle_id": {"anyOf": [{"format": "uuid", "type": "string"}, {"type": "null"}], "description": "Bundle ID grouping this quote with quotes on other services. Null if quote is not bundled.", "title": "Quote Bundle Id"}, "bundled_quotes": {"description": "Other quotes in the same bundle (from other services in the project). Empty if quote is not bundled.", "items": {"$ref": "#/components/schemas/BundledQuoteOutV1"}, "title": "Bundled Quotes", "type": "array"}, "detail": {"anyOf": [{"additionalProperties": true, "type": "object"}, {"type": "null"}], "description": "Quote detail containing service-specific configuration data.", "title": "Detail"}}, "required": ["id", "service_id", "provider", "status", "selected", "recommended", "is_expired"], "title": "QuoteOutV1", "type": "object"}, "InstallTrackingLocationOutV1": {"properties": {"location_id": {"description": "ID of the service location.", "format": "uuid", "title": "Location Id", "type": "string"}, "name": {"description": "Label for this location. <br/><b>Example:</b> \"LA Headquarters\"", "title": "Name", "type": "string"}, "address": {"description": "Full location address. <br/><b>Example:</b> \"123 Main St, Los Angeles, CA 90013, US\"", "title": "Address", "type": "string"}, "scheduled_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The date the installation is scheduled to occur.", "title": "Scheduled Install Date"}, "original_target_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The original target date for the installation.", "title": "Original Target Date"}, "actual_install_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "The actual date the installation occurred.", "title": "Actual Install Date"}, "latest_update": {"anyOf": [{"$ref": "#/components/schemas/MilestoneUpdateOutV1"}, {"type": "null"}], "description": "The most recent installation update across all milestones for this location."}, "milestones": {"description": "List of installation milestones for this location.", "items": {"$ref": "#/components/schemas/MilestoneOutV1"}, "title": "Milestones", "type": "array"}}, "required": ["location_id", "name", "address"], "title": "InstallTrackingLocationOutV1", "type": "object"}, "MilestoneOutV1": {"properties": {"id": {"description": "ID of the milestone.", "format": "uuid", "title": "Id", "type": "string"}, "order": {"description": "Position in the milestone sequence (0-based). <br/><b>Example:</b> 0", "title": "Order", "type": "integer"}, "label": {"description": "Human-readable name of the milestone. <br/><b>Example:</b> \"Carrier Site Survey\"", "title": "Label", "type": "string"}, "description": {"description": "Additional detail about the milestone. <br/><b>Example:</b> \"Provider conducts on-site survey\"", "title": "Description", "type": "string"}, "status": {"description": "Milestone status. Possible values: \"Not Started\", \"In Progress\", \"Completed\", \"Delayed\", etc. <br/><b>Example:</b> \"Not Started\"", "title": "Status", "type": "string"}, "milestone_key": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Machine-readable key identifying the milestone type. <br/><b>Example:</b> \"carrier_site_survey\"", "title": "Milestone Key"}, "start_date_expected": {"description": "Expected start date for the milestone. <br/><b>Example:</b> \"2024-01-15\"", "format": "date", "title": "Start Date Expected", "type": "string"}, "end_date_expected": {"description": "Expected end date for the milestone. <br/><b>Example:</b> \"2024-02-01\"", "format": "date", "title": "End Date Expected", "type": "string"}, "end_date_scheduled": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Scheduled end date for the milestone. <br/><b>Example:</b> \"2024-01-28\"", "title": "End Date Scheduled"}, "end_date_actual": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Actual end date when the milestone was completed. <br/><b>Example:</b> \"2024-01-25\"", "title": "End Date Actual"}, "updates": {"description": "List of updates (events) for this milestone, ordered by most recent first.", "items": {"$ref": "#/components/schemas/MilestoneUpdateOutV1"}, "title": "Updates", "type": "array"}}, "required": ["id", "order", "label", "description", "status", "start_date_expected", "end_date_expected"], "title": "MilestoneOutV1", "type": "object"}, "MilestoneUpdateOutV1": {"properties": {"id": {"description": "ID of the update event.", "format": "uuid", "title": "Id", "type": "string"}, "title": {"description": "Title of the update. <br/><b>Example:</b> \"Milestone status changed\"", "title": "Title", "type": "string"}, "created_at": {"description": "Date and time when the update was created. <br/><b>Example:</b> \"2024-01-15T14:30:00Z\"", "format": "date-time", "title": "Created At", "type": "string"}, "content": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Plain-text content of the update. <br/><b>Example:</b> \"Signed forms received, order processing to proceed.\"", "title": "Content"}}, "required": ["id", "title", "created_at"], "title": "MilestoneUpdateOutV1", "type": "object"}, "PagedInstallTrackingLocationOutV1": {"properties": {"items": {"items": {"$ref": "#/components/schemas/InstallTrackingLocationOutV1"}, "title": "Items", "type": "array"}, "total_items": {"examples": [1], "title": "Total Items", "type": "integer"}, "total_pages": {"examples": [1], "title": "Total Pages", "type": "integer"}, "page": {"examples": [1], "title": "Page", "type": "integer"}, "per_page": {"examples": [100], "title": "Per Page", "type": "integer"}}, "required": ["items", "total_items", "total_pages", "page", "per_page"], "title": "PagedInstallTrackingLocationOutV1", "type": "object"}, "EventOutV1": {"properties": {"id": {"description": "ID of the Event.", "format": "uuid", "title": "Id", "type": "string"}, "title": {"description": "Title of the Event. <br/><b>Example:</b> \"Service details updated\"", "title": "Title", "type": "string"}, "type": {"$ref": "#/components/schemas/EventTypeChoices", "description": "Type of the Event for broader categorization. <br/><b>Example:</b> \"Service Updated\""}, "created_at": {"description": "Date and time when the event was created. <br/><b>Example:</b> \"2021-01-01T00:00:00Z\"", "format": "date-time", "title": "Created At", "type": "string"}, "content": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Html content of the message.", "title": "Content"}, "data": {"anyOf": [{"additionalProperties": true, "type": "object"}, {"type": "null"}], "description": "Data associated with the Event. Can be different shapes depending on event type. <br/><b>Example:</b> {\"new\": {\"detail\": {\"tax_code\": \"P2\"}}, \"old\": {\"detail\": {\"tax_code\": \"None\"}}}", "title": "Data"}}, "required": ["id", "title", "type", "created_at"], "title": "EventOutV1", "type": "object"}, "EventTypeChoices": {"enum": ["db", "call_note", "task_note", "plain_note", "user_note", "system_email", "system_file_transfer", "action_confirmed", "attention_needed", "order_cancelled", "order_cancel_requested", "order_restored", "service_created", "questionnaire_submitted", "installation_update", "install_status_update", "step_info_received", "step_out_for_quote", "step_quote_received", "added_to_cart", "step_contract_requested", "step_contract_received", "step_order_submitted", "step_pending_installation", "step_service_installed", "provider_completed_quote_request", "quote_request_sent_to_provider", "quote_request_failed", "quote_request_cancelled", "quote_refresh_requested", "quotes_expired", "quotes_refreshed", "invoice_updated", "invoice_payment_linked", "invoice_payment_unlinked", "salesperson_changed", "csm_changed", "implementation_specialist_changed", "quoperator_changed", "ticket_owner_changed", "user_deactivated", "service_update", "cancelled_date_updated", "arr_revenue_end_date_overridden", "contract_update", "contract_file_update", "attachment_file_update", "pm_changed", "service_removed", "service_reshopped", "service_moved", "service_onboarding_completed", "installation_survey", "cost_saving_recognized", "price_prediction", "estimate_default_changed", "team_user_assigned_auth_roles", "admin_user_assigned_auth_roles", "team_user_invited", "team_user_removed", "team_deleted", "team_details_updated", "project_name_updated", "service_group_archive_update", "service_enrollment_updated", "request_config_updated", "questionnaire_softblocker_limit_updated", "dispatch_tier_auto_upgraded", "agent_action", "agent_undo_action", "ly_assistant_action", "dispatch_action", "ticket_created", "ticket_returned_to_open", "ticket_closed", "ticket_cancelled", "ticket_pending_customer_response", "ticket_carrier_completion_scheduled", "ticket_type_changed", "macd_agent_assigned", "macd_agent_unassigned", "ofq_scenario_detected", "ofq_action_taken", "ofq_escalated", "ofq_skipped", "ofq_run_completed", "network_data_fetch_completed", "quote_automation_started", "tags_updated", "admin_tags_updated", "ip_allowlist_changed"], "title": "EventTypeChoices", "type": "string"}, "PagedEventOutV1": {"properties": {"items": {"items": {"$ref": "#/components/schemas/EventOutV1"}, "title": "Items", "type": "array"}, "total_items": {"examples": [1], "title": "Total Items", "type": "integer"}, "total_pages": {"examples": [1], "title": "Total Pages", "type": "integer"}, "page": {"examples": [1], "title": "Page", "type": "integer"}, "per_page": {"examples": [100], "title": "Per Page", "type": "integer"}}, "required": ["items", "total_items", "total_pages", "page", "per_page"], "title": "PagedEventOutV1", "type": "object"}, "TeamOutV1": {"properties": {"name": {"description": "Name of the team provided by the user. <br/><b>Example:</b> \"Acme Inc\"", "title": "Name", "type": "string"}, "default_billing_address": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Default billing address selected by the user for further procurement requests. <br/><b>Example:</b> \"123 Main St Unit B, Los Angeles, CA 90013, US\"", "title": "Default Billing Address"}, "default_billing_contact": {"anyOf": [{"$ref": "#/components/schemas/ContactDashboardOutV1"}, {"type": "null"}], "description": "Default billing contact selected by the user for further procurement requests."}, "custom_fields_settings": {"anyOf": [{"additionalProperties": true, "type": "object"}, {"type": "null"}], "description": "Fields configured by your team. See example for format. <br/><b>Example:</b> {\n    \"addresses\": {\n        \"shipping_address\": {\n            \"name\": \"shipping_address\",\n            \"input_type\": \"string\",\n            \"display_name\": \"Shipping Address\",\n        }\n    },\n    \"service_details\": {\n        \"all\": {\n            \"project_id\": {\n                \"name\": \"project_id\",\n                \"input_type\": \"string\",\n                \"display_name\": \"Project ID\",\n            },\n        },\n        \"internet\": {\n            \"router_id\": {\n                \"name\": \"router_id\",\n                \"input_type\": \"string\",\n                \"display_name\": \"Router ID\",\n            },\n        },\n    },\n}", "title": "Custom Fields Settings"}}, "required": ["name"], "title": "TeamOutV1", "type": "object"}, "PagedTeamUserOutV1": {"properties": {"items": {"items": {"$ref": "#/components/schemas/TeamUserOutV1"}, "title": "Items", "type": "array"}, "total_items": {"examples": [1], "title": "Total Items", "type": "integer"}, "total_pages": {"examples": [1], "title": "Total Pages", "type": "integer"}, "page": {"examples": [1], "title": "Page", "type": "integer"}, "per_page": {"examples": [100], "title": "Per Page", "type": "integer"}}, "required": ["items", "total_items", "total_pages", "page", "per_page"], "title": "PagedTeamUserOutV1", "type": "object"}, "TeamUserOutV1": {"properties": {"first_name": {"description": "First Name of the Team User. <br/><b>Example:</b> \"John\"", "title": "First Name", "type": "string"}, "last_name": {"description": "Last Name of the Team User. <br/><b>Example:</b> \"Smith\"", "title": "Last Name", "type": "string"}, "email": {"description": "Email of the Team User. <br/><b>Example:</b> \"john@example.com\"", "title": "Email", "type": "string"}, "phone": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Phone Number of the Team User. <br/><b>Example:</b> \"555-555-5555\"", "title": "Phone"}, "date_joined": {"description": "Date and time that the user joined the Team. <br/><b>Example:</b> \"2021-01-01T00:00:00Z\"", "format": "date-time", "title": "Date Joined", "type": "string"}}, "required": ["first_name", "last_name", "email", "date_joined"], "title": "TeamUserOutV1", "type": "object"}, "PagedContactDashboardOutV1": {"properties": {"items": {"items": {"$ref": "#/components/schemas/ContactDashboardOutV1"}, "title": "Items", "type": "array"}, "total_items": {"examples": [1], "title": "Total Items", "type": "integer"}, "total_pages": {"examples": [1], "title": "Total Pages", "type": "integer"}, "page": {"examples": [1], "title": "Page", "type": "integer"}, "per_page": {"examples": [100], "title": "Per Page", "type": "integer"}}, "required": ["items", "total_items", "total_pages", "page", "per_page"], "title": "PagedContactDashboardOutV1", "type": "object"}, "PagedTeamDocumentOutV1": {"properties": {"items": {"items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Items", "type": "array"}, "total_items": {"examples": [1], "title": "Total Items", "type": "integer"}, "total_pages": {"examples": [1], "title": "Total Pages", "type": "integer"}, "page": {"examples": [1], "title": "Page", "type": "integer"}, "per_page": {"examples": [100], "title": "Per Page", "type": "integer"}}, "required": ["items", "total_items", "total_pages", "page", "per_page"], "title": "PagedTeamDocumentOutV1", "type": "object"}, "PagedTicketOutV1": {"properties": {"items": {"items": {"$ref": "#/components/schemas/TicketOutV1"}, "title": "Items", "type": "array"}, "total_items": {"examples": [1], "title": "Total Items", "type": "integer"}, "total_pages": {"examples": [1], "title": "Total Pages", "type": "integer"}, "page": {"examples": [1], "title": "Page", "type": "integer"}, "per_page": {"examples": [100], "title": "Per Page", "type": "integer"}}, "required": ["items", "total_items", "total_pages", "page", "per_page"], "title": "PagedTicketOutV1", "type": "object"}, "TicketDocumentOutV1": {"properties": {"id": {"description": "ID of the Ticket Document.", "format": "uuid", "title": "Id", "type": "string"}, "name": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Name of the Ticket Document including the extension. <br/><b>Example:</b> \"my_file.pdf\"", "title": "Name"}, "file_url": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "URL to download the file. <br/><b>Example:</b> https://api.lightyear.ai/developer/tickets/0261abc1-afb6-4f78-9d8e-83f64a928bd8/documents/0261abc1-afb6-4f78-9d8e-83f64a928bd8/v1", "title": "File Url"}}, "required": ["id"], "title": "TicketDocumentOutV1", "type": "object"}, "TicketOutV1": {"properties": {"id": {"description": "ID of the Ticket.", "format": "uuid", "title": "Id", "type": "string"}, "description": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Description of the ticket. <br/><b>Example:</b> \"Confirm Building Owner Contact info\"", "title": "Description"}, "expected_resolution_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Expected date for the ticket to be resolved.", "title": "Expected Resolution Date"}, "status": {"$ref": "#/components/schemas/TicketStatusChoices", "description": "Current status of the ticket. <br/><b>Example:</b> \"OPEN\""}, "ticket_type": {"$ref": "#/components/schemas/TicketTypeChoices", "description": "Type of the ticket. <br/><b>Example:</b> \"DISCONNECT_SERVICE\""}, "attachments": {"description": "Attachments added to this respective message.", "items": {"$ref": "#/components/schemas/TicketDocumentOutV1"}, "title": "Attachments", "type": "array"}, "service": {"$ref": "#/components/schemas/ServiceOutV1", "description": "Service associated with the ticket."}, "updated_at": {"description": "Watermark for delta sync: the most recent time this ticket, its messages, or its attachments changed. Use with the `updated_since` filter on `GET /developer/tickets/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}}, "required": ["id", "status", "ticket_type", "attachments", "service", "updated_at"], "title": "TicketOutV1", "type": "object"}, "TicketStatusChoices": {"enum": ["OPEN", "CLOSED", "CANCELLED", "PENDING_CUSTOMER_RESPONSE", "CARRIER_COMPLETION_SCHEDULED"], "title": "TicketStatusChoices", "type": "string"}, "TicketTypeChoices": {"enum": ["BILLING_ISSUE", "MOVE_SERVICE", "CHANGE_SERVICE", "DISCONNECT_SERVICE", "SLA_CREDIT_REQUEST"], "title": "TicketTypeChoices", "type": "string"}, "TicketDetailOutV1": {"properties": {"id": {"description": "ID of the Ticket.", "format": "uuid", "title": "Id", "type": "string"}, "description": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Description of the ticket. <br/><b>Example:</b> \"Confirm Building Owner Contact info\"", "title": "Description"}, "expected_resolution_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Expected date for the ticket to be resolved.", "title": "Expected Resolution Date"}, "status": {"$ref": "#/components/schemas/TicketStatusChoices", "description": "Current status of the ticket. <br/><b>Example:</b> \"OPEN\""}, "ticket_type": {"$ref": "#/components/schemas/TicketTypeChoices", "description": "Type of the ticket. <br/><b>Example:</b> \"DISCONNECT_SERVICE\""}, "attachments": {"description": "Attachments added to this respective message.", "items": {"$ref": "#/components/schemas/TicketDocumentOutV1"}, "title": "Attachments", "type": "array"}, "service": {"$ref": "#/components/schemas/ServiceOutV1", "description": "Service associated with the ticket."}, "updated_at": {"description": "Watermark for delta sync: the most recent time this ticket, its messages, or its attachments changed. Use with the `updated_since` filter on `GET /developer/tickets/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "messages": {"description": "List of all messages made on this ticket.", "items": {"$ref": "#/components/schemas/TicketMessageOutV1"}, "title": "Messages", "type": "array"}}, "required": ["id", "status", "ticket_type", "attachments", "service", "updated_at", "messages"], "title": "TicketDetailOutV1", "type": "object"}, "TicketMessageOutV1": {"properties": {"id": {"description": "ID of the Ticket Message.", "format": "uuid", "title": "Id", "type": "string"}, "sent_at": {"description": "Date and time when the message was sent.", "format": "date-time", "title": "Sent At", "type": "string"}, "type": {"allOf": [{"$ref": "#/components/schemas/TicketMessageTypeChoices"}], "description": "Type of the message. <br/><b>Example:</b> \"OPENING_COMMENT\""}, "content": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Html content of message", "title": "Content"}, "attachments": {"description": "Attachments added to this respective message.", "items": {"$ref": "#/components/schemas/TicketDocumentOutV1"}, "title": "Attachments", "type": "array"}, "created_by": {"anyOf": [{"$ref": "#/components/schemas/AccountOutV1"}, {"type": "null"}], "description": "User who created the message. <br/><b>Example:</b> \"John Doe\""}}, "required": ["id", "sent_at", "attachments"], "title": "TicketMessageOutV1", "type": "object"}, "TicketMessageTypeChoices": {"enum": ["OPENING_COMMENT", "CLOSING_COMMENT", "CANCELLING_COMMENT", "PENDING_CUSTOMER_RESPONSE_COMMENT", "CARRIER_COMPLETION_SCHEDULED_COMMENT", "MESSAGE"], "title": "TicketMessageTypeChoices", "type": "string"}, "TicketInV1": {"properties": {"service_id": {"description": "ID of the service to create the ticket for.", "format": "uuid", "title": "Service Id", "type": "string"}, "ticket_type": {"$ref": "#/components/schemas/TicketTypeChoices", "description": "Type of the ticket. <br/><b>Example:</b> \"DISCONNECT_SERVICE\""}, "description": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Description of the ticket. <br/><b>Example:</b> \"Please disconnect this service at end of term.\"", "title": "Description"}, "expected_resolution_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Expected date for the ticket to be resolved. <br/><b>Example:</b> \"2025-06-01\"", "title": "Expected Resolution Date"}}, "required": ["service_id", "ticket_type"], "title": "TicketInV1", "type": "object"}, "PagedActionItemOutV1": {"properties": {"items": {"items": {"$ref": "#/components/schemas/ActionItemOutV1"}, "title": "Items", "type": "array"}, "total_items": {"examples": [1], "title": "Total Items", "type": "integer"}, "total_pages": {"examples": [1], "title": "Total Pages", "type": "integer"}, "page": {"examples": [1], "title": "Page", "type": "integer"}, "per_page": {"examples": [100], "title": "Per Page", "type": "integer"}}, "required": ["items", "total_items", "total_pages", "page", "per_page"], "title": "PagedActionItemOutV1", "type": "object"}, "ActionItemCommentOutV1": {"properties": {"id": {"description": "ID of the base Action Item.", "format": "uuid", "title": "Id", "type": "string"}, "created_at": {"description": "Date and time when the action item was created.", "format": "date-time", "title": "Created At", "type": "string"}, "created_by": {"$ref": "#/components/schemas/AccountOutV1", "description": "User who created the action item. <br/><b>Example:</b> \"John Doe\""}, "comment": {"description": "The text comment left by the user or Lightyear team member. <br/><b>Example:</b> \"Confirmed, we are good with that decision\"", "title": "Comment", "type": "string"}, "attachments": {"description": "Attachments added to this respective comment.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Attachments", "type": "array"}}, "required": ["id", "created_at", "created_by", "comment", "attachments"], "title": "ActionItemCommentOutV1", "type": "object"}, "ActionItemDetailOutV1": {"properties": {"id": {"description": "ID of the Action Item.", "format": "uuid", "title": "Id", "type": "string"}, "created_at": {"description": "Date and time when the action item was created.", "format": "date-time", "title": "Created At", "type": "string"}, "type": {"$ref": "#/components/schemas/ActionItemTypeChoices", "description": "Type of the action item suggesting the response type needed. <br/><b>Example:</b> \"Document Request\""}, "task": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Description of the requested action item. <br/><b>Example:</b> \"Confirm Building Owner Contact info\"", "title": "Task"}, "due_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Due date for completing the action item.", "title": "Due Date"}, "status": {"$ref": "#/components/schemas/ActionItemStatusChoices", "description": "Current status of the action item. <br/><b>Example:</b> \"Closed\""}, "completed_at": {"anyOf": [{"format": "date-time", "type": "string"}, {"type": "null"}], "description": "Date and time when the action item was marked as complete.", "title": "Completed At"}, "completed_by": {"anyOf": [{"$ref": "#/components/schemas/AccountOutV1"}, {"type": "null"}], "description": "User who completed the action item. <br/><b>Example:</b> \"John Doe\""}, "assignee": {"anyOf": [{"$ref": "#/components/schemas/AccountOutV1"}, {"type": "null"}], "description": "Assigned user responsible for completing the action item. <br/><b>Example:</b> \"John Doe\""}, "service_id": {"anyOf": [{"format": "uuid", "type": "string"}, {"type": "null"}], "description": "ID of associated service (if applicable). <br/><b>Example:</b> \"123e4567-e89b-12d3-a456-426614174000\"", "title": "Service Id"}, "attachments": {"description": "Attachments related to this action item.", "items": {"$ref": "#/components/schemas/TeamDocumentOutV1"}, "title": "Attachments", "type": "array"}, "updated_at": {"description": "Watermark for delta sync: the most recent time this action item, its comments, or its attachments changed. Use with the `updated_since` filter on `GET /developer/action-items/v1` and checkpoint from this value rather than your own clock. <br/><b>Example:</b> \"2026-08-19T15:30:00Z\"", "format": "date-time", "title": "Updated At", "type": "string"}, "comments": {"description": "List of all comments made on this action item.", "items": {"$ref": "#/components/schemas/ActionItemCommentOutV1"}, "title": "Comments", "type": "array"}}, "required": ["id", "created_at", "type", "status", "attachments", "updated_at", "comments"], "title": "ActionItemDetailOutV1", "type": "object"}, "InvoiceStatusChoices": {"enum": ["OPEN", "DRAFT", "CLOSED", "VOID", "PAYMENT_ISSUED", "SENT"], "title": "InvoiceStatusChoices", "type": "string"}, "ListInvoicesFiltersV1": {"properties": {"status": {"anyOf": [{"items": {"$ref": "#/components/schemas/InvoiceStatusChoices"}, "type": "array"}, {"type": "null"}], "description": "Filter by invoice status. Defaults to all visible statuses: ['OPEN', 'CLOSED', 'PAYMENT_ISSUED', 'SENT']", "title": "Status"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Filter by provider name (case-insensitive partial match). <br/><b>Example:</b> \"Lumen\"", "title": "Provider"}, "issue_date_from": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Filter invoices with issue date on or after this date. <br/><b>Example:</b> \"2024-01-01\"", "title": "Issue Date From"}, "issue_date_to": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Filter invoices with issue date on or before this date. <br/><b>Example:</b> \"2024-12-31\"", "title": "Issue Date To"}, "amount_min": {"anyOf": [{"minimum": 0.0, "type": "number"}, {"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Filter invoices with total amount greater than or equal to this value. <br/><b>Example:</b> 1000.00", "title": "Amount Min"}, "amount_max": {"anyOf": [{"minimum": 0.0, "type": "number"}, {"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Filter invoices with total amount less than or equal to this value. <br/><b>Example:</b> 5000.00", "title": "Amount Max"}}, "title": "ListInvoicesFiltersV1", "type": "object"}, "InvoiceOutV1": {"properties": {"id": {"description": "ID of the invoice.", "format": "uuid", "title": "Id", "type": "string"}, "lightyear_invoice_id": {"description": "Lightyear-assigned invoice ID. <br/><b>Example:</b> \"ABC12M5AB3\"", "title": "Lightyear Invoice Id", "type": "string"}, "provider_invoice_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Provider-assigned invoice number. <br/><b>Example:</b> \"684189329\"", "title": "Provider Invoice Id"}, "provider_billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Provider billing account number. <br/><b>Example:</b> \"5-1MRXSWMB\"", "title": "Provider Billing Account Number"}, "invoice_status": {"description": "Status of the invoice. Possible values: \"Open\", \"Closed - Paid\", \"Payment Issued\", \"Sent\". <br/><b>Example:</b> \"Open\"", "title": "Invoice Status", "type": "string"}, "issue_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Invoice issue date. <br/><b>Example:</b> \"2024-04-01\"", "title": "Issue Date"}, "due_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Invoice payment due date. <br/><b>Example:</b> \"2024-05-01\"", "title": "Due Date"}, "current_charges_currency_code": {"description": "Currency code for current charges. <br/><b>Example:</b> \"USD\"", "title": "Current Charges Currency Code", "type": "string"}, "current_charges_value": {"description": "Current charges amount. <br/><b>Example:</b> 3200.99", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Current Charges Value", "type": "string"}, "balance_currency_code": {"description": "Currency code for the balance. <br/><b>Example:</b> \"USD\"", "title": "Balance Currency Code", "type": "string"}, "balance_value": {"description": "Balance amount. <br/><b>Example:</b> 3200.99", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Balance Value", "type": "string"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Provider name. <br/><b>Example:</b> \"Lumen\"", "title": "Provider"}}, "required": ["id", "lightyear_invoice_id", "invoice_status", "current_charges_currency_code", "current_charges_value", "balance_currency_code", "balance_value"], "title": "InvoiceOutV1", "type": "object"}, "PagedInvoiceOutV1": {"properties": {"items": {"items": {"$ref": "#/components/schemas/InvoiceOutV1"}, "title": "Items", "type": "array"}, "total_items": {"examples": [1], "title": "Total Items", "type": "integer"}, "total_pages": {"examples": [1], "title": "Total Pages", "type": "integer"}, "page": {"examples": [1], "title": "Page", "type": "integer"}, "per_page": {"examples": [100], "title": "Per Page", "type": "integer"}}, "required": ["items", "total_items", "total_pages", "page", "per_page"], "title": "PagedInvoiceOutV1", "type": "object"}, "InvoiceDetailOutV1": {"properties": {"id": {"description": "ID of the invoice.", "format": "uuid", "title": "Id", "type": "string"}, "lightyear_invoice_id": {"description": "Lightyear-assigned invoice ID. <br/><b>Example:</b> \"ABC12M5AB3\"", "title": "Lightyear Invoice Id", "type": "string"}, "provider_invoice_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Provider-assigned invoice number. <br/><b>Example:</b> \"684189329\"", "title": "Provider Invoice Id"}, "provider_billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Provider billing account number. <br/><b>Example:</b> \"5-1MRXSWMB\"", "title": "Provider Billing Account Number"}, "invoice_status": {"description": "Status of the invoice. Possible values: \"Open\", \"Closed - Paid\", \"Payment Issued\", \"Sent\". <br/><b>Example:</b> \"Open\"", "title": "Invoice Status", "type": "string"}, "issue_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Invoice issue date. <br/><b>Example:</b> \"2024-04-01\"", "title": "Issue Date"}, "due_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Invoice payment due date. <br/><b>Example:</b> \"2024-05-01\"", "title": "Due Date"}, "current_charges_currency_code": {"description": "Currency code for current charges. <br/><b>Example:</b> \"USD\"", "title": "Current Charges Currency Code", "type": "string"}, "current_charges_value": {"description": "Current charges amount. <br/><b>Example:</b> 3200.99", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Current Charges Value", "type": "string"}, "balance_currency_code": {"description": "Currency code for the balance. <br/><b>Example:</b> \"USD\"", "title": "Balance Currency Code", "type": "string"}, "balance_value": {"description": "Balance amount. <br/><b>Example:</b> 3200.99", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Balance Value", "type": "string"}, "provider": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Provider name. <br/><b>Example:</b> \"Lumen\"", "title": "Provider"}, "invoice_line_items": {"description": "Individual line items extracted from the invoice.", "items": {"$ref": "#/components/schemas/InvoiceLineItemOutV1"}, "title": "Invoice Line Items", "type": "array"}, "invoice_service_charges": {"description": "Aggregated service charges per service on the invoice.", "items": {"$ref": "#/components/schemas/InvoiceServiceChargeOutV1"}, "title": "Invoice Service Charges", "type": "array"}}, "required": ["id", "lightyear_invoice_id", "invoice_status", "current_charges_currency_code", "current_charges_value", "balance_currency_code", "balance_value"], "title": "InvoiceDetailOutV1", "type": "object"}, "InvoiceLineItemOutV1": {"properties": {"id": {"description": "ID of the line item.", "format": "uuid", "title": "Id", "type": "string"}, "description": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Description of the line item charge. <br/><b>Example:</b> \"IP Logical Flat Rate=100Mbps Amount\"", "title": "Description"}, "category": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Category of the line item. <br/><b>Example:</b> \"Service Charge\"", "title": "Category"}, "service_type": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type"}, "service_description": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Description of the associated service. <br/><b>Example:</b> \"100 Mbps/100 Mbps Dedicated circuit\"", "title": "Service Description"}, "circuit_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Provider circuit/service ID. Omitted when not available. <br/><b>Example:</b> \"444453853\"", "title": "Circuit Id"}, "location_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Name of the service location(s). <br/><b>Example:</b> \"Demo Site\"", "title": "Location Name"}, "location_address": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Full address of the service location(s). <br/><b>Example:</b> \"4130 N 5TH STREET, NORTH LAS VEGAS, NV\"", "title": "Location Address"}, "custom_fields": {"description": "Custom fields configured by your team for the associated service.", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "currency_code": {"description": "Three-letter currency code. <br/><b>Example:</b> \"USD\"", "title": "Currency Code", "type": "string"}, "amount": {"description": "Line item charge amount. <br/><b>Example:</b> 460.63", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Amount", "type": "string"}}, "required": ["id", "currency_code", "amount"], "title": "InvoiceLineItemOutV1", "type": "object"}, "InvoiceServiceChargeOutV1": {"properties": {"id": {"description": "ID of the service charge.", "format": "uuid", "title": "Id", "type": "string"}, "service_type": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Type of service, as a stable key that stays the same when the platform renames a service type. In the platform, `wan_point_to_point` is \"Ethernet P2P\", `wan_wavelength` is \"Wavelength P2P\", `wan_dark_fiber` is \"Dark Fiber P2P\". <br/><b>Example:</b> \"internet\"", "title": "Service Type"}, "service_description": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Description of the service. <br/><b>Example:</b> \"100 Mbps/100 Mbps Dedicated circuit\"", "title": "Service Description"}, "circuit_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Provider circuit/service ID. Omitted when not available. <br/><b>Example:</b> \"444453853\"", "title": "Circuit Id"}, "location_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Name of the service location(s). <br/><b>Example:</b> \"Demo Site\"", "title": "Location Name"}, "location_address": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Full address of the service location(s). <br/><b>Example:</b> \"308 8th Ave, New York, NY 10001, US\"", "title": "Location Address"}, "custom_fields": {"description": "Custom fields configured by your team for the associated service.", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "currency_code": {"description": "Three-letter currency code. <br/><b>Example:</b> \"USD\"", "title": "Currency Code", "type": "string"}, "amount": {"description": "Total charge amount for this service. <br/><b>Example:</b> 1490.67", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Amount", "type": "string"}}, "required": ["id", "currency_code", "amount"], "title": "InvoiceServiceChargeOutV1", "type": "object"}, "ConsolidatedInvoiceStatusChoices": {"enum": ["DRAFT", "OPEN", "PAID", "VOID"], "title": "ConsolidatedInvoiceStatusChoices", "type": "string"}, "ListConsolidatedBillsFiltersV1": {"properties": {"status": {"anyOf": [{"items": {"$ref": "#/components/schemas/ConsolidatedInvoiceStatusChoices"}, "type": "array"}, {"type": "null"}], "description": "Filter by consolidated bill status. Defaults to all visible statuses: ['OPEN', 'PAID']", "title": "Status"}, "due_date_from": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Filter bills with due date on or after this date. <br/><b>Example:</b> \"2025-01-01\"", "title": "Due Date From"}, "due_date_to": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Filter bills with due date on or before this date. <br/><b>Example:</b> \"2025-12-31\"", "title": "Due Date To"}, "amount_min": {"anyOf": [{"minimum": 0.0, "type": "number"}, {"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Filter bills with total amount greater than or equal to this value. <br/><b>Example:</b> 1000.00", "title": "Amount Min"}, "amount_max": {"anyOf": [{"minimum": 0.0, "type": "number"}, {"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string"}, {"type": "null"}], "description": "Filter bills with total amount less than or equal to this value. <br/><b>Example:</b> 100000.00", "title": "Amount Max"}}, "title": "ListConsolidatedBillsFiltersV1", "type": "object"}, "ConsolidatedBillOutV1": {"properties": {"id": {"description": "ID of the consolidated bill.", "format": "uuid", "title": "Id", "type": "string"}, "consolidated_bill_id": {"description": "Lightyear-assigned consolidated bill ID. <br/><b>Example:</b> \"CI5PHM5AB3\"", "title": "Consolidated Bill Id", "type": "string"}, "issue_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the consolidated bill was sent to the customer. <br/><b>Example:</b> \"2025-07-05\"", "title": "Issue Date"}, "due_date": {"description": "Payment due date. <br/><b>Example:</b> \"2025-07-19\"", "format": "date", "title": "Due Date", "type": "string"}, "status": {"description": "Status of the consolidated bill. Possible values: \"Open\", \"Paid\". <br/><b>Example:</b> \"Open\"", "title": "Status", "type": "string"}, "total_due_currency_code": {"description": "Currency code for the total due amount. <br/><b>Example:</b> \"USD\"", "title": "Total Due Currency Code", "type": "string"}, "total_due_value": {"description": "Total amount due. <br/><b>Example:</b> 75078.96", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Total Due Value", "type": "string"}}, "required": ["id", "consolidated_bill_id", "due_date", "status", "total_due_currency_code", "total_due_value"], "title": "ConsolidatedBillOutV1", "type": "object"}, "PagedConsolidatedBillOutV1": {"properties": {"items": {"items": {"$ref": "#/components/schemas/ConsolidatedBillOutV1"}, "title": "Items", "type": "array"}, "total_items": {"examples": [1], "title": "Total Items", "type": "integer"}, "total_pages": {"examples": [1], "title": "Total Pages", "type": "integer"}, "page": {"examples": [1], "title": "Page", "type": "integer"}, "per_page": {"examples": [100], "title": "Per Page", "type": "integer"}}, "required": ["items", "total_items", "total_pages", "page", "per_page"], "title": "PagedConsolidatedBillOutV1", "type": "object"}, "ConsolidatedBillDetailOutV1": {"properties": {"id": {"description": "ID of the consolidated bill.", "format": "uuid", "title": "Id", "type": "string"}, "consolidated_bill_id": {"description": "Lightyear-assigned consolidated bill ID. <br/><b>Example:</b> \"CI5PHM5AB3\"", "title": "Consolidated Bill Id", "type": "string"}, "issue_date": {"anyOf": [{"format": "date", "type": "string"}, {"type": "null"}], "description": "Date the consolidated bill was sent to the customer. <br/><b>Example:</b> \"2025-07-05\"", "title": "Issue Date"}, "due_date": {"description": "Payment due date. <br/><b>Example:</b> \"2025-07-19\"", "format": "date", "title": "Due Date", "type": "string"}, "status": {"description": "Status of the consolidated bill. Possible values: \"Open\", \"Paid\". <br/><b>Example:</b> \"Open\"", "title": "Status", "type": "string"}, "total_due_currency_code": {"description": "Currency code for the total due amount. <br/><b>Example:</b> \"USD\"", "title": "Total Due Currency Code", "type": "string"}, "total_due_value": {"description": "Total amount due. <br/><b>Example:</b> 75078.96", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Total Due Value", "type": "string"}, "consolidated_bill_line_items": {"description": "Line items included in this consolidated bill.", "items": {"$ref": "#/components/schemas/ConsolidatedBillLineItemOutV1"}, "title": "Consolidated Bill Line Items", "type": "array"}}, "required": ["id", "consolidated_bill_id", "due_date", "status", "total_due_currency_code", "total_due_value"], "title": "ConsolidatedBillDetailOutV1", "type": "object"}, "ConsolidatedBillLineItemOutV1": {"properties": {"id": {"description": "ID of the consolidated bill line item.", "format": "uuid", "title": "Id", "type": "string"}, "provider": {"description": "Provider name for this line item. <br/><b>Example:</b> \"Lumen\"", "title": "Provider", "type": "string"}, "service_type": {"description": "Display name of the service type as recorded when the line item was created, so older line items can carry an earlier name, such as \"WAN: Dark Fiber\" for what is now \"Dark Fiber P2P\". <br/><b>Example:</b> \"Internet\"", "title": "Service Type", "type": "string"}, "service_description": {"description": "Description of the service. <br/><b>Example:</b> \"500 Mbps/500 Mbps Dedicated circuit\"", "title": "Service Description", "type": "string"}, "billing_account_number": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Billing Account Number (BAN) associated with this line item. <br/><b>Example:</b> \"5KYC8788\"", "title": "Billing Account Number"}, "location_name": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Name of the service location(s). <br/><b>Example:</b> \"Demo Site\"", "title": "Location Name"}, "location_address": {"anyOf": [{"type": "string"}, {"type": "null"}], "description": "Full address of the service location(s). <br/><b>Example:</b> \"308 8th Ave, New York, NY 10001, US\"", "title": "Location Address"}, "custom_fields": {"description": "Custom fields configured by your team for this line item.", "items": {"$ref": "#/components/schemas/CustomFieldOutV1"}, "title": "Custom Fields", "type": "array"}, "currency_code": {"description": "Three-letter currency code. <br/><b>Example:</b> \"USD\"", "title": "Currency Code", "type": "string"}, "amount": {"description": "Charge amount for this line item. <br/><b>Example:</b> 568.89", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Amount", "type": "string"}}, "required": ["id", "provider", "service_type", "service_description", "currency_code", "amount"], "title": "ConsolidatedBillLineItemOutV1", "type": "object"}}, "securitySchemes": {"LightyearOAuthBearerAuth": {"type": "http", "scheme": "bearer", "description": "OAuth2 client credentials bearer token, minted at POST /developer/oauth/token. See the Authentication section for details."}, "LightyearHMACAuth": {"type": "http", "scheme": "LY-HMAC", "description": "LY-HMAC signed requests. See the Authentication section for signing details."}}}, "servers": [], "tags": [{"name": "OAuth", "description": "Exchange OAuth 2.0 client credentials for short-lived bearer tokens. See the Authentication section for details."}, {"name": "Team", "description": "Discover team info and general application preferences in our Teams API section. Utilize these end points to help retrieve all of your teams users, contacts, and team related documents."}, {"name": "Contracts", "description": "Discover contract info, associated services, and file downloads in our Contracts API section. Utilize these end points to help retrieving all of your contracts or viewing details such as term, renewal information, or related service insights."}, {"name": "Services", "description": "Discover service info, associated locations, contracts, and file downloads in our Services API section. Utilize these end points to help retrieve all of your services, both in progress and already installed. Dive deeper into detailed service views, action items, and service related documents."}, {"name": "Locations", "description": "Discover all your service addresses, location info, and associated services in our Locations API section."}, {"name": "Tickets", "description": "Discover tickets and dive into their details in our Tickets API section. Utilize these end points to help retrieve all of your tickets, their messages, and related documents."}, {"name": "Action Items", "description": "Action Items related endpoints"}, {"name": "Invoices", "description": "Access provider invoice data including line items and aggregated service charges. Use these endpoints to retrieve invoices for your team, filter by provider, status, or date range, and drill into individual invoice details."}, {"name": "Consolidated Bills", "description": "Access Lightyear consolidated bills, which aggregate charges across all provider invoices for a billing period. Use these endpoints to retrieve bills for your team, filter by status or date range, and view line item breakdowns."}]}