v1

latestOpenAPI 3.1.02026-07-242735131.1 MB

Pricing Plan

Update pricing plan details

Updates the pricing plan for an employment. The frequency determines how often Remote bills the employer for management fees. Annual billing typically offers a discount.

Scopes

Category	Read only Scope	Write only Scope (read access implicit)
Manage employments (employments)	-	Manage employments (employment:write)

put/v2/employments/{employment_id}/pricing-plan-details

Path parameters

employment_idstring required

Employment ID

Query parameters

integer

Specific version number

'latest'

Use latest version

Version of the pricing_plan_details form schema

Request body

pricing_plan_detailsobject required

Pricing plan details information. As its properties may vary depending on the country, you must query the Show form schema endpoint passing the country code and pricing_plan_details as path parameters.

Example request

{
  "pricing_plan_details": {
    "frequency": "annually"
  }
}

Response

Success

Example response

{
  "data": {
    "employment": {
      "contract_origin": "remote_contract",
      "id": "20a72f86-employment-id-9e4942a902ff",
      "personal_details": {},
      "status": "created",
      "type": "employee",
      "updated_at": "2024-01-15T10:30:00Z",
      "user_status": "active"
    }
  }
}