api.md

Shared Types

from stainless_commons_stripe.types import (
    AccountRequirementsError,
    Address,
    Application,
    BillingClocksResourceStatusDetailsAdvancingStatusDetails,
    BillingClocksResourceStatusDetailsStatusDetails,
    DeletedApplication,
    DeletedCustomer,
    DeletedTaxID,
    InvoiceSettingCustomField,
    PaymentFlowsPaymentIntentPresentmentDetails,
    PaymentFlowsPrivatePaymentMethodsCardPresentCommonWallet,
    PaymentMethodDetailsCardInstallmentsPlan,
    PaymentMethodDetailsCardPresent,
    PaymentMethodDetailsCardPresentOffline,
    PaymentMethodDetailsCardPresentReceipt,
    PaymentMethodDetailsPassthroughCard,
    Shipping,
    Source,
    SourceCodeVerificationFlow,
    SourceOrder,
    SourceOrderItem,
    SourceOwner,
    SourceReceiverFlow,
    SourceRedirectFlow,
    SourceTypeACHCreditTransfer,
    SourceTypeACHDebit,
    SourceTypeAcssDebit,
    SourceTypeAlipay,
    SourceTypeAuBecsDebit,
    SourceTypeBancontact,
    SourceTypeCard,
    SourceTypeCardPresent,
    SourceTypeEps,
    SourceTypeGiropay,
    SourceTypeIdeal,
    SourceTypeKlarna,
    SourceTypeMultibanco,
    SourceTypeP24,
    SourceTypeSepaDebit,
    SourceTypeSofort,
    SourceTypeThreeDSecure,
    SourceTypeWechat,
    TaxCode,
    TestHelpersTestClock,
)

Accounts

Types:

from stainless_commons_stripe.types import (
    Account,
    AccountInvoicesSettings,
    AccountRequirementsAlternative,
    AccountSettings,
    LegalEntityJapanAddress,
)

Methods:

• client.accounts.retrieve(**params) -> Account

Balance

Types:

from stainless_commons_stripe.types import (
    BalanceAmount,
    BalanceAmountBySourceType,
    BalanceRetrieveResponse,
)

Methods:

• client.balance.retrieve(**params) -> BalanceRetrieveResponse

Coupons

Types:

from stainless_commons_stripe.types import Coupon

Methods:

• client.coupons.create(**params) -> Coupon
• client.coupons.list(**params) -> SyncMyCursorIDPage[Coupon]

Customers

Types:

from stainless_commons_stripe.types import (
    BankAccount,
    Card,
    Customer,
    Discount,
    InvoiceSetting,
    PromotionCode,
    TaxID,
    TaxIDsOwner,
)

Methods:

• client.customers.create(**params) -> Customer
• client.customers.list(**params) -> SyncMyCursorIDPage[Customer]

Disputes

Types:

from stainless_commons_stripe.types import (
    ApplicationFee,
    BalanceTransaction,
    Charge,
    ChargeTransferData,
    ConnectCollectionTransfer,
    CustomerBalanceResourceCashBalanceTransactionAdjustedForOverdraft,
    CustomerBalanceResourceCashBalanceTransactionAppliedToPayment,
    CustomerBalanceResourceCashBalanceTransactionRefundedFromPayment,
    CustomerBalanceResourceCashBalanceTransactionTransferredToBalance,
    CustomerBalanceResourceCashBalanceTransactionUnappliedFromPayment,
    CustomerCashBalanceTransaction,
    Dispute,
    FeeRefund,
    File,
    FileLink,
    IssuingAuthorization,
    IssuingAuthorizationAmountDetails,
    IssuingCard,
    IssuingCardholder,
    IssuingCardholderAddress,
    IssuingCardholderAuthorizationControls,
    IssuingCardholderCardIssuing,
    IssuingCardholderCompany,
    IssuingCardholderIDDocument,
    IssuingCardholderIndividual,
    IssuingCardholderIndividualDob,
    IssuingCardholderRequirements,
    IssuingCardholderSpendingLimit,
    IssuingCardholderUserTermsAcceptance,
    IssuingCardholderVerification,
    IssuingDispute,
    IssuingTransaction,
    PaymentMethodDetails,
    PaymentMethodDetailsBancontactDispute,
    PaymentMethodDetailsIdealDispute,
    PaymentMethodDetailsSofortDispute,
    PaymentMethodDetailsUsBankAccount,
    Payout,
    Topup,
    Transfer,
)

Methods:

• client.disputes.update(dispute, **params) -> Dispute
• client.disputes.list(**params) -> SyncMyCursorIDPage[Dispute]

Invoices

Types:

from stainless_commons_stripe.types import (
    APIErrors,
    AutomaticTaxInvoice,
    BillingBillResourceInvoicingParentsInvoiceParent,
    BillingBillResourceInvoicingParentsInvoiceSubscriptionParent,
    BillingCreditBalanceTransaction,
    BillingCreditGrant,
    BillingCreditGrantsResourceAmount,
    BillingCreditGrantsResourceBalanceCredit,
    BillingCreditGrantsResourceBalanceCreditsApplicationInvoiceVoided,
    BillingCreditGrantsResourceBalanceCreditsApplied,
    BillingCreditGrantsResourceBalanceDebit,
    BillingCreditGrantsResourceMonetaryAmount,
    ConnectAccountReference,
    DeletedDiscount,
    DiscountsResourceDiscountAmount,
    Invoice,
    InvoicePayment,
    InvoicesPaymentsInvoicePaymentAssociatedPayment,
    InvoicesResourceFromInvoice,
    InvoicesResourcePretaxCreditAmount,
    LineItem,
    PaymentMethod,
    PaymentMethodCard,
    PaymentMethodCardGeneratedCard,
    PaymentMethodDetailsPaymentRecordUsBankAccount,
    PaymentMethodSepaDebit,
    PaymentRecord,
    PaymentsPrimitivesPaymentRecordsResourceAmount,
    PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails,
    SepaDebitGeneratedFrom,
    ShippingRateDeliveryEstimateBound,
    TaxRate,
)

Methods:

• client.invoices.create(**params) -> Invoice
• client.invoices.list(**params) -> SyncMyCursorIDPage[Invoice]
• client.invoices.finalize(invoice, **params) -> Invoice

Invoiceitems

Types:

from stainless_commons_stripe.types import InvoiceitemCreateResponse

Methods:

• client.invoiceitems.create(**params) -> InvoiceitemCreateResponse

PaymentLinks

Types:

from stainless_commons_stripe.types import CustomTextPosition, PaymentLinkCreateResponse

Methods:

• client.payment_links.create(**params) -> PaymentLinkCreateResponse

PaymentIntents

Types:

from stainless_commons_stripe.types import (
    PaymentFlowsInstallmentOptions,
    PaymentIntent,
    PaymentIntentPaymentMethodOptionsMandateOptionsPayto,
    PaymentIntentTypeSpecificPaymentMethodOptionsClient,
    PaymentMethodOptionsCardPresentRouting,
    PaymentTransferData,
    Review,
)

Methods:

• client.payment_intents.list(**params) -> SyncMyCursorIDPage[PaymentIntent]

Prices

Types:

from stainless_commons_stripe.types import Price

Methods:

• client.prices.create(**params) -> Price
• client.prices.list(**params) -> SyncMyCursorIDPage[Price]

Products

Types:

from stainless_commons_stripe.types import Product

Methods:

• client.products.create(**params) -> Product
• client.products.list(**params) -> SyncMyCursorIDPage[Product]

Refunds

Types:

from stainless_commons_stripe.types import Refund, TransferReversal

Methods:

• client.refunds.create(**params) -> Refund

Subscriptions

Types:

from stainless_commons_stripe.types import (
    AutomaticTaxSubscription,
    DefaultSettings,
    DefaultSettingsAutomaticTax,
    Mandate,
    PaymentMethodDetailsBancontactSetupAttempt,
    PaymentMethodDetailsIdealSetupAttempt,
    PaymentMethodDetailsSofortSetupAttempt,
    PendingUpdate,
    PhaseAutomaticTax,
    Schedule,
    ScheduleAddInvoiceItem,
    ScheduleConfigurationItem,
    SchedulePhaseConfiguration,
    SchedulePhaseSetting,
    ScheduleSetting,
    SetupAttempt,
    SetupAttemptPaymentMethodDetails,
    SetupAttemptPaymentMethodDetailsCardPresent,
    SetupIntent,
    SetupIntentPaymentMethodOptionsMandateOptionsPayto,
    SetupIntentTypeSpecificPaymentMethodOptionsClient,
    StackableDiscount,
    Subscription,
    SubscriptionBillingThresholds,
    SubscriptionInvoiceSettings,
    SubscriptionItem,
    SubscriptionTransferData,
)

Methods:

• client.subscriptions.update(subscription_exposed_id, **params) -> Subscription
• client.subscriptions.list(**params) -> SyncMyCursorIDPage[Subscription]
• client.subscriptions.cancel(subscription_exposed_id, **params) -> Subscription