Last updated

These docs are intended for a developer audience.

Quotes

A quote is a pricing estimate for requested goods or services and can help facilitate negotiation before creating an order. Customers can accept or reject a quote. If accepted, depending on which acceptance conditions are defined and fulfilled, an order is created or modified based on the quote. A quote has an expiration date. Merchants can recall or cancel an issued quote.

Quotes can only be edited when they are in draft status. To edit an issued quote, recall a quote, edit, and issue it again. For detailed information on the quote API and related operations, see Quotes.

To create and manage quotes using the Rebilly UI, see Quotes.

There are three ways to create a quote:

  • Create a new quote using the Create a quote operation. This option creates a new quote that conveys a proposed order to the customer, so that they can accept or reject the proposal before an order is created.
  • Edit an existing order using the Upsert an order operation. This option creates a quote that conveys the changes to the customer, so that they can accept or reject the changes and before the order is updated.
  • Reactivate a canceled subscription using the Reactivate a subscription operation. This option creates a quote that conveys the changes to the customer, so that they can accept or reject the changes before the subscription is reactivated.

When a quote is accepted, depending on which acceptance conditions are defined and fulfilled: a new order is created based on the quote, or an existing order is modified based on the orderId that was passed in the request body.

Quote lifecycle

This section describes the quote lifecycle and related terms.

StatusDescription
draftQuote is not issued yet. In this state, the quote can be edited.
issuedQuote is issued to the customer. In this state, the quote cannot be edited.
acceptedCustomer accepted the quote and created an order.
rejectedCustomer rejected the quote.
canceledMerchant organization canceled the quote.
expiredExpired before customer or organization interaction.

Quote issued, edited, and accepted

This section describes the lifecycle of a quote that is created, issued, edited, and then accepted.

Issue
Recall
Acceptance
1. Draft
2. Issued
3. Accepted
4. Order created/modified
  1. A quote is created and is assigned the draft status. In this state, the quote can be edited.
    Select from the following options to create a quote:
    • Create a new quote using the Create a quote operation.
    • Edit an existing order using the Upsert an order operation. This option creates a quote that conveys the changes to the customer, so that they can accept or reject the changes before the order is updated.
    • Reactivate a canceled subscription using the Reactivate a subscription operation. This option creates a quote that conveys the changes to the customer, so that they can accept or reject the changes before the subscription is reactivated.
  2. The quote is issued to the customer and is assigned the issued status. In this state, the quote cannot be edited. Quotes are issued using the Issue a quote operation.
    1. The customer requests some changes to the quote. The quote is recalled and is assigned the draft status so that it can be edited. Quotes are recalled using the Recall a quote operation.
    2. The quote is edited and issued to the customer again. The quote is assigned the issued status.
  3. The customer accepts the quote. The quote is assigned the accepted status.
    Quotes are accepted using the Accept a quote operation.
  4. When a quote is accepted, depending on which acceptance conditions are defined and fulfilled, the orderId that was passed in the request body is used to modify or create an order based on the data in the quote.

Quote issued and rejected

This section describes the lifecycle of a quote that is rejected.

Issue
Customer rejection
1. Draft
2. Issued
3. Rejected
  1. A quote is created and is assigned the draft status. In this state, the quote can be edited.
    Select from the following options to create a quote:
    • Create a new quote using the Create a quote operation.
    • Edit an existing order using the Upsert an order operation. This option creates a quote that conveys the changes to the customer, so that they can accept or reject the changes before the order is updated.
    • Reactivate a canceled subscription using the Reactivate a subscription operation. This option creates a quote that conveys the changes to the customer, so that they can accept or reject the changes before the subscription is reactivated.
  2. The quote is issued to the customer and is assigned the issued status. In this state, the quote cannot be edited. Quotes are issued using the Issue a quote operation.
  3. The quote is rejected by the customer. The quote and is assigned the rejected status. When a quote is rejected, the quote the associated order is not created or modified. Quotes are rejected using the Reject a quote operation.

Quote issued and canceled

This section describes the lifecycle of a quote that is canceled.

Issue
Organization cancels
1. Draft
2. Issued
3. Canceled
  1. A quote is created and is assigned the draft status. In this state, the quote can be edited.
    Select from the following options to create a quote:
    • Create a new quote using the Create a quote operation.
    • Edit an existing order using the Upsert an order operation. This option creates a quote that conveys the changes to the customer, so that they can accept or reject the changes before the order is updated.
    • Reactivate a canceled subscription using the Reactivate a subscription operation. This option creates a quote that conveys the changes to the customer, so that they can accept or reject the changes before the subscription is reactivated.
  2. The quote is issued to the customer and is assigned the issued status. In this state, the quote cannot be edited. Quotes are issued using the Issue a quote operation.
  3. The organization cancels the quote. The quote is assigned the canceled status. When a quote is canceled, the associated order is not created or modified. Quotes are canceled using the Cancel a quote operation.

Quote issued and expired

This section describes the lifecycle of a quote that is expired.

Issue
Exceeds expiration date
1. Draft
2. Issued
3. Expired
  1. A quote is created and is assigned the draft status. In this state, the quote can be edited.
    Select from the following options to create a quote:
    • Create a new quote using the Create a quote operation.
    • Edit an existing order using the Upsert an order operation. This option creates a quote that conveys the changes to the customer, so that they can accept or reject the changes before the order is updated.
    • Reactivate a canceled subscription using the Reactivate a subscription operation. This option creates a quote that conveys the changes to the customer, so that they can accept or reject the changes before the subscription is reactivated.
  2. The quote is issued to the customer and is assigned the issued status. In this state, the quote cannot be edited. Quotes are issued using the Issue a quote operation.
  3. The quote exceeds the expiration date before it is accepted or rejected. The quote is assigned the expired status. The quote cannot be modified or re-issued, and the associated order is not updated or modified. A new quote must be created if the customer wants to proceed.