Retrieve plan

Retrieve a single plan by id. site_id is supplied as a query parameter and plan_id in the request body; the plan is returned only when its product belongs to the site.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Fast, globally cached

This endpoint is served from a global cache, so responses are fast and low-latency worldwide (typically well under 100 ms).

Data freshness:

  • When you update a plan, the change is stored immediately.
  • Caches refresh on a short cycle, so an update can take up to 5 minutes to appear everywhere.
  • Users in the same region always see identical data; all regions converge on the latest data within the refresh window.

Retrieve a plan by ID.

Returns the full plan resource including product details, paywall configuration, and address requirements. The plan must belong to a product associated with the specified site. Both POST and GET are accepted for this endpoint.

const response = await fetch("https://www.pelcro.com/api/v1/sdk/plan?site_id=1232&plan_id=50", {
  method: "POST",
  headers: {
    "Accept": "application/json"
  }
});

const data = await response.json();
$response = Http::post('https://www.pelcro.com/api/v1/sdk/plan', [
    'site_id' => 1232,
    'plan_id' => 50,
]);

$data = $response->json();
Query Params
int32
required

The unique identifier of the site associated with your account.

string
enum
Defaults to en

Optional. Two-letter ISO 639-1 language code used to localize response messages. Supported values: en, fr, it, ko, es, de. Defaults to en; an unsupported value falls back to en.

Allowed:
Body Params
int32
required

The unique identifier of the plan

Responses

Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json