POST
/
api
/
subscription
curl --request POST \
  --url https://events.newscatcherapi.xyz/api/subscription \
  --header 'x-api-token: <api-key>'
{
  "active": true,
  "calls_per_seconds": 123,
  "plan_name": "<string>",
  "usage_assigned_calls": 123,
  "usage_remaining_calls": 123,
  "additional_info": {}
}

Authorizations

​
x-api-token
string
header
required

API Key to authenticate requests.

To access the API, include your API key in the x-api-token header. To obtain your API key, complete the form or contact us directly.

Response

200
application/json
A successful response containing information about the current subscription plan.

Response model for a successful Subscription request retrieving plan information. Response field behavior:

  • Required fields are guaranteed to be present and non-null.
  • Optional fields may be null/undefined if the data couldn't be extracted during processing.
​
active
boolean
required

Indicates whether the subscription is currently active.

​
calls_per_seconds
integer
required

The number of API calls allowed per second under the current plan.

​
plan_name
string
required

The name of the subscription plan.

​
usage_assigned_calls
integer
required

The total number of API calls assigned to the current subscription.

​
usage_remaining_calls
integer
required

The number of API calls remaining for the current subscription period.

​
additional_info
object
required

Additional plan-specific information and features.

Was this page helpful?

Suggest editsRaise issue
Retrieve subscription plan information