Ana içeriğe geç

Subscribe to content

In this example, we demonstrate how to manage subscription-based access to content using the OneEntry API. We check if a user has an active subscription and either grant access to premium content or prompt them to subscribe.

✅ Purpose of the scenario:

  • Only users with a subscription have access to the content
  • The check is based on Orders, User.
  • Those who are not authorized or have not purchased will receive an offer to subscribe.

✅ What you need:

  • A valid PROJECT_URL and APP_TOKEN for authentication with the OneEntry API.
  • Form with marker "subscriptions", attributes "expired_date" and "subscription_time" and type "Order form"
  • Registered user

📌 Important:

  • These examples do not include error handling.
  • You can manage errors using a try-catch block or by employing a construction like await Promise.catch((error) => error).

📚 See in documentation:

📦 SDK reference:

Try it live​

Run this method interactively in the JS SDK sandbox — connect your Project URL and App Token on first visit, then open:

  • Subscribe to content — In this example, we demonstrate how to manage subscription-based access to content using the OneEntry API. We check if a user has an active subscription and either grant access to premium content or prompt them to subscribe.

Scenario​

1. Import defineOneEntry from SDK and define PROJECT_URL and APP_TOKEN​

Example:

import { defineOneEntry } from 'oneentry';

const PROJECT_URL = 'your-project-url';
const APP_TOKEN = 'your-app-token';

2. Creating an API client with defineOneEntry()​

Example:

const { Users, Orders, Pages, Payments, AuthProvider, Forms } = defineOneEntry(
  PROJECT_URL,
  {
    token: APP_TOKEN,
  },
);

3. Get form​

Example:

const form = await Forms.getFormByMarker('subscription');
console.log(form);
// expired_date - Date
// subscription_time - list
Result:
{
  "id": 6,
  "attributeSetId": 8,
  "type": "order",
  "localizeInfos": {
    "title": "Subscription",
    "titleForSite": "Subscription",
    "successMessage": "Message about successful data processing",
    "unsuccessMessage": "Message about unsuccessful data processing",
    "urlAddress": "",
    "database": "0",
    "script": "0"
  },
  "version": 21,
  "position": 1,
  "identifier": "subscription",
  "processingType": "script",
  "templateId": null,
  "attributes": [
    {
      "type": "date",
      "marker": "expired_date",
      "position": 2,
      "settings": {},
      "isVisible": true,
      "listTitles": [],
      "validators": {},
      "initialValue": null,
      "localizeInfos": {
        "title": "Expired date"
      },
      "additionalFields": {}
    },
    {
      "type": "list",
      "marker": "subscription_time",
      "position": 5,
      "settings": {},
      "isVisible": true,
      "listTitles": [
        {
          "title": "1 month",
          "value": "1",
          "extended": {
            "type": "real",
            "value": "100"
          },
          "position": 1
        },
        {
          "title": "6 months",
          "value": "6",
          "extended": {
            "type": "real",
            "value": "500"
          },
          "position": 2
        },
        {
          "title": "1 year",
          "value": "12",
          "extended": {
            "type": "real",
            "value": "999"
          },
          "position": 3
        }
      ],
      "validators": {},
      "initialValue": null,
      "localizeInfos": {
        "title": "Subscription time"
      },
      "additionalFields": {}
    }
  ],
  "total": "1",
  "moduleFormConfigs": []
}

4. Preparing data for user authorization​

Example:

const authData = [
  { marker: 'email_reg', value: 'your-email' },
  { marker: 'password_reg', value: 'your-password' },
];
Result:
[
  {
    "marker": "email_reg",
    "value": "kvasssukr.net@gmail.com"
  },
  {
    "marker": "password_reg",
    "value": "123456"
  }
]

5. Authorization and obtaining user data with AuthProvider.auth()​

Example:

const authResponse = await AuthProvider.auth('email', { authData });
console.log(authResponse);

const user = await Users.getUser();
console.log(user);
Result:
{
  "id": 39,
  "total": "1",
  "identifier": "kvasssukr.net@gmail.com",
  "authProviderIdentifier": "email",
  "formData": [
    {
      "marker": "name_reg",
      "type": "string",
      "value": "Ivan"
    },
    {
      "marker": "phone_reg",
      "type": "string",
      "value": "+10000000001"
    },
    {
      "marker": "email_notification_reg",
      "type": "string",
      "value": "test@example.com"
    }
  ],
  "formIdentifier": "reg",
  "groups": [
    1
  ],
  "state": {},
  "rating": {},
  "moduleFormConfigs": []
}

6. We get a list of user orders with Orders.getAllOrdersByMarker()​

Example:

const orders = await Orders.getAllOrdersByMarker('subscriptions');

if ('statusCode' in orders) {
  throw new Error(orders.message);
}
Result:
{
  "items": [
    {
      "id": 119,
      "storageId": 2,
      "createdDate": "2026-06-06T11:50:12.995Z",
      "statusIdentifier": "active",
      "statusLocalizeInfos": {
        "title": "Active"
      },
      "formIdentifier": "subscription",
      "formData": [
        {
          "type": "date",
          "marker": "expired_date",
          "value": {
            "fullDate": "2026-05-07T00:00:00.000Z",
            "formattedValue": "07-05-2026 00:00",
            "formatString": "DD-MM-YYYY HH:mm"
          }
        },
        {
          "type": "list",
          "marker": "subscription_time",
          "value": [
            "1"
          ]
        }
      ],
      "attributeSetIdentifier": "subscriptions",
      "paymentStrategy": "once",
      "totalSum": "400",
      "totalSumRaw": "400",
      "currency": "USD",
      "paymentAccountIdentifier": "cash",
      "paymentAccountLocalizeInfos": {
        "title": "Cash"
      },
      "products": [
        {
          "id": 15,
          "title": "Orange ball",
          "sku": null,
          "previewImage": "[]",
          "price": 400,
          "quantity": 1,
          "isGift": false
        }
      ],
      "paymentUrl": null,
      "discountConfig": {
        "orderDiscounts": [],
        "productDiscounts": [],
        "coupon": null,
        "settings": {
          "allowStacking": false,
          "maxDiscountValue": null,
          "allowGiftStacking": false,
          "maxBonusPaymentPercent": null,
          "minBonusAmount": null,
          "minOrderAmountForBonus": null,
          "giftRefundPolicy": "KEEP_GIFT"
        },
        "additionalDiscountsMarkers": [],
        "totalRaw": 400,
        "totalSumWithDiscount": 400,
        "excludedGiftProductIds": [],
        "bonus": {
          "availableBalance": 0,
          "maxBonusDiscount": 0,
          "minBonusAmount": null,
          "minOrderAmountForBonus": null,
          "bonusApplied": 0
        },
        "bonusApplied": 0,
        "totalDue": 400
      },
      "isPartial": false,
      "isCompleted": false
    }
  ],
  "total": 1
}

7. Checking for an active subscription​

Example:

const now = new Date();
const hasActiveSubscription = orders.items?.some(
  (order: any) =>
    new Date(
      order.formData.find(
        (d: { marker: string }) => d.marker === 'expired_date',
      ).value.fullDate,
    ) > now,
);

8. If the subscription is active, we provide access, otherwise we create an order and generate payment​

Example:

let content = null;
if (hasActiveSubscription) {
  // ✅ Subscription active → show content
  content = await Pages.getPageByUrl('premium_page');
  console.log('🎉 Access is open:', content);
} else {
  // ❌ No subscription → create an order and generate payment
  const body = {
    formIdentifier: 'subscription',
    paymentAccountIdentifier: 'cash',
    formData: [
      {
        type: 'date',
        marker: 'expired_date',
        value: {
          fullDate: '2026-05-07T00:00:00.000Z',
          formattedValue: '07-05-2026 00:00',
          formatString: 'DD-MM-YYYY HH:mm',
        },
      },
      {
        // A `list` field takes an array of the selected option values
        // (plain strings), not option objects. '1' = the "1 month" option.
        type: 'list',
        marker: 'subscription_time',
        value: ['1'],
      },
    ],
    products: [
      {
        productId: 15,
        quantity: 1,
      },
    ],
  };
  const order = await Orders.createOrder('subscriptions', body);

  if ('statusCode' in order) {
    throw new Error(order.message);
  }

  const payment = await Payments.createSession(order.id, 'session', false);
  console.log('💸 Proceed to pay for your subscription:', payment);
}

Final example​

// 1. Import defineOneEntry from SDK and define PROJECT_URL and APP_TOKEN
import { defineOneEntry } from 'oneentry';

const PROJECT_URL = 'your-project-url';
const APP_TOKEN = 'your-app-token';

// 2. Creating an API client with [defineOneEntry()](/docs/index/#Installation)
const { Users, Orders, Pages, Payments, AuthProvider, Forms } = defineOneEntry(
  PROJECT_URL,
  {
    token: APP_TOKEN,
  },
);

// 3. Get form
const form = await Forms.getFormByMarker('subscription');
console.log(form);
// expired_date - Date
// subscription_time - list

// 4. Preparing data for user authorization
const authData = [
  { marker: 'email_reg', value: 'your-email' },
  { marker: 'password_reg', value: 'your-password' },
];

// 5. Authorization and obtaining user data with [AuthProvider.auth()](/docs/auth-provider/auth)
const authResponse = await AuthProvider.auth('email', { authData });
console.log(authResponse);

const user = await Users.getUser();
console.log(user);

// 6. We get a list of user orders with [Orders.getAllOrdersByMarker()](/docs/orders/getAllOrdersByMarker)
const orders = await Orders.getAllOrdersByMarker('subscriptions');

if ('statusCode' in orders) {
  throw new Error(orders.message);
}

// 7. Checking for an active subscription
const now = new Date();
const hasActiveSubscription = orders.items?.some(
  (order: any) =>
    new Date(
      order.formData.find(
        (d: { marker: string }) => d.marker === 'expired_date',
      ).value.fullDate,
    ) > now,
);

// 8. If the subscription is active, we provide access, otherwise we create an order and generate payment
let content = null;
if (hasActiveSubscription) {
  // ✅ Subscription active → show content
  content = await Pages.getPageByUrl('premium_page');
  console.log('🎉 Access is open:', content);
} else {
  // ❌ No subscription → create an order and generate payment
  const body = {
    formIdentifier: 'subscription',
    paymentAccountIdentifier: 'cash',
    formData: [
      {
        type: 'date',
        marker: 'expired_date',
        value: {
          fullDate: '2026-05-07T00:00:00.000Z',
          formattedValue: '07-05-2026 00:00',
          formatString: 'DD-MM-YYYY HH:mm',
        },
      },
      {
        // A `list` field takes an array of the selected option values
        // (plain strings), not option objects. '1' = the "1 month" option.
        type: 'list',
        marker: 'subscription_time',
        value: ['1'],
      },
    ],
    products: [
      {
        productId: 15,
        quantity: 1,
      },
    ],
  };
  const order = await Orders.createOrder('subscriptions', body);

  if ('statusCode' in order) {
    throw new Error(order.message);
  }

  const payment = await Payments.createSession(order.id, 'session', false);
  console.log('💸 Proceed to pay for your subscription:', payment);
}