@streamsdk/typescript · Official Stream SDK for TypeScript

Official Node.js/TypeScript SDK for Stream API


---

📚 Table of Contents

- Overview
- Installation
- Quick Start
- SDK Features
- Usage
- Examples
- Express.js Integration
- API Documentation
- Error Handling
- Contributing
- Support
- License

---

Overview

The Stream SDK provides a complete TypeScript/JavaScript interface to the Stream payment platform. Process payments, manage subscriptions, create invoices, and handle customer data with full type safety and modern JavaScript features.

Key Features:

- 🔐 Secure API Key authentication
- 👥 Customer (Consumer) management
- 📦 Product catalog management
- 💳 Payment link creation
- 🔄 Subscription handling
- 🧾 Invoice generation
- 🎟️ Coupon & discount management
- 📝 Full TypeScript support
- ⚡ ES Modules and CommonJS compatible

---

Installation

``bash
npm install @streamsdk/typescript
`

Or install from GitHub:

`bash
npm install github:streampayments/streamsdk-typescript#v1.0.0
`

$3

`json
{
"dependencies": {
"@streamsdk/typescript": "^1.0.0"
}
}
`

---

Quick Start

`typescript
import StreamSDK from "@streamsdk/typescript";

// Initialize the SDK
const client = StreamSDK.init(process.env.STREAM_API_KEY!);

// Create a payment link
const result = await client.createSimplePaymentLink({
name: "Monthly Subscription",
amount: 99.99,
consumer: {
email: "customer@example.com",
name: "Ahmad Ali",
phone: "+966501234567",
},
product: {
name: "Premium Plan",
price: 99.99,
},
successRedirectUrl: "https://yourapp.com/success",
failureRedirectUrl: "https://yourapp.com/failure",
});

console.log("Payment URL:", result.paymentUrl);
`

---

SDK Features

$3

| Feature | Description |
| ------------------ | ------------------------------------------ |
| Authentication | API Key and Bearer Token support |
| Consumers | Create, update, list, and delete customers |
| Products | Manage your product catalog |
| Payment Links | Generate secure payment links |
| Subscriptions | Handle recurring payments |
| Invoices | Create and manage invoices |
| Coupons | Discount and promotion management |
| Webhooks | Real-time event notifications |

$3

- ✅ Single or multiple products per payment
- ✅ Guest checkout (no consumer required)
- ✅ Smart resource matching (automatic deduplication)
- ✅ SAR currency (default)
- ✅ Custom metadata support
- ✅ Full TypeScript type definitions
- ✅ ESM and CommonJS support

---

Usage

For detailed usage examples and API documentation, please refer to the API Documentation section below.

$3

Initialize the SDK with your API key:

`typescript
import StreamSDK from "@streamsdk/typescript";

const client = StreamSDK.init(process.env.STREAM_API_KEY!);
`

For more authentication options and detailed examples for each resource, see the documentation links in the Available Resources and Operations section.

---

Examples

Explore complete TypeScript SDK examples in the examples directory:

- basic.mjs - Basic SDK usage
- comprehensive.mjs - Advanced features
- multiple-products.mjs - Multiple products guide

View All Examples →

For Express.js examples, see streamsdk-express

---

Express.js Integration

For Express.js applications, we provide a separate adapter package with declarative handlers for checkout and webhooks:

streamsdk-express →

---

API Documentation

$3

> Click on each resource above to see detailed documentation with code examples, parameters, and response types.

---

Error Handling

The SDK throws errors for failed requests:

`typescript
try {
const consumer = await client.createConsumer({
name: "Ahmad Ali",
email: "invalid-email",
});
} catch (error) {
console.error("Error creating consumer:", error.message);
console.error("Status:", error.status);
console.error("Response:", error.response);
}
`

---

Contributing

We welcome contributions! Please see our Contributing Guide for details.

$3

`bash


Clone the repository

---

Support

$3

- API Documentation
- OpenAPI Specification
- Examples
- Express Adapter
- Multiple Products Guide
- Framework Support

$3

- 📧 Email: support@streampay.sa
- 🐛 Issues: GitHub Issues
- 💬 Discussions: GitHub Discussions

---

License

MIT License - see LICENSE for details.

---