Get all premiums Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://apidocs.plannrcrm.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
"PlannrCRM MCP server": {
  "url": "https://apidocs.plannrcrm.com/mcp"
}
Close
GET /api/v1/plans/{plan_uuid}/premiums
Personal access token & O auth2

Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • plan_uuid string Required

Query parameters

  • include string

    Comma separated list of relationships to include in the response. Valid relationships are [created_by,plan,transferred_from_plan]

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • filter[transfer_type] string

    Filter by comma separated list of transfer type values.

  • filter[date_advice_given_after] string

    date Filter by date advice given after.

  • filter[date_advice_given_before] string

    date Filter by date advice given before.

  • filter[amount_from] string

    Filter by premium amount from in pennies.

  • filter[amount_to] string

    Filter by premium amount to in pennies.

  • filter[frequency] string

    Filter by comma separated list of frequency values.

  • filter[recurring] boolean

    Filter by recurring premiums when true, or non recurring premiums when false.

  • filter[source] string

    Filter by comma separated list of source of premium values.

  • filter[payment_method] string

    Filter by comma separated list of payment method values.

  • filter[start_date_after] string

    date Filter by start date after.

  • filter[start_date_before] string

    date Filter by start date before.

  • filter[end_date_after] string

    date Filter by end date after.

  • filter[end_date_before] string

    date Filter by end date before.

  • filter[start_date] string

    date Filter by start date. This supports operators.

  • filter[end_date] string

    date Filter by end date. This supports operators.

  • sort string

    Field to sort by. Valid fields are [created_at, updated_at, date_advice_given, premium, start_date, end_date]. Negative sign to denote DESC. Defaults to '-start_date'.

  • per_page integer

    Number of results to return with pagination (Default 15. Max 500).

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • data array[object]
      Hide data attribute Show data attribute object
      • message string
GET /api/v1/plans/{plan_uuid}/premiums 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/plans/6ff8f7f6-1eb3-3525-be4a-3932c805afed/premiums' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "message": "Plan is being deleted."
    }
  ]
}