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
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._stripe_service import StripeService
from stripe._util import sanitize_id
from typing import Optional, cast
from typing_extensions import TYPE_CHECKING
if TYPE_CHECKING:
from stripe._invoice_payment import InvoicePayment
from stripe._list_object import ListObject
from stripe._request_options import RequestOptions
from stripe.params._invoice_payment_list_params import (
InvoicePaymentListParams,
)
from stripe.params._invoice_payment_retrieve_params import (
InvoicePaymentRetrieveParams,
)
class InvoicePaymentService(StripeService):
def list(
self,
params: Optional["InvoicePaymentListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "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: Optional["InvoicePaymentListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "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: Optional["InvoicePaymentRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "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: Optional["InvoicePaymentRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "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,
),
)
|
