@polar-sh/sdk
Advanced tools
Developer-friendly & type-safe Typescript SDK specifically catered to leverage [Polar](https://polar.sh) API.
Developer-friendly & type-safe Typescript SDK specifically catered to leverage Polar API.
[!WARNING] Starting version
>v0.6.0, we changed our SDK generator. It's not backward compatible with previous versions.
Polar API: Polar HTTP and Webhooks API
Read the docs at https://docs.polar.sh/api
The SDK can be installed with either npm, pnpm, bun or yarn package managers.
npm add @polar-sh/sdk
pnpm add @polar-sh/sdk
bun add @polar-sh/sdk
yarn add @polar-sh/sdk zod
# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.
For supported JavaScript runtimes, please consult RUNTIMES.md.
import { Polar } from "@polar-sh/sdk";
const polar = new Polar();
async function run() {
const result = await polar.endpointcheckoutCreatedPost({
data: {
createdAt: new Date("2024-11-12T14:26:42.882Z"),
modifiedAt: new Date("2023-05-28T05:08:06.235Z"),
id: "<value>",
status: "failed",
clientSecret: "<value>",
url: "https://heavy-beret.com/",
expiresAt: new Date("2022-02-25T02:26:48.460Z"),
successUrl: "https://sardonic-final.info/",
embedOrigin: "<value>",
amount: 962818,
taxAmount: 6400,
currency: "Yen",
subtotalAmount: 648726,
totalAmount: 210702,
productId: "<value>",
productPriceId: "<value>",
discountId: "<value>",
allowDiscountCodes: true,
isDiscountApplicable: false,
isFreeProductPrice: false,
isPaymentRequired: false,
isPaymentSetupRequired: false,
isPaymentFormRequired: false,
customerId: "<value>",
customerName: "<value>",
customerEmail: "Ryley_Erdman@hotmail.com",
customerIpAddress: "<value>",
customerBillingAddress: {
country: "South Africa",
},
customerTaxId: "<id>",
paymentProcessorMetadata: {},
metadata: {
"key": 18677,
"key1": 95370,
},
product: {
createdAt: new Date("2022-04-02T00:05:42.586Z"),
modifiedAt: new Date("2023-12-16T03:02:38.803Z"),
id: "<value>",
name: "<value>",
description:
"for embarrassment untidy long-term near honestly separate yet",
isRecurring: true,
isArchived: false,
organizationId: "<value>",
prices: [
{
createdAt: new Date("2024-11-19T15:59:15.588Z"),
modifiedAt: new Date("2022-11-17T00:11:23.972Z"),
id: "<value>",
isArchived: false,
productId: "<value>",
priceCurrency: "<value>",
minimumAmount: 363560,
maximumAmount: 75876,
presetAmount: 82334,
},
],
benefits: [
{
createdAt: new Date("2023-08-22T00:47:02.059Z"),
modifiedAt: new Date("2023-06-04T10:32:44.101Z"),
id: "<value>",
type: "license_keys",
description: "within jacket unless",
selectable: false,
deletable: false,
organizationId: "<value>",
},
],
medias: [
{
id: "<value>",
organizationId: "<value>",
name: "<value>",
path: "/private/var",
mimeType: "<value>",
size: 245189,
storageVersion: "<value>",
checksumEtag: "<value>",
checksumSha256Base64: "<value>",
checksumSha256Hex: "<value>",
lastModifiedAt: new Date("2022-11-03T15:00:03.276Z"),
version: "<value>",
isUploaded: false,
createdAt: new Date("2024-06-07T13:47:02.365Z"),
sizeReadable: "<value>",
publicUrl: "https://webbed-experience.name/",
},
],
},
productPrice: {
createdAt: new Date("2024-02-15T09:22:19.644Z"),
modifiedAt: new Date("2022-12-28T20:59:29.904Z"),
id: "<value>",
isArchived: false,
productId: "<value>",
priceCurrency: "<value>",
minimumAmount: 417896,
maximumAmount: 962818,
presetAmount: 6400,
recurringInterval: "month",
},
discount: {
duration: "repeating",
type: "fixed",
basisPoints: 341163,
id: "<value>",
name: "<value>",
code: "<value>",
},
subscriptionId: "<value>",
attachedCustomFields: [
{
customFieldId: "<value>",
customField: {
createdAt: new Date("2022-08-19T22:18:44.316Z"),
modifiedAt: new Date("2023-04-29T23:39:10.699Z"),
id: "<value>",
metadata: {
"key": false,
},
slug: "<value>",
name: "<value>",
organizationId: "<value>",
properties: {
options: [
{
value: "<value>",
label: "<value>",
},
],
},
},
order: 996863,
required: false,
},
{
customFieldId: "<value>",
customField: {
createdAt: new Date("2023-07-03T09:46:29.338Z"),
modifiedAt: new Date("2024-01-25T18:08:49.597Z"),
id: "<value>",
metadata: {
"key": false,
},
slug: "<value>",
name: "<value>",
organizationId: "<value>",
properties: {},
},
order: 72589,
required: true,
},
{
customFieldId: "<value>",
customField: {
createdAt: new Date("2024-07-31T13:25:31.669Z"),
modifiedAt: new Date("2022-11-12T09:40:10.044Z"),
id: "<value>",
metadata: {
"key": "<value>",
},
slug: "<value>",
name: "<value>",
organizationId: "<value>",
properties: {},
},
order: 161325,
required: true,
},
],
},
});
// Handle the result
console.log(result);
}
run();
The SDK has built-in support to validate webhook events. Here is an example with Express.js:
import express, { Request, Response } from "express";
import { validateEvent, WebhookVerificationError } from "@polar-sh/sdk/webhooks";
const app = express();
app.post("/webhook", express.raw({ type: "application/json" }), (req: Request, res: Response) => {
try {
const event = validateEvent(req.body, req.headers, process.env["POLAR_WEBHOOK_SECRET"] ?? "");
// Process the event
res.status(202).send('')
} catch (error) {
if (error instanceof WebhookVerificationError) {
res.status(403).send('')
}
throw error
}
});
All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.
To read more about standalone functions, check FUNCTIONS.md.
advertisementsGet - Get CampaignadvertisementsList - List CampaignsbenefitsCreate - Create BenefitbenefitsDelete - Delete BenefitbenefitsGet - Get BenefitbenefitsGrants - List Benefit GrantsbenefitsList - List BenefitsbenefitsUpdate - Update BenefitcheckoutLinksCreate - Create Checkout LinkcheckoutLinksDelete - Delete Checkout LinkcheckoutLinksGet - Get Checkout LinkcheckoutLinksList - List Checkout LinkscheckoutLinksUpdate - Update Checkout LinkcheckoutsCustomClientConfirm - Confirm Checkout Session from ClientcheckoutsCustomClientGet - Get Checkout Session from ClientcheckoutsCustomClientUpdate - Update Checkout Session from ClientcheckoutsCustomCreate - Create Checkout SessioncheckoutsCustomGet - Get Checkout SessioncheckoutsCustomList - List Checkout SessionscheckoutsCustomUpdate - Update Checkout SessioncustomFieldsCreate - Create Custom FieldcustomFieldsDelete - Delete Custom FieldcustomFieldsGet - Get Custom FieldcustomFieldsList - List Custom FieldscustomFieldsUpdate - Update Custom FielddiscountsCreate - Create DiscountdiscountsDelete - Delete DiscountdiscountsGet - Get DiscountdiscountsList - List DiscountsdiscountsUpdate - Update DiscountexternalOrganizationsList - List External OrganizationsfilesCreate - Create FilefilesDelete - Delete FilefilesList - List FilesfilesUpdate - Update FilefilesUploaded - Complete File UploadlicenseKeysGet - Get License KeylicenseKeysGetActivation - Get ActivationlicenseKeysList - List License KeyslicenseKeysUpdate - Update License KeymetricsGet - Get MetricsmetricsLimits - Get Metrics Limitsoauth2Authorize - Authorizeoauth2ClientsCreate - Create Clientoauth2ClientsDelete - Delete Clientoauth2ClientsGet - Get Clientoauth2ClientsList - List Clientsoauth2ClientsUpdate - Update Clientoauth2Introspect - Introspect Tokenoauth2Revoke - Revoke Tokenoauth2Token - Request Tokenoauth2Userinfo - Get User InfoordersGet - Get OrderordersInvoice - Get Order InvoiceordersList - List OrdersorganizationsCreate - Create OrganizationorganizationsGet - Get OrganizationorganizationsList - List OrganizationsorganizationsUpdate - Update OrganizationproductsCreate - Create ProductproductsGet - Get ProductproductsList - List ProductsproductsUpdate - Update ProductproductsUpdateBenefits - Update Product BenefitsrepositoriesGet - Get RepositoryrepositoriesList - List RepositoriesrepositoriesUpdate - Update RepositorysubscriptionsExport - Export SubscriptionssubscriptionsList - List SubscriptionsusersAdvertisementsCreate - Create AdvertisementusersAdvertisementsDelete - Delete AdvertisementusersAdvertisementsEnable - Enable AdvertisementusersAdvertisementsGet - Get AdvertisementusersAdvertisementsList - List AdvertisementsusersAdvertisementsUpdate - Update AdvertisementusersBenefitsGet - Get BenefitusersBenefitsList - List BenefitsusersDownloadablesGet - Get DownloadableusersDownloadablesList - List DownloadablesusersLicenseKeysActivate - Activate License KeyusersLicenseKeysDeactivate - Deactivate License KeyusersLicenseKeysGet - Get License KeyusersLicenseKeysList - List License KeysusersLicenseKeysValidate - Validate License KeyusersOrdersGet - Get OrderusersOrdersInvoice - Get Order InvoiceusersOrdersList - List OrdersusersSubscriptionsCancel - Cancel SubscriptionusersSubscriptionsGet - Get SubscriptionusersSubscriptionsList - List SubscriptionsusersSubscriptionsUpdate - Update SubscriptioncheckoutsCreatecheckoutsCustomCreate instead.checkoutsGetSome of the endpoints in this SDK support pagination. To use pagination, you
make your SDK calls as usual, but the returned response object will also be an
async iterable that can be consumed using the for await...of
syntax.
Here's an example of one such pagination call:
import { Polar } from "@polar-sh/sdk";
const polar = new Polar({
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});
async function run() {
const result = await polar.users.benefits.list({});
for await (const page of result) {
// Handle the page
console.log(page);
}
}
run();
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
import { Polar } from "@polar-sh/sdk";
const polar = new Polar({
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});
async function run() {
const result = await polar.users.benefits.list({}, {
retries: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
});
for await (const page of result) {
// Handle the page
console.log(page);
}
}
run();
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
import { Polar } from "@polar-sh/sdk";
const polar = new Polar({
retryConfig: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});
async function run() {
const result = await polar.users.benefits.list({});
for await (const page of result) {
// Handle the page
console.log(page);
}
}
run();
All SDK methods return a response object or throw an error. By default, an API error will throw a errors.SDKError.
If a HTTP request fails, an operation my also throw an error from the models/errors/httpclienterrors.ts module:
| HTTP Client Error | Description |
|---|---|
| RequestAbortedError | HTTP request was aborted by the client |
| RequestTimeoutError | HTTP request timed out due to an AbortSignal signal |
| ConnectionError | HTTP client was unable to make a request to a server |
| InvalidRequestError | Any input used to create a request is invalid |
| UnexpectedClientError | Unrecognised or unexpected error |
In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective Errors tables in SDK docs for more details on possible error types for each operation. For example, the list method may throw the following errors:
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.HTTPValidationError | 422 | application/json |
| errors.SDKError | 4XX, 5XX | */* |
import { Polar } from "@polar-sh/sdk";
import {
HTTPValidationError,
SDKValidationError,
} from "@polar-sh/sdk/models/errors";
const polar = new Polar({
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});
async function run() {
let result;
try {
result = await polar.users.benefits.list({});
for await (const page of result) {
// Handle the page
console.log(page);
}
} catch (err) {
switch (true) {
case (err instanceof SDKValidationError): {
// Validation errors can be pretty-printed
console.error(err.pretty());
// Raw value may also be inspected
console.error(err.rawValue);
return;
}
case (err instanceof HTTPValidationError): {
// Handle err.data$: HTTPValidationErrorData
console.error(err);
return;
}
default: {
throw err;
}
}
}
}
run();
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue. Additionally, a pretty() method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.
You can override the default server globally by passing a server name to the server: keyof typeof ServerList 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 names associated with the available servers:
| Name | Server |
|---|---|
production | https://api.polar.sh |
sandbox | https://sandbox-api.polar.sh |
import { Polar } from "@polar-sh/sdk";
const polar = new Polar({
server: "sandbox",
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});
async function run() {
const result = await polar.users.benefits.list({});
for await (const page of result) {
// Handle the page
console.log(page);
}
}
run();
The default server can also be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:
import { Polar } from "@polar-sh/sdk";
const polar = new Polar({
serverURL: "https://api.polar.sh",
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});
async function run() {
const result = await polar.users.benefits.list({});
for await (const page of result) {
// Handle the page
console.log(page);
}
}
run();
The TypeScript SDK makes API calls using an HTTPClient that wraps the native
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:
import { Polar } from "@polar-sh/sdk";
import { HTTPClient } from "@polar-sh/sdk/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 Polar({ httpClient });
This SDK supports the following security scheme globally:
| Name | Type | Scheme | Environment Variable |
|---|---|---|---|
accessToken | http | HTTP Bearer | POLAR_ACCESS_TOKEN |
To authenticate with the API the accessToken parameter must be set when initializing the SDK client instance. For example:
import { Polar } from "@polar-sh/sdk";
const polar = new Polar({
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});
async function run() {
const result = await polar.users.benefits.list({});
for await (const page of result) {
// Handle the page
console.log(page);
}
}
run();
You can setup your SDK to emit debug logs for SDK requests and responses.
You can pass a logger that matches console's interface as an SDK option.
[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
import { Polar } from "@polar-sh/sdk";
const sdk = new Polar({ debugLogger: console });
You can also enable a default debug logger by setting an environment variable POLAR_DEBUG to true.
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.
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.
FAQs
Developer-friendly & type-safe Typescript SDK specifically catered to leverage [Polar](https://polar.sh) API.
The npm package @polar-sh/sdk receives a total of 817 weekly downloads. As such, @polar-sh/sdk popularity was classified as not popular.
We found that @polar-sh/sdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
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.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.
Security News
Research
Socket researchers found a malicious Maven package impersonating the legitimate ‘XZ for Java’ library, introducing a backdoor for remote code execution.