o i9 @sddlmZddlmZddlmZddlmZddlm Z ddl m Z ddl m Z ddlmZdd lmZdd lmZmZdd lmZmZmZmZmZmZmZmZmZdd lm Z m!Z!m"Z"e"rdd l#m$Z$ddl%m&Z&ddl'm(Z(ddl)m*Z+ddl,m-Z-ddl.m/Z/ddl0m1Z1ddl2m3Z3ddl4m5Z5ddl6m7Z7ddl8m9Z9ddl:m;Z;ddlm?Z?ddl@mAZAddlBmCZCddlDmEZEddlFmGZGddlHmIZIdd lJmKZKdd!lLmMZMdd"lNmOZOdd#lPmQZQdd$lRmSZSGd%d&d&ed&ed&e d&e d&ed&ZTd'S)()CreateableAPIResource)DeletableAPIResource)ExpandableField) ListObject)ListableAPIResource)SearchResultObject)SearchableAPIResource) StripeObject)UpdateableAPIResource)class_method_variant sanitize_id) AsyncIteratorClassVarDictIteratorListOptionalUnioncastoverload)LiteralUnpack TYPE_CHECKING)Account) Application) BankAccount)Card)Customer)Discount)Invoice) PaymentMethod) SetupIntent)Source)SubscriptionItem)SubscriptionSchedule)TaxId)TaxRate)SubscriptionCancelParams)SubscriptionCreateParams) SubscriptionDeleteDiscountParams)SubscriptionListParams)SubscriptionMigrateParams)SubscriptionModifyParams)SubscriptionResumeParams)SubscriptionRetrieveParams)SubscriptionSearchParams) TestClockc @seZdZUdZdZeeded<GdddeZ GdddeZ Gdd d eZ Gd d d eZ Gd d d eZ GdddeZGdddeZGdddeZGdddeZGdddeZGdddeZGdddeZeeded< eeed< e ed<eed < ee ed!< e ed"< ee ed#< eeed$< eed%< eeed&< ee ed'< ed(ed)< eed*< eed+< ed,ed-< eeed.< eed/ed0< eeed1ed2< eed3ed4< eeed5< eed6ed7< eeed8< eed9< eed:<ed;ed<< eed=ed>< eed?< eeefed@< eeedA< ededB< eedCedD< eeedE< eeedF< eeedG< eedHedI< eeedJ< eedKedL< eedM< edNedO< eedPedQ< eeedR< eeedS< eeedT< eeedU< edVedWe dXdYdfdZd[Z!e"e#dVedWe dXdYdfd\d]Z$e"dWe dXdYdfd^d]Z$e%d_dWe dXdYdfd`d]Z$edVedWe dXdYdfdadbZ&e"e#dVedWe dXdYdfdcddZ'e"dWe dXdYdfdeddZ'e%dfdWe dXdYdfdgddZ'edWe dhdYdfdidjZ(edWe dhdYdfdkdlZ)edVedWe dmdYd6fdndoZ*e"e#dVedWe dmdYd6fdpdqZ+e"dWe dmdYd6fdrdqZ+e%dsdWe dmdYd6fdtdqZ+edVedWe dmdYd6fdudvZ,e"e#dVedWe dmdYd6fdwdxZ-e"dWe dmdYd6fdydxZ-e%dzdWe dmdYd6fd{dxZ-edWe d|dYedfd}d~Z.edWe d|dYedfddZ/ededWe ddYdfddZ0e"e#dedWe ddYdfddZ1e"dWe ddYdfddZ1e%ddWe ddYdfddZ1ededWe ddYdfddZ2e"e#dedWe ddYdfddZ3e"dWe ddYdfddZ3e%ddWe ddYdfddZ3ed9edWe ddYdfddZ4ed9edWe ddYdfddZ5ededWe ddYdfddZ6e"e#dedWe ddYdfddZ7e"dWe ddYdfddZ7e%ddWe ddYdfddZ7ededWe ddYdfddZ8e"e#dedWe ddYdfddZ9e"dWe ddYdfddZ9e%ddWe ddYdfddZ9ed9edWe ddYdfddZ:ed9edWe ddYdfddZ;ede ddYeede ddYe?dfddZ@ede ddYeAdfddZBe e e e e eeeeeeed ZCdS) Subscriptionz Subscriptions allow you to charge a customer on a recurring basis. Related guide: [Creating subscriptions](https://stripe.com/docs/billing/subscriptions/creating) subscription OBJECT_NAMEc@sPeZdZUGdddeZeeded< eed< eeed< deiZ dS)zSubscription.AutomaticTaxc@,eZdZUeeded< eded<dS)z#Subscription.AutomaticTax.Liabilityraccountr5selftypeN__name__ __module__ __qualname__rr__annotations__rr>r>t/var/www/snowflake_co_dev_github/snow_flake_back_end_deploy/env/lib/python3.10/site-packages/stripe/_subscription.py LiabilityU  r@requires_location_inputsdisabled_reasonenabled liabilityN) r:r;r<r r@rrr=bool_inner_class_typesr>r>r>r? AutomaticTaxTs    rHc@sNeZdZUeed< eeed< eeed< eeed< eeed<dS)z%Subscription.BillingCycleAnchorConfig day_of_monthhourminutemonthsecondN)r:r;r<intr=rr>r>r>r?BillingCycleAnchorConfigms     rOc@sPeZdZUGdddeZeeed< eded< eeed< deiZ dS)zSubscription.BillingModec@eZdZUeeded<dS)z!Subscription.BillingMode.Flexible)includeditemizedproration_discountsNr:r;r<rrr=r>r>r>r?Flexible rUflexible)classicrWr8 updated_atN) r:r;r<r rUrr=rrNrGr>r>r>r? BillingModes     rZc@s(eZdZUeeed< eeed<dS)zSubscription.BillingThresholds amount_gtereset_billing_cycle_anchorN)r:r;r<rrNr=rFr>r>r>r?BillingThresholds  r]c@s>eZdZUeeed< eeded< eeded<dS)z Subscription.CancellationDetailscomment)customer_service low_qualitymissing_featuresotherswitched_service too_complex too_expensiveunusedfeedback)cancellation_requestedpayment_disputedpayment_failedreasonN)r:r;r<rstrr=rr>r>r>r?CancellationDetailss  rnc@sDeZdZUGdddeZeeeded< eed<deiZ dS)zSubscription.InvoiceSettingsc@r4)z#Subscription.InvoiceSettings.Issuerrr5r6r8Nr9r>r>r>r?IssuerrAror%account_tax_idsissuerN) r:r;r<r rorrrr=rGr>r>r>r?InvoiceSettingss   rrc@s(eZdZUeded< eeed<dS)zSubscription.PauseCollection) keep_as_draftmark_uncollectiblevoidbehavior resumes_atN)r:r;r<rr=rrNr>r>r>r?PauseCollectionr^rxc@s\eZdZUGdddeZeeed< eeeded< eeded< deiZ dS) zSubscription.PaymentSettingsc@seZdZUGdddeZGdddeZGdddeZGdddeZGd d d eZGd d d eZ Gd ddeZ e ee d< e ee d< e ee d< e ee d< e ee d< e e e d< e e e d< eeeeee e dZ dS)z1Subscription.PaymentSettings.PaymentMethodOptionsc@DeZdZUGdddeZeeed<eeded< deiZdS)z;Subscription.PaymentSettings.PaymentMethodOptions.AcssDebitc@rP)zJSubscription.PaymentSettings.PaymentMethodOptions.AcssDebit.MandateOptions)businesspersonaltransaction_typeNrTr>r>r>r?MandateOptionsrVr}mandate_options automaticinstant microdepositsverification_methodN r:r;r<r r}rr=rrGr>r>r>r? AcssDebits   rc@eZdZUeded<dS)zr>r>r? Bancontact rc@sVeZdZUGdddeZeeed<eeded< eeded< deiZdS) z6Subscription.PaymentSettings.PaymentMethodOptions.Cardc@s:eZdZUeeed< eeded< eeed<dS)zESubscription.PaymentSettings.PaymentMethodOptions.Card.MandateOptionsamount)fixedmaximum amount_type descriptionN)r:r;r<rrNr=rrmr>r>r>r?r}s  r}r~) amexcartes_bancairesdinersdiscover eftpos_augirocardinteracjcblink mastercardunionpayunknownvisanetwork)anyr challengerequest_three_d_secureNrr>r>r>r?rs   rc@sDeZdZUGdddeZeeed<eeded< deiZdS)zASubscription.PaymentSettings.PaymentMethodOptions.CustomerBalancec@s@eZdZUGdddeZeeed<eeed< deiZdS)zNSubscription.PaymentSettings.PaymentMethodOptions.CustomerBalance.BankTransferc@r)z]Subscription.PaymentSettings.PaymentMethodOptions.CustomerBalance.BankTransfer.EuBankTransfer)BEDEESFRIENLcountryNrr>r>r>r?EuBankTransfer!rreu_bank_transferr8N) r:r;r<r rrr=rmrGr>r>r>r? BankTransfer s    r bank_transfer funding_typeN) r:r;r<r rrr=rrGr>r>r>r?CustomerBalances   rc@ eZdZdS)z9Subscription.PaymentSettings.PaymentMethodOptions.KonbiniNr:r;r<r>r>r>r?Konbini5rc@r)z;Subscription.PaymentSettings.PaymentMethodOptions.SepaDebitNrr>r>r>r? SepaDebit8rrc@ry)z?Subscription.PaymentSettings.PaymentMethodOptions.UsBankAccountc@s^eZdZUGdddeZeeed<eeeded< eeeded< deiZ dS) zTSubscription.PaymentSettings.PaymentMethodOptions.UsBankAccount.FinancialConnectionsc@s"eZdZUeeeded<dS)z\Subscription.PaymentSettings.PaymentMethodOptions.UsBankAccount.FinancialConnections.Filters)checkingsavingsaccount_subcategoriesN)r:r;r<rrrr=r>r>r>r?Filters=s  rfilters)balances ownershippayment_method transactions permissions)rrrprefetchN) r:r;r<r rrr=rrrGr>r>r>r?FinancialConnections<s     rfinancial_connectionsrrN) r:r;r<r rrr=rrGr>r>r>r? UsBankAccount;s  r acss_debit bancontactcardcustomer_balancekonbini sepa_debitus_bank_account)rrrrrrrN)r:r;r<r rrrrrrrrr=rGr>r>r>r?PaymentMethodOptionss< , +       rpayment_method_options)(ach_credit_transfer ach_debitraffirm amazon_pay au_becs_debit bacs_debitrboletorcashappcryptocustomrepsfpxgiropaygrabpayidealjp_credit_transfer kakao_payklarnarkr_cardr multibanco naver_paynz_bank_accountp24paycopaynowpaypal promptpay revolut_paysepa_credit_transferrsofortswishr wechat_paypayment_method_types)offon_subscriptionsave_default_payment_methodN) r:r;r<r rrr=rrrGr>r>r>r?PaymentSettingss$  1. rc@s$eZdZUeded< eed<dS)z'Subscription.PendingInvoiceItemInterval)dayrLweekyearintervalinterval_countN)r:r;r<rr=rNr>r>r>r?PendingInvoiceItemIntervals rc@sReZdZUeeed< eed< eeded< eeed< eeed<dS)zSubscription.PendingUpdatebilling_cycle_anchor expires_atr#subscription_items trial_endtrial_from_planN)r:r;r<rrNr=rrFr>r>r>r? PendingUpdates   rc@s(eZdZUeeed< eded<dS)zSubscription.TransferDataamount_percentr destinationN)r:r;r<rfloatr=rr>r>r>r? TransferDatar^rc@s0eZdZUGdddeZeed< deiZdS)zSubscription.TrialSettingsc@r)z&Subscription.TrialSettings.EndBehavior)cancelcreate_invoicepausemissing_payment_methodNrr>r>r>r? EndBehaviors r end_behaviorN)r:r;r<r rr=rGr>r>r>r? TrialSettingss  r r applicationapplication_fee_percent automatic_taxrbilling_cycle_anchor_config billing_modebilling_thresholds cancel_atcancel_at_period_end canceled_atcancellation_details)charge_automatically send_invoicecollection_methodcreatedcurrencyrcustomerdays_until_duer default_payment_method)rr CardResourcer"default_sourcer&default_tax_ratesrr discountsended_atidinvoice_settingsr#itemsrlatest_invoicelivemodemetadata!next_pending_invoice_item_invoiceobjectr on_behalf_ofpause_collectionpayment_settingspending_invoice_item_intervalr!pending_setup_intentpending_updater$schedule start_date)activecanceled incompleteincomplete_expiredpast_duepausedtrialingunpaidstatusr0 test_clock transfer_datartrial_settings trial_startsubscription_exposed_idparamsr'returncK"td|jddjt|d|dS) 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 period, unless manually [deleted](https://docs.stripe.com/api#delete_invoiceitem). If you've set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed if invoice_now and prorate are both set to true. By default, upon subscription cancellation, Stripe stops automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all. r1delete+/v1/subscriptions/{subscription_exposed_id}r>r?r_static_requestformatr clsr>r?r>r>r? _cls_cancels zSubscription._cls_cancelcKdSrBNr>r>r?r>r>r?rs zSubscription.cancelcKrMrNr>r7r?r>r>r?rs rLc K(td|jddjt|dd|dS)rBr1rCrDr!rErFr_requestrIr getrPr>r>r?rs  c*td|jddjt|d|dIdHS)rBr1rCrDrErFNr_static_request_asyncrIr rJr>r>r?_cls_cancel_asyncs  zSubscription._cls_cancel_asynccdSrNr>rOr>r>r? cancel_async*s zSubscription.cancel_asynccrYrNr>rPr>r>r?rZ9s rXc 0td|jddjt|dd|dIdHS)rBr1rCrDr!rErFNr_request_asyncrIr rTrPr>r>r?rZFs   r(cKstd|jd||dS) 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 the exact behavior of the initial payment. To start subscriptions where the first invoice always begins in a draft status, use [subscription schedules](https://docs.stripe.com/docs/billing/subscriptions/subscription-schedules#managing) instead. Schedules provide the flexibility to model more complex billing configurations that change over time. r1postrF)rrH class_urlrKr?r>r>r?create\s zSubscription.createcs"td|jd||dIdHS)r^r1r_rFN)rrWr`rar>r>r? create_asyncrs  zSubscription.create_asyncr)cKrA)K Removes the currently applied discount on a subscription. rrC4/v1/subscriptions/{subscription_exposed_id}/discountrErFrGrJr>r>r?_cls_delete_discounts z!Subscription._cls_delete_discountcKrMrdNr>rOr>r>r?delete_discounts zSubscription.delete_discountcKrMrgr>rPr>r>r?rhrfc KrQ)rdrrCrer!rErFrRrPr>r>r?rh crU)rdrrCrerErFNrVrJr>r>r?_cls_delete_discount_asyncs  z'Subscription._cls_delete_discount_asynccrYrgr>rOr>r>r?delete_discount_asyncs z"Subscription.delete_discount_asynccrYrgr>rPr>r>r?rlrkc r[)rdrrCrer!rErFNr\rPr>r>r?rl  r*cKs4|jd||d}t|tstdt|j|S) By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled. rTrF%Expected list object from API, got %s)rHr` isinstancer TypeErrorr8r:rKr?resultr>r>r?lists zSubscription.listcs<|jd||dIdH}t|tstdt|j|S)rorTrFNrp)rWr`rqrrrr8r:rsr>r>r? list_asyncs zSubscription.list_asyncr+cKrA)G Upgrade the billing_mode of an existing subscription. r1r_(/v1/subscriptions/{subscription}/migrater2rFrGrKr2r?r>r>r? _cls_migrate(zSubscription._cls_migratecKrMrwNr>r2r?r>r>r?migrate:zSubscription.migratecKrMr}r>rPr>r>r?rDrir{c KrQ)rwr1r_rxr!ryrFrRrPr>r>r?rMrjcrU)rwr1r_rxryrFNrVrzr>r>r?_cls_migrate_async_ zSubscription._cls_migrate_asynccrYr}r>r~r>r>r? migrate_asyncqzSubscription.migrate_asynccrYr}r>rPr>r>r?r{rmrc r[)rwr1r_rxr!ryrFNr\rPr>r>r?rrnr,cKs*d|t|f}td|jd||dS) Updates an existing subscription to match the specified parameters. When changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes. To preview how the proration is calculated, use the [create preview](https://docs.stripe.com/docs/api/invoices/create_preview) endpoint. By default, we prorate subscription changes. For example, if a customer signs up on May 1 for a 100 price, they'll be billed 100 immediately. If on May 15 they switch to a 200 price, then on June 1 they'll be billed 250 (200 for a renewal of her subscription, plus a 50 prorating adjustment for half of the previous month's 100 difference). Similarly, a downgrade generates a credit that is applied to the next invoice. We also prorate when you make quantity changes. Switching prices does not normally change the billing date or generate an immediate charge unless: The billing interval is changed (for example, from monthly to yearly). The subscription moves from free to paid. A trial starts or ends. In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. Learn about how [Stripe immediately attempts payment for subscription changes](https://docs.stripe.com/docs/billing/subscriptions/upgrade-downgrade#immediate-payment). If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription's renewal date, you need to manually [invoice the customer](https://docs.stripe.com/docs/api/invoices/create). If you don't want to prorate, set the proration_behavior option to none. With this option, the customer is billed 100 on May 1 and 200 on June 1. Similarly, if you set proration_behavior to none when switching between different billing intervals (for example, from monthly to yearly), we don't generate any credits for the old subscription's unused time. We still reset the billing date and bill immediately for the new subscription. Updating the quantity on a subscription many times in an hour may result in [rate limiting. If you need to bill for a frequently changing quantity, consider integrating usage-based billing](https://docs.stripe.com/docs/rate-limits) instead. %s/%sr1r_rF)r`r rrHrKr!r?urlr>r>r?modifyszSubscription.modifycs2d|t|f}td|jd||dIdHS)rrr1r_rFN)r`r rrWrr>r>r? modify_asyncs zSubscription.modify_asyncr-cKrA) 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 fails the subscription will be past_due. The resumption invoice will void automatically if not paid by the expiration date. r1r_'/v1/subscriptions/{subscription}/resumeryrFrGrzr>r>r? _cls_resumer|zSubscription._cls_resumecKrMrNr>r~r>r>r?resumerzSubscription.resumecKrMrr>rPr>r>r?rrirc KrQ)rr1r_rr!ryrFrRrPr>r>r?rrjcrU)rr1r_rryrFNrVrzr>r>r?_cls_resume_asyncrzSubscription._cls_resume_asynccrYrr>r~r>r>r? resume_async)rzSubscription.resume_asynccrYrr>rPr>r>r?r3rmrc r[)rr1r_rr!ryrFNr\rPr>r>r?r<rnr.cKs||fi|}||S)? Retrieves the subscription with the given ID. )refreshrKr!r?instancer>r>r?retrieveNszSubscription.retrievecs$||fi|}|IdH|S)rN) refresh_asyncrr>r>r?retrieve_asyncYszSubscription.retrieve_asynckwargsr/cOs|j|ddi|S) 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 than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India. search_url/v1/subscriptions/search)_searchrKargsrr>r>r?searchds zSubscription.searchcs|j|ddi|IdHS)rrrN) _search_asyncrr>r>r? search_asyncrs  zSubscription.search_asynccOs|j|i|SN)rauto_paging_iterrr>r>r?search_auto_paging_itersz$Subscription.search_auto_paging_itercs|j|i|IdHSr)rrrr>r>r?search_auto_paging_iter_asyncsz*Subscription.search_auto_paging_iter_async) r r rrrr"r*r+r,r.r;r<N)Dr:r;r<__doc__r3rrr=r rHrOrZr]rnrrrxrrrrr rrrrNrFrmrrrr classmethodrrLr staticmethodrr rXrZrbrcrfrhrkrlrurvr{rrrrrrrrrrrrrrrrr rrGr>r>r>r?r1Esb   o                                                       $ $                 r1N)Ustripe._createable_api_resourcerstripe._deletable_api_resourcerstripe._expandable_fieldrstripe._list_objectrstripe._listable_api_resourcerstripe._search_result_objectrstripe._searchable_api_resourcerstripe._stripe_objectr stripe._updateable_api_resourcer stripe._utilr r typingr rrrrrrrrtyping_extensionsrrrstripe._accountrstripe._applicationrstripe._bank_accountr stripe._cardrrstripe._customerrstripe._discountrstripe._invoicerstripe._payment_methodr stripe._setup_intentr!stripe._sourcer"stripe._subscription_itemr#stripe._subscription_scheduler$stripe._tax_idr%stripe._tax_rater&)stripe.params._subscription_cancel_paramsr')stripe.params._subscription_create_paramsr(2stripe.params._subscription_delete_discount_paramsr)'stripe.params._subscription_list_paramsr**stripe.params._subscription_migrate_paramsr+)stripe.params._subscription_modify_paramsr,)stripe.params._subscription_resume_paramsr-+stripe.params._subscription_retrieve_paramsr.)stripe.params._subscription_search_paramsr/stripe.test_helpers._test_clockr0r1r>r>r>r?sX         ,