Querying for return premium plans

Use the following endpoints to query for return premium plans:

  • GET /admin/v1/return-premium-plans
  • GET /admin/v1/return-premium-plans/{returnPremiumPlanId}
For example, the following request retrieves information about return premium plan "ret_premium_plan:1":
GET /admin/v1/return-premium-plans/ret_premium_plan:1

{
    "data": {
        "attributes": {
            "chargeQualification": {
                "code": "ChargePattern",
                "name": "Same Payer, Policy Period, and Charge Pattern"
            },
            "description": "The default plan for returned premium distribution.",
            "effectiveDate": "2013-01-01",
            "id": "ret_premium_plan:1",
            "inUse": true,
            "listBillAccountExcessTreatment": {
                "code": "PolicyOwnerUnapplied",
                "name": "Policy Owner Unapplied"
            },
            "name": "Default Return Premium Plan",
            "planOrder": 1
        },
        ...