stripe/resources/
invoice_ext.rs

1use serde::Serialize;
2
3use crate::client::{Client, Response};
4use crate::ids::{CouponId, CustomerId, InvoiceId, PlanId, SubscriptionId, SubscriptionItemId};
5use crate::params::{Metadata, SearchList, Timestamp};
6use crate::resources::{CollectionMethod, Invoice};
7
8#[deprecated(since = "0.12.0")]
9pub type InvoiceCollectionMethod = CollectionMethod;
10
11impl Invoice {
12    /// Retrieves the details of an upcoming invoice_id
13    ///
14    /// For more details see <https://stripe.com/docs/api#upcoming_invoice>.
15    pub fn upcoming(client: &Client, params: RetrieveUpcomingInvoice) -> Response<Invoice> {
16        client.get_query("/invoices/upcoming", &params)
17    }
18
19    /// Finalizes an invoice.
20    ///
21    /// For more details see <https://stripe.com/docs/api/invoices/finalize.>.
22    pub fn finalize(
23        client: &Client,
24        invoice_id: &InvoiceId,
25        params: FinalizeInvoiceParams,
26    ) -> Response<Invoice> {
27        client.post_form(&format!("/invoices/{}/finalize", invoice_id), params)
28    }
29
30    /// Pays an invoice.
31    ///
32    /// For more details see <https://stripe.com/docs/api#pay_invoice.>.
33    pub fn pay(client: &Client, invoice_id: &InvoiceId) -> Response<Invoice> {
34        client.post(&format!("/invoices/{}/pay", invoice_id))
35    }
36
37    /// Searches for an invoice.
38    ///
39    /// For more details see <https://stripe.com/docs/api/invoices/search>.
40    pub fn search(client: &Client, params: InvoiceSearchParams) -> Response<SearchList<Invoice>> {
41        client.get_query("/invoices/search", params)
42    }
43
44    /// Voids an invoice.
45    ///
46    /// For more details see <https://stripe.com/docs/api/invoices/void>.
47    pub fn void(client: &Client, invoice_id: &InvoiceId) -> Response<Invoice> {
48        client.post(&format!("/invoices/{}/void", invoice_id))
49    }
50}
51
52#[derive(Clone, Debug, Serialize)]
53pub struct RetrieveUpcomingInvoice {
54    pub customer: CustomerId, // this is a required param
55    #[serde(skip_serializing_if = "Option::is_none")]
56    pub coupon: Option<CouponId>,
57    #[serde(skip_serializing_if = "Option::is_none")]
58    pub subscription: Option<SubscriptionId>,
59    #[serde(skip_serializing_if = "Option::is_none")]
60    pub subscription_items: Option<SubscriptionItemFilter>,
61    #[serde(skip_serializing_if = "Option::is_none")]
62    pub subscription_prorate: Option<bool>,
63    #[serde(skip_serializing_if = "Option::is_none")]
64    pub subscription_proration_date: Option<Timestamp>,
65    #[serde(skip_serializing_if = "Option::is_none")]
66    pub subscription_tax_percent: Option<f64>,
67    #[serde(skip_serializing_if = "Option::is_none")]
68    pub subscription_trial_end: Option<Timestamp>,
69}
70
71impl RetrieveUpcomingInvoice {
72    pub fn new(customer: CustomerId) -> Self {
73        RetrieveUpcomingInvoice {
74            customer,
75            coupon: None,
76            subscription: None,
77            subscription_items: None,
78            subscription_prorate: None,
79            subscription_proration_date: None,
80            subscription_tax_percent: None,
81            subscription_trial_end: None,
82        }
83    }
84}
85
86#[derive(Clone, Debug, Serialize)]
87pub struct SubscriptionItemFilter {
88    #[serde(skip_serializing_if = "Option::is_none")]
89    pub id: Option<SubscriptionItemId>,
90    #[serde(skip_serializing_if = "Option::is_none")]
91    pub deleted: Option<bool>,
92    #[serde(skip_serializing_if = "Option::is_none")]
93    pub metadata: Option<Metadata>,
94    #[serde(skip_serializing_if = "Option::is_none")]
95    pub plan: Option<PlanId>,
96    #[serde(skip_serializing_if = "Option::is_none")]
97    pub quantity: Option<u64>,
98}
99
100#[derive(Clone, Debug, Default, Serialize)]
101pub struct InvoiceSearchParams<'a> {
102    pub query: String,
103    #[serde(skip_serializing_if = "Option::is_none")]
104    pub limit: Option<u64>,
105    #[serde(skip_serializing_if = "Option::is_none")]
106    pub page: Option<u64>,
107    pub expand: &'a [&'a str],
108}
109
110impl<'a> InvoiceSearchParams<'a> {
111    pub fn new() -> InvoiceSearchParams<'a> {
112        InvoiceSearchParams { query: String::new(), limit: None, page: None, expand: &[] }
113    }
114}
115
116#[derive(Clone, Debug, Default, Serialize)]
117pub struct FinalizeInvoiceParams {
118    #[serde(skip_serializing_if = "Option::is_none")]
119    pub auto_advance: Option<bool>,
120}
stripe/resources/invoice_ext.rs

stripe/resources/
invoice_ext.rs
