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
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._expandable_field import ExpandableField
from stripe._list_object import ListObject
from stripe._listable_api_resource import ListableAPIResource
from stripe._stripe_object import StripeObject
from typing import ClassVar, Optional
from typing_extensions import Literal, Unpack, TYPE_CHECKING
if TYPE_CHECKING:
from stripe._charge import Charge
from stripe._invoice import Invoice
from stripe._payment_intent import PaymentIntent
from stripe._payment_record import PaymentRecord
from stripe.params._invoice_payment_list_params import (
InvoicePaymentListParams,
)
from stripe.params._invoice_payment_retrieve_params import (
InvoicePaymentRetrieveParams,
)
class InvoicePayment(ListableAPIResource["InvoicePayment"]):
"""
Invoice Payments represent payments made against invoices. Invoice Payments can
be accessed in two ways:
1. By expanding the `payments` field on the [Invoice](https://stripe.com/docs/api#invoice) resource.
2. By using the Invoice Payment retrieve and list endpoints.
Invoice Payments include the mapping between payment objects, such as Payment Intent, and Invoices.
This resource and its endpoints allows you to easily track if a payment is associated with a specific invoice and
monitor the allocation details of the payments.
"""
OBJECT_NAME: ClassVar[Literal["invoice_payment"]] = "invoice_payment"
class Payment(StripeObject):
charge: Optional[ExpandableField["Charge"]]
"""
ID of the successful charge for this payment when `type` is `charge`.Note: charge is only surfaced if the charge object is not associated with a payment intent. If the charge object does have a payment intent, the Invoice Payment surfaces the payment intent instead.
"""
payment_intent: Optional[ExpandableField["PaymentIntent"]]
"""
ID of the PaymentIntent associated with this payment when `type` is `payment_intent`. Note: This property is only populated for invoices finalized on or after March 15th, 2019.
"""
payment_record: Optional[ExpandableField["PaymentRecord"]]
"""
ID of the PaymentRecord associated with this payment when `type` is `payment_record`.
"""
type: Literal["charge", "payment_intent", "payment_record"]
"""
Type of payment object associated with this invoice payment.
"""
class StatusTransitions(StripeObject):
canceled_at: Optional[int]
"""
The time that the payment was canceled.
"""
paid_at: Optional[int]
"""
The time that the payment succeeded.
"""
amount_paid: Optional[int]
"""
Amount that was actually paid for this invoice, in cents (or local equivalent). This field is null until the payment is `paid`. This amount can be less than the `amount_requested` if the PaymentIntent's `amount_received` is not sufficient to pay all of the invoices that it is attached to.
"""
amount_requested: int
"""
Amount intended to be paid toward this invoice, in cents (or local equivalent)
"""
created: int
"""
Time at which the object was created. Measured in seconds since the Unix epoch.
"""
currency: str
"""
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).
"""
id: str
"""
Unique identifier for the object.
"""
invoice: ExpandableField["Invoice"]
"""
The invoice that was paid.
"""
is_default: bool
"""
Stripe automatically creates a default InvoicePayment when the invoice is finalized, and keeps it synchronized with the invoice's `amount_remaining`. The PaymentIntent associated with the default payment can't be edited or canceled directly.
"""
livemode: bool
"""
Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
"""
object: Literal["invoice_payment"]
"""
String representing the object's type. Objects of the same type share the same value.
"""
payment: Payment
status: str
"""
The status of the payment, one of `open`, `paid`, or `canceled`.
"""
status_transitions: StatusTransitions
@classmethod
def list(
cls, **params: Unpack["InvoicePaymentListParams"]
) -> ListObject["InvoicePayment"]:
"""
When retrieving an invoice, there is an includable payments property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of payments.
"""
result = cls._static_request(
"get",
cls.class_url(),
params=params,
)
if not isinstance(result, ListObject):
raise TypeError(
"Expected list object from API, got %s"
% (type(result).__name__)
)
return result
@classmethod
async def list_async(
cls, **params: Unpack["InvoicePaymentListParams"]
) -> ListObject["InvoicePayment"]:
"""
When retrieving an invoice, there is an includable payments property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of payments.
"""
result = await cls._static_request_async(
"get",
cls.class_url(),
params=params,
)
if not isinstance(result, ListObject):
raise TypeError(
"Expected list object from API, got %s"
% (type(result).__name__)
)
return result
@classmethod
def retrieve(
cls, id: str, **params: Unpack["InvoicePaymentRetrieveParams"]
) -> "InvoicePayment":
"""
Retrieves the invoice payment with the given ID.
"""
instance = cls(id, **params)
instance.refresh()
return instance
@classmethod
async def retrieve_async(
cls, id: str, **params: Unpack["InvoicePaymentRetrieveParams"]
) -> "InvoicePayment":
"""
Retrieves the invoice payment with the given ID.
"""
instance = cls(id, **params)
await instance.refresh_async()
return instance
_inner_class_types = {
"payment": Payment,
"status_transitions": StatusTransitions,
}
|
