The Secret object

Attributes

idstring
Unique identifier for the object.

objectstring
String representing the object’s type. Objects of the same type share the same value.

createdtimestamp
Time at which the object was created. Measured in seconds since the Unix epoch.

deletednullable boolean
If true, indicates that this secret has been deleted

expires_atnullable timestamp
The Unix timestamp for the expiry time of the secret, after which the secret deletes.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

namestring
A name for the secret that’s unique within the scope.

payloadnullable stringExpandable
The plaintext secret value to be stored.

scopeobject
Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.

The Secret object

{
  "id": "appsecret_5110hHS1707T6fjBnah1LkdIwHu7ix",
  "object": "apps.secret",
  "created": 1680209063,
  "expires_at": null,
  "livemode": false,
  "name": "my-api-key",
  "scope": {
    "type": "account"
  }
}

List secrets

List all secrets stored on the given scope.

Parameters

scopeobjectRequired
Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.

More parameters

ending_beforestring

limitinteger

starting_afterstring

Returns

A dictionary with a data property that contains an array of up to limit Secrets, starting after Secret starting_after. Each entry in the array is a separate Secret object. If no more Secrets are available, the resulting array will be empty.

GET /v1/apps/secrets

Server-side language

curl -G https://api.stripe.com/v1/apps/secrets \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
  -d "scope[type]"=account

Response

{
  "object": "list",
  "url": "/v1/apps/secrets",
  "has_more": false,
  "data": [
    {
      "id": "appsecret_5110hHS1707T6fjBnah1LkdIwHu7ix",
      "object": "apps.secret",
      "created": 1680209063,
      "expires_at": null,
      "livemode": false,
      "name": "my-api-key",
      "scope": {
        "type": "account"
      }
    }
    {...}
    {...}
  ],
}

Delete a Secret

Deletes a secret from the secret store by name and scope.

Parameters

namestringRequired
A name for the secret that’s unique within the scope.

scopeobjectRequired
Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.

Returns

Returns the deleted secret object.

POST /v1/apps/secrets/delete

Server-side language

curl https://api.stripe.com/v1/apps/secrets/delete \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
  -d name=my-api-key \
  -d "scope[type]"=account

Response

{
  "id": "appsecret_5110hHS1707T6fjBnah1LkdIwHu7ix",
  "object": "apps.secret",
  "deleted": true
}

Find a Secret

Finds a secret in the secret store by name and scope.

Parameters

namestringRequired
A name for the secret that’s unique within the scope.

scopeobjectRequired
Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.

Returns

Returns a secret object.

GET /v1/apps/secrets/find

Server-side language

curl -G https://api.stripe.com/v1/apps/secrets/find \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
  -d name=my-api-key \
  -d "scope[type]"=account

Response

{
  "id": "appsecret_5110hHS1707T6fjBnah1LkdIwHu7ix",
  "object": "apps.secret",
  "created": 1680209063,
  "expires_at": null,
  "livemode": false,
  "name": "my-api-key",
  "scope": {
    "type": "account"
  }
}

Set a Secret

Create or replace a secret in the secret store.

Parameters

namestringRequired
A name for the secret that’s unique within the scope.

payloadstringRequired
The plaintext secret value to be stored.

scopeobjectRequired
Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.

expires_attimestamp
The Unix timestamp for the expiry time of the secret, after which the secret deletes.

Returns

Returns a secret object.

POST /v1/apps/secrets

Server-side language

curl https://api.stripe.com/v1/apps/secrets \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
  -d name=my-api-key \
  -d payload=secret_key_xxxxxx \
  -d "scope[type]"=account

Response

{
  "id": "appsecret_5110hHS1707T6fjBnah1LkdIwHu7ix",
  "object": "apps.secret",
  "created": 1680209063,
  "expires_at": null,
  "livemode": false,
  "name": "my-api-key",
  "scope": {
    "type": "account"
  }
}

The Secret object

Attributes

idstring

objectstring

createdtimestamp

deletednullable boolean

expires_atnullable timestamp

livemodeboolean

namestring

payloadnullable stringExpandable

scopeobject

List secrets

Parameters

scopeobjectRequired

More parametersExpand all

ending_beforestring

limitinteger

starting_afterstring

Returns

Delete a Secret

Parameters

namestringRequired

scopeobjectRequired

Returns

Find a Secret

Parameters

namestringRequired

scopeobjectRequired

Returns

Set a Secret

Parameters

namestringRequired

payloadstringRequired

scopeobjectRequired

expires_attimestamp

Returns

More parameters