API reference
Test mode. Use your secret key on your server; live processing is currently disabled.
https://api.knoxapi.comSend form-encoded requests with Authorization: Bearer sk_test_....
Complete OpenAPI specification · Integration guide
Operations and schemas are based on the pinned Stripe OpenAPI specification (MIT). Nested object definitions and enums are available in the complete specification.
GET /v1/quotes
List all quotes
Returns a list of your quotes.
Request parameters
| Parameter | Location | Type | Description |
|---|---|---|---|
customer | query | string | The ID of the customer whose quotes you're retrieving. |
customer_account | query | string | The ID of the account representing the customer whose quotes you're retrieving. |
ending_before | query | string | A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. |
expand | query | array of string | Specifies which fields in the response should be expanded. |
limit | query | integer | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. |
starting_after | query | string | A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. |
status | query | string | The status of the quote. |
test_clock | query | string | Provides a list of quotes that are associated with the specified test clock. The response will not include quotes with test clocks if this and the customer parameter is not set. |
object. See the OpenAPI specification for the complete schema.
Responses
HTTP 200: Successful response.
| Field | Type | Description |
|---|---|---|
data required | array of quote | |
has_more required | boolean | True if this list has another page of items after this one that can be fetched. |
object required | string | String representing the object's type. Objects of the same type share the same value. Always has the value `list`. |
url required | string | The URL where this list can be accessed. |
HTTP default: Error response.
| Field | Type | Description |
|---|---|---|
error required | api_errors |
POST /v1/quotes
Create a quote
A quote models prices and services for a customer. Default options for header, description, footer, and expires_at can be set in the dashboard via the quote template.
Request parameters
| Field | Type | Description |
|---|---|---|
application_fee_amount | one of multiple schemas | The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. There cannot be any line items with recurring prices when using this field. |
application_fee_percent | one of multiple schemas | A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field. |
automatic_tax | object | Settings for automatic tax lookup for this quote and resulting invoices and subscriptions. |
collection_method | string | Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`. |
customer | string | The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. |
customer_account | string | The account for which this quote belongs to. A customer or account is required before finalizing the quote. Once specified, it cannot be changed. |
default_tax_rates | one of multiple schemas | The tax rates that will apply to any line item that does not have `tax_rates` set. |
description | one of multiple schemas | A description that will be displayed on the quote PDF. If no value is passed, the default description configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. |
discounts | one of multiple schemas | The discounts applied to the quote. |
expand | array of string | Specifies which fields in the response should be expanded. |
expires_at | integer | A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. If no value is passed, the default expiration date configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. |
footer | one of multiple schemas | A footer that will be displayed on the quote PDF. If no value is passed, the default footer configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. |
from_quote | object | Clone an existing quote. The new quote will be created in `status=draft`. When using this parameter, you cannot specify any other parameters except for `expires_at`. |
header | one of multiple schemas | A header that will be displayed on the quote PDF. If no value is passed, the default header configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. |
invoice_settings | object | All invoices will be billed using the specified settings. |
line_items | array of object | A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost. |
metadata | object | Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. |
on_behalf_of | one of multiple schemas | The account on behalf of which to charge. |
subscription_data | object | When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created. |
test_clock | string | ID of the test clock to attach to the quote. |
transfer_data | one of multiple schemas | The data with which to automatically create a Transfer for each of the invoices. |
Responses
HTTP 200: Successful response.
| Field | Type | Description |
|---|---|---|
amount_subtotal required | integer | Total before any discounts or taxes are applied. |
amount_total required | integer | Total after discounts and taxes are applied. |
application | one of multiple schemas | ID of the Connect Application that created the quote. |
application_fee_amount | integer | The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Only applicable if there are no line items with recurring prices on the quote. |
application_fee_percent | number | A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. Only applicable if there are line items with recurring prices on the quote. |
automatic_tax required | quotes_resource_automatic_tax | |
collection_method required | string | Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or on finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`. |
computed required | quotes_resource_computed | |
created required | integer | Time at which the object was created. Measured in seconds since the Unix epoch. |
currency | string | Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). |
customer | one of multiple schemas | The customer who received this quote. A customer is required to finalize the quote. Once specified, you can't change it. |
customer_account | string | The account representing the customer who received this quote. A customer or account is required to finalize the quote. Once specified, you can't change it. |
default_tax_rates | array of one of multiple schemas | The tax rates applied to this quote. |
description | string | A description that will be displayed on the quote PDF. |
discounts required | array of one of multiple schemas | The discounts applied to this quote. |
expires_at required | integer | The date on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. |
footer | string | A footer that will be displayed on the quote PDF. |
from_quote | one of multiple schemas | Details of the quote that was cloned. See the [cloning documentation](https://docs.stripe.com/quotes/clone) for more details. |
header | string | A header that will be displayed on the quote PDF. |
id required | string | Unique identifier for the object. |
invoice | one of multiple schemas | The invoice that was created from this quote. |
invoice_settings required | invoice_setting_quote_setting | |
line_items | object | A list of items the customer is being quoted for. |
livemode required | boolean | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
metadata required | object | Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. |
number | string | A unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://docs.stripe.com/quotes/overview#finalize). |
object required | string | String representing the object's type. Objects of the same type share the same value. |
on_behalf_of | one of multiple schemas | The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details. |
status required | string | The status of the quote. |
status_transitions required | quotes_resource_status_transitions | |
subscription | one of multiple schemas | The subscription that was created or updated from this quote. |
subscription_data required | quotes_resource_subscription_data_subscription_data | |
subscription_schedule | one of multiple schemas | The subscription schedule that was created or updated from this quote. |
test_clock | one of multiple schemas | ID of the test clock this quote belongs to. |
total_details required | quotes_resource_total_details | |
transfer_data | one of multiple schemas | The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices. |
HTTP default: Error response.
| Field | Type | Description |
|---|---|---|
error required | api_errors |
GET /v1/quotes/{quote}
Retrieve a quote
Retrieves the quote with the given ID.
Request parameters
| Parameter | Location | Type | Description |
|---|---|---|---|
expand | query | array of string | Specifies which fields in the response should be expanded. |
quote | path | string |
object. See the OpenAPI specification for the complete schema.
Responses
HTTP 200: Successful response.
| Field | Type | Description |
|---|---|---|
amount_subtotal required | integer | Total before any discounts or taxes are applied. |
amount_total required | integer | Total after discounts and taxes are applied. |
application | one of multiple schemas | ID of the Connect Application that created the quote. |
application_fee_amount | integer | The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Only applicable if there are no line items with recurring prices on the quote. |
application_fee_percent | number | A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. Only applicable if there are line items with recurring prices on the quote. |
automatic_tax required | quotes_resource_automatic_tax | |
collection_method required | string | Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or on finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`. |
computed required | quotes_resource_computed | |
created required | integer | Time at which the object was created. Measured in seconds since the Unix epoch. |
currency | string | Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). |
customer | one of multiple schemas | The customer who received this quote. A customer is required to finalize the quote. Once specified, you can't change it. |
customer_account | string | The account representing the customer who received this quote. A customer or account is required to finalize the quote. Once specified, you can't change it. |
default_tax_rates | array of one of multiple schemas | The tax rates applied to this quote. |
description | string | A description that will be displayed on the quote PDF. |
discounts required | array of one of multiple schemas | The discounts applied to this quote. |
expires_at required | integer | The date on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. |
footer | string | A footer that will be displayed on the quote PDF. |
from_quote | one of multiple schemas | Details of the quote that was cloned. See the [cloning documentation](https://docs.stripe.com/quotes/clone) for more details. |
header | string | A header that will be displayed on the quote PDF. |
id required | string | Unique identifier for the object. |
invoice | one of multiple schemas | The invoice that was created from this quote. |
invoice_settings required | invoice_setting_quote_setting | |
line_items | object | A list of items the customer is being quoted for. |
livemode required | boolean | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
metadata required | object | Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. |
number | string | A unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://docs.stripe.com/quotes/overview#finalize). |
object required | string | String representing the object's type. Objects of the same type share the same value. |
on_behalf_of | one of multiple schemas | The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details. |
status required | string | The status of the quote. |
status_transitions required | quotes_resource_status_transitions | |
subscription | one of multiple schemas | The subscription that was created or updated from this quote. |
subscription_data required | quotes_resource_subscription_data_subscription_data | |
subscription_schedule | one of multiple schemas | The subscription schedule that was created or updated from this quote. |
test_clock | one of multiple schemas | ID of the test clock this quote belongs to. |
total_details required | quotes_resource_total_details | |
transfer_data | one of multiple schemas | The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices. |
HTTP default: Error response.
| Field | Type | Description |
|---|---|---|
error required | api_errors |
POST /v1/quotes/{quote}
Update a quote
A quote models prices and services for a customer.
Request parameters
| Parameter | Location | Type | Description |
|---|---|---|---|
quote | path | string |
| Field | Type | Description |
|---|---|---|
application_fee_amount | one of multiple schemas | The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. There cannot be any line items with recurring prices when using this field. |
application_fee_percent | one of multiple schemas | A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field. |
automatic_tax | object | Settings for automatic tax lookup for this quote and resulting invoices and subscriptions. |
collection_method | string | Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`. |
customer | string | The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. |
customer_account | string | The account for which this quote belongs to. A customer or account is required before finalizing the quote. Once specified, it cannot be changed. |
default_tax_rates | one of multiple schemas | The tax rates that will apply to any line item that does not have `tax_rates` set. |
description | one of multiple schemas | A description that will be displayed on the quote PDF. |
discounts | one of multiple schemas | The discounts applied to the quote. |
expand | array of string | Specifies which fields in the response should be expanded. |
expires_at | integer | A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. |
footer | one of multiple schemas | A footer that will be displayed on the quote PDF. |
header | one of multiple schemas | A header that will be displayed on the quote PDF. |
invoice_settings | object | All invoices will be billed using the specified settings. |
line_items | array of object | A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost. |
metadata | object | Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. |
on_behalf_of | one of multiple schemas | The account on behalf of which to charge. |
subscription_data | object | When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created. |
transfer_data | one of multiple schemas | The data with which to automatically create a Transfer for each of the invoices. |
Responses
HTTP 200: Successful response.
| Field | Type | Description |
|---|---|---|
amount_subtotal required | integer | Total before any discounts or taxes are applied. |
amount_total required | integer | Total after discounts and taxes are applied. |
application | one of multiple schemas | ID of the Connect Application that created the quote. |
application_fee_amount | integer | The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Only applicable if there are no line items with recurring prices on the quote. |
application_fee_percent | number | A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. Only applicable if there are line items with recurring prices on the quote. |
automatic_tax required | quotes_resource_automatic_tax | |
collection_method required | string | Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or on finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`. |
computed required | quotes_resource_computed | |
created required | integer | Time at which the object was created. Measured in seconds since the Unix epoch. |
currency | string | Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). |
customer | one of multiple schemas | The customer who received this quote. A customer is required to finalize the quote. Once specified, you can't change it. |
customer_account | string | The account representing the customer who received this quote. A customer or account is required to finalize the quote. Once specified, you can't change it. |
default_tax_rates | array of one of multiple schemas | The tax rates applied to this quote. |
description | string | A description that will be displayed on the quote PDF. |
discounts required | array of one of multiple schemas | The discounts applied to this quote. |
expires_at required | integer | The date on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. |
footer | string | A footer that will be displayed on the quote PDF. |
from_quote | one of multiple schemas | Details of the quote that was cloned. See the [cloning documentation](https://docs.stripe.com/quotes/clone) for more details. |
header | string | A header that will be displayed on the quote PDF. |
id required | string | Unique identifier for the object. |
invoice | one of multiple schemas | The invoice that was created from this quote. |
invoice_settings required | invoice_setting_quote_setting | |
line_items | object | A list of items the customer is being quoted for. |
livemode required | boolean | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
metadata required | object | Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. |
number | string | A unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://docs.stripe.com/quotes/overview#finalize). |
object required | string | String representing the object's type. Objects of the same type share the same value. |
on_behalf_of | one of multiple schemas | The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details. |
status required | string | The status of the quote. |
status_transitions required | quotes_resource_status_transitions | |
subscription | one of multiple schemas | The subscription that was created or updated from this quote. |
subscription_data required | quotes_resource_subscription_data_subscription_data | |
subscription_schedule | one of multiple schemas | The subscription schedule that was created or updated from this quote. |
test_clock | one of multiple schemas | ID of the test clock this quote belongs to. |
total_details required | quotes_resource_total_details | |
transfer_data | one of multiple schemas | The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices. |
HTTP default: Error response.
| Field | Type | Description |
|---|---|---|
error required | api_errors |
POST /v1/quotes/{quote}/accept
Accept a quote
Accepts the specified quote.
Request parameters
| Parameter | Location | Type | Description |
|---|---|---|---|
quote | path | string |
| Field | Type | Description |
|---|---|---|
expand | array of string | Specifies which fields in the response should be expanded. |
Responses
HTTP 200: Successful response.
| Field | Type | Description |
|---|---|---|
amount_subtotal required | integer | Total before any discounts or taxes are applied. |
amount_total required | integer | Total after discounts and taxes are applied. |
application | one of multiple schemas | ID of the Connect Application that created the quote. |
application_fee_amount | integer | The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Only applicable if there are no line items with recurring prices on the quote. |
application_fee_percent | number | A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. Only applicable if there are line items with recurring prices on the quote. |
automatic_tax required | quotes_resource_automatic_tax | |
collection_method required | string | Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or on finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`. |
computed required | quotes_resource_computed | |
created required | integer | Time at which the object was created. Measured in seconds since the Unix epoch. |
currency | string | Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). |
customer | one of multiple schemas | The customer who received this quote. A customer is required to finalize the quote. Once specified, you can't change it. |
customer_account | string | The account representing the customer who received this quote. A customer or account is required to finalize the quote. Once specified, you can't change it. |
default_tax_rates | array of one of multiple schemas | The tax rates applied to this quote. |
description | string | A description that will be displayed on the quote PDF. |
discounts required | array of one of multiple schemas | The discounts applied to this quote. |
expires_at required | integer | The date on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. |
footer | string | A footer that will be displayed on the quote PDF. |
from_quote | one of multiple schemas | Details of the quote that was cloned. See the [cloning documentation](https://docs.stripe.com/quotes/clone) for more details. |
header | string | A header that will be displayed on the quote PDF. |
id required | string | Unique identifier for the object. |
invoice | one of multiple schemas | The invoice that was created from this quote. |
invoice_settings required | invoice_setting_quote_setting | |
line_items | object | A list of items the customer is being quoted for. |
livemode required | boolean | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
metadata required | object | Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. |
number | string | A unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://docs.stripe.com/quotes/overview#finalize). |
object required | string | String representing the object's type. Objects of the same type share the same value. |
on_behalf_of | one of multiple schemas | The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details. |
status required | string | The status of the quote. |
status_transitions required | quotes_resource_status_transitions | |
subscription | one of multiple schemas | The subscription that was created or updated from this quote. |
subscription_data required | quotes_resource_subscription_data_subscription_data | |
subscription_schedule | one of multiple schemas | The subscription schedule that was created or updated from this quote. |
test_clock | one of multiple schemas | ID of the test clock this quote belongs to. |
total_details required | quotes_resource_total_details | |
transfer_data | one of multiple schemas | The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices. |
HTTP default: Error response.
| Field | Type | Description |
|---|---|---|
error required | api_errors |
POST /v1/quotes/{quote}/cancel
Cancel a quote
Cancels the quote.
Request parameters
| Parameter | Location | Type | Description |
|---|---|---|---|
quote | path | string |
| Field | Type | Description |
|---|---|---|
expand | array of string | Specifies which fields in the response should be expanded. |
Responses
HTTP 200: Successful response.
| Field | Type | Description |
|---|---|---|
amount_subtotal required | integer | Total before any discounts or taxes are applied. |
amount_total required | integer | Total after discounts and taxes are applied. |
application | one of multiple schemas | ID of the Connect Application that created the quote. |
application_fee_amount | integer | The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Only applicable if there are no line items with recurring prices on the quote. |
application_fee_percent | number | A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. Only applicable if there are line items with recurring prices on the quote. |
automatic_tax required | quotes_resource_automatic_tax | |
collection_method required | string | Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or on finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`. |
computed required | quotes_resource_computed | |
created required | integer | Time at which the object was created. Measured in seconds since the Unix epoch. |
currency | string | Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). |
customer | one of multiple schemas | The customer who received this quote. A customer is required to finalize the quote. Once specified, you can't change it. |
customer_account | string | The account representing the customer who received this quote. A customer or account is required to finalize the quote. Once specified, you can't change it. |
default_tax_rates | array of one of multiple schemas | The tax rates applied to this quote. |
description | string | A description that will be displayed on the quote PDF. |
discounts required | array of one of multiple schemas | The discounts applied to this quote. |
expires_at required | integer | The date on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. |
footer | string | A footer that will be displayed on the quote PDF. |
from_quote | one of multiple schemas | Details of the quote that was cloned. See the [cloning documentation](https://docs.stripe.com/quotes/clone) for more details. |
header | string | A header that will be displayed on the quote PDF. |
id required | string | Unique identifier for the object. |
invoice | one of multiple schemas | The invoice that was created from this quote. |
invoice_settings required | invoice_setting_quote_setting | |
line_items | object | A list of items the customer is being quoted for. |
livemode required | boolean | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
metadata required | object | Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. |
number | string | A unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://docs.stripe.com/quotes/overview#finalize). |
object required | string | String representing the object's type. Objects of the same type share the same value. |
on_behalf_of | one of multiple schemas | The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details. |
status required | string | The status of the quote. |
status_transitions required | quotes_resource_status_transitions | |
subscription | one of multiple schemas | The subscription that was created or updated from this quote. |
subscription_data required | quotes_resource_subscription_data_subscription_data | |
subscription_schedule | one of multiple schemas | The subscription schedule that was created or updated from this quote. |
test_clock | one of multiple schemas | ID of the test clock this quote belongs to. |
total_details required | quotes_resource_total_details | |
transfer_data | one of multiple schemas | The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices. |
HTTP default: Error response.
| Field | Type | Description |
|---|---|---|
error required | api_errors |
GET /v1/quotes/{quote}/computed_upfront_line_items
Retrieve a quote's upfront line items
When retrieving a quote, there is an includable computed.upfront.line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of upfront line items.
Request parameters
| Parameter | Location | Type | Description |
|---|---|---|---|
ending_before | query | string | A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. |
expand | query | array of string | Specifies which fields in the response should be expanded. |
limit | query | integer | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. |
quote | path | string | |
starting_after | query | string | A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. |
object. See the OpenAPI specification for the complete schema.
Responses
HTTP 200: Successful response.
| Field | Type | Description |
|---|---|---|
data required | array of item | Details about each object. |
has_more required | boolean | True if this list has another page of items after this one that can be fetched. |
object required | string | String representing the object's type. Objects of the same type share the same value. Always has the value `list`. |
url required | string | The URL where this list can be accessed. |
HTTP default: Error response.
| Field | Type | Description |
|---|---|---|
error required | api_errors |
POST /v1/quotes/{quote}/finalize
Finalize a quote
Finalizes the quote.
Request parameters
| Parameter | Location | Type | Description |
|---|---|---|---|
quote | path | string |
| Field | Type | Description |
|---|---|---|
expand | array of string | Specifies which fields in the response should be expanded. |
expires_at | integer | A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. |
Responses
HTTP 200: Successful response.
| Field | Type | Description |
|---|---|---|
amount_subtotal required | integer | Total before any discounts or taxes are applied. |
amount_total required | integer | Total after discounts and taxes are applied. |
application | one of multiple schemas | ID of the Connect Application that created the quote. |
application_fee_amount | integer | The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Only applicable if there are no line items with recurring prices on the quote. |
application_fee_percent | number | A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. Only applicable if there are line items with recurring prices on the quote. |
automatic_tax required | quotes_resource_automatic_tax | |
collection_method required | string | Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or on finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`. |
computed required | quotes_resource_computed | |
created required | integer | Time at which the object was created. Measured in seconds since the Unix epoch. |
currency | string | Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). |
customer | one of multiple schemas | The customer who received this quote. A customer is required to finalize the quote. Once specified, you can't change it. |
customer_account | string | The account representing the customer who received this quote. A customer or account is required to finalize the quote. Once specified, you can't change it. |
default_tax_rates | array of one of multiple schemas | The tax rates applied to this quote. |
description | string | A description that will be displayed on the quote PDF. |
discounts required | array of one of multiple schemas | The discounts applied to this quote. |
expires_at required | integer | The date on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. |
footer | string | A footer that will be displayed on the quote PDF. |
from_quote | one of multiple schemas | Details of the quote that was cloned. See the [cloning documentation](https://docs.stripe.com/quotes/clone) for more details. |
header | string | A header that will be displayed on the quote PDF. |
id required | string | Unique identifier for the object. |
invoice | one of multiple schemas | The invoice that was created from this quote. |
invoice_settings required | invoice_setting_quote_setting | |
line_items | object | A list of items the customer is being quoted for. |
livemode required | boolean | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
metadata required | object | Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. |
number | string | A unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://docs.stripe.com/quotes/overview#finalize). |
object required | string | String representing the object's type. Objects of the same type share the same value. |
on_behalf_of | one of multiple schemas | The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details. |
status required | string | The status of the quote. |
status_transitions required | quotes_resource_status_transitions | |
subscription | one of multiple schemas | The subscription that was created or updated from this quote. |
subscription_data required | quotes_resource_subscription_data_subscription_data | |
subscription_schedule | one of multiple schemas | The subscription schedule that was created or updated from this quote. |
test_clock | one of multiple schemas | ID of the test clock this quote belongs to. |
total_details required | quotes_resource_total_details | |
transfer_data | one of multiple schemas | The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices. |
HTTP default: Error response.
| Field | Type | Description |
|---|---|---|
error required | api_errors |
GET /v1/quotes/{quote}/line_items
Retrieve a quote's line items
When retrieving a quote, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
Request parameters
| Parameter | Location | Type | Description |
|---|---|---|---|
ending_before | query | string | A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. |
expand | query | array of string | Specifies which fields in the response should be expanded. |
limit | query | integer | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. |
quote | path | string | |
starting_after | query | string | A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. |
object. See the OpenAPI specification for the complete schema.
Responses
HTTP 200: Successful response.
| Field | Type | Description |
|---|---|---|
data required | array of item | Details about each object. |
has_more required | boolean | True if this list has another page of items after this one that can be fetched. |
object required | string | String representing the object's type. Objects of the same type share the same value. Always has the value `list`. |
url required | string | The URL where this list can be accessed. |
HTTP default: Error response.
| Field | Type | Description |
|---|---|---|
error required | api_errors |
GET /v1/quotes/{quote}/pdf
Download quote PDF
Download the PDF for a finalized quote. Explanation for special handling can be found here
Request parameters
| Parameter | Location | Type | Description |
|---|---|---|---|
expand | query | array of string | Specifies which fields in the response should be expanded. |
quote | path | string |
object. See the OpenAPI specification for the complete schema.
Responses
HTTP 200: Successful response.
HTTP default: Error response.
| Field | Type | Description |
|---|---|---|
error required | api_errors |