import stripe using node js + typescript

Question

I need to import stripe in to my application

First i installed stripe npm package

npm install stripe --save

Stripe documentation says that secret key should be set before connect the api.

In Node it likes this

var stripe = require('stripe')(' your stripe API key ');

I need to convert it to typescript

I tried following way . but it didnt work for me

import * as stripe from 'stripe';
stripe('sk_test_...')

if some can help me to solve this problem it will great help to me to continue my project without delay.

Thank you

Have you checked http://stackoverflow.com/questions/18378503/importing-node-modules-with-typescript?rq=1 ? — bug-a-lot, Feb 02 '17 at 14:18

score 64 · Answer 1 · edited Jun 03 '21 at 18:21

64

You can refer to the repo on GitHub: https://github.com/stripe/stripe-node

import Stripe from 'stripe';

const stripe = new Stripe('sk_test_...', {
  apiVersion: '2020-08-27',
});

const createCustomer = async () => {
  const params: Stripe.CustomerCreateParams = {
    description: 'test customer',
  };

  const customer: Stripe.Customer = await stripe.customers.create(params);

  console.log(customer.id);
};
createCustomer();

edited Jun 03 '21 at 18:21

Joe Previte

114
1
16

answered Mar 08 '20 at 15:08

Tan Nguyen

947
7
8

This worked like a charm! Note: the API version needs to be updated to "2020-08-27". Submitted an edit. – Joe Previte Jun 03 '21 at 14:57
Now the API version is updated to "2022-08-01" – Adam D Oct 12 '22 at 18:21
3

It's now "2022-11-15". Typescript will steer you to the right value. – ZCaceres Dec 29 '22 at 19:24

score 31 · Answer 2 · answered Jan 12 '20 at 02:16

31

As of stripe 8.0.1 the package has its own typeing so it is not necessary to install additional types. Just import it like this:

import Stripe from 'stripe';

answered Jan 12 '20 at 02:16

David Dehghan

22,159
10
107
95

8eecf0d2 · Answer 3 · 2020-01-14T20:12:26.600

Update: The solution below is outdated and for those using stripe@8.0.1 or greater the answer from David Dehghan should be used.

As britzkopf said, stripe don't provide their own definitions yet (and probably never will), but you can use the type definitions from @types/stripe.

npm install stripe @types/stripe

And then import and construct the Stripe class as follows.

import * as Stripe from 'stripe';
const stripe = new Stripe('xxx_xxx_xxx');

If you want finer grained imports for some reason you can use this (somewhat hacky) approach instead.

import { resources } from 'stripe';
const stripeData = require('stripe')('xxx_xxx_xxx');
const customers = new resources.Customers(stripeData, null);

score 10 · Answer 4 · answered Nov 09 '18 at 13:40

I had the same problem and the solution provided did not work for me:

import * as Stripe from 'stripe';
const stripe = new Stripe('xxx_xxx_xxx');

Using this approach, I got this error

[ts] Cannot use 'new' with an expression whose type lacks a call or construct signature. stripe.ts(1, 1): Type originates at this import. A namespace-style import cannot be called or constructed, and will cause a failure at runtime. Consider using a default import or import require here instead. (alias) class Stripe (alias) namespace Stripe import Stripe

I got it working using "allowSyntheticDefaultImports": true in tsconfig.json With this compile option, the following is valid in TypeScript:

import Stripe from "stripe";

const secret = process.env.STRIPE_SECRET!;
export const stripe = new Stripe(secret);

This worked for me, thanks! `"allowSyntheticDefaultImports: true"` was the default in my case so I did not need to change anything. — damix911, Nov 09 '19 at 09:30

score 8 · Answer 5 · answered Feb 22 '17 at 01:45

8

It's a feature request. Go give it another thumbs up.

answered Feb 22 '17 at 01:45

britzkopf

168
1
8

score 1 · Answer 6 · answered May 07 '22 at 00:36

1

From the official documentation:

import Stripe from 'stripe';
const stripe = new Stripe('sk_test_...');

answered May 07 '22 at 00:36

chris

2,490
4
32
56

import stripe using node js + typescript

6 Answers6

Linked