djstripe.models.api

APIKey

Bases: StripeModel

id

attribute  id

livemode

attribute  livemode

metadata

attribute  metadata

name

attribute  name

object

attribute  object

objects

attribute  objects

secret

attribute  secret

secret_redacted

property  secret_redacted: str

Returns a redacted version of the secret, suitable for display purposes.

Same algorithm used on the Stripe dashboard.

type

attribute  type

clean

clean(self)

get_stripe_dashboard_url

get_stripe_dashboard_url(self)

refresh_account

refresh_account(self, commit = True)

APIKeyManager

Bases: models.Manager

get_or_create_by_api_key

get_or_create_by_api_key(self, secret: str)

generate_api_key_id

generate_api_key_id() -> str

get_api_key_details_by_prefix

get_api_key_details_by_prefix(api_key: str)

redact_api_key

redact_api_key(api_key: str) -> str

Return a redacted version of an API key, suitable for display purposes.

Uses the same algorithm as the Stripe dashboard.