Package com.stripe.param

Class WebhookEndpointCreateParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.WebhookEndpointCreateParams

public class WebhookEndpointCreateParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	WebhookEndpointCreateParams.ApiVersion
static class	WebhookEndpointCreateParams.Builder
static enum	WebhookEndpointCreateParams.EnabledEvent

Nested classes/interfaces inherited from class com.stripe.net.ApiRequestParams

ApiRequestParams.EnumParam

Field Summary

Fields inherited from class com.stripe.net.ApiRequestParams

EXTRA_PARAMS_KEY

Method Summary

Modifier and Type	Method	Description
static WebhookEndpointCreateParams.Builder	builder()
WebhookEndpointCreateParams.ApiVersion	getApiVersion()	Events sent to this endpoint will be generated with this Stripe Version instead of your account's default Stripe Version.
Boolean	getConnect()	Whether this endpoint should receive events from connected accounts (true), or from your account (false).
Object	getDescription()	An optional description of what the webhook is used for.
List<WebhookEndpointCreateParams.EnabledEvent>	getEnabledEvents()	Required. The list of events to enable for this endpoint.
List<String>	getExpand()	Specifies which fields in the response should be expanded.
Map<String,Object>	getExtraParams()	Map of extra parameters for custom features not available in this client library.
Object	getMetadata()	Set of key-value pairs that you can attach to an object.
String	getUrl()	Required. The URL of the webhook endpoint.

Methods inherited from class com.stripe.net.ApiRequestParams

paramsToMap, toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static WebhookEndpointCreateParams.Builder builder()

getApiVersion

public WebhookEndpointCreateParams.ApiVersion getApiVersion()

Events sent to this endpoint will be generated with this Stripe Version instead of your account's default Stripe Version.

getConnect

public Boolean getConnect()

Whether this endpoint should receive events from connected accounts (true), or from your account (false). Defaults to false.

getDescription

public Object getDescription()

An optional description of what the webhook is used for.

getEnabledEvents

public List<WebhookEndpointCreateParams.EnabledEvent> getEnabledEvents()

Required. The list of events to enable for this endpoint. You may specify ['*'] to enable all events, except those that require explicit selection.

getExpand

public List<String> getExpand()

Specifies which fields in the response should be expanded.

getExtraParams

public Map<String,Object> getExtraParams()

Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's @SerializedName value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.

getMetadata

public Object getMetadata()

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.

getUrl

public String getUrl()

Required. The URL of the webhook endpoint.