> ## Documentation Index > Fetch the complete documentation index at: https://docs.joinluminous.com/llms.txt > Use this file to discover all available pages before exploring further. # Price Schedule > Get detailed information for a specific price schedule ## OpenAPI ````yaml /api-reference/build.yaml get /price-schedules/{scheduleId} openapi: 3.0.0 info: title: Luminous API version: 1.0.0 description: API documentation for Luminous servers: - url: https://{companyName}.api.joinluminous.com/external/api/v1 variables: companyName: default: companyName description: Your company-specific subdomain security: [] tags: - name: Products description: Get and manage products - name: Pricing description: Manage price schedules, levels, and customizations - name: BOMs description: Manage Bills of Materials (BOMs) - name: Labels description: Label rendering via Labelary ZPL service - name: Companies description: Manage business accounts and their associated data - name: Contacts description: Manage contact information for individuals - name: Suppliers description: Manage suppliers (factories) — vendors used on purchase orders - name: Supplier SKUs description: Manage per-supplier SKU and unit-cost overrides for products - name: Locations description: Manage warehouses and locations - name: Inventory description: Get and adjust product stock levels - name: Lots description: Create, update, and delete product lots (batches) - name: Transfer Orders description: Manage transfer orders - name: Fulfillment Orders description: Manage fulfillment orders and picklists - name: Purchase Orders description: Get and modify purchase orders - name: Receiving Reports description: Manage receiving reports - name: Payment Obligations description: Manage payment obligations for purchase orders - name: Sales Orders description: Manage sales orders and sales order shipments - name: Purgatory description: >- Inspect and resolve non-posted sales orders in the purgatory staging workflow - name: PickFlow Shipping description: >- Provider-agnostic shipping rates, services, packages, and label purchase for PickFlow - name: Cycle Counts description: >- Create, drive, and post PickFlow cycle counts — batches, per-warehouse sessions, and CSV import/export - name: Print Stations description: List paired print stations and enqueue print jobs to them - name: Invoices description: Get and manage invoices - name: Work Orders description: >- Manage work orders — production lifecycle, steps, materials, links, shipments, and comments - name: Production Batches description: Group and manage work orders as production batches - name: Bills description: >- Accounts payable bill management, payments, attachments, allocations, and variance - name: Prepayments description: Manage vendor prepayments and applications - name: Vendor Credits description: Manage vendor credits and applications - name: Vendor Returns description: Manage vendor returns and credit generation - name: Customer Returns description: Manage customer returns (sales returns), receiving, and restock behavior - name: Stock Snapshot description: Point-in-time stock snapshots with export support - name: Consumption description: Consumption reports and exports - name: Inventory Aging description: Cost-layer-based inventory aging reports - name: Bills Reports description: Accounts payable bills aging reports - name: Forecast description: Materialized forecast data - name: Reports description: Close the books, inventory discrepancy, transaction COGS, and EDI reports - name: Tags description: Add/remove tags across various resources - name: Custom Fields description: Get and set custom fields across various resources - name: Currency description: Currency configuration, exchange rates, and conversion - name: Integration Mappings description: Manage integration mappings for external systems - name: Integration Field Mappings description: Manage field-level mappings between Luminous and external systems paths: /price-schedules/{scheduleId}: get: tags: - Pricing summary: Price Schedule description: Get detailed information for a specific price schedule operationId: getPriceSchedule parameters: - name: scheduleId in: path required: true schema: type: string description: The unique identifier of the price schedule responses: '200': description: Price schedule details content: application/json: schema: type: object properties: id: type: number description: Unique identifier for the price schedule example: 123 name: type: string description: Name of the price schedule example: Holiday Sale 2023 description: type: string description: Detailed description of the price schedule example: Special pricing for holiday season status: type: string description: Status of the price schedule enum: - active - inactive example: active start_date: type: string format: date description: When the price schedule becomes active example: '2023-11-01' end_date: type: string format: date description: When the price schedule expires example: '2023-12-31' priority: type: integer description: >- Priority of this price schedule (higher numbers take precedence) example: 100 price_levels: type: array description: List of price levels this schedule applies to items: type: object properties: id: type: string example: '789' name: type: string example: Wholesale companies: type: array description: >- List of companies this schedule applies to (if specific to companies) items: type: object properties: id: type: string example: '123456' name: type: string example: Acme Corporation created_at: type: string format: date-time description: When the price schedule was created example: '2023-03-15T14:30:00Z' updated_at: type: string format: date-time description: When the price schedule was last updated example: '2023-03-15T14:30:00Z' counting_algorithm: type: string description: Algorithm used for counting items for price determination example: each_item modification_type: type: string description: Type of price modification applied example: amount_off global: type: boolean description: Whether this price schedule applies globally example: true tiers: type: array description: List of price schedule tiers items: type: object properties: id: type: number description: Unique identifier for the price schedule tier example: 123 created_at: type: string format: date-time description: When the price schedule tier was created example: '2023-03-15T14:30:00Z' updated_at: type: string format: date-time description: When the price schedule tier was last updated example: '2023-03-15T14:30:00Z' status: type: string description: Status of the price schedule tier enum: - active - inactive example: active price_schedule_id: type: string description: ID of the parent price schedule example: '456789' quantity: type: number format: float description: Quantity threshold for this pricing tier example: 10 discount_amount: type: number format: float description: Amount of discount applied at this tier example: 5.99 '401': description: Authentication credentials were missing or invalid content: application/json: schema: type: object properties: error: type: string example: Unauthorized message: type: string example: Authentication credentials are missing or invalid status_code: type: integer example: 401 '403': description: You do not have permission to perform this action content: application/json: schema: type: object properties: error: type: string example: Forbidden message: type: string example: You do not have permission to access this resource status_code: type: integer example: 403 '404': description: The requested resource was not found content: application/json: schema: type: object properties: error: type: string example: Not Found message: type: string example: The requested resource could not be found status_code: type: integer example: 404 security: - BearerAuth: [] components: securitySchemes: BearerAuth: type: http scheme: bearer description: >- Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token. ````