Unique identifier for the object.
String representing the object's type. Objects of the same type share the same value.
Time at which the object was created. Measured in seconds since the Unix epoch.
OptionaldeletedIf true, indicates that this secret has been deleted
The Unix timestamp for the expiry time of the secret, after which the secret deletes.
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
A name for the secret that's unique within the scope.
OptionalpayloadThe plaintext secret value to be stored.
Secret Store is an API that allows Stripe Apps developers to securely persist secrets for use by UI Extensions and app backends.
The primary resource in Secret Store is a
secret. Other apps can't view secrets created by an app. Additionally, secrets are scoped to provide further permission control.All Dashboard users and the app backend share
accountscoped secrets. Use theaccountscope for secrets that don't change per-user, like a third-party API key.A
userscoped secret is accessible by the app backend and one specific Dashboard user. Use theuserscope for per-user secrets like per-user OAuth tokens, where different users might have different permissions.Related guide: Store data between page reloads