1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
// ======================================
// This file was automatically generated.
// ======================================
use serde::{Deserialize, Serialize};
use crate::client::{Client, Response};
use crate::ids::{CustomerId, QuoteId};
use crate::params::{Expand, Expandable, List, Metadata, Object, Paginable, Timestamp};
use crate::resources::{
Account, Application, CheckoutSessionItem, ConnectAccountReference, Currency, Customer,
Discount, Invoice, QuotesResourceTotalDetails, Subscription, SubscriptionSchedule, TaxRate,
TestHelpersTestClock,
};
/// The resource representing a Stripe "Quote".
///
/// For more details see <https://stripe.com/docs/api/quotes/object>
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct Quote {
/// Unique identifier for the object.
pub id: QuoteId,
/// Total before any discounts or taxes are applied.
pub amount_subtotal: i64,
/// Total after discounts and taxes are applied.
pub amount_total: i64,
/// ID of the Connect Application that created the quote.
pub application: Option<Expandable<Application>>,
/// 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.
pub application_fee_amount: Option<i64>,
/// 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.
pub application_fee_percent: Option<f64>,
pub automatic_tax: QuotesResourceAutomaticTax,
/// Either `charge_automatically`, or `send_invoice`.
///
/// When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or on finalization using the default payment method attached to the subscription or customer.
/// When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.
/// Defaults to `charge_automatically`.
pub collection_method: QuoteCollectionMethod,
pub computed: QuotesResourceComputed,
/// Time at which the object was created.
///
/// Measured in seconds since the Unix epoch.
pub created: Timestamp,
/// Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
///
/// Must be a [supported currency](https://stripe.com/docs/currencies).
pub currency: Option<Currency>,
/// The customer which this quote belongs to.
///
/// A customer is required before finalizing the quote.
/// Once specified, it cannot be changed.
pub customer: Option<Expandable<Customer>>,
/// The tax rates applied to this quote.
#[serde(skip_serializing_if = "Option::is_none")]
pub default_tax_rates: Option<Vec<Expandable<TaxRate>>>,
/// A description that will be displayed on the quote PDF.
pub description: Option<String>,
/// The discounts applied to this quote.
pub discounts: Vec<Expandable<Discount>>,
/// The date on which the quote will be canceled if in `open` or `draft` status.
///
/// Measured in seconds since the Unix epoch.
pub expires_at: Timestamp,
/// A footer that will be displayed on the quote PDF.
pub footer: Option<String>,
/// Details of the quote that was cloned.
///
/// See the [cloning documentation](https://stripe.com/docs/quotes/clone) for more details.
pub from_quote: Option<QuotesResourceFromQuote>,
/// A header that will be displayed on the quote PDF.
pub header: Option<String>,
/// The invoice that was created from this quote.
pub invoice: Option<Expandable<Invoice>>,
pub invoice_settings: InvoiceSettingQuoteSetting,
/// A list of items the customer is being quoted for.
#[serde(skip_serializing_if = "Option::is_none")]
pub line_items: Option<List<CheckoutSessionItem>>,
/// Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
pub livemode: bool,
/// Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object.
///
/// This can be useful for storing additional information about the object in a structured format.
pub metadata: Metadata,
/// A unique number that identifies this particular quote.
///
/// This number is assigned once the quote is [finalized](https://stripe.com/docs/quotes/overview#finalize).
pub number: Option<String>,
/// The account on behalf of which to charge.
///
/// See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details.
pub on_behalf_of: Option<Expandable<Account>>,
/// The status of the quote.
pub status: QuoteStatus,
pub status_transitions: QuotesResourceStatusTransitions,
/// The subscription that was created or updated from this quote.
pub subscription: Option<Expandable<Subscription>>,
pub subscription_data: QuotesResourceSubscriptionDataSubscriptionData,
/// The subscription schedule that was created or updated from this quote.
pub subscription_schedule: Option<Expandable<SubscriptionSchedule>>,
/// ID of the test clock this quote belongs to.
pub test_clock: Option<Expandable<TestHelpersTestClock>>,
pub total_details: QuotesResourceTotalDetails,
/// 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.
pub transfer_data: Option<QuotesResourceTransferData>,
}
impl Quote {
/// Returns a list of your quotes.
pub fn list(client: &Client, params: &ListQuotes<'_>) -> Response<List<Quote>> {
client.get_query("/quotes", params)
}
/// Retrieves the quote with the given ID.
pub fn retrieve(client: &Client, id: &QuoteId, expand: &[&str]) -> Response<Quote> {
client.get_query(&format!("/quotes/{}", id), Expand { expand })
}
}
impl Object for Quote {
type Id = QuoteId;
fn id(&self) -> Self::Id {
self.id.clone()
}
fn object(&self) -> &'static str {
"quote"
}
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct InvoiceSettingQuoteSetting {
/// Number of days within which a customer must pay invoices generated by this quote.
///
/// This value will be `null` for quotes where `collection_method=charge_automatically`.
pub days_until_due: Option<u32>,
pub issuer: ConnectAccountReference,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct QuotesResourceAutomaticTax {
/// Automatically calculate taxes.
pub enabled: bool,
/// 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.
pub liability: Option<ConnectAccountReference>,
/// The status of the most recent automated tax calculation for this quote.
pub status: Option<QuotesResourceAutomaticTaxStatus>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct QuotesResourceComputed {
/// The definitive totals and line items the customer will be charged on a recurring basis.
///
/// Takes into account the line items with recurring prices and discounts with `duration=forever` coupons only.
/// Defaults to `null` if no inputted line items with recurring prices.
pub recurring: Option<QuotesResourceRecurring>,
pub upfront: QuotesResourceUpfront,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct QuotesResourceFromQuote {
/// Whether this quote is a revision of a different quote.
pub is_revision: bool,
/// The quote that was cloned.
pub quote: Expandable<Quote>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct QuotesResourceRecurring {
/// Total before any discounts or taxes are applied.
pub amount_subtotal: i64,
/// Total after discounts and taxes are applied.
pub amount_total: i64,
/// The frequency at which a subscription is billed.
///
/// One of `day`, `week`, `month` or `year`.
pub interval: QuotesResourceRecurringInterval,
/// The number of intervals (specified in the `interval` attribute) between subscription billings.
///
/// For example, `interval=month` and `interval_count=3` bills every 3 months.
pub interval_count: u64,
pub total_details: QuotesResourceTotalDetails,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct QuotesResourceStatusTransitions {
/// The time that the quote was accepted.
///
/// Measured in seconds since Unix epoch.
pub accepted_at: Option<Timestamp>,
/// The time that the quote was canceled.
///
/// Measured in seconds since Unix epoch.
pub canceled_at: Option<Timestamp>,
/// The time that the quote was finalized.
///
/// Measured in seconds since Unix epoch.
pub finalized_at: Option<Timestamp>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct QuotesResourceSubscriptionDataSubscriptionData {
/// 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.
pub description: Option<String>,
/// 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.
pub effective_date: Option<Timestamp>,
/// Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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's `metadata` field.
/// If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field.
/// Unlike object-level metadata, this field is declarative.
/// Updates will clear prior values.
pub metadata: Option<Metadata>,
/// Integer representing the number of trial period days before the customer is charged for the first time.
pub trial_period_days: Option<u32>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct QuotesResourceTransferData {
/// 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.
pub amount: Option<i64>,
/// 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.
pub amount_percent: Option<f64>,
/// The account where funds from the payment will be transferred to upon payment success.
pub destination: Expandable<Account>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct QuotesResourceUpfront {
/// Total before any discounts or taxes are applied.
pub amount_subtotal: i64,
/// Total after discounts and taxes are applied.
pub amount_total: i64,
/// The line items that will appear on the next invoice after this quote is accepted.
///
/// This does not include pending invoice items that exist on the customer but may still be included in the next invoice.
#[serde(skip_serializing_if = "Option::is_none")]
pub line_items: Option<List<CheckoutSessionItem>>,
pub total_details: QuotesResourceTotalDetails,
}
/// The parameters for `Quote::list`.
#[derive(Clone, Debug, Serialize, Default)]
pub struct ListQuotes<'a> {
/// The ID of the customer whose quotes will be retrieved.
#[serde(skip_serializing_if = "Option::is_none")]
pub customer: Option<CustomerId>,
/// A cursor for use in pagination.
///
/// `ending_before` is an object ID that defines your place in the list.
/// For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
#[serde(skip_serializing_if = "Option::is_none")]
pub ending_before: Option<QuoteId>,
/// Specifies which fields in the response should be expanded.
#[serde(skip_serializing_if = "Expand::is_empty")]
pub expand: &'a [&'a str],
/// A limit on the number of objects to be returned.
///
/// Limit can range between 1 and 100, and the default is 10.
#[serde(skip_serializing_if = "Option::is_none")]
pub limit: Option<u64>,
/// A cursor for use in pagination.
///
/// `starting_after` is an object ID that defines your place in the list.
/// For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
#[serde(skip_serializing_if = "Option::is_none")]
pub starting_after: Option<QuoteId>,
/// The status of the quote.
#[serde(skip_serializing_if = "Option::is_none")]
pub status: Option<QuoteStatus>,
/// Provides a list of quotes that are associated with the specified test clock.
///
/// The response will not include quotes with test clocks if this and the customer parameter is not set.
#[serde(skip_serializing_if = "Option::is_none")]
pub test_clock: Option<&'a str>,
}
impl<'a> ListQuotes<'a> {
pub fn new() -> Self {
ListQuotes {
customer: Default::default(),
ending_before: Default::default(),
expand: Default::default(),
limit: Default::default(),
starting_after: Default::default(),
status: Default::default(),
test_clock: Default::default(),
}
}
}
impl Paginable for ListQuotes<'_> {
type O = Quote;
fn set_last(&mut self, item: Self::O) {
self.starting_after = Some(item.id());
}
}
/// An enum representing the possible values of an `Quote`'s `collection_method` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum QuoteCollectionMethod {
ChargeAutomatically,
SendInvoice,
}
impl QuoteCollectionMethod {
pub fn as_str(self) -> &'static str {
match self {
QuoteCollectionMethod::ChargeAutomatically => "charge_automatically",
QuoteCollectionMethod::SendInvoice => "send_invoice",
}
}
}
impl AsRef<str> for QuoteCollectionMethod {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for QuoteCollectionMethod {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for QuoteCollectionMethod {
fn default() -> Self {
Self::ChargeAutomatically
}
}
/// An enum representing the possible values of an `Quote`'s `status` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum QuoteStatus {
Accepted,
Canceled,
Draft,
Open,
}
impl QuoteStatus {
pub fn as_str(self) -> &'static str {
match self {
QuoteStatus::Accepted => "accepted",
QuoteStatus::Canceled => "canceled",
QuoteStatus::Draft => "draft",
QuoteStatus::Open => "open",
}
}
}
impl AsRef<str> for QuoteStatus {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for QuoteStatus {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for QuoteStatus {
fn default() -> Self {
Self::Accepted
}
}
/// An enum representing the possible values of an `QuotesResourceAutomaticTax`'s `status` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum QuotesResourceAutomaticTaxStatus {
Complete,
Failed,
RequiresLocationInputs,
}
impl QuotesResourceAutomaticTaxStatus {
pub fn as_str(self) -> &'static str {
match self {
QuotesResourceAutomaticTaxStatus::Complete => "complete",
QuotesResourceAutomaticTaxStatus::Failed => "failed",
QuotesResourceAutomaticTaxStatus::RequiresLocationInputs => "requires_location_inputs",
}
}
}
impl AsRef<str> for QuotesResourceAutomaticTaxStatus {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for QuotesResourceAutomaticTaxStatus {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for QuotesResourceAutomaticTaxStatus {
fn default() -> Self {
Self::Complete
}
}
/// An enum representing the possible values of an `QuotesResourceRecurring`'s `interval` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum QuotesResourceRecurringInterval {
Day,
Month,
Week,
Year,
}
impl QuotesResourceRecurringInterval {
pub fn as_str(self) -> &'static str {
match self {
QuotesResourceRecurringInterval::Day => "day",
QuotesResourceRecurringInterval::Month => "month",
QuotesResourceRecurringInterval::Week => "week",
QuotesResourceRecurringInterval::Year => "year",
}
}
}
impl AsRef<str> for QuotesResourceRecurringInterval {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for QuotesResourceRecurringInterval {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for QuotesResourceRecurringInterval {
fn default() -> Self {
Self::Day
}
}