Skip to content
Nappai Documentation

Stripe Plan

Stripe Plan manages the plans in your Stripe account. A plan defines how much and how often a product is charged, for example 29.00 a month, and is what a customer is assigned when they subscribe. From a flow you can create plans, look them up and delete them.

Plans and the recurring prices of Stripe Price do the same job. If you are starting from scratch, you can use either.

When to use it

  • You launch a new product with a monthly fee and want to create its plan from a flow.
  • You want to offer a free trial of a few days on a plan.
  • You want to review the plans you have in Stripe.
  • A plan is no longer offered and you want to delete it.

Configuration

You need a Stripe API credential with the secret key of your Stripe account. See Credentials.

FieldWhat it does
Credential (required)The Stripe API credential of your account.
Operation (required)The action the component performs. Defaults to Create. See Operations.
ModeOnly in Get. By ID looks up one plan; All returns the list of plans. Defaults to By ID.
Plan IDThe plan’s identifier in Stripe. Required in Delete and in Get with By ID.
AmountOnly in Create, and required there. The amount of each charge in the smallest unit of the currency, for example cents: 2900 is 29.00.
CurrencyOnly in Create, and required there. The plan’s currency, such as eur or usd. Defaults to usd.
Billing IntervalOnly in Create, and required there. How often it is charged: month, day, week or year. Defaults to month.
Interval CountOnly in Create. How many intervals pass between charges. For example, 3 with month charges every three months. Defaults to 1.
Product IDOnly in Create, and required there. The Stripe product the plan belongs to (starts with prod_). Create it first with Stripe Product.
Trial Period DaysOnly in Create. Days of free trial before the first charge.
LimitOnly in Get with All. Maximum number of plans returned, between 1 and 100. Defaults to 100.

Operations

  • Create: creates a plan for a product with the given amount and billing period.
  • Delete: deletes a plan so it can no longer be assigned to new subscriptions.
  • Get: with By ID returns one plan; with All returns the list of plans.

Output

The Data output returns the plan that was created, looked up or deleted. With Get and All, it returns one item per plan. Each item includes the plan’s identifier, amount, currency and billing period.

You can connect it to your catalogue or to a message for the team. The component can also be connected to an Agent as a tool, so the agent decides when to use it. See Tool Mode.

Example

A course platform launches a quarterly subscription with a 14-day trial.

  1. Create the product “Course access” with Stripe Product and keep its identifier.
  2. Add Stripe Plan with Operation set to Create and pass that identifier to Product ID.
  3. Set Amount to 7500, Currency to eur, Billing Interval to month, Interval Count to 3 and Trial Period Days to 14.
  4. Connect the Data output to a message for the sales team with the new plan’s identifier.