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§
- Automatic
Tax - Billing
Alert - 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.
- Billing
Alert Id - Billing
Alert Triggered - Billing
Alert Triggered Builder - Billing
Bill Resource Invoice Item Parents Invoice Item Parent - Billing
Bill Resource Invoice Item Parents Invoice Item Parent Builder - Billing
Bill Resource Invoice Item Parents Invoice Item Subscription Parent - Billing
Bill Resource Invoice Item Parents Invoice Item Subscription Parent Builder - Billing
Bill Resource Invoicing Lines Common Credited Items - Billing
Bill Resource Invoicing Lines Common Proration Details - Billing
Bill Resource Invoicing Lines Parents Invoice Line Item Invoice Item Parent - Billing
Bill Resource Invoicing Lines Parents Invoice Line Item Parent - Billing
Bill Resource Invoicing Lines Parents Invoice Line Item Subscription Item Parent - Billing
Bill Resource Invoicing Parents Invoice Parent - Billing
Bill Resource Invoicing Parents Invoice Quote Parent - Billing
Bill Resource Invoicing Parents Invoice Subscription Parent - Billing
Bill Resource Invoicing Pricing Pricing - Billing
Bill Resource Invoicing Pricing Pricing Price Details - Billing
Bill Resource Invoicing Taxes Tax - Billing
Bill Resource Invoicing Taxes TaxRate Details - Billing
Clocks Resource Status Details Advancing Status Details - Billing
Clocks Resource Status Details Status Details - Billing
Credit Balance Summary - Indicates the billing credit balance for billing credits granted to a customer.
- Billing
Credit Balance Transaction - A credit balance transaction is a resource representing a transaction (either a credit or a debit) against an existing credit grant.
- Billing
Credit Balance Transaction Id - Billing
Credit Grant - A credit grant is an API resource that documents the allocation of some billing credits to a customer.
- Billing
Credit Grant Id - Billing
Credit Grants Resource Amount - Billing
Credit Grants Resource Applicability Config - Billing
Credit Grants Resource Applicable Price - Billing
Credit Grants Resource Applicable Price Id - Billing
Credit Grants Resource Balance Credit - Billing
Credit Grants Resource Balance Credits Application Invoice Voided - Billing
Credit Grants Resource Balance Credits Applied - Billing
Credit Grants Resource Balance Debit - Billing
Credit Grants Resource Monetary Amount - Billing
Credit Grants Resource Scope - Billing
Meter - 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.
- Billing
Meter Event - 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.
- Billing
Meter Event Adjustment - 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.
- Billing
Meter Event Summary - 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.
- Billing
Meter Event Summary Id - Billing
Meter Id - Billing
Meter Resource Aggregation Settings - Billing
Meter Resource Aggregation Settings Builder - Billing
Meter Resource Billing Meter Event Adjustment Cancel - Billing
Meter Resource Billing Meter Event Adjustment Cancel Builder - Billing
Meter Resource Billing Meter Status Transitions - Billing
Meter Resource Billing Meter Status Transitions Builder - Billing
Meter Resource Billing Meter Value - Billing
Meter Resource Billing Meter Value Builder - Billing
Meter Resource Customer Mapping Settings - Billing
Meter Resource Customer Mapping Settings Builder - Billing
Portal Configuration - A portal configuration describes the functionality and behavior of a portal session.
- Billing
Portal Configuration Id - Billing
Portal Session - The Billing customer portal is a Stripe-hosted UI for subscription and billing management.
- Billing
Portal Session Id - Cancellation
Details - Checkout
Session Item - A line item.
- Checkout
Session Item Id - Credit
Balance - Credit
Balance Builder - Credit
Note - Issue a credit note to adjust an invoice’s amount after the invoice is finalized.
- Credit
Note Id - Credit
Note Line Item - The credit note line item object
- Credit
Note Line Item Id - Credit
Note Refund - Credit
Notes Pretax Credit Amount - Deleted
Invoice - Deleted
Invoiceitem - Deleted
Invoiceitem Builder - Deleted
Plan - Deleted
Subscription Item - Deleted
TaxId - Deleted
Test Helpers Test Clock - Discounts
Resource Discount Amount - Discounts
Resource Stackable Discount - Invoice
- Invoices are statements of amounts owed by a customer, and are either generated one-off, or generated periodically from a subscription.
- Invoice
Id - Invoice
Installments Card - Invoice
Item - 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. - Invoice
Item Id - Invoice
Item Threshold Reason - Invoice
Line Item - Invoice Line Items represent the individual lines within an invoice and only exist within the context of an invoice.
- Invoice
Line Item Id - Invoice
Line Item Period - Invoice
Mandate Options Card - Invoice
Payment - The invoice payment object
- Invoice
Payment Id - Invoice
Payment Method Options Acss Debit - Invoice
Payment Method Options Acss Debit Mandate Options - Invoice
Payment Method Options Bancontact - Invoice
Payment Method Options Card - Invoice
Payment Method Options Customer Balance - Invoice
Payment Method Options Customer Balance Bank Transfer - Invoice
Payment Method Options Customer Balance Bank Transfer EuBank Transfer - Invoice
Payment Method Options Konbini - Invoice
Payment Method Options Sepa Debit - Invoice
Payment Method Options UsBank Account - Invoice
Payment Method Options UsBank Account Linked Account Options - Invoice
Payment Method Options UsBank Account Linked Account Options Filters - Invoice
Rendering Pdf - Invoice
Rendering Template - 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.
- Invoice
Rendering Template Id - Invoice
Setting Checkout Rendering Options - Invoice
Setting Custom Field - Invoice
Setting Customer Rendering Options - Invoice
Setting Customer Setting - Invoice
Setting Quote Setting - Invoice
Setting Quote Setting Builder - Invoice
Setting Subscription Schedule Phase Setting - Invoice
Setting Subscription Schedule Setting - Invoice
Threshold Reason - Invoices
Payment Method Options - Invoices
Payment Settings - Invoices
Payments Invoice Payment Associated Payment - Invoices
Payments Invoice Payment Status Transitions - Invoices
Resource Confirmation Secret - Invoices
Resource From Invoice - Invoices
Resource Invoice Rendering - Invoices
Resource Invoice TaxId - Invoices
Resource Pretax Credit Amount - Invoices
Resource Shipping Cost - Invoices
Resource Status Transitions - 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
- Plan
Tier - Portal
Business Profile - Portal
Business Profile Builder - Portal
Customer Update - Portal
Customer Update Builder - Portal
Features - Portal
Features Builder - Portal
Flows After Completion Hosted Confirmation - Portal
Flows After Completion Hosted Confirmation Builder - Portal
Flows After Completion Redirect - Portal
Flows After Completion Redirect Builder - Portal
Flows Coupon Offer - Portal
Flows Coupon Offer Builder - Portal
Flows Flow - Portal
Flows Flow After Completion - Portal
Flows Flow After Completion Builder - Portal
Flows Flow Builder - Portal
Flows Flow Subscription Cancel - Portal
Flows Flow Subscription Cancel Builder - Portal
Flows Flow Subscription Update - Portal
Flows Flow Subscription Update Builder - Portal
Flows Flow Subscription Update Confirm - Portal
Flows Flow Subscription Update Confirm Builder - Portal
Flows Retention - Portal
Flows Retention Builder - Portal
Flows Subscription Update Confirm Discount - Portal
Flows Subscription Update Confirm Discount Builder - Portal
Flows Subscription Update Confirm Item - Portal
Flows Subscription Update Confirm Item Builder - Portal
Flows Subscription Update Confirm Item Id - Portal
Invoice List - Portal
Invoice List Builder - Portal
Login Page - Portal
Login Page Builder - Portal
Payment Method Update - Portal
Payment Method Update Builder - Portal
Resource Schedule Update AtPeriod End - Portal
Resource Schedule Update AtPeriod EndBuilder - Portal
Resource Schedule Update AtPeriod EndCondition - Portal
Resource Schedule Update AtPeriod EndCondition Builder - Portal
Subscription Cancel - Portal
Subscription Cancel Builder - Portal
Subscription Cancellation Reason - Portal
Subscription Cancellation Reason Builder - Portal
Subscription Update - Portal
Subscription Update Builder - Portal
Subscription Update Product - Portal
Subscription Update Product Builder - 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
- Quotes
Resource Automatic Tax - Quotes
Resource Automatic TaxBuilder - Quotes
Resource Computed - Quotes
Resource Computed Builder - Quotes
Resource From Quote - Quotes
Resource From Quote Builder - Quotes
Resource Recurring - Quotes
Resource Recurring Builder - Quotes
Resource Status Transitions - Quotes
Resource Status Transitions Builder - Quotes
Resource Subscription Data Subscription Data - Quotes
Resource Subscription Data Subscription Data Builder - Quotes
Resource Total Details - Quotes
Resource Total Details Builder - Quotes
Resource Total Details Resource Breakdown - Quotes
Resource Total Details Resource Breakdown Builder - Quotes
Resource Transfer Data - Quotes
Resource Transfer Data Builder - Quotes
Resource Upfront - Quotes
Resource Upfront Builder - Schedules
Phase Automatic Tax - Subscription
- Subscriptions allow you to charge a customer on a recurring basis.
- Subscription
Automatic Tax - Subscription
Id - Subscription
Item - Subscription items allow you to create customer subscriptions with more than one plan, making it easy to represent complex billing relationships.
- Subscription
Item Id - Subscription
Payment Method Options Card - Subscription
Pending Invoice Item Interval - Subscription
Schedule - A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes.
- Subscription
Schedule AddInvoice Item - An Add Invoice Item describes the prices and quantities that will be added as pending invoice items when entering a phase.
- Subscription
Schedule Configuration Item - A phase item describes the price and quantity of a phase.
- Subscription
Schedule Current Phase - Subscription
Schedule Id - Subscription
Schedule Phase Configuration - A phase describes the plans, coupon, and trialing status of a subscription for a predefined time period.
- Subscription
Schedules Resource Default Settings - Subscription
Schedules Resource Default Settings Automatic Tax - Subscription
Transfer Data - Subscriptions
Resource Billing Cycle Anchor Config - Subscriptions
Resource Pause Collection - The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription. should be paused.
- Subscriptions
Resource Payment Method Options - Subscriptions
Resource Payment Settings - Subscriptions
Resource Pending Update - Pending Updates store the changes pending from a previous update that will be applied to the Subscription upon successful payment.
- Subscriptions
Resource Subscription Invoice Settings - TaxI
DsOwner - 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
- TaxId
Verification - Test
Helpers Test Clock - 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.
- Test
Helpers Test Clock Id - Thresholds
Resource Usage Alert Filter - Thresholds
Resource Usage Alert Filter Builder - Thresholds
Resource Usage Threshold Config - The usage threshold alert configuration enables setting up alerts for when a certain usage threshold on a specific meter is crossed.
- Thresholds
Resource Usage Threshold Config Builder - Transform
Usage
Enums§
- Automatic
TaxDisabled Reason - If Stripe disabled automatic tax, this enum describes why.
- Automatic
TaxStatus - The status of the most recent automated tax calculation for this invoice.
- Billing
Alert Alert Type - Billing
Alert Status - Status of the alert. This can be active, inactive or archived.
- Billing
Bill Resource Invoice Item Parents Invoice Item Parent Type - The type of parent that generated this invoice item
- Billing
Bill Resource Invoicing Lines Parents Invoice Line Item Parent Type - The type of parent that generated this line item
- Billing
Bill Resource Invoicing Parents Invoice Parent Type - The type of parent that generated this invoice
- Billing
Bill Resource Invoicing Pricing Pricing Type - The type of the pricing details.
- Billing
Bill Resource Invoicing Taxes TaxTax Behavior - Whether this tax is inclusive or exclusive.
- Billing
Bill Resource Invoicing Taxes TaxTaxability Reason - 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.
- Billing
Bill Resource Invoicing Taxes TaxType - The type of tax information.
- Billing
Credit Balance Transaction Type - The type of credit balance transaction (credit or debit).
- Billing
Credit Grant Category - Billing
Credit Grants Resource Amount Type - The type of this amount. We currently only support
monetary
billing credits. - Billing
Credit Grants Resource Balance Credit Type - The type of credit transaction.
- Billing
Credit Grants Resource Balance Debit Type - The type of debit transaction.
- Billing
Credit Grants Resource Scope Price Type - 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 withprices
. - Billing
Meter Event Adjustment Status - The meter event adjustment’s status.
- Billing
Meter Event Adjustment Type - Billing
Meter Event Time Window - Billing
Meter Resource Aggregation Settings Formula - Specifies how events are aggregated.
- Billing
Meter Resource Customer Mapping Settings Type - The method for mapping a meter event to a customer.
- Billing
Meter Status - Billing
Portal Session Locale - Cancellation
Details Feedback - The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.
- Cancellation
Details Reason - Why this subscription was canceled.
- Credit
Note Line Item Type - The type of the credit note line item, one of
invoice_line_item
orcustom_line_item
. When the type isinvoice_line_item
there is an additionalinvoice_line_item
property on the resource the value of which is the id of the credited line item on the invoice. - Credit
Note Reason - Credit
Note Status - Status of this credit note, one of
issued
orvoid
. Learn more about voiding credit notes. - Credit
Note Type - Type of this credit note, one of
pre_payment
orpost_payment
. Apre_payment
credit note means it was issued when the invoice was open. Apost_payment
credit note means it was issued when the invoice was paid. - Credit
Notes Pretax Credit Amount Type - Type of the pretax credit amount referenced.
- Invoice
Billing Reason - Indicates the reason why the invoice was created.
- Invoice
Collection Method - Invoice
Customer TaxExempt - 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. - Invoice
Mandate Options Card Amount Type - One of
fixed
ormaximum
. Iffixed
, theamount
param refers to the exact amount to be charged in future payments. Ifmaximum
, the amount charged can be up to the value passed for theamount
param. - Invoice
Payment Method Options Acss Debit Mandate Options Transaction Type - Transaction type of the mandate.
- Invoice
Payment Method Options Acss Debit Verification Method - Bank account verification method.
- Invoice
Payment Method Options Bancontact Preferred Language - Preferred language of the Bancontact authorization page that the customer is redirected to.
- Invoice
Payment Method Options Card Request ThreeD Secure - 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.
- Invoice
Payment Method Options Customer Balance Bank Transfer EuBank Transfer Country - The desired country code of the bank account information.
Permitted values include:
BE
,DE
,ES
,FR
,IE
, orNL
. - Invoice
Payment Method Options Customer Balance Funding Type - The funding method type to be used when there are not enough funds in the customer balance.
Permitted values include:
bank_transfer
. - Invoice
Payment Method Options UsBank Account Linked Account Options Filters Account Subcategories - The account subcategories to use to filter for possible accounts to link.
Valid subcategories are
checking
andsavings
. - Invoice
Payment Method Options UsBank Account Linked Account Options Permissions - The list of permissions to request. The
payment_method
permission must be included. - Invoice
Payment Method Options UsBank Account Linked Account Options Prefetch - Data features requested to be retrieved upon account creation.
- Invoice
Payment Method Options UsBank Account Verification Method - Bank account verification method.
- Invoice
Rendering PdfPage Size - 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.
- Invoice
Rendering Template Status - Invoice
Status - Invoices
Payment Settings Payment Method Types - 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.
- Invoices
Payments Invoice Payment Associated Payment Type - Type of payment object associated with this invoice payment.
- Invoices
Resource Invoice TaxId Type - 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
, orunknown
. - Invoices
Resource Pretax Credit Amount Type - Type of the pretax credit amount referenced.
- Plan
Billing Scheme - Plan
Interval - Plan
Tiers Mode - Plan
Usage Type - Portal
Customer Update Allowed Updates - The types of customer updates that are supported. When empty, customers are not updateable.
- Portal
Flows Flow After Completion Type - The specified type of behavior after the flow is completed.
- Portal
Flows Flow Type - Type of flow that the customer will go through.
- Portal
Flows Retention Type - Type of retention strategy that will be used.
- Portal
Resource Schedule Update AtPeriod EndCondition Type - The type of condition.
- Portal
Subscription Cancel Mode - Whether to cancel subscriptions immediately or at the end of the billing period.
- Portal
Subscription Cancel Proration Behavior - Whether to create prorations when canceling subscriptions.
Possible values are
none
andcreate_prorations
. - Portal
Subscription Cancellation Reason Options - Which cancellation reasons will be given as options to the customer.
- Portal
Subscription Update Default Allowed Updates - The types of subscription updates that are supported for items listed in the
products
attribute. When empty, subscriptions are not updateable. - Portal
Subscription Update Proration Behavior - Determines how to handle prorations resulting from subscription updates.
Valid values are
none
,create_prorations
, andalways_invoice
. Defaults to a value ofnone
if you don’t set it during creation. - Quote
Collection Method - Quote
Status - Quotes
Resource Automatic TaxStatus - The status of the most recent automated tax calculation for this quote.
- Quotes
Resource Recurring Interval - The frequency at which a subscription is billed. One of
day
,week
,month
oryear
. - Schedules
Phase Automatic TaxDisabled Reason - If Stripe disabled automatic tax, this enum describes why.
- Subscription
Automatic TaxDisabled Reason - If Stripe disabled automatic tax, this enum describes why.
- Subscription
Collection Method - Subscription
Payment Method Options Card Network - 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.
- Subscription
Payment Method Options Card Request ThreeD Secure - 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.
- Subscription
Pending Invoice Item Interval Interval - Specifies invoicing frequency. Either
day
,week
,month
oryear
. - Subscription
Schedule EndBehavior - Subscription
Schedule Phase Configuration Billing Cycle Anchor - Possible values are
phase_start
orautomatic
. Ifphase_start
then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. Ifautomatic
then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle documentation. - Subscription
Schedule Phase Configuration Collection Method - Either
charge_automatically
, orsend_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 asactive
. - Subscription
Schedule Phase Configuration Proration Behavior - If the subscription schedule will prorate when transitioning to this phase.
Possible values are
create_prorations
andnone
. - Subscription
Schedule Status - The present status of the subscription schedule.
Possible values are
not_started
,active
,completed
,released
, andcanceled
. You can read more about the different states in our behavior guide. - Subscription
Schedules Resource Default Settings Automatic TaxDisabled Reason - If Stripe disabled automatic tax, this enum describes why.
- Subscription
Schedules Resource Default Settings Billing Cycle Anchor - Possible values are
phase_start
orautomatic
. Ifphase_start
then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. Ifautomatic
then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle documentation. - Subscription
Schedules Resource Default Settings Collection Method - Either
charge_automatically
, orsend_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 asactive
. - Subscription
Status - Possible values are
incomplete
,incomplete_expired
,trialing
,active
,past_due
,canceled
,unpaid
, orpaused
. - Subscriptions
Resource Pause Collection Behavior - The payment collection behavior for this subscription while paused.
One of
keep_as_draft
,mark_uncollectible
, orvoid
. - Subscriptions
Resource Payment Settings Payment Method Types - 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.
- Subscriptions
Resource Payment Settings Save Default Payment Method - Configure whether Stripe updates
subscription.default_payment_method
when payment succeeds. Defaults tooff
. - TaxI
DsOwner Type - Type of owner referenced.
- TaxId
Type - 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
, orzw_tin
. Note that some legacy tax IDs have typeunknown
. - TaxId
Verification Status - Verification status, one of
pending
,verified
,unverified
, orunavailable
. - Test
Helpers Test Clock Status - The status of the Test Clock.
- Thresholds
Resource Usage Alert Filter Type - Thresholds
Resource Usage Threshold Config Recurrence - Defines how the alert will behave.
- Transform
Usage Round - After division, either round the result
up
ordown
.