JavaScript SDK

The API publishes a JavaScript SDK generated from its own OpenAPI specification. It covers every operation, sends the headers for you, unwraps the response envelope and turns errors into exceptions.

#Getting started in the browser

<script src="https://api.memberfy.net/sdk.js"></script>
<script>
  const api = Memberfy.createClient({ baseUrl: 'https://api.memberfy.net' });

  const session = await api.auth.login({ email, password });
  api.setToken(session.token).setCommunity(communityId);

  const me = await api.auth.getMe();
</script>

Always pass the baseUrl with https://.

#Getting started in Node

Download the file into your project and import it locally (Node 18 or newer, which already has fetch):

curl -s https://api.memberfy.net/sdk.mjs -o memberfy-sdk.mjs

import { createClient } from './memberfy-sdk.mjs';

const api = createClient({ baseUrl: 'https://api.memberfy.net' });
const session = await api.auth.login({ email: process.env.MEMBERFY_EMAIL, password: process.env.MEMBERFY_PASSWORD });
api.setToken(session.token).setCommunity(process.env.MEMBERFY_COMMUNITY_ID);

Download it again whenever you want to update.

#What it does for you

#The methods

Methods are grouped by topic (the same topics as the reference): api.auth, api.products, api.subscriptions, api.coupons, api.sectionsSpaces, api.events… The method name comes from the operation's operationId: api.products.postCommunitiesByCommunityIdProducts, api.profiles.getList, api.auth.login.

Some names still carry CommunitiesByCommunityId from when the route had the community in the path. Since October 6, 2026 no route carries the community in the path, but the names stayed, so nothing breaks in your code. The community always goes through setCommunity. See X-CommunityId.

Each endpoint's page in the reference shows its operationId.

#Parameters and body

Path and query parameters go by name; everything else becomes the body:

api.setCommunity(communityId); // the community goes in the X-CommunityId header

await api.products.putCommunitiesByCommunityIdProductsById({
  id: productId,               // goes into the path
  type: 'SUBSCRIPTION',        // body
  title: 'Student · Monthly',  // body
  price: 49,                   // body
  billingInterval: 'MONTHLY',  // body
  allowedPaymentMethods: ['PIX', 'CREDIT_CARD', 'BOLETO'],
});

You can also split them: { id, body: { … } }. Don't pass communityId in the arguments: since it's no longer a path parameter, it would go into the body. Other per-call options: headers (extra headers), query (additional query parameters) and signal (an AbortController).

For any route, there's api.request({ httpMethod, path, pathParams, queryParams, hasBody }, args).

#Handling errors

try {
  await api.coupons.postCommunitiesByCommunityIdCouponsValidate({ code: 'LAUNCH20' });
} catch (error) {
  if (error.name === 'MemberfyError') {
    console.log(error.status);  // 400
    console.log(error.errors);  // [{ param: 'code', message: 'Coupon has expired' }]
  }
}

#Client options

#Always current

The SDK is generated each time it's served, from the API's routes. Downloading it again means updating it.

#For AI

For an assistant to generate correct calls, give it the /docs.txt as well: the SDK says how to call; /docs.txt says what to send.

#Related

• Authentication
• Responses and errors
• API Reference