Stripe

Connections

Connection types:

• Stripe

Stripe

Stripe is a popular payment provider which allows you to accept payments, send payouts, and manage your business online. The Stripe connector uses the official Node.js client from Stripe. In order to use the Stripe connection, you first need to create a Stripe account and setup an API key.

Secrets like API keys should be stored using the _secret operator.

Properties

• secretKey: string: Required - Stripe secret key.
• apiVersion: string: Stripe API version to use. Defaults to the account-wide version.
• timeout: number: Timeout for requests to the Stripe API.
• maxNetworkRetries: number: Maximum number of times failed requests are repeated before throwing an error.
• telemetry: boolean: Whether to send telemetry data to Stripe (this is forwarded to the Stripe client library. Lowdefy does not receive any telemetry data from your Stripe connection.)

Examples

Simple connection:

connections:
  - id: stripe
    type: Stripe
    properties:
      secretKey:
        _secret: STRIPE_SECRET_KEY

Environment variables:

LOWDEFY_SECRET_STRIPE_SECRET_KEY = sk_test_KyvNyie...

Using an older API version:

connections:
  - id: stripe
    type: Stripe
    properties:
      secretKey:
        _secret: STRIPE_SECRET_KEY
      apiVersion: 2017-12-14

Environment variables:

LOWDEFY_SECRET_STRIPE_SECRET_KEY = sk_test_KyvNyie...

Requests

Request types:

• StripeRequest

StripeRequest

The StripeRequest request allows calls to all modules supported by the Stripe API client by nesting the resource and method calls:

resource:
  method:
    - parameter1
    - parameter2

Properties

• {{ apiResource }}: object: A Stripe API resource, eg. customers.
  • {{ method }}: array | null: A resource method, eg. create. The arguments array will be passed on to the client method.

The Stripe client exposes all resources as objects, with the API methods being available as function properties on those resource objects. In Lowdefy, you may access these properties by nesting them.

Examples

List the 30 most recent customers

requests:
  - id: list_customers
    type: StripeRequest
    connectionId: stripe
    properties:
      customers:
        list:
          limit: 30

Create a payment intent

requests:
  - id: create_payment_intent
    type: StripeRequest
    connectionId: stripe
    properties:
      paymentIntents:
        create:
          - amount: 2000
            currency: eur
            payment_method_types: [ card ]

Retrieve a checkout session by ID

requests:
  - id: retrieve_checkout_session
    type: StripeRequest
    connectionId: stripe
    properties:
      checkout:
        sessions:
          retrieve:
            - cs_test_onpT2icY2lrSU0IgDGXEhhcOHcWeJS5BpLcQGMx0uI9TZHLMBdzvWpvx