Stripe.Params.Apps.SecretCreateParams (tiger_stripe v0.3.0)

Copy Markdown View Source

Parameters for secret create.

Summary

Types

scope()
t()

Types

scope()

@type scope() :: %{
  optional(:type) => String.t() | nil,
  optional(:user) => String.t() | nil,
  optional(String.t()) => term()
}
  • type - The secret scope type. Possible values: account, user.
  • user - The user ID. This field is required if type is set to user, and should not be provided if type is set to account. Max length: 5000.

t()

@type t() :: %Stripe.Params.Apps.SecretCreateParams{
  expand: [String.t()] | nil,
  expires_at: integer() | nil,
  name: String.t(),
  payload: String.t(),
  scope: scope()
}
  • expand - Specifies which fields in the response should be expanded.
  • expires_at - The Unix timestamp for the expiry time of the secret, after which the secret deletes. Format: Unix timestamp.
  • name - A name for the secret that's unique within the scope. Max length: 5000.
  • payload - The plaintext secret value to be stored. Max length: 5000.
  • scope - Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.