# Add a Subscriptions tab in user settings (`aspiring_hypotenuse_ior/add-subscriptions-tab-in-user-settings`) Actor

Add a Subscriptions tab in user settings, a repetitive task that could be automated with a tool.

- **URL**: https://apify.com/aspiring\_hypotenuse\_ior/add-subscriptions-tab-in-user-settings.md
- **Developed by:** [Lore Nest](https://apify.com/aspiring_hypotenuse_ior) (community)
- **Categories:** Developer tools
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $3.00 / 1,000 results

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).

# README

## Add a Subscriptions tab in user settings

Add a Subscriptions tab in user settings, a repetitive task that could be automated with a tool.

This Actor automates the generation of a "Subscriptions" tab configuration for a user settings interface, transforming raw subscription records into a structured, UI-ready payload. Instead of manually formatting subscription data each time a settings panel needs to be rendered, the tool accepts a JSON payload and returns a normalized configuration object containing tab metadata, formatted subscription items, and component props ready to be consumed by a frontend.

### Use Cases

- **Settings UI bootstrapping**: Quickly produce a complete tab configuration object from a list of subscription records (id, name, status, next\_billing) so a frontend component can render without extra data wrangling.
- **Active subscription counting for headers**: Generate a tab header summary by counting only subscriptions whose status equals `"active"`, useful for showing badges like "3 active subscriptions" on the tab.
- **Display name normalization**: Convert raw plan names into uppercase display labels and capitalize status fields (e.g., `"premium plan"` → `"PREMIUM PLAN"`, `"active"` → `"Active"`) for consistent UI presentation.
- **Empty state handling**: Detect when the subscriptions array is empty and include an `"empty_state_message"` field (`"No subscriptions found."`) in the component props, allowing the UI to render a fallback when a user has no subscriptions.
- **Theme and billing history toggling**: Pass through UI preferences such as `theme` and `show_billing_history` from the input into the resulting `component_props.settings`, so a settings panel can be rendered with the correct visual configuration per user.

### How It Works

The Actor reads three top-level keys from the input payload: `user_id`, `subscriptions`, and `ui_config`. It iterates over each subscription record and maps it to a frontend-friendly shape with `display_name` (uppercased), `status_label` (capitalized), `next_date`, and `internal_id`. It then counts how many subscriptions have a status of `"active"` to populate the tab's metadata summary. Finally, it assembles a result object containing the `tab_id`, `tab_title`, metadata block, and `component_props` (which bundle the formatted items, the user's UI settings, and an optional empty-state message), returning the complete configuration for downstream rendering. If the payload contains a `dry_run` flag, the function short-circuits and returns a text summary instead of the full config object.

### Usage on Apify

Run it directly from the Apify Console ("Start"/"Try for free"), or call it via the API:

```
POST https://api.apify.com/v2/acts/add-subscriptions-tab-in-user-settings/run-sync-get-dataset-items?token=<YOUR_APIFY_TOKEN>
Content-Type: application/json

{}
```

### Pricing

Pay-per-event, billed automatically by Apify -- no separate account or payment step:

- Actor start: $0.00005 per GB of memory (minimum one event per run)
- Result: $0.005 per item returned -- this is the primary, usage-based charge

Also independently available at $0.0100 USDC (Base) per call via the x402 payment protocol (`POST /tools/add-subscriptions-tab-in-user-settings`) for callers outside the Apify platform.

### Example output

Real output captured from this tool's own build-time smoke test (input above):

```json
{
  "tab_id": "subscriptions_tab",
  "tab_title": "Subscriptions",
  "metadata": {
    "user_id": "unknown",
    "active_subscriptions_count": 0,
    "generated_at": "automated_task"
  },
  "component_props": {
    "items": [],
    "settings": {},
    "empty_state_message": "No subscriptions found."
  }
}
```

# Actor input Schema

## `dry_run` (type: `string`):

Real parameter read as payload\['dry\_run'] in this tool's own generated code.

## `subscriptions` (type: `string`):

Real parameter read as payload\['subscriptions'] in this tool's own generated code.

## `ui_config` (type: `string`):

Real parameter read as payload\['ui\_config'] in this tool's own generated code.

## `user_id` (type: `string`):

Real parameter read as payload\['user\_id'] in this tool's own generated code.

## Actor input object example

```json
{
  "user_id": "unknown"
}
```

# Actor output Schema

## `output` (type: `string`):

Real dataset items pushed via Actor.push\_data() in src/main.py -- each item is exactly the dict this tool's own run() returns. This tool's own real, build-time-captured output had these top-level fields: component\_props, metadata, tab\_id, tab\_title.

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {};

// Run the Actor and wait for it to finish
const run = await client.actor("aspiring_hypotenuse_ior/add-subscriptions-tab-in-user-settings").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {}

# Run the Actor and wait for it to finish
run = client.actor("aspiring_hypotenuse_ior/add-subscriptions-tab-in-user-settings").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{}' |
apify call aspiring_hypotenuse_ior/add-subscriptions-tab-in-user-settings --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,aspiring_hypotenuse_ior/add-subscriptions-tab-in-user-settings"
        }
    }
}

```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/dsM0JmeBieDbjvkQw/builds/fwaYCPqLw3uAvTaes/openapi.json