Enumerations¶
Last Updated 2019-09-17
ApiErrorCode¶
-
class
djstripe.enums.
ApiErrorCode
[source]¶ Charge failure error codes.
https://stripe.com/docs/error-codes
-
account_already_exists
= 'account_already_exists'¶
-
account_country_invalid_address
= 'account_country_invalid_address'¶
-
account_invalid
= 'account_invalid'¶
-
account_number_invalid
= 'account_number_invalid'¶
-
alipay_upgrade_required
= 'alipay_upgrade_required'¶
-
amount_too_large
= 'amount_too_large'¶
-
amount_too_small
= 'amount_too_small'¶
-
api_key_expired
= 'api_key_expired'¶
-
balance_insufficient
= 'balance_insufficient'¶
-
bank_account_exists
= 'bank_account_exists'¶
-
bank_account_unusable
= 'bank_account_unusable'¶
-
bank_account_unverified
= 'bank_account_unverified'¶
-
bitcoin_upgrade_required
= 'bitcoin_upgrade_required'¶
-
card_declined
= 'card_declined'¶
-
charge_already_captured
= 'charge_already_captured'¶
-
charge_already_refunded
= 'charge_already_refunded'¶
-
charge_disputed
= 'charge_disputed'¶
-
charge_exceeds_source_limit
= 'charge_exceeds_source_limit'¶
-
charge_expired_for_capture
= 'charge_expired_for_capture'¶
-
choices
= (('account_already_exists', 'Account already exists'), ('account_country_invalid_address', 'Account country invalid address'), ('account_invalid', 'Account invalid'), ('account_number_invalid', 'Account number invalid'), ('alipay_upgrade_required', 'Alipay upgrade required'), ('amount_too_large', 'Amount too large'), ('amount_too_small', 'Amount too small'), ('api_key_expired', 'Api key expired'), ('balance_insufficient', 'Balance insufficient'), ('bank_account_exists', 'Bank account exists'), ('bank_account_unusable', 'Bank account unusable'), ('bank_account_unverified', 'Bank account unverified'), ('bitcoin_upgrade_required', 'Bitcoin upgrade required'), ('card_declined', 'Card was declined'), ('charge_already_captured', 'Charge already captured'), ('charge_already_refunded', 'Charge already refunded'), ('charge_disputed', 'Charge disputed'), ('charge_exceeds_source_limit', 'Charge exceeds source limit'), ('charge_expired_for_capture', 'Charge expired for capture'), ('country_unsupported', 'Country unsupported'), ('coupon_expired', 'Coupon expired'), ('customer_max_subscriptions', 'Customer max subscriptions'), ('email_invalid', 'Email invalid'), ('expired_card', 'Expired card'), ('idempotency_key_in_use', 'Idempotency key in use'), ('incorrect_address', 'Incorrect address'), ('incorrect_cvc', 'Incorrect security code'), ('incorrect_number', 'Incorrect number'), ('incorrect_zip', 'ZIP code failed validation'), ('instant_payouts_unsupported', 'Instant payouts unsupported'), ('invalid_card_type', 'Invalid card type'), ('invalid_charge_amount', 'Invalid charge amount'), ('invalid_cvc', 'Invalid security code'), ('invalid_expiry_month', 'Invalid expiration month'), ('invalid_expiry_year', 'Invalid expiration year'), ('invalid_number', 'Invalid number'), ('invalid_source_usage', 'Invalid source usage'), ('invalid_swipe_data', 'Invalid swipe data'), ('invoice_no_customer_line_items', 'Invoice no customer line items'), ('invoice_no_subscription_line_items', 'Invoice no subscription line items'), ('invoice_not_editable', 'Invoice not editable'), ('invoice_upcoming_none', 'Invoice upcoming none'), ('livemode_mismatch', 'Livemode mismatch'), ('missing', 'No card being charged'), ('not_allowed_on_standard_account', 'Not allowed on standard account'), ('order_creation_failed', 'Order creation failed'), ('order_required_settings', 'Order required settings'), ('order_status_invalid', 'Order status invalid'), ('order_upstream_timeout', 'Order upstream timeout'), ('out_of_inventory', 'Out of inventory'), ('parameter_invalid_empty', 'Parameter invalid empty'), ('parameter_invalid_integer', 'Parameter invalid integer'), ('parameter_invalid_string_blank', 'Parameter invalid string blank'), ('parameter_invalid_string_empty', 'Parameter invalid string empty'), ('parameter_missing', 'Parameter missing'), ('parameter_unknown', 'Parameter unknown'), ('parameters_exclusive', 'Parameters exclusive'), ('payment_intent_authentication_failure', 'Payment intent authentication failure'), ('payment_intent_incompatible_payment_method', 'Payment intent incompatible payment method'), ('payment_intent_invalid_parameter', 'Payment intent invalid parameter'), ('payment_intent_payment_attempt_failed', 'Payment intent payment attempt failed'), ('payment_intent_unexpected_state', 'Payment intent unexpected state'), ('payment_method_unactivated', 'Payment method unactivated'), ('payment_method_unexpected_state', 'Payment method unexpected state'), ('payouts_not_allowed', 'Payouts not allowed'), ('platform_api_key_expired', 'Platform api key expired'), ('postal_code_invalid', 'Postal code invalid'), ('processing_error', 'Processing error'), ('product_inactive', 'Product inactive'), ('rate_limit', 'Rate limit'), ('resource_already_exists', 'Resource already exists'), ('resource_missing', 'Resource missing'), ('routing_number_invalid', 'Routing number invalid'), ('secret_key_required', 'Secret key required'), ('sepa_unsupported_account', 'SEPA unsupported account'), ('shipping_calculation_failed', 'Shipping calculation failed'), ('sku_inactive', 'SKU inactive'), ('state_unsupported', 'State unsupported'), ('tax_id_invalid', 'Tax id invalid'), ('taxes_calculation_failed', 'Taxes calculation failed'), ('testmode_charges_only', 'Testmode charges only'), ('tls_version_unsupported', 'TLS version unsupported'), ('token_already_used', 'Token already used'), ('token_in_use', 'Token in use'), ('transfers_not_allowed', 'Transfers not allowed'), ('upstream_order_creation_failed', 'Upstream order creation failed'), ('url_invalid', 'URL invalid'))¶
-
country_unsupported
= 'country_unsupported'¶
-
coupon_expired
= 'coupon_expired'¶
-
customer_max_subscriptions
= 'customer_max_subscriptions'¶
-
email_invalid
= 'email_invalid'¶
-
expired_card
= 'expired_card'¶
-
idempotency_key_in_use
= 'idempotency_key_in_use'¶
-
incorrect_address
= 'incorrect_address'¶
-
incorrect_cvc
= 'incorrect_cvc'¶
-
incorrect_number
= 'incorrect_number'¶
-
incorrect_zip
= 'incorrect_zip'¶
-
instant_payouts_unsupported
= 'instant_payouts_unsupported'¶
-
invalid_card_type
= 'invalid_card_type'¶
-
invalid_charge_amount
= 'invalid_charge_amount'¶
-
invalid_cvc
= 'invalid_cvc'¶
-
invalid_expiry_month
= 'invalid_expiry_month'¶
-
invalid_expiry_year
= 'invalid_expiry_year'¶
-
invalid_number
= 'invalid_number'¶
-
invalid_source_usage
= 'invalid_source_usage'¶
-
invalid_swipe_data
= 'invalid_swipe_data'¶
-
invoice_no_customer_line_items
= 'invoice_no_customer_line_items'¶
-
invoice_no_subscription_line_items
= 'invoice_no_subscription_line_items'¶
-
invoice_not_editable
= 'invoice_not_editable'¶
-
invoice_upcoming_none
= 'invoice_upcoming_none'¶
-
livemode_mismatch
= 'livemode_mismatch'¶
-
missing
= 'missing'¶
-
not_allowed_on_standard_account
= 'not_allowed_on_standard_account'¶
-
order_creation_failed
= 'order_creation_failed'¶
-
order_required_settings
= 'order_required_settings'¶
-
order_status_invalid
= 'order_status_invalid'¶
-
order_upstream_timeout
= 'order_upstream_timeout'¶
-
out_of_inventory
= 'out_of_inventory'¶
-
parameter_invalid_empty
= 'parameter_invalid_empty'¶
-
parameter_invalid_integer
= 'parameter_invalid_integer'¶
-
parameter_invalid_string_blank
= 'parameter_invalid_string_blank'¶
-
parameter_invalid_string_empty
= 'parameter_invalid_string_empty'¶
-
parameter_missing
= 'parameter_missing'¶
-
parameter_unknown
= 'parameter_unknown'¶
-
parameters_exclusive
= 'parameters_exclusive'¶
-
payment_intent_authentication_failure
= 'payment_intent_authentication_failure'¶
-
payment_intent_incompatible_payment_method
= 'payment_intent_incompatible_payment_method'¶
-
payment_intent_invalid_parameter
= 'payment_intent_invalid_parameter'¶
-
payment_intent_payment_attempt_failed
= 'payment_intent_payment_attempt_failed'¶
-
payment_intent_unexpected_state
= 'payment_intent_unexpected_state'¶
-
payment_method_unactivated
= 'payment_method_unactivated'¶
-
payment_method_unexpected_state
= 'payment_method_unexpected_state'¶
-
payouts_not_allowed
= 'payouts_not_allowed'¶
-
platform_api_key_expired
= 'platform_api_key_expired'¶
-
postal_code_invalid
= 'postal_code_invalid'¶
-
processing_error
= 'processing_error'¶
-
product_inactive
= 'product_inactive'¶
-
rate_limit
= 'rate_limit'¶
-
resource_already_exists
= 'resource_already_exists'¶
-
resource_missing
= 'resource_missing'¶
-
routing_number_invalid
= 'routing_number_invalid'¶
-
secret_key_required
= 'secret_key_required'¶
-
sepa_unsupported_account
= 'sepa_unsupported_account'¶
-
shipping_calculation_failed
= 'shipping_calculation_failed'¶
-
sku_inactive
= 'sku_inactive'¶
-
state_unsupported
= 'state_unsupported'¶
-
tax_id_invalid
= 'tax_id_invalid'¶
-
taxes_calculation_failed
= 'taxes_calculation_failed'¶
-
testmode_charges_only
= 'testmode_charges_only'¶
-
tls_version_unsupported
= 'tls_version_unsupported'¶
-
token_already_used
= 'token_already_used'¶
-
token_in_use
= 'token_in_use'¶
-
transfers_not_allowed
= 'transfers_not_allowed'¶
-
upstream_order_creation_failed
= 'upstream_order_creation_failed'¶
-
url_invalid
= 'url_invalid'¶
-
AccountType¶
BalanceTransactionStatus¶
BalanceTransactionType¶
-
class
djstripe.enums.
BalanceTransactionType
[source]¶ -
adjustment
= 'adjustment'¶
-
advance
= 'advance'¶
-
advance_funding
= 'advance_funding'¶
-
application_fee
= 'application_fee'¶
-
application_fee_refund
= 'application_fee_refund'¶
-
charge
= 'charge'¶
-
choices
= (('adjustment', 'Adjustment'), ('advance', 'Advance'), ('advance_funding', 'Advance funding'), ('application_fee', 'Application fee'), ('application_fee_refund', 'Application fee refund'), ('charge', 'Charge'), ('connect_collection_transfer', 'Connect collection transfer'), ('issuing_authorization_hold', 'Issuing authorization hold'), ('issuing_authorization_release', 'Issuing authorization release'), ('issuing_transaction', 'Issuing transaction'), ('network_cost', 'Network cost'), ('payment', 'Payment'), ('payment_failure_refund', 'Payment failure refund'), ('payment_refund', 'Payment refund'), ('payout', 'Payout'), ('payout_cancel', 'Payout cancellation'), ('payout_failure', 'Payout failure'), ('refund', 'Refund'), ('refund_failure', 'Refund failure'), ('reserve_transaction', 'Reserve transaction'), ('reserved_funds', 'Reserved funds'), ('stripe_fee', 'Stripe fee'), ('stripe_fx_fee', 'Stripe fx fee'), ('tax_fee', 'Tax fee'), ('topup', 'Topup'), ('topup_reversal', 'Topup reversal'), ('transfer', 'Transfer'), ('transfer_cancel', 'Transfer cancel'), ('transfer_refund', 'Transfer refund'), ('validation', 'Validation'))¶
-
connect_collection_transfer
= 'connect_collection_transfer'¶
-
issuing_transaction
= 'issuing_transaction'¶
-
network_cost
= 'network_cost'¶
-
payment
= 'payment'¶
-
payment_failure_refund
= 'payment_failure_refund'¶
-
payment_refund
= 'payment_refund'¶
-
payout
= 'payout'¶
-
payout_cancel
= 'payout_cancel'¶
-
payout_failure
= 'payout_failure'¶
-
refund
= 'refund'¶
-
refund_failure
= 'refund_failure'¶
-
reserve_transaction
= 'reserve_transaction'¶
-
reserved_funds
= 'reserved_funds'¶
-
stripe_fee
= 'stripe_fee'¶
-
stripe_fx_fee
= 'stripe_fx_fee'¶
-
tax_fee
= 'tax_fee'¶
-
topup
= 'topup'¶
-
topup_reversal
= 'topup_reversal'¶
-
transfer
= 'transfer'¶
-
transfer_cancel
= 'transfer_cancel'¶
-
transfer_refund
= 'transfer_refund'¶
-
validation
= 'validation'¶
-
BankAccountHolderType¶
BankAccountStatus¶
-
class
djstripe.enums.
BankAccountStatus
[source]¶ -
choices
= (('errored', 'Errored'), ('new', 'New'), ('validated', 'Validated'), ('verification_failed', 'Verification failed'), ('verified', 'Verified'))¶
-
errored
= 'errored'¶
-
new
= 'new'¶
-
validated
= 'validated'¶
-
verification_failed
= 'verification_failed'¶
-
verified
= 'verified'¶
-
BusinessType¶
CaptureMethod¶
CardCheckResult¶
CardBrand¶
-
class
djstripe.enums.
CardBrand
[source]¶ -
AmericanExpress
= 'American Express'¶
-
DinersClub
= 'Diners Club'¶
-
Discover
= 'Discover'¶
-
JCB
= 'JCB'¶
-
MasterCard
= 'MasterCard'¶
-
UnionPay
= 'UnionPay'¶
-
Unknown
= 'Unknown'¶
-
Visa
= 'Visa'¶
-
choices
= (('American Express', 'American Express'), ('Diners Club', 'Diners Club'), ('Discover', 'Discover'), ('JCB', 'JCB'), ('MasterCard', 'MasterCard'), ('UnionPay', 'UnionPay'), ('Unknown', 'Unknown'), ('Visa', 'Visa'))¶
-
CardFundingType¶
CardTokenizationMethod¶
ChargeStatus¶
ConfirmationMethod¶
CouponDuration¶
CustomerTaxExempt¶
DisputeReason¶
-
class
djstripe.enums.
DisputeReason
[source]¶ -
bank_cannot_process
= 'bank_cannot_process'¶
-
choices
= (('bank_cannot_process', 'Bank cannot process'), ('credit_not_processed', 'Credit not processed'), ('customer_initiated', 'Customer-initiated'), ('debit_not_authorized', 'Debit not authorized'), ('duplicate', 'Duplicate'), ('fraudulent', 'Fraudulent'), ('general', 'General'), ('incorrect_account_details', 'Incorrect account details'), ('insufficient_funds', 'Insufficient funds'), ('product_not_received', 'Product not received'), ('product_unacceptable', 'Product unacceptable'), ('subscription_canceled', 'Subscription canceled'), ('unrecognized', 'Unrecognized'))¶
-
credit_not_processed
= 'credit_not_processed'¶
-
customer_initiated
= 'customer_initiated'¶
-
duplicate
= 'duplicate'¶
-
fraudulent
= 'fraudulent'¶
-
general
= 'general'¶
-
incorrect_account_details
= 'incorrect_account_details'¶
-
insufficient_funds
= 'insufficient_funds'¶
-
product_not_received
= 'product_not_received'¶
-
product_unacceptable
= 'product_unacceptable'¶
-
subscription_canceled
= 'subscription_canceled'¶
-
unrecognized
= 'unrecognized'¶
-
DisputeStatus¶
-
class
djstripe.enums.
DisputeStatus
[source]¶ -
charge_refunded
= 'charge_refunded'¶
-
choices
= (('charge_refunded', 'Charge refunded'), ('lost', 'Lost'), ('needs_response', 'Needs response'), ('under_review', 'Under review'), ('warning_closed', 'Warning closed'), ('warning_needs_response', 'Warning needs response'), ('warning_under_review', 'Warning under review'), ('won', 'Won'))¶
-
lost
= 'lost'¶
-
needs_response
= 'needs_response'¶
-
under_review
= 'under_review'¶
-
warning_closed
= 'warning_closed'¶
-
warning_needs_response
= 'warning_needs_response'¶
-
warning_under_review
= 'warning_under_review'¶
-
won
= 'won'¶
-
FileUploadPurpose¶
-
class
djstripe.enums.
FileUploadPurpose
[source]¶ -
choices
= (('dispute_evidence', 'Dispute evidence'), ('identity_document', 'Identity document'), ('tax_document_user_upload', 'Tax document user upload'))¶
-
dispute_evidence
= 'dispute_evidence'¶
-
identity_document
= 'identity_document'¶
-
tax_document_user_upload
= 'tax_document_user_upload'¶
-
FileUploadType¶
InvoiceBilling¶
IntentUsage¶
IntentStatus¶
-
class
djstripe.enums.
IntentStatus
[source]¶ Status of Intents which apply both to PaymentIntents and SetupIntents.
-
canceled
= 'canceled'¶
-
choices
= (('canceled', 'Cancellation invalidates the intent for future confirmation and cannot be undone.'), ('processing', 'Required actions have been handled.'), ('requires_action', 'Payment Method require additional action, such as 3D secure.'), ('requires_confirmation', 'Intent is ready to be confirmed.'), ('requires_payment_method', 'Intent created and requires a Payment Method to be attached.'))¶
-
processing
= 'processing'¶
-
requires_action
= 'requires_action'¶
-
requires_confirmation
= 'requires_confirmation'¶
-
requires_payment_method
= 'requires_payment_method'¶
-
PaymentIntentStatus¶
-
class
djstripe.enums.
PaymentIntentStatus
[source]¶ -
canceled
= 'canceled'¶
-
choices
= (('canceled', 'Cancellation invalidates the intent for future confirmation and cannot be undone.'), ('processing', 'Required actions have been handled.'), ('requires_action', 'Payment Method require additional action, such as 3D secure.'), ('requires_capture', 'Capture the funds on the cards which have been put on holds.'), ('requires_confirmation', 'Intent is ready to be confirmed.'), ('requires_payment_method', 'Intent created and requires a Payment Method to be attached.'), ('succeeded', 'The funds are in your account.'))¶
-
processing
= 'processing'¶
-
requires_action
= 'requires_action'¶
-
requires_capture
= 'requires_capture'¶
-
requires_confirmation
= 'requires_confirmation'¶
-
requires_payment_method
= 'requires_payment_method'¶
-
succeeded
= 'succeeded'¶
-
SetupIntentStatus¶
-
class
djstripe.enums.
SetupIntentStatus
[source]¶ -
canceled
= 'canceled'¶
-
choices
= (('canceled', 'Cancellation invalidates the intent for future confirmation and cannot be undone.'), ('processing', 'Required actions have been handled.'), ('requires_action', 'Payment Method require additional action, such as 3D secure.'), ('requires_confirmation', 'Intent is ready to be confirmed.'), ('requires_payment_method', 'Intent created and requires a Payment Method to be attached.'), ('succeeded', 'Setup was successful and the payment method is optimized for future payments.'))¶
-
processing
= 'processing'¶
-
requires_action
= 'requires_action'¶
-
requires_confirmation
= 'requires_confirmation'¶
-
requires_payment_method
= 'requires_payment_method'¶
-
succeeded
= 'succeeded'¶
-
PayoutFailureCode¶
-
class
djstripe.enums.
PayoutFailureCode
[source]¶ Payout failure error codes.
https://stripe.com/docs/api#payout_failures
-
account_closed
= 'account_closed'¶
-
account_frozen
= 'account_frozen'¶
-
bank_account_restricted
= 'bank_account_restricted'¶
-
bank_ownership_changed
= 'bank_ownership_changed'¶
-
choices
= (('account_closed', 'Bank account has been closed.'), ('account_frozen', 'Bank account has been frozen.'), ('bank_account_restricted', 'Bank account has restrictions on payouts allowed.'), ('bank_ownership_changed', 'Destination bank account has changed ownership.'), ('could_not_process', 'Bank could not process payout.'), ('debit_not_authorized', 'Debit transactions not approved on the bank account.'), ('insufficient_funds', 'Stripe account has insufficient funds.'), ('invalid_account_number', 'Invalid account number'), ('invalid_currency', 'Bank account does not support currency.'), ('no_account', 'Bank account could not be located.'), ('unsupported_card', 'Card no longer supported.'))¶
-
could_not_process
= 'could_not_process'¶
-
insufficient_funds
= 'insufficient_funds'¶
-
invalid_account_number
= 'invalid_account_number'¶
-
invalid_currency
= 'invalid_currency'¶
-
no_account
= 'no_account'¶
-
unsupported_card
= 'unsupported_card'¶
-
PayoutMethod¶
PayoutStatus¶
PayoutType¶
PlanAggregateUsage¶
PlanBillingScheme¶
PlanInterval¶
PlanUsageType¶
PlanTiersMode¶
ProductType¶
ScheduledQueryRunStatus¶
SourceFlow¶
SourceStatus¶
SourceType¶
-
class
djstripe.enums.
SourceType
[source]¶ -
ach_credit_transfer
= 'ach_credit_transfer'¶
-
ach_debit
= 'ach_debit'¶
-
alipay
= 'alipay'¶
-
bancontact
= 'bancontact'¶
-
bitcoin
= 'bitcoin'¶
-
card
= 'card'¶
-
card_present
= 'card_present'¶
-
choices
= (('ach_credit_transfer', 'ACH Credit Transfer'), ('ach_debit', 'ACH Debit'), ('alipay', 'Alipay'), ('bancontact', 'Bancontact'), ('bitcoin', 'Bitcoin'), ('card', 'Card'), ('card_present', 'Card present'), ('eps', 'EPS'), ('giropay', 'Giropay'), ('ideal', 'iDEAL'), ('p24', 'P24'), ('paper_check', 'Paper check'), ('sepa_credit_transfer', 'SEPA credit transfer'), ('sepa_debit', 'SEPA Direct Debit'), ('sofort', 'SOFORT'), ('three_d_secure', '3D Secure'))¶
-
eps
= 'eps'¶
-
giropay
= 'giropay'¶
-
ideal
= 'ideal'¶
-
p24
= 'p24'¶
-
paper_check
= 'paper_check'¶
-
sepa_credit_transfer
= 'sepa_credit_transfer'¶
-
sepa_debit
= 'sepa_debit'¶
-
sofort
= 'sofort'¶
-
three_d_secure
= 'three_d_secure'¶
-
LegacySourceType¶
-
class
djstripe.enums.
LegacySourceType
[source]¶ -
alipay_account
= 'alipay_account'¶
-
bank_account
= 'bank_account'¶
-
bitcoin_receiver
= 'bitcoin_receiver'¶
-
card
= 'card'¶
-
choices
= (('alipay_account', 'Alipay account'), ('bank_account', 'Bank account'), ('bitcoin_receiver', 'Bitcoin receiver'), ('card', 'Card'))¶
-
RefundFailureReason¶
-
class
djstripe.enums.
RefundFailureReason
[source]¶ -
choices
= (('expired_or_canceled_card', 'Expired or canceled card'), ('lost_or_stolen_card', 'Lost or stolen card'), ('unknown', 'Unknown'))¶
-
expired_or_canceled_card
= 'expired_or_canceled_card'¶
-
lost_or_stolen_card
= 'lost_or_stolen_card'¶
-
unknown
= 'unknown'¶
-
RefundReason¶
RefundStatus¶
SourceUsage¶
SourceCodeVerificationStatus¶
SourceRedirectFailureReason¶
SourceRedirectStatus¶
SubmitTypeStatus¶
SubscriptionStatus¶
-
class
djstripe.enums.
SubscriptionStatus
[source]¶ -
active
= 'active'¶
-
canceled
= 'canceled'¶
-
choices
= (('active', 'Active'), ('canceled', 'Canceled'), ('incomplete', 'Incomplete'), ('incomplete_expired', 'Incomplete Expired'), ('past_due', 'Past due'), ('trialing', 'Trialing'), ('unpaid', 'Unpaid'))¶
-
incomplete
= 'incomplete'¶
-
incomplete_expired
= 'incomplete_expired'¶
-
past_due
= 'past_due'¶
-
trialing
= 'trialing'¶
-
unpaid
= 'unpaid'¶
-