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
// ======================================
// This file was automatically generated.
// ======================================
use crate::config::{Client, Response};
use crate::ids::{ApplicationFeeId, ChargeId};
use crate::params::{Expand, Expandable, List, Object, RangeQuery, Timestamp};
use crate::resources::{
Account, Application, ApplicationFeeRefund, BalanceTransaction, Charge, Currency,
};
use serde_derive::{Deserialize, Serialize};
/// The resource representing a Stripe "PlatformFee".
///
/// For more details see [https://stripe.com/docs/api/application_fees/object](https://stripe.com/docs/api/application_fees/object).
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct ApplicationFee {
/// Unique identifier for the object.
pub id: ApplicationFeeId,
/// ID of the Stripe account this fee was taken from.
pub account: Expandable<Account>,
/// Amount earned, in %s.
pub amount: i64,
/// Amount in %s refunded (can be less than the amount attribute on the fee if a partial refund was issued).
pub amount_refunded: i64,
/// ID of the Connect application that earned the fee.
pub application: Expandable<Application>,
/// Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds).
#[serde(skip_serializing_if = "Option::is_none")]
pub balance_transaction: Option<Expandable<BalanceTransaction>>,
/// ID of the charge that the application fee was taken from.
pub charge: Expandable<Charge>,
/// 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: Currency,
/// 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,
/// ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter.
#[serde(skip_serializing_if = "Option::is_none")]
pub originating_transaction: Option<Expandable<Charge>>,
/// Whether the fee has been fully refunded.
///
/// If the fee is only partially refunded, this attribute will still be false.
pub refunded: bool,
/// A list of refunds that have been applied to the fee.
pub refunds: List<ApplicationFeeRefund>,
}
impl ApplicationFee {
/// Returns a list of application fees you’ve previously collected.
///
/// The application fees are returned in sorted order, with the most recent fees appearing first.
pub fn list(
client: &Client,
params: ListApplicationFees<'_>,
) -> Response<List<ApplicationFee>> {
client.get_query("/application_fees", ¶ms)
}
/// Retrieves the details of an application fee that your account has collected.
///
/// The same information is returned when refunding the application fee.
pub fn retrieve(
client: &Client,
id: &ApplicationFeeId,
expand: &[&str],
) -> Response<ApplicationFee> {
client.get_query(&format!("/application_fees/{}", id), &Expand { expand })
}
}
impl Object for ApplicationFee {
type Id = ApplicationFeeId;
fn id(&self) -> Self::Id {
self.id.clone()
}
fn object(&self) -> &'static str {
"application_fee"
}
}
/// The parameters for `ApplicationFee::list`.
#[derive(Clone, Debug, Serialize, Default)]
pub struct ListApplicationFees<'a> {
/// Only return application fees for the charge specified by this charge ID.
#[serde(skip_serializing_if = "Option::is_none")]
pub charge: Option<ChargeId>,
#[serde(skip_serializing_if = "Option::is_none")]
pub created: Option<RangeQuery<Timestamp>>,
/// 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<ApplicationFeeId>,
/// 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<ApplicationFeeId>,
}
impl<'a> ListApplicationFees<'a> {
pub fn new() -> Self {
ListApplicationFees {
charge: Default::default(),
created: Default::default(),
ending_before: Default::default(),
expand: Default::default(),
limit: Default::default(),
starting_after: Default::default(),
}
}
}