Get Available Billing Options for a Proposal

Time	Status	User Agent
Retrieving recent requests…

Overview

Returns the available billing options for a proposal, including payment frequency, payment schedules, and totals. Each option represents a different billing plan (e.g., annual, semi-annual, quarterly, monthly) with a breakdown of individual invoice dates and amounts. Use this to present billing choices to the customer before binding a quote.

Preconditions

The proposal should be rated before calling this endpoint so that premium amounts are available.

Examples

Scenario 1: Retrieve billing options:

GET /api/Quotes/Proposals/12345/BillingOptions

200 OK
[
  {
    "BillingFrequencyCode": "A",
    "Name": "Annual",
    "NumberOfPayments": 1,
    "TotalPayment": 5250.00,
    "InstallmentFeesTotal": null,
    "SecurityDepositAmount": null,
    "Schedule": [
      {
        "IsDownPayment": false,
        "TransactionDate": "2026-06-01T00:00:00",
        "PeriodStart": "2026-06-01T00:00:00",
        "PeriodEnd": "2027-05-31T00:00:00",
        "DueDate": "2026-06-01T00:00:00",
        "BilledAmount": 5250.00
      }
    ]
  },
  {
    "BillingFrequencyCode": "Q",
    "Name": "Quarterly",
    "NumberOfPayments": 4,
    "TotalPayment": 5350.00,
    "InstallmentFeesTotal": 100.00,
    "SecurityDepositAmount": 1312.50,
    "Schedule": [
      {
        "IsDownPayment": true,
        "TransactionDate": "2026-06-01T00:00:00",
        "DueDate": "2026-06-01T00:00:00",
        "BilledAmount": 1312.50
      },
      {
        "IsDownPayment": false,
        "TransactionDate": "2026-09-01T00:00:00",
        "DueDate": "2026-09-01T00:00:00",
        "BilledAmount": 1345.83
      }
    ]
  }
]

Scenario 2: Override the first invoice date:

GET /api/Quotes/Proposals/12345/BillingOptions?firstInvoiceDate=2026-07-01

200 OK
[
  {
    "BillingFrequencyCode": "A",
    "Name": "Annual",
    "NumberOfPayments": 1,
    "TotalPayment": 5250.00,
    "Schedule": [
      {
        "IsDownPayment": false,
        "TransactionDate": "2026-07-01T00:00:00",
        "DueDate": "2026-07-01T00:00:00",
        "BilledAmount": 5250.00
      }
    ]
  }
]

Notes

The BillingFrequencyCode from the response is used as the billingFrequencyCode parameter when calling POST /api/Quotes/Proposals/{proposalId}/BindQuote.
If the proposal has not been rated, the amounts in the billing options may be zero or inaccurate.