Stripe: Ephemeral keys schemas
1 Stripe schema with complete fields and constraints.
← Ephemeral keys operations · All schemas
Create an ephemeral key — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Ephemeral keys give the SDKs (like Stripe's mobile SDKs and Issuing Elements) temporary, scoped access to a specific resource, such as a Customer, Issuing Card, or Identity VerificationSession, without exposing your secret API key. Related guides: [Using Issuing Elements](https://docs.stripe.com/issuing/elements). |
created | JSON | Required within parent | |
created (anyOf 1) | integer | Alternative | Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time |
created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
expires | JSON | Required within parent | |
expires (anyOf 1) | integer | Alternative | Time at which the key will expire. Measured in seconds since the Unix epoch. Format: unix-time |
expires (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
livemode | boolean | Required within parent | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: ephemeral_key |
secret | string | Optional | The key's secret. You can use this value to make authorized requests to the Stripe API. Maximum length: 5000 |