djstripe.enums
APIKeyType
Bases: Enum
API Key Types (internal model only)
publishable
attribute publishable
restricted
attribute restricted
secret
attribute secret
AccountType
Bases: Enum
custom
attribute custom
express
attribute express
standard
attribute standard
ApiErrorCode
Bases: Enum
Charge failure error codes.
https://stripe.com/docs/error-codes
account_already_exists
attribute account_already_exists
account_country_invalid_address
attribute account_country_invalid_address
account_invalid
attribute account_invalid
account_number_invalid
attribute account_number_invalid
alipay_upgrade_required
attribute alipay_upgrade_required
amount_too_large
attribute amount_too_large
amount_too_small
attribute amount_too_small
api_key_expired
attribute api_key_expired
balance_insufficient
attribute balance_insufficient
bank_account_exists
attribute bank_account_exists
bank_account_unusable
attribute bank_account_unusable
bank_account_unverified
attribute bank_account_unverified
bitcoin_upgrade_required
attribute bitcoin_upgrade_required
card_declined
attribute card_declined
charge_already_captured
attribute charge_already_captured
charge_already_refunded
attribute charge_already_refunded
charge_disputed
attribute charge_disputed
charge_exceeds_source_limit
attribute charge_exceeds_source_limit
charge_expired_for_capture
attribute charge_expired_for_capture
country_unsupported
attribute country_unsupported
coupon_expired
attribute coupon_expired
customer_max_subscriptions
attribute customer_max_subscriptions
email_invalid
attribute email_invalid
expired_card
attribute expired_card
idempotency_key_in_use
attribute idempotency_key_in_use
incorrect_address
attribute incorrect_address
incorrect_cvc
attribute incorrect_cvc
incorrect_number
attribute incorrect_number
incorrect_zip
attribute incorrect_zip
instant_payouts_unsupported
attribute instant_payouts_unsupported
invalid_card_type
attribute invalid_card_type
invalid_charge_amount
attribute invalid_charge_amount
invalid_cvc
attribute invalid_cvc
invalid_expiry_month
attribute invalid_expiry_month
invalid_expiry_year
attribute invalid_expiry_year
invalid_number
attribute invalid_number
invalid_source_usage
attribute invalid_source_usage
invalid_swipe_data
attribute invalid_swipe_data
invoice_no_customer_line_items
attribute invoice_no_customer_line_items
invoice_no_subscription_line_items
attribute invoice_no_subscription_line_items
invoice_not_editable
attribute invoice_not_editable
invoice_upcoming_none
attribute invoice_upcoming_none
livemode_mismatch
attribute livemode_mismatch
missing
attribute missing
not_allowed_on_standard_account
attribute not_allowed_on_standard_account
order_creation_failed
attribute order_creation_failed
order_required_settings
attribute order_required_settings
order_status_invalid
attribute order_status_invalid
order_upstream_timeout
attribute order_upstream_timeout
out_of_inventory
attribute out_of_inventory
parameter_invalid_empty
attribute parameter_invalid_empty
parameter_invalid_integer
attribute parameter_invalid_integer
parameter_invalid_string_blank
attribute parameter_invalid_string_blank
parameter_invalid_string_empty
attribute parameter_invalid_string_empty
parameter_missing
attribute parameter_missing
parameter_unknown
attribute parameter_unknown
parameters_exclusive
attribute parameters_exclusive
payment_intent_authentication_failure
attribute payment_intent_authentication_failure
payment_intent_incompatible_payment_method
attribute payment_intent_incompatible_payment_method
payment_intent_invalid_parameter
attribute payment_intent_invalid_parameter
payment_intent_payment_attempt_failed
attribute payment_intent_payment_attempt_failed
payment_intent_unexpected_state
attribute payment_intent_unexpected_state
payment_method_unactivated
attribute payment_method_unactivated
payment_method_unexpected_state
attribute payment_method_unexpected_state
payouts_not_allowed
attribute payouts_not_allowed
platform_api_key_expired
attribute platform_api_key_expired
postal_code_invalid
attribute postal_code_invalid
processing_error
attribute processing_error
product_inactive
attribute product_inactive
rate_limit
attribute rate_limit
resource_already_exists
attribute resource_already_exists
resource_missing
attribute resource_missing
routing_number_invalid
attribute routing_number_invalid
secret_key_required
attribute secret_key_required
sepa_unsupported_account
attribute sepa_unsupported_account
shipping_calculation_failed
attribute shipping_calculation_failed
sku_inactive
attribute sku_inactive
state_unsupported
attribute state_unsupported
tax_id_invalid
attribute tax_id_invalid
taxes_calculation_failed
attribute taxes_calculation_failed
testmode_charges_only
attribute testmode_charges_only
tls_version_unsupported
attribute tls_version_unsupported
token_already_used
attribute token_already_used
token_in_use
attribute token_in_use
transfers_not_allowed
attribute transfers_not_allowed
upstream_order_creation_failed
attribute upstream_order_creation_failed
url_invalid
attribute url_invalid
BalanceTransactionReportingCategory
Bases: Enum
https://stripe.com/docs/reports/reporting-categories
advance
attribute advance
advance_funding
attribute advance_funding
anticipation_repayment
attribute anticipation_repayment
charge
attribute charge
charge_failure
attribute charge_failure
connect_collection_transfer
attribute connect_collection_transfer
connect_reserved_funds
attribute connect_reserved_funds
dispute
attribute dispute
dispute_reversal
attribute dispute_reversal
fee
attribute fee
issuing_authorization_hold
attribute issuing_authorization_hold
issuing_authorization_release
attribute issuing_authorization_release
issuing_dispute
attribute issuing_dispute
issuing_transaction
attribute issuing_transaction
other_adjustment
attribute other_adjustment
partial_capture_reversal
attribute partial_capture_reversal
payout
attribute payout
payout_reversal
attribute payout_reversal
platform_earning
attribute platform_earning
platform_earning_refund
attribute platform_earning_refund
refund
attribute refund
refund_failure
attribute refund_failure
risk_reserved_funds
attribute risk_reserved_funds
tax
attribute tax
topup
attribute topup
topup_reversal
attribute topup_reversal
transfer
attribute transfer
transfer_reversal
attribute transfer_reversal
BalanceTransactionStatus
Bases: Enum
available
attribute available
pending
attribute pending
BalanceTransactionType
Bases: Enum
adjustment
attribute adjustment
advance
attribute advance
advance_funding
attribute advance_funding
anticipation_repayment
attribute anticipation_repayment
application_fee
attribute application_fee
application_fee_refund
attribute application_fee_refund
balance_transfer_inbound
attribute balance_transfer_inbound
balance_transfer_outbound
attribute balance_transfer_outbound
charge
attribute charge
connect_collection_transfer
attribute connect_collection_transfer
contribution
attribute contribution
issuing_authorization_hold
attribute issuing_authorization_hold
issuing_authorization_release
attribute issuing_authorization_release
issuing_dispute
attribute issuing_dispute
issuing_transaction
attribute issuing_transaction
network_cost
attribute network_cost
payment
attribute payment
payment_failure_refund
attribute payment_failure_refund
payment_refund
attribute payment_refund
payout
attribute payout
payout_cancel
attribute payout_cancel
payout_failure
attribute payout_failure
refund
attribute refund
refund_failure
attribute refund_failure
reserve_transaction
attribute reserve_transaction
reserved_funds
attribute reserved_funds
stripe_fee
attribute stripe_fee
stripe_fx_fee
attribute stripe_fx_fee
tax_fee
attribute tax_fee
topup
attribute topup
topup_reversal
attribute topup_reversal
transfer
attribute transfer
transfer_cancel
attribute transfer_cancel
transfer_failure
attribute transfer_failure
transfer_refund
attribute transfer_refund
validation
attribute validation
BankAccountHolderType
Bases: Enum
company
attribute company
individual
attribute individual
BankAccountStatus
Bases: Enum
errored
attribute errored
new
attribute new
validated
attribute validated
verification_failed
attribute verification_failed
verified
attribute verified
BillingScheme
Bases: Enum
per_unit
attribute per_unit
tiered
attribute tiered
BusinessType
Bases: Enum
company
attribute company
government_entity
attribute government_entity
individual
attribute individual
non_profit
attribute non_profit
CaptureMethod
Bases: Enum
automatic
attribute automatic
automatic_async
attribute automatic_async
manual
attribute manual
CardBrand
Bases: Enum
AmericanExpress
attribute AmericanExpress
DinersClub
attribute DinersClub
Discover
attribute Discover
JCB
attribute JCB
MasterCard
attribute MasterCard
UnionPay
attribute UnionPay
Unknown
attribute Unknown
Visa
attribute Visa
CardCheckResult
Bases: Enum
fail
attribute fail
pass_
attribute pass_
unavailable
attribute unavailable
unchecked
attribute unchecked
CardFundingType
Bases: Enum
credit
attribute credit
debit
attribute debit
prepaid
attribute prepaid
unknown
attribute unknown
CardTokenizationMethod
Bases: Enum
android_pay
attribute android_pay
apple_pay
attribute apple_pay
ChargeStatus
Bases: Enum
failed
attribute failed
pending
attribute pending
succeeded
attribute succeeded
ConfirmationMethod
Bases: Enum
automatic
attribute automatic
manual
attribute manual
CouponDuration
Bases: Enum
forever
attribute forever
once
attribute once
repeating
attribute repeating
CustomerTaxExempt
Bases: Enum
exempt
attribute exempt
none
attribute none
reverse
attribute reverse
DisputeReason
Bases: Enum
bank_cannot_process
attribute bank_cannot_process
credit_not_processed
attribute credit_not_processed
customer_initiated
attribute customer_initiated
debit_not_authorized
attribute debit_not_authorized
duplicate
attribute duplicate
fraudulent
attribute fraudulent
general
attribute general
incorrect_account_details
attribute incorrect_account_details
insufficient_funds
attribute insufficient_funds
product_not_received
attribute product_not_received
product_unacceptable
attribute product_unacceptable
subscription_canceled
attribute subscription_canceled
unrecognized
attribute unrecognized
DisputeStatus
Bases: Enum
charge_refunded
attribute charge_refunded
lost
attribute lost
needs_response
attribute needs_response
under_review
attribute under_review
warning_closed
attribute warning_closed
warning_needs_response
attribute warning_needs_response
warning_under_review
attribute warning_under_review
won
attribute won
DjstripePaymentMethodType
Bases: Enum
A djstripe-specific enum for the DjStripePaymentMethod model.
alipay_account
attribute alipay_account
bank_account
attribute bank_account
card
attribute card
source
attribute source
Enum
EnumMetaClass
Bases: type
FilePurpose
Bases: Enum
account_requirement
attribute account_requirement
additional_verification
attribute additional_verification
business_icon
attribute business_icon
business_logo
attribute business_logo
credit_note
attribute credit_note
customer_signature
attribute customer_signature
dispute_evidence
attribute dispute_evidence
document_provider_identity_document
attribute document_provider_identity_document
finance_report_run
attribute finance_report_run
identity_document
attribute identity_document
identity_document_downloadable
attribute identity_document_downloadable
invoice_statement
attribute invoice_statement
pci_document
attribute pci_document
selfie
attribute selfie
sigma_scheduled_query
attribute sigma_scheduled_query
tax_document_user_upload
attribute tax_document_user_upload
FileType
Bases: Enum
csv
attribute csv
docx
attribute docx
jpg
attribute jpg
pdf
attribute pdf
png
attribute png
xls
attribute xls
xlsx
attribute xlsx
IntentStatus
Bases: Enum
Status of Intents which apply both to PaymentIntents and SetupIntents.
canceled
attribute canceled
processing
attribute processing
requires_action
attribute requires_action
requires_confirmation
attribute requires_confirmation
requires_payment_method
attribute requires_payment_method
IntentUsage
Bases: Enum
off_session
attribute off_session
on_session
attribute on_session
InvoiceBillingReason
Bases: Enum
automatic_pending_invoice_item_invoice
attribute automatic_pending_invoice_item_invoice
manual
attribute manual
subscription
attribute subscription
subscription_create
attribute subscription_create
subscription_cycle
attribute subscription_cycle
subscription_threshold
attribute subscription_threshold
subscription_update
attribute subscription_update
upcoming
attribute upcoming
InvoiceCollectionMethod
Bases: Enum
charge_automatically
attribute charge_automatically
send_invoice
attribute send_invoice
InvoiceStatus
Bases: Enum
draft
attribute draft
open
attribute open
paid
attribute paid
uncollectible
attribute uncollectible
void
attribute void
InvoiceorLineItemType
Bases: Enum
invoice_item
attribute invoice_item
line_item
attribute line_item
unsupported
attribute unsupported
LegacySourceType
Bases: Enum
alipay_account
attribute alipay_account
bank_account
attribute bank_account
bitcoin_receiver
attribute bitcoin_receiver
card
attribute card
LineItem
Bases: Enum
invoiceitem
attribute invoiceitem
subscription
attribute subscription
MandateStatus
Bases: Enum
active
attribute active
inactive
attribute inactive
pending
attribute pending
MandateType
Bases: Enum
multi_use
attribute multi_use
single_use
attribute single_use
OrderStatus
Bases: Enum
canceled
attribute canceled
complete
attribute complete
open
attribute open
processing
attribute processing
submitted
attribute submitted
PaymentIntentCancellationReason
Bases: Enum
abandoned
attribute abandoned
automatic
attribute automatic
duplicate
attribute duplicate
failed_invoice
attribute failed_invoice
fraudulent
attribute fraudulent
requested_by_customer
attribute requested_by_customer
void_invoice
attribute void_invoice
PaymentIntentStatus
Bases: Enum
canceled
attribute canceled
processing
attribute processing
requires_action
attribute requires_action
requires_capture
attribute requires_capture
requires_confirmation
attribute requires_confirmation
requires_payment_method
attribute requires_payment_method
succeeded
attribute succeeded
PaymentMethodType
Bases: Enum
acss_debit
attribute acss_debit
affirm
attribute affirm
afterpay_clearpay
attribute afterpay_clearpay
alipay
attribute alipay
au_becs_debit
attribute au_becs_debit
bacs_debit
attribute bacs_debit
bancontact
attribute bancontact
blik
attribute blik
boleto
attribute boleto
card
attribute card
card_present
attribute card_present
cashapp
attribute cashapp
customer_balance
attribute customer_balance
eps
attribute eps
fpx
attribute fpx
giropay
attribute giropay
grabpay
attribute grabpay
ideal
attribute ideal
interac_present
attribute interac_present
klarna
attribute klarna
konbini
attribute konbini
link
attribute link
oxxo
attribute oxxo
p24
attribute p24
paynow
attribute paynow
paypal
attribute paypal
pix
attribute pix
promptpay
attribute promptpay
sepa_debit
attribute sepa_debit
sofort
attribute sofort
us_bank_account
attribute us_bank_account
wechat_pay
attribute wechat_pay
zip
attribute zip
PayoutFailureCode
Bases: Enum
Payout failure error codes.
https://stripe.com/docs/api#payout_failures
account_closed
attribute account_closed
account_frozen
attribute account_frozen
bank_account_restricted
attribute bank_account_restricted
bank_ownership_changed
attribute bank_ownership_changed
could_not_process
attribute could_not_process
debit_not_authorized
attribute debit_not_authorized
declined
attribute declined
incorrect_account_holder_address
attribute incorrect_account_holder_address
incorrect_account_holder_name
attribute incorrect_account_holder_name
incorrect_account_holder_tax_id
attribute incorrect_account_holder_tax_id
insufficient_funds
attribute insufficient_funds
invalid_account_number
attribute invalid_account_number
invalid_currency
attribute invalid_currency
no_account
attribute no_account
unsupported_card
attribute unsupported_card
PayoutMethod
Bases: Enum
instant
attribute instant
standard
attribute standard
PayoutSourceType
Bases: Enum
bank_account
attribute bank_account
card
attribute card
fpx
attribute fpx
PayoutStatus
Bases: Enum
canceled
attribute canceled
failed
attribute failed
in_transit
attribute in_transit
paid
attribute paid
pending
attribute pending
PayoutType
Bases: Enum
bank_account
attribute bank_account
card
attribute card
PlanAggregateUsage
Bases: Enum
last_during_period
attribute last_during_period
last_ever
attribute last_ever
max
attribute max
sum
attribute sum
PlanInterval
Bases: Enum
day
attribute day
month
attribute month
week
attribute week
year
attribute year
PriceTiersMode
Bases: Enum
graduated
attribute graduated
volume
attribute volume
PriceType
Bases: Enum
one_time
attribute one_time
recurring
attribute recurring
PriceUsageType
Bases: Enum
licensed
attribute licensed
metered
attribute metered
ProductType
Bases: Enum
good
attribute good
service
attribute service
RefundFailureReason
Bases: Enum
expired_or_canceled_card
attribute expired_or_canceled_card
lost_or_stolen_card
attribute lost_or_stolen_card
unknown
attribute unknown
RefundReason
Bases: Enum
duplicate
attribute duplicate
expired_uncaptured_charge
attribute expired_uncaptured_charge
fraudulent
attribute fraudulent
requested_by_customer
attribute requested_by_customer
RefundStatus
Bases: Enum
canceled
attribute canceled
failed
attribute failed
pending
attribute pending
succeeded
attribute succeeded
ScheduledQueryRunStatus
Bases: Enum
canceled
attribute canceled
failed
attribute failed
timed_out
attribute timed_out
SessionBillingAddressCollection
Bases: Enum
auto
attribute auto
required
attribute required
SessionMode
Bases: Enum
payment
attribute payment
setup
attribute setup
subscription
attribute subscription
SessionPaymentStatus
Bases: Enum
no_payment_required
attribute no_payment_required
paid
attribute paid
unpaid
attribute unpaid
SessionStatus
Bases: Enum
complete
attribute complete
expired
attribute expired
open
attribute open
SetupIntentCancellationReason
Bases: Enum
abandoned
attribute abandoned
duplicate
attribute duplicate
requested_by_customer
attribute requested_by_customer
SetupIntentStatus
Bases: Enum
canceled
attribute canceled
processing
attribute processing
requires_action
attribute requires_action
requires_confirmation
attribute requires_confirmation
requires_payment_method
attribute requires_payment_method
succeeded
attribute succeeded
ShippingRateTaxBehavior
Bases: Enum
exclusive
attribute exclusive
inclusive
attribute inclusive
unspecified
attribute unspecified
ShippingRateType
Bases: Enum
fixed_amount
attribute fixed_amount
SourceCodeVerificationStatus
Bases: Enum
failed
attribute failed
pending
attribute pending
succeeded
attribute succeeded
SourceFlow
Bases: Enum
code_verification
attribute code_verification
none
attribute none
receiver
attribute receiver
redirect
attribute redirect
SourceRedirectFailureReason
Bases: Enum
declined
attribute declined
processing_error
attribute processing_error
user_abort
attribute user_abort
SourceRedirectStatus
Bases: Enum
failed
attribute failed
not_required
attribute not_required
pending
attribute pending
succeeded
attribute succeeded
SourceStatus
Bases: Enum
canceled
attribute canceled
chargeable
attribute chargeable
consumed
attribute consumed
failed
attribute failed
pending
attribute pending
SourceTransactionStatus
Bases: Enum
chargeable
attribute chargeable
failed
attribute failed
pending
attribute pending
succeeded
attribute succeeded
SourceType
Bases: Enum
ach_credit_transfer
attribute ach_credit_transfer
ach_debit
attribute ach_debit
acss_debit
attribute acss_debit
alipay
attribute alipay
au_becs_debit
attribute au_becs_debit
bancontact
attribute bancontact
bitcoin
attribute bitcoin
card
attribute card
card_present
attribute card_present
eps
attribute eps
giropay
attribute giropay
ideal
attribute ideal
klarna
attribute klarna
multibanco
attribute multibanco
p24
attribute p24
paper_check
attribute paper_check
sepa_credit_transfer
attribute sepa_credit_transfer
sepa_debit
attribute sepa_debit
sofort
attribute sofort
three_d_secure
attribute three_d_secure
wechat
attribute wechat
SourceUsage
Bases: Enum
reusable
attribute reusable
single_use
attribute single_use
SubmitTypeStatus
Bases: Enum
auto
attribute auto
book
attribute book
donate
attribute donate
pay
attribute pay
SubscriptionProrationBehavior
Bases: Enum
always_invoice
attribute always_invoice
create_prorations
attribute create_prorations
none
attribute none
SubscriptionScheduleEndBehavior
Bases: Enum
cancel
attribute cancel
release
attribute release
SubscriptionScheduleStatus
Bases: Enum
active
attribute active
canceled
attribute canceled
completed
attribute completed
not_started
attribute not_started
released
attribute released
SubscriptionStatus
Bases: Enum
active
attribute active
canceled
attribute canceled
incomplete
attribute incomplete
incomplete_expired
attribute incomplete_expired
past_due
attribute past_due
paused
attribute paused
trialing
attribute trialing
unpaid
attribute unpaid
TaxIdType
Bases: Enum
ae_trn
attribute ae_trn
au_abn
attribute au_abn
br_cnp
attribute br_cnp
br_cpf
attribute br_cpf
ca_bn
attribute ca_bn
ca_qst
attribute ca_qst
ch_vat
attribute ch_vat
cl_tin
attribute cl_tin
es_cif
attribute es_cif
eu_vat
attribute eu_vat
hk_br
attribute hk_br
id_npw
attribute id_npw
in_gst
attribute in_gst
jp_cn
attribute jp_cn
jp_rn
attribute jp_rn
kr_brn
attribute kr_brn
li_uid
attribute li_uid
mx_rfc
attribute mx_rfc
my_frp
attribute my_frp
my_itn
attribute my_itn
my_sst
attribute my_sst
no_vat
attribute no_vat
nz_gst
attribute nz_gst
ru_inn
attribute ru_inn
ru_kpp
attribute ru_kpp
sa_vat
attribute sa_vat
sg_gst
attribute sg_gst
sg_uen
attribute sg_uen
th_vat
attribute th_vat
tw_vat
attribute tw_vat
unknown
attribute unknown
us_ein
attribute us_ein
za_vat
attribute za_vat
UsageAction
Bases: Enum
increment
attribute increment
set
attribute set
VerificationSessionStatus
Bases: Enum
canceled
attribute canceled
processing
attribute processing
requires_input
attribute requires_input
verified
attribute verified
VerificationType
Bases: Enum
document
attribute document
id_number
attribute id_number
WebhookEndpointStatus
Bases: Enum
disabled
attribute disabled
enabled
attribute enabled
WebhookEndpointValidation
Bases: Enum
An enum to specific the choices for WebhookEndpoint Validation.
none
attribute none
retrieve_event
attribute retrieve_event
verify_signature
attribute verify_signature