Set a Secret

POST /v1/apps/secrets

Copy endpoint

https://api.stripe.com/

Request Body

application/x-www-form-urlencoded required

{
expand?: string[];
expires_at?: number;
name: string;
payload: string;
scope: { type: "account" | "user";user?: string; };
}

Responses

200 application/json

Successful response.

interface AppsSecret {
created: number;
deleted?: boolean;
expires_at?: number | null;
id: string;
livemode: boolean;
name: string;
object: "apps.secret";
payload?: string | null;
scope:

SecretServiceResourceScope

interface SecretServiceResourceScope {
type: "account" | "user";
user?: string;
}

;
}

default application/json

Error response.

interface Error {
error:

ApiErrors

interface ApiErrors {
advice_code?: string;
charge?: string;
code?: string;
decline_code?: string;
doc_url?: string;
message?: string;
network_advice_code?: string;
network_decline_code?: string;
param?: string;
payment_intent?: PaymentIntent;
payment_method?: PaymentMethod;
payment_method_type?: string;
request_log_url?: string;
setup_intent?: SetupIntent;
source?: BankAccount | Card | Source;
type: "api_error" | "card_error" | "idempotency_error" | "invalid_request_error";
}

;
}