Contact Us 1-800-596-4880
  1. Homepage
  2. Stripe Connector (1.0)

  3. Stripe Connector Reference

All Connectors

Stripe Connector Module Connector Reference

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

The name of the configuration to use.

x

intent

String

intent

x

Confirm 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

Create a PaymentMethod

<stripe:create-v1-payment-methods>

Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods using Stripe.js. This operation makes an HTTP POST request to the /v1/payment_methods endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Payment Method 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

Attach a PaymentMethod to a Customer

<stripe:create-v1-payment-methods-attach-by-payment-method>

Attaches a PaymentMethod object to a Customer. To attach a new PaymentMethod to a customer for future payments, it is best to use SetupIntent or a PaymentIntent with setup_future_usage. These approaches perform any necessary steps to ensure that the PaymentMethod can be used in a future payment. Using the /v1/payment_methods/:id/attach endpoint does not ensure that future payments can be made with the attached PaymentMethod. See the Stripe documentation for "Optimizing cards for future payments" for more information about setting up future payments. To use this PaymentMethod as the default for invoice or subscription payments, set invoice_settings.default_payment_method, on the Customer to the PaymentMethod’s ID. This operation makes an HTTP POST request to the /v1/payment_methods/{payment_method}/attach endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Payment method

String

Payment method

x

Attach Payment Method To 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 PaymentMethod

<stripe:create-v1-payment-methods-by-payment-method>

Updates a PaymentMethod object. A PaymentMethod must be attached a customer to be updated. This operation makes an HTTP POST request to the /v1/payment_methods/{payment_method} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Payment method

String

Payment method

x

Update Payment Method 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

Detach a PaymentMethod from a Customer

<stripe:create-v1-payment-methods-detach-by-payment-method>

Detaches a PaymentMethod object from a Customer. This operation makes an HTTP POST request to the /v1/payment_methods/{payment_method}/detach endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Payment method

String

Payment method

x

Detach Payment Method From 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 payout

<stripe:create-v1-payouts>

Create a new payout object to send funds to your own bank account. Your Stripe balance must be able to cover the payout amount, or you'™ll receive an Insufficient Funds error. If your API key is in test mode, money is not actually sent, but everything else occurs as if in live mode. If you are creating a manual payout on a Stripe account that uses multiple payment source types, you must specify the source type balance that the payout should draw from. The balance object details available and pending amounts by source type. This operation makes an HTTP POST request to the /v1/payouts endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Payout 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 payout

<stripe:create-v1-payouts-by-payout>

Updates the specified payout by setting the values of the parameters passed. Any parameters not provided are left unchanged. This request accepts only the metadata as arguments. This operation makes an HTTP POST request to the /v1/payouts/{payout} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

payout

String

payout

x

Update Payout 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 payout

<stripe:create-v1-payouts-cancel-by-payout>

Cancels a previously created payout if it has not yet been paid out. Funds are refunded to your available balance. You can’t cancel automatic Stripe payouts. This operation makes an HTTP POST request to the /v1/payouts/{payout}/cancel endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

payout

String

payout

x

Cancel Payout 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 plan

<stripe:create-v1-plans>

You can create plans using the API, or in the Stripe Dashboard. This operation makes an HTTP POST request to the /v1/plans endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Plan 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 plan

<stripe:create-v1-plans-by-plan>

Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan’s ID, amount, currency, or billing cycle. This operation makes an HTTP POST request to the /v1/plans/{plan} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

plan

String

plan

x

Update Plan 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 product

<stripe:create-v1-products>

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

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Product 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 product

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

Updates the specific product 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/products/{id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

ID

String

ID

x

Update Product 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 value list item

<stripe:create-v1-radar-value-list-items>

Creates a new ValueListItem object, which is added to the specified parent value list. This operation makes an HTTP POST request to the /v1/radar/value_list_items endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Value List 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 a value list

<stripe:create-v1-radar-value-lists>

Creates a new ValueList object, which can then be referenced in rules. This operation makes an HTTP POST request to the /v1/radar/value_lists endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Value List 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 value list

<stripe:create-v1-radar-value-lists-by-value-list>

Updates a ValueList object by setting the values of the parameters passed. Any parameters not provided are left unchanged. Note that item_type is immutable. This operation makes an HTTP POST request to the /v1/radar/value_lists/{value_list} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Value list

String

Value list

x

Update Value List 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 refund

<stripe:create-v1-refunds>

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

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create 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

Update a refund

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

Updates the specified refund by setting the values of the parameters passed. 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/refunds/{refund} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

refund

String

refund

x

Update 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 a Report Run

<stripe:create-v1-reporting-report-runs>

Creates a new object and begins running the report and requires a live-mode API key. This operation makes an HTTP POST request to the /v1/reporting/report_runs endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Report Run 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 a review

<stripe:create-v1-reviews-approve-by-review>

Approves and closes a Review object and removes it from the list of reviews. This operation makes an HTTP POST request to the /v1/reviews/{review}/approve endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

review

String

review

x

Approve Review 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 SetupIntent

<stripe:create-v1-setup-intents>

Creates a SetupIntent object. After the SetupIntent object is created, attach a payment method and confirm to collect any required permissions to charge the payment method later. This operation makes an HTTP POST request to the /v1/setup_intents endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Setup 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 SetupIntent

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

Updates a SetupIntent object. This operation makes an HTTP POST request to the /v1/setup_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 Setup 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 SetupIntent

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

A SetupIntent object can be canceled when it is in one of these statuses: requires_payment_method requires_capture requires_confirmation requires_action Once canceled, setup is abandoned and any operations on the SetupIntent fail with an error. This operation makes an HTTP POST request to the /v1/setup_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 Setup 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 SetupIntent

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

Confirms that your customer intends to set up the current or provided payment method. For example, you would confirm a SetupIntent when a customer presses the Save button on a payment method management page on your website. If the selected payment method does not require any additional steps from the customer, the SetupIntent transitions to the succeeded status. Otherwise, it transitions to the requires_action status and suggests additional actions via next_action. If setup fails, the SetupIntent transitions to the requires_payment_method status. This operation makes an HTTP POST request to the /v1/setup_intents/{intent}/confirm endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

intent

String

intent

x

Confirm Setup 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

Create a SKU

<stripe:create-v1-skus>

Creates a new SKU associated with a product. This operation makes an HTTP POST request to the /v1/skus endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Sku 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 SKU

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

Updates the specific SKU by setting the values of the parameters passed. Any parameters not provided are left unchanged. You cannot edit a SKU’s attributes. Instead, you must deactivate the existing SKU and create a new one with the new attribute values. This operation makes an HTTP POST request to the /v1/skus/{id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

ID

String

ID

x

Update Sku 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

<stripe:create-v1-sources>

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

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Source 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

<stripe:create-v1-sources-by-source>

Updates the specified source by setting the values of the parameters passed. Any parameters not provided are left unchanged. This request accepts the metadata and owner as arguments. It is also possible to update type specific information for selected payment methods. This operation makes an HTTP POST request to the /v1/sources/{source} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

source

String

source

x

Update Source 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 source

<stripe:create-v1-sources-verify-by-source>

Verifies a specified source. This operation makes an HTTP POST request to the /v1/sources/{source}/verify endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

source

String

source

x

Verify Source 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 subscription item

<stripe:create-v1-subscription-items>

Adds a new item to an existing subscription. No existing items are changed or replaced. This operation makes an HTTP POST request to the /v1/subscription_items endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Subscription 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 a subscription item

<stripe:create-v1-subscription-items-by-item>

Updates the plan or quantity of an item on a current subscription. This operation makes an HTTP POST request to the /v1/subscription_items/{item} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

item

String

item

x

Update Subscription 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 a usage record

<stripe:create-v1-subscription-items-usage-records-by-subscription-item>

Creates a usage record for a specified subscription item and date, and fills it with a quantity. Usage records provide quantity information that Stripe uses to track how much a customer is using your service. With usage information and the pricing model set up by the metered billing plan, Stripe helps you send accurate invoices to your customers. The default calculation for usage is to add up all the quantity values of the usage records within a billing period. You can change this default behavior with the billing plan’s aggregate_usage parameter. When there is more than one usage record with the same timestamp, Stripe adds the quantity values together. In most cases, this is the desired resolution, however, you can change this behavior with the action parameter. The default pricing model for metered billing is per-unit pricing. For finer granularity, you can configure metered billing to have a tiered pricing model. This operation makes an HTTP POST request to the /v1/subscription_items/{subscription_item}/usage_records endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Subscription item

String

Subscription item

x

Create Usage Record 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 schedule

<stripe:create-v1-subscription-schedules>

Creates a new subscription schedule object. Each customer can have up to 25 active or scheduled subscriptions. This operation makes an HTTP POST request to the /v1/subscription_schedules endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Schedule 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 schedule

<stripe:create-v1-subscription-schedules-by-schedule>

Updates an existing subscription schedule. This operation makes an HTTP POST request to the /v1/subscription_schedules/{schedule} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

schedule

String

schedule

x

Update Schedule 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 schedule

<stripe:create-v1-subscription-schedules-cancel-by-schedule>

Cancels a subscription schedule and its associated subscription immediately. A subscription schedule can only be canceled if its status is not_started or active. This operation makes an HTTP POST request to the /v1/subscription_schedules/{schedule}/cancel endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

schedule

String

schedule

x

Cancel Schedule 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

Release a schedule

<stripe:create-v1-subscription-schedules-release-by-schedule>

Releases the subscription schedule immediately, which stops scheduling of its phases, but leaves any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it removes its subscription property and sets the subscription’s ID to the released_subscription property. This operation makes an HTTP POST request to the /v1/subscription_schedules/{schedule}/release endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

schedule

String

schedule

x

Release Schedule 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 subscription

<stripe:create-v1-subscriptions>

Creates a new subscription on an existing customer. Each customer can have up to 25 active or scheduled subscriptions. This operation makes an HTTP POST request to the /v1/subscriptions endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create 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

Update a subscription

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

Updates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, prices can be optionally prorated the next month to reconcile 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/subscriptions/{subscription_exposed_id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Subscription exposed ID

String

Subscription exposed ID

x

Update 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 rate

<stripe:create-v1-tax-rates>

Creates a new tax rate. This operation makes an HTTP POST request to the /v1/tax_rates endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Tax Rate 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 tax rate

<stripe:create-v1-tax-rates-by-tax-rate>

Updates an existing tax rate. This operation makes an HTTP POST request to the /v1/tax_rates/{tax_rate} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Tax rate

String

Tax rate

x

Update Tax Rate 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 Connection Token

<stripe:create-v1-terminal-connection-tokens>

To connect to a reader, the Stripe Terminal SDK must retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token. This operation makes an HTTP POST request to the /v1/terminal/connection_tokens endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Connection Token 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 Location

<stripe:create-v1-terminal-locations>

Creates a new Location object. This operation makes an HTTP POST request to the /v1/terminal/locations endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Location 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 Location

<stripe:create-v1-terminal-locations-by-location>

Updates a Location 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/terminal/locations/{location} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

location

String

location

x

Update Location 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 Reader

<stripe:create-v1-terminal-readers>

Creates a new Reader object. This operation makes an HTTP POST request to the /v1/terminal/readers endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Reader 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 Reader

<stripe:create-v1-terminal-readers-by-reader>

Updates a Reader 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/terminal/readers/{reader} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

reader

String

reader

x

Update Reader 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 single-use token

<stripe:create-v1-tokens>

Creates a single-use token that represents a bank account’s details. Use this token with any API method in place of a bank account dictionary. This token can be used only once, by attaching it to a Custom account. This operation makes an HTTP POST request to the /v1/tokens endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Single Use Token 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 top-up

<stripe:create-v1-topups>

Tops up the balance of an account. This operation makes an HTTP POST request to the /v1/topups endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Top Up 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 top-up

<stripe:create-v1-topups-by-topup>

Updates the metadata of a top-up. Other top-up details are not editable by design. This operation makes an HTTP POST request to the /v1/topups/{topup} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

topup

String

topup

x

Update Top Up 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 top-up

<stripe:create-v1-topups-cancel-by-topup>

Cancels a pending top-up. This operation makes an HTTP POST request to the /v1/topups/{topup}/cancel endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

topup

String

topup

x

Cancel Top Up 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 transfer

<stripe:create-v1-transfers>

To send funds from your Stripe account to a connected account, create a new transfer object. Your Stripe balance must be sufficient to cover the transfer amount, or you'™ll receive an Insufficient Funds error. This operation makes an HTTP POST request to the /v1/transfers endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Transfer 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 transfer

<stripe:create-v1-transfers-by-transfer>

Updates the specified transfer by setting the values of the parameters passed. 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/transfers/{transfer} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

transfer

String

transfer

x

Update Transfer 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 transfer reversal

<stripe:create-v1-transfers-reversals-by-id>

When you create a new reversal, you must specify a transfer to create it on. When reversing transfers, you can optionally reverse part of the transfer. You can do so as many times as you wish until the entire transfer has been reversed. Once entirely reversed, a transfer can’t be reversed again. This method returns an error when called on an already-reversed transfer, or when trying to reverse more money than is left on a transfer. This operation makes an HTTP POST request to the /v1/transfers/{id}/reversals endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

ID

String

ID

x

Create Transfer Reversal 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 reversal

<stripe:create-v1-transfers-reversals-by-transfer-id>

Updates the specified reversal by setting the values of the parameters passed. Any parameters not provided are left unchanged. This request accepts only metadata and description as arguments. This operation makes an HTTP POST request to the /v1/transfers/{transfer}/reversals/{id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

ID

String

ID

x

transfer

String

transfer

x

Update Reversal 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 webhook endpoint

<stripe:create-v1-webhook-endpoints>

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

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Webhook Endpoint 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 webhook endpoint

<stripe:create-v1-webhook-endpoints-by-webhook-endpoint>

Updates the webhook endpoint. You can edit the URL, the list of enabled_events, and the status of your endpoint. This operation makes an HTTP POST request to the /v1/webhook_endpoints/{webhook_endpoint} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Webhook endpoint

String

Webhook endpoint

x

Update Webhook Endpoint 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

Delete Account

<stripe:delete-v1-account>

With Connect, you can delete Custom or Express accounts you manage. Accounts created using test-mode keys can be deleted at any time. Accounts created using live-mode keys can only be deleted after all balances are zero. This operation makes an HTTP DELETE request to the /v1/account endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Delete 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

Delete Bank Account

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

Delete a specified external account for a given account. This operation makes an HTTP DELETE 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

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.

#[null]

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

Delete External Account

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

Delete a specified external account for a given account. This operation makes an HTTP DELETE 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

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.

#[null]

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

Delete People

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

Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship to an account, other than a person who is the account_opener, can be deleted using the API. If your integration is using the executive parameter, you cannot delete the only verified executive on file. This operation makes an HTTP DELETE 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

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.

#[null]

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

Delete Person

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

Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship to an account, other than a person who is the account_opener, can be deleted using the API. If your integration is using the executive parameter, you cannot delete the only verified executive on file. This operation makes an HTTP DELETE 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

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.

#[null]

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

Deletes Bank Account For Account

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

Deletes a specified external account for a given account. This operation makes an HTTP DELETE 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

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.

#[null]

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

Delete an account

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

With Connect, you can delete Custom or Express accounts you manage. Accounts created using test-mode keys can be deleted at any time. Accounts created using live-mode keys can only be deleted after all balances are zero. If you want to delete your own account, use the account information tab in your account settings instead. This operation makes an HTTP DELETE 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

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.

#[null]

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

Delete External Account For Account

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

Delete a specified external account for a given account. This operation makes an HTTP DELETE 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

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.

#[null]

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

Delete People For Account

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

Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship to an account, other than a person who is the account_opener, can be deleted using the API. If your integration is using the executive parameter, you cannot delete the only verified executive on file. This operation makes an HTTP DELETE 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

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.

#[null]

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

Delete Person For Account

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

Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship to an account, other than a person who is the account_opener, can be deleted using the API. If your integration is using the executive parameter, you cannot delete the only verified executive on file. This operation makes an HTTP DELETE 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

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.

#[null]

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

Delete Apple Pay Domain

<stripe:delete-v1-apple-pay-domains-by-domain>

Deletes an Apple pay domain. This operation makes an HTTP DELETE request to the /v1/apple_pay/domains/{domain} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

domain

String

domain

x

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.

#[null]

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

Delete a Coupon

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

Deletes a coupon. Deleting a coupon does not affect any customers who already applied the coupon; it means that new customers can’t redeem the coupon. This operation makes an HTTP DELETE 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

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.

#[null]

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

Delete bank account for customer

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

Deletes a specified source for a given customer. This operation makes an HTTP DELETE 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

Delete 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

Delete a customer

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

Permanently deletes a customer and cannot be undone. Also immediately cancels any active subscriptions associated with the customer. This operation makes an HTTP DELETE 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

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.

#[null]

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

Delete card for customer

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

Deletes a specified source for a given customer. This operation makes an HTTP DELETE 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

Delete 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

Delete a customer discount

<stripe:delete-v1-customers-discount-by-customer>

Removes the discount that is currently applied to a customer. This operation makes an HTTP DELETE request to the /v1/customers/{customer}/discount endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

customer

String

customer

x

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.

#[null]

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

Delete a source for customer

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

Deletes a specified source for a given customer. This operation makes an HTTP DELETE 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

Delete Source 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 customer subscription

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

Cancels a customer’s subscription immediately if the default value of false is used. If you set the at_period_end parameter to true, the subscription remains active until the end of the period, at which point it is canceled and not renewed. In either case, the customer is not charged again for the subscription. NOTE: Pending invoice items that you'™ve created are still charged for at the end of the period, unless they are manually deleted. If you'™ve set the subscription to cancel at the end of the period, any pending prorations are left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed. This operation makes an HTTP DELETE 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

Cancel 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

Remove discount from customer

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

Removes the discount currently applied a customer. This operation makes an HTTP DELETE request to the /v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount 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

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.

#[null]

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

Delete a tax ID

<stripe:delete-v1-customers-tax-ids-by-customer-id>

Deletes an existing TaxID object. This operation makes an HTTP DELETE request to the /v1/customers/{customer}/tax_ids/{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

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.

#[null]

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

Delete a ephemeral key

<stripe:delete-v1-ephemeral-keys-by-key>

Invalidates a short-lived API key for a specified resource. This operation makes an HTTP DELETE request to the /v1/ephemeral_keys/{key} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

key

String

key

x

Delete 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

Delete an invoice item

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

Deletes an invoice item. Deleting invoice items is only possible when the invoice items are not attached to invoices, or if it’s attached to a draft invoice. This operation makes an HTTP DELETE 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

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.

#[null]

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

Delete a draft invoice

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

Permanently deletes a draft invoice and cannot be undone. Attempts to delete invoices that are no longer in a draft state fail. After an invoice is finalized, it must be voided rather than deleted. This operation makes an HTTP DELETE 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

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.

#[null]

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

Delete a plan

<stripe:delete-v1-plans-by-plan>

Deleting plans means new subscribers can’t be added. Existing subscribers aren’t affected. This operation makes an HTTP DELETE request to the /v1/plans/{plan} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

plan

String

plan

x

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.

#[null]

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

Delete a product

<stripe:delete-v1-products-by-id>

Deletes a product. Deleting a product with type=good is only possible if it has no SKUs associated with it. Deleting a product with type=service is only possible if it has no plans associated with it. This operation makes an HTTP DELETE request to the /v1/products/{id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

ID

String

ID

x

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.

#[null]

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

Delete a value list item

<stripe:delete-v1-radar-value-list-items-by-item>

Deletes a ValueListItem object, removing it from its parent value list. This operation makes an HTTP DELETE request to the /v1/radar/value_list_items/{item} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

item

String

item

x

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.

#[null]

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

Delete a value list

<stripe:delete-v1-radar-value-lists-by-value-list>

Deletes a ValueList object and also deletes any items contained within the value list. You can only delete a value list if it is not referenced in any rules. This operation makes an HTTP DELETE request to the /v1/radar/value_lists/{value_list} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Value list

String

Value list

x

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.

#[null]

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

Delete a SKU

<stripe:delete-v1-skus-by-id>

Deletes a SKU. Deleting a SKU is only possible if it has not been used in an order. This operation makes an HTTP DELETE request to the /v1/skus/{id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

ID

String

ID

x

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.

#[null]

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

Delete a subscription item

<stripe:delete-v1-subscription-items-by-item>

Deletes an item from the subscription. Removing a subscription item from a subscription does not cancel the subscription. This operation makes an HTTP DELETE request to the /v1/subscription_items/{item} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

item

String

item

x

Delete Subscription 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

Cancel a subscription

<stripe:delete-v1-subscriptions-by-subscription-exposed-id>

Cancels a customer’s subscription immediately and the customer is not charged again for the subscription. NOTE: Pending invoice items that you'™ve created are still charged for at the end of the period, unless manually deleted. If you'™ve set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed. This operation makes an HTTP DELETE request to the /v1/subscriptions/{subscription_exposed_id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Subscription exposed ID

String

Subscription exposed ID

x

Cancel 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

Delete a subscription discount

<stripe:delete-v1-subscriptions-discount-by-subscription-exposed-id>

Removes the discount that is currently applied to a subscription. This operation makes an HTTP DELETE request to the /v1/subscriptions/{subscription_exposed_id}/discount endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Subscription exposed ID

String

Subscription exposed ID

x

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.

#[null]

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

Delete a Location

<stripe:delete-v1-terminal-locations-by-location>

Deletes a Location object. This operation makes an HTTP DELETE request to the /v1/terminal/locations/{location} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

location

String

location

x

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.

#[null]

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

Delete a Reader

<stripe:delete-v1-terminal-readers-by-reader>

Deletes a Reader object. This operation makes an HTTP DELETE request to the /v1/terminal/readers/{reader} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

reader

String

reader

x

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.

#[null]

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

Delete a webhook endpoint

<stripe:delete-v1-webhook-endpoints-by-webhook-endpoint>

Deletes webhook endpoints. You can also delete webhook endpoints using the webhook endpoint management page of the Stripe dashboard. This operation makes an HTTP DELETE request to the /v1/webhook_endpoints/{webhook_endpoint} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Webhook endpoint

String

Webhook endpoint

x

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.

#[null]

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

Get 3D Secure Object

<stripe:get-v13d-secure-by-three-d-secure>

Retrieves a 3D Secure object. This operation makes an HTTP GET request to the /v1/3d_secure/{three_d_secure} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Three d secure

String

Three d secure

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

Get Account

<stripe:get-v1-account>

Retrieves the details of an account. This operation makes an HTTP GET request to the /v1/account endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

expand

Array of String

Specifies which fields in the response to expand.

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.

#[null]

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

Retrieve Bank Account

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

Retrieves a specified external account for a given account. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response to expand.

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.

#[null]

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

List Account Capabilities

<stripe:get-v1-account-capabilities>

Returns a list of capabilities associated with the account, sorted by creation date, with the most recent capability appearing first. This operation makes an HTTP GET request to the /v1/account/capabilities endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

expand

Array of String

Specifies which fields in the response to expand.

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.

#[null]

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

Get Account Capability

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

Retrieves information about the specified Account Capability. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List External Accounts

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

Lists external accounts for an account. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response to expand.

limit

Number

Limit on the number of objects to return, which can range between 1 and 100. The default is 10.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Get External Account

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

Retrieves a specified external account for a given account. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response to expand.

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.

#[null]

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

List People

<stripe:get-v1-account-people>

Returns a list of people associated with the account’s legal entity, sorted by creation date, with the most recent people appearing first. This operation makes an HTTP GET request to the /v1/account/people endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

expand

Array of String

Specifies which fields in the response to expand.

relationship

String

Filters on the list of people returned based on the person''s relationship to the account’s company.

limit

Number

Limit on the number of objects to return, which can range between 1 and 100. The default is 10.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Get People

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

Retrieves an existing person. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response to expand.

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.

#[null]

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

List Persons

<stripe:get-v1-account-persons>

Returns a list of people associated with the account’s legal entity, sorted by creation date, with the most recent people appearing first. This operation makes an HTTP GET request to the /v1/account/persons endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

expand

Array of String

Specifies which fields in the response to expand.

relationship

String

Filters on the list of people returned based on the person’s relationship to the account’s company.

limit

Number

Limit on the number of objects to return, which can range between 1 and 100. The default is 10.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Get Person

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

Retrieves an existing person. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response to expand.

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.

#[null]

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

List all connected accounts

<stripe:get-v1-accounts>

Returns a list of accounts connected to your platform via Connect. If you'™re not a platform, the list is empty. This operation makes an HTTP GET request to the /v1/accounts endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

expand

Array of String

Specifies which fields in the response should be expanded.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

created

Number

created

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Get Bank Account For Account

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

Retrieves a specified external account for a given account. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response to expand.

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.

#[null]

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

Retrieve account

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

Retrieves the details of an account. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response to expand.

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.

#[null]

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

List all account capabilities

<stripe:get-v1-accounts-capabilities-by-account>

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first. This operation makes an HTTP GET request to the /v1/accounts/{account}/capabilities endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

account

String

account

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

Retrieve an Account Capability

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

Retrieves information about the specified Account Capability. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response to expand.

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.

#[null]

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

List External Accounts For Account

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

List external accounts for an account. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response should be expanded.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Get External Account For Account

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

Retrieve a specified external account for a given account. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List People For Account

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

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response should be expanded.

relationship

String

Filters on the list of people returned based on the person''s relationship to the account''s company.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Get People For Account

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

Retrieves an existing person. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List Persons For Account

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

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response should be expanded.

relationship

String

Filters on the list of people returned based on the person''s relationship to the account''s company.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Get Person For Account

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

Retrieves an existing person. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List Apple Pay Domains

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

List apple pay domains. This operation makes an HTTP GET 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

Domain name

String

Domain name

expand

Array of String

Specifies which fields in the response should be expanded.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Get Apple Pay Domain

<stripe:get-v1-apple-pay-domains-by-domain>

Retrieve an apple pay domain. This operation makes an HTTP GET request to the /v1/apple_pay/domains/{domain} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

domain

String

domain

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List Application Fees

<stripe:get-v1-application-fees>

Returns a list of application fees you'™ve previously collected. The application fees are returned in sorted order, with the most recent fees appearing first. This operation makes an HTTP GET request to the /v1/application_fees endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

expand

Array of String

Specifies which fields in the response should be expanded.

charge

String

Only return application fees for the charge specified by this charge ID.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

created

Number

created

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Get Application Fee

<stripe:get-v1-application-fees-by-id>

Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee. This operation makes an HTTP GET request to the /v1/application_fees/{id} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

ID

String

ID

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

Get Refund For Application Fee

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

By default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List Refunds For Application Fee

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

You can see a list of the refunds belonging to a specific application fee. Note that the 10 most recent refunds are always available by default on the application fee object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response should be expanded.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Get Balance

<stripe:get-v1-balance>

Retrieves the current account balance, based on the authentication that was used to make the request. For a sample request, see Accounting for negative balances. This operation makes an HTTP GET request to the /v1/balance endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

Get Balance History

<stripe:get-v1-balance-history>

Returns a list of transactions that have contributed to the Stripe account balance (, for example, charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first. Note that this endpoint was previously called 'œBalance history' and used the path /v1/balance/history. This operation makes an HTTP GET request to the /v1/balance/history endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Ending before

String

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar to fetch the previous page of the list.

Available on

Number

Available on

source

String

Only returns the original transaction.

payout

String

For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.

Starting after

String

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo to fetch the next page of the list.

expand

Array of String

Specifies which fields in the response should be expanded.

currency

String

Only return transactions in a certain currency. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).

type

String

Only returns transactions of the given type. One of: charge, refund, adjustment, application_fee, application_fee_refund, transfer, payment, payout, payout_failure, stripe_fee, or network_cost.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

created

Number

created

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.

#[null]

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

Get Balance History For Transaction

<stripe:get-v1-balance-history-by-id>

Retrieves the balance transaction with the given ID. Note that this endpoint previously used the path /v1/balance/history/:id. This operation makes an HTTP GET request to the /v1/balance/history/{id} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

ID

String

ID

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List Balance Transactions

<stripe:get-v1-balance-transactions>

Returns a list of transactions that have contributed to the Stripe account balance (, for example, charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first. Note that this endpoint was previously called 'œBalance history' and used the path /v1/balance/history. This operation makes an HTTP GET request to the /v1/balance_transactions endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Available on

Number

Available on

source

String

Only returns the original transaction.

payout

String

For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.

expand

Array of String

Specifies which fields in the response should be expanded.

currency

String

Only return transactions in a certain currency. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).

type

String

Only returns transactions of the given type. One of: charge, refund, adjustment, application_fee, application_fee_refund, transfer, payment, payout, payout_failure, stripe_fee, or network_cost.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

created

Number

created

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Get Balance Transaction By Id

<stripe:get-v1-balance-transactions-by-id>

Retrieves the balance transaction with the given ID. Note that this endpoint previously used the path /v1/balance/history/:id. This operation makes an HTTP GET request to the /v1/balance_transactions/{id} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

ID

String

ID

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all charges

<stripe:get-v1-charges>

Returns a list of charges you'™ve previously created. The charges are returned in sorted order, with the most recent charges appearing first. This operation makes an HTTP GET request to the /v1/charges endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

expand

Array of String

Specifies which fields in the response should be expanded.

customer

String

Only return charges for the customer specified by this customer ID.

Transfer group

String

Only return charges for this transfer group.

created[gt]

Number

created[gt]

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Payment intent

String

Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID.

created

Number

created

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve a charge

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

Retrieves the details of a charge that has previously been created. Supply the unique charge ID that was returned from your previous request, and Stripe will return the corresponding charge information. The same information is returned when creating or refunding the charge. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

Get Charge Dispute

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

Retrieve a dispute for a specified charge. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List Charge Refunds

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

You can see a list of the refunds belonging to a specific charge. Note that the 10 most recent refunds are always available by default on the charge object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response should be expanded.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Get Refund For Charge

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

Retrieves the details of an existing refund. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all Checkout Sessions

<stripe:get-v1-checkout-sessions>

Returns a list of Checkout Sessions. This operation makes an HTTP GET request to the /v1/checkout/sessions endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

subscription

String

Only return the Checkout Session for the subscription specified.

expand

Array of String

Specifies which fields in the response should be expanded.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Payment intent

String

Only return the Checkout Session for the PaymentIntent specified.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve a Session

<stripe:get-v1-checkout-sessions-by-session>

Retrieves a Session object. This operation makes an HTTP GET request to the /v1/checkout/sessions/{session} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

session

String

session

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List Country Specs

<stripe:get-v1-country-specs>

Lists all Country Spec objects available in the API. This operation makes an HTTP GET request to the /v1/country_specs endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

expand

Array of String

Specifies which fields in the response should be expanded.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve a Country Spec

<stripe:get-v1-country-specs-by-country>

Returns a Country Spec for a given Country code. This operation makes an HTTP GET request to the /v1/country_specs/{country} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

country

String

country

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all coupons

<stripe:get-v1-coupons>

Returns a list of your coupons. This operation makes an HTTP GET request to the /v1/coupons endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

expand

Array of String

Specifies which fields in the response should be expanded.

created[gt]

Number

created[gt]

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

created

Number

A filter on the list, based on the object created field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve a coupon

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

Retrieves the coupon with the given ID. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List Credit Notes

<stripe:get-v1-credit-notes>

Returns a list of credit notes. This operation makes an HTTP GET request to the /v1/credit_notes endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

expand

Array of String

Specifies which fields in the response should be expanded.

invoice

String

Only return credit notes for the invoice specified by this invoice ID.

customer

String

Only return credit notes for the customer specified by this customer ID.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Get Credit Note

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

Retrieves the credit note object with the given identifier. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

Get Credit Note Lines For Credit Note

<stripe:get-v1-credit-notes-lines-by-credit-note>

When retrieving a credit note, you'™ll get a lines property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items. This operation makes an HTTP GET request to the /v1/credit_notes/{credit_note}/lines endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Credit note

String

Credit note

x

expand

Array of String

Specifies which fields in the response should be expanded.

Ending before

String

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar to fetch the previous page of the list.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Starting after

String

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo to fetch the next page of the list.

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.

#[null]

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

Get Credit Note Preview

<stripe:get-v1-credit-notes-preview>

Get a preview of a credit note without creating it. This operation makes an HTTP GET request to the /v1/credit_notes/preview endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Refund amount

Number

The integer amount in %s representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.

Out of band amount

Number

The integer amount in %s representing the amount that is credited outside of Stripe.

refund

String

ID of an existing refund to link this credit note to.

reason

String

Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory

amount

Number

The integer amount in %s representing the total amount of the credit note.

expand

Array of String

Specifies which fields in the response should be expanded.

invoice

String

ID of the invoice.

x

metadata

String

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

lines

Array of String

Line items that make up the credit note.

Credit amount

Number

The integer amount in %s representing the amount to credit the customer''s balance, which will be automatically applied to their next invoice.

memo

String

The credit note''s memo appears on the credit note PDF.

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.

#[null]

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

Get Credit Note Preview Lines

<stripe:get-v1-credit-notes-preview-lines>

When retrieving a credit note preview, you'™ll get a lines property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items. This operation makes an HTTP GET request to the /v1/credit_notes/preview/lines endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Ending before

String

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar to fetch the previous page of the list.

Starting after

String

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo to fetch the next page of the list.

Refund amount

Number

The integer amount in %s representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.

Out of band amount

Number

The integer amount in %s representing the amount that is credited outside of Stripe.

refund

String

ID of an existing refund to link this credit note to.

reason

String

Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory

amount

Number

The integer amount in %s representing the total amount of the credit note.

expand

Array of String

Specifies which fields in the response should be expanded.

invoice

String

ID of the invoice.

x

metadata

String

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

lines

Array of String

Line items that make up the credit note.

Credit amount

Number

The integer amount in %s representing the amount to credit the customer''s balance, which will be automatically applied to their next invoice.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

memo

String

The credit note''s memo appears on the credit note PDF.

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.

#[null]

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

List all customers

<stripe:get-v1-customers>

Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first. This operation makes an HTTP GET request to the /v1/customers endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

email

String

A filter on the list based on the customer''s email field. The value must be a string.

expand

Array of String

Specifies which fields in the response should be expanded.

created[gt]

Number

created[gt]

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

created

Number

created

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

List Balance Transactions For Customer

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

Returns a list of transactions that updated the customer’s balance. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response should be expanded.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Get Balance Transaction For Customer

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

Retrieves a specific transaction that updated the customer’s balance. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

Retrieve a customer

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

Retrieves the details of an existing customer. You need only supply the unique customer identifier that was returned upon customer creation. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

Retrieve discount for customer

<stripe:get-v1-customers-discount-by-customer>

Retrieve discount for customer This operation makes an HTTP GET request to the /v1/customers/{customer}/discount endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

customer

String

customer

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List sources for customer

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

List sources for a specified customer. This operation makes an HTTP GET 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

object

String

Filter sources according to a particular object type.

expand

Array of String

Specifies which fields in the response should be expanded.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve a source for customer

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

Retrieve a specified source for a given customer. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List customer active subscriptions

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

You can see a list of the customer active subscriptions. Note that the 10 most recent active subscriptions are always available by default on the customer object. If you need more than those 10, you can use the limit and starting_after parameters to page through additional subscriptions. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response should be expanded.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve a customer subscription

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

Retrieves the subscription with the given ID. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

Get discount from customer

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

Get discount from customer This operation makes an HTTP GET request to the /v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount 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

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all tax IDs

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

Returns a list of tax IDs for a customer. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response should be expanded.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve a tax ID

<stripe:get-v1-customers-tax-ids-by-customer-id>

Retrieves the TaxID object with the given identifier. This operation makes an HTTP GET request to the /v1/customers/{customer}/tax_ids/{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

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all disputes

<stripe:get-v1-disputes>

Returns a list of your disputes. This operation makes an HTTP GET request to the /v1/disputes endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

expand

Array of String

Specifies which fields in the response should be expanded.

charge

String

Only return disputes associated to the charge specified by this charge ID.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Payment intent

String

Only return disputes associated to the PaymentIntent specified by this PaymentIntent ID.

created

Number

created

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve a dispute

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

Retrieves the dispute with the given ID. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all events

<stripe:get-v1-events>

List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in event object api_version attribute (not according to your current Stripe API version or Stripe-Version header). This operation makes an HTTP GET request to the /v1/events endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

expand

Array of String

Specifies which fields in the response should be expanded.

type

String

A string containing a specific event name, or group of events using * as a wildcard. The list will be filtered to include only events with a matching event property.

created[gt]

Number

created[gt]

types

Array of String

An array of up to 20 strings containing specific event names. The list will be filtered to include only events with a matching event property. You may pass either type or types, but not both.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Delivery success

Boolean

Filter events by whether all webhooks were successfully delivered. If false, events which are still pending or have failed all delivery attempts to a webhook endpoint will be returned.

false

created

Number

created

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve and event

<stripe:get-v1-events-by-id>

Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook. This operation makes an HTTP GET request to the /v1/events/{id} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

ID

String

ID

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all exchange rates

<stripe:get-v1-exchange-rates>

Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports. This operation makes an HTTP GET request to the /v1/exchange_rates endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

expand

Array of String

Specifies which fields in the response should be expanded.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and total number of supported payout currencies, and the default is the max.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve and exchange rate

<stripe:get-v1-exchange-rates-by-currency>

Retrieves the exchange rates from the given currency to every supported currency. This operation makes an HTTP GET request to the /v1/exchange_rates/{currency} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

currency

String

currency

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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:get-v1-file-links>

Returns a list of file links. This operation makes an HTTP GET request to the /v1/file_links endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

expired

Boolean

Filter links by their expiration status. By default, all links are returned.

false

expand

Array of String

Specifies which fields in the response should be expanded.

file

String

Only return links for the given file.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

created

Number

created

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

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

Retrieves the file link with the given ID. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all files

<stripe:get-v1-files>

Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the most recently created files appearing first. This operation makes an HTTP GET request to the /v1/files endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

purpose

String

The file purpose to filter queries by. If none is provided, files will not be filtered by purpose.

expand

Array of String

Specifies which fields in the response should be expanded.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

created

Number

created

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve a file

<stripe:get-v1-files-by-file>

Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object. To access file contents, see the File Upload Guide. This operation makes an HTTP GET request to the /v1/files/{file} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

file

String

file

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all invoice items

<stripe:get-v1-invoiceitems>

Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first. This operation makes an HTTP GET request to the /v1/invoiceitems endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

expand

Array of String

Specifies which fields in the response should be expanded.

invoice

String

Only return invoice items belonging to this invoice. If none is provided, all invoice items will be returned. If specifying an invoice, no customer identifier is needed.

customer

String

The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

pending

Boolean

Set to true to only show pending invoice items, which are not yet attached to any invoices. Set to false to only show invoice items already attached to invoices. If unspecified, no filter is applied.

false

created

Number

created

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve an invoice item

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

Retrieves the invoice item with the given ID. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all invoices

<stripe:get-v1-invoices>

You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first. This operation makes an HTTP GET request to the /v1/invoices endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Collection method

String

The collection method of the invoice to retrieve. Either charge_automatically or send_invoice.

subscription

String

Only return invoices for the subscription specified by this subscription ID.

expand

Array of String

Specifies which fields in the response should be expanded.

status

String

The status of the invoice, one of draft, open, paid, uncollectible, or void. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview)

customer

String

Only return invoices for the customer specified by this customer ID.

Due date

Number

Due date

created[gt]

Number

created[gt]

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

created

Number

created

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve an invoice

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

Retrieves the invoice with the given ID. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

Retrieve an invoice''s line items

<stripe:get-v1-invoices-lines-by-invoice>

When retrieving an invoice, you'™ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items. This operation makes an HTTP GET request to the /v1/invoices/{invoice}/lines endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

invoice

String

invoice

x

expand

Array of String

Specifies which fields in the response should be expanded.

Ending before

String

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar to fetch the previous page of the list.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Starting after

String

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo to fetch the next page of the list.

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.

#[null]

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

Retrieve an upcoming invoice

<stripe:get-v1-invoices-upcoming>

At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discount that is applicable to the customer. Note that when you are viewing an upcoming invoice, you are simply viewing a preview - the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount. You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass a proration_date parameter when doing the actual subscription update. The value passed in should be the same as the subscription_proration_date returned on the upcoming invoice resource. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_proration_date on the upcoming invoice resource. This operation makes an HTTP GET request to the /v1/invoices/upcoming endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Subscription tax percent

Number

If provided, the invoice returned will preview updating or creating a subscription with that tax percent. If set, one of subscription_items or subscription is required. This field has been deprecated and will be removed in a future API version, for further information view the [migration docs](https://stripe.com/docs/billing/migration/taxes) for tax_rates.

subscription

String

The identifier of the subscription for which you''d like to retrieve the upcoming invoice. If not provided, but a subscription_items is provided, you will preview creating a subscription with those items. If neither subscription nor subscription_items is provided, you will retrieve the next upcoming invoice from among the customer''s subscriptions.

Subscription proration date

Number

If previewing an update to a subscription, and doing proration, subscription_proration_date forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period, and cannot be before the subscription was on its current plan. If set, subscription, and one of subscription_items, or subscription_trial_end are required. Also, subscription_proration cannot be set to false.

coupon

String

The code of the coupon to apply. If subscription or subscription_items is provided, the invoice returned will preview updating or creating a subscription with that coupon. Otherwise, it will preview applying that coupon to the customer for the next upcoming invoice from among the customer''s subscriptions. The invoice can be previewed without a coupon by passing this value as an empty string.

Subscription cancel now

Boolean

This simulates the subscription being canceled or expired immediately.

false

Subscription default tax rates

String

If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have tax_rates set.

Subscription trial from plan

Boolean

Indicates if a plan''s trial_period_days should be applied to the subscription. Setting subscription_trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with subscription_trial_end is not allowed.

false

Subscription trial end

String

If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of subscription_items or subscription is required.

expand

Array of String

Specifies which fields in the response should be expanded.

Invoice items

Array of String

List of invoice items to add or update in the upcoming invoice preview.

Subscription proration behavior

String

Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (, for example, when switching plans, resetting billing_cycle_anchor=now, or starting a trial), or if an item’s quantity changes. Valid values are create_prorations, none, or always_invoice. Passing create_prorations will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass always_invoice. Prorations can be disabled by passing none.

Subscription items

Array of String

List of subscription items, each with an attached plan.

customer

String

The identifier of the customer whose upcoming invoice you''d like to retrieve.

schedule

String

The identifier of the unstarted schedule whose upcoming invoice you''d like to retrieve. Cannot be used with subscription or subscription fields.

Subscription prorate

Boolean

This field has been renamed to subscription_proration_behavior. subscription_prorate=true can be replaced with subscription_proration_behavior=create_prorations and subscription_prorate=false can be replaced with subscription_proration_behavior=none.

false

Subscription start date

Number

Date a subscription is intended to start (can be future or past)

Subscription billing cycle anchor

String

For new subscriptions, a future timestamp to anchor the subscription''s [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with month or year intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to now or unchanged.

Subscription cancel at period end

Boolean

Boolean indicating whether this subscription should cancel at the end of the current period.

false

Subscription cancel at

String

Timestamp indicating when the subscription should be scheduled to cancel. Will prorate if within the current period and prorations have been enabled using proration_behavior.`

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.

#[null]

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

Retrieve an upcoming invoice''s line items

<stripe:get-v1-invoices-upcoming-lines>

When retrieving an upcoming invoice, you'™ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items. This operation makes an HTTP GET request to the /v1/invoices/upcoming/lines endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Ending before

String

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar to fetch the previous page of the list.

Subscription tax percent

Number

If provided, the invoice returned will preview updating or creating a subscription with that tax percent. If set, one of subscription_items or subscription is required. This field has been deprecated and will be removed in a future API version, for further information view the [migration docs](https://stripe.com/docs/billing/migration/taxes) for tax_rates.

Starting after

String

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo to fetch the next page of the list.

subscription

String

The identifier of the subscription for which you''d like to retrieve the upcoming invoice. If not provided, but a subscription_items is provided, you will preview creating a subscription with those items. If neither subscription nor subscription_items is provided, you will retrieve the next upcoming invoice from among the customer''s subscriptions.

Subscription proration date

Number

If previewing an update to a subscription, and doing proration, subscription_proration_date forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period, and cannot be before the subscription was on its current plan. If set, subscription, and one of subscription_items, or subscription_trial_end are required. Also, subscription_proration cannot be set to false.

coupon

String

The code of the coupon to apply. If subscription or subscription_items is provided, the invoice returned will preview updating or creating a subscription with that coupon. Otherwise, it will preview applying that coupon to the customer for the next upcoming invoice from among the customer''s subscriptions. The invoice can be previewed without a coupon by passing this value as an empty string.

Subscription cancel now

Boolean

This simulates the subscription being canceled or expired immediately.

false

Subscription default tax rates

String

If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have tax_rates set.

Subscription trial from plan

Boolean

Indicates if a plan''s trial_period_days should be applied to the subscription. Setting subscription_trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with subscription_trial_end is not allowed.

false

Subscription trial end

String

If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of subscription_items or subscription is required.

expand

Array of String

Specifies which fields in the response should be expanded.

Invoice items

Array of String

List of invoice items to add or update in the upcoming invoice preview.

Subscription proration behavior

String

Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (, for example, when switching plans, resetting billing_cycle_anchor=now, or starting a trial), or if an item’s quantity changes. Valid values are create_prorations, none, or always_invoice. Passing create_prorations will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass always_invoice. Prorations can be disabled by passing none.

Subscription items

Array of String

List of subscription items, each with an attached plan.

customer

String

The identifier of the customer whose upcoming invoice you''d like to retrieve.

schedule

String

The identifier of the unstarted schedule whose upcoming invoice you''d like to retrieve. Cannot be used with subscription or subscription fields.

Subscription prorate

Boolean

If previewing an update to a subscription, this decides whether the preview will show the result of applying prorations or not. If set, one of subscription_items or subscription, and one of subscription_items or subscription_trial_end are required.

false

Subscription start date

Number

Date a subscription is intended to start (can be future or past)

Subscription billing cycle anchor

String

For new subscriptions, a future timestamp to anchor the subscription''s [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with month or year intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to now or unchanged.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Subscription cancel at period end

Boolean

Boolean indicating whether this subscription should cancel at the end of the current period.

false

Subscription cancel at

String

Timestamp indicating when the subscription should be scheduled to cancel. Will prorate if within the current period and prorations have been enabled using proration_behavior.`

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.

#[null]

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

List all authorizations

<stripe:get-v1-issuing-authorizations>

Returns a list of Issuing Authorization objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first. This operation makes an HTTP GET request to the /v1/issuing/authorizations endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

expand

Array of String

Specifies which fields in the response should be expanded.

status

String

Only return authorizations with the given status. One of pending, closed, or reversed.

card

String

Only return issuing transactions that belong to the given card.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

created

Number

Only return authorizations that were created during the given date interval.

cardholder

String

Only return authorizations belonging to the given cardholder.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve an authorization

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

Retrieves an Issuing Authorization object. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all cardholders

<stripe:get-v1-issuing-cardholders>

Returns a list of Issuing Cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first. This operation makes an HTTP GET request to the /v1/issuing/cardholders endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Phone number

String

Only return cardholders that have the given phone number.

email

String

Only return cardholders that have the given email address.

expand

Array of String

Specifies which fields in the response should be expanded.

status

String

Only return cardholders that have the given status. One of active, inactive, or blocked.

type

String

Only return cardholders that have the given type. One of individual or company.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

created

Number

Only return cardholders that were created during the given date interval.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve a cardholder

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

Retrieves an Issuing Cardholder object. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all cards

<stripe:get-v1-issuing-cards>

Returns a list of Issuing Card objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first. This operation makes an HTTP GET request to the /v1/issuing/cards endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Exp month

Number

Only return cards that have the given expiration month.

Exp year

Number

Only return cards that have the given expiration year.

expand

Array of String

Specifies which fields in the response should be expanded.

last4

String

Only return cards that have the given last four digits.

status

String

Only return cards that have the given status. One of active, inactive, or canceled.

type

String

Only return cards that have the given type. One of virtual or physical.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

created

Number

Only return cards that were issued during the given date interval.

cardholder

String

Only return cards belonging to the Cardholder with the provided ID.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve a card

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

Retrieves an Issuing Card object. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all issuing disputes

<stripe:get-v1-issuing-disputes>

Returns a list of Issuing Dispute objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first. This operation makes an HTTP GET request to the /v1/issuing/disputes endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

expand

Array of String

Specifies which fields in the response should be expanded.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve an issuing dispute

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

Retrieves an Issuing Dispute object. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all settlements

<stripe:get-v1-issuing-settlements>

Returns a list of Issuing Settlement objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first. This operation makes an HTTP GET request to the /v1/issuing/settlements endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

expand

Array of String

Specifies which fields in the response should be expanded.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

created

Number

Only return issuing settlements that were created during the given date interval.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Return a settlement

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

Retrieves an Issuing Settlement object. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all transactions

<stripe:get-v1-issuing-transactions>

Returns a list of Issuing Transaction objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first. This operation makes an HTTP GET request to the /v1/issuing/transactions endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

expand

Array of String

Specifies which fields in the response should be expanded.

card

String

Only return transactions that belong to the given card.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

created

Number

Only return transactions that were created during the given date interval.

cardholder

String

Only return transactions that belong to the given cardholder.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve a transaction

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

Retrieves an Issuing Transaction object. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

Retrieve a Mandate

<stripe:get-v1-mandates-by-mandate>

Retrieves a Mandate object. This operation makes an HTTP GET request to the /v1/mandates/{mandate} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

mandate

String

mandate

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all order returns

<stripe:get-v1-order-returns>

Returns a list of your order returns. The returns are returned sorted by creation date, with the most recently created return appearing first. This operation makes an HTTP GET request to the /v1/order_returns endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

expand

Array of String

Specifies which fields in the response should be expanded.

order

String

The order to retrieve returns for.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

created

Number

Date this return was created.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve an order return

<stripe:get-v1-order-returns-by-id>

Retrieves the details of an existing order return. Supply the unique order ID from either an order return creation request or the order return list, and Stripe will return the corresponding order information. This operation makes an HTTP GET request to the /v1/order_returns/{id} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

ID

String

ID

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all orders

<stripe:get-v1-orders>

Returns a list of your orders. The orders are returned sorted by creation date, with the most recently created orders appearing first. This operation makes an HTTP GET request to the /v1/orders endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Status transitions

String

Filter orders based on when they were paid, fulfilled, canceled, or returned.

expand

Array of String

Specifies which fields in the response should be expanded.

status

String

Only return orders that have the given status. One of created, paid, fulfilled, or refunded.

customer

String

Only return orders for the given customer.

ids

Array of String

Only return orders with the given IDs.

created[gt]

Number

created[gt]

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Upstream ids

Array of String

Only return orders with the given upstream order IDs.

created

Number

Date this order was created.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve an order

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

Retrieves the details of an existing order. Supply the unique order ID from either an order creation request or the order list, and Stripe will return the corresponding order information. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all PaymentIntents

<stripe:get-v1-payment-intents>

Returns a list of PaymentIntents. This operation makes an HTTP GET request to the /v1/payment_intents endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

expand

Array of String

Specifies which fields in the response should be expanded.

customer

String

Only return PaymentIntents for the customer specified by this customer ID.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

created

Number

A filter on the list, based on the object created field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve a PaymentIntent

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

Retrieves the details of a PaymentIntent that has previously been created. Client-side retrieval using a publishable key is allowed when the client_secret is provided in the query string. When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the payment intent object reference for more details. This operation makes an HTTP GET 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

expand

Array of String

Specifies which fields in the response should be expanded.

Client secret

String

The client secret of the PaymentIntent. Required if a publishable key is used to retrieve the source.

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.

#[null]

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

List a Customer''s PaymentMethods

<stripe:get-v1-payment-methods>

Returns a list of PaymentMethods for a given Customer This operation makes an HTTP GET request to the /v1/payment_methods endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Ending before

String

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar to fetch the previous page of the list.

Starting after

String

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo to fetch the next page of the list.

expand

Array of String

Specifies which fields in the response should be expanded.

customer

String

The ID of the customer whose PaymentMethods will be retrieved.

x

type

String

A required filter on the list, based on the object type field.

x

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

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.

#[null]

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

Retrieve a PaymentMethod

<stripe:get-v1-payment-methods-by-payment-method>

Retrieves a PaymentMethod object. This operation makes an HTTP GET request to the /v1/payment_methods/{payment_method} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Payment method

String

Payment method

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all payouts

<stripe:get-v1-payouts>

Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first. This operation makes an HTTP GET request to the /v1/payouts endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

expand

Array of String

Specifies which fields in the response should be expanded.

status

String

Only return payouts that have the given status: pending, paid, failed, or canceled.

Arrival date

Number

Arrival date

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

destination

String

The ID of an external account - only return payouts sent to this external account.

created

Number

created

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve a payout

<stripe:get-v1-payouts-by-payout>

Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list, and Stripe will return the corresponding payout information. This operation makes an HTTP GET request to the /v1/payouts/{payout} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

payout

String

payout

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all plans

<stripe:get-v1-plans>

Returns a list of your plans. This operation makes an HTTP GET request to the /v1/plans endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

expand

Array of String

Specifies which fields in the response should be expanded.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

created

Number

A filter on the list, based on the object created field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.

product

String

Only return plans for the given product.

active

Boolean

Only return plans that are active or inactive (, for example, pass false to list all inactive plans).

false

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve a plan

<stripe:get-v1-plans-by-plan>

Retrieves the plan with the given ID. This operation makes an HTTP GET request to the /v1/plans/{plan} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

plan

String

plan

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all products

<stripe:get-v1-products>

Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first. This operation makes an HTTP GET request to the /v1/products endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

url

String

Only return products with the given url.

shippable

Boolean

Only return products that can be shipped (i.e., physical, not digital products).

false

expand

Array of String

Specifies which fields in the response should be expanded.

ids

Array of String

Only return products with the given IDs.

type

String

Only return products of this type.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

created

Number

Only return products that were created during the given date interval.

active

Boolean

Only return products that are active or inactive (, for example, pass false to list all inactive products).

false

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve a product

<stripe:get-v1-products-by-id>

Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information. This operation makes an HTTP GET request to the /v1/products/{id} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

ID

String

ID

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all early fraud warnings

<stripe:get-v1-radar-early-fraud-warnings>

Returns a list of early fraud warnings. This operation makes an HTTP GET request to the /v1/radar/early_fraud_warnings endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

expand

Array of String

Specifies which fields in the response should be expanded.

charge

String

Only return early fraud warnings for the charge specified by this charge ID.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve an early fraud warning

<stripe:get-v1-radar-early-fraud-warnings-by-early-fraud-warning>

Retrieves the details of an early fraud warning that has previously been created. Please refer to the early fraud warning object reference for more details. This operation makes an HTTP GET request to the /v1/radar/early_fraud_warnings/{early_fraud_warning} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Early fraud warning

String

Early fraud warning

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all value list items

<stripe:get-v1-radar-value-list-items>

Returns a list of ValueListItem objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first. This operation makes an HTTP GET request to the /v1/radar/value_list_items endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

expand

Array of String

Specifies which fields in the response should be expanded.

Value list

String

Identifier for the parent value list this item belongs to.

x

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

value

String

Return items belonging to the parent list whose value matches the specified value (using an "is like" match).

created

Number

created

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve a value list item

<stripe:get-v1-radar-value-list-items-by-item>

Retrieves a ValueListItem object. This operation makes an HTTP GET request to the /v1/radar/value_list_items/{item} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

item

String

item

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all value lists

<stripe:get-v1-radar-value-lists>

Returns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first. This operation makes an HTTP GET request to the /v1/radar/value_lists endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

expand

Array of String

Specifies which fields in the response should be expanded.

alias

String

The alias used to reference the value list when writing rules.

contains

String

A value contained within a value list - returns all value lists containing this value.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

created

Number

created

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve a value list

<stripe:get-v1-radar-value-lists-by-value-list>

Retrieves a ValueList object. This operation makes an HTTP GET request to the /v1/radar/value_lists/{value_list} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Value list

String

Value list

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all refunds

<stripe:get-v1-refunds>

Returns a list of all refunds you'™ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the charge object. This operation makes an HTTP GET request to the /v1/refunds endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

expand

Array of String

Specifies which fields in the response should be expanded.

charge

String

Only return refunds for the charge specified by this charge ID.

created[gt]

Number

created[gt]

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Payment intent

String

Only return refunds for the PaymentIntent specified by this ID.

created

Number

created

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve a refund

<stripe:get-v1-refunds-by-refund>

Retrieves the details of an existing refund. This operation makes an HTTP GET request to the /v1/refunds/{refund} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

refund

String

refund

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all Report Runs

<stripe:get-v1-reporting-report-runs>

Returns a list of Report Runs, with the most recent appearing first. (Requires a live-mode API key.) This operation makes an HTTP GET request to the /v1/reporting/report_runs endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

expand

Array of String

Specifies which fields in the response should be expanded.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

created

Number

created

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve a Report Run

<stripe:get-v1-reporting-report-runs-by-report-run>

Retrieves the details of an existing Report Run. (Requires a live-mode API key.) This operation makes an HTTP GET request to the /v1/reporting/report_runs/{report_run} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Report run

String

Report run

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all Report Types

<stripe:get-v1-reporting-report-types>

Returns a full list of Report Types. (Requires a live-mode API key.) This operation makes an HTTP GET request to the /v1/reporting/report_types endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

Retrieve a Report Type

<stripe:get-v1-reporting-report-types-by-report-type>

Retrieves the details of a Report Type. (Requires a live-mode API key.) This operation makes an HTTP GET request to the /v1/reporting/report_types/{report_type} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Report type

String

Report type

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all open reviews

<stripe:get-v1-reviews>

Returns a list of Review objects that have open set to true. The objects are sorted in descending order by creation date, with the most recently created object appearing first. This operation makes an HTTP GET request to the /v1/reviews endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

expand

Array of String

Specifies which fields in the response should be expanded.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

created

Number

created

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve a review

<stripe:get-v1-reviews-by-review>

Retrieves a Review object. This operation makes an HTTP GET request to the /v1/reviews/{review} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

review

String

review

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all SetupIntents

<stripe:get-v1-setup-intents>

Returns a list of SetupIntents. This operation makes an HTTP GET request to the /v1/setup_intents endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

expand

Array of String

Specifies which fields in the response should be expanded.

Payment method

String

Only return SetupIntents associated with the specified payment method.

customer

String

Only return SetupIntents for the customer specified by this customer ID.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

created

Number

A filter on the list, based on the object created field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve a SetupIntent

<stripe:get-v1-setup-intents-by-intent>

Retrieves the details of a SetupIntent that has previously been created. Client-side retrieval using a publishable key is allowed when the client_secret is provided in the query string. When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the SetupIntent object reference for more details. This operation makes an HTTP GET request to the /v1/setup_intents/{intent} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

intent

String

intent

x

expand

Array of String

Specifies which fields in the response should be expanded.

Client secret

String

The client secret of the SetupIntent. Required if a publishable key is used to retrieve the SetupIntent.

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.

#[null]

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

List all scheduled query runs

<stripe:get-v1-sigma-scheduled-query-runs>

Returns a list of scheduled query runs. This operation makes an HTTP GET request to the /v1/sigma/scheduled_query_runs endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

expand

Array of String

Specifies which fields in the response should be expanded.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve a scheduled query run

<stripe:get-v1-sigma-scheduled-query-runs-by-scheduled-query-run>

Retrieves the details of an scheduled query run. This operation makes an HTTP GET request to the /v1/sigma/scheduled_query_runs/{scheduled_query_run} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Scheduled query run

String

Scheduled query run

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all SKUs

<stripe:get-v1-skus>

Returns a list of your SKUs. The SKUs are returned sorted by creation date, with the most recently created SKUs appearing first. This operation makes an HTTP GET request to the /v1/skus endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

In stock

Boolean

Only return SKUs that are either in stock or out of stock (, for example, pass false to list all SKUs that are out of stock). If no value is provided, all SKUs are returned.

false

attributes

String

Only return SKUs that have the specified key-value pairs in this partially constructed dictionary. Can be specified only if product is also supplied. For instance, if the associated product has attributes ["color", "size"], passing in attributes[color]=red returns all the SKUs for this product that have color set to red.

expand

Array of String

Specifies which fields in the response should be expanded.

ids

Array of String

Only return SKUs with the given IDs.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

product

String

The ID of the product whose SKUs will be retrieved. Must be a product with type good.

active

Boolean

Only return SKUs that are active or inactive (, for example, pass false to list all inactive products).

false

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve a SKU

<stripe:get-v1-skus-by-id>

Retrieves the details of an existing SKU. Supply the unique SKU identifier from either a SKU creation request or from the product, and Stripe will return the corresponding SKU information. This operation makes an HTTP GET request to the /v1/skus/{id} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

ID

String

ID

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

Retrieve a source

<stripe:get-v1-sources-by-source>

Retrieves an existing source object. Supply the unique source ID from a source creation request and Stripe will return the corresponding up-to-date source object information. This operation makes an HTTP GET request to the /v1/sources/{source} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

source

String

source

x

expand

Array of String

Specifies which fields in the response should be expanded.

Client secret

String

The client secret of the source. Required if a publishable key is used to retrieve the source.

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.

#[null]

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

Retrieve a new source mandate notification

<stripe:get-v1-sources-mandate-notifications-by-source-mandate-notification>

Retrieves a new Source MandateNotification. This operation makes an HTTP GET request to the /v1/sources/{source}/mandate_notifications/{mandate_notification} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Mandate notification

String

Mandate notification

x

source

String

source

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List source transactions

<stripe:get-v1-sources-source-transactions-by-source>

List source transactions for a given source. This operation makes an HTTP GET request to the /v1/sources/{source}/source_transactions endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

source

String

source

x

expand

Array of String

Specifies which fields in the response should be expanded.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve source transaction

<stripe:get-v1-sources-source-transactions-by-source-source-transaction>

Retrieve an existing source transaction object. Supply the unique source ID from a source creation request and the source transaction ID and Stripe will return the corresponding up-to-date source object information. This operation makes an HTTP GET request to the /v1/sources/{source}/source_transactions/{source_transaction} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

source

String

source

x

Source transaction

String

Source transaction

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all subscription items

<stripe:get-v1-subscription-items>

Returns a list of your subscription items for a given subscription. This operation makes an HTTP GET request to the /v1/subscription_items endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

subscription

String

The ID of the subscription whose items will be retrieved.

x

expand

Array of String

Specifies which fields in the response should be expanded.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve a subscription item

<stripe:get-v1-subscription-items-by-item>

Retrieves the invoice item with the given ID. This operation makes an HTTP GET request to the /v1/subscription_items/{item} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

item

String

item

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all subscription item period summaries

<stripe:get-v1-subscription-items-usage-record-summaries-by-subscription-item>

For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that’s been summarized from multiple usage records and over a subscription billing period (, for example, 15 usage records in the billing plan’s month of September). The list is sorted in reverse-chronological order (newest first). The first list item represents the most current usage period that hasn'™t ended yet. Since new usage records can still be added, the returned summary information for the subscription item’s ID should be seen as unstable until the subscription billing period ends. This operation makes an HTTP GET request to the /v1/subscription_items/{subscription_item}/usage_record_summaries endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Subscription item

String

Subscription item

x

expand

Array of String

Specifies which fields in the response should be expanded.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

List all schedules

<stripe:get-v1-subscription-schedules>

Retrieves the list of your subscription schedules. This operation makes an HTTP GET request to the /v1/subscription_schedules endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Completed at

Number

Only return subscription schedules that completed during the given date interval.

scheduled

Boolean

Only return subscription schedules that have not started yet.

false

expand

Array of String

Specifies which fields in the response should be expanded.

Released at

Number

Only return subscription schedules that were released during the given date interval.

customer

String

Only return subscription schedules for the given customer.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Canceled at

Number

Only return subscription schedules that were created canceled the given date interval.

created

Number

Only return subscription schedules that were created during the given date interval.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve a schedule

<stripe:get-v1-subscription-schedules-by-schedule>

Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation. This operation makes an HTTP GET request to the /v1/subscription_schedules/{schedule} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

schedule

String

schedule

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List subscriptions

<stripe:get-v1-subscriptions>

By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled. This operation makes an HTTP GET request to the /v1/subscriptions endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Collection method

String

The collection method of the subscriptions to retrieve. Either charge_automatically or send_invoice.

Current period start

Number

Current period start

expand

Array of String

Specifies which fields in the response should be expanded.

status

String

The status of the subscriptions to retrieve. One of: incomplete, incomplete_expired, trialing, active, past_due, unpaid, canceled, or all. Passing in a value of canceled will return all canceled subscriptions, including those belonging to deleted customers. Passing in a value of all will return subscriptions of all statuses.

customer

String

The ID of the customer whose subscriptions will be retrieved.

Current period end

Number

Current period end

created[gt]

Number

created[gt]

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

plan

String

The ID of the plan whose subscriptions will be retrieved.

created

Number

created

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve a subscription

<stripe:get-v1-subscriptions-by-subscription-exposed-id>

Retrieves the subscription with the given ID. This operation makes an HTTP GET request to the /v1/subscriptions/{subscription_exposed_id} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Subscription exposed ID

String

Subscription exposed ID

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all tax rates

<stripe:get-v1-tax-rates>

Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first. This operation makes an HTTP GET request to the /v1/tax_rates endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

inclusive

Boolean

Optional flag to filter by tax rates that are inclusive (or those that are not inclusive)

false

expand

Array of String

Specifies which fields in the response should be expanded.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

created

Number

Optional range for filtering created date

active

Boolean

Optional flag to filter by tax rates that are either active or not active (archived)

false

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieves a tax rate

<stripe:get-v1-tax-rates-by-tax-rate>

Retrieves a tax rate with the given ID This operation makes an HTTP GET request to the /v1/tax_rates/{tax_rate} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Tax rate

String

Tax rate

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all Locations

<stripe:get-v1-terminal-locations>

Returns a list of Location objects. This operation makes an HTTP GET request to the /v1/terminal/locations endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

expand

Array of String

Specifies which fields in the response should be expanded.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve a Location

<stripe:get-v1-terminal-locations-by-location>

Retrieves a Location object. This operation makes an HTTP GET request to the /v1/terminal/locations/{location} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

location

String

location

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all Readers

<stripe:get-v1-terminal-readers>

Returns a list of Reader objects. This operation makes an HTTP GET request to the /v1/terminal/readers endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

location

String

A location ID to filter the response list to only readers at the specific location

Device type

String

Filters readers by device type

expand

Array of String

Specifies which fields in the response should be expanded.

status

String

A status filter to filter readers to only offline or online readers

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve a Reader

<stripe:get-v1-terminal-readers-by-reader>

Retrieves a Reader object. This operation makes an HTTP GET request to the /v1/terminal/readers/{reader} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

reader

String

reader

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

Retrieve a token

<stripe:get-v1-tokens-by-token>

Retrieves the token with the given ID. This operation makes an HTTP GET request to the /v1/tokens/{token} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

token

String

token

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all top-ups

<stripe:get-v1-topups>

Returns a list of top-ups. This operation makes an HTTP GET request to the /v1/topups endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

amount

Number

A positive integer representing how much to transfer.

expand

Array of String

Specifies which fields in the response should be expanded.

status

String

Only return top-ups that have the given status. One of canceled, failed, pending or succeeded.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

created

Number

A filter on the list, based on the object created field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve a top-up

<stripe:get-v1-topups-by-topup>

Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information. This operation makes an HTTP GET request to the /v1/topups/{topup} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

topup

String

topup

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all transfers

<stripe:get-v1-transfers>

Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first. This operation makes an HTTP GET request to the /v1/transfers endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

expand

Array of String

Specifies which fields in the response should be expanded.

Transfer group

String

Only return transfers with the specified transfer group.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

destination

String

Only return transfers for the destination specified by this account ID.

created

Number

created

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve a transfer

<stripe:get-v1-transfers-by-transfer>

Retrieves the details of an existing transfer. Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer information. This operation makes an HTTP GET request to the /v1/transfers/{transfer} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

transfer

String

transfer

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all reversals

<stripe:get-v1-transfers-reversals-by-id>

You can see a list of the reversals belonging to a specific transfer. Note that the 10 most recent reversals are always available by default on the transfer object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional reversals. This operation makes an HTTP GET request to the /v1/transfers/{id}/reversals endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

ID

String

ID

x

expand

Array of String

Specifies which fields in the response should be expanded.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve a reversal

<stripe:get-v1-transfers-reversals-by-transfer-id>

By default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specific reversal stored on the transfer. This operation makes an HTTP GET request to the /v1/transfers/{transfer}/reversals/{id} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

ID

String

ID

x

transfer

String

transfer

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

List all webhook endpoints

<stripe:get-v1-webhook-endpoints>

Returns a list of your webhook endpoints. This operation makes an HTTP GET request to the /v1/webhook_endpoints endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

expand

Array of String

Specifies which fields in the response should be expanded.

limit

Number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Output Mime Type

String

The mime type of the payload that this operation outputs.

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.

#[null]

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

Array of Any

For Configurations

Throws

  • STRIPE:BAD_REQUEST

  • STRIPE:CLIENT_ERROR

  • STRIPE:CONNECTIVITY

  • STRIPE:INTERNAL_SERVER_ERROR

  • STRIPE:NOT_ACCEPTABLE

  • STRIPE:NOT_FOUND

  • STRIPE:SERVER_ERROR

  • STRIPE:SERVICE_UNAVAILABLE

  • STRIPE:TIMEOUT

  • STRIPE:TOO_MANY_REQUESTS

  • STRIPE:UNAUTHORIZED

  • STRIPE:UNSUPPORTED_MEDIA_TYPE

Retrieve a webhook endpoint

<stripe:get-v1-webhook-endpoints-by-webhook-endpoint>

Retrieves the webhook endpoint with the given ID. This operation makes an HTTP GET request to the /v1/webhook_endpoints/{webhook_endpoint} endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Webhook endpoint

String

Webhook endpoint

x

expand

Array of String

Specifies which fields in the response should be expanded.

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.

#[null]

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

Invalidate sessions

<stripe:update-v1-account-logout>

Invalidates all sessions for a light account, for a platform to use during platform logout. You may only log out Express accounts connected to your platform. This operation makes an HTTP PUT request to the /v1/account/logout endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Invalidate Sessions 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

Invalidate Sessions For Account

<stripe:update-v1-accounts-logout-by-account>

Invalidates all sessions for a light account, for a platform to use during platform logout. You may only log out Express accounts connected to your platform. This operation makes an HTTP PUT request to the /v1/accounts/{account}/logout endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

account

String

account

x

Invalidate Session 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

Types

Default Header

Field Type Description Default Value Required

Key

String

x

Value

String

x

Default Query Param

Field Type Description Default Value Required

Key

String

x

Value

String

x

Proxy

Field Type Description Default Value Required

Host

String

x

Port

Number

x

Username

String

Password

String

Non Proxy Hosts

String

Tls

Field Type Description Default Value Required

Enabled Protocols

String

A comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma-separated list of cipher suites enabled for this context.

Trust Store

Trust Store

Key Store

Key Store

Revocation Check

Trust Store

Field Type Description Default Value Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.

Password

String

The password used to protect the trust store.

Type

String

The type of store used.

Algorithm

String

The algorithm used by the trust store.

Insecure

Boolean

If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.

Key Store

Field Type Description Default Value Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.

Type

String

The type of store used.

Alias

String

When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.

Key Password

String

The password used to protect the private key.

Password

String

The password used to protect the key store.

Algorithm

String

The algorithm used by the key store.

Standard Revocation Check

Field Type Description Default Value Required

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before).

Soft Fail

Boolean

Avoid verification failure when the revocation server can not be reached or is busy.

Custom Ocsp Responder

Field Type Description Default Value Required

Url

String

The URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response (must be in the trust store), if present.

Crl File

Field Type Description Default Value Required

Path

String

The path to the CRL file.

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

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.

Reconnection Strategy

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread

Count

Number

How many reconnection attempts to make.

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

Http Response Attributes

Field Type Description Default Value Required

Status Code

Number

x

Headers

Object

x

Reason Phrase

String

x

Repeatable In Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

The amount of memory that will be allocated to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.

Max Buffer Size

Number

The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed

Repeatable File Store Stream

Field Type Description Default Value Required

In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed content on the disk is buffered.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

Redelivery Policy

Field Type Description Default Value Required

Max Redelivery Count

Number

The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message

Message Digest Algorithm

String

The secure hashing algorithm to use. If not set, the default is SHA-256.

Message Identifier

Redelivery Policy Message Identifier

Defines which strategy is used to identify the messages.

Object Store

ObjectStore

The object store where the redelivery counter for each message is stored.

Redelivery Policy Message Identifier

Field Type Description Default Value Required

Use Secure Hash

Boolean

Whether to use a secure hash algorithm to identify a redelivered message.

Id Expression

String

Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is false.

Repeatable In Memory Iterable

Field Type Description Default Value Required

Initial Buffer Size

Number

The number of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances.

Max Buffer Size

Number

The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

Repeatable File Store Iterable

Field Type Description Default Value Required

In Memory Objects

Number

The maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed
Back to top
View on GitHub