Skip to content

Enumerations

Attributes

djstripe.enums.PlanTiersMode = PriceTiersMode module-attribute

djstripe.enums.PlanUsageType = PriceUsageType module-attribute

Classes

djstripe.enums.APIKeyType

Bases: Enum

API Key Types (internal model only)

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
58
59
60
61
62
63
64
65
class APIKeyType(Enum):
    """
    API Key Types (internal model only)
    """

    publishable = _("Publishable key")
    secret = _("Secret key")
    restricted = _("Restricted key")

Attributes

djstripe.enums.APIKeyType.publishable = _('Publishable key') class-attribute instance-attribute
djstripe.enums.APIKeyType.restricted = _('Restricted key') class-attribute instance-attribute
djstripe.enums.APIKeyType.secret = _('Secret key') class-attribute instance-attribute

djstripe.enums.ApiErrorCode

Bases: Enum

Charge failure error codes.

https://stripe.com/docs/error-codes

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
class ApiErrorCode(Enum):
    """
    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 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")
    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")

    # deprecated
    invalid_swipe_data = _("Invalid swipe data")

Attributes

djstripe.enums.ApiErrorCode.account_already_exists = _('Account already exists') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.account_country_invalid_address = _('Account country invalid address') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.account_invalid = _('Account invalid') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.account_number_invalid = _('Account number invalid') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.alipay_upgrade_required = _('Alipay upgrade required') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.amount_too_large = _('Amount too large') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.amount_too_small = _('Amount too small') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.api_key_expired = _('Api key expired') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.balance_insufficient = _('Balance insufficient') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.bank_account_exists = _('Bank account exists') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.bank_account_unusable = _('Bank account unusable') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.bank_account_unverified = _('Bank account unverified') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.bitcoin_upgrade_required = _('Bitcoin upgrade required') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.card_declined = _('Card was declined') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.charge_already_captured = _('Charge already captured') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.charge_already_refunded = _('Charge already refunded') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.charge_disputed = _('Charge disputed') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.charge_exceeds_source_limit = _('Charge exceeds source limit') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.charge_expired_for_capture = _('Charge expired for capture') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.country_unsupported = _('Country unsupported') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.coupon_expired = _('Coupon expired') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.customer_max_subscriptions = _('Customer max subscriptions') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.email_invalid = _('Email invalid') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.expired_card = _('Expired card') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.idempotency_key_in_use = _('Idempotency key in use') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.incorrect_address = _('Incorrect address') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.incorrect_cvc = _('Incorrect security code') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.incorrect_number = _('Incorrect number') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.incorrect_zip = _('ZIP code failed validation') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.instant_payouts_unsupported = _('Instant payouts unsupported') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.invalid_card_type = _('Invalid card type') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.invalid_charge_amount = _('Invalid charge amount') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.invalid_cvc = _('Invalid security code') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.invalid_expiry_month = _('Invalid expiration month') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.invalid_expiry_year = _('Invalid expiration year') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.invalid_number = _('Invalid number') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.invalid_source_usage = _('Invalid source usage') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.invalid_swipe_data = _('Invalid swipe data') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.invoice_no_customer_line_items = _('Invoice no customer line items') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.invoice_no_subscription_line_items = _('Invoice no subscription line items') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.invoice_not_editable = _('Invoice not editable') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.invoice_upcoming_none = _('Invoice upcoming none') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.livemode_mismatch = _('Livemode mismatch') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.missing = _('No card being charged') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.not_allowed_on_standard_account = _('Not allowed on standard account') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.order_creation_failed = _('Order creation failed') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.order_required_settings = _('Order required settings') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.order_status_invalid = _('Order status invalid') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.order_upstream_timeout = _('Order upstream timeout') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.out_of_inventory = _('Out of inventory') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.parameter_invalid_empty = _('Parameter invalid empty') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.parameter_invalid_integer = _('Parameter invalid integer') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.parameter_invalid_string_blank = _('Parameter invalid string blank') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.parameter_invalid_string_empty = _('Parameter invalid string empty') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.parameter_missing = _('Parameter missing') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.parameter_unknown = _('Parameter unknown') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.parameters_exclusive = _('Parameters exclusive') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.payment_intent_authentication_failure = _('Payment intent authentication failure') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.payment_intent_incompatible_payment_method = _('Payment intent incompatible payment method') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.payment_intent_invalid_parameter = _('Payment intent invalid parameter') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.payment_intent_payment_attempt_failed = _('Payment intent payment attempt failed') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.payment_intent_unexpected_state = _('Payment intent unexpected state') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.payment_method_unactivated = _('Payment method unactivated') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.payment_method_unexpected_state = _('Payment method unexpected state') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.payouts_not_allowed = _('Payouts not allowed') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.platform_api_key_expired = _('Platform api key expired') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.postal_code_invalid = _('Postal code invalid') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.processing_error = _('Processing error') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.product_inactive = _('Product inactive') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.rate_limit = _('Rate limit') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.resource_already_exists = _('Resource already exists') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.resource_missing = _('Resource missing') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.routing_number_invalid = _('Routing number invalid') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.secret_key_required = _('Secret key required') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.sepa_unsupported_account = _('SEPA unsupported account') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.shipping_calculation_failed = _('Shipping calculation failed') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.sku_inactive = _('SKU inactive') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.state_unsupported = _('State unsupported') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.tax_id_invalid = _('Tax id invalid') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.taxes_calculation_failed = _('Taxes calculation failed') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.testmode_charges_only = _('Testmode charges only') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.tls_version_unsupported = _('TLS version unsupported') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.token_already_used = _('Token already used') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.token_in_use = _('Token in use') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.transfers_not_allowed = _('Transfers not allowed') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.upstream_order_creation_failed = _('Upstream order creation failed') class-attribute instance-attribute
djstripe.enums.ApiErrorCode.url_invalid = _('URL invalid') class-attribute instance-attribute

djstripe.enums.BalanceTransactionReportingCategory

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
class BalanceTransactionReportingCategory(Enum):
    """
    https://stripe.com/docs/reports/reporting-categories
    """

    advance = _("Advance")
    advance_funding = _("Advance funding")
    anticipation_repayment = _("Anticipation loan repayment (BR)")
    charge = _("Charge")
    charge_failure = _("Charge failure")
    connect_collection_transfer = _("Stripe Connect collection transfer")
    connect_reserved_funds = _("Stripe Connect reserved funds")
    dispute = _("Dispute")
    dispute_reversal = _("Dispute reversal")
    fee = _("Stripe fee")
    issuing_authorization_hold = _("Issuing authorization hold")
    issuing_authorization_release = _("Issuing authorization release")
    issuing_dispute = _("Issuing dispute")
    issuing_transaction = _("Issuing transaction")
    other_adjustment = _("Other adjustment")
    partial_capture_reversal = _("Partial capture reversal")
    payout = _("Payout")
    payout_reversal = _("Payout reversal")
    platform_earning = _("Stripe Connect platform earning")
    platform_earning_refund = _("Stripe Connect platform earning refund")
    refund = _("Refund")
    refund_failure = _("Refund failure")
    risk_reserved_funds = _("Risk-reserved funds")
    tax = _("Tax")
    topup = _("Top-up")
    topup_reversal = _("Top-up reversal")
    transfer = _("Stripe Connect transfer")
    transfer_reversal = _("Stripe Connect transfer reversal")

Attributes

djstripe.enums.BalanceTransactionReportingCategory.advance = _('Advance') class-attribute instance-attribute
djstripe.enums.BalanceTransactionReportingCategory.advance_funding = _('Advance funding') class-attribute instance-attribute
djstripe.enums.BalanceTransactionReportingCategory.anticipation_repayment = _('Anticipation loan repayment (BR)') class-attribute instance-attribute
djstripe.enums.BalanceTransactionReportingCategory.charge = _('Charge') class-attribute instance-attribute
djstripe.enums.BalanceTransactionReportingCategory.charge_failure = _('Charge failure') class-attribute instance-attribute
djstripe.enums.BalanceTransactionReportingCategory.connect_collection_transfer = _('Stripe Connect collection transfer') class-attribute instance-attribute
djstripe.enums.BalanceTransactionReportingCategory.connect_reserved_funds = _('Stripe Connect reserved funds') class-attribute instance-attribute
djstripe.enums.BalanceTransactionReportingCategory.dispute = _('Dispute') class-attribute instance-attribute
djstripe.enums.BalanceTransactionReportingCategory.dispute_reversal = _('Dispute reversal') class-attribute instance-attribute
djstripe.enums.BalanceTransactionReportingCategory.fee = _('Stripe fee') class-attribute instance-attribute
djstripe.enums.BalanceTransactionReportingCategory.issuing_authorization_hold = _('Issuing authorization hold') class-attribute instance-attribute
djstripe.enums.BalanceTransactionReportingCategory.issuing_authorization_release = _('Issuing authorization release') class-attribute instance-attribute
djstripe.enums.BalanceTransactionReportingCategory.issuing_dispute = _('Issuing dispute') class-attribute instance-attribute
djstripe.enums.BalanceTransactionReportingCategory.issuing_transaction = _('Issuing transaction') class-attribute instance-attribute
djstripe.enums.BalanceTransactionReportingCategory.other_adjustment = _('Other adjustment') class-attribute instance-attribute
djstripe.enums.BalanceTransactionReportingCategory.partial_capture_reversal = _('Partial capture reversal') class-attribute instance-attribute
djstripe.enums.BalanceTransactionReportingCategory.payout = _('Payout') class-attribute instance-attribute
djstripe.enums.BalanceTransactionReportingCategory.payout_reversal = _('Payout reversal') class-attribute instance-attribute
djstripe.enums.BalanceTransactionReportingCategory.platform_earning = _('Stripe Connect platform earning') class-attribute instance-attribute
djstripe.enums.BalanceTransactionReportingCategory.platform_earning_refund = _('Stripe Connect platform earning refund') class-attribute instance-attribute
djstripe.enums.BalanceTransactionReportingCategory.refund = _('Refund') class-attribute instance-attribute
djstripe.enums.BalanceTransactionReportingCategory.refund_failure = _('Refund failure') class-attribute instance-attribute
djstripe.enums.BalanceTransactionReportingCategory.risk_reserved_funds = _('Risk-reserved funds') class-attribute instance-attribute
djstripe.enums.BalanceTransactionReportingCategory.tax = _('Tax') class-attribute instance-attribute
djstripe.enums.BalanceTransactionReportingCategory.topup = _('Top-up') class-attribute instance-attribute
djstripe.enums.BalanceTransactionReportingCategory.topup_reversal = _('Top-up reversal') class-attribute instance-attribute
djstripe.enums.BalanceTransactionReportingCategory.transfer = _('Stripe Connect transfer') class-attribute instance-attribute
djstripe.enums.BalanceTransactionReportingCategory.transfer_reversal = _('Stripe Connect transfer reversal') class-attribute instance-attribute

djstripe.enums.BalanceTransactionStatus

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
203
204
205
class BalanceTransactionStatus(Enum):
    available = _("Available")
    pending = _("Pending")

Attributes

djstripe.enums.BalanceTransactionStatus.available = _('Available') class-attribute instance-attribute
djstripe.enums.BalanceTransactionStatus.pending = _('Pending') class-attribute instance-attribute

djstripe.enums.BalanceTransactionType

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
class BalanceTransactionType(Enum):
    # https://stripe.com/docs/reports/balance-transaction-types
    adjustment = _("Adjustment")
    advance = _("Advance")
    advance_funding = _("Advance funding")
    anticipation_repayment = _("Anticipation loan repayment")
    application_fee = _("Application fee")
    application_fee_refund = _("Application fee refund")
    balance_transfer_inbound = _("Balance transfer (inbound)")
    balance_transfer_outbound = _("Balance transfer (outbound)")
    charge = _("Charge")
    connect_collection_transfer = _("Connect collection transfer")
    contribution = _("Charitable contribution")
    issuing_authorization_hold = _("Issuing authorization hold")
    issuing_authorization_release = _("Issuing authorization release")
    issuing_dispute = _("Issuing dispute")
    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 currency conversion fee")
    tax_fee = _("Tax fee")
    topup = _("Topup")
    topup_reversal = _("Topup reversal")
    transfer = _("Transfer")
    transfer_cancel = _("Transfer cancel")
    transfer_failure = _("Transfer failure")
    transfer_refund = _("Transfer refund")
    validation = _("Validation")

Attributes

djstripe.enums.BalanceTransactionType.adjustment = _('Adjustment') class-attribute instance-attribute
djstripe.enums.BalanceTransactionType.advance = _('Advance') class-attribute instance-attribute
djstripe.enums.BalanceTransactionType.advance_funding = _('Advance funding') class-attribute instance-attribute
djstripe.enums.BalanceTransactionType.anticipation_repayment = _('Anticipation loan repayment') class-attribute instance-attribute
djstripe.enums.BalanceTransactionType.application_fee = _('Application fee') class-attribute instance-attribute
djstripe.enums.BalanceTransactionType.application_fee_refund = _('Application fee refund') class-attribute instance-attribute
djstripe.enums.BalanceTransactionType.balance_transfer_inbound = _('Balance transfer (inbound)') class-attribute instance-attribute
djstripe.enums.BalanceTransactionType.balance_transfer_outbound = _('Balance transfer (outbound)') class-attribute instance-attribute
djstripe.enums.BalanceTransactionType.charge = _('Charge') class-attribute instance-attribute
djstripe.enums.BalanceTransactionType.connect_collection_transfer = _('Connect collection transfer') class-attribute instance-attribute
djstripe.enums.BalanceTransactionType.contribution = _('Charitable contribution') class-attribute instance-attribute
djstripe.enums.BalanceTransactionType.issuing_authorization_hold = _('Issuing authorization hold') class-attribute instance-attribute
djstripe.enums.BalanceTransactionType.issuing_authorization_release = _('Issuing authorization release') class-attribute instance-attribute
djstripe.enums.BalanceTransactionType.issuing_dispute = _('Issuing dispute') class-attribute instance-attribute
djstripe.enums.BalanceTransactionType.issuing_transaction = _('Issuing transaction') class-attribute instance-attribute
djstripe.enums.BalanceTransactionType.network_cost = _('Network cost') class-attribute instance-attribute
djstripe.enums.BalanceTransactionType.payment = _('Payment') class-attribute instance-attribute
djstripe.enums.BalanceTransactionType.payment_failure_refund = _('Payment failure refund') class-attribute instance-attribute
djstripe.enums.BalanceTransactionType.payment_refund = _('Payment refund') class-attribute instance-attribute
djstripe.enums.BalanceTransactionType.payout = _('Payout') class-attribute instance-attribute
djstripe.enums.BalanceTransactionType.payout_cancel = _('Payout cancellation') class-attribute instance-attribute
djstripe.enums.BalanceTransactionType.payout_failure = _('Payout failure') class-attribute instance-attribute
djstripe.enums.BalanceTransactionType.refund = _('Refund') class-attribute instance-attribute
djstripe.enums.BalanceTransactionType.refund_failure = _('Refund failure') class-attribute instance-attribute
djstripe.enums.BalanceTransactionType.reserve_transaction = _('Reserve transaction') class-attribute instance-attribute
djstripe.enums.BalanceTransactionType.reserved_funds = _('Reserved funds') class-attribute instance-attribute
djstripe.enums.BalanceTransactionType.stripe_fee = _('Stripe fee') class-attribute instance-attribute
djstripe.enums.BalanceTransactionType.stripe_fx_fee = _('Stripe currency conversion fee') class-attribute instance-attribute
djstripe.enums.BalanceTransactionType.tax_fee = _('Tax fee') class-attribute instance-attribute
djstripe.enums.BalanceTransactionType.topup = _('Topup') class-attribute instance-attribute
djstripe.enums.BalanceTransactionType.topup_reversal = _('Topup reversal') class-attribute instance-attribute
djstripe.enums.BalanceTransactionType.transfer = _('Transfer') class-attribute instance-attribute
djstripe.enums.BalanceTransactionType.transfer_cancel = _('Transfer cancel') class-attribute instance-attribute
djstripe.enums.BalanceTransactionType.transfer_failure = _('Transfer failure') class-attribute instance-attribute
djstripe.enums.BalanceTransactionType.transfer_refund = _('Transfer refund') class-attribute instance-attribute
djstripe.enums.BalanceTransactionType.validation = _('Validation') class-attribute instance-attribute

djstripe.enums.BankAccountHolderType

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
248
249
250
class BankAccountHolderType(Enum):
    individual = _("Individual")
    company = _("Company")

Attributes

djstripe.enums.BankAccountHolderType.company = _('Company') class-attribute instance-attribute
djstripe.enums.BankAccountHolderType.individual = _('Individual') class-attribute instance-attribute

djstripe.enums.BankAccountStatus

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
253
254
255
256
257
258
class BankAccountStatus(Enum):
    new = _("New")
    validated = _("Validated")
    verified = _("Verified")
    verification_failed = _("Verification failed")
    errored = _("Errored")

Attributes

djstripe.enums.BankAccountStatus.errored = _('Errored') class-attribute instance-attribute
djstripe.enums.BankAccountStatus.new = _('New') class-attribute instance-attribute
djstripe.enums.BankAccountStatus.validated = _('Validated') class-attribute instance-attribute
djstripe.enums.BankAccountStatus.verification_failed = _('Verification failed') class-attribute instance-attribute
djstripe.enums.BankAccountStatus.verified = _('Verified') class-attribute instance-attribute

djstripe.enums.BillingScheme

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
261
262
263
class BillingScheme(Enum):
    per_unit = _("Per-unit")
    tiered = _("Tiered")

Attributes

djstripe.enums.BillingScheme.per_unit = _('Per-unit') class-attribute instance-attribute
djstripe.enums.BillingScheme.tiered = _('Tiered') class-attribute instance-attribute

djstripe.enums.CaptureMethod

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
266
267
268
class CaptureMethod(Enum):
    automatic = _("Automatic")
    manual = _("Manual")

Attributes

djstripe.enums.CaptureMethod.automatic = _('Automatic') class-attribute instance-attribute
djstripe.enums.CaptureMethod.manual = _('Manual') class-attribute instance-attribute

djstripe.enums.CardBrand

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
278
279
280
281
282
283
284
285
286
class CardBrand(Enum):
    AmericanExpress = (_("American Express"), "American Express")
    DinersClub = (_("Diners Club"), "Diners Club")
    Discover = _("Discover")
    JCB = _("JCB")
    MasterCard = _("MasterCard")
    UnionPay = _("UnionPay")
    Visa = _("Visa")
    Unknown = _("Unknown")

Attributes

djstripe.enums.CardBrand.AmericanExpress = (_('American Express'), 'American Express') class-attribute instance-attribute
djstripe.enums.CardBrand.DinersClub = (_('Diners Club'), 'Diners Club') class-attribute instance-attribute
djstripe.enums.CardBrand.Discover = _('Discover') class-attribute instance-attribute
djstripe.enums.CardBrand.JCB = _('JCB') class-attribute instance-attribute
djstripe.enums.CardBrand.MasterCard = _('MasterCard') class-attribute instance-attribute
djstripe.enums.CardBrand.UnionPay = _('UnionPay') class-attribute instance-attribute
djstripe.enums.CardBrand.Unknown = _('Unknown') class-attribute instance-attribute
djstripe.enums.CardBrand.Visa = _('Visa') class-attribute instance-attribute

djstripe.enums.CardCheckResult

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
271
272
273
274
275
class CardCheckResult(Enum):
    pass_ = (_("Pass"), "pass")
    fail = _("Fail")
    unavailable = _("Unavailable")
    unchecked = _("Unchecked")

Attributes

djstripe.enums.CardCheckResult.fail = _('Fail') class-attribute instance-attribute
djstripe.enums.CardCheckResult.pass_ = (_('Pass'), 'pass') class-attribute instance-attribute
djstripe.enums.CardCheckResult.unavailable = _('Unavailable') class-attribute instance-attribute
djstripe.enums.CardCheckResult.unchecked = _('Unchecked') class-attribute instance-attribute

djstripe.enums.CardFundingType

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
289
290
291
292
293
class CardFundingType(Enum):
    credit = _("Credit")
    debit = _("Debit")
    prepaid = _("Prepaid")
    unknown = _("Unknown")

Attributes

djstripe.enums.CardFundingType.credit = _('Credit') class-attribute instance-attribute
djstripe.enums.CardFundingType.debit = _('Debit') class-attribute instance-attribute
djstripe.enums.CardFundingType.prepaid = _('Prepaid') class-attribute instance-attribute
djstripe.enums.CardFundingType.unknown = _('Unknown') class-attribute instance-attribute

djstripe.enums.CardTokenizationMethod

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
296
297
298
class CardTokenizationMethod(Enum):
    apple_pay = _("Apple Pay")
    android_pay = _("Android Pay")

Attributes

djstripe.enums.CardTokenizationMethod.android_pay = _('Android Pay') class-attribute instance-attribute
djstripe.enums.CardTokenizationMethod.apple_pay = _('Apple Pay') class-attribute instance-attribute

djstripe.enums.ChargeStatus

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
301
302
303
304
class ChargeStatus(Enum):
    succeeded = _("Succeeded")
    pending = _("Pending")
    failed = _("Failed")

Attributes

djstripe.enums.ChargeStatus.failed = _('Failed') class-attribute instance-attribute
djstripe.enums.ChargeStatus.pending = _('Pending') class-attribute instance-attribute
djstripe.enums.ChargeStatus.succeeded = _('Succeeded') class-attribute instance-attribute

djstripe.enums.ConfirmationMethod

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
313
314
315
class ConfirmationMethod(Enum):
    automatic = _("Automatic")
    manual = _("Manual")

Attributes

djstripe.enums.ConfirmationMethod.automatic = _('Automatic') class-attribute instance-attribute
djstripe.enums.ConfirmationMethod.manual = _('Manual') class-attribute instance-attribute

djstripe.enums.CouponDuration

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
318
319
320
321
class CouponDuration(Enum):
    once = _("Once")
    repeating = _("Multi-month")
    forever = _("Forever")

Attributes

djstripe.enums.CouponDuration.forever = _('Forever') class-attribute instance-attribute
djstripe.enums.CouponDuration.once = _('Once') class-attribute instance-attribute
djstripe.enums.CouponDuration.repeating = _('Multi-month') class-attribute instance-attribute

djstripe.enums.CustomerTaxExempt

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
324
325
326
327
class CustomerTaxExempt(Enum):
    none = _("None")
    exempt = _("Exempt")
    reverse = _("Reverse")

Attributes

djstripe.enums.CustomerTaxExempt.exempt = _('Exempt') class-attribute instance-attribute
djstripe.enums.CustomerTaxExempt.none = _('None') class-attribute instance-attribute
djstripe.enums.CustomerTaxExempt.reverse = _('Reverse') class-attribute instance-attribute

djstripe.enums.DisputeReason

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
330
331
332
333
334
335
336
337
338
339
340
341
342
343
class DisputeReason(Enum):
    duplicate = _("Duplicate")
    fraudulent = _("Fraudulent")
    subscription_canceled = _("Subscription canceled")
    product_unacceptable = _("Product unacceptable")
    product_not_received = _("Product not received")
    unrecognized = _("Unrecognized")
    credit_not_processed = _("Credit not processed")
    general = _("General")
    incorrect_account_details = _("Incorrect account details")
    insufficient_funds = _("Insufficient funds")
    bank_cannot_process = _("Bank cannot process")
    debit_not_authorized = _("Debit not authorized")
    customer_initiated = _("Customer-initiated")

Attributes

djstripe.enums.DisputeReason.bank_cannot_process = _('Bank cannot process') class-attribute instance-attribute
djstripe.enums.DisputeReason.credit_not_processed = _('Credit not processed') class-attribute instance-attribute
djstripe.enums.DisputeReason.customer_initiated = _('Customer-initiated') class-attribute instance-attribute
djstripe.enums.DisputeReason.debit_not_authorized = _('Debit not authorized') class-attribute instance-attribute
djstripe.enums.DisputeReason.duplicate = _('Duplicate') class-attribute instance-attribute
djstripe.enums.DisputeReason.fraudulent = _('Fraudulent') class-attribute instance-attribute
djstripe.enums.DisputeReason.general = _('General') class-attribute instance-attribute
djstripe.enums.DisputeReason.incorrect_account_details = _('Incorrect account details') class-attribute instance-attribute
djstripe.enums.DisputeReason.insufficient_funds = _('Insufficient funds') class-attribute instance-attribute
djstripe.enums.DisputeReason.product_not_received = _('Product not received') class-attribute instance-attribute
djstripe.enums.DisputeReason.product_unacceptable = _('Product unacceptable') class-attribute instance-attribute
djstripe.enums.DisputeReason.subscription_canceled = _('Subscription canceled') class-attribute instance-attribute
djstripe.enums.DisputeReason.unrecognized = _('Unrecognized') class-attribute instance-attribute

djstripe.enums.DisputeStatus

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
346
347
348
349
350
351
352
353
354
class DisputeStatus(Enum):
    warning_needs_response = _("Warning needs response")
    warning_under_review = _("Warning under review")
    warning_closed = _("Warning closed")
    needs_response = _("Needs response")
    under_review = _("Under review")
    charge_refunded = _("Charge refunded")
    won = _("Won")
    lost = _("Lost")

Attributes

djstripe.enums.DisputeStatus.charge_refunded = _('Charge refunded') class-attribute instance-attribute
djstripe.enums.DisputeStatus.lost = _('Lost') class-attribute instance-attribute
djstripe.enums.DisputeStatus.needs_response = _('Needs response') class-attribute instance-attribute
djstripe.enums.DisputeStatus.under_review = _('Under review') class-attribute instance-attribute
djstripe.enums.DisputeStatus.warning_closed = _('Warning closed') class-attribute instance-attribute
djstripe.enums.DisputeStatus.warning_needs_response = _('Warning needs response') class-attribute instance-attribute
djstripe.enums.DisputeStatus.warning_under_review = _('Warning under review') class-attribute instance-attribute
djstripe.enums.DisputeStatus.won = _('Won') class-attribute instance-attribute

djstripe.enums.DjstripePaymentMethodType

Bases: Enum

A djstripe-specific enum for the DjStripePaymentMethod model.

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
854
855
856
857
858
859
860
861
862
class DjstripePaymentMethodType(Enum):
    """
    A djstripe-specific enum for the DjStripePaymentMethod model.
    """

    alipay_account = _("Alipay account")
    card = _("Card")
    bank_account = _("Bank account")
    source = _("Source")

Attributes

djstripe.enums.DjstripePaymentMethodType.alipay_account = _('Alipay account') class-attribute instance-attribute
djstripe.enums.DjstripePaymentMethodType.bank_account = _('Bank account') class-attribute instance-attribute
djstripe.enums.DjstripePaymentMethodType.card = _('Card') class-attribute instance-attribute
djstripe.enums.DjstripePaymentMethodType.source = _('Source') class-attribute instance-attribute

djstripe.enums.Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
54
55
class Enum(metaclass=EnumMetaClass):
    pass

djstripe.enums.EnumMetaClass

Bases: type

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
class EnumMetaClass(type):
    def __init__(cls, name, bases, classdict):
        def _human_enum_values(enum):
            return cls.__choices__[enum]

        # add a class attribute
        cls.humanize = _human_enum_values

    @classmethod
    def __prepare__(cls, name, bases):
        return OrderedDict()

    def __new__(cls, name, bases, classdict):
        members = []
        keys = {}
        choices = OrderedDict()
        for key, value in classdict.items():
            if key.startswith("__"):
                continue
            members.append(key)
            if isinstance(value, tuple):
                value, alias = value
                keys[alias] = key
            else:
                alias = None
            keys[alias or key] = key
            choices[alias or key] = value

        for k, v in keys.items():
            classdict[v] = k

        classdict["__choices__"] = choices
        classdict["__members__"] = members

        # Note: Differences between Python 2.x and Python 3.x force us to
        # explicitly use unicode here, and to explicitly sort the list. In
        # Python 2.x, class members are unordered and so the ordering will
        # vary on different systems based on internal hashing. Without this
        # Django will continually require new no-op migrations.
        classdict["choices"] = tuple(
            (str(k), str(v))
            for k, v in sorted(choices.items(), key=operator.itemgetter(0))
        )

        return type.__new__(cls, name, bases, classdict)

Functions

djstripe.enums.EnumMetaClass.__init__(name, bases, classdict)
Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
 8
 9
10
11
12
13
def __init__(cls, name, bases, classdict):
    def _human_enum_values(enum):
        return cls.__choices__[enum]

    # add a class attribute
    cls.humanize = _human_enum_values
djstripe.enums.EnumMetaClass.__new__(name, bases, classdict)
Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
def __new__(cls, name, bases, classdict):
    members = []
    keys = {}
    choices = OrderedDict()
    for key, value in classdict.items():
        if key.startswith("__"):
            continue
        members.append(key)
        if isinstance(value, tuple):
            value, alias = value
            keys[alias] = key
        else:
            alias = None
        keys[alias or key] = key
        choices[alias or key] = value

    for k, v in keys.items():
        classdict[v] = k

    classdict["__choices__"] = choices
    classdict["__members__"] = members

    # Note: Differences between Python 2.x and Python 3.x force us to
    # explicitly use unicode here, and to explicitly sort the list. In
    # Python 2.x, class members are unordered and so the ordering will
    # vary on different systems based on internal hashing. Without this
    # Django will continually require new no-op migrations.
    classdict["choices"] = tuple(
        (str(k), str(v))
        for k, v in sorted(choices.items(), key=operator.itemgetter(0))
    )

    return type.__new__(cls, name, bases, classdict)
djstripe.enums.EnumMetaClass.__prepare__(name, bases) classmethod
Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
15
16
17
@classmethod
def __prepare__(cls, name, bases):
    return OrderedDict()

djstripe.enums.FilePurpose

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
class FilePurpose(Enum):
    account_requirement = _("Account requirement")
    additional_verification = _("Additional verification")
    business_icon = _("Business icon")
    business_logo = _("Business logo")
    customer_signature = _("Customer signature")
    credit_note = _("Credit Note")
    dispute_evidence = _("Dispute evidence")
    document_provider_identity_document = _("Document provider identity document")
    finance_report_run = _("Finance report run")
    identity_document = _("Identity document")
    identity_document_downloadable = _("Identity document (downloadable)")
    invoice_statement = _("Invoice statement")
    pci_document = _("PCI document")
    selfie = _("Selfie (Stripe Identity)")
    sigma_scheduled_query = _("Sigma scheduled query")
    tax_document_user_upload = _("Tax document user upload")

Attributes

djstripe.enums.FilePurpose.account_requirement = _('Account requirement') class-attribute instance-attribute
djstripe.enums.FilePurpose.additional_verification = _('Additional verification') class-attribute instance-attribute
djstripe.enums.FilePurpose.business_icon = _('Business icon') class-attribute instance-attribute
djstripe.enums.FilePurpose.credit_note = _('Credit Note') class-attribute instance-attribute
djstripe.enums.FilePurpose.customer_signature = _('Customer signature') class-attribute instance-attribute
djstripe.enums.FilePurpose.dispute_evidence = _('Dispute evidence') class-attribute instance-attribute
djstripe.enums.FilePurpose.document_provider_identity_document = _('Document provider identity document') class-attribute instance-attribute
djstripe.enums.FilePurpose.finance_report_run = _('Finance report run') class-attribute instance-attribute
djstripe.enums.FilePurpose.identity_document = _('Identity document') class-attribute instance-attribute
djstripe.enums.FilePurpose.identity_document_downloadable = _('Identity document (downloadable)') class-attribute instance-attribute
djstripe.enums.FilePurpose.invoice_statement = _('Invoice statement') class-attribute instance-attribute
djstripe.enums.FilePurpose.pci_document = _('PCI document') class-attribute instance-attribute
djstripe.enums.FilePurpose.selfie = _('Selfie (Stripe Identity)') class-attribute instance-attribute
djstripe.enums.FilePurpose.sigma_scheduled_query = _('Sigma scheduled query') class-attribute instance-attribute
djstripe.enums.FilePurpose.tax_document_user_upload = _('Tax document user upload') class-attribute instance-attribute

djstripe.enums.FileType

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
376
377
378
379
380
381
382
383
class FileType(Enum):
    pdf = _("PDF")
    jpg = _("JPG")
    png = _("PNG")
    csv = _("CSV")
    xls = _("XLS")
    xlsx = _("XLSX")
    docx = _("DOCX")

Attributes

djstripe.enums.FileType.csv = _('CSV') class-attribute instance-attribute
djstripe.enums.FileType.docx = _('DOCX') class-attribute instance-attribute
djstripe.enums.FileType.jpg = _('JPG') class-attribute instance-attribute
djstripe.enums.FileType.pdf = _('PDF') class-attribute instance-attribute
djstripe.enums.FileType.png = _('PNG') class-attribute instance-attribute
djstripe.enums.FileType.xls = _('XLS') class-attribute instance-attribute
djstripe.enums.FileType.xlsx = _('XLSX') class-attribute instance-attribute

djstripe.enums.IntentStatus

Bases: Enum

Status of Intents which apply both to PaymentIntents and SetupIntents.

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
class IntentStatus(Enum):
    """
    Status of Intents which apply both to PaymentIntents
    and SetupIntents.
    """

    requires_payment_method = _(
        "Intent created and requires a Payment Method to be attached."
    )
    requires_confirmation = _("Intent is ready to be confirmed.")
    requires_action = _("Payment Method require additional action, such as 3D secure.")
    processing = _("Required actions have been handled.")
    canceled = _(
        "Cancellation invalidates the intent for future confirmation and "
        "cannot be undone."
    )

Attributes

djstripe.enums.IntentStatus.canceled = _('Cancellation invalidates the intent for future confirmation and cannot be undone.') class-attribute instance-attribute
djstripe.enums.IntentStatus.processing = _('Required actions have been handled.') class-attribute instance-attribute
djstripe.enums.IntentStatus.requires_action = _('Payment Method require additional action, such as 3D secure.') class-attribute instance-attribute
djstripe.enums.IntentStatus.requires_confirmation = _('Intent is ready to be confirmed.') class-attribute instance-attribute
djstripe.enums.IntentStatus.requires_payment_method = _('Intent created and requires a Payment Method to be attached.') class-attribute instance-attribute

djstripe.enums.IntentUsage

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
410
411
412
class IntentUsage(Enum):
    on_session = _("On session")
    off_session = _("Off session")

Attributes

djstripe.enums.IntentUsage.off_session = _('Off session') class-attribute instance-attribute
djstripe.enums.IntentUsage.on_session = _('On session') class-attribute instance-attribute

djstripe.enums.InvoiceBillingReason

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
386
387
388
389
390
391
392
393
394
class InvoiceBillingReason(Enum):
    subscription_cycle = _("Subscription cycle")
    subscription_create = _("Subscription create")
    subscription_update = _("Subscription update")
    subscription = _("Subscription")
    manual = _("Manual")
    upcoming = _("Upcoming")
    subscription_threshold = _("Subscription threshold")
    automatic_pending_invoice_item_invoice = _("Automatic pending invoice item invoice")

Attributes

djstripe.enums.InvoiceBillingReason.automatic_pending_invoice_item_invoice = _('Automatic pending invoice item invoice') class-attribute instance-attribute
djstripe.enums.InvoiceBillingReason.manual = _('Manual') class-attribute instance-attribute
djstripe.enums.InvoiceBillingReason.subscription = _('Subscription') class-attribute instance-attribute
djstripe.enums.InvoiceBillingReason.subscription_create = _('Subscription create') class-attribute instance-attribute
djstripe.enums.InvoiceBillingReason.subscription_cycle = _('Subscription cycle') class-attribute instance-attribute
djstripe.enums.InvoiceBillingReason.subscription_threshold = _('Subscription threshold') class-attribute instance-attribute
djstripe.enums.InvoiceBillingReason.subscription_update = _('Subscription update') class-attribute instance-attribute
djstripe.enums.InvoiceBillingReason.upcoming = _('Upcoming') class-attribute instance-attribute

djstripe.enums.InvoiceCollectionMethod

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
397
398
399
class InvoiceCollectionMethod(Enum):
    charge_automatically = _("Charge automatically")
    send_invoice = _("Send invoice")

Attributes

djstripe.enums.InvoiceCollectionMethod.charge_automatically = _('Charge automatically') class-attribute instance-attribute
djstripe.enums.InvoiceCollectionMethod.send_invoice = _('Send invoice') class-attribute instance-attribute

djstripe.enums.InvoiceStatus

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
402
403
404
405
406
407
class InvoiceStatus(Enum):
    draft = _("Draft")
    open = _("Open")
    paid = _("Paid")
    uncollectible = _("Uncollectible")
    void = _("Void")

Attributes

djstripe.enums.InvoiceStatus.draft = _('Draft') class-attribute instance-attribute
djstripe.enums.InvoiceStatus.open = _('Open') class-attribute instance-attribute
djstripe.enums.InvoiceStatus.paid = _('Paid') class-attribute instance-attribute
djstripe.enums.InvoiceStatus.uncollectible = _('Uncollectible') class-attribute instance-attribute
djstripe.enums.InvoiceStatus.void = _('Void') class-attribute instance-attribute

djstripe.enums.LegacySourceType

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
688
689
690
691
692
class LegacySourceType(Enum):
    card = _("Card")
    bank_account = _("Bank account")
    bitcoin_receiver = _("Bitcoin receiver")
    alipay_account = _("Alipay account")

Attributes

djstripe.enums.LegacySourceType.alipay_account = _('Alipay account') class-attribute instance-attribute
djstripe.enums.LegacySourceType.bank_account = _('Bank account') class-attribute instance-attribute
djstripe.enums.LegacySourceType.bitcoin_receiver = _('Bitcoin receiver') class-attribute instance-attribute
djstripe.enums.LegacySourceType.card = _('Card') class-attribute instance-attribute

djstripe.enums.LineItem

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
433
434
435
class LineItem(Enum):
    invoiceitem = _("Invoice Item")
    subscription = _("Subscription")

Attributes

djstripe.enums.LineItem.invoiceitem = _('Invoice Item') class-attribute instance-attribute
djstripe.enums.LineItem.subscription = _('Subscription') class-attribute instance-attribute

djstripe.enums.MandateStatus

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
438
439
440
441
class MandateStatus(Enum):
    active = _("Active")
    inactive = _("Inactive")
    pending = _("Pending")

Attributes

djstripe.enums.MandateStatus.active = _('Active') class-attribute instance-attribute
djstripe.enums.MandateStatus.inactive = _('Inactive') class-attribute instance-attribute
djstripe.enums.MandateStatus.pending = _('Pending') class-attribute instance-attribute

djstripe.enums.MandateType

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
444
445
446
class MandateType(Enum):
    multi_use = _("Multi-use")
    single_use = _("Single-use")

Attributes

djstripe.enums.MandateType.multi_use = _('Multi-use') class-attribute instance-attribute
djstripe.enums.MandateType.single_use = _('Single-use') class-attribute instance-attribute

djstripe.enums.OrderStatus

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
449
450
451
452
453
454
class OrderStatus(Enum):
    open = _("Open")
    submitted = _("Submitted")
    processing = _("Processing")
    complete = _("Complete")
    canceled = _("Canceled")

Attributes

djstripe.enums.OrderStatus.canceled = _('Canceled') class-attribute instance-attribute
djstripe.enums.OrderStatus.complete = _('Complete') class-attribute instance-attribute
djstripe.enums.OrderStatus.open = _('Open') class-attribute instance-attribute
djstripe.enums.OrderStatus.processing = _('Processing') class-attribute instance-attribute
djstripe.enums.OrderStatus.submitted = _('Submitted') class-attribute instance-attribute

djstripe.enums.PaymentIntentCancellationReason

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
584
585
586
587
588
589
590
591
592
593
594
class PaymentIntentCancellationReason(Enum):
    # see also SetupIntentCancellationReason
    # User provided reasons:
    duplicate = _("Duplicate")
    fraudulent = _("Fraudulent")
    abandoned = _("Abandoned")
    requested_by_customer = _("Requested by Customer")
    # Reasons generated by Stripe internally
    failed_invoice = _("Failed invoice")
    void_invoice = _("Void invoice")
    automatic = _("Automatic")

Attributes

djstripe.enums.PaymentIntentCancellationReason.abandoned = _('Abandoned') class-attribute instance-attribute
djstripe.enums.PaymentIntentCancellationReason.automatic = _('Automatic') class-attribute instance-attribute
djstripe.enums.PaymentIntentCancellationReason.duplicate = _('Duplicate') class-attribute instance-attribute
djstripe.enums.PaymentIntentCancellationReason.failed_invoice = _('Failed invoice') class-attribute instance-attribute
djstripe.enums.PaymentIntentCancellationReason.fraudulent = _('Fraudulent') class-attribute instance-attribute
djstripe.enums.PaymentIntentCancellationReason.requested_by_customer = _('Requested by Customer') class-attribute instance-attribute
djstripe.enums.PaymentIntentCancellationReason.void_invoice = _('Void invoice') class-attribute instance-attribute

djstripe.enums.PaymentIntentStatus

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
459
460
461
462
463
464
465
466
467
468
469
470
471
class PaymentIntentStatus(Enum):
    requires_payment_method = _(
        "Intent created and requires a Payment Method to be attached."
    )
    requires_confirmation = _("Intent is ready to be confirmed.")
    requires_action = _("Payment Method require additional action, such as 3D secure.")
    processing = _("Required actions have been handled.")
    requires_capture = _("Capture the funds on the cards which have been put on holds.")
    canceled = _(
        "Cancellation invalidates the intent for future confirmation and "
        "cannot be undone."
    )
    succeeded = _("The funds are in your account.")

Attributes

djstripe.enums.PaymentIntentStatus.canceled = _('Cancellation invalidates the intent for future confirmation and cannot be undone.') class-attribute instance-attribute
djstripe.enums.PaymentIntentStatus.processing = _('Required actions have been handled.') class-attribute instance-attribute
djstripe.enums.PaymentIntentStatus.requires_action = _('Payment Method require additional action, such as 3D secure.') class-attribute instance-attribute
djstripe.enums.PaymentIntentStatus.requires_capture = _('Capture the funds on the cards which have been put on holds.') class-attribute instance-attribute
djstripe.enums.PaymentIntentStatus.requires_confirmation = _('Intent is ready to be confirmed.') class-attribute instance-attribute
djstripe.enums.PaymentIntentStatus.requires_payment_method = _('Intent created and requires a Payment Method to be attached.') class-attribute instance-attribute
djstripe.enums.PaymentIntentStatus.succeeded = _('The funds are in your account.') class-attribute instance-attribute

djstripe.enums.PaymentMethodType

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
class PaymentMethodType(Enum):
    acss_debit = _("ACSS Dbit")
    affirm = _("Affirm")
    afterpay_clearpay = _("Afterpay Clearpay")
    alipay = _("Alipay")
    au_becs_debit = _("BECS Debit (Australia)")
    bacs_debit = _("Bacs Direct Debit")
    bancontact = _("Bancontact")
    blik = _("BLIK")
    boleto = _("Boleto")
    card = _("Card")
    card_present = _("Card present")
    cashapp = _("Cash App")
    customer_balance = _("Customer Balance")
    eps = _("EPS")
    fpx = _("FPX")
    giropay = _("Giropay")
    grabpay = _("Grabpay")
    ideal = _("iDEAL")
    interac_present = _("Interac (card present)")
    klarna = _("Klarna")
    konbini = _("Konbini")
    link = _("Link")
    oxxo = _("OXXO")
    p24 = _("Przelewy24")
    paynow = _("PayNow")
    paypal = _("PayPal")
    pix = _("Pix")
    promptpay = _("PromptPay")
    sepa_debit = _("SEPA Direct Debit")
    sofort = _("SOFORT")
    us_bank_account = _("ACH Direct Debit")
    wechat_pay = _("Wechat Pay")
    zip = _("Zip")

Attributes

djstripe.enums.PaymentMethodType.acss_debit = _('ACSS Dbit') class-attribute instance-attribute
djstripe.enums.PaymentMethodType.affirm = _('Affirm') class-attribute instance-attribute
djstripe.enums.PaymentMethodType.afterpay_clearpay = _('Afterpay Clearpay') class-attribute instance-attribute
djstripe.enums.PaymentMethodType.alipay = _('Alipay') class-attribute instance-attribute
djstripe.enums.PaymentMethodType.au_becs_debit = _('BECS Debit (Australia)') class-attribute instance-attribute
djstripe.enums.PaymentMethodType.bacs_debit = _('Bacs Direct Debit') class-attribute instance-attribute
djstripe.enums.PaymentMethodType.bancontact = _('Bancontact') class-attribute instance-attribute
djstripe.enums.PaymentMethodType.blik = _('BLIK') class-attribute instance-attribute
djstripe.enums.PaymentMethodType.boleto = _('Boleto') class-attribute instance-attribute
djstripe.enums.PaymentMethodType.card = _('Card') class-attribute instance-attribute
djstripe.enums.PaymentMethodType.card_present = _('Card present') class-attribute instance-attribute
djstripe.enums.PaymentMethodType.cashapp = _('Cash App') class-attribute instance-attribute
djstripe.enums.PaymentMethodType.customer_balance = _('Customer Balance') class-attribute instance-attribute
djstripe.enums.PaymentMethodType.eps = _('EPS') class-attribute instance-attribute
djstripe.enums.PaymentMethodType.fpx = _('FPX') class-attribute instance-attribute
djstripe.enums.PaymentMethodType.giropay = _('Giropay') class-attribute instance-attribute
djstripe.enums.PaymentMethodType.grabpay = _('Grabpay') class-attribute instance-attribute
djstripe.enums.PaymentMethodType.ideal = _('iDEAL') class-attribute instance-attribute
djstripe.enums.PaymentMethodType.interac_present = _('Interac (card present)') class-attribute instance-attribute
djstripe.enums.PaymentMethodType.klarna = _('Klarna') class-attribute instance-attribute
djstripe.enums.PaymentMethodType.konbini = _('Konbini') class-attribute instance-attribute
djstripe.enums.PaymentMethodType.oxxo = _('OXXO') class-attribute instance-attribute
djstripe.enums.PaymentMethodType.p24 = _('Przelewy24') class-attribute instance-attribute
djstripe.enums.PaymentMethodType.paynow = _('PayNow') class-attribute instance-attribute
djstripe.enums.PaymentMethodType.paypal = _('PayPal') class-attribute instance-attribute
djstripe.enums.PaymentMethodType.pix = _('Pix') class-attribute instance-attribute
djstripe.enums.PaymentMethodType.promptpay = _('PromptPay') class-attribute instance-attribute
djstripe.enums.PaymentMethodType.sepa_debit = _('SEPA Direct Debit') class-attribute instance-attribute
djstripe.enums.PaymentMethodType.sofort = _('SOFORT') class-attribute instance-attribute
djstripe.enums.PaymentMethodType.us_bank_account = _('ACH Direct Debit') class-attribute instance-attribute
djstripe.enums.PaymentMethodType.wechat_pay = _('Wechat Pay') class-attribute instance-attribute
djstripe.enums.PaymentMethodType.zip = _('Zip') class-attribute instance-attribute

djstripe.enums.PayoutFailureCode

Bases: Enum

Payout failure error codes.

https://stripe.com/docs/api#payout_failures

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
class PayoutFailureCode(Enum):
    """
    Payout failure error codes.

    https://stripe.com/docs/api#payout_failures
    """

    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.")
    declined = _(
        "The bank has declined this transfer. Please contact the bank before retrying."
    )
    insufficient_funds = _("Stripe account has insufficient funds.")
    invalid_account_number = _("Invalid account number")
    incorrect_account_holder_name = _(
        "Your bank notified us that the bank account holder name on file is incorrect."
    )
    incorrect_account_holder_address = _(
        "Your bank notified us that the bank account holder address on file is"
        " incorrect."
    )
    incorrect_account_holder_tax_id = _(
        "Your bank notified us that the bank account holder tax ID on file is"
        " incorrect."
    )
    invalid_currency = _("Bank account does not support currency.")
    no_account = _("Bank account could not be located.")
    unsupported_card = _("Card no longer supported.")

Attributes

djstripe.enums.PayoutFailureCode.account_closed = _('Bank account has been closed.') class-attribute instance-attribute
djstripe.enums.PayoutFailureCode.account_frozen = _('Bank account has been frozen.') class-attribute instance-attribute
djstripe.enums.PayoutFailureCode.bank_account_restricted = _('Bank account has restrictions on payouts allowed.') class-attribute instance-attribute
djstripe.enums.PayoutFailureCode.bank_ownership_changed = _('Destination bank account has changed ownership.') class-attribute instance-attribute
djstripe.enums.PayoutFailureCode.could_not_process = _('Bank could not process payout.') class-attribute instance-attribute
djstripe.enums.PayoutFailureCode.debit_not_authorized = _('Debit transactions not approved on the bank account.') class-attribute instance-attribute
djstripe.enums.PayoutFailureCode.declined = _('The bank has declined this transfer. Please contact the bank before retrying.') class-attribute instance-attribute
djstripe.enums.PayoutFailureCode.incorrect_account_holder_address = _('Your bank notified us that the bank account holder address on file is incorrect.') class-attribute instance-attribute
djstripe.enums.PayoutFailureCode.incorrect_account_holder_name = _('Your bank notified us that the bank account holder name on file is incorrect.') class-attribute instance-attribute
djstripe.enums.PayoutFailureCode.incorrect_account_holder_tax_id = _('Your bank notified us that the bank account holder tax ID on file is incorrect.') class-attribute instance-attribute
djstripe.enums.PayoutFailureCode.insufficient_funds = _('Stripe account has insufficient funds.') class-attribute instance-attribute
djstripe.enums.PayoutFailureCode.invalid_account_number = _('Invalid account number') class-attribute instance-attribute
djstripe.enums.PayoutFailureCode.invalid_currency = _('Bank account does not support currency.') class-attribute instance-attribute
djstripe.enums.PayoutFailureCode.no_account = _('Bank account could not be located.') class-attribute instance-attribute
djstripe.enums.PayoutFailureCode.unsupported_card = _('Card no longer supported.') class-attribute instance-attribute

djstripe.enums.PayoutMethod

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
560
561
562
class PayoutMethod(Enum):
    standard = _("Standard")
    instant = _("Instant")

Attributes

djstripe.enums.PayoutMethod.instant = _('Instant') class-attribute instance-attribute
djstripe.enums.PayoutMethod.standard = _('Standard') class-attribute instance-attribute

djstripe.enums.PayoutSourceType

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
565
566
567
568
class PayoutSourceType(Enum):
    bank_account = _("Bank account")
    fpx = _("Financial Process Exchange (FPX)")
    card = _("Card")

Attributes

djstripe.enums.PayoutSourceType.bank_account = _('Bank account') class-attribute instance-attribute
djstripe.enums.PayoutSourceType.card = _('Card') class-attribute instance-attribute
djstripe.enums.PayoutSourceType.fpx = _('Financial Process Exchange (FPX)') class-attribute instance-attribute

djstripe.enums.PayoutStatus

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
571
572
573
574
575
576
class PayoutStatus(Enum):
    paid = _("Paid")
    pending = _("Pending")
    in_transit = _("In transit")
    canceled = _("Canceled")
    failed = _("Failed")

Attributes

djstripe.enums.PayoutStatus.canceled = _('Canceled') class-attribute instance-attribute
djstripe.enums.PayoutStatus.failed = _('Failed') class-attribute instance-attribute
djstripe.enums.PayoutStatus.in_transit = _('In transit') class-attribute instance-attribute
djstripe.enums.PayoutStatus.paid = _('Paid') class-attribute instance-attribute
djstripe.enums.PayoutStatus.pending = _('Pending') class-attribute instance-attribute

djstripe.enums.PayoutType

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
579
580
581
class PayoutType(Enum):
    bank_account = _("Bank account")
    card = _("Card")

Attributes

djstripe.enums.PayoutType.bank_account = _('Bank account') class-attribute instance-attribute
djstripe.enums.PayoutType.card = _('Card') class-attribute instance-attribute

djstripe.enums.PlanAggregateUsage

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
597
598
599
600
601
class PlanAggregateUsage(Enum):
    last_during_period = _("Last during period")
    last_ever = _("Last ever")
    max = _("Max")
    sum = _("Sum")

Attributes

djstripe.enums.PlanAggregateUsage.last_during_period = _('Last during period') class-attribute instance-attribute
djstripe.enums.PlanAggregateUsage.last_ever = _('Last ever') class-attribute instance-attribute
djstripe.enums.PlanAggregateUsage.max = _('Max') class-attribute instance-attribute
djstripe.enums.PlanAggregateUsage.sum = _('Sum') class-attribute instance-attribute

djstripe.enums.PlanInterval

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
604
605
606
607
608
class PlanInterval(Enum):
    day = _("Day")
    week = _("Week")
    month = _("Month")
    year = _("Year")

Attributes

djstripe.enums.PlanInterval.day = _('Day') class-attribute instance-attribute
djstripe.enums.PlanInterval.month = _('Month') class-attribute instance-attribute
djstripe.enums.PlanInterval.week = _('Week') class-attribute instance-attribute
djstripe.enums.PlanInterval.year = _('Year') class-attribute instance-attribute

djstripe.enums.PriceTiersMode

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
611
612
613
class PriceTiersMode(Enum):
    graduated = _("Graduated")
    volume = _("Volume-based")

Attributes

djstripe.enums.PriceTiersMode.graduated = _('Graduated') class-attribute instance-attribute
djstripe.enums.PriceTiersMode.volume = _('Volume-based') class-attribute instance-attribute

djstripe.enums.PriceType

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
616
617
618
class PriceType(Enum):
    one_time = _("One-time")
    recurring = _("Recurring")

Attributes

djstripe.enums.PriceType.one_time = _('One-time') class-attribute instance-attribute
djstripe.enums.PriceType.recurring = _('Recurring') class-attribute instance-attribute

djstripe.enums.PriceUsageType

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
621
622
623
class PriceUsageType(Enum):
    metered = _("Metered")
    licensed = _("Licensed")

Attributes

djstripe.enums.PriceUsageType.licensed = _('Licensed') class-attribute instance-attribute
djstripe.enums.PriceUsageType.metered = _('Metered') class-attribute instance-attribute

djstripe.enums.ProductType

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
631
632
633
class ProductType(Enum):
    good = _("Good")
    service = _("Service")

Attributes

djstripe.enums.ProductType.good = _('Good') class-attribute instance-attribute
djstripe.enums.ProductType.service = _('Service') class-attribute instance-attribute

djstripe.enums.RefundFailureReason

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
695
696
697
698
class RefundFailureReason(Enum):
    lost_or_stolen_card = _("Lost or stolen card")
    expired_or_canceled_card = _("Expired or canceled card")
    unknown = _("Unknown")

Attributes

djstripe.enums.RefundFailureReason.expired_or_canceled_card = _('Expired or canceled card') class-attribute instance-attribute
djstripe.enums.RefundFailureReason.lost_or_stolen_card = _('Lost or stolen card') class-attribute instance-attribute
djstripe.enums.RefundFailureReason.unknown = _('Unknown') class-attribute instance-attribute

djstripe.enums.RefundReason

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
701
702
703
704
705
class RefundReason(Enum):
    duplicate = _("Duplicate charge")
    fraudulent = _("Fraudulent")
    requested_by_customer = _("Requested by customer")
    expired_uncaptured_charge = _("Expired uncaptured charge")

Attributes

djstripe.enums.RefundReason.duplicate = _('Duplicate charge') class-attribute instance-attribute
djstripe.enums.RefundReason.expired_uncaptured_charge = _('Expired uncaptured charge') class-attribute instance-attribute
djstripe.enums.RefundReason.fraudulent = _('Fraudulent') class-attribute instance-attribute
djstripe.enums.RefundReason.requested_by_customer = _('Requested by customer') class-attribute instance-attribute

djstripe.enums.RefundStatus

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
708
709
710
711
712
class RefundStatus(Enum):
    pending = _("Pending")
    succeeded = _("Succeeded")
    failed = _("Failed")
    canceled = _("Canceled")

Attributes

djstripe.enums.RefundStatus.canceled = _('Canceled') class-attribute instance-attribute
djstripe.enums.RefundStatus.failed = _('Failed') class-attribute instance-attribute
djstripe.enums.RefundStatus.pending = _('Pending') class-attribute instance-attribute
djstripe.enums.RefundStatus.succeeded = _('Succeeded') class-attribute instance-attribute

djstripe.enums.ScheduledQueryRunStatus

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
643
644
645
646
class ScheduledQueryRunStatus(Enum):
    canceled = _("Canceled")
    failed = _("Failed")
    timed_out = _("Timed out")

Attributes

djstripe.enums.ScheduledQueryRunStatus.canceled = _('Canceled') class-attribute instance-attribute
djstripe.enums.ScheduledQueryRunStatus.failed = _('Failed') class-attribute instance-attribute
djstripe.enums.ScheduledQueryRunStatus.timed_out = _('Timed out') class-attribute instance-attribute

djstripe.enums.SessionMode

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
715
716
717
718
class SessionMode(Enum):
    payment = _("Payment")
    setup = _("Setup")
    subscription = _("Subscription")

Attributes

djstripe.enums.SessionMode.payment = _('Payment') class-attribute instance-attribute
djstripe.enums.SessionMode.setup = _('Setup') class-attribute instance-attribute
djstripe.enums.SessionMode.subscription = _('Subscription') class-attribute instance-attribute

djstripe.enums.SessionStatus

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
307
308
309
310
class SessionStatus(Enum):
    open = _("Open")
    complete = _("Complete")
    expired = _("Expired")

Attributes

djstripe.enums.SessionStatus.complete = _('Complete') class-attribute instance-attribute
djstripe.enums.SessionStatus.expired = _('Expired') class-attribute instance-attribute
djstripe.enums.SessionStatus.open = _('Open') class-attribute instance-attribute

djstripe.enums.SetupIntentCancellationReason

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
636
637
638
639
640
class SetupIntentCancellationReason(Enum):
    # see also PaymentIntentCancellationReason
    abandoned = _("Abandoned")
    requested_by_customer = _("Requested by Customer")
    duplicate = _("Duplicate")

Attributes

djstripe.enums.SetupIntentCancellationReason.abandoned = _('Abandoned') class-attribute instance-attribute
djstripe.enums.SetupIntentCancellationReason.duplicate = _('Duplicate') class-attribute instance-attribute
djstripe.enums.SetupIntentCancellationReason.requested_by_customer = _('Requested by Customer') class-attribute instance-attribute

djstripe.enums.SetupIntentStatus

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
474
475
476
477
478
479
480
481
482
483
484
485
486
487
class SetupIntentStatus(Enum):
    requires_payment_method = _(
        "Intent created and requires a Payment Method to be attached."
    )
    requires_confirmation = _("Intent is ready to be confirmed.")
    requires_action = _("Payment Method require additional action, such as 3D secure.")
    processing = _("Required actions have been handled.")
    canceled = _(
        "Cancellation invalidates the intent for future confirmation and "
        "cannot be undone."
    )
    succeeded = _(
        "Setup was successful and the payment method is optimized for future payments."
    )

Attributes

djstripe.enums.SetupIntentStatus.canceled = _('Cancellation invalidates the intent for future confirmation and cannot be undone.') class-attribute instance-attribute
djstripe.enums.SetupIntentStatus.processing = _('Required actions have been handled.') class-attribute instance-attribute
djstripe.enums.SetupIntentStatus.requires_action = _('Payment Method require additional action, such as 3D secure.') class-attribute instance-attribute
djstripe.enums.SetupIntentStatus.requires_confirmation = _('Intent is ready to be confirmed.') class-attribute instance-attribute
djstripe.enums.SetupIntentStatus.requires_payment_method = _('Intent created and requires a Payment Method to be attached.') class-attribute instance-attribute
djstripe.enums.SetupIntentStatus.succeeded = _('Setup was successful and the payment method is optimized for future payments.') class-attribute instance-attribute

djstripe.enums.ShippingRateTaxBehavior

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
779
780
781
782
class ShippingRateTaxBehavior(Enum):
    inclusive = _("Inclusive")
    exclusive = _("Exclusive")
    unspecified = _("Unspecified")

Attributes

djstripe.enums.ShippingRateTaxBehavior.exclusive = _('Exclusive') class-attribute instance-attribute
djstripe.enums.ShippingRateTaxBehavior.inclusive = _('Inclusive') class-attribute instance-attribute
djstripe.enums.ShippingRateTaxBehavior.unspecified = _('Unspecified') class-attribute instance-attribute

djstripe.enums.ShippingRateType

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
775
776
class ShippingRateType(Enum):
    fixed_amount = _("Fixed Amount")

Attributes

djstripe.enums.ShippingRateType.fixed_amount = _('Fixed Amount') class-attribute instance-attribute

djstripe.enums.SourceCodeVerificationStatus

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
726
727
728
729
class SourceCodeVerificationStatus(Enum):
    pending = _("Pending")
    succeeded = _("Succeeded")
    failed = _("Failed")

Attributes

djstripe.enums.SourceCodeVerificationStatus.failed = _('Failed') class-attribute instance-attribute
djstripe.enums.SourceCodeVerificationStatus.pending = _('Pending') class-attribute instance-attribute
djstripe.enums.SourceCodeVerificationStatus.succeeded = _('Succeeded') class-attribute instance-attribute

djstripe.enums.SourceFlow

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
649
650
651
652
653
class SourceFlow(Enum):
    redirect = _("Redirect")
    receiver = _("Receiver")
    code_verification = _("Code verification")
    none = _("None")

Attributes

djstripe.enums.SourceFlow.code_verification = _('Code verification') class-attribute instance-attribute
djstripe.enums.SourceFlow.none = _('None') class-attribute instance-attribute
djstripe.enums.SourceFlow.receiver = _('Receiver') class-attribute instance-attribute
djstripe.enums.SourceFlow.redirect = _('Redirect') class-attribute instance-attribute

djstripe.enums.SourceRedirectFailureReason

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
732
733
734
735
class SourceRedirectFailureReason(Enum):
    user_abort = _("User-aborted")
    declined = _("Declined")
    processing_error = _("Processing error")

Attributes

djstripe.enums.SourceRedirectFailureReason.declined = _('Declined') class-attribute instance-attribute
djstripe.enums.SourceRedirectFailureReason.processing_error = _('Processing error') class-attribute instance-attribute
djstripe.enums.SourceRedirectFailureReason.user_abort = _('User-aborted') class-attribute instance-attribute

djstripe.enums.SourceRedirectStatus

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
738
739
740
741
742
class SourceRedirectStatus(Enum):
    pending = _("Pending")
    succeeded = _("Succeeded")
    not_required = _("Not required")
    failed = _("Failed")

Attributes

djstripe.enums.SourceRedirectStatus.failed = _('Failed') class-attribute instance-attribute
djstripe.enums.SourceRedirectStatus.not_required = _('Not required') class-attribute instance-attribute
djstripe.enums.SourceRedirectStatus.pending = _('Pending') class-attribute instance-attribute
djstripe.enums.SourceRedirectStatus.succeeded = _('Succeeded') class-attribute instance-attribute

djstripe.enums.SourceStatus

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
656
657
658
659
660
661
class SourceStatus(Enum):
    canceled = _("Canceled")
    chargeable = _("Chargeable")
    consumed = _("Consumed")
    failed = _("Failed")
    pending = _("Pending")

Attributes

djstripe.enums.SourceStatus.canceled = _('Canceled') class-attribute instance-attribute
djstripe.enums.SourceStatus.chargeable = _('Chargeable') class-attribute instance-attribute
djstripe.enums.SourceStatus.consumed = _('Consumed') class-attribute instance-attribute
djstripe.enums.SourceStatus.failed = _('Failed') class-attribute instance-attribute
djstripe.enums.SourceStatus.pending = _('Pending') class-attribute instance-attribute

djstripe.enums.SourceType

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
class SourceType(Enum):
    ach_credit_transfer = _("ACH Credit Transfer")
    ach_debit = _("ACH Debit")
    acss_debit = _("ACSS Debit")
    alipay = _("Alipay")
    au_becs_debit = _("BECS Debit (AU)")
    bancontact = _("Bancontact")
    bitcoin = _("Bitcoin (Legacy)")
    card = _("Card")
    card_present = _("Card present")
    eps = _("EPS")
    giropay = _("Giropay")
    ideal = _("iDEAL")
    klarna = _("Klarna")
    multibanco = _("Multibanco")
    p24 = _("P24")
    paper_check = _("Paper check")
    sepa_credit_transfer = _("SEPA credit transfer")
    sepa_debit = _("SEPA Direct Debit")
    sofort = _("SOFORT")
    three_d_secure = _("3D Secure")
    wechat = _("WeChat")

Attributes

djstripe.enums.SourceType.ach_credit_transfer = _('ACH Credit Transfer') class-attribute instance-attribute
djstripe.enums.SourceType.ach_debit = _('ACH Debit') class-attribute instance-attribute
djstripe.enums.SourceType.acss_debit = _('ACSS Debit') class-attribute instance-attribute
djstripe.enums.SourceType.alipay = _('Alipay') class-attribute instance-attribute
djstripe.enums.SourceType.au_becs_debit = _('BECS Debit (AU)') class-attribute instance-attribute
djstripe.enums.SourceType.bancontact = _('Bancontact') class-attribute instance-attribute
djstripe.enums.SourceType.bitcoin = _('Bitcoin (Legacy)') class-attribute instance-attribute
djstripe.enums.SourceType.card = _('Card') class-attribute instance-attribute
djstripe.enums.SourceType.card_present = _('Card present') class-attribute instance-attribute
djstripe.enums.SourceType.eps = _('EPS') class-attribute instance-attribute
djstripe.enums.SourceType.giropay = _('Giropay') class-attribute instance-attribute
djstripe.enums.SourceType.ideal = _('iDEAL') class-attribute instance-attribute
djstripe.enums.SourceType.klarna = _('Klarna') class-attribute instance-attribute
djstripe.enums.SourceType.multibanco = _('Multibanco') class-attribute instance-attribute
djstripe.enums.SourceType.p24 = _('P24') class-attribute instance-attribute
djstripe.enums.SourceType.paper_check = _('Paper check') class-attribute instance-attribute
djstripe.enums.SourceType.sepa_credit_transfer = _('SEPA credit transfer') class-attribute instance-attribute
djstripe.enums.SourceType.sepa_debit = _('SEPA Direct Debit') class-attribute instance-attribute
djstripe.enums.SourceType.sofort = _('SOFORT') class-attribute instance-attribute
djstripe.enums.SourceType.three_d_secure = _('3D Secure') class-attribute instance-attribute
djstripe.enums.SourceType.wechat = _('WeChat') class-attribute instance-attribute

djstripe.enums.SourceUsage

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
721
722
723
class SourceUsage(Enum):
    reusable = _("Reusable")
    single_use = _("Single-use")

Attributes

djstripe.enums.SourceUsage.reusable = _('Reusable') class-attribute instance-attribute
djstripe.enums.SourceUsage.single_use = _('Single-use') class-attribute instance-attribute

djstripe.enums.SubscriptionProrationBehavior

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
769
770
771
772
class SubscriptionProrationBehavior(Enum):
    create_prorations = _("Create prorations")
    always_invoice = _("Always invoice")
    none = _("None")

Attributes

djstripe.enums.SubscriptionProrationBehavior.always_invoice = _('Always invoice') class-attribute instance-attribute
djstripe.enums.SubscriptionProrationBehavior.create_prorations = _('Create prorations') class-attribute instance-attribute
djstripe.enums.SubscriptionProrationBehavior.none = _('None') class-attribute instance-attribute

djstripe.enums.SubscriptionScheduleEndBehavior

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
745
746
747
class SubscriptionScheduleEndBehavior(Enum):
    release = _("Release")
    cancel = _("Cancel")

Attributes

djstripe.enums.SubscriptionScheduleEndBehavior.cancel = _('Cancel') class-attribute instance-attribute
djstripe.enums.SubscriptionScheduleEndBehavior.release = _('Release') class-attribute instance-attribute

djstripe.enums.SubscriptionScheduleStatus

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
750
751
752
753
754
755
class SubscriptionScheduleStatus(Enum):
    not_started = _("Not started")
    active = _("Active")
    completed = _("Completed")
    released = _("Released")
    canceled = _("Canceled")

Attributes

djstripe.enums.SubscriptionScheduleStatus.active = _('Active') class-attribute instance-attribute
djstripe.enums.SubscriptionScheduleStatus.canceled = _('Canceled') class-attribute instance-attribute
djstripe.enums.SubscriptionScheduleStatus.completed = _('Completed') class-attribute instance-attribute
djstripe.enums.SubscriptionScheduleStatus.not_started = _('Not started') class-attribute instance-attribute
djstripe.enums.SubscriptionScheduleStatus.released = _('Released') class-attribute instance-attribute

djstripe.enums.SubscriptionStatus

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
758
759
760
761
762
763
764
765
766
class SubscriptionStatus(Enum):
    incomplete = _("Incomplete")
    incomplete_expired = _("Incomplete Expired")
    trialing = _("Trialing")
    active = _("Active")
    past_due = _("Past due")
    canceled = _("Canceled")
    unpaid = _("Unpaid")
    paused = _("Paused")

Attributes

djstripe.enums.SubscriptionStatus.active = _('Active') class-attribute instance-attribute
djstripe.enums.SubscriptionStatus.canceled = _('Canceled') class-attribute instance-attribute
djstripe.enums.SubscriptionStatus.incomplete = _('Incomplete') class-attribute instance-attribute
djstripe.enums.SubscriptionStatus.incomplete_expired = _('Incomplete Expired') class-attribute instance-attribute
djstripe.enums.SubscriptionStatus.past_due = _('Past due') class-attribute instance-attribute
djstripe.enums.SubscriptionStatus.paused = _('Paused') class-attribute instance-attribute
djstripe.enums.SubscriptionStatus.trialing = _('Trialing') class-attribute instance-attribute
djstripe.enums.SubscriptionStatus.unpaid = _('Unpaid') class-attribute instance-attribute

djstripe.enums.TaxIdType

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
class TaxIdType(Enum):
    ae_trn = _("AE TRN")
    au_abn = _("AU ABN")
    br_cnp = _("BR CNP")
    br_cpf = _("BR CPF")
    ca_bn = _("CA BN")
    ca_qst = _("CA QST")
    ch_vat = _("CH VAT")
    cl_tin = _("CL TIN")
    es_cif = _("ES CIF")
    eu_vat = _("EU VAT")
    hk_br = _("HK BR")
    id_npw = _("ID NPW")
    in_gst = _("IN GST")
    jp_cn = _("JP CN")
    jp_rn = _("JP RN")
    kr_brn = _("KR BRN")
    li_uid = _("LI UID")
    mx_rfc = _("MX RFC")
    my_frp = _("MY FRP")
    my_itn = _("MY ITN")
    my_sst = _("MY SST")
    no_vat = _("NO VAT")
    nz_gst = _("NZ GST")
    ru_inn = _("RU INN")
    ru_kpp = _("RU KPP")
    sa_vat = _("SA VAT")
    sg_gst = _("SG GST")
    sg_uen = _("SG UEN")
    th_vat = _("TH VAT")
    tw_vat = _("TW VAT")
    us_ein = _("US EIN")
    za_vat = _("ZA VAT")
    unknown = _("Unknown")

Attributes

djstripe.enums.TaxIdType.ae_trn = _('AE TRN') class-attribute instance-attribute
djstripe.enums.TaxIdType.au_abn = _('AU ABN') class-attribute instance-attribute
djstripe.enums.TaxIdType.br_cnp = _('BR CNP') class-attribute instance-attribute
djstripe.enums.TaxIdType.br_cpf = _('BR CPF') class-attribute instance-attribute
djstripe.enums.TaxIdType.ca_bn = _('CA BN') class-attribute instance-attribute
djstripe.enums.TaxIdType.ca_qst = _('CA QST') class-attribute instance-attribute
djstripe.enums.TaxIdType.ch_vat = _('CH VAT') class-attribute instance-attribute
djstripe.enums.TaxIdType.cl_tin = _('CL TIN') class-attribute instance-attribute
djstripe.enums.TaxIdType.es_cif = _('ES CIF') class-attribute instance-attribute
djstripe.enums.TaxIdType.eu_vat = _('EU VAT') class-attribute instance-attribute
djstripe.enums.TaxIdType.hk_br = _('HK BR') class-attribute instance-attribute
djstripe.enums.TaxIdType.id_npw = _('ID NPW') class-attribute instance-attribute
djstripe.enums.TaxIdType.in_gst = _('IN GST') class-attribute instance-attribute
djstripe.enums.TaxIdType.jp_cn = _('JP CN') class-attribute instance-attribute
djstripe.enums.TaxIdType.jp_rn = _('JP RN') class-attribute instance-attribute
djstripe.enums.TaxIdType.kr_brn = _('KR BRN') class-attribute instance-attribute
djstripe.enums.TaxIdType.li_uid = _('LI UID') class-attribute instance-attribute
djstripe.enums.TaxIdType.mx_rfc = _('MX RFC') class-attribute instance-attribute
djstripe.enums.TaxIdType.my_frp = _('MY FRP') class-attribute instance-attribute
djstripe.enums.TaxIdType.my_itn = _('MY ITN') class-attribute instance-attribute
djstripe.enums.TaxIdType.my_sst = _('MY SST') class-attribute instance-attribute
djstripe.enums.TaxIdType.no_vat = _('NO VAT') class-attribute instance-attribute
djstripe.enums.TaxIdType.nz_gst = _('NZ GST') class-attribute instance-attribute
djstripe.enums.TaxIdType.ru_inn = _('RU INN') class-attribute instance-attribute
djstripe.enums.TaxIdType.ru_kpp = _('RU KPP') class-attribute instance-attribute
djstripe.enums.TaxIdType.sa_vat = _('SA VAT') class-attribute instance-attribute
djstripe.enums.TaxIdType.sg_gst = _('SG GST') class-attribute instance-attribute
djstripe.enums.TaxIdType.sg_uen = _('SG UEN') class-attribute instance-attribute
djstripe.enums.TaxIdType.th_vat = _('TH VAT') class-attribute instance-attribute
djstripe.enums.TaxIdType.tw_vat = _('TW VAT') class-attribute instance-attribute
djstripe.enums.TaxIdType.unknown = _('Unknown') class-attribute instance-attribute
djstripe.enums.TaxIdType.us_ein = _('US EIN') class-attribute instance-attribute
djstripe.enums.TaxIdType.za_vat = _('ZA VAT') class-attribute instance-attribute

djstripe.enums.VerificationSessionStatus

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
821
822
823
824
825
826
827
828
829
class VerificationSessionStatus(Enum):
    """
    https://stripe.com/docs/api/identity/verification_sessions/object#identity_verification_session_object-status
    """

    requires_input = _("Requires input")
    processing = _("Processing")
    verified = _("Verified")
    canceled = _("Canceled")

Attributes

djstripe.enums.VerificationSessionStatus.canceled = _('Canceled') class-attribute instance-attribute
djstripe.enums.VerificationSessionStatus.processing = _('Processing') class-attribute instance-attribute
djstripe.enums.VerificationSessionStatus.requires_input = _('Requires input') class-attribute instance-attribute
djstripe.enums.VerificationSessionStatus.verified = _('Verified') class-attribute instance-attribute

djstripe.enums.VerificationType

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
832
833
834
835
836
837
838
class VerificationType(Enum):
    """
    https://stripe.com/docs/api/identity/verification_sessions/object#identity_verification_session_object-type
    """

    document = _("Document")
    id_number = _("ID number")

Attributes

djstripe.enums.VerificationType.document = _('Document') class-attribute instance-attribute
djstripe.enums.VerificationType.id_number = _('ID number') class-attribute instance-attribute

djstripe.enums.WebhookEndpointStatus

Bases: Enum

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
841
842
843
class WebhookEndpointStatus(Enum):
    enabled = _("enabled")
    disabled = _("disabled")

Attributes

djstripe.enums.WebhookEndpointStatus.disabled = _('disabled') class-attribute instance-attribute
djstripe.enums.WebhookEndpointStatus.enabled = _('enabled') class-attribute instance-attribute

djstripe.enums.WebhookEndpointValidation

Bases: Enum

An enum to specific the choices for WebhookEndpoint Validation.

Source code in .venv/lib/python3.12/site-packages/djstripe/enums.py 
846
847
848
849
850
851
class WebhookEndpointValidation(Enum):
    """An enum to specific the choices for WebhookEndpoint Validation."""

    verify_signature = _("Verify Signature")
    retrieve_event = _("Retrieve Event")
    none = _("None (NOT RECOMMENDED)")

Attributes

djstripe.enums.WebhookEndpointValidation.none = _('None (NOT RECOMMENDED)') class-attribute instance-attribute
djstripe.enums.WebhookEndpointValidation.retrieve_event = _('Retrieve Event') class-attribute instance-attribute
djstripe.enums.WebhookEndpointValidation.verify_signature = _('Verify Signature') class-attribute instance-attribute