Skip to content

Stripe Product

This component allows you to manage your product catalog in Stripe directly from your Nappai automation. You can create new products, find existing ones, update their details, or remove them when they are no longer needed. It connects your internal workflows to the Stripe payment platform to keep your product information up to date.

How it Works

This component acts as a bridge between your Nappai workflow and the Stripe API. When you connect this node, it sends specific instructions to Stripe’s servers based on the inputs you provide.

Internally, it handles the secure connection to Stripe using credentials you have already configured. Depending on the mode you select, it will either look for a single specific product using its unique ID or fetch a list of multiple products. Once the action is complete, it sends the results back to your workflow so you can use that data in subsequent steps.

Connection & Credentials

This component requires configuring a credential in the Nappai panel before interacting with the external service:

  1. Go to the Credentials section in your Nappai panel.
  2. Create a new credential of the type Stripe API and fill in the required fields (API Key).
  3. In your workflow, select the saved credential in the Credential input field of this node.

Inputs

This component has a special mode called “Mapping Mode”. When you enable this mode using the toggle switch, an additional input called “Mapping Data” is activated, and each input field offers you three different ways to provide data:

  • Fixed: You type the value directly into the field.
  • Mapped: You connect the output of another component to use its result as the value.
  • Javascript: You write Javascript code to dynamically calculate the value.

This flexibility allows you to create more dynamic and connected workflows.

Input Fields

The following fields are available to configure this component. Each field may be visible in different operations:

  • Operation: Choose what you want to do with the product data.

    • Visible in: All operations
  • Mode: Select how you want to retrieve records. ‘By ID’ gets one specific record. ‘All’ lists multiple records.

    • Visible in: All operations
  • Product ID: The unique identifier for a product (e.g., prod_…). Required when deleting, updating, or getting a specific product.

    • Visible in: All operations
  • Name: The name of the product. This is required if you are creating a new product.

    • Visible in: All operations
  • Description: A detailed description of the product that customers will see.

    • Visible in: All operations
  • Active: Set whether the product is available for purchase.

    • Visible in: All operations
  • URL: The URL of the product’s public web page.

    • Visible in: All operations
  • Unit Label: A label for one unit of the product (e.g., ‘seat’, ‘token’, ‘kg’).

    • Visible in: All operations
  • Shippable: Indicate if the product is physical and can be shipped.

    • Visible in: All operations
  • Statement Descriptor: Short text that appears on customer credit card statements (max 22 characters).

    • Visible in: All operations
  • Tax Code: The Stripe Tax Code ID (e.g., txcd_10000000) to automatically handle tax calculations.

    • Visible in: All operations
  • Limit: The maximum number of records to return (between 1 and 100). Only used when listing multiple records.

    • Visible in: All operations

Outputs

The component produces data that you can use in other parts of your workflow.

  • Product Object: A dictionary containing all the details of the product (ID, name, price, etc.).
  • Product ID: The unique identifier of the product, which you can use in other nodes.
  • Operation Status: A string indicating if the action was successful (e.g., “success”, “updated”, “deleted”) or if an error occurred.
  • Error Message: If the operation fails, this output provides a detailed explanation of the error.

Output Data Example (JSON)

json { “product”: { “id”: “prod_123456789”, “name”: “Premium Subscription”, “active”: true, “description”: “Access to all premium features”, “type”: “service”, “statement_descriptor”: “MY STORE” }, “product_id”: “prod_123456789”, “status”: “success” }

Connectivity

This component is typically used at the beginning of a product management workflow. It often connects to:

  • Payment Nodes: To verify if a product exists before creating an invoice.
  • Notification Nodes: To send alerts when a product is created or updated.
  • Database Nodes: To save product details to your internal records after retrieving them from Stripe.

Logical connections usually flow from this component’s Output (specifically the Product ID or Product Object) into other components that need to reference that specific item, such as Price creation or Customer billing modules.

Usage Example

Scenario: Creating a New Product

  1. Set Operation to create a new item.
  2. Enter a Name (e.g., “Gold Plan”).
  3. Add a Description explaining the benefits.
  4. Set Active to “True”.
  5. Run the workflow.
  6. The workflow will output the new Product ID, which you can then use to set up payment plans or send welcome emails to new customers.

Important Notes

ℹ️ Mode Behavior When you select the ‘Mode’ input, ensure you understand the difference between ‘By ID’ (for fetching one specific item) and ‘All’ (for listing many items). Using ‘All’ with a large catalog may require a Limit to prevent overwhelming your system with too many records at once.

📋 Requirement You must have a valid Stripe API Credential configured in your Nappai panel before this component can function. Without a credential, all operations will fail.

Tips and Best Practices

  • Always test with a small Limit when using the ‘All’ mode to ensure you are getting the correct data structure.
  • Use the Statement Descriptor wisely, as it appears directly on customer bank statements; keep it short and recognizable.
  • If you are setting up a physical product, remember to mark Shippable as true so Stripe knows to collect shipping information.
  • Use the output Product ID in subsequent steps rather than the product name to ensure accuracy, as names can change.

Security Considerations

  • Ensure your Stripe API Credential is kept secret and not shared.
  • Be careful when using the Delete function, as product deletions can sometimes be irreversible depending on Stripe’s current policies.
  • Validate the Limit input to avoid exceeding Stripe’s API rate limits.