Get all premiums

GET /api/v1/plans/{plan_uuid}/premiums

Query parameters

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
GET /api/v1/plans/{plan_uuid}/premiums
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/plans/plan_uuid/premiums' \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
{
  "data": [
    {
      "plan": {
        "name": "Johns ISA",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "cash_account",
        "uuid": "9f04e29e-43b0-49fb-be9d-5579f7448b2d",
        "wrap": "App\\Http\\Resources\\Plans\\PlanResource",
        "cases": "App\\Http\\Resources\\CasesResource",
        "value": {
          "amount": {
            "example": "4000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "currency": {
            "example": "GBP",
            "description": "Currency of the money"
          },
          "formatted": {
            "example": "£40.00",
            "description": "Money amount formatted with currency"
          }
        },
        "claims": "App\\Http\\Resources\\Plans\\ClaimResource",
        "client": "App\\Http\\Resources\\AccountResource",
        "covers": "App\\Http\\Resources\\Plans\\CoverResource",
        "seller": "App\\Http\\Resources\\AccountResource",
        "status": "inactive",
        "accounts": "App\\Http\\Resources\\AccountResource",
        "on_panel": true,
        "provider": "App\\Http\\Resources\\Plans\\ProviderResource",
        "sub_type": "lifetime isa",
        "opened_at": "2025-04-02T13:27:57+01:00",
        "valued_at": "2025-04-02T13:27:57+01:00",
        "created_at": "2025-04-02T13:27:57+01:00",
        "statistics": {
          "recent_growth": 100
        },
        "updated_at": "2025-04-02T13:27:57+01:00",
        "advice_area": "non_investment_insurance",
        "inactive_at": "2025-04-02T13:27:57+01:00",
        "review_date": "2024-04-02",
        "linked_plans": "App\\Http\\Resources\\Plans\\PlanResource",
        "main_account": "App\\Http\\Resources\\Plans\\SubAccountResource",
        "sub_accounts": "App\\Http\\Resources\\Plans\\SubAccountResource",
        "under_advice": true,
        "abstract_type": "asset",
        "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
        "is_wrap_child": false,
        "linked_owners": "App\\Http\\Resources\\AccountResource",
        "policy_number": "AVIVA-123",
        "show_on_joint": true,
        "wrap_children": "App\\Http\\Resources\\Plans\\PlanResource",
        "can_be_deleted": "false",
        "total_benefits": {
          "critical_illness": {
            "amount": {
              "example": "15000000",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "currency": {
              "example": "GBP",
              "description": "Currency of the money"
            },
            "formatted": {
              "example": "£150,000.00",
              "description": "Money amount formatted with currency"
            }
          },
          "family_income_benefit": {
            "amount": {
              "example": "10000000",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "currency": {
              "example": "GBP",
              "description": "Currency of the money"
            },
            "formatted": {
              "example": "£100,000.00",
              "description": "Money amount formatted with currency"
            }
          }
        },
        "inactive_reason": "claimed",
        "is_group_scheme": false,
        "is_wrap_product": false,
        "latest_valuations": "App\\Http\\Resources\\Plans\\ValuationResource",
        "proposal_reference": "AB123456",
        "agency_in_your_name": true,
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "is_sub_group_scheme": false,
        "total_benefit_amount": {
          "amount": {
            "example": "25000000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "currency": {
            "example": "GBP",
            "description": "Currency of the money"
          },
          "formatted": {
            "example": "£250,000.00",
            "description": "Money amount formatted with currency"
          }
        },
        "is_group_scheme_member": false,
        "originally_sold_by_firm": true,
        "agency_in_your_name_from": "2024-04-02",
        "contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
        "visible_on_client_portal": true,
        "include_in_client_valuation": true
      },
      "uuid": "93950a2a-0679-46f5-8efa-0a6bd36598bd",
      "amount": 74584,
      "source": "employee",
      "details": "Extra premium details",
      "premium": 74584,
      "end_date": "2027-04-02",
      "frequency": "weekly",
      "created_at": "2025-04-02T13:27:57+01:00",
      "created_by": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "10b2a362-02a5-4664-bfc0-b15a74fde1b9",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2025-04-02T13:27:57+01:00",
        "first_name": "Gareth",
        "updated_at": "2025-04-02T13:27:57+01:00",
        "with_login": true,
        "inactive_at": "2025-04-02",
        "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
        "introduced_by": "App\\Http\\Resources\\AccountResource",
        "primary_email": "App\\Http\\Resources\\ContactDetailResource",
        "can_be_deleted": "false",
        "assigned_adviser": "App\\Http\\Resources\\AccountResource",
        "next_review_date": "2025-04-02T13:27:57+01:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2025-04-02T13:27:57+01:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "joint_account_circle": "App\\Http\\Resources\\CircleResource",
        "ownership_percentage": 100,
        "previous_review_date": "2025-04-02T13:27:57+01:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2025-04-02T13:27:57+01:00"
      },
      "percentage": 5.5,
      "start_date": "2025-02-16",
      "updated_at": "2025-04-02T13:27:57+01:00",
      "transfer_type": "transfer",
      "payment_method": "direct_debit",
      "premium_monthly": 298336,
      "premium_annually": 3580032,
      "date_advice_given": "2024-10-10",
      "pensionable_salary": 10000000,
      "total_premium_to_date": 74584,
      "transferred_from_plan": {
        "name": "Johns ISA",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "cash_account",
        "uuid": "06fb7dec-d45e-462d-a880-621ec4b3e060",
        "wrap": "App\\Http\\Resources\\Plans\\PlanResource",
        "cases": "App\\Http\\Resources\\CasesResource",
        "value": {
          "amount": {
            "example": "4000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "currency": {
            "example": "GBP",
            "description": "Currency of the money"
          },
          "formatted": {
            "example": "£40.00",
            "description": "Money amount formatted with currency"
          }
        },
        "claims": "App\\Http\\Resources\\Plans\\ClaimResource",
        "client": "App\\Http\\Resources\\AccountResource",
        "covers": "App\\Http\\Resources\\Plans\\CoverResource",
        "seller": "App\\Http\\Resources\\AccountResource",
        "status": "inactive",
        "accounts": "App\\Http\\Resources\\AccountResource",
        "on_panel": true,
        "provider": "App\\Http\\Resources\\Plans\\ProviderResource",
        "sub_type": "lifetime isa",
        "opened_at": "2025-04-02T13:27:57+01:00",
        "valued_at": "2025-04-02T13:27:57+01:00",
        "created_at": "2025-04-02T13:27:57+01:00",
        "statistics": {
          "recent_growth": 100
        },
        "updated_at": "2025-04-02T13:27:57+01:00",
        "advice_area": "non_investment_insurance",
        "inactive_at": "2025-04-02T13:27:57+01:00",
        "review_date": "2024-04-02",
        "linked_plans": "App\\Http\\Resources\\Plans\\PlanResource",
        "main_account": "App\\Http\\Resources\\Plans\\SubAccountResource",
        "sub_accounts": "App\\Http\\Resources\\Plans\\SubAccountResource",
        "under_advice": true,
        "abstract_type": "asset",
        "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
        "is_wrap_child": false,
        "linked_owners": "App\\Http\\Resources\\AccountResource",
        "policy_number": "AVIVA-123",
        "show_on_joint": true,
        "wrap_children": "App\\Http\\Resources\\Plans\\PlanResource",
        "can_be_deleted": "false",
        "total_benefits": {
          "critical_illness": {
            "amount": {
              "example": "15000000",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "currency": {
              "example": "GBP",
              "description": "Currency of the money"
            },
            "formatted": {
              "example": "£150,000.00",
              "description": "Money amount formatted with currency"
            }
          },
          "family_income_benefit": {
            "amount": {
              "example": "10000000",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "currency": {
              "example": "GBP",
              "description": "Currency of the money"
            },
            "formatted": {
              "example": "£100,000.00",
              "description": "Money amount formatted with currency"
            }
          }
        },
        "inactive_reason": "claimed",
        "is_group_scheme": false,
        "is_wrap_product": false,
        "latest_valuations": "App\\Http\\Resources\\Plans\\ValuationResource",
        "proposal_reference": "AB123456",
        "agency_in_your_name": true,
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "is_sub_group_scheme": false,
        "total_benefit_amount": {
          "amount": {
            "example": "25000000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "currency": {
            "example": "GBP",
            "description": "Currency of the money"
          },
          "formatted": {
            "example": "£250,000.00",
            "description": "Money amount formatted with currency"
          }
        },
        "is_group_scheme_member": false,
        "originally_sold_by_firm": true,
        "agency_in_your_name_from": "2024-04-02",
        "contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
        "visible_on_client_portal": true,
        "include_in_client_valuation": true
      },
      "date_of_transfer_valuation": "2024-11-14",
      "transferred_from_plan_type": "cash_account",
      "transferred_from_plan_sub_type": "cash_deposit"
    }
  ]
}