Skip to main content
Version: 1.28 (Current)

Add Stripe Connector

Audience: Low-code Engineers

Skill Prerequisites: Actions, Tokens, Connectors

Creates a new Stripe connector in a connector group. The connector stores the Stripe secret key that the Stripe payment actions use to call Stripe. The action can save the ID of the new connector in a token, so later actions can use or update it.

The secret key is saved encrypted.

note

This action requires the Stripe feature to be licensed.

Typical Use Cases​

  • Let each customer or tenant save its own Stripe account from a setup form
  • Create Stripe connectors from a setup workflow instead of by hand
  • Save the new connector's ID so you can update or delete it later

Don't use it to​

  • Change an existing Stripe connector. Use Update Stripe Connector instead.
  • Check that the key works. The action saves it without contacting Stripe, and Test Connector doesn't support Stripe connectors.
  • Add a connector of another type. Use Add Connector instead.
Action NameDescription
Update Stripe ConnectorChanges the details of an existing Stripe connector.
Get ConnectorReads the details of a connector.
Delete ConnectorRemoves a connector.
Stripe CheckoutTakes a payment through Stripe Checkout using a Stripe connector.
Stripe Create CustomerCreates a customer in Stripe using a Stripe connector.
Stripe Create PlanCreates a subscription plan in Stripe using a Stripe connector.
Stripe Create SubscriptionSubscribes a customer to a plan using a Stripe connector.
Stripe Payment with TokenCharges a card token using a Stripe connector.

Input Parameter Reference​

ParameterDescriptionSupports TokensDefaultRequired
Group TitleThe Stripe connector group to add the connector to. The list shows Stripe groups only. The saved value is the group's ID.Noempty stringYes
Entry titleThe name of the connector, for example Stripe - [CompanyName].Yesempty stringNo
Secret KeyThe Stripe secret API key, for example sk_test_... or sk_live_.... Saved encrypted.Yesempty stringNo
EntryId Token NameThe name of a token to save the new connector's ID in, for example StripeConnectorId. Brackets are optional.Noempty stringNo

Output Parameters Reference​

ParameterDescription
[<EntryId Token Name>]The ID of the new connector, a GUID. It's only set when EntryId Token Name has a value.

Considerations​

  • The group decides the connector type. If Group Title is empty, the action fails with Invalid GroupId. If no group has that ID, it fails with Connector group (id: ...) not found.
  • Nothing is required by the connector. An empty Secret Key is saved as empty, and the Stripe actions will fail when they use the connector.
  • The key isn't tested. A wrong key is saved without an error. You'll only find out when a Stripe action runs.
  • Names aren't unique. Running the action twice with the same title creates two connectors.
  • Test and live keys. Stripe test keys start with sk_test_ and live keys with sk_live_. Consider separate connectors, or separate groups, for each.
  • Keep secrets out of the action. The editor shows Secret Key as plain text. Pass the key through a token, for example from a form, instead of typing it into the action.

Examples​

tip

To understand how to use the below examples, please see Running Examples.

1. Save a customer's Stripe key​

This action adds a connector to the Stripe group with ID 5, using the key from a form. The new connector's ID is saved in [StripeConnectorId]. Replace 5 with the ID of your Stripe group, or pick the group in the editor after importing.

{
"Title": "Add Stripe Connector",
"ActionType": "cs.stripe.add",
"Description": "Save the customer's Stripe secret key",
"Parameters": {
"Group": "5",
"EntryName": "Stripe - [CompanyName]",
"SecretKey": "[StripeSecretKey]",
"EntryIdTokenName": "StripeConnectorId"
}
}

Revised 09/26/2026