🚀. Socket Launch Week Day 2:Introducing Manifest Alerts.Learn more
Sign In

productize

Package Overview
Dependencies
Maintainers
1
Versions
6
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

productize

Create Stripe products and prices with generated TypeScript constants from a simple JSON file

latest
npmnpm
Version
1.0.5
Version published
Maintainers
1
Created
Source

Productize

Productize is a tool that automates the process of creating and syncing Stripe products and prices from a simple JSON config. It also generates typesafe product and price references for your JS/TS projects.

Installation

bun add -g productize
# or
npm install -g productize

Usage

CLI

You can use this tool directly from the command line:

# Set stripe key
export STRIPE_SECRET_KEY=sk_your_stripe_secret_key

# Add productize cli tool
bun add -g productize

# Run the CLI
productize [input-file] [output-file]

Or run one-shot with bunx:

bunx productize [input-file] [output-file]

Arguments:

  • input-file: Path to your JSON file with product data (default: products.json)
  • output-file: Path where the TypeScript file will be generated (default: products.ts)

Programmatic Usage

You can also use this tool programmatically in your Node.js/Bun/Deno projects:

import { syncStripeProductConfig } from 'productize';

await syncStripeProductConfig({
  stripeSecretKey: 'your_stripe_secret_key',
  inputFilePath: 'path/to/your/products.json',
  outputFilePath: 'path/to/output/products.ts'
});
console.log('Stripe products synced successfully.');

Or without top-level await / import:

require('productize').syncStripeProductConfig({
  stripeSecretKey: 'your_stripe_secret_key',
  inputFilePath: 'path/to/your/products.json',
  outputFilePath: 'path/to/output/products.ts'
}).then(() => console.log('Stripe products synced successfully'));

Input File Format

Your products input JSON file should have the following structure:

[
  {
    "name": "Basic Plan",
    "description": "Basic features for individuals",
    "prices": [
      {
        "name": "Monthly",
        "unit_amount": 999,
        "currency": "usd",
        "recurring": {
          "interval": "month"
        }
      },
      {
        "name": "Yearly",
        "unit_amount": 9990,
        "currency": "usd",
        "recurring": {
          "interval": "year"
        }
      }
    ]
  },
  // Add more products as needed
]

Output

The tool will generate a TypeScript file with SNAKE_CASE constants for your Stripe products and prices:

products.ts

// This file is auto-generated. Do not edit manually.
export const STRIPE_PRODUCTS = {
  BASIC_PLAN: {
    ID: 'prod_Qc1gQZpb89FTYN',
    PRICES: {
      MONTHLY: {
        ID: 'price_1PkndDBUsi1mfR0LbGg1Nwtk',
        AMOUNT: '$9.99 USD',
      },
      YEARLY: {
        ID: 'price_1PkndEBUsi1mfR0L3qMxfCMh',
        AMOUNT: '$99.90 USD',
      },
    },
  },
};

This can be used to reference Stripe products and prices in your codebase in a typesafe way, for example:

import Stripe from 'stripe';
import { STRIPE_PRODUCTS } from './products';

const stripe = new Stripe(process.env.STRIPE_SECRET_KEY);

stripe.checkout.sessions.create({
  mode: 'subscription',
  product: STRIPE_PRODUCTS.BASIC_PLAN.ID,
  price: STRIPE_PRODUCTS.BASIC_PLAN.PRICES.ID,
});

Best Practices

  • Keep the source products.json and auto-generated TypeScript file in version control.
  • Run this tool in your CI/CD pipeline or during deployment to ensure Stripe product IDs and attributes are up-to-date.
  • Use live/test-mode-specific STRIPE_SECRET_KEY environment variables to target test and live mode Stripe data.

Contributing

Issues, pull requests, and forks are welcome, but this free side project may become unmaintained at any time.

License

MIT

Keywords

stripe

FAQs

Package last updated on 06 Aug 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts