Delete a Secret | Swagger Petstore

3 body fields

expandarray<string>optional

Specifies which fields in the response should be expanded.

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.

2 status codes

200Successful response.

createdintegerrequired

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

deletedbooleanoptional

If true, indicates that this secret has been deleted

expires_atintegeroptional

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

idstringrequired

Unique identifier for the object.

livemodebooleanrequired

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

namestringrequired

A name for the secret that's unique within the scope.

objectstringrequired

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

Allowed:apps.secret

payloadstringoptional

The plaintext secret value to be stored.

scopeobjectrequired

defaultError response.

errorobjectrequired

Error handling

Any other status is an error: Error response.

import { Stripe } from "swagger-petstore---openapi-3-0-sdk";

const client = new Stripe({
  baseUrl: "https://api.stripe.com/",
  auth: { basicAuth: { username: process.env.STRIPE_USERNAME!, password: process.env.STRIPE_PASSWORD! } },
});

const result = await client.apps.postSecretsDelete({
  name: "Untitled",
  scope: { type: "account" },
});

{
  "created": 1,
  "deleted": true,
  "expires_at": 1,
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "livemode": true,
  "name": "Jane Doe",
  "object": "apps.secret",
  "payload": "example_value",
  "scope": {
    "type": "account",
    "user": "example_value"
  }
}

Request

Response

Errors