Package com.stripe.service

Class WebhookEndpointService

java.lang.Object

com.stripe.net.ApiService

com.stripe.service.WebhookEndpointService

public final class WebhookEndpointService
extends ApiService

Constructor Summary

Constructors

Constructor	Description
WebhookEndpointService(StripeResponseGetter responseGetter)

Method Summary

Modifier and Type	Method	Description
WebhookEndpoint	create(WebhookEndpointCreateParams params)	A webhook endpoint must have a url and a list of enabled_events.
WebhookEndpoint	create(WebhookEndpointCreateParams params, RequestOptions options)	A webhook endpoint must have a url and a list of enabled_events.
WebhookEndpoint	delete(String webhookEndpoint)	You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.
WebhookEndpoint	delete(String webhookEndpoint, RequestOptions options)	You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.
StripeCollection<WebhookEndpoint>	list()	Returns a list of your webhook endpoints.
StripeCollection<WebhookEndpoint>	list(RequestOptions options)	Returns a list of your webhook endpoints.
StripeCollection<WebhookEndpoint>	list(WebhookEndpointListParams params)	Returns a list of your webhook endpoints.
StripeCollection<WebhookEndpoint>	list(WebhookEndpointListParams params, RequestOptions options)	Returns a list of your webhook endpoints.
WebhookEndpoint	retrieve(String webhookEndpoint)	Retrieves the webhook endpoint with the given ID.
WebhookEndpoint	retrieve(String webhookEndpoint, RequestOptions options)	Retrieves the webhook endpoint with the given ID.
WebhookEndpoint	retrieve(String webhookEndpoint, WebhookEndpointRetrieveParams params)	Retrieves the webhook endpoint with the given ID.
WebhookEndpoint	retrieve(String webhookEndpoint, WebhookEndpointRetrieveParams params, RequestOptions options)	Retrieves the webhook endpoint with the given ID.
WebhookEndpoint	update(String webhookEndpoint)	Updates the webhook endpoint.
WebhookEndpoint	update(String webhookEndpoint, RequestOptions options)	Updates the webhook endpoint.
WebhookEndpoint	update(String webhookEndpoint, WebhookEndpointUpdateParams params)	Updates the webhook endpoint.
WebhookEndpoint	update(String webhookEndpoint, WebhookEndpointUpdateParams params, RequestOptions options)	Updates the webhook endpoint.

Methods inherited from class com.stripe.net.ApiService

getResponseGetter, request, requestStream

Methods inherited from class java.lang.Object

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

Constructor Details

WebhookEndpointService

public WebhookEndpointService(StripeResponseGetter responseGetter)

Method Details

delete

public WebhookEndpoint delete(String webhookEndpoint)
                       throws StripeException

You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.

Throws:

StripeException

delete

public WebhookEndpoint delete(String webhookEndpoint,
 RequestOptions options)
                       throws StripeException

You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.

Throws:

StripeException

retrieve

public WebhookEndpoint retrieve(String webhookEndpoint,
 WebhookEndpointRetrieveParams params)
                         throws StripeException

Retrieves the webhook endpoint with the given ID.

Throws:

StripeException

retrieve

public WebhookEndpoint retrieve(String webhookEndpoint,
 RequestOptions options)
                         throws StripeException

Retrieves the webhook endpoint with the given ID.

Throws:

StripeException

retrieve

public WebhookEndpoint retrieve(String webhookEndpoint)
                         throws StripeException

Retrieves the webhook endpoint with the given ID.

Throws:

StripeException

retrieve

public WebhookEndpoint retrieve(String webhookEndpoint,
 WebhookEndpointRetrieveParams params,
 RequestOptions options)
                         throws StripeException

Retrieves the webhook endpoint with the given ID.

Throws:

StripeException

update

public WebhookEndpoint update(String webhookEndpoint,
 WebhookEndpointUpdateParams params)
                       throws StripeException

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

Throws:

StripeException

update

public WebhookEndpoint update(String webhookEndpoint,
 RequestOptions options)
                       throws StripeException

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

Throws:

StripeException

update

public WebhookEndpoint update(String webhookEndpoint)
                       throws StripeException

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

Throws:

StripeException

update

public WebhookEndpoint update(String webhookEndpoint,
 WebhookEndpointUpdateParams params,
 RequestOptions options)
                       throws StripeException

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

Throws:

StripeException

list

public StripeCollection<WebhookEndpoint> list(WebhookEndpointListParams params)
                                       throws StripeException

Returns a list of your webhook endpoints.

Throws:

StripeException

list

public StripeCollection<WebhookEndpoint> list(RequestOptions options)
                                       throws StripeException

Returns a list of your webhook endpoints.

Throws:

StripeException

list

public StripeCollection<WebhookEndpoint> list()
                                       throws StripeException

Returns a list of your webhook endpoints.

Throws:

StripeException

list

public StripeCollection<WebhookEndpoint> list(WebhookEndpointListParams params,
 RequestOptions options)
                                       throws StripeException

Returns a list of your webhook endpoints.

Throws:

StripeException

create

public WebhookEndpoint create(WebhookEndpointCreateParams params)
                       throws StripeException

A webhook endpoint must have a url and a list of enabled_events. You may optionally specify the Boolean connect parameter. If set to true, then a Connect webhook endpoint that notifies the specified url about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specified url only about events from your account is created. You can also create webhook endpoints in the webhooks settings section of the Dashboard.

Throws:

StripeException

create

public WebhookEndpoint create(WebhookEndpointCreateParams params,
 RequestOptions options)
                       throws StripeException

A webhook endpoint must have a url and a list of enabled_events. You may optionally specify the Boolean connect parameter. If set to true, then a Connect webhook endpoint that notifies the specified url about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specified url only about events from your account is created. You can also create webhook endpoints in the webhooks settings section of the Dashboard.

Throws:

StripeException