stripe-python API reference

278 public APIs from stripe-python (stripe/stripe-python) — 17 classes, 1 functions, 260 methods. Signatures extracted by static analysis of the actual source.

Repository: stripe/stripe-python

Kind	Count
Classes	17
Functions	1
Methods	260

API list

methodstripe._account.Account.create_person(account:str, **params:Unpack['AccountCreatePersonParams']) -> 'Person'

Creates a new person.

methodstripe._account.Account.create_person_async(account:str, **params:Unpack['AccountCreatePersonParams']) -> 'Person'

Creates a new person.

method

stripe._account.Account.list_external_accounts(account:str, **params:Unpack['AccountListExternalAccountsParams']) -> ListObject[Union['BankAccount', 'Card']]

List external accounts for an account.

method

stripe._account.Account.list_external_accounts_async(account:str, **params:Unpack['AccountListExternalAccountsParams']) -> ListObject[Union['BankAccount', 'Card']]

List external accounts for an account.

method

stripe._account.Account.modify_capability(account:str, capability:str, **params:Unpack['AccountModifyCapabilityParams']) -> 'Capability'

Updates an existing Account Capability.

method

stripe._account.Account.modify_capability_async(account:str, capability:str, **params:Unpack['AccountModifyCapabilityParams']) -> 'Capability'

Updates an existing Account Capability.

methodstripe._account.Account.modify_person(account:str, person:str, **params:Unpack['AccountModifyPersonParams']) -> 'Person'

Updates an existing person.

method

stripe._account.Account.modify_person_async(account:str, person:str, **params:Unpack['AccountModifyPersonParams']) -> 'Person'

Updates an existing person.

method

stripe._account.Account.retrieve_person(account:str, person:str, **params:Unpack['AccountRetrievePersonParams']) -> 'Person'

Retrieves an existing person.

method

stripe._account.Account.retrieve_person_async(account:str, person:str, **params:Unpack['AccountRetrievePersonParams']) -> 'Person'

Retrieves an existing person.

classstripe._any_iterator.AnyIterator

AnyIterator supports iteration through both `for ...

classstripe._balance.Balance

This is an object representing your Stripe balance.

methodstripe._card.Card.delete(sid:str, **params:Unpack['CardDeleteParams']) -> Union['BankAccount', 'Card']

Delete a specified external account for a given account.

classstripe._cash_balance.CashBalance

A customer's `Cash balance` represents real funds.

classstripe._credit_note_line_item.CreditNoteLineItem

The credit note line item object

classstripe._customer.Customer

This object represents a customer of your business.

methodstripe._customer.Customer.create(**params:Unpack['CustomerCreateParams']) -> 'Customer'

Creates a new customer object.

methodstripe._customer.Customer.create_async(**params:Unpack['CustomerCreateParams']) -> 'Customer'

Creates a new customer object.

methodstripe._customer.Customer.create_tax_id(customer:str, **params:Unpack['CustomerCreateTaxIdParams']) -> 'TaxId'

Creates a new tax_id object for a customer.

methodstripe._customer.Customer.create_tax_id_async(customer:str, **params:Unpack['CustomerCreateTaxIdParams']) -> 'TaxId'

Creates a new tax_id object for a customer.

methodstripe._customer.Customer.delete(sid:str, **params:Unpack['CustomerDeleteParams']) -> 'Customer'

Permanently deletes a customer.

methodstripe._customer.Customer.delete_async(sid:str, **params:Unpack['CustomerDeleteParams']) -> 'Customer'

Permanently deletes a customer.

methodstripe._customer.Customer.delete_discount(customer:str, **params:Unpack['CustomerDeleteDiscountParams']) -> 'Discount'

Removes the currently applied discount on a customer.

methodstripe._customer.Customer.delete_tax_id(customer:str, id:str, **params:Unpack['CustomerDeleteTaxIdParams']) -> 'TaxId'

Deletes an existing tax_id object.

method

stripe._customer.Customer.delete_tax_id_async(customer:str, id:str, **params:Unpack['CustomerDeleteTaxIdParams']) -> 'TaxId'

Deletes an existing tax_id object.

methodstripe._customer.Customer.list(**params:Unpack['CustomerListParams']) -> ListObject['Customer']

Returns a list of your customers.

methodstripe._customer.Customer.list_async(**params:Unpack['CustomerListParams']) -> ListObject['Customer']

Returns a list of your customers.

method

stripe._customer.Customer.list_sources(customer:str, **params:Unpack['CustomerListSourcesParams']) -> ListObject[Union['Account', 'BankAccount', 'Card', 'Source']]

List sources for a specified customer.

methodstripe._customer.Customer.list_tax_ids(customer:str, **params:Unpack['CustomerListTaxIdsParams']) -> ListObject['TaxId']

Returns a list of tax IDs for a customer.

method

stripe._customer.Customer.list_tax_ids_async(customer:str, **params:Unpack['CustomerListTaxIdsParams']) -> ListObject['TaxId']

Returns a list of tax IDs for a customer.

method

stripe._customer.Customer.modify_cash_balance(customer:str, **params:Unpack['CustomerModifyCashBalanceParams']) -> 'CashBalance'

Changes the settings on a customer's cash balance.

methodstripe._customer.Customer.retrieve(id:str, **params:Unpack['CustomerRetrieveParams']) -> 'Customer'

Retrieves a Customer object.

methodstripe._customer.Customer.retrieve_async(id:str, **params:Unpack['CustomerRetrieveParams']) -> 'Customer'

Retrieves a Customer object.

method

stripe._customer.Customer.retrieve_cash_balance(customer:str, **params:Unpack['CustomerRetrieveCashBalanceParams']) -> 'CashBalance'

Retrieves a customer's cash balance.

method

stripe._customer.Customer.retrieve_cash_balance_async(customer:str, **params:Unpack['CustomerRetrieveCashBalanceParams']) -> 'CashBalance'

Retrieves a customer's cash balance.

method

stripe._customer_service.CustomerService.create(params:Optional['CustomerCreateParams']=None, options:Optional['RequestOptions']=None) -> 'Customer'

Creates a new customer object.

method

stripe._customer_service.CustomerService.create_async(params:Optional['CustomerCreateParams']=None, options:Optional['RequestOptions']=None) -> 'Customer'

Creates a new customer object.

method

stripe._customer_service.CustomerService.delete(customer:str, params:Optional['CustomerDeleteParams']=None, options:Optional['RequestOptions']=None) -> 'Customer'

Permanently deletes a customer.

method

stripe._customer_service.CustomerService.delete_async(customer:str, params:Optional['CustomerDeleteParams']=None, options:Optional['RequestOptions']=None) -> 'Customer'

Permanently deletes a customer.

method

stripe._customer_service.CustomerService.list(params:Optional['CustomerListParams']=None, options:Optional['RequestOptions']=None) -> 'ListObject[Customer]'

Returns a list of your customers.

method

stripe._customer_service.CustomerService.list_async(params:Optional['CustomerListParams']=None, options:Optional['RequestOptions']=None) -> 'ListObject[Customer]'

Returns a list of your customers.

method

stripe._customer_service.CustomerService.retrieve(customer:str, params:Optional['CustomerRetrieveParams']=None, options:Optional['RequestOptions']=None) -> 'Customer'

Retrieves a Customer object.

method

stripe._customer_service.CustomerService.retrieve_async(customer:str, params:Optional['CustomerRetrieveParams']=None, options:Optional['RequestOptions']=None) -> 'Customer'

Retrieves a Customer object.

methodstripe._event.Event.list(**params:Unpack['EventListParams']) -> ListObject['Event']

List events, going back up to 30 days.

methodstripe._event.Event.list_async(**params:Unpack['EventListParams']) -> ListObject['Event']

List events, going back up to 30 days.

classstripe._exchange_rate.ExchangeRate

[Deprecated] The `ExchangeRate` APIs are deprecated.

methodstripe._exchange_rate.ExchangeRate.list(**params:Unpack['ExchangeRateListParams']) -> ListObject['ExchangeRate']

[Deprecated] The ExchangeRate APIs are deprecated.

methodstripe._exchange_rate.ExchangeRate.list_async(**params:Unpack['ExchangeRateListParams']) -> ListObject['ExchangeRate']

[Deprecated] The ExchangeRate APIs are deprecated.

methodstripe._exchange_rate.ExchangeRate.retrieve(id:str, **params:Unpack['ExchangeRateRetrieveParams']) -> 'ExchangeRate'

[Deprecated] The ExchangeRate APIs are deprecated.

method

stripe._exchange_rate.ExchangeRate.retrieve_async(id:str, **params:Unpack['ExchangeRateRetrieveParams']) -> 'ExchangeRate'

[Deprecated] The ExchangeRate APIs are deprecated.

classstripe._file.File

This object represents files hosted on Stripe's servers.

methodstripe._file.File.list(**params:Unpack['FileListParams']) -> ListObject['File']

Returns a list of the files that your account has access to.

methodstripe._file.File.list_async(**params:Unpack['FileListParams']) -> ListObject['File']

Returns a list of the files that your account has access to.

methodstripe._file.File.retrieve(id:str, **params:Unpack['FileRetrieveParams']) -> 'File'

Retrieves the details of an existing file object.

methodstripe._file.File.retrieve_async(id:str, **params:Unpack['FileRetrieveParams']) -> 'File'

Retrieves the details of an existing file object.

methodstripe._file_link.FileLink.create(**params:Unpack['FileLinkCreateParams']) -> 'FileLink'

Creates a new file link object.

methodstripe._file_link.FileLink.create_async(**params:Unpack['FileLinkCreateParams']) -> 'FileLink'

Creates a new file link object.

methodstripe._file_link.FileLink.list(**params:Unpack['FileLinkListParams']) -> ListObject['FileLink']

Returns a list of file links.

methodstripe._file_link.FileLink.list_async(**params:Unpack['FileLinkListParams']) -> ListObject['FileLink']

Returns a list of file links.

methodstripe._file_link.FileLink.modify(id:str, **params:Unpack['FileLinkModifyParams']) -> 'FileLink'

Updates an existing file link object.

methodstripe._file_link.FileLink.modify_async(id:str, **params:Unpack['FileLinkModifyParams']) -> 'FileLink'

Updates an existing file link object.

methodstripe._file_link.FileLink.retrieve(id:str, **params:Unpack['FileLinkRetrieveParams']) -> 'FileLink'

Retrieves the file link with the given ID.

methodstripe._file_link.FileLink.retrieve_async(id:str, **params:Unpack['FileLinkRetrieveParams']) -> 'FileLink'

Retrieves the file link with the given ID.

classstripe._http_client.HTTPClient

Base HTTP client that custom clients can inherit from.

methodstripe._invoice.Invoice.add_lines(invoice:str, **params:Unpack['InvoiceAddLinesParams']) -> 'Invoice'

Adds multiple line items to an invoice.

methodstripe._invoice.Invoice.add_lines_async(invoice:str, **params:Unpack['InvoiceAddLinesParams']) -> 'Invoice'

Adds multiple line items to an invoice.

methodstripe._invoice.Invoice.create(**params:Unpack['InvoiceCreateParams']) -> 'Invoice'

This endpoint creates a draft invoice for a given customer.

methodstripe._invoice.Invoice.create_async(**params:Unpack['InvoiceCreateParams']) -> 'Invoice'

This endpoint creates a draft invoice for a given customer.

methodstripe._invoice.Invoice.delete(sid:str, **params:Unpack['InvoiceDeleteParams']) -> 'Invoice'

Permanently deletes a one-off invoice draft.

methodstripe._invoice.Invoice.delete_async(sid:str, **params:Unpack['InvoiceDeleteParams']) -> 'Invoice'

Permanently deletes a one-off invoice draft.

methodstripe._invoice.Invoice.modify(id:str, **params:Unpack['InvoiceModifyParams']) -> 'Invoice'

Draft invoices are fully editable.

methodstripe._invoice.Invoice.modify_async(id:str, **params:Unpack['InvoiceModifyParams']) -> 'Invoice'

Draft invoices are fully editable.

methodstripe._invoice.Invoice.remove_lines(invoice:str, **params:Unpack['InvoiceRemoveLinesParams']) -> 'Invoice'

Removes multiple line items from an invoice.

methodstripe._invoice.Invoice.remove_lines_async(invoice:str, **params:Unpack['InvoiceRemoveLinesParams']) -> 'Invoice'

Removes multiple line items from an invoice.

methodstripe._invoice.Invoice.retrieve(id:str, **params:Unpack['InvoiceRetrieveParams']) -> 'Invoice'

Retrieves the invoice with the given ID.

methodstripe._invoice.Invoice.retrieve_async(id:str, **params:Unpack['InvoiceRetrieveParams']) -> 'Invoice'

Retrieves the invoice with the given ID.

methodstripe._invoice.Invoice.update_lines(invoice:str, **params:Unpack['InvoiceUpdateLinesParams']) -> 'Invoice'

Updates multiple line items on an invoice.

methodstripe._invoice.Invoice.update_lines_async(invoice:str, **params:Unpack['InvoiceUpdateLinesParams']) -> 'Invoice'

Updates multiple line items on an invoice.

methodstripe._invoice.Invoice.void_invoice(invoice:str, **params:Unpack['InvoiceVoidInvoiceParams']) -> 'Invoice'

Mark a finalized invoice as void.

methodstripe._invoice.Invoice.void_invoice_async(invoice:str, **params:Unpack['InvoiceVoidInvoiceParams']) -> 'Invoice'

Mark a finalized invoice as void.

classstripe._invoice_payment.InvoicePayment

Invoice Payments represent payments made against invoices.

method

stripe._invoice_payment.InvoicePayment.retrieve(id:str, **params:Unpack['InvoicePaymentRetrieveParams']) -> 'InvoicePayment'

Retrieves the invoice payment with the given ID.

method

stripe._invoice_payment.InvoicePayment.retrieve_async(id:str, **params:Unpack['InvoicePaymentRetrieveParams']) -> 'InvoicePayment'

Retrieves the invoice payment with the given ID.

classstripe._line_item.LineItem

A line item.

methodstripe._plan.Plan.delete(sid:str, **params:Unpack['PlanDeleteParams']) -> 'Plan'

Deleting plans means new subscribers can't be added.

methodstripe._plan.Plan.delete_async(sid:str, **params:Unpack['PlanDeleteParams']) -> 'Plan'

Deleting plans means new subscribers can't be added.

methodstripe._plan.Plan.list(**params:Unpack['PlanListParams']) -> ListObject['Plan']

Returns a list of your plans.

methodstripe._plan.Plan.list_async(**params:Unpack['PlanListParams']) -> ListObject['Plan']

Returns a list of your plans.

methodstripe._plan.Plan.retrieve(id:str, **params:Unpack['PlanRetrieveParams']) -> 'Plan'

Retrieves the plan with the given ID.

methodstripe._plan.Plan.retrieve_async(id:str, **params:Unpack['PlanRetrieveParams']) -> 'Plan'

Retrieves the plan with the given ID.

methodstripe._price.Price.retrieve(id:str, **params:Unpack['PriceRetrieveParams']) -> 'Price'

Retrieves the price with the given ID.

methodstripe._price.Price.retrieve_async(id:str, **params:Unpack['PriceRetrieveParams']) -> 'Price'

Retrieves the price with the given ID.

methodstripe._product.Product.create(**params:Unpack['ProductCreateParams']) -> 'Product'

Creates a new product object.

methodstripe._product.Product.create_async(**params:Unpack['ProductCreateParams']) -> 'Product'

Creates a new product object.

methodstripe._product.Product.delete(sid:str, **params:Unpack['ProductDeleteParams']) -> 'Product'

Delete a product.

methodstripe._product.Product.delete_async(sid:str, **params:Unpack['ProductDeleteParams']) -> 'Product'

Delete a product.

method

stripe._product.Product.delete_feature(product:str, id:str, **params:Unpack['ProductDeleteFeatureParams']) -> 'ProductFeature'

Deletes the feature attachment to a product

method

stripe._product.Product.delete_feature_async(product:str, id:str, **params:Unpack['ProductDeleteFeatureParams']) -> 'ProductFeature'

Deletes the feature attachment to a product

methodstripe._product.Product.list(**params:Unpack['ProductListParams']) -> ListObject['Product']

Returns a list of your products.

methodstripe._product.Product.list_async(**params:Unpack['ProductListParams']) -> ListObject['Product']

Returns a list of your products.

method

stripe._product.Product.list_features(product:str, **params:Unpack['ProductListFeaturesParams']) -> ListObject['ProductFeature']

Retrieve a list of features for a product

method

stripe._product.Product.list_features_async(product:str, **params:Unpack['ProductListFeaturesParams']) -> ListObject['ProductFeature']

Retrieve a list of features for a product

methodstripe._product.Product.retrieve(id:str, **params:Unpack['ProductRetrieveParams']) -> 'Product'

Retrieves the details of an existing product.

methodstripe._product.Product.retrieve_async(id:str, **params:Unpack['ProductRetrieveParams']) -> 'Product'

Retrieves the details of an existing product.

methodstripe._review.Review.list(**params:Unpack['ReviewListParams']) -> ListObject['Review']

Returns a list of Review objects that have open set to true.

methodstripe._review.Review.retrieve(id:str, **params:Unpack['ReviewRetrieveParams']) -> 'Review'

Retrieves a Review object.

methodstripe._review.Review.retrieve_async(id:str, **params:Unpack['ReviewRetrieveParams']) -> 'Review'

Retrieves a Review object.

methodstripe._source.Source.create(**params:Unpack['SourceCreateParams']) -> 'Source'

Creates a new source object.

methodstripe._source.Source.create_async(**params:Unpack['SourceCreateParams']) -> 'Source'

Creates a new source object.

method

stripe._source.Source.list_source_transactions(source:str, **params:Unpack['SourceListSourceTransactionsParams']) -> ListObject['SourceTransaction']

List source transactions for a given source.

methodstripe._source.Source.retrieve(id:str, **params:Unpack['SourceRetrieveParams']) -> 'Source'

Retrieves an existing source object.

methodstripe._source.Source.retrieve_async(id:str, **params:Unpack['SourceRetrieveParams']) -> 'Source'

Retrieves an existing source object.

methodstripe._source.Source.verify(source:str, **params:Unpack['SourceVerifyParams']) -> 'Source'

Verify a given source.

methodstripe._source.Source.verify_async(source:str, **params:Unpack['SourceVerifyParams']) -> 'Source'

Verify a given source.

method

stripe._subscription.Subscription.cancel(subscription_exposed_id:str, **params:Unpack['SubscriptionCancelParams']) -> 'Subscription'

Cancels a customer's subscription immediately.

method

stripe._subscription.Subscription.cancel_async(subscription_exposed_id:str, **params:Unpack['SubscriptionCancelParams']) -> 'Subscription'

Cancels a customer's subscription immediately.

methodstripe._subscription.Subscription.create(**params:Unpack['SubscriptionCreateParams']) -> 'Subscription'

Creates a new subscription on an existing customer.

methodstripe._subscription.Subscription.create_async(**params:Unpack['SubscriptionCreateParams']) -> 'Subscription'

Creates a new subscription on an existing customer.

methodstripe._subscription.Subscription.retrieve(id:str, **params:Unpack['SubscriptionRetrieveParams']) -> 'Subscription'

Retrieves the subscription with the given ID.

method

stripe._subscription.Subscription.retrieve_async(id:str, **params:Unpack['SubscriptionRetrieveParams']) -> 'Subscription'

Retrieves the subscription with the given ID.

classstripe._test_helpers.APIResourceTestHelpers

The base type for the TestHelper nested classes.

methodstripe._token.Token.retrieve(id:str, **params:Unpack['TokenRetrieveParams']) -> 'Token'

Retrieves the token with the given ID.

methodstripe._token.Token.retrieve_async(id:str, **params:Unpack['TokenRetrieveParams']) -> 'Token'

Retrieves the token with the given ID.

classstripe._topup.Topup

To top up your Stripe balance, you create a top-up object.

methodstripe._topup.Topup.cancel(topup:str, **params:Unpack['TopupCancelParams']) -> 'Topup'

Cancels a top-up.

methodstripe._topup.Topup.cancel_async(topup:str, **params:Unpack['TopupCancelParams']) -> 'Topup'

Cancels a top-up.

methodstripe._topup.Topup.create(**params:Unpack['TopupCreateParams']) -> 'Topup'

Top up the balance of an account

methodstripe._topup.Topup.create_async(**params:Unpack['TopupCreateParams']) -> 'Topup'

Top up the balance of an account

methodstripe._topup.Topup.list(**params:Unpack['TopupListParams']) -> ListObject['Topup']

Returns a list of top-ups.

methodstripe._topup.Topup.list_async(**params:Unpack['TopupListParams']) -> ListObject['Topup']

Returns a list of top-ups.

methodstripe._topup.Topup.modify(id:str, **params:Unpack['TopupModifyParams']) -> 'Topup'

Updates the metadata of a top-up.

methodstripe._topup.Topup.modify_async(id:str, **params:Unpack['TopupModifyParams']) -> 'Topup'

Updates the metadata of a top-up.

funcstripe._webhook.build_v1_event(values:Dict[str, Any], requestor:_APIRequestor) -> Event

Internal helper for centralizing v1 event creation

methodstripe.apps._secret.Secret.create(**params:Unpack['SecretCreateParams']) -> 'Secret'

Create or replace a secret in the secret store.

methodstripe.apps._secret.Secret.create_async(**params:Unpack['SecretCreateParams']) -> 'Secret'

Create or replace a secret in the secret store.

methodstripe.apps._secret.Secret.delete_where(**params:Unpack['SecretDeleteWhereParams']) -> 'Secret'

Deletes a secret from the secret store by name and scope.

methodstripe.apps._secret.Secret.find(**params:Unpack['SecretFindParams']) -> 'Secret'

Finds a secret in the secret store by name and scope.

methodstripe.apps._secret.Secret.find_async(**params:Unpack['SecretFindParams']) -> 'Secret'

Finds a secret in the secret store by name and scope.

methodstripe.apps._secret.Secret.list(**params:Unpack['SecretListParams']) -> ListObject['Secret']

List all secrets stored on the given scope.

methodstripe.apps._secret.Secret.list_async(**params:Unpack['SecretListParams']) -> ListObject['Secret']

List all secrets stored on the given scope.

method

stripe.apps._secret_service.SecretService.create(params:'SecretCreateParams', options:Optional['RequestOptions']=None) -> 'Secret'

Create or replace a secret in the secret store.

method

stripe.apps._secret_service.SecretService.create_async(params:'SecretCreateParams', options:Optional['RequestOptions']=None) -> 'Secret'

Create or replace a secret in the secret store.

method

stripe.apps._secret_service.SecretService.list(params:'SecretListParams', options:Optional['RequestOptions']=None) -> 'ListObject[Secret]'

List all secrets stored on the given scope.

method

stripe.apps._secret_service.SecretService.list_async(params:'SecretListParams', options:Optional['RequestOptions']=None) -> 'ListObject[Secret]'

List all secrets stored on the given scope.

methodstripe.billing._alert.Alert.activate(id:str, **params:Unpack['AlertActivateParams']) -> 'Alert'

Reactivates this alert, allowing it to trigger again.

methodstripe.billing._alert.Alert.activate_async(id:str, **params:Unpack['AlertActivateParams']) -> 'Alert'

Reactivates this alert, allowing it to trigger again.

methodstripe.billing._alert.Alert.create(**params:Unpack['AlertCreateParams']) -> 'Alert'

Creates a billing alert

methodstripe.billing._alert.Alert.create_async(**params:Unpack['AlertCreateParams']) -> 'Alert'

Creates a billing alert

methodstripe.billing._alert.Alert.deactivate(id:str, **params:Unpack['AlertDeactivateParams']) -> 'Alert'

Deactivates this alert, preventing it from triggering.

methodstripe.billing._alert.Alert.deactivate_async(id:str, **params:Unpack['AlertDeactivateParams']) -> 'Alert'

Deactivates this alert, preventing it from triggering.

methodstripe.billing._alert.Alert.list(**params:Unpack['AlertListParams']) -> ListObject['Alert']

Lists billing active and inactive alerts

methodstripe.billing._alert.Alert.list_async(**params:Unpack['AlertListParams']) -> ListObject['Alert']

Lists billing active and inactive alerts

methodstripe.billing._alert.Alert.retrieve(id:str, **params:Unpack['AlertRetrieveParams']) -> 'Alert'

Retrieves a billing alert given an ID

methodstripe.billing._alert.Alert.retrieve_async(id:str, **params:Unpack['AlertRetrieveParams']) -> 'Alert'

Retrieves a billing alert given an ID

methodstripe.billing._meter.Meter.create(**params:Unpack['MeterCreateParams']) -> 'Meter'

Creates a billing meter.

methodstripe.billing._meter.Meter.create_async(**params:Unpack['MeterCreateParams']) -> 'Meter'

Creates a billing meter.

methodstripe.billing._meter.Meter.list(**params:Unpack['MeterListParams']) -> ListObject['Meter']

Retrieve a list of billing meters.

methodstripe.billing._meter.Meter.list_async(**params:Unpack['MeterListParams']) -> ListObject['Meter']

Retrieve a list of billing meters.

methodstripe.billing._meter.Meter.modify(id:str, **params:Unpack['MeterModifyParams']) -> 'Meter'

Updates a billing meter.

methodstripe.billing._meter.Meter.modify_async(id:str, **params:Unpack['MeterModifyParams']) -> 'Meter'

Updates a billing meter.

methodstripe.billing._meter.Meter.retrieve(id:str, **params:Unpack['MeterRetrieveParams']) -> 'Meter'

Retrieves a billing meter given an ID.

methodstripe.billing._meter.Meter.retrieve_async(id:str, **params:Unpack['MeterRetrieveParams']) -> 'Meter'

Retrieves a billing meter given an ID.

methodstripe.billing_portal._session.Session.create(**params:Unpack['SessionCreateParams']) -> 'Session'

Creates a session of the customer portal.

methodstripe.billing_portal._session.Session.create_async(**params:Unpack['SessionCreateParams']) -> 'Session'

Creates a session of the customer portal.

methodstripe.checkout._session.Session.create(**params:Unpack['SessionCreateParams']) -> 'Session'

Creates a Checkout Session object.

methodstripe.checkout._session.Session.create_async(**params:Unpack['SessionCreateParams']) -> 'Session'

Creates a Checkout Session object.

methodstripe.checkout._session.Session.list(**params:Unpack['SessionListParams']) -> ListObject['Session']

Returns a list of Checkout Sessions.

methodstripe.checkout._session.Session.list_async(**params:Unpack['SessionListParams']) -> ListObject['Session']

Returns a list of Checkout Sessions.

methodstripe.checkout._session.Session.modify(id:str, **params:Unpack['SessionModifyParams']) -> 'Session'

Updates a Checkout Session object.

methodstripe.checkout._session.Session.modify_async(id:str, **params:Unpack['SessionModifyParams']) -> 'Session'

Updates a Checkout Session object.

methodstripe.checkout._session.Session.retrieve(id:str, **params:Unpack['SessionRetrieveParams']) -> 'Session'

Retrieves a Checkout Session object.

methodstripe.checkout._session.Session.retrieve_async(id:str, **params:Unpack['SessionRetrieveParams']) -> 'Session'

Retrieves a Checkout Session object.

methodstripe.climate._order.Order.cancel(order:str, **params:Unpack['OrderCancelParams']) -> 'Order'

Cancels a Climate order.

methodstripe.climate._order.Order.cancel_async(order:str, **params:Unpack['OrderCancelParams']) -> 'Order'

Cancels a Climate order.

methodstripe.climate._order.Order.create(**params:Unpack['OrderCreateParams']) -> 'Order'

Creates a Climate order object for a given Climate product.

methodstripe.climate._order.Order.create_async(**params:Unpack['OrderCreateParams']) -> 'Order'

Creates a Climate order object for a given Climate product.

methodstripe.climate._order.Order.list(**params:Unpack['OrderListParams']) -> ListObject['Order']

Lists all Climate order objects.

methodstripe.climate._order.Order.list_async(**params:Unpack['OrderListParams']) -> ListObject['Order']

Lists all Climate order objects.

methodstripe.climate._product.Product.list(**params:Unpack['ProductListParams']) -> ListObject['Product']

Lists all available Climate product objects.

methodstripe.climate._product.Product.list_async(**params:Unpack['ProductListParams']) -> ListObject['Product']

Lists all available Climate product objects.

classstripe.climate._supplier.Supplier

A supplier of carbon removal.

methodstripe.climate._supplier.Supplier.list(**params:Unpack['SupplierListParams']) -> ListObject['Supplier']

Lists all available Climate supplier objects.

methodstripe.climate._supplier.Supplier.list_async(**params:Unpack['SupplierListParams']) -> ListObject['Supplier']

Lists all available Climate supplier objects.

methodstripe.climate._supplier.Supplier.retrieve(id:str, **params:Unpack['SupplierRetrieveParams']) -> 'Supplier'

Retrieves a Climate supplier object.

methodstripe.climate._supplier.Supplier.retrieve_async(id:str, **params:Unpack['SupplierRetrieveParams']) -> 'Supplier'

Retrieves a Climate supplier object.

classstripe.entitlements._active_entitlement_summary.ActiveEntitlementSummary

A summary of a customer's active entitlements.

methodstripe.entitlements._feature.Feature.create(**params:Unpack['FeatureCreateParams']) -> 'Feature'

Creates a feature

methodstripe.entitlements._feature.Feature.create_async(**params:Unpack['FeatureCreateParams']) -> 'Feature'

Creates a feature

methodstripe.entitlements._feature.Feature.list(**params:Unpack['FeatureListParams']) -> ListObject['Feature']

Retrieve a list of features

methodstripe.entitlements._feature.Feature.list_async(**params:Unpack['FeatureListParams']) -> ListObject['Feature']

Retrieve a list of features

methodstripe.entitlements._feature.Feature.retrieve(id:str, **params:Unpack['FeatureRetrieveParams']) -> 'Feature'

Retrieves a feature

methodstripe.entitlements._feature.Feature.retrieve_async(id:str, **params:Unpack['FeatureRetrieveParams']) -> 'Feature'

Retrieves a feature

method

stripe.financial_connections._account.Account.list_owners(account:str, **params:Unpack['AccountListOwnersParams']) -> ListObject['AccountOwner']

Lists all owners for a given Account

method

stripe.financial_connections._account.Account.list_owners_async(account:str, **params:Unpack['AccountListOwnersParams']) -> ListObject['AccountOwner']

Lists all owners for a given Account

classstripe.financial_connections._account_owner.AccountOwner

Describes an owner of an account.

methodstripe.forwarding._request.Request.create(**params:Unpack['RequestCreateParams']) -> 'Request'

Creates a ForwardingRequest object.

methodstripe.forwarding._request.Request.create_async(**params:Unpack['RequestCreateParams']) -> 'Request'

Creates a ForwardingRequest object.

methodstripe.forwarding._request.Request.list(**params:Unpack['RequestListParams']) -> ListObject['Request']

Lists all ForwardingRequest objects.

methodstripe.forwarding._request.Request.list_async(**params:Unpack['RequestListParams']) -> ListObject['Request']

Lists all ForwardingRequest objects.

methodstripe.forwarding._request.Request.retrieve(id:str, **params:Unpack['RequestRetrieveParams']) -> 'Request'

Retrieves a ForwardingRequest object.

methodstripe.forwarding._request.Request.retrieve_async(id:str, **params:Unpack['RequestRetrieveParams']) -> 'Request'

Retrieves a ForwardingRequest object.

method

stripe.issuing._authorization.Authorization.list(**params:Unpack['AuthorizationListParams']) -> ListObject['Authorization']

Returns a list of Issuing Authorization objects.

method

stripe.issuing._authorization.Authorization.retrieve(id:str, **params:Unpack['AuthorizationRetrieveParams']) -> 'Authorization'

Retrieves an Issuing Authorization object.

method

stripe.issuing._authorization.Authorization.retrieve_async(id:str, **params:Unpack['AuthorizationRetrieveParams']) -> 'Authorization'

Retrieves an Issuing Authorization object.

methodstripe.issuing._card.Card.create(**params:Unpack['CardCreateParams']) -> 'Card'

Creates an Issuing Card object.

methodstripe.issuing._card.Card.create_async(**params:Unpack['CardCreateParams']) -> 'Card'

Creates an Issuing Card object.

methodstripe.issuing._card.Card.list(**params:Unpack['CardListParams']) -> ListObject['Card']

Returns a list of Issuing Card objects.

methodstripe.issuing._card.Card.list_async(**params:Unpack['CardListParams']) -> ListObject['Card']

Returns a list of Issuing Card objects.

methodstripe.issuing._card.Card.retrieve(id:str, **params:Unpack['CardRetrieveParams']) -> 'Card'

Retrieves an Issuing Card object.

methodstripe.issuing._card.Card.retrieve_async(id:str, **params:Unpack['CardRetrieveParams']) -> 'Card'

Retrieves an Issuing Card object.

methodstripe.issuing._token.Token.list(**params:Unpack['TokenListParams']) -> ListObject['Token']

Lists all Issuing Token objects for a given card.

methodstripe.issuing._token.Token.list_async(**params:Unpack['TokenListParams']) -> ListObject['Token']

Lists all Issuing Token objects for a given card.

methodstripe.issuing._token.Token.retrieve(id:str, **params:Unpack['TokenRetrieveParams']) -> 'Token'

Retrieves an Issuing Token object.

methodstripe.issuing._token.Token.retrieve_async(id:str, **params:Unpack['TokenRetrieveParams']) -> 'Token'

Retrieves an Issuing Token object.

methodstripe.issuing._transaction.Transaction.list(**params:Unpack['TransactionListParams']) -> ListObject['Transaction']

Returns a list of Issuing Transaction objects.

method

stripe.issuing._transaction.Transaction.list_async(**params:Unpack['TransactionListParams']) -> ListObject['Transaction']

Returns a list of Issuing Transaction objects.

methodstripe.issuing._transaction.Transaction.retrieve(id:str, **params:Unpack['TransactionRetrieveParams']) -> 'Transaction'

Retrieves an Issuing Transaction object.

method

stripe.issuing._transaction.Transaction.retrieve_async(id:str, **params:Unpack['TransactionRetrieveParams']) -> 'Transaction'

Retrieves an Issuing Transaction object.

methodstripe.reporting._report_type.ReportType.list(**params:Unpack['ReportTypeListParams']) -> ListObject['ReportType']

Returns a full list of Report Types.

methodstripe.reporting._report_type.ReportType.list_async(**params:Unpack['ReportTypeListParams']) -> ListObject['ReportType']

Returns a full list of Report Types.

methodstripe.reporting._report_type.ReportType.retrieve(id:str, **params:Unpack['ReportTypeRetrieveParams']) -> 'ReportType'

Retrieves the details of a Report Type.

method

stripe.reporting._report_type.ReportType.retrieve_async(id:str, **params:Unpack['ReportTypeRetrieveParams']) -> 'ReportType'

Retrieves the details of a Report Type.

methodstripe.tax._registration.Registration.create(**params:Unpack['RegistrationCreateParams']) -> 'Registration'

Creates a new Tax Registration object.

methodstripe.tax._registration.Registration.create_async(**params:Unpack['RegistrationCreateParams']) -> 'Registration'

Creates a new Tax Registration object.

methodstripe.tax._registration.Registration.list(**params:Unpack['RegistrationListParams']) -> ListObject['Registration']

Returns a list of Tax Registration objects.

method

stripe.tax._registration.Registration.list_async(**params:Unpack['RegistrationListParams']) -> ListObject['Registration']

Returns a list of Tax Registration objects.

methodstripe.tax._registration.Registration.modify(id:str, **params:Unpack['RegistrationModifyParams']) -> 'Registration'

Updates an existing Tax Registration object.

method

stripe.tax._registration.Registration.modify_async(id:str, **params:Unpack['RegistrationModifyParams']) -> 'Registration'

Updates an existing Tax Registration object.

methodstripe.tax._registration.Registration.retrieve(id:str, **params:Unpack['RegistrationRetrieveParams']) -> 'Registration'

Returns a Tax Registration object.

method

stripe.tax._registration.Registration.retrieve_async(id:str, **params:Unpack['RegistrationRetrieveParams']) -> 'Registration'

Returns a Tax Registration object.

methodstripe.tax._settings.Settings.modify(**params:Unpack['SettingsModifyParams']) -> 'Settings'

Updates Tax Settings parameters used in tax calculations.

methodstripe.tax._settings.Settings.modify_async(**params:Unpack['SettingsModifyParams']) -> 'Settings'

Updates Tax Settings parameters used in tax calculations.

methodstripe.tax._settings.Settings.retrieve(**params:Unpack['SettingsRetrieveParams']) -> 'Settings'

Retrieves Tax Settings for a merchant.

methodstripe.tax._settings.Settings.retrieve_async(**params:Unpack['SettingsRetrieveParams']) -> 'Settings'

Retrieves Tax Settings for a merchant.

methodstripe.tax._transaction.Transaction.retrieve(id:str, **params:Unpack['TransactionRetrieveParams']) -> 'Transaction'

Retrieves a Tax Transaction object.

method

stripe.tax._transaction.Transaction.retrieve_async(id:str, **params:Unpack['TransactionRetrieveParams']) -> 'Transaction'

Retrieves a Tax Transaction object.

methodstripe.terminal._configuration.Configuration.create(**params:Unpack['ConfigurationCreateParams']) -> 'Configuration'

Creates a new Configuration object.

method

stripe.terminal._configuration.Configuration.create_async(**params:Unpack['ConfigurationCreateParams']) -> 'Configuration'

Creates a new Configuration object.

method

stripe.terminal._configuration.Configuration.delete(sid:str, **params:Unpack['ConfigurationDeleteParams']) -> 'Configuration'

Deletes a Configuration object.

method

stripe.terminal._configuration.Configuration.delete_async(sid:str, **params:Unpack['ConfigurationDeleteParams']) -> 'Configuration'

Deletes a Configuration object.

method

stripe.terminal._configuration.Configuration.list(**params:Unpack['ConfigurationListParams']) -> ListObject['Configuration']

Returns a list of Configuration objects.

method

stripe.terminal._configuration.Configuration.list_async(**params:Unpack['ConfigurationListParams']) -> ListObject['Configuration']

Returns a list of Configuration objects.

method

stripe.terminal._configuration.Configuration.modify(id:str, **params:Unpack['ConfigurationModifyParams']) -> 'Configuration'

Updates a new Configuration object.

method

stripe.terminal._configuration.Configuration.modify_async(id:str, **params:Unpack['ConfigurationModifyParams']) -> 'Configuration'

Updates a new Configuration object.

method

stripe.terminal._configuration.Configuration.retrieve(id:str, **params:Unpack['ConfigurationRetrieveParams']) -> 'Configuration'

Retrieves a Configuration object.

method

stripe.terminal._configuration.Configuration.retrieve_async(id:str, **params:Unpack['ConfigurationRetrieveParams']) -> 'Configuration'

Retrieves a Configuration object.

classstripe.terminal._location.Location

A Location represents a grouping of readers.

methodstripe.terminal._location.Location.create(**params:Unpack['LocationCreateParams']) -> 'Location'

Creates a new Location object.

methodstripe.terminal._location.Location.create_async(**params:Unpack['LocationCreateParams']) -> 'Location'

Creates a new Location object.

methodstripe.terminal._location.Location.delete(sid:str, **params:Unpack['LocationDeleteParams']) -> 'Location'

Deletes a Location object.

methodstripe.terminal._location.Location.delete_async(sid:str, **params:Unpack['LocationDeleteParams']) -> 'Location'

Deletes a Location object.

methodstripe.terminal._location.Location.list(**params:Unpack['LocationListParams']) -> ListObject['Location']

Returns a list of Location objects.

methodstripe.terminal._location.Location.list_async(**params:Unpack['LocationListParams']) -> ListObject['Location']

Returns a list of Location objects.

methodstripe.terminal._location.Location.retrieve(id:str, **params:Unpack['LocationRetrieveParams']) -> 'Location'

Retrieves a Location object.

methodstripe.terminal._location.Location.retrieve_async(id:str, **params:Unpack['LocationRetrieveParams']) -> 'Location'

Retrieves a Location object.

methodstripe.terminal._reader.Reader.cancel_action(reader:str, **params:Unpack['ReaderCancelActionParams']) -> 'Reader'

Cancels the current reader action.

methodstripe.terminal._reader.Reader.cancel_action_async(reader:str, **params:Unpack['ReaderCancelActionParams']) -> 'Reader'

Cancels the current reader action.

method

stripe.terminal._reader.Reader.confirm_payment_intent(reader:str, **params:Unpack['ReaderConfirmPaymentIntentParams']) -> 'Reader'

Finalizes a payment on a Reader.

method

stripe.terminal._reader.Reader.confirm_payment_intent_async(reader:str, **params:Unpack['ReaderConfirmPaymentIntentParams']) -> 'Reader'

Finalizes a payment on a Reader.

methodstripe.terminal._reader.Reader.create(**params:Unpack['ReaderCreateParams']) -> 'Reader'

Creates a new Reader object.

methodstripe.terminal._reader.Reader.create_async(**params:Unpack['ReaderCreateParams']) -> 'Reader'

Creates a new Reader object.

methodstripe.terminal._reader.Reader.delete(sid:str, **params:Unpack['ReaderDeleteParams']) -> 'Reader'

Deletes a Reader object.

methodstripe.terminal._reader.Reader.delete_async(sid:str, **params:Unpack['ReaderDeleteParams']) -> 'Reader'

Deletes a Reader object.

methodstripe.terminal._reader.Reader.list(**params:Unpack['ReaderListParams']) -> ListObject['Reader']

Returns a list of Reader objects.

methodstripe.terminal._reader.Reader.list_async(**params:Unpack['ReaderListParams']) -> ListObject['Reader']

Returns a list of Reader objects.

method

stripe.terminal._reader.Reader.process_payment_intent(reader:str, **params:Unpack['ReaderProcessPaymentIntentParams']) -> 'Reader'

Initiates a payment flow on a Reader.

method

stripe.terminal._reader.Reader.process_payment_intent_async(reader:str, **params:Unpack['ReaderProcessPaymentIntentParams']) -> 'Reader'

Initiates a payment flow on a Reader.

method

stripe.terminal._reader.Reader.process_setup_intent(reader:str, **params:Unpack['ReaderProcessSetupIntentParams']) -> 'Reader'

Initiates a SetupIntent flow on a Reader.

method

stripe.terminal._reader.Reader.process_setup_intent_async(reader:str, **params:Unpack['ReaderProcessSetupIntentParams']) -> 'Reader'

Initiates a SetupIntent flow on a Reader.

methodstripe.terminal._reader.Reader.refund_payment(reader:str, **params:Unpack['ReaderRefundPaymentParams']) -> 'Reader'

Initiates an in-person refund on a Reader.

method

stripe.terminal._reader.Reader.refund_payment_async(reader:str, **params:Unpack['ReaderRefundPaymentParams']) -> 'Reader'

Initiates an in-person refund on a Reader.

methodstripe.terminal._reader.Reader.retrieve(id:str, **params:Unpack['ReaderRetrieveParams']) -> 'Reader'

Retrieves a Reader object.

methodstripe.terminal._reader.Reader.retrieve_async(id:str, **params:Unpack['ReaderRetrieveParams']) -> 'Reader'

Retrieves a Reader object.

methodstripe.treasury._transaction.Transaction.list(**params:Unpack['TransactionListParams']) -> ListObject['Transaction']

Retrieves a list of Transaction objects.

method

stripe.treasury._transaction.Transaction.list_async(**params:Unpack['TransactionListParams']) -> ListObject['Transaction']

Retrieves a list of Transaction objects.

methodstripe.treasury._transaction.Transaction.retrieve(id:str, **params:Unpack['TransactionRetrieveParams']) -> 'Transaction'

Retrieves the details of an existing Transaction.

method

stripe.treasury._transaction.Transaction.retrieve_async(id:str, **params:Unpack['TransactionRetrieveParams']) -> 'Transaction'

Retrieves the details of an existing Transaction.

classstripe.v2._list_object.ListObject

Represents one page of a list of V2 Stripe objects.

About this data

These signatures were extracted from the public source of stripe/stripe-python using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries