Using AI coding agents like Claude Code or Cursor? Try the official Chargebee Agent Skills to speed up your development.Try now
ChargebeeAPI

List quotes

List all quotes.

Sample Request

Sample Result[JSON]

URL Format

GET https://[site].chargebee.com/api/v2/quotes

Input Parameters

limit
optional, integer, default=10, min=1, max=100

The number of resources to be returned.

offset
optional, string, max chars=1000

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset to the value of next_offset obtained in the previous iteration of the API call.

include_deleted
optional, boolean, default=false

If set to true, includes the deleted resources in the response. For the deleted resources in the response, the 'deleted ' attribute will be 'true '.

sort_by[<sort-order>]
optional, object

optional, string filter

Sorts based on the specified attribute. Supported attributes : date

Supported sort-orders : asc, desc

Example → sort_by[asc] = "date"

This will sort the result based on the 'date' attribute in ascending(earliest first) order.

Filter Params

For operator usages, see the Pagination and Filtering section.
id[<operator>]

optional, string filter

The quote number. Acts as a identifier for quote and typically generated sequentially. Supported operators : is, is_not, starts_with, in, not_in

Example → id[is] = "123"

Supported operators: is, is_not, starts_with, in, not_in
Example → 123
customer_id[<operator>]

optional, string filter

The identifier of the customer this quote belongs to. Supported operators : is, is_not, starts_with, in, not_in

Example → customer_id[is_not] = "4gmiXbsjdm"

Supported operators: is, is_not, starts_with, in, not_in
Example → 4gmiXbsjdm
subscription_id[<operator>]

optional, string filter

To filter based on subscription_id. NOTE: Not to be used if consolidated invoicing feature is enabled. Supported operators : is, is_not, starts_with, is_present, in, not_in

Example → subscription_id[is_not] = "4gmiXbsjdm"

Supported operators: is, is_not, starts_with, is_present, in, not_in
Example → 4gmiXbsjdm
status[<operator>]

optional, enumerated string filter

Current status of this quote. Possible values are : open, accepted, declined, invoiced, closed.

Supported operators : is, is_not, in, not_in

Example → status[is] = "open"

Supported operators: is, is_not, in, not_in
Example → open
date[<operator>]

optional, timestamp(UTC) in seconds filter

Creation date of the quote. Typically this is the date on which quote is generated. Supported operators : after, before, on, between

Example → date[on] = "1435054328"

Supported operators: after, before, on, between
Example → 1435054328
updated_at[<operator>]

optional, timestamp(UTC) in seconds filter

To filter based on updated at. This attribute will be present only if the resource has been updated after 2016-11-09. Supported operators : after, before, on, between

Example → updated_at[on] = "1243545465"

Supported operators: after, before, on, between
Example → 1243545465

Returns

next_offset
optional, string, max chars=1000

This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter offset.

quote
Quote object
Resource object representing quote
quoted_subscription
Quoted subscription object
Resource object representing quoted_subscription
quoted_ramp
Quoted ramp object
Resource object representing quoted_ramp