Collapse Menu
Documentation
FastSpring App
Contact Support

POST /quotes{id}/cancel - Cancel a Quote

Overview

How to cancel a quote using the POST /quotes endpoint

The POST /quotes/{id}/cancel endpoint cancels a quote, and sets the status to CANCELED. After this, the quoteURL no longer displays the quote.

  • POST /quotes/{id}/cancel

Request Bodies are not required for a DeleteQuote request. If a request body is provided, it will be ignored.

Example Response

  • {
       "id": "QU123XYZABC456DEF789GHI0123Q"
       "coupon": "5OFF", 
       "created": 1621728000,
       "createdBy": {
         "company": "FastSpring",
         "email": "createdby@example.com",
         "first": "Quote",
         "last": "Creator",
         "phone": "(805)123-4567"
       },
       "createdDisplay": "2021-04-23 12:30:00", 
       "currency": "USD",
       "discount": 0.0,
       "discountDisplay": "$0.00",
       "discountInPayoutCurrency": 0.0,
       "discountInPayoutCurrencyDisplay": "$0.00",
       "expirationDateDays": 30,
       "expires": 1621773000, 
       "expiresDisplay": "2021-05-23", 
       fulfillmentTerm: "ON_PAYMENT",
       "items": [ // GET BETTER ITEMS RESPONSE
         {
           "path": "sample-product-from-catalog"
         }
       ],
       "name": "Example json of a Quote Resource object",
       "notes": "Here are some notes for this quote.",
       "netTermsDays": 30,
       "quoteUrl": "https://examplestore.app.onfastspring.com/.../quote/QU123XYZABC456DEF789GHI0123Q",
       "recipient": {
         "email": "example@examplecompany.com",
         "first": "Example",
         "last": "Customr",
         "company": "ExampleCompany",
         "phone": "(805)123-4567" 
       },
       "recipientAddress": {
         "city": "Santa Barbara",
         "country": "US",
         "postalCode": "93101",
         "region": "CA",
         "streetLine1": "801 Garden Street",
         "streetLine2": "Ste. 201"
       },
       "status": "CANCELED",
       "statusHistory": {
          "OPEN": {
            "by": "Example User",
            "byEmail": "example_user@example.com",
            "on": 1621728000,
            "onDisplay": "2021-04-23 12:30:00"
          }
          "CANCELED": {
            "by": "Other User",
            "byEmail": "other_user@example.com",
            "on": 1619791325,
            "onDisplay": "2021-04-30 08:00:00"
          }
          "COMPLETED": null,
          "EXPIRED": null,
          "PENDING_PAYMENT": null
       },
       "tags":{
          "key": "value"
        },
       "tax": 100.00,
       "taxDisplay": "$100.00",
       "taxId": null,
       "taxInPayoutCurrency": 0.0,
       "taxInPayoutCurrencyDisplay": "$0.00",
       "total": 100.00,
       "totalDisplay": "$100.00",
       "totalInPayoutCurrency": 100.00,
       "totalInPayoutCurrencyDisplay": "$100.00",
       "updated": 1621773000, 
       "updatedDisplay": "2021-05-23"
    }