Contractors
Subscriptions

Manage contractor plus subscription

Endpoint that can be used to upgrade, assign or downgrade a contractor's subscription. This can be used when company admins desire to assign someone to the Contractor Plus plan, but also to change the contractor's subscription between Plus and Standard.

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

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage employments (employments)-Manage employments (employment:write)
post/v1/contractors/employments/{employment_id}/contractor-plus-subscription

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/contractors/employments/{employment_id}/contractor-plus-subscription
  • 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, employment:write, employments, all:write)

Path parameters

employment_idstring required

Employment ID

Request body

operation'upgrade' | 'downgrade' required

Example request

{
  "operation": "upgrade"
}

Response

Success

Example response

{
  "data": {
    "status": "ok"
  }
}

Changes

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