published on Friday, Aug 14, 2026 by Pulumi
published on Friday, Aug 14, 2026 by Pulumi
A Quote is a way to model prices that you’d like to provide to a customer. Once accepted, it will automatically create an invoice, subscription or subscription schedule.
Create Quote Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Quote(name: string, args?: QuoteArgs, opts?: CustomResourceOptions);@overload
def Quote(resource_name: str,
args: Optional[QuoteArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Quote(resource_name: str,
opts: Optional[ResourceOptions] = None,
application_fee_amount: Optional[float] = None,
application_fee_percent: Optional[float] = None,
automatic_tax: Optional[QuoteAutomaticTaxArgs] = None,
collection_method: Optional[str] = None,
customer: Optional[str] = None,
customer_account: Optional[str] = None,
default_tax_rates: Optional[Sequence[str]] = None,
description: Optional[str] = None,
discounts: Optional[Sequence[QuoteDiscountArgs]] = None,
expires_at: Optional[float] = None,
footer: Optional[str] = None,
from_quote: Optional[QuoteFromQuoteArgs] = None,
header: Optional[str] = None,
invoice_settings: Optional[QuoteInvoiceSettingsArgs] = None,
line_items: Optional[Sequence[QuoteLineItemArgs]] = None,
metadata: Optional[Mapping[str, str]] = None,
on_behalf_of: Optional[str] = None,
subscription_data: Optional[QuoteSubscriptionDataArgs] = None,
test_clock: Optional[str] = None,
transfer_data: Optional[QuoteTransferDataArgs] = None)func NewQuote(ctx *Context, name string, args *QuoteArgs, opts ...ResourceOption) (*Quote, error)public Quote(string name, QuoteArgs? args = null, CustomResourceOptions? opts = null)type: stripe:Quote
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "stripe_quote" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args QuoteArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args QuoteArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args QuoteArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args QuoteArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args QuoteArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var quoteResource = new Stripe.Quote("quoteResource", new()
{
ApplicationFeeAmount = 0.0,
ApplicationFeePercent = 0.0,
AutomaticTax = new Stripe.Inputs.QuoteAutomaticTaxArgs
{
Enabled = false,
Liability = new Stripe.Inputs.QuoteAutomaticTaxLiabilityArgs
{
Type = "string",
Account = "string",
},
Provider = "string",
Status = "string",
},
CollectionMethod = "string",
Customer = "string",
CustomerAccount = "string",
DefaultTaxRates = new[]
{
"string",
},
Description = "string",
Discounts = new[]
{
new Stripe.Inputs.QuoteDiscountArgs
{
Coupon = "string",
Discount = "string",
PromotionCode = "string",
},
},
ExpiresAt = 0.0,
Footer = "string",
FromQuote = new Stripe.Inputs.QuoteFromQuoteArgs
{
Quote = "string",
IsRevision = false,
},
Header = "string",
InvoiceSettings = new Stripe.Inputs.QuoteInvoiceSettingsArgs
{
DaysUntilDue = 0.0,
Issuer = new Stripe.Inputs.QuoteInvoiceSettingsIssuerArgs
{
Type = "string",
Account = "string",
},
},
LineItems = new[]
{
new Stripe.Inputs.QuoteLineItemArgs
{
Discounts = new[]
{
new Stripe.Inputs.QuoteLineItemDiscountArgs
{
Coupon = "string",
Discount = "string",
PromotionCode = "string",
},
},
Price = "string",
PriceData = new Stripe.Inputs.QuoteLineItemPriceDataArgs
{
Currency = "string",
Product = "string",
Recurring = new Stripe.Inputs.QuoteLineItemPriceDataRecurringArgs
{
Interval = "string",
IntervalCount = 0.0,
},
TaxBehavior = "string",
UnitAmount = 0.0,
UnitAmountDecimal = 0.0,
},
Quantity = 0.0,
TaxRates = new[]
{
"string",
},
},
},
Metadata =
{
{ "string", "string" },
},
OnBehalfOf = "string",
SubscriptionData = new Stripe.Inputs.QuoteSubscriptionDataArgs
{
BillingMode = new Stripe.Inputs.QuoteSubscriptionDataBillingModeArgs
{
Type = "string",
Flexible = new Stripe.Inputs.QuoteSubscriptionDataBillingModeFlexibleArgs
{
ProrationDiscounts = "string",
},
},
Description = "string",
EffectiveDate = 0.0,
Metadata =
{
{ "string", "string" },
},
TrialPeriodDays = 0.0,
},
TestClock = "string",
TransferData = new Stripe.Inputs.QuoteTransferDataArgs
{
Destination = "string",
Amount = 0.0,
AmountPercent = 0.0,
},
});
example, err := stripe.NewQuote(ctx, "quoteResource", &stripe.QuoteArgs{
ApplicationFeeAmount: pulumi.Float64(0),
ApplicationFeePercent: pulumi.Float64(0),
AutomaticTax: &stripe.QuoteAutomaticTaxArgs{
Enabled: pulumi.Bool(false),
Liability: &stripe.QuoteAutomaticTaxLiabilityArgs{
Type: pulumi.String("string"),
Account: pulumi.String("string"),
},
Provider: pulumi.String("string"),
Status: pulumi.String("string"),
},
CollectionMethod: pulumi.String("string"),
Customer: pulumi.String("string"),
CustomerAccount: pulumi.String("string"),
DefaultTaxRates: pulumi.StringArray{
pulumi.String("string"),
},
Description: pulumi.String("string"),
Discounts: stripe.QuoteDiscountArray{
&stripe.QuoteDiscountArgs{
Coupon: pulumi.String("string"),
Discount: pulumi.String("string"),
PromotionCode: pulumi.String("string"),
},
},
ExpiresAt: pulumi.Float64(0),
Footer: pulumi.String("string"),
FromQuote: &stripe.QuoteFromQuoteArgs{
Quote: pulumi.String("string"),
IsRevision: pulumi.Bool(false),
},
Header: pulumi.String("string"),
InvoiceSettings: &stripe.QuoteInvoiceSettingsArgs{
DaysUntilDue: pulumi.Float64(0),
Issuer: &stripe.QuoteInvoiceSettingsIssuerArgs{
Type: pulumi.String("string"),
Account: pulumi.String("string"),
},
},
LineItems: stripe.QuoteLineItemArray{
&stripe.QuoteLineItemArgs{
Discounts: stripe.QuoteLineItemDiscountArray{
&stripe.QuoteLineItemDiscountArgs{
Coupon: pulumi.String("string"),
Discount: pulumi.String("string"),
PromotionCode: pulumi.String("string"),
},
},
Price: pulumi.String("string"),
PriceData: &stripe.QuoteLineItemPriceDataArgs{
Currency: pulumi.String("string"),
Product: pulumi.String("string"),
Recurring: &stripe.QuoteLineItemPriceDataRecurringArgs{
Interval: pulumi.String("string"),
IntervalCount: pulumi.Float64(0),
},
TaxBehavior: pulumi.String("string"),
UnitAmount: pulumi.Float64(0),
UnitAmountDecimal: pulumi.Float64(0),
},
Quantity: pulumi.Float64(0),
TaxRates: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Metadata: pulumi.StringMap{
"string": pulumi.String("string"),
},
OnBehalfOf: pulumi.String("string"),
SubscriptionData: &stripe.QuoteSubscriptionDataArgs{
BillingMode: &stripe.QuoteSubscriptionDataBillingModeArgs{
Type: pulumi.String("string"),
Flexible: &stripe.QuoteSubscriptionDataBillingModeFlexibleArgs{
ProrationDiscounts: pulumi.String("string"),
},
},
Description: pulumi.String("string"),
EffectiveDate: pulumi.Float64(0),
Metadata: pulumi.StringMap{
"string": pulumi.String("string"),
},
TrialPeriodDays: pulumi.Float64(0),
},
TestClock: pulumi.String("string"),
TransferData: &stripe.QuoteTransferDataArgs{
Destination: pulumi.String("string"),
Amount: pulumi.Float64(0),
AmountPercent: pulumi.Float64(0),
},
})
resource "stripe_quote" "quoteResource" {
lifecycle {
create_before_destroy = true
}
application_fee_amount = 0
application_fee_percent = 0
automatic_tax = {
enabled = false
liability = {
type = "string"
account = "string"
}
provider = "string"
status = "string"
}
collection_method = "string"
customer = "string"
customer_account = "string"
default_tax_rates = ["string"]
description = "string"
discounts {
coupon = "string"
discount = "string"
promotion_code = "string"
}
expires_at = 0
footer = "string"
from_quote = {
quote = "string"
is_revision = false
}
header = "string"
invoice_settings = {
days_until_due = 0
issuer = {
type = "string"
account = "string"
}
}
line_items {
discounts {
coupon = "string"
discount = "string"
promotion_code = "string"
}
price = "string"
price_data = {
currency = "string"
product = "string"
recurring = {
interval = "string"
interval_count = 0
}
tax_behavior = "string"
unit_amount = 0
unit_amount_decimal = 0
}
quantity = 0
tax_rates = ["string"]
}
metadata = {
"string" = "string"
}
on_behalf_of = "string"
subscription_data = {
billing_mode = {
type = "string"
flexible = {
proration_discounts = "string"
}
}
description = "string"
effective_date = 0
metadata = {
"string" = "string"
}
trial_period_days = 0
}
test_clock = "string"
transfer_data = {
destination = "string"
amount = 0
amount_percent = 0
}
}
var quoteResource = new Quote("quoteResource", QuoteArgs.builder()
.applicationFeeAmount(0.0)
.applicationFeePercent(0.0)
.automaticTax(QuoteAutomaticTaxArgs.builder()
.enabled(false)
.liability(QuoteAutomaticTaxLiabilityArgs.builder()
.type("string")
.account("string")
.build())
.provider("string")
.status("string")
.build())
.collectionMethod("string")
.customer("string")
.customerAccount("string")
.defaultTaxRates("string")
.description("string")
.discounts(QuoteDiscountArgs.builder()
.coupon("string")
.discount("string")
.promotionCode("string")
.build())
.expiresAt(0.0)
.footer("string")
.fromQuote(QuoteFromQuoteArgs.builder()
.quote("string")
.isRevision(false)
.build())
.header("string")
.invoiceSettings(QuoteInvoiceSettingsArgs.builder()
.daysUntilDue(0.0)
.issuer(QuoteInvoiceSettingsIssuerArgs.builder()
.type("string")
.account("string")
.build())
.build())
.lineItems(QuoteLineItemArgs.builder()
.discounts(QuoteLineItemDiscountArgs.builder()
.coupon("string")
.discount("string")
.promotionCode("string")
.build())
.price("string")
.priceData(QuoteLineItemPriceDataArgs.builder()
.currency("string")
.product("string")
.recurring(QuoteLineItemPriceDataRecurringArgs.builder()
.interval("string")
.intervalCount(0.0)
.build())
.taxBehavior("string")
.unitAmount(0.0)
.unitAmountDecimal(0.0)
.build())
.quantity(0.0)
.taxRates("string")
.build())
.metadata(Map.of("string", "string"))
.onBehalfOf("string")
.subscriptionData(QuoteSubscriptionDataArgs.builder()
.billingMode(QuoteSubscriptionDataBillingModeArgs.builder()
.type("string")
.flexible(QuoteSubscriptionDataBillingModeFlexibleArgs.builder()
.prorationDiscounts("string")
.build())
.build())
.description("string")
.effectiveDate(0.0)
.metadata(Map.of("string", "string"))
.trialPeriodDays(0.0)
.build())
.testClock("string")
.transferData(QuoteTransferDataArgs.builder()
.destination("string")
.amount(0.0)
.amountPercent(0.0)
.build())
.build());
quote_resource = stripe.Quote("quoteResource",
application_fee_amount=float(0),
application_fee_percent=float(0),
automatic_tax={
"enabled": False,
"liability": {
"type": "string",
"account": "string",
},
"provider": "string",
"status": "string",
},
collection_method="string",
customer="string",
customer_account="string",
default_tax_rates=["string"],
description="string",
discounts=[{
"coupon": "string",
"discount": "string",
"promotion_code": "string",
}],
expires_at=float(0),
footer="string",
from_quote={
"quote": "string",
"is_revision": False,
},
header="string",
invoice_settings={
"days_until_due": float(0),
"issuer": {
"type": "string",
"account": "string",
},
},
line_items=[{
"discounts": [{
"coupon": "string",
"discount": "string",
"promotion_code": "string",
}],
"price": "string",
"price_data": {
"currency": "string",
"product": "string",
"recurring": {
"interval": "string",
"interval_count": float(0),
},
"tax_behavior": "string",
"unit_amount": float(0),
"unit_amount_decimal": float(0),
},
"quantity": float(0),
"tax_rates": ["string"],
}],
metadata={
"string": "string",
},
on_behalf_of="string",
subscription_data={
"billing_mode": {
"type": "string",
"flexible": {
"proration_discounts": "string",
},
},
"description": "string",
"effective_date": float(0),
"metadata": {
"string": "string",
},
"trial_period_days": float(0),
},
test_clock="string",
transfer_data={
"destination": "string",
"amount": float(0),
"amount_percent": float(0),
})
const quoteResource = new stripe.Quote("quoteResource", {
applicationFeeAmount: 0,
applicationFeePercent: 0,
automaticTax: {
enabled: false,
liability: {
type: "string",
account: "string",
},
provider: "string",
status: "string",
},
collectionMethod: "string",
customer: "string",
customerAccount: "string",
defaultTaxRates: ["string"],
description: "string",
discounts: [{
coupon: "string",
discount: "string",
promotionCode: "string",
}],
expiresAt: 0,
footer: "string",
fromQuote: {
quote: "string",
isRevision: false,
},
header: "string",
invoiceSettings: {
daysUntilDue: 0,
issuer: {
type: "string",
account: "string",
},
},
lineItems: [{
discounts: [{
coupon: "string",
discount: "string",
promotionCode: "string",
}],
price: "string",
priceData: {
currency: "string",
product: "string",
recurring: {
interval: "string",
intervalCount: 0,
},
taxBehavior: "string",
unitAmount: 0,
unitAmountDecimal: 0,
},
quantity: 0,
taxRates: ["string"],
}],
metadata: {
string: "string",
},
onBehalfOf: "string",
subscriptionData: {
billingMode: {
type: "string",
flexible: {
prorationDiscounts: "string",
},
},
description: "string",
effectiveDate: 0,
metadata: {
string: "string",
},
trialPeriodDays: 0,
},
testClock: "string",
transferData: {
destination: "string",
amount: 0,
amountPercent: 0,
},
});
type: stripe:Quote
properties:
applicationFeeAmount: 0
applicationFeePercent: 0
automaticTax:
enabled: false
liability:
account: string
type: string
provider: string
status: string
collectionMethod: string
customer: string
customerAccount: string
defaultTaxRates:
- string
description: string
discounts:
- coupon: string
discount: string
promotionCode: string
expiresAt: 0
footer: string
fromQuote:
isRevision: false
quote: string
header: string
invoiceSettings:
daysUntilDue: 0
issuer:
account: string
type: string
lineItems:
- discounts:
- coupon: string
discount: string
promotionCode: string
price: string
priceData:
currency: string
product: string
recurring:
interval: string
intervalCount: 0
taxBehavior: string
unitAmount: 0
unitAmountDecimal: 0
quantity: 0
taxRates:
- string
metadata:
string: string
onBehalfOf: string
subscriptionData:
billingMode:
flexible:
prorationDiscounts: string
type: string
description: string
effectiveDate: 0
metadata:
string: string
trialPeriodDays: 0
testClock: string
transferData:
amount: 0
amountPercent: 0
destination: string
Quote Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Quote resource accepts the following input properties:
- Application
Fee doubleAmount - 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 doublePercent - 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 QuoteAutomatic Tax - Collection
Method string - Either
charge_automatically, orsend_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 asactive. Defaults tocharge_automatically. - Customer string
- 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 List<string>Rates - The tax rates applied to this quote.
- Description string
- A description that will be displayed on the quote PDF.
- Discounts
List<Quote
Discount> - The discounts applied to this quote.
- Expires
At double - The date on which the quote will be canceled if in
openordraftstatus. Measured in seconds since the Unix epoch. - string
- A footer that will be displayed on the quote PDF.
- From
Quote QuoteFrom Quote - Details of the quote that was cloned. See the cloning documentation for more details.
- Header string
- A header that will be displayed on the quote PDF.
- Invoice
Settings QuoteInvoice Settings - Line
Items List<QuoteLine Item> - A list of items the customer is being quoted for.
- Metadata Dictionary<string, string>
- Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- On
Behalf stringOf - The account on behalf of which to charge. See the Connect documentation for details.
- Subscription
Data QuoteSubscription Data - Test
Clock string - ID of the test clock this quote belongs to.
- Transfer
Data QuoteTransfer Data - 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.
- Application
Fee float64Amount - 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 float64Percent - 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 QuoteAutomatic Tax Args - Collection
Method string - Either
charge_automatically, orsend_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 asactive. Defaults tocharge_automatically. - Customer string
- 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 []stringRates - The tax rates applied to this quote.
- Description string
- A description that will be displayed on the quote PDF.
- Discounts
[]Quote
Discount Args - The discounts applied to this quote.
- Expires
At float64 - The date on which the quote will be canceled if in
openordraftstatus. Measured in seconds since the Unix epoch. - string
- A footer that will be displayed on the quote PDF.
- From
Quote QuoteFrom Quote Args - Details of the quote that was cloned. See the cloning documentation for more details.
- Header string
- A header that will be displayed on the quote PDF.
- Invoice
Settings QuoteInvoice Settings Args - Line
Items []QuoteLine Item Args - A list of items the customer is being quoted for.
- Metadata map[string]string
- Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- On
Behalf stringOf - The account on behalf of which to charge. See the Connect documentation for details.
- Subscription
Data QuoteSubscription Data Args - Test
Clock string - ID of the test clock this quote belongs to.
- Transfer
Data QuoteTransfer Data Args - 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.
- application_
fee_ numberamount - 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_ numberpercent - 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 object - collection_
method string - Either
charge_automatically, orsend_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 asactive. Defaults tocharge_automatically. - customer string
- 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_ list(string)rates - The tax rates applied to this quote.
- description string
- A description that will be displayed on the quote PDF.
- discounts list(object)
- The discounts applied to this quote.
- expires_
at number - The date on which the quote will be canceled if in
openordraftstatus. Measured in seconds since the Unix epoch. - string
- A footer that will be displayed on the quote PDF.
- from_
quote object - Details of the quote that was cloned. See the cloning documentation for more details.
- header string
- A header that will be displayed on the quote PDF.
- invoice_
settings object - line_
items list(object) - A list of items the customer is being quoted for.
- metadata map(string)
- Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- on_
behalf_ stringof - The account on behalf of which to charge. See the Connect documentation for details.
- subscription_
data object - test_
clock string - ID of the test clock this quote belongs to.
- transfer_
data object - 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.
- application
Fee DoubleAmount - 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 DoublePercent - 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 QuoteAutomatic Tax - collection
Method String - Either
charge_automatically, orsend_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 asactive. Defaults tocharge_automatically. - customer String
- 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 List<String>Rates - The tax rates applied to this quote.
- description String
- A description that will be displayed on the quote PDF.
- discounts
List<Quote
Discount> - The discounts applied to this quote.
- expires
At Double - The date on which the quote will be canceled if in
openordraftstatus. Measured in seconds since the Unix epoch. - String
- A footer that will be displayed on the quote PDF.
- from
Quote QuoteFrom Quote - Details of the quote that was cloned. See the cloning documentation for more details.
- header String
- A header that will be displayed on the quote PDF.
- invoice
Settings QuoteInvoice Settings - line
Items List<QuoteLine Item> - A list of items the customer is being quoted for.
- metadata Map<String,String>
- Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- on
Behalf StringOf - The account on behalf of which to charge. See the Connect documentation for details.
- subscription
Data QuoteSubscription Data - test
Clock String - ID of the test clock this quote belongs to.
- transfer
Data QuoteTransfer Data - 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.
- application
Fee numberAmount - 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 numberPercent - 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 QuoteAutomatic Tax - collection
Method string - Either
charge_automatically, orsend_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 asactive. Defaults tocharge_automatically. - customer string
- 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 string[]Rates - The tax rates applied to this quote.
- description string
- A description that will be displayed on the quote PDF.
- discounts
Quote
Discount[] - The discounts applied to this quote.
- expires
At number - The date on which the quote will be canceled if in
openordraftstatus. Measured in seconds since the Unix epoch. - string
- A footer that will be displayed on the quote PDF.
- from
Quote QuoteFrom Quote - Details of the quote that was cloned. See the cloning documentation for more details.
- header string
- A header that will be displayed on the quote PDF.
- invoice
Settings QuoteInvoice Settings - line
Items QuoteLine Item[] - A list of items the customer is being quoted for.
- metadata {[key: string]: string}
- Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- on
Behalf stringOf - The account on behalf of which to charge. See the Connect documentation for details.
- subscription
Data QuoteSubscription Data - test
Clock string - ID of the test clock this quote belongs to.
- transfer
Data QuoteTransfer Data - 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.
- application_
fee_ floatamount - 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_ floatpercent - 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 QuoteAutomatic Tax Args - collection_
method str - Either
charge_automatically, orsend_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 asactive. Defaults tocharge_automatically. - customer str
- The customer who received this quote. A customer is required to finalize the quote. Once specified, you can't change it.
- customer_
account str - 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_ Sequence[str]rates - The tax rates applied to this quote.
- description str
- A description that will be displayed on the quote PDF.
- discounts
Sequence[Quote
Discount Args] - The discounts applied to this quote.
- expires_
at float - The date on which the quote will be canceled if in
openordraftstatus. Measured in seconds since the Unix epoch. - str
- A footer that will be displayed on the quote PDF.
- from_
quote QuoteFrom Quote Args - Details of the quote that was cloned. See the cloning documentation for more details.
- header str
- A header that will be displayed on the quote PDF.
- invoice_
settings QuoteInvoice Settings Args - line_
items Sequence[QuoteLine Item Args] - A list of items the customer is being quoted for.
- metadata Mapping[str, str]
- Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- on_
behalf_ strof - The account on behalf of which to charge. See the Connect documentation for details.
- subscription_
data QuoteSubscription Data Args - test_
clock str - ID of the test clock this quote belongs to.
- transfer_
data QuoteTransfer Data Args - 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.
- application
Fee NumberAmount - 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 NumberPercent - 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 Property Map - collection
Method String - Either
charge_automatically, orsend_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 asactive. Defaults tocharge_automatically. - customer String
- 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 List<String>Rates - The tax rates applied to this quote.
- description String
- A description that will be displayed on the quote PDF.
- discounts List<Property Map>
- The discounts applied to this quote.
- expires
At Number - The date on which the quote will be canceled if in
openordraftstatus. Measured in seconds since the Unix epoch. - String
- A footer that will be displayed on the quote PDF.
- from
Quote Property Map - Details of the quote that was cloned. See the cloning documentation for more details.
- header String
- A header that will be displayed on the quote PDF.
- invoice
Settings Property Map - line
Items List<Property Map> - A list of items the customer is being quoted for.
- metadata Map<String>
- Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- on
Behalf StringOf - The account on behalf of which to charge. See the Connect documentation for details.
- subscription
Data Property Map - test
Clock String - ID of the test clock this quote belongs to.
- transfer
Data Property Map - 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.
Outputs
All input properties are implicitly available as output properties. Additionally, the Quote resource produces the following output properties:
- Application string
- ID of the Connect Application that created the quote.
- Created double
- Time at which the object was created. Measured in seconds since the Unix epoch.
- Currency string
- Three-letter ISO currency code, in lowercase. Must be a supported currency.
- Id string
- The provider-assigned unique ID for this managed resource.
- Invoice string
- The invoice that was created from this quote.
- Livemode bool
- If the object exists in live mode, the value is
true. If the object exists in test mode, the value isfalse. - Number string
- A unique number that identifies this particular quote. This number is assigned once the quote is finalized.
- Object string
- String representing the object's type. Objects of the same type share the same value.
- Status string
- The status of the quote.
- Status
Transitions QuoteStatus Transitions - Subscription string
- The subscription that was created or updated from this quote.
- Subscription
Schedule string - The subscription schedule that was created or updated from this quote.
- Total
Details QuoteTotal Details
- Application string
- ID of the Connect Application that created the quote.
- Created float64
- Time at which the object was created. Measured in seconds since the Unix epoch.
- Currency string
- Three-letter ISO currency code, in lowercase. Must be a supported currency.
- Id string
- The provider-assigned unique ID for this managed resource.
- Invoice string
- The invoice that was created from this quote.
- Livemode bool
- If the object exists in live mode, the value is
true. If the object exists in test mode, the value isfalse. - Number string
- A unique number that identifies this particular quote. This number is assigned once the quote is finalized.
- Object string
- String representing the object's type. Objects of the same type share the same value.
- Status string
- The status of the quote.
- Status
Transitions QuoteStatus Transitions - Subscription string
- The subscription that was created or updated from this quote.
- Subscription
Schedule string - The subscription schedule that was created or updated from this quote.
- Total
Details QuoteTotal Details
- application string
- ID of the Connect Application that created the quote.
- created number
- Time at which the object was created. Measured in seconds since the Unix epoch.
- currency string
- Three-letter ISO currency code, in lowercase. Must be a supported currency.
- id string
- The provider-assigned unique ID for this managed resource.
- invoice string
- The invoice that was created from this quote.
- livemode bool
- If the object exists in live mode, the value is
true. If the object exists in test mode, the value isfalse. - number string
- A unique number that identifies this particular quote. This number is assigned once the quote is finalized.
- object string
- String representing the object's type. Objects of the same type share the same value.
- status string
- The status of the quote.
- status_
transitions object - subscription string
- The subscription that was created or updated from this quote.
- subscription_
schedule string - The subscription schedule that was created or updated from this quote.
- total_
details object
- application String
- ID of the Connect Application that created the quote.
- created Double
- Time at which the object was created. Measured in seconds since the Unix epoch.
- currency String
- Three-letter ISO currency code, in lowercase. Must be a supported currency.
- id String
- The provider-assigned unique ID for this managed resource.
- invoice String
- The invoice that was created from this quote.
- livemode Boolean
- If the object exists in live mode, the value is
true. If the object exists in test mode, the value isfalse. - number String
- A unique number that identifies this particular quote. This number is assigned once the quote is finalized.
- object String
- String representing the object's type. Objects of the same type share the same value.
- status String
- The status of the quote.
- status
Transitions QuoteStatus Transitions - subscription String
- The subscription that was created or updated from this quote.
- subscription
Schedule String - The subscription schedule that was created or updated from this quote.
- total
Details QuoteTotal Details
- application string
- ID of the Connect Application that created the quote.
- created number
- Time at which the object was created. Measured in seconds since the Unix epoch.
- currency string
- Three-letter ISO currency code, in lowercase. Must be a supported currency.
- id string
- The provider-assigned unique ID for this managed resource.
- invoice string
- The invoice that was created from this quote.
- livemode boolean
- If the object exists in live mode, the value is
true. If the object exists in test mode, the value isfalse. - number string
- A unique number that identifies this particular quote. This number is assigned once the quote is finalized.
- object string
- String representing the object's type. Objects of the same type share the same value.
- status string
- The status of the quote.
- status
Transitions QuoteStatus Transitions - subscription string
- The subscription that was created or updated from this quote.
- subscription
Schedule string - The subscription schedule that was created or updated from this quote.
- total
Details QuoteTotal Details
- application str
- ID of the Connect Application that created the quote.
- created float
- Time at which the object was created. Measured in seconds since the Unix epoch.
- currency str
- Three-letter ISO currency code, in lowercase. Must be a supported currency.
- id str
- The provider-assigned unique ID for this managed resource.
- invoice str
- The invoice that was created from this quote.
- livemode bool
- If the object exists in live mode, the value is
true. If the object exists in test mode, the value isfalse. - number str
- A unique number that identifies this particular quote. This number is assigned once the quote is finalized.
- object str
- String representing the object's type. Objects of the same type share the same value.
- status str
- The status of the quote.
- status_
transitions QuoteStatus Transitions - subscription str
- The subscription that was created or updated from this quote.
- subscription_
schedule str - The subscription schedule that was created or updated from this quote.
- total_
details QuoteTotal Details
- application String
- ID of the Connect Application that created the quote.
- created Number
- Time at which the object was created. Measured in seconds since the Unix epoch.
- currency String
- Three-letter ISO currency code, in lowercase. Must be a supported currency.
- id String
- The provider-assigned unique ID for this managed resource.
- invoice String
- The invoice that was created from this quote.
- livemode Boolean
- If the object exists in live mode, the value is
true. If the object exists in test mode, the value isfalse. - number String
- A unique number that identifies this particular quote. This number is assigned once the quote is finalized.
- object String
- String representing the object's type. Objects of the same type share the same value.
- status String
- The status of the quote.
- status
Transitions Property Map - subscription String
- The subscription that was created or updated from this quote.
- subscription
Schedule String - The subscription schedule that was created or updated from this quote.
- total
Details Property Map
Look up Existing Quote Resource
Get an existing Quote resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: QuoteState, opts?: CustomResourceOptions): Quote@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
application: Optional[str] = None,
application_fee_amount: Optional[float] = None,
application_fee_percent: Optional[float] = None,
automatic_tax: Optional[QuoteAutomaticTaxArgs] = None,
collection_method: Optional[str] = None,
created: Optional[float] = None,
currency: Optional[str] = None,
customer: Optional[str] = None,
customer_account: Optional[str] = None,
default_tax_rates: Optional[Sequence[str]] = None,
description: Optional[str] = None,
discounts: Optional[Sequence[QuoteDiscountArgs]] = None,
expires_at: Optional[float] = None,
footer: Optional[str] = None,
from_quote: Optional[QuoteFromQuoteArgs] = None,
header: Optional[str] = None,
invoice: Optional[str] = None,
invoice_settings: Optional[QuoteInvoiceSettingsArgs] = None,
line_items: Optional[Sequence[QuoteLineItemArgs]] = None,
livemode: Optional[bool] = None,
metadata: Optional[Mapping[str, str]] = None,
number: Optional[str] = None,
object: Optional[str] = None,
on_behalf_of: Optional[str] = None,
status: Optional[str] = None,
status_transitions: Optional[QuoteStatusTransitionsArgs] = None,
subscription: Optional[str] = None,
subscription_data: Optional[QuoteSubscriptionDataArgs] = None,
subscription_schedule: Optional[str] = None,
test_clock: Optional[str] = None,
total_details: Optional[QuoteTotalDetailsArgs] = None,
transfer_data: Optional[QuoteTransferDataArgs] = None) -> Quotefunc GetQuote(ctx *Context, name string, id IDInput, state *QuoteState, opts ...ResourceOption) (*Quote, error)public static Quote Get(string name, Input<string> id, QuoteState? state, CustomResourceOptions? opts = null)public static Quote get(String name, Output<String> id, QuoteState state, CustomResourceOptions options)resources: _: type: stripe:Quote get: id: ${id}import {
to = stripe_quote.example
id = "${id}"
}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Application string
- ID of the Connect Application that created the quote.
- Application
Fee doubleAmount - 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 doublePercent - 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 QuoteAutomatic Tax - Collection
Method string - Either
charge_automatically, orsend_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 asactive. Defaults tocharge_automatically. - Created double
- Time at which the object was created. Measured in seconds since the Unix epoch.
- Currency string
- Three-letter ISO currency code, in lowercase. Must be a supported currency.
- Customer string
- 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 List<string>Rates - The tax rates applied to this quote.
- Description string
- A description that will be displayed on the quote PDF.
- Discounts
List<Quote
Discount> - The discounts applied to this quote.
- Expires
At double - The date on which the quote will be canceled if in
openordraftstatus. Measured in seconds since the Unix epoch. - string
- A footer that will be displayed on the quote PDF.
- From
Quote QuoteFrom Quote - Details of the quote that was cloned. See the cloning documentation for more details.
- Header string
- A header that will be displayed on the quote PDF.
- Invoice string
- The invoice that was created from this quote.
- Invoice
Settings QuoteInvoice Settings - Line
Items List<QuoteLine Item> - A list of items the customer is being quoted for.
- Livemode bool
- If the object exists in live mode, the value is
true. If the object exists in test mode, the value isfalse. - Metadata Dictionary<string, string>
- Set of key-value pairs 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.
- Object string
- String representing the object's type. Objects of the same type share the same value.
- On
Behalf stringOf - The account on behalf of which to charge. See the Connect documentation for details.
- Status string
- The status of the quote.
- Status
Transitions QuoteStatus Transitions - Subscription string
- The subscription that was created or updated from this quote.
- Subscription
Data QuoteSubscription Data - Subscription
Schedule string - The subscription schedule that was created or updated from this quote.
- Test
Clock string - ID of the test clock this quote belongs to.
- Total
Details QuoteTotal Details - Transfer
Data QuoteTransfer Data - 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.
- Application string
- ID of the Connect Application that created the quote.
- Application
Fee float64Amount - 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 float64Percent - 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 QuoteAutomatic Tax Args - Collection
Method string - Either
charge_automatically, orsend_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 asactive. Defaults tocharge_automatically. - Created float64
- Time at which the object was created. Measured in seconds since the Unix epoch.
- Currency string
- Three-letter ISO currency code, in lowercase. Must be a supported currency.
- Customer string
- 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 []stringRates - The tax rates applied to this quote.
- Description string
- A description that will be displayed on the quote PDF.
- Discounts
[]Quote
Discount Args - The discounts applied to this quote.
- Expires
At float64 - The date on which the quote will be canceled if in
openordraftstatus. Measured in seconds since the Unix epoch. - string
- A footer that will be displayed on the quote PDF.
- From
Quote QuoteFrom Quote Args - Details of the quote that was cloned. See the cloning documentation for more details.
- Header string
- A header that will be displayed on the quote PDF.
- Invoice string
- The invoice that was created from this quote.
- Invoice
Settings QuoteInvoice Settings Args - Line
Items []QuoteLine Item Args - A list of items the customer is being quoted for.
- Livemode bool
- If the object exists in live mode, the value is
true. If the object exists in test mode, the value isfalse. - Metadata map[string]string
- Set of key-value pairs 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.
- Object string
- String representing the object's type. Objects of the same type share the same value.
- On
Behalf stringOf - The account on behalf of which to charge. See the Connect documentation for details.
- Status string
- The status of the quote.
- Status
Transitions QuoteStatus Transitions Args - Subscription string
- The subscription that was created or updated from this quote.
- Subscription
Data QuoteSubscription Data Args - Subscription
Schedule string - The subscription schedule that was created or updated from this quote.
- Test
Clock string - ID of the test clock this quote belongs to.
- Total
Details QuoteTotal Details Args - Transfer
Data QuoteTransfer Data Args - 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.
- application string
- ID of the Connect Application that created the quote.
- application_
fee_ numberamount - 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_ numberpercent - 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 object - collection_
method string - Either
charge_automatically, orsend_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 asactive. Defaults tocharge_automatically. - created number
- Time at which the object was created. Measured in seconds since the Unix epoch.
- currency string
- Three-letter ISO currency code, in lowercase. Must be a supported currency.
- customer string
- 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_ list(string)rates - The tax rates applied to this quote.
- description string
- A description that will be displayed on the quote PDF.
- discounts list(object)
- The discounts applied to this quote.
- expires_
at number - The date on which the quote will be canceled if in
openordraftstatus. Measured in seconds since the Unix epoch. - string
- A footer that will be displayed on the quote PDF.
- from_
quote object - Details of the quote that was cloned. See the cloning documentation for more details.
- header string
- A header that will be displayed on the quote PDF.
- invoice string
- The invoice that was created from this quote.
- invoice_
settings object - line_
items list(object) - A list of items the customer is being quoted for.
- livemode bool
- If the object exists in live mode, the value is
true. If the object exists in test mode, the value isfalse. - metadata map(string)
- Set of key-value pairs 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.
- object string
- String representing the object's type. Objects of the same type share the same value.
- on_
behalf_ stringof - The account on behalf of which to charge. See the Connect documentation for details.
- status string
- The status of the quote.
- status_
transitions object - subscription string
- The subscription that was created or updated from this quote.
- subscription_
data object - subscription_
schedule string - The subscription schedule that was created or updated from this quote.
- test_
clock string - ID of the test clock this quote belongs to.
- total_
details object - transfer_
data object - 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.
- application String
- ID of the Connect Application that created the quote.
- application
Fee DoubleAmount - 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 DoublePercent - 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 QuoteAutomatic Tax - collection
Method String - Either
charge_automatically, orsend_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 asactive. Defaults tocharge_automatically. - created Double
- Time at which the object was created. Measured in seconds since the Unix epoch.
- currency String
- Three-letter ISO currency code, in lowercase. Must be a supported currency.
- customer String
- 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 List<String>Rates - The tax rates applied to this quote.
- description String
- A description that will be displayed on the quote PDF.
- discounts
List<Quote
Discount> - The discounts applied to this quote.
- expires
At Double - The date on which the quote will be canceled if in
openordraftstatus. Measured in seconds since the Unix epoch. - String
- A footer that will be displayed on the quote PDF.
- from
Quote QuoteFrom Quote - Details of the quote that was cloned. See the cloning documentation for more details.
- header String
- A header that will be displayed on the quote PDF.
- invoice String
- The invoice that was created from this quote.
- invoice
Settings QuoteInvoice Settings - line
Items List<QuoteLine Item> - A list of items the customer is being quoted for.
- livemode Boolean
- If the object exists in live mode, the value is
true. If the object exists in test mode, the value isfalse. - metadata Map<String,String>
- Set of key-value pairs 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.
- object String
- String representing the object's type. Objects of the same type share the same value.
- on
Behalf StringOf - The account on behalf of which to charge. See the Connect documentation for details.
- status String
- The status of the quote.
- status
Transitions QuoteStatus Transitions - subscription String
- The subscription that was created or updated from this quote.
- subscription
Data QuoteSubscription Data - subscription
Schedule String - The subscription schedule that was created or updated from this quote.
- test
Clock String - ID of the test clock this quote belongs to.
- total
Details QuoteTotal Details - transfer
Data QuoteTransfer Data - 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.
- application string
- ID of the Connect Application that created the quote.
- application
Fee numberAmount - 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 numberPercent - 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 QuoteAutomatic Tax - collection
Method string - Either
charge_automatically, orsend_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 asactive. Defaults tocharge_automatically. - created number
- Time at which the object was created. Measured in seconds since the Unix epoch.
- currency string
- Three-letter ISO currency code, in lowercase. Must be a supported currency.
- customer string
- 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 string[]Rates - The tax rates applied to this quote.
- description string
- A description that will be displayed on the quote PDF.
- discounts
Quote
Discount[] - The discounts applied to this quote.
- expires
At number - The date on which the quote will be canceled if in
openordraftstatus. Measured in seconds since the Unix epoch. - string
- A footer that will be displayed on the quote PDF.
- from
Quote QuoteFrom Quote - Details of the quote that was cloned. See the cloning documentation for more details.
- header string
- A header that will be displayed on the quote PDF.
- invoice string
- The invoice that was created from this quote.
- invoice
Settings QuoteInvoice Settings - line
Items QuoteLine Item[] - A list of items the customer is being quoted for.
- livemode boolean
- If the object exists in live mode, the value is
true. If the object exists in test mode, the value isfalse. - metadata {[key: string]: string}
- Set of key-value pairs 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.
- object string
- String representing the object's type. Objects of the same type share the same value.
- on
Behalf stringOf - The account on behalf of which to charge. See the Connect documentation for details.
- status string
- The status of the quote.
- status
Transitions QuoteStatus Transitions - subscription string
- The subscription that was created or updated from this quote.
- subscription
Data QuoteSubscription Data - subscription
Schedule string - The subscription schedule that was created or updated from this quote.
- test
Clock string - ID of the test clock this quote belongs to.
- total
Details QuoteTotal Details - transfer
Data QuoteTransfer Data - 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.
- application str
- ID of the Connect Application that created the quote.
- application_
fee_ floatamount - 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_ floatpercent - 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 QuoteAutomatic Tax Args - collection_
method str - Either
charge_automatically, orsend_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 asactive. Defaults tocharge_automatically. - created float
- Time at which the object was created. Measured in seconds since the Unix epoch.
- currency str
- Three-letter ISO currency code, in lowercase. Must be a supported currency.
- customer str
- The customer who received this quote. A customer is required to finalize the quote. Once specified, you can't change it.
- customer_
account str - 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_ Sequence[str]rates - The tax rates applied to this quote.
- description str
- A description that will be displayed on the quote PDF.
- discounts
Sequence[Quote
Discount Args] - The discounts applied to this quote.
- expires_
at float - The date on which the quote will be canceled if in
openordraftstatus. Measured in seconds since the Unix epoch. - str
- A footer that will be displayed on the quote PDF.
- from_
quote QuoteFrom Quote Args - Details of the quote that was cloned. See the cloning documentation for more details.
- header str
- A header that will be displayed on the quote PDF.
- invoice str
- The invoice that was created from this quote.
- invoice_
settings QuoteInvoice Settings Args - line_
items Sequence[QuoteLine Item Args] - A list of items the customer is being quoted for.
- livemode bool
- If the object exists in live mode, the value is
true. If the object exists in test mode, the value isfalse. - metadata Mapping[str, str]
- Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- number str
- A unique number that identifies this particular quote. This number is assigned once the quote is finalized.
- object str
- String representing the object's type. Objects of the same type share the same value.
- on_
behalf_ strof - The account on behalf of which to charge. See the Connect documentation for details.
- status str
- The status of the quote.
- status_
transitions QuoteStatus Transitions Args - subscription str
- The subscription that was created or updated from this quote.
- subscription_
data QuoteSubscription Data Args - subscription_
schedule str - The subscription schedule that was created or updated from this quote.
- test_
clock str - ID of the test clock this quote belongs to.
- total_
details QuoteTotal Details Args - transfer_
data QuoteTransfer Data Args - 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.
- application String
- ID of the Connect Application that created the quote.
- application
Fee NumberAmount - 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 NumberPercent - 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 Property Map - collection
Method String - Either
charge_automatically, orsend_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 asactive. Defaults tocharge_automatically. - created Number
- Time at which the object was created. Measured in seconds since the Unix epoch.
- currency String
- Three-letter ISO currency code, in lowercase. Must be a supported currency.
- customer String
- 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 List<String>Rates - The tax rates applied to this quote.
- description String
- A description that will be displayed on the quote PDF.
- discounts List<Property Map>
- The discounts applied to this quote.
- expires
At Number - The date on which the quote will be canceled if in
openordraftstatus. Measured in seconds since the Unix epoch. - String
- A footer that will be displayed on the quote PDF.
- from
Quote Property Map - Details of the quote that was cloned. See the cloning documentation for more details.
- header String
- A header that will be displayed on the quote PDF.
- invoice String
- The invoice that was created from this quote.
- invoice
Settings Property Map - line
Items List<Property Map> - A list of items the customer is being quoted for.
- livemode Boolean
- If the object exists in live mode, the value is
true. If the object exists in test mode, the value isfalse. - metadata Map<String>
- Set of key-value pairs 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.
- object String
- String representing the object's type. Objects of the same type share the same value.
- on
Behalf StringOf - The account on behalf of which to charge. See the Connect documentation for details.
- status String
- The status of the quote.
- status
Transitions Property Map - subscription String
- The subscription that was created or updated from this quote.
- subscription
Data Property Map - subscription
Schedule String - The subscription schedule that was created or updated from this quote.
- test
Clock String - ID of the test clock this quote belongs to.
- total
Details Property Map - transfer
Data Property Map - 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.
Supporting Types
QuoteAutomaticTax, QuoteAutomaticTaxArgs
- Enabled bool
- Automatically calculate taxes
- Liability
Quote
Automatic Tax Liability - The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
- Provider string
- The tax provider powering automatic tax.
- Status string
- The status of the most recent automated tax calculation for this quote.
- Enabled bool
- Automatically calculate taxes
- Liability
Quote
Automatic Tax Liability - The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
- Provider string
- The tax provider powering automatic tax.
- Status string
- The status of the most recent automated tax calculation for this quote.
- enabled bool
- Automatically calculate taxes
- liability object
- The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
- provider string
- The tax provider powering automatic tax.
- status string
- The status of the most recent automated tax calculation for this quote.
- enabled Boolean
- Automatically calculate taxes
- liability
Quote
Automatic Tax Liability - The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
- provider String
- The tax provider powering automatic tax.
- status String
- The status of the most recent automated tax calculation for this quote.
- enabled boolean
- Automatically calculate taxes
- liability
Quote
Automatic Tax Liability - The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
- provider string
- The tax provider powering automatic tax.
- status string
- The status of the most recent automated tax calculation for this quote.
- enabled bool
- Automatically calculate taxes
- liability
Quote
Automatic Tax Liability - The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
- provider str
- The tax provider powering automatic tax.
- status str
- The status of the most recent automated tax calculation for this quote.
- enabled Boolean
- Automatically calculate taxes
- liability Property Map
- The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
- provider String
- The tax provider powering automatic tax.
- status String
- The status of the most recent automated tax calculation for this quote.
QuoteAutomaticTaxLiability, QuoteAutomaticTaxLiabilityArgs
QuoteDiscount, QuoteDiscountArgs
- Coupon string
- ID of the coupon to create a new discount for.
- Discount string
- ID of an existing discount on the object (or one of its ancestors) to reuse.
- Promotion
Code string - ID of the promotion code to create a new discount for.
- Coupon string
- ID of the coupon to create a new discount for.
- Discount string
- ID of an existing discount on the object (or one of its ancestors) to reuse.
- Promotion
Code string - ID of the promotion code to create a new discount for.
- coupon string
- ID of the coupon to create a new discount for.
- discount string
- ID of an existing discount on the object (or one of its ancestors) to reuse.
- promotion_
code string - ID of the promotion code to create a new discount for.
- coupon String
- ID of the coupon to create a new discount for.
- discount String
- ID of an existing discount on the object (or one of its ancestors) to reuse.
- promotion
Code String - ID of the promotion code to create a new discount for.
- coupon string
- ID of the coupon to create a new discount for.
- discount string
- ID of an existing discount on the object (or one of its ancestors) to reuse.
- promotion
Code string - ID of the promotion code to create a new discount for.
- coupon str
- ID of the coupon to create a new discount for.
- discount str
- ID of an existing discount on the object (or one of its ancestors) to reuse.
- promotion_
code str - ID of the promotion code to create a new discount for.
- coupon String
- ID of the coupon to create a new discount for.
- discount String
- ID of an existing discount on the object (or one of its ancestors) to reuse.
- promotion
Code String - ID of the promotion code to create a new discount for.
QuoteFromQuote, QuoteFromQuoteArgs
- Quote string
- The quote that was cloned.
- Is
Revision bool - Whether this quote is a revision of a different quote.
- Quote string
- The quote that was cloned.
- Is
Revision bool - Whether this quote is a revision of a different quote.
- quote string
- The quote that was cloned.
- is_
revision bool - Whether this quote is a revision of a different quote.
- quote String
- The quote that was cloned.
- is
Revision Boolean - Whether this quote is a revision of a different quote.
- quote string
- The quote that was cloned.
- is
Revision boolean - Whether this quote is a revision of a different quote.
- quote str
- The quote that was cloned.
- is_
revision bool - Whether this quote is a revision of a different quote.
- quote String
- The quote that was cloned.
- is
Revision Boolean - Whether this quote is a revision of a different quote.
QuoteInvoiceSettings, QuoteInvoiceSettingsArgs
- Days
Until doubleDue - Number of days within which a customer must pay invoices generated by this quote. This value will be
nullfor quotes wherecollection_method=charge_automatically. - Issuer
Quote
Invoice Settings Issuer
- Days
Until float64Due - Number of days within which a customer must pay invoices generated by this quote. This value will be
nullfor quotes wherecollection_method=charge_automatically. - Issuer
Quote
Invoice Settings Issuer
- days_
until_ numberdue - Number of days within which a customer must pay invoices generated by this quote. This value will be
nullfor quotes wherecollection_method=charge_automatically. - issuer object
- days
Until DoubleDue - Number of days within which a customer must pay invoices generated by this quote. This value will be
nullfor quotes wherecollection_method=charge_automatically. - issuer
Quote
Invoice Settings Issuer
- days
Until numberDue - Number of days within which a customer must pay invoices generated by this quote. This value will be
nullfor quotes wherecollection_method=charge_automatically. - issuer
Quote
Invoice Settings Issuer
- days_
until_ floatdue - Number of days within which a customer must pay invoices generated by this quote. This value will be
nullfor quotes wherecollection_method=charge_automatically. - issuer
Quote
Invoice Settings Issuer
- days
Until NumberDue - Number of days within which a customer must pay invoices generated by this quote. This value will be
nullfor quotes wherecollection_method=charge_automatically. - issuer Property Map
QuoteInvoiceSettingsIssuer, QuoteInvoiceSettingsIssuerArgs
QuoteLineItem, QuoteLineItemArgs
- Discounts
List<Quote
Line Item Discount> - The discounts applied to this line item.
- Price string
- The ID of the price object. One of
priceorprice_datais required. - Price
Data QuoteLine Item Price Data - Data used to generate a new Price object inline. One of
priceorprice_datais required. - Quantity double
- The quantity of the line item.
- Tax
Rates List<string> - The tax rates which apply to the line item. When set, the
default_tax_rateson the quote do not apply to this line item.
- Discounts
[]Quote
Line Item Discount - The discounts applied to this line item.
- Price string
- The ID of the price object. One of
priceorprice_datais required. - Price
Data QuoteLine Item Price Data - Data used to generate a new Price object inline. One of
priceorprice_datais required. - Quantity float64
- The quantity of the line item.
- Tax
Rates []string - The tax rates which apply to the line item. When set, the
default_tax_rateson the quote do not apply to this line item.
- discounts list(object)
- The discounts applied to this line item.
- price string
- The ID of the price object. One of
priceorprice_datais required. - price_
data object - Data used to generate a new Price object inline. One of
priceorprice_datais required. - quantity number
- The quantity of the line item.
- tax_
rates list(string) - The tax rates which apply to the line item. When set, the
default_tax_rateson the quote do not apply to this line item.
- discounts
List<Quote
Line Item Discount> - The discounts applied to this line item.
- price String
- The ID of the price object. One of
priceorprice_datais required. - price
Data QuoteLine Item Price Data - Data used to generate a new Price object inline. One of
priceorprice_datais required. - quantity Double
- The quantity of the line item.
- tax
Rates List<String> - The tax rates which apply to the line item. When set, the
default_tax_rateson the quote do not apply to this line item.
- discounts
Quote
Line Item Discount[] - The discounts applied to this line item.
- price string
- The ID of the price object. One of
priceorprice_datais required. - price
Data QuoteLine Item Price Data - Data used to generate a new Price object inline. One of
priceorprice_datais required. - quantity number
- The quantity of the line item.
- tax
Rates string[] - The tax rates which apply to the line item. When set, the
default_tax_rateson the quote do not apply to this line item.
- discounts
Sequence[Quote
Line Item Discount] - The discounts applied to this line item.
- price str
- The ID of the price object. One of
priceorprice_datais required. - price_
data QuoteLine Item Price Data - Data used to generate a new Price object inline. One of
priceorprice_datais required. - quantity float
- The quantity of the line item.
- tax_
rates Sequence[str] - The tax rates which apply to the line item. When set, the
default_tax_rateson the quote do not apply to this line item.
- discounts List<Property Map>
- The discounts applied to this line item.
- price String
- The ID of the price object. One of
priceorprice_datais required. - price
Data Property Map - Data used to generate a new Price object inline. One of
priceorprice_datais required. - quantity Number
- The quantity of the line item.
- tax
Rates List<String> - The tax rates which apply to the line item. When set, the
default_tax_rateson the quote do not apply to this line item.
QuoteLineItemDiscount, QuoteLineItemDiscountArgs
- Coupon string
- ID of the coupon to create a new discount for.
- Discount string
- ID of an existing discount on the object (or one of its ancestors) to reuse.
- Promotion
Code string - ID of the promotion code to create a new discount for.
- Coupon string
- ID of the coupon to create a new discount for.
- Discount string
- ID of an existing discount on the object (or one of its ancestors) to reuse.
- Promotion
Code string - ID of the promotion code to create a new discount for.
- coupon string
- ID of the coupon to create a new discount for.
- discount string
- ID of an existing discount on the object (or one of its ancestors) to reuse.
- promotion_
code string - ID of the promotion code to create a new discount for.
- coupon String
- ID of the coupon to create a new discount for.
- discount String
- ID of an existing discount on the object (or one of its ancestors) to reuse.
- promotion
Code String - ID of the promotion code to create a new discount for.
- coupon string
- ID of the coupon to create a new discount for.
- discount string
- ID of an existing discount on the object (or one of its ancestors) to reuse.
- promotion
Code string - ID of the promotion code to create a new discount for.
- coupon str
- ID of the coupon to create a new discount for.
- discount str
- ID of an existing discount on the object (or one of its ancestors) to reuse.
- promotion_
code str - ID of the promotion code to create a new discount for.
- coupon String
- ID of the coupon to create a new discount for.
- discount String
- ID of an existing discount on the object (or one of its ancestors) to reuse.
- promotion
Code String - ID of the promotion code to create a new discount for.
QuoteLineItemPriceData, QuoteLineItemPriceDataArgs
- Currency string
- Three-letter ISO currency code, in lowercase. Must be a supported currency.
- Product string
- The ID of the Product that this Price will belong to.
- Recurring
Quote
Line Item Price Data Recurring - The recurring components of a price such as
intervalandinterval_count. - Tax
Behavior string - Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of
inclusive,exclusive, orunspecified. Once specified as eitherinclusiveorexclusive, it cannot be changed. - Unit
Amount double - A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
- Unit
Amount doubleDecimal - Same as
unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one ofunit_amountandunit_amount_decimalcan be set.
- Currency string
- Three-letter ISO currency code, in lowercase. Must be a supported currency.
- Product string
- The ID of the Product that this Price will belong to.
- Recurring
Quote
Line Item Price Data Recurring - The recurring components of a price such as
intervalandinterval_count. - Tax
Behavior string - Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of
inclusive,exclusive, orunspecified. Once specified as eitherinclusiveorexclusive, it cannot be changed. - Unit
Amount float64 - A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
- Unit
Amount float64Decimal - Same as
unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one ofunit_amountandunit_amount_decimalcan be set.
- currency string
- Three-letter ISO currency code, in lowercase. Must be a supported currency.
- product string
- The ID of the Product that this Price will belong to.
- recurring object
- The recurring components of a price such as
intervalandinterval_count. - tax_
behavior string - Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of
inclusive,exclusive, orunspecified. Once specified as eitherinclusiveorexclusive, it cannot be changed. - unit_
amount number - A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
- unit_
amount_ numberdecimal - Same as
unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one ofunit_amountandunit_amount_decimalcan be set.
- currency String
- Three-letter ISO currency code, in lowercase. Must be a supported currency.
- product String
- The ID of the Product that this Price will belong to.
- recurring
Quote
Line Item Price Data Recurring - The recurring components of a price such as
intervalandinterval_count. - tax
Behavior String - Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of
inclusive,exclusive, orunspecified. Once specified as eitherinclusiveorexclusive, it cannot be changed. - unit
Amount Double - A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
- unit
Amount DoubleDecimal - Same as
unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one ofunit_amountandunit_amount_decimalcan be set.
- currency string
- Three-letter ISO currency code, in lowercase. Must be a supported currency.
- product string
- The ID of the Product that this Price will belong to.
- recurring
Quote
Line Item Price Data Recurring - The recurring components of a price such as
intervalandinterval_count. - tax
Behavior string - Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of
inclusive,exclusive, orunspecified. Once specified as eitherinclusiveorexclusive, it cannot be changed. - unit
Amount number - A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
- unit
Amount numberDecimal - Same as
unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one ofunit_amountandunit_amount_decimalcan be set.
- currency str
- Three-letter ISO currency code, in lowercase. Must be a supported currency.
- product str
- The ID of the Product that this Price will belong to.
- recurring
Quote
Line Item Price Data Recurring - The recurring components of a price such as
intervalandinterval_count. - tax_
behavior str - Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of
inclusive,exclusive, orunspecified. Once specified as eitherinclusiveorexclusive, it cannot be changed. - unit_
amount float - A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
- unit_
amount_ floatdecimal - Same as
unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one ofunit_amountandunit_amount_decimalcan be set.
- currency String
- Three-letter ISO currency code, in lowercase. Must be a supported currency.
- product String
- The ID of the Product that this Price will belong to.
- recurring Property Map
- The recurring components of a price such as
intervalandinterval_count. - tax
Behavior String - Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of
inclusive,exclusive, orunspecified. Once specified as eitherinclusiveorexclusive, it cannot be changed. - unit
Amount Number - A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
- unit
Amount NumberDecimal - Same as
unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one ofunit_amountandunit_amount_decimalcan be set.
QuoteLineItemPriceDataRecurring, QuoteLineItemPriceDataRecurringArgs
- Interval string
- Specifies billing frequency. Either
day,week,monthoryear. - Interval
Count double - The number of intervals between subscription billings. For example,
interval=monthandinterval_count=3bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
- Interval string
- Specifies billing frequency. Either
day,week,monthoryear. - Interval
Count float64 - The number of intervals between subscription billings. For example,
interval=monthandinterval_count=3bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
- interval string
- Specifies billing frequency. Either
day,week,monthoryear. - interval_
count number - The number of intervals between subscription billings. For example,
interval=monthandinterval_count=3bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
- interval String
- Specifies billing frequency. Either
day,week,monthoryear. - interval
Count Double - The number of intervals between subscription billings. For example,
interval=monthandinterval_count=3bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
- interval string
- Specifies billing frequency. Either
day,week,monthoryear. - interval
Count number - The number of intervals between subscription billings. For example,
interval=monthandinterval_count=3bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
- interval str
- Specifies billing frequency. Either
day,week,monthoryear. - interval_
count float - The number of intervals between subscription billings. For example,
interval=monthandinterval_count=3bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
- interval String
- Specifies billing frequency. Either
day,week,monthoryear. - interval
Count Number - The number of intervals between subscription billings. For example,
interval=monthandinterval_count=3bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
QuoteStatusTransitions, QuoteStatusTransitionsArgs
- Accepted
At double - The time that the quote was accepted. Measured in seconds since Unix epoch.
- Canceled
At double - The time that the quote was canceled. Measured in seconds since Unix epoch.
- Finalized
At double - The time that the quote was finalized. Measured in seconds since Unix epoch.
- Accepted
At float64 - The time that the quote was accepted. Measured in seconds since Unix epoch.
- Canceled
At float64 - The time that the quote was canceled. Measured in seconds since Unix epoch.
- Finalized
At float64 - The time that the quote was finalized. Measured in seconds since Unix epoch.
- accepted_
at number - The time that the quote was accepted. Measured in seconds since Unix epoch.
- canceled_
at number - The time that the quote was canceled. Measured in seconds since Unix epoch.
- finalized_
at number - The time that the quote was finalized. Measured in seconds since Unix epoch.
- accepted
At Double - The time that the quote was accepted. Measured in seconds since Unix epoch.
- canceled
At Double - The time that the quote was canceled. Measured in seconds since Unix epoch.
- finalized
At Double - The time that the quote was finalized. Measured in seconds since Unix epoch.
- accepted
At number - The time that the quote was accepted. Measured in seconds since Unix epoch.
- canceled
At number - The time that the quote was canceled. Measured in seconds since Unix epoch.
- finalized
At number - The time that the quote was finalized. Measured in seconds since Unix epoch.
- accepted_
at float - The time that the quote was accepted. Measured in seconds since Unix epoch.
- canceled_
at float - The time that the quote was canceled. Measured in seconds since Unix epoch.
- finalized_
at float - The time that the quote was finalized. Measured in seconds since Unix epoch.
- accepted
At Number - The time that the quote was accepted. Measured in seconds since Unix epoch.
- canceled
At Number - The time that the quote was canceled. Measured in seconds since Unix epoch.
- finalized
At Number - The time that the quote was finalized. Measured in seconds since Unix epoch.
QuoteSubscriptionData, QuoteSubscriptionDataArgs
- Billing
Mode QuoteSubscription Data Billing Mode - The billing mode of the quote.
- Description string
- The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
- Effective
Date double - When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. This date is ignored if it is in the past when the quote is accepted. Measured in seconds since the Unix epoch.
- Metadata Dictionary<string, string>
- Set of key-value pairs that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in
line_items, this field will be passed to the resulting subscription'smetadatafield. Ifsubscription_data.effective_dateis used, this field will be passed to the resulting subscription schedule'sphases.metadatafield. Unlike object-level metadata, this field is declarative. Updates will clear prior values. - Trial
Period doubleDays - Integer representing the number of trial period days before the customer is charged for the first time.
- Billing
Mode QuoteSubscription Data Billing Mode - The billing mode of the quote.
- Description string
- The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
- Effective
Date float64 - When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. This date is ignored if it is in the past when the quote is accepted. Measured in seconds since the Unix epoch.
- Metadata map[string]string
- Set of key-value pairs that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in
line_items, this field will be passed to the resulting subscription'smetadatafield. Ifsubscription_data.effective_dateis used, this field will be passed to the resulting subscription schedule'sphases.metadatafield. Unlike object-level metadata, this field is declarative. Updates will clear prior values. - Trial
Period float64Days - Integer representing the number of trial period days before the customer is charged for the first time.
- billing_
mode object - The billing mode of the quote.
- description string
- The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
- effective_
date number - When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. This date is ignored if it is in the past when the quote is accepted. Measured in seconds since the Unix epoch.
- metadata map(string)
- Set of key-value pairs that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in
line_items, this field will be passed to the resulting subscription'smetadatafield. Ifsubscription_data.effective_dateis used, this field will be passed to the resulting subscription schedule'sphases.metadatafield. Unlike object-level metadata, this field is declarative. Updates will clear prior values. - trial_
period_ numberdays - Integer representing the number of trial period days before the customer is charged for the first time.
- billing
Mode QuoteSubscription Data Billing Mode - The billing mode of the quote.
- description String
- The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
- effective
Date Double - When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. This date is ignored if it is in the past when the quote is accepted. Measured in seconds since the Unix epoch.
- metadata Map<String,String>
- Set of key-value pairs that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in
line_items, this field will be passed to the resulting subscription'smetadatafield. Ifsubscription_data.effective_dateis used, this field will be passed to the resulting subscription schedule'sphases.metadatafield. Unlike object-level metadata, this field is declarative. Updates will clear prior values. - trial
Period DoubleDays - Integer representing the number of trial period days before the customer is charged for the first time.
- billing
Mode QuoteSubscription Data Billing Mode - The billing mode of the quote.
- description string
- The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
- effective
Date number - When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. This date is ignored if it is in the past when the quote is accepted. Measured in seconds since the Unix epoch.
- metadata {[key: string]: string}
- Set of key-value pairs that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in
line_items, this field will be passed to the resulting subscription'smetadatafield. Ifsubscription_data.effective_dateis used, this field will be passed to the resulting subscription schedule'sphases.metadatafield. Unlike object-level metadata, this field is declarative. Updates will clear prior values. - trial
Period numberDays - Integer representing the number of trial period days before the customer is charged for the first time.
- billing_
mode QuoteSubscription Data Billing Mode - The billing mode of the quote.
- description str
- The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
- effective_
date float - When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. This date is ignored if it is in the past when the quote is accepted. Measured in seconds since the Unix epoch.
- metadata Mapping[str, str]
- Set of key-value pairs that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in
line_items, this field will be passed to the resulting subscription'smetadatafield. Ifsubscription_data.effective_dateis used, this field will be passed to the resulting subscription schedule'sphases.metadatafield. Unlike object-level metadata, this field is declarative. Updates will clear prior values. - trial_
period_ floatdays - Integer representing the number of trial period days before the customer is charged for the first time.
- billing
Mode Property Map - The billing mode of the quote.
- description String
- The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
- effective
Date Number - When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. This date is ignored if it is in the past when the quote is accepted. Measured in seconds since the Unix epoch.
- metadata Map<String>
- Set of key-value pairs that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in
line_items, this field will be passed to the resulting subscription'smetadatafield. Ifsubscription_data.effective_dateis used, this field will be passed to the resulting subscription schedule'sphases.metadatafield. Unlike object-level metadata, this field is declarative. Updates will clear prior values. - trial
Period NumberDays - Integer representing the number of trial period days before the customer is charged for the first time.
QuoteSubscriptionDataBillingMode, QuoteSubscriptionDataBillingModeArgs
- Type string
- Controls how prorations and invoices for subscriptions are calculated and orchestrated.
- Flexible
Quote
Subscription Data Billing Mode Flexible
- Type string
- Controls how prorations and invoices for subscriptions are calculated and orchestrated.
- Flexible
Quote
Subscription Data Billing Mode Flexible
- type String
- Controls how prorations and invoices for subscriptions are calculated and orchestrated.
- flexible
Quote
Subscription Data Billing Mode Flexible
- type string
- Controls how prorations and invoices for subscriptions are calculated and orchestrated.
- flexible
Quote
Subscription Data Billing Mode Flexible
- type str
- Controls how prorations and invoices for subscriptions are calculated and orchestrated.
- flexible
Quote
Subscription Data Billing Mode Flexible
- type String
- Controls how prorations and invoices for subscriptions are calculated and orchestrated.
- flexible Property Map
QuoteSubscriptionDataBillingModeFlexible, QuoteSubscriptionDataBillingModeFlexibleArgs
- Proration
Discounts string - Controls how invoices and invoice items display proration amounts and discount amounts.
- Proration
Discounts string - Controls how invoices and invoice items display proration amounts and discount amounts.
- proration_
discounts string - Controls how invoices and invoice items display proration amounts and discount amounts.
- proration
Discounts String - Controls how invoices and invoice items display proration amounts and discount amounts.
- proration
Discounts string - Controls how invoices and invoice items display proration amounts and discount amounts.
- proration_
discounts str - Controls how invoices and invoice items display proration amounts and discount amounts.
- proration
Discounts String - Controls how invoices and invoice items display proration amounts and discount amounts.
QuoteTotalDetails, QuoteTotalDetailsArgs
- Amount
Discount double - This is the sum of all the discounts.
- Amount
Shipping double - This is the sum of all the shipping amounts.
- Amount
Tax double - This is the sum of all the tax amounts.
- Breakdown
Quote
Total Details Breakdown
- Amount
Discount float64 - This is the sum of all the discounts.
- Amount
Shipping float64 - This is the sum of all the shipping amounts.
- Amount
Tax float64 - This is the sum of all the tax amounts.
- Breakdown
Quote
Total Details Breakdown
- amount_
discount number - This is the sum of all the discounts.
- amount_
shipping number - This is the sum of all the shipping amounts.
- amount_
tax number - This is the sum of all the tax amounts.
- breakdown object
- amount
Discount Double - This is the sum of all the discounts.
- amount
Shipping Double - This is the sum of all the shipping amounts.
- amount
Tax Double - This is the sum of all the tax amounts.
- breakdown
Quote
Total Details Breakdown
- amount
Discount number - This is the sum of all the discounts.
- amount
Shipping number - This is the sum of all the shipping amounts.
- amount
Tax number - This is the sum of all the tax amounts.
- breakdown
Quote
Total Details Breakdown
- amount_
discount float - This is the sum of all the discounts.
- amount_
shipping float - This is the sum of all the shipping amounts.
- amount_
tax float - This is the sum of all the tax amounts.
- breakdown
Quote
Total Details Breakdown
- amount
Discount Number - This is the sum of all the discounts.
- amount
Shipping Number - This is the sum of all the shipping amounts.
- amount
Tax Number - This is the sum of all the tax amounts.
- breakdown Property Map
QuoteTotalDetailsBreakdown, QuoteTotalDetailsBreakdownArgs
- Discounts
List<Quote
Total Details Breakdown Discount> - The aggregated discounts.
- Taxes
List<Quote
Total Details Breakdown Tax> - The aggregated tax amounts by rate.
- Discounts
[]Quote
Total Details Breakdown Discount - The aggregated discounts.
- Taxes
[]Quote
Total Details Breakdown Tax - The aggregated tax amounts by rate.
- discounts list(object)
- The aggregated discounts.
- taxes list(object)
- The aggregated tax amounts by rate.
- discounts
List<Quote
Total Details Breakdown Discount> - The aggregated discounts.
- taxes
List<Quote
Total Details Breakdown Tax> - The aggregated tax amounts by rate.
- discounts
Quote
Total Details Breakdown Discount[] - The aggregated discounts.
- taxes
Quote
Total Details Breakdown Tax[] - The aggregated tax amounts by rate.
- discounts
Sequence[Quote
Total Details Breakdown Discount] - The aggregated discounts.
- taxes
Sequence[Quote
Total Details Breakdown Tax] - The aggregated tax amounts by rate.
- discounts List<Property Map>
- The aggregated discounts.
- taxes List<Property Map>
- The aggregated tax amounts by rate.
QuoteTotalDetailsBreakdownDiscount, QuoteTotalDetailsBreakdownDiscountArgs
- Amount double
- The amount discounted.
- Discount string
- A discount represents the actual application of a coupon or promotion code. It contains information about when the discount began, when it will end, and what it is applied to.
- Amount float64
- The amount discounted.
- Discount string
- A discount represents the actual application of a coupon or promotion code. It contains information about when the discount began, when it will end, and what it is applied to.
- amount number
- The amount discounted.
- discount string
- A discount represents the actual application of a coupon or promotion code. It contains information about when the discount began, when it will end, and what it is applied to.
- amount Double
- The amount discounted.
- discount String
- A discount represents the actual application of a coupon or promotion code. It contains information about when the discount began, when it will end, and what it is applied to.
- amount number
- The amount discounted.
- discount string
- A discount represents the actual application of a coupon or promotion code. It contains information about when the discount began, when it will end, and what it is applied to.
- amount float
- The amount discounted.
- discount str
- A discount represents the actual application of a coupon or promotion code. It contains information about when the discount began, when it will end, and what it is applied to.
- amount Number
- The amount discounted.
- discount String
- A discount represents the actual application of a coupon or promotion code. It contains information about when the discount began, when it will end, and what it is applied to.
QuoteTotalDetailsBreakdownTax, QuoteTotalDetailsBreakdownTaxArgs
- Amount double
- Amount of tax applied for this rate.
- Rate string
- Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax.
- Taxability
Reason string - The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
- Taxable
Amount double - The amount on which tax is calculated, in cents (or local equivalent).
- Amount float64
- Amount of tax applied for this rate.
- Rate string
- Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax.
- Taxability
Reason string - The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
- Taxable
Amount float64 - The amount on which tax is calculated, in cents (or local equivalent).
- amount number
- Amount of tax applied for this rate.
- rate string
- Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax.
- taxability_
reason string - The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
- taxable_
amount number - The amount on which tax is calculated, in cents (or local equivalent).
- amount Double
- Amount of tax applied for this rate.
- rate String
- Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax.
- taxability
Reason String - The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
- taxable
Amount Double - The amount on which tax is calculated, in cents (or local equivalent).
- amount number
- Amount of tax applied for this rate.
- rate string
- Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax.
- taxability
Reason string - The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
- taxable
Amount number - The amount on which tax is calculated, in cents (or local equivalent).
- amount float
- Amount of tax applied for this rate.
- rate str
- Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax.
- taxability_
reason str - The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
- taxable_
amount float - The amount on which tax is calculated, in cents (or local equivalent).
- amount Number
- Amount of tax applied for this rate.
- rate String
- Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax.
- taxability
Reason String - The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
- taxable
Amount Number - The amount on which tax is calculated, in cents (or local equivalent).
QuoteTransferData, QuoteTransferDataArgs
- Destination string
- The account where funds from the payment will be transferred to upon payment success.
- Amount double
- The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination.
- Amount
Percent double - 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 destination account. By default, the entire amount will be transferred to the destination.
- Destination string
- The account where funds from the payment will be transferred to upon payment success.
- Amount float64
- The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination.
- Amount
Percent float64 - 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 destination account. By default, the entire amount will be transferred to the destination.
- destination string
- The account where funds from the payment will be transferred to upon payment success.
- amount number
- The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination.
- amount_
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 destination account. By default, the entire amount will be transferred to the destination.
- destination String
- The account where funds from the payment will be transferred to upon payment success.
- amount Double
- The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination.
- amount
Percent Double - 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 destination account. By default, the entire amount will be transferred to the destination.
- destination string
- The account where funds from the payment will be transferred to upon payment success.
- amount number
- The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination.
- amount
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 destination account. By default, the entire amount will be transferred to the destination.
- destination str
- The account where funds from the payment will be transferred to upon payment success.
- amount float
- The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination.
- amount_
percent float - 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 destination account. By default, the entire amount will be transferred to the destination.
- destination String
- The account where funds from the payment will be transferred to upon payment success.
- amount Number
- The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination.
- amount
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 destination account. By default, the entire amount will be transferred to the destination.
Package Details
- Repository
- stripe stripe/terraform-provider-stripe
- License
- Notes
- This Pulumi package is based on the
stripeTerraform Provider.
published on Friday, Aug 14, 2026 by Pulumi