Show Benefit Renewal Request

Show Benefit Renewal Request details.

Authentication

This endpoint accepts any one of the following token types:

Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.

Scopes

Category	Read only Scope	Write only Scope (read access implicit)
Manage company resources (company_admin)	View benefit renewals (benefit_renewal:read)	Manage benefit renewals (benefit_renewal:write)

get/v1/benefit-renewal-requests/{benefit_renewal_request_id}

Request

Base URL: https://gateway.remote.com
URL: https://gateway.remote.com/v1/benefit-renewal-requests/{benefit_renewal_request_id}
Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, benefit_renewal:read, benefit_renewal:write, company_admin, all:write, all:read)

Path parameters

benefit_renewal_request_idstring uuid required

A unique identifier in UUID v4 format.

Example:663e0b79-c893-45ff-a1b2-f6dcabc098b5

Benefit Renewal Request Id

Headers

Authorizationstring required

Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.

The refresh token needs to have been obtained through the Authorization Code flow.

Response

Success

Example response

{
  "data": {
    "benefit_renewal_request": {
      "benefit_group": {
        "country_code": "FRA",
        "id": "03b20f23-06b2-4fe2-8f21-49b445ccc1bb",
        "name": "Health"
      },
      "benefit_renewal_response": {
        "benefit_tier": {
          "description": "A tier for testing purposes",
          "display_cost": "~$100",
          "id": "163d8f6c-2440-4f45-918b-d095f9e0ef79",
          "name": "Premium"
        },
        "updated_at": "2021-07-01T00:00:00Z"
      },
      "coverage_end_date": "2022-07-01",
      "coverage_start_date": "2021-07-01",
      "current_benefit_tier": {
        "description": "A tier for testing purposes",
        "display_cost": "~$100",
        "id": "163d8f6c-2440-4f45-918b-d095f9e0ef79",
        "name": "Premium"
      },
      "id": "0073f4b5-b669-4b4a-b963-2a477f4e75a1",
      "number_of_affected_employees": 10,
      "renewal_selection_end_date": "2021-05-01",
      "renewal_selection_instructions": "We are delighted to announce our new Global Life Insurance plans, now available in 66 countries.\nThis addition is set to significantly enhance the benefits package for your international team.\nSelection Deadline: Review and choose the right Global Life Insurance plan for each country where your team is based by 11:59 PM on December 31, 2023.\nWe offer flexible coverage options from $50,000 to $600,000, so take your time to decide what's best for your team.\nIf you don't make a selection within this period, your team members won't be enrolled in the Global Life Insurance.\nIf you wish to do so anytime next year, please reach out to help@remote.com\nFor more information on how benefits work in different countries, check out our Global <a href=\"https://remote.com/benefits-guide/global-life-insurance\">benefits guide</a>.\n",
      "renewal_selection_start_date": "2021-03-01"
    }
  }
}

Changes

No recorded changes to this operation across all 65 revisions of this API.