Crate stripe_billing

Source
Expand description

This crate provides Rust bindings to the Stripe HTTP API, specifically for requests mentioned in the Billing section of the Stripe API docs

Modules§

billing_alert
billing_credit_balance_summary
billing_credit_balance_transaction
billing_credit_grant
billing_meter
billing_meter_event
billing_meter_event_adjustment
billing_meter_event_summary
billing_portal_configuration
billing_portal_session
credit_note
credit_note_line_item
invoice
invoice_item
invoice_line_item
invoice_payment
invoice_rendering_template
plan
quote
subscription
subscription_item
subscription_schedule
tax_id
test_helpers_test_clock

Structs§

AutomaticTax
BillingAlert
A billing alert is a resource that notifies you when a certain usage threshold on a meter is crossed. For example, you might create a billing alert to notify you when a certain user made 100 API requests.
BillingAlertId
BillingAlertTriggered
BillingAlertTriggeredBuilder
BillingBillResourceInvoiceItemParentsInvoiceItemParent
BillingBillResourceInvoiceItemParentsInvoiceItemParentBuilder
BillingBillResourceInvoiceItemParentsInvoiceItemSubscriptionParent
BillingBillResourceInvoiceItemParentsInvoiceItemSubscriptionParentBuilder
BillingBillResourceInvoicingLinesCommonCreditedItems
BillingBillResourceInvoicingLinesCommonProrationDetails
BillingBillResourceInvoicingLinesParentsInvoiceLineItemInvoiceItemParent
BillingBillResourceInvoicingLinesParentsInvoiceLineItemParent
BillingBillResourceInvoicingLinesParentsInvoiceLineItemSubscriptionItemParent
BillingBillResourceInvoicingParentsInvoiceParent
BillingBillResourceInvoicingParentsInvoiceQuoteParent
BillingBillResourceInvoicingParentsInvoiceSubscriptionParent
BillingBillResourceInvoicingPricingPricing
BillingBillResourceInvoicingPricingPricingPriceDetails
BillingBillResourceInvoicingTaxesTax
BillingBillResourceInvoicingTaxesTaxRateDetails
BillingClocksResourceStatusDetailsAdvancingStatusDetails
BillingClocksResourceStatusDetailsStatusDetails
BillingCreditBalanceSummary
Indicates the billing credit balance for billing credits granted to a customer.
BillingCreditBalanceTransaction
A credit balance transaction is a resource representing a transaction (either a credit or a debit) against an existing credit grant.
BillingCreditBalanceTransactionId
BillingCreditGrant
A credit grant is an API resource that documents the allocation of some billing credits to a customer.
BillingCreditGrantId
BillingCreditGrantsResourceAmount
BillingCreditGrantsResourceApplicabilityConfig
BillingCreditGrantsResourceApplicablePrice
BillingCreditGrantsResourceApplicablePriceId
BillingCreditGrantsResourceBalanceCredit
BillingCreditGrantsResourceBalanceCreditsApplicationInvoiceVoided
BillingCreditGrantsResourceBalanceCreditsApplied
BillingCreditGrantsResourceBalanceDebit
BillingCreditGrantsResourceMonetaryAmount
BillingCreditGrantsResourceScope
BillingMeter
Meters specify how to aggregate meter events over a billing period. Meter events represent the actions that customers take in your system. Meters attach to prices and form the basis of the bill.
BillingMeterEvent
Meter events represent actions that customers take in your system. You can use meter events to bill a customer based on their usage. Meter events are associated with billing meters, which define both the contents of the event’s payload and how to aggregate those events.
BillingMeterEventAdjustment
A billing meter event adjustment is a resource that allows you to cancel a meter event. For example, you might create a billing meter event adjustment to cancel a meter event that was created in error or attached to the wrong customer.
BillingMeterEventSummary
A billing meter event summary represents an aggregated view of a customer’s billing meter events within a specified timeframe. It indicates how much. usage was accrued by a customer for that period.
BillingMeterEventSummaryId
BillingMeterId
BillingMeterResourceAggregationSettings
BillingMeterResourceAggregationSettingsBuilder
BillingMeterResourceBillingMeterEventAdjustmentCancel
BillingMeterResourceBillingMeterEventAdjustmentCancelBuilder
BillingMeterResourceBillingMeterStatusTransitions
BillingMeterResourceBillingMeterStatusTransitionsBuilder
BillingMeterResourceBillingMeterValue
BillingMeterResourceBillingMeterValueBuilder
BillingMeterResourceCustomerMappingSettings
BillingMeterResourceCustomerMappingSettingsBuilder
BillingPortalConfiguration
A portal configuration describes the functionality and behavior of a portal session.
BillingPortalConfigurationId
BillingPortalSession
The Billing customer portal is a Stripe-hosted UI for subscription and billing management.
BillingPortalSessionId
CancellationDetails
CheckoutSessionItem
A line item.
CheckoutSessionItemId
CreditBalance
CreditBalanceBuilder
CreditNote
Issue a credit note to adjust an invoice’s amount after the invoice is finalized.
CreditNoteId
CreditNoteLineItem
The credit note line item object
CreditNoteLineItemId
CreditNoteRefund
CreditNotesPretaxCreditAmount
DeletedInvoice
DeletedInvoiceitem
DeletedInvoiceitemBuilder
DeletedPlan
DeletedSubscriptionItem
DeletedTaxId
DeletedTestHelpersTestClock
DiscountsResourceDiscountAmount
DiscountsResourceStackableDiscount
Invoice
Invoices are statements of amounts owed by a customer, and are either generated one-off, or generated periodically from a subscription.
InvoiceId
InvoiceInstallmentsCard
InvoiceItem
Invoice Items represent the component lines of an invoice. An invoice item is added to an. invoice by creating or updating it with an invoice field, at which point it will be included as an invoice line item within invoice.lines.
InvoiceItemId
InvoiceItemThresholdReason
InvoiceLineItem
Invoice Line Items represent the individual lines within an invoice and only exist within the context of an invoice.
InvoiceLineItemId
InvoiceLineItemPeriod
InvoiceMandateOptionsCard
InvoicePayment
The invoice payment object
InvoicePaymentId
InvoicePaymentMethodOptionsAcssDebit
InvoicePaymentMethodOptionsAcssDebitMandateOptions
InvoicePaymentMethodOptionsBancontact
InvoicePaymentMethodOptionsCard
InvoicePaymentMethodOptionsCustomerBalance
InvoicePaymentMethodOptionsCustomerBalanceBankTransfer
InvoicePaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer
InvoicePaymentMethodOptionsKonbini
InvoicePaymentMethodOptionsSepaDebit
InvoicePaymentMethodOptionsUsBankAccount
InvoicePaymentMethodOptionsUsBankAccountLinkedAccountOptions
InvoicePaymentMethodOptionsUsBankAccountLinkedAccountOptionsFilters
InvoiceRenderingPdf
InvoiceRenderingTemplate
Invoice Rendering Templates are used to configure how invoices are rendered on surfaces like the PDF. Invoice Rendering Templates. can be created from within the Dashboard, and they can be used over the API when creating invoices.
InvoiceRenderingTemplateId
InvoiceSettingCheckoutRenderingOptions
InvoiceSettingCustomField
InvoiceSettingCustomerRenderingOptions
InvoiceSettingCustomerSetting
InvoiceSettingQuoteSetting
InvoiceSettingQuoteSettingBuilder
InvoiceSettingSubscriptionSchedulePhaseSetting
InvoiceSettingSubscriptionScheduleSetting
InvoiceThresholdReason
InvoicesPaymentMethodOptions
InvoicesPaymentSettings
InvoicesPaymentsInvoicePaymentAssociatedPayment
InvoicesPaymentsInvoicePaymentStatusTransitions
InvoicesResourceConfirmationSecret
InvoicesResourceFromInvoice
InvoicesResourceInvoiceRendering
InvoicesResourceInvoiceTaxId
InvoicesResourcePretaxCreditAmount
InvoicesResourceShippingCost
InvoicesResourceStatusTransitions
Plan
You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.
PlanId
PlanTier
PortalBusinessProfile
PortalBusinessProfileBuilder
PortalCustomerUpdate
PortalCustomerUpdateBuilder
PortalFeatures
PortalFeaturesBuilder
PortalFlowsAfterCompletionHostedConfirmation
PortalFlowsAfterCompletionHostedConfirmationBuilder
PortalFlowsAfterCompletionRedirect
PortalFlowsAfterCompletionRedirectBuilder
PortalFlowsCouponOffer
PortalFlowsCouponOfferBuilder
PortalFlowsFlow
PortalFlowsFlowAfterCompletion
PortalFlowsFlowAfterCompletionBuilder
PortalFlowsFlowBuilder
PortalFlowsFlowSubscriptionCancel
PortalFlowsFlowSubscriptionCancelBuilder
PortalFlowsFlowSubscriptionUpdate
PortalFlowsFlowSubscriptionUpdateBuilder
PortalFlowsFlowSubscriptionUpdateConfirm
PortalFlowsFlowSubscriptionUpdateConfirmBuilder
PortalFlowsRetention
PortalFlowsRetentionBuilder
PortalFlowsSubscriptionUpdateConfirmDiscount
PortalFlowsSubscriptionUpdateConfirmDiscountBuilder
PortalFlowsSubscriptionUpdateConfirmItem
PortalFlowsSubscriptionUpdateConfirmItemBuilder
PortalFlowsSubscriptionUpdateConfirmItemId
PortalInvoiceList
PortalInvoiceListBuilder
PortalLoginPage
PortalLoginPageBuilder
PortalPaymentMethodUpdate
PortalPaymentMethodUpdateBuilder
PortalResourceScheduleUpdateAtPeriodEnd
PortalResourceScheduleUpdateAtPeriodEndBuilder
PortalResourceScheduleUpdateAtPeriodEndCondition
PortalResourceScheduleUpdateAtPeriodEndConditionBuilder
PortalSubscriptionCancel
PortalSubscriptionCancelBuilder
PortalSubscriptionCancellationReason
PortalSubscriptionCancellationReasonBuilder
PortalSubscriptionUpdate
PortalSubscriptionUpdateBuilder
PortalSubscriptionUpdateProduct
PortalSubscriptionUpdateProductBuilder
Quote
A Quote is a way to model prices that you’d like to provide to a customer. Once accepted, it will automatically create an invoice, subscription or subscription schedule.
QuoteId
QuotesResourceAutomaticTax
QuotesResourceAutomaticTaxBuilder
QuotesResourceComputed
QuotesResourceComputedBuilder
QuotesResourceFromQuote
QuotesResourceFromQuoteBuilder
QuotesResourceRecurring
QuotesResourceRecurringBuilder
QuotesResourceStatusTransitions
QuotesResourceStatusTransitionsBuilder
QuotesResourceSubscriptionDataSubscriptionData
QuotesResourceSubscriptionDataSubscriptionDataBuilder
QuotesResourceTotalDetails
QuotesResourceTotalDetailsBuilder
QuotesResourceTotalDetailsResourceBreakdown
QuotesResourceTotalDetailsResourceBreakdownBuilder
QuotesResourceTransferData
QuotesResourceTransferDataBuilder
QuotesResourceUpfront
QuotesResourceUpfrontBuilder
SchedulesPhaseAutomaticTax
Subscription
Subscriptions allow you to charge a customer on a recurring basis.
SubscriptionAutomaticTax
SubscriptionId
SubscriptionItem
Subscription items allow you to create customer subscriptions with more than one plan, making it easy to represent complex billing relationships.
SubscriptionItemId
SubscriptionPaymentMethodOptionsCard
SubscriptionPendingInvoiceItemInterval
SubscriptionSchedule
A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes.
SubscriptionScheduleAddInvoiceItem
An Add Invoice Item describes the prices and quantities that will be added as pending invoice items when entering a phase.
SubscriptionScheduleConfigurationItem
A phase item describes the price and quantity of a phase.
SubscriptionScheduleCurrentPhase
SubscriptionScheduleId
SubscriptionSchedulePhaseConfiguration
A phase describes the plans, coupon, and trialing status of a subscription for a predefined time period.
SubscriptionSchedulesResourceDefaultSettings
SubscriptionSchedulesResourceDefaultSettingsAutomaticTax
SubscriptionTransferData
SubscriptionsResourceBillingCycleAnchorConfig
SubscriptionsResourcePauseCollection
The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription. should be paused.
SubscriptionsResourcePaymentMethodOptions
SubscriptionsResourcePaymentSettings
SubscriptionsResourcePendingUpdate
Pending Updates store the changes pending from a previous update that will be applied to the Subscription upon successful payment.
SubscriptionsResourceSubscriptionInvoiceSettings
TaxIDsOwner
TaxId
You can add one or multiple tax IDs to a customer or account. Customer and account tax IDs get displayed on related invoices and credit notes.
TaxIdId
TaxIdVerification
TestHelpersTestClock
A test clock enables deterministic control over objects in testmode. With a test clock, you can create. objects at a frozen time in the past or future, and advance to a specific future time to observe webhooks and state changes. After the clock advances,. you can either validate the current state of your scenario (and test your assumptions), change the current state of your scenario (and test more complex scenarios), or keep advancing forward in time.
TestHelpersTestClockId
ThresholdsResourceUsageAlertFilter
ThresholdsResourceUsageAlertFilterBuilder
ThresholdsResourceUsageThresholdConfig
The usage threshold alert configuration enables setting up alerts for when a certain usage threshold on a specific meter is crossed.
ThresholdsResourceUsageThresholdConfigBuilder
TransformUsage

Enums§

AutomaticTaxDisabledReason
If Stripe disabled automatic tax, this enum describes why.
AutomaticTaxStatus
The status of the most recent automated tax calculation for this invoice.
BillingAlertAlertType
BillingAlertStatus
Status of the alert. This can be active, inactive or archived.
BillingBillResourceInvoiceItemParentsInvoiceItemParentType
The type of parent that generated this invoice item
BillingBillResourceInvoicingLinesParentsInvoiceLineItemParentType
The type of parent that generated this line item
BillingBillResourceInvoicingParentsInvoiceParentType
The type of parent that generated this invoice
BillingBillResourceInvoicingPricingPricingType
The type of the pricing details.
BillingBillResourceInvoicingTaxesTaxTaxBehavior
Whether this tax is inclusive or exclusive.
BillingBillResourceInvoicingTaxesTaxTaxabilityReason
The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
BillingBillResourceInvoicingTaxesTaxType
The type of tax information.
BillingCreditBalanceTransactionType
The type of credit balance transaction (credit or debit).
BillingCreditGrantCategory
BillingCreditGrantsResourceAmountType
The type of this amount. We currently only support monetary billing credits.
BillingCreditGrantsResourceBalanceCreditType
The type of credit transaction.
BillingCreditGrantsResourceBalanceDebitType
The type of debit transaction.
BillingCreditGrantsResourceScopePriceType
The price type that credit grants can apply to. We currently only support the metered price type. This refers to prices that have a Billing Meter attached to them. Cannot be used in combination with prices.
BillingMeterEventAdjustmentStatus
The meter event adjustment’s status.
BillingMeterEventAdjustmentType
BillingMeterEventTimeWindow
BillingMeterResourceAggregationSettingsFormula
Specifies how events are aggregated.
BillingMeterResourceCustomerMappingSettingsType
The method for mapping a meter event to a customer.
BillingMeterStatus
BillingPortalSessionLocale
CancellationDetailsFeedback
The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.
CancellationDetailsReason
Why this subscription was canceled.
CreditNoteLineItemType
The type of the credit note line item, one of invoice_line_item or custom_line_item. When the type is invoice_line_item there is an additional invoice_line_item property on the resource the value of which is the id of the credited line item on the invoice.
CreditNoteReason
CreditNoteStatus
Status of this credit note, one of issued or void. Learn more about voiding credit notes.
CreditNoteType
Type of this credit note, one of pre_payment or post_payment. A pre_payment credit note means it was issued when the invoice was open. A post_payment credit note means it was issued when the invoice was paid.
CreditNotesPretaxCreditAmountType
Type of the pretax credit amount referenced.
InvoiceBillingReason
Indicates the reason why the invoice was created.
InvoiceCollectionMethod
InvoiceCustomerTaxExempt
The customer’s tax exempt status. Until the invoice is finalized, this field will equal customer.tax_exempt. Once the invoice is finalized, this field will no longer be updated.
InvoiceMandateOptionsCardAmountType
One of fixed or maximum. If fixed, the amount param refers to the exact amount to be charged in future payments. If maximum, the amount charged can be up to the value passed for the amount param.
InvoicePaymentMethodOptionsAcssDebitMandateOptionsTransactionType
Transaction type of the mandate.
InvoicePaymentMethodOptionsAcssDebitVerificationMethod
Bank account verification method.
InvoicePaymentMethodOptionsBancontactPreferredLanguage
Preferred language of the Bancontact authorization page that the customer is redirected to.
InvoicePaymentMethodOptionsCardRequestThreeDSecure
We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine.
InvoicePaymentMethodOptionsCustomerBalanceBankTransferEuBankTransferCountry
The desired country code of the bank account information. Permitted values include: BE, DE, ES, FR, IE, or NL.
InvoicePaymentMethodOptionsCustomerBalanceFundingType
The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: bank_transfer.
InvoicePaymentMethodOptionsUsBankAccountLinkedAccountOptionsFiltersAccountSubcategories
The account subcategories to use to filter for possible accounts to link. Valid subcategories are checking and savings.
InvoicePaymentMethodOptionsUsBankAccountLinkedAccountOptionsPermissions
The list of permissions to request. The payment_method permission must be included.
InvoicePaymentMethodOptionsUsBankAccountLinkedAccountOptionsPrefetch
Data features requested to be retrieved upon account creation.
InvoicePaymentMethodOptionsUsBankAccountVerificationMethod
Bank account verification method.
InvoiceRenderingPdfPageSize
Page size of invoice pdf. Options include a4, letter, and auto. If set to auto, page size will be switched to a4 or letter based on customer locale.
InvoiceRenderingTemplateStatus
InvoiceStatus
InvoicesPaymentSettingsPaymentMethodTypes
The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your invoice template settings.
InvoicesPaymentsInvoicePaymentAssociatedPaymentType
Type of payment object associated with this invoice payment.
InvoicesResourceInvoiceTaxIdType
The type of the tax ID, one of ad_nrt, ar_cuit, eu_vat, bo_tin, br_cnpj, br_cpf, cn_tin, co_nit, cr_tin, do_rcn, ec_ruc, eu_oss_vat, hr_oib, pe_ruc, ro_tin, rs_pib, sv_nit, uy_ruc, ve_rif, vn_tin, gb_vat, nz_gst, au_abn, au_arn, in_gst, no_vat, no_voec, za_vat, ch_vat, mx_rfc, sg_uen, ru_inn, ru_kpp, ca_bn, hk_br, es_cif, tw_vat, th_vat, jp_cn, jp_rn, jp_trn, li_uid, li_vat, my_itn, us_ein, kr_brn, ca_qst, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, my_sst, sg_gst, ae_trn, cl_tin, sa_vat, id_npwp, my_frp, il_vat, ge_vat, ua_vat, is_vat, bg_uic, hu_tin, si_tin, ke_pin, tr_tin, eg_tin, ph_tin, al_tin, bh_vat, kz_bin, ng_tin, om_vat, de_stn, ch_uid, tz_vat, uz_vat, uz_tin, md_vat, ma_vat, by_tin, ao_tin, bs_tin, bb_tin, cd_nif, mr_nif, me_pib, zw_tin, ba_tin, gn_nif, mk_vat, sr_fin, sn_ninea, am_tin, np_pan, tj_tin, ug_tin, zm_tin, kh_tin, aw_tin, az_tin, bd_bin, bj_ifu, et_tin, kg_tin, la_tin, cm_niu, cv_nif, bf_ifu, or unknown.
InvoicesResourcePretaxCreditAmountType
Type of the pretax credit amount referenced.
PlanBillingScheme
PlanInterval
PlanTiersMode
PlanUsageType
PortalCustomerUpdateAllowedUpdates
The types of customer updates that are supported. When empty, customers are not updateable.
PortalFlowsFlowAfterCompletionType
The specified type of behavior after the flow is completed.
PortalFlowsFlowType
Type of flow that the customer will go through.
PortalFlowsRetentionType
Type of retention strategy that will be used.
PortalResourceScheduleUpdateAtPeriodEndConditionType
The type of condition.
PortalSubscriptionCancelMode
Whether to cancel subscriptions immediately or at the end of the billing period.
PortalSubscriptionCancelProrationBehavior
Whether to create prorations when canceling subscriptions. Possible values are none and create_prorations.
PortalSubscriptionCancellationReasonOptions
Which cancellation reasons will be given as options to the customer.
PortalSubscriptionUpdateDefaultAllowedUpdates
The types of subscription updates that are supported for items listed in the products attribute. When empty, subscriptions are not updateable.
PortalSubscriptionUpdateProrationBehavior
Determines how to handle prorations resulting from subscription updates. Valid values are none, create_prorations, and always_invoice. Defaults to a value of none if you don’t set it during creation.
QuoteCollectionMethod
QuoteStatus
QuotesResourceAutomaticTaxStatus
The status of the most recent automated tax calculation for this quote.
QuotesResourceRecurringInterval
The frequency at which a subscription is billed. One of day, week, month or year.
SchedulesPhaseAutomaticTaxDisabledReason
If Stripe disabled automatic tax, this enum describes why.
SubscriptionAutomaticTaxDisabledReason
If Stripe disabled automatic tax, this enum describes why.
SubscriptionCollectionMethod
SubscriptionPaymentMethodOptionsCardNetwork
Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.
SubscriptionPaymentMethodOptionsCardRequestThreeDSecure
We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine.
SubscriptionPendingInvoiceItemIntervalInterval
Specifies invoicing frequency. Either day, week, month or year.
SubscriptionScheduleEndBehavior
SubscriptionSchedulePhaseConfigurationBillingCycleAnchor
Possible values are phase_start or automatic. If phase_start then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If automatic then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle documentation.
SubscriptionSchedulePhaseConfigurationCollectionMethod
Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as active.
SubscriptionSchedulePhaseConfigurationProrationBehavior
If the subscription schedule will prorate when transitioning to this phase. Possible values are create_prorations and none.
SubscriptionScheduleStatus
The present status of the subscription schedule. Possible values are not_started, active, completed, released, and canceled. You can read more about the different states in our behavior guide.
SubscriptionSchedulesResourceDefaultSettingsAutomaticTaxDisabledReason
If Stripe disabled automatic tax, this enum describes why.
SubscriptionSchedulesResourceDefaultSettingsBillingCycleAnchor
Possible values are phase_start or automatic. If phase_start then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If automatic then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle documentation.
SubscriptionSchedulesResourceDefaultSettingsCollectionMethod
Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as active.
SubscriptionStatus
Possible values are incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, or paused.
SubscriptionsResourcePauseCollectionBehavior
The payment collection behavior for this subscription while paused. One of keep_as_draft, mark_uncollectible, or void.
SubscriptionsResourcePaymentSettingsPaymentMethodTypes
The list of payment method types to provide to every invoice created by the subscription. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your invoice template settings.
SubscriptionsResourcePaymentSettingsSaveDefaultPaymentMethod
Configure whether Stripe updates subscription.default_payment_method when payment succeeds. Defaults to off.
TaxIDsOwnerType
Type of owner referenced.
TaxIdType
Type of the tax ID, one of ad_nrt, ae_trn, al_tin, am_tin, ao_tin, ar_cuit, au_abn, au_arn, aw_tin, az_tin, ba_tin, bb_tin, bd_bin, bf_ifu, bg_uic, bh_vat, bj_ifu, bo_tin, br_cnpj, br_cpf, bs_tin, by_tin, ca_bn, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, ca_qst, cd_nif, ch_uid, ch_vat, cl_tin, cm_niu, cn_tin, co_nit, cr_tin, cv_nif, de_stn, do_rcn, ec_ruc, eg_tin, es_cif, et_tin, eu_oss_vat, eu_vat, gb_vat, ge_vat, gn_nif, hk_br, hr_oib, hu_tin, id_npwp, il_vat, in_gst, is_vat, jp_cn, jp_rn, jp_trn, ke_pin, kg_tin, kh_tin, kr_brn, kz_bin, la_tin, li_uid, li_vat, ma_vat, md_vat, me_pib, mk_vat, mr_nif, mx_rfc, my_frp, my_itn, my_sst, ng_tin, no_vat, no_voec, np_pan, nz_gst, om_vat, pe_ruc, ph_tin, ro_tin, rs_pib, ru_inn, ru_kpp, sa_vat, sg_gst, sg_uen, si_tin, sn_ninea, sr_fin, sv_nit, th_vat, tj_tin, tr_tin, tw_vat, tz_vat, ua_vat, ug_tin, us_ein, uy_ruc, uz_tin, uz_vat, ve_rif, vn_tin, za_vat, zm_tin, or zw_tin. Note that some legacy tax IDs have type unknown.
TaxIdVerificationStatus
Verification status, one of pending, verified, unverified, or unavailable.
TestHelpersTestClockStatus
The status of the Test Clock.
ThresholdsResourceUsageAlertFilterType
ThresholdsResourceUsageThresholdConfigRecurrence
Defines how the alert will behave.
TransformUsageRound
After division, either round the result up or down.