https://github.com/speakeasy-sdks/paddle-ts
A typescript SDK for accessing the Paddle API.
https://github.com/speakeasy-sdks/paddle-ts
api invoicing sdk tax transactions typescript
Last synced: 3 months ago
JSON representation
A typescript SDK for accessing the Paddle API.
- Host: GitHub
- URL: https://github.com/speakeasy-sdks/paddle-ts
- Owner: speakeasy-sdks
- License: mit
- Created: 2023-08-24T21:22:39.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-02T21:44:48.000Z (over 1 year ago)
- Last Synced: 2025-04-11T23:47:30.501Z (3 months ago)
- Topics: api, invoicing, sdk, tax, transactions, typescript
- Language: TypeScript
- Homepage: https://developer.paddle.com/
- Size: 1.51 MB
- Stars: 1
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Typescript SDK
One platform for tax, payments, and subscriptions
## SDK Installation
### NPM
```bash
npm add https://github.com/speakeasy-sdks/paddle-ts
```
### Yarn
```bash
yarn add https://github.com/speakeasy-sdks/paddle-ts
```
## SDK Example Usage
### Example
```typescript
import { Paddle } from "Paddle";
import {
CurrencyCode2,
CurrencyCodeChargeback,
CurrencyCodePayouts,
SchemaAction,
SchemaStatusAdjustment,
} from "Paddle/sdk/models/shared";
async function run() {
const sdk = new Paddle({
security: {
bearerAuth: "",
},
});
const result = await sdk.adjustments.create({
action: SchemaAction.Refund,
customerId: "ctm_01grnn4zta5a1mf02jjze7y2ys",
id: "adj_01gya6twkp8y0tv1e19rsgst9m",
items: [
{
id: "adjitm_01gw4rs4kex0prncwfne87ft8x",
itemId: "txnitm_01gm302t81w94gyjpjpqypkzkf",
type: AdjustmentCreateType.Full,
},
],
payoutTotals: {
chargebackFee: {
amount: "1680",
original: {
amount: "1500",
},
},
earnings: "15120",
fee: "300",
subtotal: "15000",
tax: "1500",
total: "16500",
},
reason: "string",
subscriptionId: "sub_01h04vsc0qhwtsbsxh3422wjs4",
transactionId: "string",
});
// Handle the result
console.log(result);
}
run();
```
## Available Resources and Operations
### [adjustments](docs/sdks/adjustments/README.md)
* [create](docs/sdks/adjustments/README.md#create) - Create an adjustment
* [list](docs/sdks/adjustments/README.md#list) - List adjustments
### [customers](docs/sdks/customers/README.md)
* [create](docs/sdks/customers/README.md#create) - Create a customer
* [get](docs/sdks/customers/README.md#get) - Get a customer
* [list](docs/sdks/customers/README.md#list) - List customers
* [listCreditBalances](docs/sdks/customers/README.md#listcreditbalances) - List credit balances for a customer
* [update](docs/sdks/customers/README.md#update) - Update a customer
### [addresses](docs/sdks/addresses/README.md)
* [create](docs/sdks/addresses/README.md#create) - Create an address for a customer
* [get](docs/sdks/addresses/README.md#get) - Get an address for a customer
* [list](docs/sdks/addresses/README.md#list) - List addresses for a customer
* [update](docs/sdks/addresses/README.md#update) - Update an address for a customer
### [businesses](docs/sdks/businesses/README.md)
* [create](docs/sdks/businesses/README.md#create) - Create a business for a customer
* [get](docs/sdks/businesses/README.md#get) - Get a business for a customer
* [list](docs/sdks/businesses/README.md#list) - List businesses for a customer
* [update](docs/sdks/businesses/README.md#update) - Update a business for a customer
### [discounts](docs/sdks/discounts/README.md)
* [create](docs/sdks/discounts/README.md#create) - Create a discount
* [get](docs/sdks/discounts/README.md#get) - Get a discount
* [list](docs/sdks/discounts/README.md#list) - List discounts
* [update](docs/sdks/discounts/README.md#update) - Update a discount
### [events](docs/sdks/events/README.md)
* [list](docs/sdks/events/README.md#list) - List events
* [listTypes](docs/sdks/events/README.md#listtypes) - List events types
### [invoices](docs/sdks/invoices/README.md)
* [cancel](docs/sdks/invoices/README.md#cancel) - Cancel an invoice
* [create](docs/sdks/invoices/README.md#create) - Create a draft invoice
* [get](docs/sdks/invoices/README.md#get) - Get an invoice
* [getPdf](docs/sdks/invoices/README.md#getpdf) - Get a PDF for an invoice
* [issueInvoice](docs/sdks/invoices/README.md#issueinvoice) - Issue an invoice
* [list](docs/sdks/invoices/README.md#list) - List invoices
* [update](docs/sdks/invoices/README.md#update) - Update a draft invoice
### [ipAddresses](docs/sdks/ipaddresses/README.md)
* [get](docs/sdks/ipaddresses/README.md#get) - Get Paddle IP addresses
### [notifications](docs/sdks/notifications/README.md)
* [createSetting](docs/sdks/notifications/README.md#createsetting) - Create a notification setting
* [deleteSetting](docs/sdks/notifications/README.md#deletesetting) - Delete a notification setting
* [get](docs/sdks/notifications/README.md#get) - Get a notification
* [getSetting](docs/sdks/notifications/README.md#getsetting) - Get a notification setting
* [list](docs/sdks/notifications/README.md#list) - List notifications
* [listLogs](docs/sdks/notifications/README.md#listlogs) - List logs for a notification
* [listSettings](docs/sdks/notifications/README.md#listsettings) - List notification settings
* [replay](docs/sdks/notifications/README.md#replay) - Replay a notification
* [replayBySetting](docs/sdks/notifications/README.md#replaybysetting) - Replay notifications by notification setting
* [updateSettings](docs/sdks/notifications/README.md#updatesettings) - Update a notification setting
### [prices](docs/sdks/prices/README.md)
* [create](docs/sdks/prices/README.md#create) - Create a price
* [get](docs/sdks/prices/README.md#get) - Get a price
* [list](docs/sdks/prices/README.md#list) - List prices
* [update](docs/sdks/prices/README.md#update) - Update a price
### [transactions](docs/sdks/transactions/README.md)
* [create](docs/sdks/transactions/README.md#create) - Create a transaction
* [get](docs/sdks/transactions/README.md#get) - Get a transaction
* [getInvoice](docs/sdks/transactions/README.md#getinvoice) - Get a PDF invoice for a transaction
* [list](docs/sdks/transactions/README.md#list) - List transactions
* [previewTransaction](docs/sdks/transactions/README.md#previewtransaction) - Preview a transaction
* [pricePreview](docs/sdks/transactions/README.md#pricepreview) - Preview prices
* [update](docs/sdks/transactions/README.md#update) - Update a transaction
### [products](docs/sdks/products/README.md)
* [create](docs/sdks/products/README.md#create) - Create a product
* [get](docs/sdks/products/README.md#get) - Get a product
* [list](docs/sdks/products/README.md#list) - List products
* [update](docs/sdks/products/README.md#update) - Update a product
### [subscriptions](docs/sdks/subscriptions/README.md)
* [cancel](docs/sdks/subscriptions/README.md#cancel) - Cancel a subscription
* [create](docs/sdks/subscriptions/README.md#create) - Create a one-time charge for a subscription
* [createPreview](docs/sdks/subscriptions/README.md#createpreview) - Preview one-off charge for a subscription
* [get](docs/sdks/subscriptions/README.md#get) - Get a subscription
* [getUpdatedPaymentMethodTransaction](docs/sdks/subscriptions/README.md#getupdatedpaymentmethodtransaction) - Get a transaction to update payment method
* [list](docs/sdks/subscriptions/README.md#list) - List subscriptions
* [pause](docs/sdks/subscriptions/README.md#pause) - Pause a subscription
* [previewSubscription](docs/sdks/subscriptions/README.md#previewsubscription) - Preview an update to a subscription
* [resumeSubscription](docs/sdks/subscriptions/README.md#resumesubscription) - Resume a paused subscription
* [update](docs/sdks/subscriptions/README.md#update) - Update a subscription
## Error Handling
All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
| Error Object | Status Code | Content Type |
| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- |
| errors.CreateAdjustmentResponseBody | 400 | application/json |
| errors.CreateAdjustmentAdjustmentsResponseBody | 404 | application/json |
| errors.CreateAdjustmentAdjustmentsResponseResponseBody | 409 | application/json |
| errors.CreateAdjustmentAdjustmentsResponse500ResponseBody | 500 | application/json |
| errors.SDKError | 4xx-5xx | */* |
Example
```typescript
import { Paddle } from "Paddle";
import * as errors from "Paddle/sdk/models/errors";
import {
CurrencyCode2,
CurrencyCodeChargeback,
CurrencyCodePayouts,
SchemaAction,
SchemaStatusAdjustment,
} from "Paddle/sdk/models/shared";
async function run() {
const sdk = new Paddle({
security: {
bearerAuth: "",
},
});
let result;
try {
result = await sdk.adjustments.create({
action: SchemaAction.Refund,
customerId: "ctm_01grnn4zta5a1mf02jjze7y2ys",
id: "adj_01gya6twkp8y0tv1e19rsgst9m",
items: [
{
id: "adjitm_01gw4rs4kex0prncwfne87ft8x",
itemId: "txnitm_01gm302t81w94gyjpjpqypkzkf",
type: AdjustmentCreateType.Full,
},
],
payoutTotals: {
chargebackFee: {
amount: "1680",
original: {
amount: "1500",
},
},
earnings: "15120",
fee: "300",
subtotal: "15000",
tax: "1500",
total: "16500",
},
reason: "string",
subscriptionId: "sub_01h04vsc0qhwtsbsxh3422wjs4",
transactionId: "string",
});
} catch (err) {
switch (true) {
case err instanceof errors.CreateAdjustmentResponseBody: {
console.error(err); // handle exception
return;
}
case err instanceof errors.CreateAdjustmentAdjustmentsResponseBody: {
console.error(err); // handle exception
return;
}
case err instanceof errors.CreateAdjustmentAdjustmentsResponseResponseBody: {
console.error(err); // handle exception
return;
}
case err instanceof errors.CreateAdjustmentAdjustmentsResponse500ResponseBody: {
console.error(err); // handle exception
return;
}
default: {
throw err;
}
}
}
// Handle the result
console.log(result);
}
run();
```
## Server Selection
### Select Server by Index
You can override the default server globally by passing a server index to the `serverIdx` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
| # | Server | Variables |
| - | ------ | --------- |
| 0 | `https://api.paddle.com` | None |
| 1 | `https://sandbox-api.paddle.com` | None |
```typescript
import { Paddle } from "Paddle";
import {
CurrencyCode2,
CurrencyCodeChargeback,
CurrencyCodePayouts,
SchemaAction,
SchemaStatusAdjustment,
} from "Paddle/sdk/models/shared";
async function run() {
const sdk = new Paddle({
serverIdx: 1,
security: {
bearerAuth: "",
},
});
const result = await sdk.adjustments.create({
action: SchemaAction.Refund,
customerId: "ctm_01grnn4zta5a1mf02jjze7y2ys",
id: "adj_01gya6twkp8y0tv1e19rsgst9m",
items: [
{
id: "adjitm_01gw4rs4kex0prncwfne87ft8x",
itemId: "txnitm_01gm302t81w94gyjpjpqypkzkf",
type: AdjustmentCreateType.Full,
},
],
payoutTotals: {
chargebackFee: {
amount: "1680",
original: {
amount: "1500",
},
},
earnings: "15120",
fee: "300",
subtotal: "15000",
tax: "1500",
total: "16500",
},
reason: "string",
subscriptionId: "sub_01h04vsc0qhwtsbsxh3422wjs4",
transactionId: "string",
});
// Handle the result
console.log(result);
}
run();
```
### Override Server URL Per-Client
The default server can also be overridden globally by passing a URL to the `serverURL` optional parameter when initializing the SDK client instance. For example:
```typescript
import { Paddle } from "Paddle";
import {
CurrencyCode2,
CurrencyCodeChargeback,
CurrencyCodePayouts,
SchemaAction,
SchemaStatusAdjustment,
} from "Paddle/sdk/models/shared";
async function run() {
const sdk = new Paddle({
serverURL: "https://api.paddle.com",
security: {
bearerAuth: "",
},
});
const result = await sdk.adjustments.create({
action: SchemaAction.Refund,
customerId: "ctm_01grnn4zta5a1mf02jjze7y2ys",
id: "adj_01gya6twkp8y0tv1e19rsgst9m",
items: [
{
id: "adjitm_01gw4rs4kex0prncwfne87ft8x",
itemId: "txnitm_01gm302t81w94gyjpjpqypkzkf",
type: AdjustmentCreateType.Full,
},
],
payoutTotals: {
chargebackFee: {
amount: "1680",
original: {
amount: "1500",
},
},
earnings: "15120",
fee: "300",
subtotal: "15000",
tax: "1500",
total: "16500",
},
reason: "string",
subscriptionId: "sub_01h04vsc0qhwtsbsxh3422wjs4",
transactionId: "string",
});
// Handle the result
console.log(result);
}
run();
```
## Custom HTTP Client
The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native
[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This
client is a thin wrapper around `fetch` and provides the ability to attach hooks
around the request lifecycle that can be used to modify the request or handle
errors and response.
The `HTTPClient` constructor takes an optional `fetcher` argument that can be
used to integrate a third-party HTTP client or when writing tests to mock out
the HTTP client and feed in fixtures.
The following example shows how to use the `"beforeRequest"` hook to to add a
custom header and a timeout to requests and how to use the `"requestError"` hook
to log errors:
```typescript
import { Paddle } from "Paddle";
import { HTTPClient } from "Paddle/lib/http";
const httpClient = new HTTPClient({
// fetcher takes a function that has the same signature as native `fetch`.
fetcher: (request) => {
return fetch(request);
}
});
httpClient.addHook("beforeRequest", (request) => {
const nextRequest = new Request(request, {
signal: request.signal || AbortSignal.timeout(5000);
});
nextRequest.headers.set("x-custom-header", "custom value");
return nextRequest;
});
httpClient.addHook("requestError", (error, request) => {
console.group("Request Error");
console.log("Reason:", `${error}`);
console.log("Endpoint:", `${request.method} ${request.url}`);
console.groupEnd();
});
const sdk = new Paddle({ httpClient });
```
## Authentication
### Per-Client Security Schemes
This SDK supports the following security scheme globally:
| Name | Type | Scheme |
| ------------ | ------------ | ------------ |
| `bearerAuth` | http | HTTP Bearer |
You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. For example:
```typescript
import { Paddle } from "Paddle";
import {
CurrencyCode2,
CurrencyCodeChargeback,
CurrencyCodePayouts,
SchemaAction,
SchemaStatusAdjustment,
} from "Paddle/sdk/models/shared";
async function run() {
const sdk = new Paddle({
security: {
bearerAuth: "",
},
});
const result = await sdk.adjustments.create({
action: SchemaAction.Refund,
customerId: "ctm_01grnn4zta5a1mf02jjze7y2ys",
id: "adj_01gya6twkp8y0tv1e19rsgst9m",
items: [
{
id: "adjitm_01gw4rs4kex0prncwfne87ft8x",
itemId: "txnitm_01gm302t81w94gyjpjpqypkzkf",
type: AdjustmentCreateType.Full,
},
],
payoutTotals: {
chargebackFee: {
amount: "1680",
original: {
amount: "1500",
},
},
earnings: "15120",
fee: "300",
subtotal: "15000",
tax: "1500",
total: "16500",
},
reason: "string",
subscriptionId: "sub_01h04vsc0qhwtsbsxh3422wjs4",
transactionId: "string",
});
// Handle the result
console.log(result);
}
run();
```
## Requirements
For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
### Maturity
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
looking for the latest version.
### Contributions
While we value open-source contributions to this SDK, this library is generated programmatically.
Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!
### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)