Stripe.Params.Forwarding.RequestCreateParams (tiger_stripe v0.3.0)

Parameters for request create.

Summary

Types

request()

t()

Types

request()

@type request() :: %{
  optional(:body) => String.t() | nil,
  optional(:headers) => [request_headers()] | nil,
  optional(String.t()) => term()
}

body - The body payload to send to the destination endpoint. Max length: 5000.
headers - The headers to include in the forwarded request. Can be omitted if no additional headers (excluding Stripe-generated ones such as the Content-Type header) should be included.

request_headers()

@type request_headers() :: %{
  optional(:name) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}

name - The header name. Max length: 5000.
value - The header value. Max length: 5000.

t()

@type t() :: %Stripe.Params.Forwarding.RequestCreateParams{
  expand: [String.t()] | nil,
  metadata: %{required(String.t()) => String.t()} | nil,
  payment_method: String.t(),
  replacements: [String.t()],
  request: request() | nil,
  url: String.t()
}

expand - Specifies which fields in the response should be expanded.
metadata - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
payment_method - The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed. Max length: 5000.
replacements - The field kinds to be replaced in the forwarded request.
request - The request body and headers to be sent to the destination endpoint.
url - The destination URL for the forwarded request. Must be supported by the config. Max length: 5000.