All Connectors

Stripe Connector Module Connector Reference

Support Category: Select

Anypoint Connector for Stripe (Stripe Connector) gives you access to the Stripe platform. This connector exposes the most commonly used operations provided by the Stripe API.

Configurations

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

Api Key Connection Provider

The connection types to provide to this configuration.

x

Response Timeout

Number

The timeout for request to the remote service.

1

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

MINUTES

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

AUTO

Name

String

The identifier of this element used to reference it in other components

x

Expiration Policy

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. The instance is not necessarily expired at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

Connection Types

API Key Connection Provider

Name Type Description Default Value Required

Default Headers

Array of Default Header

Query Parameters

Array of Default Query Param

Connection Timeout

Number

The timeout for establishing connections to the remote service

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Connection Timeout.

SECONDS

Use Persistent Connections

Boolean

If false, each connection is closed after the first request is completed.

true

Max Connections

Number

Maximum number of concurrent outbound connections to keep open.

-1

Connection Idle Timeout

Number

Timeout for how long a connection can remain idle before it is closed.

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the connection Idle Timeout

SECONDS

Proxy Config

Proxy

Reusable configuration element for outbound connections through a proxy.

Stream Response

Boolean

Whether to stream received responses.

false

Response Buffer Size

Number

The space in bytes for the buffer where the HTTP response will be stored.

-1

Base Uri

String

Parameter base URI, each instance or tenant gets its own

https://api.stripe.com

Authorization

String

Authorization

TLS Configuration

Tls

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Sources

On Canceled Subscription Listener

<stripe:on-canceled-subscription-listener>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Canceled at

Number

Lower bound timestamp value for new objects. If no value is provided, the field is set to now().

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

Primary Node Only

Boolean

Whether this source should be executed only on the primary node when running in a cluster.

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Redelivery Policy

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

On New Charge Listener

<stripe:on-new-charge-listener>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Created

Number

Lower bound timestamp value for new objects. If no value is provided, the field is set to now().

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in a cluster.

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Redelivery Policy

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

On New Coupon Listener

<stripe:on-new-coupon-listener>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Created

Number

Lower bound timestamp value for new objects. If no value is provided, the field is set to now().

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in a cluster.

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Redelivery Policy

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

On New Customer Listener

<stripe:on-new-customer-listener>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Created

Number

Lower bound timestamp value for new objects. If no value is provided, the field is set to now().

Email

String

A case-sensitive filter on the list based on the customer’s email field. The value must be a string.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in a cluster.

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Redelivery Policy

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

On New Event Listener

<stripe:on-new-event-listener>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Created

Number

Lower bound timestamp value for new objects. If no value is provided, the field is set to now().

Type

String

A string containing a specific event name

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in a cluster

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Redelivery Policy

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

On New Invoice Listener

<stripe:on-new-invoice-listener>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Created

Number

Lower bound timestamp value for new objects. If no value is provided, the field is set to now().

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in a cluster

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Redelivery Policy

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

On New Order Listener

<stripe:on-new-order-listener>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Created

Number

Lower bound timestamp value for new objects. If no value is provided, the field is set to now().

Customer

String

Only return orders for the given customer.

Status

String

Only return orders that have the specified status: created, paid, fulfilled, or refunded

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in a cluster.

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Redelivery Policy

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

On New Refund Listener

<stripe:on-new-refund-listener>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Created

Number

Lower bound timestamp value for new objects. If no value is provided, the field is set to now().

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in a cluster.

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Redelivery Policy

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Operations

Initiate 3D Secure Auth

<stripe:create-v13d-secure>

Initiate 3D Secure authentication. This operation makes an HTTP POST request to the /v1/3d_secure endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Initiate3d Secure Auth Content

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

Timeout for requests to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Update Account

<stripe:create-v1-account>

Updates a connected Express or Custom account by setting the values of the parameters passed. Parameters that are not provided are left unchanged. Most parameters can be changed only for Custom accounts, and these parameters are identified as Custom Only. Parameters that are identified as Custom and Express are supported by both account types.

This operation makes an HTTP POST request to the /v1/account endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Update Account Content

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create Bank Account

<stripe:create-v1-account-bank-accounts>

Creates an external account for a specified account. This operation makes an HTTP POST request to the /v1/account/bank_accounts endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Bank Account Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Update Bank Account

<stripe:create-v1-account-bank-accounts-by-id>

Updates the metadata, account holder name, and account holder type of a bank account that belongs to a Custom account, and optionally sets it as the default for its currency. You cannot edit other bank account details. To re-enable a disabled bank account, perform an update call without providing any arguments or changes. This operation makes an HTTP POST request to the /v1/account/bank_accounts/{id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

ID

String

ID

x

Update Bank Account Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Update Account Capability

<stripe:create-v1-account-capabilities-by-capability>

Performs an update on an existing Account Capability. This operation makes an HTTP POST request to the /v1/account/capabilities/{capability} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

capability

String

capability

x

Update Account Capability Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create External Account

<stripe:create-v1-account-external-accounts>

Creates an external account for a specified account. This operation makes an HTTP POST request to the /v1/account/external_accounts endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create External Account Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Update External Account

<stripe:create-v1-account-external-accounts-by-id>

Updates the metadata, account holder name, and account holder type of a bank account that belongs to a Custom account, and optionally sets it as the default for its currency. You cannot edit other bank account details. To re-enable a disabled bank account, perform an update call without providing any arguments or changes.

This operation makes an HTTP POST request to the /v1/account/external_accounts/{id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

ID

String

ID

x

Update External Account Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

<stripe:create-v1-account-links>

Creates an AccountLink object that returns a single-use Stripe URL. The user can then redirect their user to that single-use URL for Connect Onboarding. This operation makes an HTTP POST request to the /v1/account_links endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Account Link Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

<stripe:create-v1-account-login-links>

Creates a single-use login link that an Express account can use to access their Stripe dashboard. You can only create login links for Express accounts that are connected to your platform. This operation makes an HTTP POST request to the /v1/account/login_links endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Login Ling Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create People

<stripe:create-v1-account-people>

Creates a new person. This operation makes an HTTP POST request to the /v1/account/people endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create People Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Update People

<stripe:create-v1-account-people-by-person>

Updates an existing person. This operation makes an HTTP POST request to the /v1/account/people/{person} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

person

String

person

x

Update People Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create Person

<stripe:create-v1-account-persons>

Creates a new person. This operation makes an HTTP POST request to the /v1/account/persons endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Person Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Update Person

<stripe:create-v1-account-persons-by-person>

Updates an existing person. This operation makes an HTTP POST request to the /v1/account/persons/{person} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

person

String

person

x

Update Person Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create an account

<stripe:create-v1-accounts>

Use Connect to create Stripe accounts for your users. To do this, you must first register your platform. For Standard accounts, parameters other than country, email, and type are used to prefill the account application that the account holder must complete.

This operation makes an HTTP POST request to the /v1/accounts endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Account Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create Bank Account For Account

<stripe:create-v1-accounts-bank-accounts-by-account>

Creates an external account for a specified account. This operation makes an HTTP POST request to the /v1/accounts/{account}/bank_accounts endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

account

String

account

x

Create Ban Account For Account Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Update Bank Account For Account

<stripe:create-v1-accounts-bank-accounts-by-account-id>

Updates the metadata, account holder name, and account holder type of a bank account that belongs to a Custom account, and optionally sets it as the default for its currency. You cannot edit other bank account details. To re-enable a disabled bank account, perform an update call without providing any arguments or changes.

This operation makes an HTTP POST request to the /v1/accounts/{account}/bank_accounts/{id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

account

String

account

x

ID

String

ID

x

Update Bank Account For Account Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Update an account

<stripe:create-v1-accounts-by-account>

Updates a connected Express or Custom account by setting the values of the parameters passed. Parameters that are not provided are left unchanged. Most parameters can be changed for Custom accounts only, which are identified as Custom Only. Parameters that are identified as Custom and Express are supported by both account types.

This operation makes an HTTP POST request to the /v1/accounts/{account} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

account

String

account

x

Update Account Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Update an Account Capability

<stripe:create-v1-accounts-capabilities-by-account-capability>

Updates an existing Account Capability. This operation makes an HTTP POST request to the /v1/accounts/{account}/capabilities/{capability} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

account

String

account

x

capability

String

capability

x

Update Account Capability For Account Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create External Account For Account

<stripe:create-v1-accounts-external-accounts-by-account>

Creates an external account for a specified account. This operation makes an HTTP POST request to the /v1/accounts/{account}/external_accounts endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

account

String

account

x

Create External Account For Account Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Update External Account For Account

<stripe:create-v1-accounts-external-accounts-by-account-id>

Updates the metadata, account holder name, and account holder type of a bank account that belongs to a Custom account, and optionally sets it as the default for its currency. You cannot edit other bank account details. To re-enable a disabled bank account, perform an update call without providing any arguments or changes. This operation makes an HTTP POST request to the /v1/accounts/{account}/external_accounts/{id} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

account

String

account

x

ID

String

ID

x

Update External Account For Account Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create Login Link For Account

<stripe:create-v1-accounts-login-links-by-account>

Creates a single-use login link that enables an Express account to access their Stripe dashboard. You can only create login links for Express accounts thar are connected to your platform. This operation makes an HTTP POST request to the /v1/accounts/{account}/login_links endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

account

String

account

x

Create Login Link For Account Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create People For Account

<stripe:create-v1-accounts-people-by-account>

Creates a new person. This operation makes an HTTP POST request to the /v1/accounts/{account}/people endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

account

String

account

x

Create People For Account Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Update People For Account

<stripe:create-v1-accounts-people-by-account-person>

Updates an existing person. This operation makes an HTTP POST request to the /v1/accounts/{account}/people/{person} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

account

String

account

x

person

String

person

x

Update People For Account Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create Person For Account

<stripe:create-v1-accounts-persons-by-account>

Creates a new person. This operation makes an HTTP POST request to the /v1/accounts/{account}/persons endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

account

String

account

x

Create Person For Account Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Update Person For Account

<stripe:create-v1-accounts-persons-by-account-person>

Updates an existing person. This operation makes an HTTP POST request to the /v1/accounts/{account}/persons/{person} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

account

String

account

x

person

String

person

x

Update Person For Account Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Reject Account

<stripe:create-v1-accounts-reject-by-account>

Use Connect to flag suspicious accounts. Test-mode, Custom, and Express accounts can be rejected at any time. Accounts created using live-mode keys can be rejected only after all balances are zero. This operation makes an HTTP POST request to the /v1/accounts/{account}/reject endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

account

String

account

x

Reject Account Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create Apple Pay Domain

<stripe:create-v1-apple-pay-domains>

Create an Apple pay domain. This operation makes an HTTP POST request to the /v1/apple_pay/domains endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Apple Pay Domain Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create Refund For Application Fee

<stripe:create-v1-application-fees-refund-by-id>

Creates a refund for the specified application fee. This operation makes an HTTP POST request to the /v1/application_fees/{id}/refund endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

ID

String

ID

x

Create Refund For Application Fee Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Update Refund For Application Fee

<stripe:create-v1-application-fees-refunds-by-fee-id>

Sets the values of the parameters passed to update the specified application fee. Any parameters not provided are left unchanged. This request accepts only metadata as an argument. This operation makes an HTTP POST request to the /v1/application_fees/{fee}/refunds/{id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

fee

String

fee

x

ID

String

ID

x

Update Refund For Application Fee Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Refund Application Fee

<stripe:create-v1-application-fees-refunds-by-id>

Refunds an application fee that was collected but not yet refunded. Funds are refunded to the Stripe account from which the fee was originally collected. You can optionally specify a partial refund multiple times until the entire application fee is refunded. After the entire application fee is refunded, it can’t be refunded again. This method raises an error when it is called on an already-refunded application fee, or when trying to refund more money than is left on an application fee. This operation makes an HTTP POST request to the /v1/application_fees/{id}/refunds endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

ID

String

ID

x

Refund Application Fee Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create Session For Self Serve Portal

<stripe:create-v1-billing-portal-sessions>

Creates a session of the self-serve Portal. This operation makes an HTTP POST request to the /v1/billing_portal/sessions endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Session For Self Serve Portal Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create Charge

<stripe:create-v1-charges>

Create a Charge object to charge a credit card or other payment source. If your API key is in test mode, the supplied payment source (for example, the card) is not actually charged, although everything else occurs as if in live mode. (Stripe assumes that the charge will complete successfully). This operation makes an HTTP POST request to the /v1/charges endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Charge Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Update a charge

<stripe:create-v1-charges-by-charge>

Updates the specified charge by setting the values of the parameters passed. Any parameters not provided are left unchanged. This operation makes an HTTP POST request to the /v1/charges/{charge} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

charge

String

charge

x

Update Charge Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create Charge Capture

<stripe:create-v1-charges-capture-by-charge>

The second half of the two-step payment flow that captures the payment of an existing, uncaptured, charge. The first step was to create a charge with the capture option set to false. Uncaptured payments expire exactly seven days after they are created. If they are not captured by that point in time, they are not marked as refunded and are no longer capturable. This operation makes an HTTP POST request to the /v1/charges/{charge}/capture endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

charge

String

charge

x

Create Charge Capture Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create Charge Dispute

<stripe:create-v1-charges-dispute-by-charge>

Creates a dispute for a specified charge. This operation makes an HTTP POST request to the /v1/charges/{charge}/dispute endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

charge

String

charge

x

Create Charge Dispute Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Close Charge Dispute

<stripe:create-v1-charges-dispute-close-by-charge>

Closes the dispute for a specified charge. This operation makes an HTTP POST request to the /v1/charges/{charge}/dispute/close endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

charge

String

charge

x

Close Charge Dispute Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create Charge Refund

<stripe:create-v1-charges-refund-by-charge>

Creates a new refund on the specified Charge or a PaymentIntent object. Creating a new refund refunds a charge that was previously created, but not yet refunded, to the credit or debit card that was originally charged. You can optionally partially refund a charge multiple times, until the entire charge is refunded. After the charge is fully refunded, it can’t be refunded again.

This method raises an error when called on an already-refunded charge, or when trying to refund more money than what remains on a charge.

This operation makes an HTTP POST request to the /v1/charges/{charge}/refund endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

charge

String

charge

x

Create Charge Refund Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create Refund For Charge

<stripe:create-v1-charges-refunds-by-charge>

Creates a refund. This operation makes an HTTP POST request to the /v1/charges/{charge}/refunds endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

charge

String

charge

x

Create Refund For Charge Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Update Refund For Charge

<stripe:create-v1-charges-refunds-by-charge-refund>

Updates a specified refund. This operation makes an HTTP POST request to the /v1/charges/{charge}/refunds/{refund} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

charge

String

charge

x

refund

String

refund

x

Update Refund For Charge Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create a Session

<stripe:create-v1-checkout-sessions>

Creates a Session object. This operation makes an HTTP POST request to the /v1/checkout/sessions endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Session Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create a coupon

<stripe:create-v1-coupons>

Creates a coupon. A coupon specifies either a percent_off or an amount_off, and the currency. If you set an amount_off, that amount is subtracted from any invoice’s subtotal. For example, an invoice with a subtotal of 100 will have a final total of 0 if a coupon with an amount_off of 200 is applied to it, and an invoice with a subtotal of 300 will have a final total of 100 if a coupon with an amount_off of 200 is applied to it. This operation makes an HTTP POST request to the /v1/coupons endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Coupon Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Update a coupon

<stripe:create-v1-coupons-by-coupon>

Updates the metadata of a coupon. You cannot edit other coupon details, such as currency, duration, and amount_off. This operation makes an HTTP POST request to the /v1/coupons/{coupon} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

coupon

String

coupon

x

Update Coupon Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create Credit Note

<stripe:create-v1-credit-notes>

Issues a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result in any combination of the following:

  • Refund: Creates a new refund using refund_amount, or links an existing refund using refund.

  • Customer balance credit: Credits the customer’s balance using credit_amount, which is automatically applied to the customer’s invoice when it’s finalized.

  • Outside of Stripe credit: Records the amount that is, or will be, credited outside of Stripe using out_of_band_amount.

For post-payment credit notes the sum of the refund, credit, and outside of Stripe amounts must equal the credit note total. You can issue multiple credit notes for an invoice. Each credit note increments the invoice’s pre_payment_credit_notes_amount or post_payment_credit_notes_amount, depending on its status at the time of credit note creation.

This operation makes an HTTP POST request to the /v1/credit_notes endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Credit Note Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Update Credit Note

<stripe:create-v1-credit-notes-by-id>

Updates an existing credit note. This operation makes an HTTP POST request to the /v1/credit_notes/{id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

ID

String

ID

x

Update Credit Note Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Mark Credit Note As Void

<stripe:create-v1-credit-notes-void-by-id>

Marks a credit note as void. This operation makes an HTTP POST request to the /v1/credit_notes/{id}/void endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

ID

String

ID

x

Mark Credit Note As Void Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create a customer

<stripe:create-v1-customers>

Creates a new customer object. This operation makes an HTTP POST request to the /v1/customers endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Customer Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create Balance Transaction For Customer

<stripe:create-v1-customers-balance-transactions-by-customer>

Creates an immutable transaction that updates the customer’s balance. This operation makes an HTTP POST request to the /v1/customers/{customer}/balance_transactions endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

customer

String

customer

x

Create Balance Transaction For Customer Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Update Balance Transaction For Customer

<stripe:create-v1-customers-balance-transactions-by-customer-transaction>

Most customer balance transaction fields are immutable, but you can update the description and metadata. This operation makes an HTTP POST request to the /v1/customers/{customer}/balance_transactions/{transaction} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

customer

String

customer

x

transaction

String

transaction

x

Update Balance Transaction For Customer Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create bank account for customer

<stripe:create-v1-customers-bank-accounts-by-customer>

Creates a new credit card on the specified customer or recipient. If the customer has no default card, then the new card becomes the default. If the customer already has a default card, then there is no change. To change the default, update the customer to have a new default_source. This operation makes an HTTP POST request to the /v1/customers/{customer}/bank_accounts endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

customer

String

customer

x

Create Bank Account For Customer Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Update bank account for customer

<stripe:create-v1-customers-bank-accounts-by-customer-id>

Update a specified bank account for a specified customer. This operation makes an HTTP POST request to the /v1/customers/{customer}/bank_accounts/{id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

customer

String

customer

x

ID

String

ID

x

Update Bank Account For Customer Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Verify bank account for customer

<stripe:create-v1-customers-bank-accounts-verify-by-customer-id>

Verifies a specified bank account for a given customer. This operation makes an HTTP POST request to the /v1/customers/{customer}/bank_accounts/{id}/verify endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

customer

String

customer

x

ID

String

ID

x

Verify Bank Account For Customer Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Update Customer

<stripe:create-v1-customers-by-customer>

Updates the specified customer by setting the values of the parameters passed. For example, if you pass the source parameter, then that becomes the customer’s active source (for example, a card) to use for all charges in the future. Parameters that are not provided are left unchanged. When you update a customer to a new valid card source by passing the source parameter, for each of the customer’s current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled is retried. This retry does not count as an automatic retry, and does not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer does not trigger this behavior. This request accepts mostly the same arguments as the customer creation call. This operation makes an HTTP POST request to the /v1/customers/{customer} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

customer

String

customer

x

Update Customer Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create a card for a customer

<stripe:create-v1-customers-cards-by-customer>

Creates a new credit card on the specified customer or recipient. If the customer has no default card, then the new card becomes the default. If the owner already has a default, then it does not change. To change the default, update the customer to have a new default_source. This operation makes an HTTP POST request to the /v1/customers/{customer}/cards endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

customer

String

customer

x

Create Card For Customer Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Update a card for customer

<stripe:create-v1-customers-cards-by-customer-id>

Updates a specified source for a given customer. This operation makes an HTTP POST request to the /v1/customers/{customer}/cards/{id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

customer

String

customer

x

ID

String

ID

x

Update Card For Customer Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create a source for customer

<stripe:create-v1-customers-sources-by-customer>

Creates a new credit card on the specified customer or recipient. If the customer has no default card, then the new card becomes the default. If the customer already has a default card, then it does not change. To change the default, update the customer to have a new default_source. This operation makes an HTTP POST request to the /v1/customers/{customer}/sources endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

customer

String

customer

x

Create Source For Customer Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Update a source for customer

<stripe:create-v1-customers-sources-by-customer-id>

Updates a specified source for a given customer. This operation makes an HTTP POST request to the /v1/customers/{customer}/sources/{id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

customer

String

customer

x

ID

String

ID

x

Update Source For Customer Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Verify a bank account

<stripe:create-v1-customers-sources-verify-by-customer-id>

Verifies a specified bank account for a given customer. This operation makes an HTTP POST request to the /v1/customers/{customer}/sources/{id}/verify endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

customer

String

customer

x

ID

String

ID

x

Verify Bank Account Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create subscription for customer

<stripe:create-v1-customers-subscriptions-by-customer>

Creates a new subscription on an existing customer. This operation makes an HTTP POST request to the /v1/customers/{customer}/subscriptions endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

customer

String

customer

x

Create Subscription For Customer Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Update a customer subscription

<stripe:create-v1-customers-subscriptions-by-customer-subscription-exposed-id>

Updates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, the price charged the following month is optionally prorated to make up for any price changes. To preview how the proration is calculated, use the upcoming invoice endpoint. This operation makes an HTTP POST request to the /v1/customers/{customer}/subscriptions/{subscription_exposed_id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

customer

String

customer

x

Subscription exposed ID

String

Subscription exposed ID

x

Update Customer Subscription Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create a tax ID

<stripe:create-v1-customers-tax-ids-by-customer>

Creates a new TaxID object for a customer. This operation makes an HTTP POST request to the /v1/customers/{customer}/tax_ids endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

customer

String

customer

x

Create Tax Id Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Update a dispute

<stripe:create-v1-disputes-by-dispute>

Submits evidence for a dispute programmatically. Strip recommends that you use the dashboard to respond to disputes. For more information, see the Stripe "Disputes and fraud" documentation. This operation makes an HTTP POST request to the /v1/disputes/{dispute} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

dispute

String

dispute

x

Update Dispute Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Close a dispute

<stripe:create-v1-disputes-close-by-dispute>

Closing the dispute for a charge indicates that you do not have any evidence to submit and are dismissing the dispute and acknowledging it as lost. The status of the dispute changes from needs_response to lost. Closing a dispute is irreversible. This operation makes an HTTP POST request to the /v1/disputes/{dispute}/close endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

dispute

String

dispute

x

Close Dispute Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create a ephemeral key

<stripe:create-v1-ephemeral-keys>

Creates a short-lived API key for a given resource. This operation makes an HTTP POST request to the /v1/ephemeral_keys endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Ephemeral Key Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

<stripe:create-v1-file-links>

Creates a new file link object. This operation makes an HTTP POST request to the /v1/file_links endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create File Link Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

<stripe:create-v1-file-links-by-link>

Updates an existing file link object. Expired links can’t be updated. This operation makes an HTTP POST request to the /v1/file_links/{link} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

link

String

link

x

Update File Link Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create a file

<stripe:create-v1-files>

To upload a file to Stripe, you must send a request of type multipart/form-data. The request must contain the file to upload, as well as the parameters for creating a file. All of Stripe’s officially supported client libraries have support for sending multipart/form-data. This operation makes an HTTP POST request to the /v1/files endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create File Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create an invoice item

<stripe:create-v1-invoiceitems>

Creates an item to add to a draft invoice. If no invoice is specified, the item will be added to the next invoice created for the specified customer. This operation makes an HTTP POST request to the /v1/invoiceitems endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Invoice Item Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Update an invoice item

<stripe:create-v1-invoiceitems-by-invoiceitem>

Updates the amount or description of an invoice item on an upcoming invoice. It is only possible to update an invoice item before the invoice it’s attached to is closed. This operation makes an HTTP POST request to the /v1/invoiceitems/{invoiceitem} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

invoiceitem

String

invoiceitem

x

Update An Invoice Item Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create an invoice

<stripe:create-v1-invoices>

Creates a draft invoice for a specified customer. The created draft invoice pulls in all pending invoice items for that customer, including prorations. This operation makes an HTTP POST request to the /v1/invoices endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Invoice Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Update an invoice

<stripe:create-v1-invoices-by-invoice>

Draft invoices are fully editable until it is finalized. To stop the Stripe billing engine from automatically finalizing, reattempting payments on, sending reminders for, or automatically reconciling invoices, pass auto_advance=false. This operation makes an HTTP POST request to the /v1/invoices/{invoice} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

invoice

String

invoice

x

Update Invoice Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Finalize an invoice

<stripe:create-v1-invoices-finalize-by-invoice>

Stripe automatically finalizes drafts before sending and attempting payment on invoices. If you want to finalize a draft invoice manually, you can do so using this method. This operation makes an HTTP POST request to the /v1/invoices/{invoice}/finalize endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

invoice

String

invoice

x

Finalize An Invoice Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Mark an Invoice as Uncollectible

<stripe:create-v1-invoices-mark-uncollectible-by-invoice>

Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes. This operation makes an HTTP POST request to the /v1/invoices/{invoice}/mark_uncollectible endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

invoice

String

invoice

x

Mark An Invoice As Uncollectible Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Pay an invoice

<stripe:create-v1-invoices-pay-by-invoice>

Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your subscriptions settings. You can also attempt payment on an invoice outside of the normal collection schedule or for some other reason. This operation makes an HTTP POST request to the /v1/invoices/{invoice}/pay endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

invoice

String

invoice

x

Pay Invoice Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Send an invoice for manual payment

<stripe:create-v1-invoices-send-by-invoice>

Stripe automatically sends invoices to customers according to your subscriptions settings. You can also manually send an invoice to your customers outside of the normal schedule. When sending invoices that are already paid, there will be no reference to the payment in the email. Requests made in test-mode send an invoice.sent event but do not send emails. This operation makes an HTTP POST request to the /v1/invoices/{invoice}/send endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

invoice

String

invoice

x

Send An Invoice For Manual Payment Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Void an invoice

<stripe:create-v1-invoices-void-by-invoice>

Marks a finalized invoice as void and can’t be undone. Voiding an invoice is similar to deletion, but it only applies to finalized invoices and maintains a paper trail so the invoice can still be found. This operation makes an HTTP POST request to the /v1/invoices/{invoice}/void endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

invoice

String

invoice

x

Void An Invoice Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Approve an authorization

<stripe:create-v1-issuing-authorizations-approve-by-authorization>

Approves a pending Issuing Authorization object. This request must be made within the timeout window of the real-time authorization flow. This operation makes an HTTP POST request to the /v1/issuing/authorizations/{authorization}/approve endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

authorization

String

authorization

x

Approve An Authorization Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Update an authorization

<stripe:create-v1-issuing-authorizations-by-authorization>

Updates the specified Issuing Authorization object by setting the values of the parameters passed. Any parameters not provided are left unchanged. This operation makes an HTTP POST request to the /v1/issuing/authorizations/{authorization} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

authorization

String

authorization

x

Update An Authorization Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Decline an authorization

<stripe:create-v1-issuing-authorizations-decline-by-authorization>

Declines a pending Issuing Authorization object. This request must be made within the timeout window of the real-time authorization flow. This operation makes an HTTP POST request to the /v1/issuing/authorizations/{authorization}/decline endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

authorization

String

authorization

x

Decline An Authorization Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create a cardholder

<stripe:create-v1-issuing-cardholders>

Creates a new Issuing Cardholder object that can issue cards. This operation makes an HTTP POST request to the /v1/issuing/cardholders endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Cardholder Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Update a cardholder

<stripe:create-v1-issuing-cardholders-by-cardholder>

Updates the specified Issuing Cardholder object by setting the values of the parameters passed. Any parameters not provided are left unchanged. This operation makes an HTTP POST request to the /v1/issuing/cardholders/{cardholder} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

cardholder

String

cardholder

x

Update Cardholder Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create a card

<stripe:create-v1-issuing-cards>

Creates an Issuing Card object. This operation makes an HTTP POST request to the /v1/issuing/cards endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Card Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Update a card

<stripe:create-v1-issuing-cards-by-card>

Updates the specified Issuing Card object by setting the values of the parameters passed. Any parameters not provided are left unchanged. This operation makes an HTTP POST request to the /v1/issuing/cards/{card} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

card

String

card

x

Update Card Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create a dispute

<stripe:create-v1-issuing-disputes>

Creates an Issuing Dispute object. This operation makes an HTTP POST request to the /v1/issuing/disputes endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Dispute Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Update an issuing dispute

<stripe:create-v1-issuing-disputes-by-dispute>

Updates the specified Issuing Dispute object by setting the values of the parameters passed. Any parameters not provided are left unchanged. This operation makes an HTTP POST request to the /v1/issuing/disputes/{dispute} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

dispute

String

dispute

x

Update An Issueing Dispute Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Update a settlement

<stripe:create-v1-issuing-settlements-by-settlement>

Updates the specified Issuing Settlement object by setting the values of the parameters passed. Any parameters not provided are left unchanged. This operation makes an HTTP POST request to the /v1/issuing/settlements/{settlement} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

settlement

String

settlement

x

Update Settlement Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Update a transaction

<stripe:create-v1-issuing-transactions-by-transaction>

Updates the specified Issuing Transaction object by setting the values of the parameters passed. Any parameters not provided are left unchanged. This operation makes an HTTP POST request to the /v1/issuing/transactions/{transaction} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

transaction

String

transaction

x

Update Transaction Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create an order

<stripe:create-v1-orders>

Creates a new order object. This operation makes an HTTP POST request to the /v1/orders endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create An Order Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Update an order

<stripe:create-v1-orders-by-id>

Updates the specific order by setting the values of the parameters passed. Any parameters not provided are left unchanged. This operation makes an HTTP POST request to the /v1/orders/{id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

ID

String

ID

x

Update An Order Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Pay an order

<stripe:create-v1-orders-pay-by-id>

Provide a source to create a payment to pay an order. This operation makes an HTTP POST request to the /v1/orders/{id}/pay endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

ID

String

ID

x

Pay An Order Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Return an order

<stripe:create-v1-orders-returns-by-id>

Return all or part of an order. The order must have a status of paid or fulfilled before it can be returned. After all items are returned, the order is canceled or returned, depending on the beginning status of the order. This operation makes an HTTP POST request to the /v1/orders/{id}/returns endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

ID

String

ID

x

Return An Order Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Create a PaymentIntent

<stripe:create-v1-payment-intents>

Creates a PaymentIntent object. After the PaymentIntent is created, attach a payment method and confirm to continue the payment. You can read more about the different payment flows available in Stripe’s API reference documentation. When confirm=true is used during creation, it is equivalent to creating and confirming the PaymentIntent in the same call. You can use any parameters available in the confirm API when confirm=true is supplied. This operation makes an HTTP POST request to the /v1/payment_intents endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Payment Intent Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Update a PaymentIntent

<stripe:create-v1-payment-intents-by-intent>

Updates properties on a PaymentIntent object without confirming. Depending on which properties you update, you may need to reconfirm the PaymentIntent. For example, updating the payment_method always requires you to reconfirm the PaymentIntent. If you prefer to update and confirm at the same time, it is best to update properties using the confirm API. This operation makes an HTTP POST request to the /v1/payment_intents/{intent} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

intent

String

intent

x

Update Payment Intent Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Cancel a PaymentIntent

<stripe:create-v1-payment-intents-cancel-by-intent>

A PaymentIntent object can be canceled when it is in one of these statuses: requires_payment_method requires_capture requires_confirmation requires_action After the PaymentIntent object is canceled, no additional charges will be made by the PaymentIntent and any operations on the PaymentIntent fail with an error. For PaymentIntent objects with status='requires_capture', the remaining amount_capturable is automatically refunded. This operation makes an HTTP POST request to the /v1/payment_intents/{intent}/cancel endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

intent

String

intent

x

Cancel Payment Intent Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Capture a PaymentIntent

<stripe:create-v1-payment-intents-capture-by-intent>

Capture the funds of an existing uncaptured PaymentIntent object when its status is requires_capture. Uncaptured PaymentIntent objects are canceled exactly seven days after they are created. See the Stripe documentation to learn more about separate authorization and capture. This operation makes an HTTP POST request to the /v1/payment_intents/{intent}/capture endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

intent

String

intent

x

Capture Payment Intent Content

application/x-www-form-urlencoded

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:RETRY_EXHAUSTED

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Confirm a PaymentIntent

<stripe:create-v1-payment-intents-confirm-by-intent>

Confirms that your customer intends to pay with the current or provided payment method. Upon confirmation, the PaymentIntent object attempts to initiate a payment. For more information, see Stripe’s API reference documentation for "Confirm a PaymentIntent". This operation makes an HTTP POST request to the /v1/payment_intents/{intent}/confirm endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String