PRpredictleads
Api Subscription

Get API subscription information

Changed on

Returns the current subscription status along with monthly credit limits and usage details.

get/api_subscription

Request

  • Base URL
    https://predictleads.com/api/v3
  • Auth
    • API key in header X-API-KEY and API key in header X-API-TOKEN
    • or HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: https://oauth.predictleads.com/token

Response

Request was successfully processed.

Example response

{
  "data": [
    {
      "id": "ea20b0c1-3427-4004-91e6-59a27be0c9ed",
      "type": "api_subscription",
      "attributes": {
        "status": "active",
        "display_name": "HubSpot enrichment",
        "monthly_credits_quota": 100,
        "monthly_credits_used": 42
      }
    }
  ],
  "included": [],
  "meta": {
    "schema_version": "3.1"
  }
}

Changes

  • ccb9fec6a710Revision changes
    • warning

      added the new expired enum value to the /// response property for the response status

    • info

      added the required property /// to the response with the status

  • 113413aee4a2Revision changes
    • info

      api operation id api_subscription removed and replaced with get_api_v3_api_subscription