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

use serde::Serialize;

use crate::client::{Client, Response};
use crate::ids::{CouponId, CustomerId, InvoiceId, PlanId, SubscriptionId, SubscriptionItemId};
use crate::params::{Metadata, SearchList, Timestamp};
use crate::resources::{CollectionMethod, Invoice};

#[deprecated(since = "0.12.0")]
pub type InvoiceCollectionMethod = CollectionMethod;

impl Invoice {
    /// Retrieves the details of an upcoming invoice_id
    ///
    /// For more details see <https://stripe.com/docs/api#upcoming_invoice>.
    pub fn upcoming(client: &Client, params: RetrieveUpcomingInvoice) -> Response<Invoice> {
        client.get_query("/invoices/upcoming", &params)
    }

    /// Finalizes an invoice.
    ///
    /// For more details see <https://stripe.com/docs/api/invoices/finalize.>.
    pub fn finalize(
        client: &Client,
        invoice_id: &InvoiceId,
        params: FinalizeInvoiceParams,
    ) -> Response<Invoice> {
        client.post_form(&format!("/invoices/{}/finalize", invoice_id), params)
    }

    /// Pays an invoice.
    ///
    /// For more details see <https://stripe.com/docs/api#pay_invoice.>.
    pub fn pay(client: &Client, invoice_id: &InvoiceId) -> Response<Invoice> {
        client.post(&format!("/invoices/{}/pay", invoice_id))
    }

    /// Searches for an invoice.
    ///
    /// For more details see <https://stripe.com/docs/api/invoices/search>.
    pub fn search(client: &Client, params: InvoiceSearchParams) -> Response<SearchList<Invoice>> {
        client.get_query("/invoices/search", params)
    }
}

#[derive(Clone, Debug, Serialize)]
pub struct RetrieveUpcomingInvoice {
    pub customer: CustomerId, // this is a required param
    #[serde(skip_serializing_if = "Option::is_none")]
    pub coupon: Option<CouponId>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub subscription: Option<SubscriptionId>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub subscription_items: Option<SubscriptionItemFilter>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub subscription_prorate: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub subscription_proration_date: Option<Timestamp>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub subscription_tax_percent: Option<f64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub subscription_trial_end: Option<Timestamp>,
}

impl RetrieveUpcomingInvoice {
    pub fn new(customer: CustomerId) -> Self {
        RetrieveUpcomingInvoice {
            customer,
            coupon: None,
            subscription: None,
            subscription_items: None,
            subscription_prorate: None,
            subscription_proration_date: None,
            subscription_tax_percent: None,
            subscription_trial_end: None,
        }
    }
}

#[derive(Clone, Debug, Serialize)]
pub struct SubscriptionItemFilter {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub id: Option<SubscriptionItemId>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub deleted: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub metadata: Option<Metadata>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub plan: Option<PlanId>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub quantity: Option<u64>,
}

#[derive(Clone, Debug, Default, Serialize)]
pub struct InvoiceSearchParams<'a> {
    pub query: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub limit: Option<u64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub page: Option<u64>,
    pub expand: &'a [&'a str],
}

impl<'a> InvoiceSearchParams<'a> {
    pub fn new() -> InvoiceSearchParams<'a> {
        InvoiceSearchParams { query: String::new(), limit: None, page: None, expand: &[] }
    }
}

#[derive(Clone, Debug, Default, Serialize)]
pub struct FinalizeInvoiceParams {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub auto_advance: Option<bool>,
}