@stigg/bulk-import

Bulk import customers to Stigg

After creating your product catalog in Stigg, you can import your existing customers into stigg.

This tool will manage the import process:

• It reads the list of customers to import from a JSON file containing.
• It's idempotent - feel safe to re-run it.

Usage

Prepare input json file

Create a file input.json that contains all the customers that should be imported into Stigg.

The file should be in the following schema:

{
  "customers": [
    {
      "customerId": "lorem-ipsum",
      "email": "[e-mail]", // optional
      "name": "[e-mail]", // optional
      "billingId": "cus_MvdQq1bVD1BQHe", // optional - if an existing customer in Stripe
      "subscription": {
        "planId": "plan-local-env-p-1",
        "billingPeriod": "MONTHLY", // optional - requried for paid plan
        "unitQuantity": 5, // optional - required for per-unit paid plan
        "startDate": "2022-01-01T00:00:00.000Z" // optional - used for backdating
      },
      "featuresUsage": { // optional - set usage for features
        "feature-seats": 9 // key is feature id, value is the current usage
      }
    }
    // ...
  ]
}

Execute bulk import

• Obtain Server API key from https://app.stigg.io/account/settings
• Run the following command (replace the <SERVER-API-KEY>):

  npx @stigg/bulk-import --input-file input.json --api-key '<SERVER-API-KEY>'
  

• During the import process there will be a progress bar.
• At the end of the process a summary will be displayed.