Sign in

v1

latestOpenAPI 3.0.02026-07-2475182625.5 KB
Quotes

Create a quote

Creates a new quote with an open status.

post/quotes

Request body

namestring required

The name or label associated with the quote.

couponstring nullable

Coupon code applied to the quote, if any.

currencystring

Currency code used in the quote.

expirationDateDaysinteger

Number of days until the quote expires.

fulfillmentTerm'ON_PAYMENT' | 'ON_QUOTE_ACCEPTANCE'

Defines when the quote is fulfilled (e.g., ON_PAYMENT).

notesstring

Additional notes for the quote.

netTermsDaysinteger

Number of days for net payment terms.

taxIdstring nullable

Tax ID associated with the quote, if any.

sourcestring

Source from which the quote was generated (e.g., MANAGER).

sourceIPstring

IP address from which the quote was created or updated.

Example request

{
  "items": [
    {
      "product": "add-on-subscription",
      "quantity": 2,
      "unitListPrice": 10,
      "attributes": {
        "licenseType": "pro",
        "seats": "5"
      }
    }
  ],
  "name": "Name of the quote",
  "recipient": {
    "company": "Example Company",
    "email": "jane.doe@example.com",
    "first": "Jane",
    "last": "Doe",
    "phone": "5555551234"
  },
  "recipientAddress": {
    "addressLine1": "123 Main Street",
    "addressLine2": "Suite 101",
    "city": "Example City",
    "country": "US",
    "postalCode": "12345",
    "region": "Example Region"
  },
  "coupon": "TENOFF",
  "currency": "USD",
  "expirationDateDays": 30,
  "fulfillmentTerm": "ON_PAYMENT",
  "notes": "This is a Note",
  "tags": [
    {
      "key": "tag-key",
      "value": "Tag Value"
    }
  ],
  "taxId": "BE09999999XX",
  "source": "MANAGER",
  "sourceIP": "198.51.100.45"
}

Response

OK

idstring

Unique identifier for the quote.

buyerGeneratedboolean

Indicates if the quote was created by the buyer.

copyNotesToInvoiceboolean

Determines whether notes should be copied to the invoice.

couponstring nullable

Coupon code applied to the quote, if any.

createdstring date-time

Timestamp when the quote was created.

currencystring

Currency code used in the quote.

discountnumber

Discount amount in base currency.

discountDisplaystring

Formatted display of the discount in base currency.

discountInPayoutCurrencynumber

Discount amount in the payout currency.

discountInPayoutCurrencyDisplaystring

Formatted display of the discount in the payout currency.

expiresstring date-time

Timestamp when the quote expires.

expirationDateDaysinteger

Number of days until the quote expires.

fulfillmentTerm'ON_PAYMENT' | 'ON_QUOTE_ACCEPTANCE'

Defines when the quote is fulfilled (e.g., ON_PAYMENT).

namestring

Name or label for the quote.

notesstring nullable

Additional notes for the quote.

netTermsDaysinteger

Number of days for net payment terms.

quoteUrlstring

URL to view or manage the quote.

siteIdstring

Identifier of the site associated with this quote.

status'OPEN' | 'CANCELED' | 'AWAITING_PAYMENT' | 'COMPLETED' | 'EXPIRED'

Current status of the quote.

subtotalnumber

Subtotal in base currency before discounts and tax.

subtotalDisplaystring

Formatted display of the subtotal.

subtotalInPayoutCurrencynumber

Subtotal in the payout currency.

subtotalInPayoutCurrencyDisplaystring

Formatted display of the subtotal in the payout currency.

taxnumber

Total tax amount in base currency.

taxRatenumber

Tax rate applied, if any.

taxTypestring

Type of tax applied (e.g., TAX, VAT).

totalnumber

Final total in base currency, after discounts/tax.

totalDisplaystring

Formatted display of the total amount.

totalInPayoutCurrencynumber

Total in the payout currency.

totalInPayoutCurrencyDisplaystring

Formatted display of the total in payout currency.

updatedstring date-time

Timestamp when the quote was last updated.

taxIdstring nullable

Tax ID associated with the quote, if any.

sourcestring

Source from which the quote was generated (e.g., MANAGER).

sourceIPstring nullable

IP address from which the quote was created or updated.

orderReferencestring nullable

Reference to an associated order, if any.

isGrossTaxboolean

Indicates whether the quote uses gross tax.

invoiceIdstring nullable

Invoice ID associated with this quote, if any.

Example response

{
  "id": "AB1CD23EFG45H6IJKLMNOPQ78R9S",
  "coupon": "TENOFF",
  "created": "2026-09-09T14:51:34.814+00:00",
  "createdBy": {
    "company": "Example Company",
    "email": "jane.doe@example.com",
    "first": "Jane",
    "last": "Doe",
    "phone": "5555551234",
    "userId": "abCDEFGHijkLmNOpQr_S"
  },
  "currency": "USD",
  "discount": 40,
  "discountDisplay": "$40.00",
  "discountInPayoutCurrency": 40,
  "discountInPayoutCurrencyDisplay": "$40.00",
  "expires": "2026-10-09T14:51:34.814+00:00",
  "expirationDateDays": 30,
  "fulfillmentTerm": "ON_PAYMENT",
  "items": [
    {
      "product": "add-on-subscription",
      "attributes": {
        "licenseType": "pro",
        "seats": "5"
      },
      "display": "Add-on Subscription",
      "period": "Monthly",
      "quantity": 2,
      "renewIntoProducts": [
        {
          "renewIntoProductId": "DG4UH337PVYDC33XEP3ZH3JHD",
          "renewIntoPath": "video-subscription",
          "renewIntoPrice": 9.99,
          "renewIntoPeriod": "Weekly",
          "renewIntoLevel": 1,
          "renewIntoIntervalCount": "2",
          "renewIntoUpcomingProduct": "audio-subscription"
        }
      ],
      "taxes": [
        {
          "totalTaxable": 360
        }
      ],
      "subscription": true,
      "unitCouponDiscountDisplay": "$0.00",
      "unitCouponDiscountInPayoutCurrencyDisplay": "$0.00",
      "unitDiscount": 20,
      "unitDiscountWithoutTax": 20,
      "unitDiscountDisplay": "$20.00",
      "unitDiscountInPayoutCurrency": 20,
      "unitDiscountInPayoutCurrencyDisplay": "$20.00",
      "unitListPrice": 200,
      "unitListPriceDisplay": "$200.00",
      "unitListPriceInPayoutCurrency": 200,
      "unitListPriceInPayoutCurrencyDisplay": "$200.00",
      "unitPrice": 180,
      "unitPriceDisplay": "$180.00",
      "unitPriceInPayoutCurrency": 180,
      "unitPriceInPayoutCurrencyDisplay": "$180.00",
      "unitPriceWithoutTax": 180,
      "unitPriceWithoutTaxDisplay": "$180.00",
      "unitListPriceWithoutTax": 200,
      "unitListPriceWithoutTaxDisplay": "$200.00",
      "taxMode": "NET",
      "priceDetail": {
        "path": "add-on-subscription",
        "quantity": 2,
        "plans": [
          {
            "path": "add-on-subscription",
            "interval": "month",
            "intervalLength": 1,
            "prices": [
              {
                "path": "add-on-subscription",
                "showUnitListPrice": 200,
                "showUnitNetPrice": 180,
                "showExtendedNetPrice": 360,
                "showExtendedListPrice": 400,
                "showUnitDiscountAmount": 20,
                "showExtendedDiscountAmount": 40,
                "subscriptionUnitListPrice": 200,
                "subscriptionExtendedNetPrice": 360,
                "subscriptionUnitDiscountAmount": 20,
                "subscriptionTaxMode": "NET",
                "unitListPrice": 200,
                "unitNetPrice": 180,
                "unitDiscountAmount": 20,
                "extendedListPrice": 400,
                "extendedNetPrice": 360,
                "extendedDiscountAmount": 40,
                "withTaxUnitListPrice": 200,
                "withTaxUnitNetPrice": 180,
                "withTaxUnitDiscountAmount": 20,
                "withTaxExtendedListPrice": 400,
                "withTaxExtendedNetPrice": 360,
                "withTaxExtendedDiscountAmount": 40,
                "withoutTaxUnitListPrice": 200,
                "withoutTaxUnitNetPrice": 180,
                "withoutTaxUnitDiscountAmount": 20,
                "withoutTaxExtendedListPrice": 400,
                "withoutTaxExtendedNetPrice": 360,
                "withoutTaxExtendedDiscountAmount": 40,
                "discountPercent": 10,
                "withTaxUnitProductDiscount": 20,
                "withTaxExtendedProductDiscount": 40,
                "withoutTaxUnitProductDiscount": 20,
                "withoutTaxExtendedProductDiscount": 40,
                "roundedWithoutTaxUnitNetPrice": 180,
                "roundedWithoutTaxExtendedNetPrice": 360,
                "roundedWithTaxExtendedNetPrice": 360,
                "sourceListPrice": 200,
                "sourceCurrency": "USD",
                "lineNumber": "LNNS3BGRMB65JEK1FF3N9W9FEEKC",
                "rules": [
                  {
                    "name": "DetermineCurrencyCode",
                    "reason": "Input currency",
                    "outputCurrency": "USD",
                    "trial": "false",
                    "endPrice": "$200.00 USD",
                    "priceModel": "PER_UNIT",
                    "description": "Load price",
                    "operation": "+ 0.0000",
                    "taxMode": "NET",
                    "taxRate": "0.0000",
                    "taxExempt": "false",
                    "unitPrice": "180.0000",
                    "quantity": "2"
                  }
                ],
                "effectiveTaxMode": "NET",
                "discountTiers": [
                  {
                    "min": 1,
                    "withTaxUnitNetPrice": 180,
                    "withoutTaxUnitNetPrice": 180,
                    "withoutTaxUnitDiscountAmount": 20,
                    "withTaxUnitDiscountAmount": 20,
                    "discountPercent": 10,
                    "type": "VOLUME_PERCENT_OFF"
                  }
                ],
                "discounts": [
                  {
                    "discountType": "VOLUME_PERCENT_OFF",
                    "discountDuration": 5,
                    "discountPath": "add-on-subscription",
                    "discountUnitAmount": 20,
                    "discountPercent": 10
                  }
                ],
                "withTaxStoreCurrencyExtendedNetPrice": 360,
                "withTaxUSDExtendedNetPrice": 360,
                "taxCode": "DV021010",
                "taxFormat": "DIGITAL_ONLY",
                "pricingPlanRenew": "auto",
                "paymentRequired": true,
                "withoutTaxExemptionUnitNetPrice": 180,
                "withoutTaxExemptionUnitListPrice": 200,
                "quantity": 2,
                "discountPath": "add-on-subscription"
              }
            ]
          }
        ]
      },
      "quantityBehavior": "allow",
      "quantityDefault": 1,
      "discountDuration": 5,
      "cancellationChoice": "AFTER_LAST_NOTIFICATION",
      "notifications": [
        {
          "notificationType": "TRIAL_CONVERSION_REMINDER",
          "intervals": [
            {
              "intervalUnit": "day",
              "intervalLength": 3
            }
          ],
          "firstIntervalUnit": "day",
          "firstIntervalLength": 3
        }
      ],
      "productDescriptions": {
        "display": {
          "en": "Add-on Subscription"
        },
        "summary": {
          "en": "This is my product summary"
        }
      }
    }
  ],
  "name": "Name of the quote",
  "netTermsDays": 30,
  "quoteUrl": "https://test.onfastspring.com/popup-defaultB2B/account/order/quote/AB1CD23EFG45H6IJKLMNOPQ78R9S",
  "recipient": {
    "company": "Example Company",
    "email": "jane.doe@example.com",
    "first": "Jane",
    "last": "Doe",
    "phone": "5555551234"
  },
  "recipientAddress": {
    "addressLine1": "123 Main Street",
    "city": "Example City",
    "country": "US",
    "postalCode": "12345",
    "region": "California"
  },
  "siteId": "aB0CdEFGHIjK",
  "status": "EXPIRED",
  "statusHistory": [
    {
      "statusUpdatedTo": "EXPIRED",
      "statusUpdatedByFullName": "SYSTEM SYSTEM",
      "statusUpdatedByEmail": "SYSTEM",
      "statusUpdatedOn": "2026-10-10T00:04:24.046+00:00"
    }
  ],
  "subtotal": 400,
  "subtotalDisplay": "$400.00",
  "subtotalInPayoutCurrency": 400,
  "subtotalInPayoutCurrencyDisplay": "$400.00",
  "tags": [
    {
      "key": "tag-key",
      "value": "Tag Value"
    }
  ],
  "taxType": "TAX",
  "total": 360,
  "totalDisplay": "$360.00",
  "totalInPayoutCurrency": 360,
  "totalInPayoutCurrencyDisplay": "$360.00",
  "updated": "2026-10-10T00:04:24.174+00:00",
  "taxId": "BE09999999XX",
  "source": "MANAGER",
  "sourceIP": "198.51.100.45",
  "orderReference": "AB1234567-8910-11121",
  "invoiceId": "AB12CDE35FGHIJKLMN6OPQRSTUV"
}