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
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._request_options import RequestOptions
from typing import List
from typing_extensions import Literal, NotRequired, TypedDict
class InvoicePaymentListParams(RequestOptions):
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["InvoicePaymentListParamsPayment"]
"""
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 InvoicePaymentListParamsPayment(TypedDict):
payment_intent: NotRequired[str]
"""
Only return invoice payments associated by this payment intent ID.
"""
payment_record: NotRequired[str]
"""
Only return invoice payments associated by this payment record ID.
"""
type: Literal["payment_intent", "payment_record"]
"""
Only return invoice payments associated by this payment type.
"""
|