How to add Unlimited plan via API

Unlimited plans require a different integration flow than regular bundles. This article explains what has changed in the API and how to correctly add Unlimited plans to your product.

Why Unlimited plans work differently

Unlimited plans require additional processing time during line creation.
Because of this, they cannot be created using the standard synchronous API flow.

To support this, the API now includes:

• A way to identify Unlimited plans
• A new asynchronous line creation endpoint
• A request status endpoint to retrieve the final result

---

Step 1: Get Unlimited plans from the bundles list

To retrieve Unlimited plans, call the bundles endpoint with the async flag enabled.

Endpoint

GET /bundles

Query parameter

with_async=true

Details:

• Type: boolean
• Default: false
• When set to true, the response includes bundles that require async processing (Unlimited plans)
• Any bundle returned with this flag must be created via /line/create_async

---

Step 2: Create an Unlimited line (Async)

Unlimited plans must be created using the asynchronous endpoint.

Endpoint

POST /line/create_async

Parameters

This endpoint uses the same parameters as /line/create:

• bundle_id
• refill_mb
• refill_days
• filters
• count
• add_in_inventory

Important limitation: Currently, only 1 line per request is supported (count must be 1)

Response:

• The API immediately returns a request_id
• Line creation continues in the background

---

Step 3: Check line creation status

Use the request_id to check the status of the async request.

Endpoint

GET /request/{requestId}

Request statuses

• processing — the line is still being created
• completed — the line is ready

When the status becomes completed, the final result is available in the result field.

Important notes

• The request_id does not expire
• You should poll this endpoint until the status is completed
• The result format is identical to the /line/create response
• Usually, the request is completed within a few seconds. In rare cases, it may take up to 10 minutes. If it takes longer, contact support.

---

Typical integration flow

1. Call GET /bundles?with_async=true
2. Select an Unlimited bundle
3. Create the line using POST /line/create_async
4. Save the returned request_id
5. Poll GET /request/{requestId}
6. When status is completed, read the final result

---

Choosing the correct line creation endpoint

Use /line/create for:

• Travel or Lifetime plans bundles
• Immediate response
• Creating up to 1000 lines per request

Use /line/create_async for:

• Unlimited plan bundles
• Any other bundle marked as async
• Background processing is required
• Creating 1 line per request

If you attempt to create an async bundle using /line/create, the API will return an error instructing you to use /line/create_async.

---

Additional Information

All endpoints, parameters, and response examples are available in the updated API documentation.