The Qonversion SDK is an npm package that allows easy access to the Qonversion API in JavaScript and TypeScript projects. It is well-documented with js/ts examples, making it simpler for developers to access the functionality provided by the API without the need for a deep-dive into Qonversion's documentation.

Install qonversion-sdk using npm

npm install qonversion-sdk

Install qonversion-sdk using yarn

yarn add qonversion-sdk

import QonversionClient from "qonversion-sdk"; const qonversionClient = new QonversionClient(secretKey, projectKey); // Call the get identity function qonversionClient .getIdentity("USER ID") .then((response) => { console.log(response); }) .catch((err) => { console.log(err); });

{ "id": string; "user_id": string; }

const QonversionClient = require("qonversion-sdk").default; const qonversionClient = new QonversionClient(secretKey, projectKey); // Call the get identity function qonversionClient .getIdentity("USER ID") .then((response) => { console.log(response); }) .catch((err) => { console.log(err); });

{ "id": string; "user_id": string; }

Get a user based on their Qonversion user ID.

Parameters

• userId [required] - The Qonversion user ID.

Response

{ id: string; created: number; environment: Environment; identity_id: string; }

Create a user using a custom user ID.

Parameters

• userId [required] - The custom user ID.
• environment [required] - The environment in which the user is created.

Response

{ id: string; created: number; environment: Qonversion.Environment; }

Get a user's properties based on their Qonversion user ID.

Parameters

• userId [required] - The Qonversion user ID.

Response

[ { key: string; value: string; }, { key: string; value: string; } ]

Set a user's properties based on their Qonversion user ID.

Parameters

• userId [required] - The Qonversion user ID.
• properties [required] - The properties to set.

Response

{ savedProperties: [ { key: string; value: string; }, { key: string; value: string; } ], propertyErrors: [ { key: string; error: string; }, { key: string; error: string; } ]; }

Get a Qonversion user ID based on a custom user ID.

Parameters

• identityId [required] - The custom user ID.

Response

{ id: string; user_id: string; }

Create a new identity using a custom identity id

Parameters

• identityId [required] - The custom identity ID.
• userId [required] - The Qonversion user ID.

Response

{ id: string; user_id: string; }

Get a user's entitlements based on their Qonversion user ID.

Parameters

• userId [required] - The Qonversion user ID.

Response

{ data: [ { id: string; active: boolean; started: number; expires: number; product: { product_id: string; subscription?: { current_period_type: "normal" | "trial" | "intro"; renewal_state: "will_renew" | "canceled" | "billing_issue"; }; }; } ] }

Grant an entitlement to a user based on their Qonversion user ID.

Parameters

• userId [required] - The Qonversion user ID.
• entitlementId [required] - The entitlement ID.

No response

Revoke an entitlement from a user based on their Qonversion user ID.

Parameters

• userId [required] - The Qonversion user ID.

No response