code stringlengths 66 870k | docstring stringlengths 19 26.7k | func_name stringlengths 1 138 | language stringclasses 1
value | repo stringlengths 7 68 | path stringlengths 5 324 | url stringlengths 46 389 | license stringclasses 7
values |
|---|---|---|---|---|---|---|---|
def retrieve(
cls, id: str, **params: Unpack["PaymentMethodDomain.RetrieveParams"]
) -> "PaymentMethodDomain":
"""
Retrieves the details of an existing payment method domain.
"""
instance = cls(id, **params)
instance.refresh()
return instance |
Retrieves the details of an existing payment method domain.
| retrieve | python | stripe/stripe-python | stripe/_payment_method_domain.py | https://github.com/stripe/stripe-python/blob/master/stripe/_payment_method_domain.py | MIT |
def _cls_validate(
cls,
payment_method_domain: str,
**params: Unpack["PaymentMethodDomain.ValidateParams"],
) -> "PaymentMethodDomain":
"""
Some payment methods might require additional steps to register a domain. If the requirements weren't satisfied when the domain was crea... |
Some payment methods might require additional steps to register a domain. If the requirements weren't satisfied when the domain was created, the payment method will be inactive on the domain.
The payment method doesn't appear in Elements or Embedded Checkout for this domain until it is active.
... | _cls_validate | python | stripe/stripe-python | stripe/_payment_method_domain.py | https://github.com/stripe/stripe-python/blob/master/stripe/_payment_method_domain.py | MIT |
def _cls_cancel(
cls, payout: str, **params: Unpack["Payout.CancelParams"]
) -> "Payout":
"""
You can cancel a previously created payout if its status is pending. Stripe refunds the funds to your available balance. You can't cancel automatic Stripe payouts.
"""
return cast(
... |
You can cancel a previously created payout if its status is pending. Stripe refunds the funds to your available balance. You can't cancel automatic Stripe payouts.
| _cls_cancel | python | stripe/stripe-python | stripe/_payout.py | https://github.com/stripe/stripe-python/blob/master/stripe/_payout.py | MIT |
def list(
cls, **params: Unpack["Payout.ListParams"]
) -> ListObject["Payout"]:
"""
Returns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you. The payouts return in sorted order, with the most recently created payouts appearing first.
"""... |
Returns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you. The payouts return in sorted order, with the most recently created payouts appearing first.
| list | python | stripe/stripe-python | stripe/_payout.py | https://github.com/stripe/stripe-python/blob/master/stripe/_payout.py | MIT |
def modify(
cls, id: str, **params: Unpack["Payout.ModifyParams"]
) -> "Payout":
"""
Updates the specified payout by setting the values of the parameters you pass. We don't change parameters that you don't provide. This request only accepts the metadata as arguments.
"""
url ... |
Updates the specified payout by setting the values of the parameters you pass. We don't change parameters that you don't provide. This request only accepts the metadata as arguments.
| modify | python | stripe/stripe-python | stripe/_payout.py | https://github.com/stripe/stripe-python/blob/master/stripe/_payout.py | MIT |
def retrieve(
cls, id: str, **params: Unpack["Payout.RetrieveParams"]
) -> "Payout":
"""
Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list. Stripe returns the corresponding payout information.
"""
... |
Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list. Stripe returns the corresponding payout information.
| retrieve | python | stripe/stripe-python | stripe/_payout.py | https://github.com/stripe/stripe-python/blob/master/stripe/_payout.py | MIT |
def _cls_reverse(
cls, payout: str, **params: Unpack["Payout.ReverseParams"]
) -> "Payout":
"""
Reverses a payout by debiting the destination bank account. At this time, you can only reverse payouts for connected accounts to US bank accounts. If the payout is manual and in the pending status... |
Reverses a payout by debiting the destination bank account. At this time, you can only reverse payouts for connected accounts to US bank accounts. If the payout is manual and in the pending status, use /v1/payouts/:id/cancel instead.
By requesting a reversal through /v1/payouts/:id/reverse, you confir... | _cls_reverse | python | stripe/stripe-python | stripe/_payout.py | https://github.com/stripe/stripe-python/blob/master/stripe/_payout.py | MIT |
def create(cls, **params: Unpack["Plan.CreateParams"]) -> "Plan":
"""
You can now model subscriptions more flexibly using the [Prices API](https://docs.stripe.com/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration.
"""
return cast(
"... |
You can now model subscriptions more flexibly using the [Prices API](https://docs.stripe.com/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration.
| create | python | stripe/stripe-python | stripe/_plan.py | https://github.com/stripe/stripe-python/blob/master/stripe/_plan.py | MIT |
def _cls_delete(
cls, sid: str, **params: Unpack["Plan.DeleteParams"]
) -> "Plan":
"""
Deleting plans means new subscribers can't be added. Existing subscribers aren't affected.
"""
url = "%s/%s" % (cls.class_url(), sanitize_id(sid))
return cast(
"Plan",
... |
Deleting plans means new subscribers can't be added. Existing subscribers aren't affected.
| _cls_delete | python | stripe/stripe-python | stripe/_plan.py | https://github.com/stripe/stripe-python/blob/master/stripe/_plan.py | MIT |
def modify(cls, id: str, **params: Unpack["Plan.ModifyParams"]) -> "Plan":
"""
Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan's ID, amount, currency, or billing cycle.
"""
url ... |
Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan's ID, amount, currency, or billing cycle.
| modify | python | stripe/stripe-python | stripe/_plan.py | https://github.com/stripe/stripe-python/blob/master/stripe/_plan.py | MIT |
def retrieve(
cls, id: str, **params: Unpack["Plan.RetrieveParams"]
) -> "Plan":
"""
Retrieves the plan with the given ID.
"""
instance = cls(id, **params)
instance.refresh()
return instance |
Retrieves the plan with the given ID.
| retrieve | python | stripe/stripe-python | stripe/_plan.py | https://github.com/stripe/stripe-python/blob/master/stripe/_plan.py | MIT |
def create(cls, **params: Unpack["Price.CreateParams"]) -> "Price":
"""
Creates a new [Price for an existing <a href="https://docs.stripe.com/api/products">Product](https://docs.stripe.com/api/prices). The Price can be recurring or one-time.
"""
return cast(
"Price",
... |
Creates a new [Price for an existing <a href="https://docs.stripe.com/api/products">Product](https://docs.stripe.com/api/prices). The Price can be recurring or one-time.
| create | python | stripe/stripe-python | stripe/_price.py | https://github.com/stripe/stripe-python/blob/master/stripe/_price.py | MIT |
def list(cls, **params: Unpack["Price.ListParams"]) -> ListObject["Price"]:
"""
Returns a list of your active prices, excluding [inline prices](https://docs.stripe.com/docs/products-prices/pricing-models#inline-pricing). For the list of inactive prices, set active to false.
"""
result = ... |
Returns a list of your active prices, excluding [inline prices](https://docs.stripe.com/docs/products-prices/pricing-models#inline-pricing). For the list of inactive prices, set active to false.
| list | python | stripe/stripe-python | stripe/_price.py | https://github.com/stripe/stripe-python/blob/master/stripe/_price.py | MIT |
def modify(
cls, id: str, **params: Unpack["Price.ModifyParams"]
) -> "Price":
"""
Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.
"""
url = "%s/%s" % (cls.class_url(), sanitize_id(id))
return... |
Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.
| modify | python | stripe/stripe-python | stripe/_price.py | https://github.com/stripe/stripe-python/blob/master/stripe/_price.py | MIT |
def retrieve(
cls, id: str, **params: Unpack["Price.RetrieveParams"]
) -> "Price":
"""
Retrieves the price with the given ID.
"""
instance = cls(id, **params)
instance.refresh()
return instance |
Retrieves the price with the given ID.
| retrieve | python | stripe/stripe-python | stripe/_price.py | https://github.com/stripe/stripe-python/blob/master/stripe/_price.py | MIT |
def search(
cls, *args, **kwargs: Unpack["Price.SearchParams"]
) -> SearchResultObject["Price"]:
"""
Search for prices you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language).
Don't use search in read-after-write flo... |
Search for prices you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language).
Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
conditions, data is searchable in less than a m... | search | python | stripe/stripe-python | stripe/_price.py | https://github.com/stripe/stripe-python/blob/master/stripe/_price.py | MIT |
def _cls_delete(
cls, sid: str, **params: Unpack["Product.DeleteParams"]
) -> "Product":
"""
Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with type=good is only possible if it has no SKUs associated with it.
... |
Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with type=good is only possible if it has no SKUs associated with it.
| _cls_delete | python | stripe/stripe-python | stripe/_product.py | https://github.com/stripe/stripe-python/blob/master/stripe/_product.py | MIT |
def list(
cls, **params: Unpack["Product.ListParams"]
) -> ListObject["Product"]:
"""
Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.
"""
result = cls._static_request(
"ge... |
Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.
| list | python | stripe/stripe-python | stripe/_product.py | https://github.com/stripe/stripe-python/blob/master/stripe/_product.py | MIT |
def modify(
cls, id: str, **params: Unpack["Product.ModifyParams"]
) -> "Product":
"""
Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
"""
url = "%s/%s" % (cls.class_url(), sanitize_id(id))
... |
Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
| modify | python | stripe/stripe-python | stripe/_product.py | https://github.com/stripe/stripe-python/blob/master/stripe/_product.py | MIT |
def retrieve(
cls, id: str, **params: Unpack["Product.RetrieveParams"]
) -> "Product":
"""
Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information.
... |
Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information.
| retrieve | python | stripe/stripe-python | stripe/_product.py | https://github.com/stripe/stripe-python/blob/master/stripe/_product.py | MIT |
def search(
cls, *args, **kwargs: Unpack["Product.SearchParams"]
) -> SearchResultObject["Product"]:
"""
Search for products you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language).
Don't use search in read-after-wri... |
Search for products you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language).
Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
conditions, data is searchable in less than a... | search | python | stripe/stripe-python | stripe/_product.py | https://github.com/stripe/stripe-python/blob/master/stripe/_product.py | MIT |
def delete_feature(
cls,
product: str,
id: str,
**params: Unpack["Product.DeleteFeatureParams"],
) -> "ProductFeature":
"""
Deletes the feature attachment to a product
"""
return cast(
"ProductFeature",
cls._static_request(
... |
Deletes the feature attachment to a product
| delete_feature | python | stripe/stripe-python | stripe/_product.py | https://github.com/stripe/stripe-python/blob/master/stripe/_product.py | MIT |
def retrieve_feature(
cls,
product: str,
id: str,
**params: Unpack["Product.RetrieveFeatureParams"],
) -> "ProductFeature":
"""
Retrieves a product_feature, which represents a feature attachment to a product
"""
return cast(
"ProductFeature... |
Retrieves a product_feature, which represents a feature attachment to a product
| retrieve_feature | python | stripe/stripe-python | stripe/_product.py | https://github.com/stripe/stripe-python/blob/master/stripe/_product.py | MIT |
def list_features(
cls, product: str, **params: Unpack["Product.ListFeaturesParams"]
) -> ListObject["ProductFeature"]:
"""
Retrieve a list of features for a product
"""
return cast(
ListObject["ProductFeature"],
cls._static_request(
"g... |
Retrieve a list of features for a product
| list_features | python | stripe/stripe-python | stripe/_product.py | https://github.com/stripe/stripe-python/blob/master/stripe/_product.py | MIT |
def create_feature(
cls, product: str, **params: Unpack["Product.CreateFeatureParams"]
) -> "ProductFeature":
"""
Creates a product_feature, which represents a feature attachment to a product
"""
return cast(
"ProductFeature",
cls._static_request(
... |
Creates a product_feature, which represents a feature attachment to a product
| create_feature | python | stripe/stripe-python | stripe/_product.py | https://github.com/stripe/stripe-python/blob/master/stripe/_product.py | MIT |
def list(
cls, **params: Unpack["PromotionCode.ListParams"]
) -> ListObject["PromotionCode"]:
"""
Returns a list of your promotion codes.
"""
result = cls._static_request(
"get",
cls.class_url(),
params=params,
)
if not isin... |
Returns a list of your promotion codes.
| list | python | stripe/stripe-python | stripe/_promotion_code.py | https://github.com/stripe/stripe-python/blob/master/stripe/_promotion_code.py | MIT |
def modify(
cls, id: str, **params: Unpack["PromotionCode.ModifyParams"]
) -> "PromotionCode":
"""
Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.
"""
url = "%s/%s" % (cls.class_url(), sanitize_id(... |
Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.
| modify | python | stripe/stripe-python | stripe/_promotion_code.py | https://github.com/stripe/stripe-python/blob/master/stripe/_promotion_code.py | MIT |
def retrieve(
cls, id: str, **params: Unpack["PromotionCode.RetrieveParams"]
) -> "PromotionCode":
"""
Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing code use [list](https://docs.stripe.com/docs/api/promotion_codes/list) with the ... |
Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing code use [list](https://docs.stripe.com/docs/api/promotion_codes/list) with the desired code.
| retrieve | python | stripe/stripe-python | stripe/_promotion_code.py | https://github.com/stripe/stripe-python/blob/master/stripe/_promotion_code.py | MIT |
def create(cls, **params: Unpack["Quote.CreateParams"]) -> "Quote":
"""
A quote models prices and services for a customer. Default options for header, description, footer, and expires_at can be set in the dashboard via the [quote template](https://dashboard.stripe.com/settings/billing/quote).
""... |
A quote models prices and services for a customer. Default options for header, description, footer, and expires_at can be set in the dashboard via the [quote template](https://dashboard.stripe.com/settings/billing/quote).
| create | python | stripe/stripe-python | stripe/_quote.py | https://github.com/stripe/stripe-python/blob/master/stripe/_quote.py | MIT |
def _cls_list_computed_upfront_line_items(
cls,
quote: str,
**params: Unpack["Quote.ListComputedUpfrontLineItemsParams"],
) -> ListObject["LineItem"]:
"""
When retrieving a quote, there is an includable [computed.upfront.line_items](https://stripe.com/docs/api/quotes/object#q... |
When retrieving a quote, there is an includable [computed.upfront.line_items](https://stripe.com/docs/api/quotes/object#quote_object-computed-upfront-line_items) property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of upfront line items.
... | _cls_list_computed_upfront_line_items | python | stripe/stripe-python | stripe/_quote.py | https://github.com/stripe/stripe-python/blob/master/stripe/_quote.py | MIT |
def _cls_list_line_items(
cls, quote: str, **params: Unpack["Quote.ListLineItemsParams"]
) -> ListObject["LineItem"]:
"""
When retrieving a quote, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (pagi... |
When retrieving a quote, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
| _cls_list_line_items | python | stripe/stripe-python | stripe/_quote.py | https://github.com/stripe/stripe-python/blob/master/stripe/_quote.py | MIT |
def modify(
cls, id: str, **params: Unpack["Quote.ModifyParams"]
) -> "Quote":
"""
A quote models prices and services for a customer.
"""
url = "%s/%s" % (cls.class_url(), sanitize_id(id))
return cast(
"Quote",
cls._static_request(
... |
A quote models prices and services for a customer.
| modify | python | stripe/stripe-python | stripe/_quote.py | https://github.com/stripe/stripe-python/blob/master/stripe/_quote.py | MIT |
def _cls_pdf(cls, quote: str, **params: Unpack["Quote.PdfParams"]) -> Any:
"""
Download the PDF for a finalized quote. Explanation for special handling can be found [here](https://docs.stripe.com/quotes/overview#quote_pdf)
"""
return cast(
Any,
cls._static_request... |
Download the PDF for a finalized quote. Explanation for special handling can be found [here](https://docs.stripe.com/quotes/overview#quote_pdf)
| _cls_pdf | python | stripe/stripe-python | stripe/_quote.py | https://github.com/stripe/stripe-python/blob/master/stripe/_quote.py | MIT |
def retrieve(
cls, id: str, **params: Unpack["Quote.RetrieveParams"]
) -> "Quote":
"""
Retrieves the quote with the given ID.
"""
instance = cls(id, **params)
instance.refresh()
return instance |
Retrieves the quote with the given ID.
| retrieve | python | stripe/stripe-python | stripe/_quote.py | https://github.com/stripe/stripe-python/blob/master/stripe/_quote.py | MIT |
def _cls_cancel(
cls, refund: str, **params: Unpack["Refund.CancelParams"]
) -> "Refund":
"""
Cancels a refund with a status of requires_action.
You can't cancel refunds in other states. Only refunds for payment methods that require customer action can enter the requires_action stat... |
Cancels a refund with a status of requires_action.
You can't cancel refunds in other states. Only refunds for payment methods that require customer action can enter the requires_action state.
| _cls_cancel | python | stripe/stripe-python | stripe/_refund.py | https://github.com/stripe/stripe-python/blob/master/stripe/_refund.py | MIT |
def create(cls, **params: Unpack["Refund.CreateParams"]) -> "Refund":
"""
When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.
Creating a new refund will refund a charge that has previously been created but not yet refunded.
Funds will... |
When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.
Creating a new refund will refund a charge that has previously been created but not yet refunded.
Funds will be refunded to the credit or debit card that was originally charged.
Yo... | create | python | stripe/stripe-python | stripe/_refund.py | https://github.com/stripe/stripe-python/blob/master/stripe/_refund.py | MIT |
def list(
cls, **params: Unpack["Refund.ListParams"]
) -> ListObject["Refund"]:
"""
Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first. The 10 most recent refunds are always available by default on the Charge object.... |
Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first. The 10 most recent refunds are always available by default on the Charge object.
| list | python | stripe/stripe-python | stripe/_refund.py | https://github.com/stripe/stripe-python/blob/master/stripe/_refund.py | MIT |
def modify(
cls, id: str, **params: Unpack["Refund.ModifyParams"]
) -> "Refund":
"""
Updates the refund that you specify by setting the values of the passed parameters. Any parameters that you don't provide remain unchanged.
This request only accepts metadata as an argument.
... |
Updates the refund that you specify by setting the values of the passed parameters. Any parameters that you don't provide remain unchanged.
This request only accepts metadata as an argument.
| modify | python | stripe/stripe-python | stripe/_refund.py | https://github.com/stripe/stripe-python/blob/master/stripe/_refund.py | MIT |
def to_dict(self):
"""
Returns a dict representation of the object.
"""
return {
"api_key": self.api_key,
"stripe_account": self.stripe_account,
"stripe_context": self.stripe_context,
"stripe_version": self.stripe_version,
"base... |
Returns a dict representation of the object.
| to_dict | python | stripe/stripe-python | stripe/_requestor_options.py | https://github.com/stripe/stripe-python/blob/master/stripe/_requestor_options.py | MIT |
def merge_options(
requestor: RequestorOptions,
request: Optional[RequestOptions],
) -> RequestOptions:
"""
Merge a client and request object, giving precedence to the values from
the request object.
"""
if request is None:
return {
"api_key": requestor.api_key,
... |
Merge a client and request object, giving precedence to the values from
the request object.
| merge_options | python | stripe/stripe-python | stripe/_request_options.py | https://github.com/stripe/stripe-python/blob/master/stripe/_request_options.py | MIT |
def extract_options_from_dict(
d: Optional[Mapping[str, Any]],
) -> Tuple[RequestOptions, Dict[str, Any]]:
"""
Extracts a RequestOptions object from a dict, and returns a tuple of
the RequestOptions object and the remaining dict.
"""
if not d:
return {}, {}
options: RequestOptions = ... |
Extracts a RequestOptions object from a dict, and returns a tuple of
the RequestOptions object and the remaining dict.
| extract_options_from_dict | python | stripe/stripe-python | stripe/_request_options.py | https://github.com/stripe/stripe-python/blob/master/stripe/_request_options.py | MIT |
def _cls_approve(
cls, review: str, **params: Unpack["Review.ApproveParams"]
) -> "Review":
"""
Approves a Review object, closing it and removing it from the list of reviews.
"""
return cast(
"Review",
cls._static_request(
"post",
... |
Approves a Review object, closing it and removing it from the list of reviews.
| _cls_approve | python | stripe/stripe-python | stripe/_review.py | https://github.com/stripe/stripe-python/blob/master/stripe/_review.py | MIT |
def list(
cls, **params: Unpack["Review.ListParams"]
) -> ListObject["Review"]:
"""
Returns a list of Review objects that have open set to true. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
"""
result = cl... |
Returns a list of Review objects that have open set to true. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
| list | python | stripe/stripe-python | stripe/_review.py | https://github.com/stripe/stripe-python/blob/master/stripe/_review.py | MIT |
def list(
cls, **params: Unpack["SetupAttempt.ListParams"]
) -> ListObject["SetupAttempt"]:
"""
Returns a list of SetupAttempts that associate with a provided SetupIntent.
"""
result = cls._static_request(
"get",
cls.class_url(),
params=par... |
Returns a list of SetupAttempts that associate with a provided SetupIntent.
| list | python | stripe/stripe-python | stripe/_setup_attempt.py | https://github.com/stripe/stripe-python/blob/master/stripe/_setup_attempt.py | MIT |
def _cls_cancel(
cls, intent: str, **params: Unpack["SetupIntent.CancelParams"]
) -> "SetupIntent":
"""
You can cancel a SetupIntent object when it's in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.
After you cancel it, setup is abandoned... |
You can cancel a SetupIntent object when it's in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.
After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can't cancel the SetupIntent for a Checkout Session. [Expire... | _cls_cancel | python | stripe/stripe-python | stripe/_setup_intent.py | https://github.com/stripe/stripe-python/blob/master/stripe/_setup_intent.py | MIT |
def create(
cls, **params: Unpack["SetupIntent.CreateParams"]
) -> "SetupIntent":
"""
Creates a SetupIntent object.
After you create the SetupIntent, attach a payment method and [confirm](https://docs.stripe.com/docs/api/setup_intents/confirm)
it to collect any required perm... |
Creates a SetupIntent object.
After you create the SetupIntent, attach a payment method and [confirm](https://docs.stripe.com/docs/api/setup_intents/confirm)
it to collect any required permissions to charge the payment method later.
| create | python | stripe/stripe-python | stripe/_setup_intent.py | https://github.com/stripe/stripe-python/blob/master/stripe/_setup_intent.py | MIT |
def retrieve(
cls, id: str, **params: Unpack["SetupIntent.RetrieveParams"]
) -> "SetupIntent":
"""
Retrieves the details of a SetupIntent that has previously been created.
Client-side retrieval using a publishable key is allowed when the client_secret is provided in the query string... |
Retrieves the details of a SetupIntent that has previously been created.
Client-side retrieval using a publishable key is allowed when the client_secret is provided in the query string.
When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the [S... | retrieve | python | stripe/stripe-python | stripe/_setup_intent.py | https://github.com/stripe/stripe-python/blob/master/stripe/_setup_intent.py | MIT |
def list(
cls, **params: Unpack["ShippingRate.ListParams"]
) -> ListObject["ShippingRate"]:
"""
Returns a list of your shipping rates.
"""
result = cls._static_request(
"get",
cls.class_url(),
params=params,
)
if not isinsta... |
Returns a list of your shipping rates.
| list | python | stripe/stripe-python | stripe/_shipping_rate.py | https://github.com/stripe/stripe-python/blob/master/stripe/_shipping_rate.py | MIT |
def modify(
cls, id: str, **params: Unpack["ShippingRate.ModifyParams"]
) -> "ShippingRate":
"""
Updates an existing shipping rate object.
"""
url = "%s/%s" % (cls.class_url(), sanitize_id(id))
return cast(
"ShippingRate",
cls._static_request(
... |
Updates an existing shipping rate object.
| modify | python | stripe/stripe-python | stripe/_shipping_rate.py | https://github.com/stripe/stripe-python/blob/master/stripe/_shipping_rate.py | MIT |
def retrieve(
cls, id: str, **params: Unpack["ShippingRate.RetrieveParams"]
) -> "ShippingRate":
"""
Returns the shipping rate object with the given ID.
"""
instance = cls(id, **params)
instance.refresh()
return instance |
Returns the shipping rate object with the given ID.
| retrieve | python | stripe/stripe-python | stripe/_shipping_rate.py | https://github.com/stripe/stripe-python/blob/master/stripe/_shipping_rate.py | MIT |
def _cls_list_source_transactions(
cls,
source: str,
**params: Unpack["Source.ListSourceTransactionsParams"],
) -> ListObject["SourceTransaction"]:
"""
List source transactions for a given source.
"""
return cast(
ListObject["SourceTransaction"],
... |
List source transactions for a given source.
| _cls_list_source_transactions | python | stripe/stripe-python | stripe/_source.py | https://github.com/stripe/stripe-python/blob/master/stripe/_source.py | MIT |
def modify(
cls, id: str, **params: Unpack["Source.ModifyParams"]
) -> "Source":
"""
Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
This request accepts the metadata and owner as arguments. It is also ... |
Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
This request accepts the metadata and owner as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our [payment ... | modify | python | stripe/stripe-python | stripe/_source.py | https://github.com/stripe/stripe-python/blob/master/stripe/_source.py | MIT |
def retrieve(
cls, id: str, **params: Unpack["Source.RetrieveParams"]
) -> "Source":
"""
Retrieves an existing source object. Supply the unique source ID from a source creation request and Stripe will return the corresponding up-to-date source object information.
"""
instance... |
Retrieves an existing source object. Supply the unique source ID from a source creation request and Stripe will return the corresponding up-to-date source object information.
| retrieve | python | stripe/stripe-python | stripe/_source.py | https://github.com/stripe/stripe-python/blob/master/stripe/_source.py | MIT |
def _cls_cancel(
cls,
subscription_exposed_id: str,
**params: Unpack["Subscription.CancelParams"],
) -> "Subscription":
"""
Cancels a customer's subscription immediately. The customer won't be charged again for the subscription. After it's canceled, you can no longer update t... |
Cancels a customer's subscription immediately. The customer won't be charged again for the subscription. After it's canceled, you can no longer update the subscription or its [metadata](https://docs.stripe.com/metadata).
Any pending invoice items that you've created are still charged at the end of the... | _cls_cancel | python | stripe/stripe-python | stripe/_subscription.py | https://github.com/stripe/stripe-python/blob/master/stripe/_subscription.py | MIT |
def create(
cls, **params: Unpack["Subscription.CreateParams"]
) -> "Subscription":
"""
Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.
When you create a subscription with collection_method=charge_automatically,... |
Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.
When you create a subscription with collection_method=charge_automatically, the first invoice is finalized as part of the request.
The payment_behavior parameter determines t... | create | python | stripe/stripe-python | stripe/_subscription.py | https://github.com/stripe/stripe-python/blob/master/stripe/_subscription.py | MIT |
def _cls_delete_discount(
cls,
subscription_exposed_id: str,
**params: Unpack["Subscription.DeleteDiscountParams"],
) -> "Discount":
"""
Removes the currently applied discount on a subscription.
"""
return cast(
"Discount",
cls._static_... |
Removes the currently applied discount on a subscription.
| _cls_delete_discount | python | stripe/stripe-python | stripe/_subscription.py | https://github.com/stripe/stripe-python/blob/master/stripe/_subscription.py | MIT |
def list(
cls, **params: Unpack["Subscription.ListParams"]
) -> ListObject["Subscription"]:
"""
By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.
"""
result = cls._static_request(
... |
By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.
| list | python | stripe/stripe-python | stripe/_subscription.py | https://github.com/stripe/stripe-python/blob/master/stripe/_subscription.py | MIT |
def _cls_resume(
cls, subscription: str, **params: Unpack["Subscription.ResumeParams"]
) -> "Subscription":
"""
Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If a resumption invoice is generated, it must be paid or marke... |
Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If a resumption invoice is generated, it must be paid or marked uncollectible before the subscription will be unpaused. If payment succeeds the subscription will become active, and if payment f... | _cls_resume | python | stripe/stripe-python | stripe/_subscription.py | https://github.com/stripe/stripe-python/blob/master/stripe/_subscription.py | MIT |
def retrieve(
cls, id: str, **params: Unpack["Subscription.RetrieveParams"]
) -> "Subscription":
"""
Retrieves the subscription with the given ID.
"""
instance = cls(id, **params)
instance.refresh()
return instance |
Retrieves the subscription with the given ID.
| retrieve | python | stripe/stripe-python | stripe/_subscription.py | https://github.com/stripe/stripe-python/blob/master/stripe/_subscription.py | MIT |
def search(
cls, *args, **kwargs: Unpack["Subscription.SearchParams"]
) -> SearchResultObject["Subscription"]:
"""
Search for subscriptions you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language).
Don't use search in... |
Search for subscriptions you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language).
Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
conditions, data is searchable in less t... | search | python | stripe/stripe-python | stripe/_subscription.py | https://github.com/stripe/stripe-python/blob/master/stripe/_subscription.py | MIT |
def create(
cls, **params: Unpack["SubscriptionItem.CreateParams"]
) -> "SubscriptionItem":
"""
Adds a new item to an existing subscription. No existing items will be changed or replaced.
"""
return cast(
"SubscriptionItem",
cls._static_request(
... |
Adds a new item to an existing subscription. No existing items will be changed or replaced.
| create | python | stripe/stripe-python | stripe/_subscription_item.py | https://github.com/stripe/stripe-python/blob/master/stripe/_subscription_item.py | MIT |
def _cls_delete(
cls, sid: str, **params: Unpack["SubscriptionItem.DeleteParams"]
) -> "SubscriptionItem":
"""
Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.
"""
url = "%s/%s" % (cls.class_url(), sanit... |
Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.
| _cls_delete | python | stripe/stripe-python | stripe/_subscription_item.py | https://github.com/stripe/stripe-python/blob/master/stripe/_subscription_item.py | MIT |
def list(
cls, **params: Unpack["SubscriptionItem.ListParams"]
) -> ListObject["SubscriptionItem"]:
"""
Returns a list of your subscription items for a given subscription.
"""
result = cls._static_request(
"get",
cls.class_url(),
params=par... |
Returns a list of your subscription items for a given subscription.
| list | python | stripe/stripe-python | stripe/_subscription_item.py | https://github.com/stripe/stripe-python/blob/master/stripe/_subscription_item.py | MIT |
def modify(
cls, id: str, **params: Unpack["SubscriptionItem.ModifyParams"]
) -> "SubscriptionItem":
"""
Updates the plan or quantity of an item on a current subscription.
"""
url = "%s/%s" % (cls.class_url(), sanitize_id(id))
return cast(
"SubscriptionIte... |
Updates the plan or quantity of an item on a current subscription.
| modify | python | stripe/stripe-python | stripe/_subscription_item.py | https://github.com/stripe/stripe-python/blob/master/stripe/_subscription_item.py | MIT |
def retrieve(
cls, id: str, **params: Unpack["SubscriptionItem.RetrieveParams"]
) -> "SubscriptionItem":
"""
Retrieves the subscription item with the given ID.
"""
instance = cls(id, **params)
instance.refresh()
return instance |
Retrieves the subscription item with the given ID.
| retrieve | python | stripe/stripe-python | stripe/_subscription_item.py | https://github.com/stripe/stripe-python/blob/master/stripe/_subscription_item.py | MIT |
def _cls_cancel(
cls,
schedule: str,
**params: Unpack["SubscriptionSchedule.CancelParams"],
) -> "SubscriptionSchedule":
"""
Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription s... |
Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.
| _cls_cancel | python | stripe/stripe-python | stripe/_subscription_schedule.py | https://github.com/stripe/stripe-python/blob/master/stripe/_subscription_schedule.py | MIT |
def create(
cls, **params: Unpack["SubscriptionSchedule.CreateParams"]
) -> "SubscriptionSchedule":
"""
Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.
"""
return cast(
"SubscriptionSchedule",
... |
Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.
| create | python | stripe/stripe-python | stripe/_subscription_schedule.py | https://github.com/stripe/stripe-python/blob/master/stripe/_subscription_schedule.py | MIT |
def list(
cls, **params: Unpack["SubscriptionSchedule.ListParams"]
) -> ListObject["SubscriptionSchedule"]:
"""
Retrieves the list of your subscription schedules.
"""
result = cls._static_request(
"get",
cls.class_url(),
params=params,
... |
Retrieves the list of your subscription schedules.
| list | python | stripe/stripe-python | stripe/_subscription_schedule.py | https://github.com/stripe/stripe-python/blob/master/stripe/_subscription_schedule.py | MIT |
def _cls_release(
cls,
schedule: str,
**params: Unpack["SubscriptionSchedule.ReleaseParams"],
) -> "SubscriptionSchedule":
"""
Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule ca... |
Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its ... | _cls_release | python | stripe/stripe-python | stripe/_subscription_schedule.py | https://github.com/stripe/stripe-python/blob/master/stripe/_subscription_schedule.py | MIT |
def retrieve(
cls, id: str, **params: Unpack["SubscriptionSchedule.RetrieveParams"]
) -> "SubscriptionSchedule":
"""
Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule cr... |
Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.
| retrieve | python | stripe/stripe-python | stripe/_subscription_schedule.py | https://github.com/stripe/stripe-python/blob/master/stripe/_subscription_schedule.py | MIT |
def list(
cls, **params: Unpack["TaxCode.ListParams"]
) -> ListObject["TaxCode"]:
"""
A list of [all tax codes available](https://stripe.com/docs/tax/tax-categories) to add to Products in order to allow specific tax calculations.
"""
result = cls._static_request(
... |
A list of [all tax codes available](https://stripe.com/docs/tax/tax-categories) to add to Products in order to allow specific tax calculations.
| list | python | stripe/stripe-python | stripe/_tax_code.py | https://github.com/stripe/stripe-python/blob/master/stripe/_tax_code.py | MIT |
def retrieve(
cls, id: str, **params: Unpack["TaxCode.RetrieveParams"]
) -> "TaxCode":
"""
Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.
"""
instance = cls(id, **params)
inst... |
Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.
| retrieve | python | stripe/stripe-python | stripe/_tax_code.py | https://github.com/stripe/stripe-python/blob/master/stripe/_tax_code.py | MIT |
def create(cls, **params: Unpack["TaxId.CreateParams"]) -> "TaxId":
"""
Creates a new account or customer tax_id object.
"""
return cast(
"TaxId",
cls._static_request(
"post",
cls.class_url(),
params=params,
... |
Creates a new account or customer tax_id object.
| create | python | stripe/stripe-python | stripe/_tax_id.py | https://github.com/stripe/stripe-python/blob/master/stripe/_tax_id.py | MIT |
def _cls_delete(
cls, sid: str, **params: Unpack["TaxId.DeleteParams"]
) -> "TaxId":
"""
Deletes an existing account or customer tax_id object.
"""
url = "%s/%s" % (cls.class_url(), sanitize_id(sid))
return cast(
"TaxId",
cls._static_request(
... |
Deletes an existing account or customer tax_id object.
| _cls_delete | python | stripe/stripe-python | stripe/_tax_id.py | https://github.com/stripe/stripe-python/blob/master/stripe/_tax_id.py | MIT |
def retrieve(
cls, id: str, **params: Unpack["TaxId.RetrieveParams"]
) -> "TaxId":
"""
Retrieves an account or customer tax_id object.
"""
instance = cls(id, **params)
instance.refresh()
return instance |
Retrieves an account or customer tax_id object.
| retrieve | python | stripe/stripe-python | stripe/_tax_id.py | https://github.com/stripe/stripe-python/blob/master/stripe/_tax_id.py | MIT |
def list(
cls, **params: Unpack["TaxRate.ListParams"]
) -> ListObject["TaxRate"]:
"""
Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.
"""
result = cls._static_request(
"get... |
Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.
| list | python | stripe/stripe-python | stripe/_tax_rate.py | https://github.com/stripe/stripe-python/blob/master/stripe/_tax_rate.py | MIT |
def retrieve(
cls, id: str, **params: Unpack["TaxRate.RetrieveParams"]
) -> "TaxRate":
"""
Retrieves a tax rate with the given ID
"""
instance = cls(id, **params)
instance.refresh()
return instance |
Retrieves a tax rate with the given ID
| retrieve | python | stripe/stripe-python | stripe/_tax_rate.py | https://github.com/stripe/stripe-python/blob/master/stripe/_tax_rate.py | MIT |
def create(cls, **params: Unpack["Token.CreateParams"]) -> "Token":
"""
Creates a single-use token that represents a bank account's details.
You can use this token with any v1 API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a [connected ... |
Creates a single-use token that represents a bank account's details.
You can use this token with any v1 API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a [connected account](https://docs.stripe.com/api#accounts) where [controller.requirement_co... | create | python | stripe/stripe-python | stripe/_token.py | https://github.com/stripe/stripe-python/blob/master/stripe/_token.py | MIT |
def retrieve(
cls, id: str, **params: Unpack["Token.RetrieveParams"]
) -> "Token":
"""
Retrieves the token with the given ID.
"""
instance = cls(id, **params)
instance.refresh()
return instance |
Retrieves the token with the given ID.
| retrieve | python | stripe/stripe-python | stripe/_token.py | https://github.com/stripe/stripe-python/blob/master/stripe/_token.py | MIT |
def _cls_cancel(
cls, topup: str, **params: Unpack["Topup.CancelParams"]
) -> "Topup":
"""
Cancels a top-up. Only pending top-ups can be canceled.
"""
return cast(
"Topup",
cls._static_request(
"post",
"/v1/topups/{topup... |
Cancels a top-up. Only pending top-ups can be canceled.
| _cls_cancel | python | stripe/stripe-python | stripe/_topup.py | https://github.com/stripe/stripe-python/blob/master/stripe/_topup.py | MIT |
def create(cls, **params: Unpack["Topup.CreateParams"]) -> "Topup":
"""
Top up the balance of an account
"""
return cast(
"Topup",
cls._static_request(
"post",
cls.class_url(),
params=params,
),
) |
Top up the balance of an account
| create | python | stripe/stripe-python | stripe/_topup.py | https://github.com/stripe/stripe-python/blob/master/stripe/_topup.py | MIT |
def modify(
cls, id: str, **params: Unpack["Topup.ModifyParams"]
) -> "Topup":
"""
Updates the metadata of a top-up. Other top-up details are not editable by design.
"""
url = "%s/%s" % (cls.class_url(), sanitize_id(id))
return cast(
"Topup",
c... |
Updates the metadata of a top-up. Other top-up details are not editable by design.
| modify | python | stripe/stripe-python | stripe/_topup.py | https://github.com/stripe/stripe-python/blob/master/stripe/_topup.py | MIT |
def retrieve(
cls, id: str, **params: Unpack["Topup.RetrieveParams"]
) -> "Topup":
"""
Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information.
... |
Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information.
| retrieve | python | stripe/stripe-python | stripe/_topup.py | https://github.com/stripe/stripe-python/blob/master/stripe/_topup.py | MIT |
def list(
cls, **params: Unpack["Transfer.ListParams"]
) -> ListObject["Transfer"]:
"""
Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.
"""
result = cls._sta... |
Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.
| list | python | stripe/stripe-python | stripe/_transfer.py | https://github.com/stripe/stripe-python/blob/master/stripe/_transfer.py | MIT |
def modify(
cls, id: str, **params: Unpack["Transfer.ModifyParams"]
) -> "Transfer":
"""
Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
This request accepts only metadata as an argument.
"""
... |
Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
This request accepts only metadata as an argument.
| modify | python | stripe/stripe-python | stripe/_transfer.py | https://github.com/stripe/stripe-python/blob/master/stripe/_transfer.py | MIT |
def retrieve(
cls, id: str, **params: Unpack["Transfer.RetrieveParams"]
) -> "Transfer":
"""
Retrieves the details of an existing transfer. Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer informatio... |
Retrieves the details of an existing transfer. Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer information.
| retrieve | python | stripe/stripe-python | stripe/_transfer.py | https://github.com/stripe/stripe-python/blob/master/stripe/_transfer.py | MIT |
def create_reversal(
cls, id: str, **params: Unpack["Transfer.CreateReversalParams"]
) -> "Reversal":
"""
When you create a new reversal, you must specify a transfer to create it on.
When reversing transfers, you can optionally reverse part of the transfer. You can do so as many tim... |
When you create a new reversal, you must specify a transfer to create it on.
When reversing transfers, you can optionally reverse part of the transfer. You can do so as many times as you wish until the entire transfer has been reversed.
Once entirely reversed, a transfer can't be reversed aga... | create_reversal | python | stripe/stripe-python | stripe/_transfer.py | https://github.com/stripe/stripe-python/blob/master/stripe/_transfer.py | MIT |
def retrieve_reversal(
cls,
transfer: str,
id: str,
**params: Unpack["Transfer.RetrieveReversalParams"],
) -> "Reversal":
"""
By default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specifi... |
By default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specific reversal stored on the transfer.
| retrieve_reversal | python | stripe/stripe-python | stripe/_transfer.py | https://github.com/stripe/stripe-python/blob/master/stripe/_transfer.py | MIT |
def modify_reversal(
cls,
transfer: str,
id: str,
**params: Unpack["Transfer.ModifyReversalParams"],
) -> "Reversal":
"""
Updates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
This r... |
Updates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
This request only accepts metadata and description as arguments.
| modify_reversal | python | stripe/stripe-python | stripe/_transfer.py | https://github.com/stripe/stripe-python/blob/master/stripe/_transfer.py | MIT |
def secure_compare(val1, val2):
"""
Returns True if the two strings are equal, False otherwise.
The time taken is independent of the number of characters that match.
For the sake of simplicity, this function executes in constant time
only when the two strings have the same length... |
Returns True if the two strings are equal, False otherwise.
The time taken is independent of the number of characters that match.
For the sake of simplicity, this function executes in constant time
only when the two strings have the same length. It short-circuits when
they have ... | secure_compare | python | stripe/stripe-python | stripe/_util.py | https://github.com/stripe/stripe-python/blob/master/stripe/_util.py | MIT |
def convert_to_dict(obj):
"""Converts a StripeObject back to a regular dict.
Nested StripeObjects are also converted back to regular dicts.
:param obj: The StripeObject to convert.
:returns: The StripeObject as a dict.
"""
if isinstance(obj, list):
return [convert_to_dict(i) for i in ... | Converts a StripeObject back to a regular dict.
Nested StripeObjects are also converted back to regular dicts.
:param obj: The StripeObject to convert.
:returns: The StripeObject as a dict.
| convert_to_dict | python | stripe/stripe-python | stripe/_util.py | https://github.com/stripe/stripe-python/blob/master/stripe/_util.py | MIT |
def create(
cls, **params: Unpack["WebhookEndpoint.CreateParams"]
) -> "WebhookEndpoint":
"""
A webhook endpoint must have a url and a list of enabled_events. You may optionally specify the Boolean connect parameter. If set to true, then a Connect webhook endpoint that notifies the specified... |
A webhook endpoint must have a url and a list of enabled_events. You may optionally specify the Boolean connect parameter. If set to true, then a Connect webhook endpoint that notifies the specified url about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the... | create | python | stripe/stripe-python | stripe/_webhook_endpoint.py | https://github.com/stripe/stripe-python/blob/master/stripe/_webhook_endpoint.py | MIT |
def _cls_delete(
cls, sid: str, **params: Unpack["WebhookEndpoint.DeleteParams"]
) -> "WebhookEndpoint":
"""
You can also delete webhook endpoints via the [webhook endpoint management](https://dashboard.stripe.com/account/webhooks) page of the Stripe dashboard.
"""
url = "%s/... |
You can also delete webhook endpoints via the [webhook endpoint management](https://dashboard.stripe.com/account/webhooks) page of the Stripe dashboard.
| _cls_delete | python | stripe/stripe-python | stripe/_webhook_endpoint.py | https://github.com/stripe/stripe-python/blob/master/stripe/_webhook_endpoint.py | MIT |
def list(
cls, **params: Unpack["WebhookEndpoint.ListParams"]
) -> ListObject["WebhookEndpoint"]:
"""
Returns a list of your webhook endpoints.
"""
result = cls._static_request(
"get",
cls.class_url(),
params=params,
)
if no... |
Returns a list of your webhook endpoints.
| list | python | stripe/stripe-python | stripe/_webhook_endpoint.py | https://github.com/stripe/stripe-python/blob/master/stripe/_webhook_endpoint.py | MIT |
def modify(
cls, id: str, **params: Unpack["WebhookEndpoint.ModifyParams"]
) -> "WebhookEndpoint":
"""
Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.
"""
url = "%s/%s" % (cls.class_url(), sanitize_id(id))
... |
Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.
| modify | python | stripe/stripe-python | stripe/_webhook_endpoint.py | https://github.com/stripe/stripe-python/blob/master/stripe/_webhook_endpoint.py | MIT |
def retrieve(
cls, id: str, **params: Unpack["WebhookEndpoint.RetrieveParams"]
) -> "WebhookEndpoint":
"""
Retrieves the webhook endpoint with the given ID.
"""
instance = cls(id, **params)
instance.refresh()
return instance |
Retrieves the webhook endpoint with the given ID.
| retrieve | python | stripe/stripe-python | stripe/_webhook_endpoint.py | https://github.com/stripe/stripe-python/blob/master/stripe/_webhook_endpoint.py | MIT |
def create(cls, **params: Unpack["Secret.CreateParams"]) -> "Secret":
"""
Create or replace a secret in the secret store.
"""
return cast(
"Secret",
cls._static_request(
"post",
cls.class_url(),
params=params,
... |
Create or replace a secret in the secret store.
| create | python | stripe/stripe-python | stripe/apps/_secret.py | https://github.com/stripe/stripe-python/blob/master/stripe/apps/_secret.py | MIT |
def delete_where(
cls, **params: Unpack["Secret.DeleteWhereParams"]
) -> "Secret":
"""
Deletes a secret from the secret store by name and scope.
"""
return cast(
"Secret",
cls._static_request(
"post",
"/v1/apps/secrets/d... |
Deletes a secret from the secret store by name and scope.
| delete_where | python | stripe/stripe-python | stripe/apps/_secret.py | https://github.com/stripe/stripe-python/blob/master/stripe/apps/_secret.py | MIT |
def find(cls, **params: Unpack["Secret.FindParams"]) -> "Secret":
"""
Finds a secret in the secret store by name and scope.
"""
return cast(
"Secret",
cls._static_request(
"get",
"/v1/apps/secrets/find",
params=param... |
Finds a secret in the secret store by name and scope.
| find | python | stripe/stripe-python | stripe/apps/_secret.py | https://github.com/stripe/stripe-python/blob/master/stripe/apps/_secret.py | MIT |
def list(
cls, **params: Unpack["Secret.ListParams"]
) -> ListObject["Secret"]:
"""
List all secrets stored on the given scope.
"""
result = cls._static_request(
"get",
cls.class_url(),
params=params,
)
if not isinstance(res... |
List all secrets stored on the given scope.
| list | python | stripe/stripe-python | stripe/apps/_secret.py | https://github.com/stripe/stripe-python/blob/master/stripe/apps/_secret.py | MIT |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.