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
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._invoice_payment import InvoicePayment
from stripe._list_object import ListObject
from stripe._request_options import RequestOptions
from stripe._stripe_service import StripeService
from stripe._util import sanitize_id
from typing import List, cast
from typing_extensions import Literal, NotRequired, TypedDict
class InvoicePaymentService(StripeService):
class ListParams(TypedDict):
ending_before: NotRequired[str]
"""
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.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
invoice: NotRequired[str]
"""
The identifier of the invoice whose payments to return.
"""
limit: NotRequired[int]
"""
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
"""
payment: NotRequired["InvoicePaymentService.ListParamsPayment"]
"""
The payment details of the invoice payments to return.
"""
starting_after: NotRequired[str]
"""
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.
"""
status: NotRequired[Literal["canceled", "open", "paid"]]
"""
The status of the invoice payments to return.
"""
class ListParamsPayment(TypedDict):
payment_intent: NotRequired[str]
"""
Only return invoice payments associated by this payment intent ID.
"""
type: Literal["payment_intent"]
"""
Only return invoice payments associated by this payment type.
"""
class RetrieveParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
def list(
self,
params: "InvoicePaymentService.ListParams" = {},
options: RequestOptions = {},
) -> 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.
"""
return cast(
ListObject[InvoicePayment],
self._request(
"get",
"/v1/invoice_payments",
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
params: "InvoicePaymentService.ListParams" = {},
options: RequestOptions = {},
) -> 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.
"""
return cast(
ListObject[InvoicePayment],
await self._request_async(
"get",
"/v1/invoice_payments",
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
invoice_payment: str,
params: "InvoicePaymentService.RetrieveParams" = {},
options: RequestOptions = {},
) -> InvoicePayment:
"""
Retrieves the invoice payment with the given ID.
"""
return cast(
InvoicePayment,
self._request(
"get",
"/v1/invoice_payments/{invoice_payment}".format(
invoice_payment=sanitize_id(invoice_payment),
),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
invoice_payment: str,
params: "InvoicePaymentService.RetrieveParams" = {},
options: RequestOptions = {},
) -> InvoicePayment:
"""
Retrieves the invoice payment with the given ID.
"""
return cast(
InvoicePayment,
await self._request_async(
"get",
"/v1/invoice_payments/{invoice_payment}".format(
invoice_payment=sanitize_id(invoice_payment),
),
base_address="api",
params=params,
options=options,
),
)
|
