---
title: "Preview Payment Schedule"
method: POST
path: "/quotes/payment-schedule"
tags: ["Quotes"]
---

# Preview Payment Schedule

`POST /quotes/payment-schedule`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/quotes/payment-schedule`
- Auth: HTTP bearer

What a set of line items would bill, and when. Arithmetic over the body.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- PaymentSchedulePreviewRequest: Compute the payment schedule a set of line items WOULD produce. Reads nothing and writes nothing - it is arithmetic over the body, which is why it is POST but tiered `read`.
  - `line_items` QuoteLineItem[], required
    - `product_name` string, required
    - `unit_amount` integer, required: CENTS, not dollars.
    - `stripe_product_id` string, nullable
    - `stripe_price_id` string, nullable
    - `manual_product_id` string, nullable
    - `description` string, nullable
    - `quantity` integer
    - `discount_pct` number
    - `billing_frequency` string, nullable
    - `start_month` integer
    - `billing_start_date` string, nullable
    - `sort_order` integer
  - `contract_start_date` string, required: ISO date the contract starts.
  - `contract_end_date` string, nullable
  - `contract_months` number, nullable
  - `contract_duration_value` number, nullable
  - `contract_duration_unit` 'months' | 'weeks' | 'days', nullable
  - `tax_amount` integer

## Response `200`

Successful Response

- ApiResponseQuotePayload
  - `data` QuotePayload, required: An open envelope for a quote, template, contact or job result.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)