Pricing

Update Design Pricing

Changed on

Update pricing for an existing design.

put/tenants/{tenant_id}/designs/{id}/pricing

Request

  • Base URL
    https://api-sandbox.aurorasolar.com
  • URL
    https://api-sandbox.aurorasolar.com/tenants/{tenant_id}/designs/{id}/pricing
  • Auth
    HTTP bearer

Path parameters

tenant_idstring uuid required

The ID of the tenant that the design is part of.

idstring uuid required

The ID of the design to update pricing details for.

Request body

Example request

{
  "pricing": {
    "flat_system_price": 40000,
    "price_per_watt": 1.99,
    "line_items": [
      {
        "component_id": "8f3c1a20-6b4d-4e7a-9c15-2d8e0f4a6b31",
        "price": 350
      }
    ],
    "storage_flat_system_price": 8000,
    "storage_line_items": [
      {
        "component_id": "1a9e7c54-3d2b-4f68-a071-5e6c8b9d0f24",
        "price": 8000
      }
    ],
    "heat_pump_flat_system_price": 6000,
    "heat_pump_line_items": [
      {
        "component_id": "4c2b8e17-9a60-4d35-b8f2-1e7c0a9d5b46",
        "price": 4500
      }
    ]
  }
}

Response

Design Pricing successfully updated.

Example response

{
  "pricing": {
    "flat_system_price": 5000,
    "price_per_watt": 4.3,
    "storage_flat_system_price": 8000,
    "heat_pump_flat_system_price": 8000,
    "pricing_by_component": [
      {
        "name": "Aurora Sample Solar Panel",
        "manufacturer_name": "Aurora Sample Manufacturer",
        "component_id": "8f3c1a20-6b4d-4e7a-9c15-2d8e0f4a6b31",
        "price": 196.35,
        "quantity": 11,
        "component_type": "modules"
      }
    ],
    "incentives": [
      {
        "name": "Solar PV Energy Tax Credit - Personal",
        "incentive_type": "cbi",
        "amount": 25,
        "disbursement": "tax_credit_rebate",
        "duration": 10,
        "cap": 35000,
        "incentive_scope": "local",
        "system_size_basis": "stc"
      }
    ],
    "adders": [
      {
        "id": "6ffee90f-116f-470e-9593-8067b2ded44e",
        "adder_name": "Steep roof surcharge",
        "adder_type": "flat",
        "adder_value": 1000,
        "percentage_basis": null,
        "is_hidden": false,
        "additional_charges": [
          {
            "name": "Processing Fee",
            "percentage": 2.5
          },
          {
            "name": "Service Fee",
            "percentage": 1
          }
        ]
      }
    ],
    "system_price_breakdown": [
      {
        "item_type": "base_price",
        "item_price": 72240,
        "cumulative_price": 73240,
        "subcomponents": [
          {
            "item_price": 1000,
            "quantity": 10,
            "adder_name": "Steep roof surcharge",
            "adder_total": 1000,
            "additional_charges_total": 35,
            "total_with_additional_charges": 1035,
            "additional_charges": [
              {
                "name": "Processing Fee",
                "percentage": 2.5,
                "amount": 25
              }
            ]
          }
        ]
      }
    ],
    "storage_system_price_breakdown": [
      {
        "item_type": "base_price",
        "item_price": 7500,
        "cumulative_price": 7750,
        "subcomponents": [
          {
            "item_price": 1000,
            "quantity": 10,
            "adder_name": "Steep roof surcharge",
            "adder_total": 1000,
            "additional_charges_total": 35,
            "total_with_additional_charges": 1035,
            "additional_charges": [
              {
                "name": "Processing Fee",
                "percentage": 2.5,
                "amount": 25
              }
            ]
          }
        ]
      }
    ],
    "heat_pump_system_price_breakdown": [
      {
        "item_type": "base_price",
        "item_price": 8000,
        "cumulative_price": 8000,
        "subcomponents": [
          {
            "item_price": 1000,
            "quantity": 10
          }
        ]
      }
    ],
    "energy_optimization_price_breakdown": [
      {
        "item_type": "base_price",
        "item_price": 7500,
        "cumulative_price": 7750,
        "subcomponents": [
          {
            "item_price": 1000,
            "quantity": 10,
            "adder_name": "Steep roof surcharge",
            "adder_total": 1000,
            "additional_charges_total": 35,
            "total_with_additional_charges": 1035,
            "additional_charges": [
              {
                "name": "Processing Fee",
                "percentage": 2.5,
                "amount": 25
              }
            ]
          }
        ]
      }
    ],
    "net_system_cost_price_breakdown": [
      {
        "item_type": "adders",
        "item_price": 1000,
        "cumulative_price": 11000,
        "subcomponents": [
          {
            "item_price": 1000,
            "quantity": 10000,
            "adder_name": "Insurance rider",
            "adder_total": 1000
          }
        ]
      }
    ],
    "system_price": 79740
  }
}

Changes

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added subschema #1 subschema #2 to the // response property allOf list for the response status

    • info

      removed subschema #1 subschema #2 from the // response property allOf list for the response status