Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Remote Subscriptions API

The Subscriptions API from Remote — 7 operation(s) for subscriptions.

Remote Subscriptions API is one of 101 APIs that Remote publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Subscriptions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 8 operations across 7 paths, and defines 22 schemas. It is described by OpenAPI 3.0.0, at version 0.1.0.

Requests are made against 2 base URLs: https://gateway.remote.com/, https://gateway.remote-sandbox.com/.

8 operations 7 paths 22 schemas 1 DELETE3 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.1.0
Base URL
https://gateway.remote.com/v1/
Authentication
HTTP Basic, HTTP Bearer, HTTP Bearer, OAuth 2.0, OAuth 2.0, OAuth 2.0, OAuth 2.0
Resource Areas
1

Authentication & Security 7

Remote Subscriptions API declares 7 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuth). It accepts HTTP bearer tokens (ClientToken). It accepts HTTP bearer tokens (CustomerAPIToken). It supports OAuth 2.0 (OAuth2) using the authorizationCode and clientCredentials flows, exposing 77 scopes. It supports OAuth 2.0 (OAuth2Assertion) using the clientCredentials flow, exposing 21 scopes. It supports OAuth 2.0 (OAuth2AuthorizationCode) using the authorizationCode flow, exposing 73 scopes. It supports OAuth 2.0 (OAuth2ClientCredentials) using the clientCredentials flow, exposing 18 scopes. By default, every request must be authenticated.

  • BasicAuth — Authenticate using the basic authentication for partners. Use the CLIENTID as login and CLIENTSECRET as password.
  • ClientToken — Authenticate a partner using only the the provided clienttoken. This authentication method only allows accessing marketing endpoints.
  • CustomerAPIToken — Authenticate using API Key generated by the customer in their Integration Settings page.
  • OAuth2 — Authenticate using OAuth 2.0 protocol.
  • OAuth2Assertion — Authenticate as the employee using the urn:ietf:params:oauth:grant-type:jwt-bearer grant in the OAuth2 protocol.
  • OAuth2AuthorizationCode — Authenticate as the token authorizer using authorizationcode / refreshtoken grants in the OAuth 2.0 protocol.
  • OAuth2ClientCredentials — Authenticate using clientcredentials grant in the OAuth 2.0 protocol.

Paths & Operations 8

Across 7 paths, the API surfaces 8 operations — 1 DELETE, 3 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Subscriptions 8
GET
/v1/contractors/employments/{employment_id}/contractor-subscriptions
List contractor subscriptions
get_v1_contractors_employments_employment_id_contractor-subscriptions 1 param → 200401403404
GET
/v1/contractors/cor-termination-requests
List contractor of record (COR) termination requests
get_v1_contractors_cor-termination-requests 4 params → 200403404
POST
/v1/contractors/employments/{employment_id}/cor-termination-requests
Create a contractor of record (COR) termination request
post_v1_contractors_employments_employment_id_cor-termination-requests 1 param → 201400403404422
GET
/v1/contractors/employments/{employment_id}/cor-termination-requests/{termination_request_id}
Show a contractor of record (COR) termination request
get_v1_contractors_employments_employment_id_cor-termination-requests_termination_request_id 2 params → 200403404
POST
/v1/contractors/employments/{employment_id}/terminate-cor-employmentdeprecated
Terminate contractor of record employment
post_v1_contractors_employments_employment_id_terminate-cor-employment 1 param → 200400403404422
POST
/v1/contractors/employments/{employment_id}/contractor-plus-subscription
Manage contractor plus subscription
post_v1_contractors_employments_employment_id_contractor-plus-subscription 1 param body → 200400403
DELETE
/v1/contractors/employments/{employment_id}/contractor-cor-subscription
Delete contractor of record subscription intent
delete_v1_contractors_employments_employment_id_contractor-cor-subscription 1 param → 204401403404422
POST
/v1/contractors/employments/{employment_id}/contractor-cor-subscription
Create contractor of record subscription intent
post_v1_contractors_employments_employment_id_contractor-cor-subscription 1 param → 201400403404422

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are ContractorSubscriptions.Summary (11 properties), CorTerminationRequest (8 properties), Product (7 properties), EligibilityQuestionnaire (6 properties). Each schema is shown below with its type and property counts.

ContractorSubscriptions.Summary
object
11 properties 6 required
ParameterError
object
3 properties 3 required
EligibilityQuestionnaire
object
6 properties 6 required
Decimal
string
A decimal number represented as a string to preserve precision. Supports negative values and fractional digits.
ContractorSubscriptionSummariesResponse
object
Summaries of contractor subscriptions
1 property 1 required
Date
string
UTC date in [ISO 8601](https://en.wikipedia.org/wiki/ISO8601) format
IndexCorTerminationRequestsResponse
object
Response schema listing many terminationrequests
1 property
SuccessResponse
object
A generic success response returned by operations that don't produce a specific resource (e.g., updates, deletes).
1 property 1 required
DateTime
string
UTC date time in YYYY-MM-DDTHH:mm:ss format
UnauthorizedResponse
object
Returned when the request does not include valid authentication credentials. Ensure you are passing a valid OAuth2 access token or API token in the Authorizati…
1 property 1 required
UnprocessableEntityResponse
object
BadRequestResponse
object
Returned when the request is malformed or contains invalid parameters. The message may be a simple string or a structured object with a code and detailed messa…
CorTerminationRequestCreatedResponse
object
1 property 1 required
ActionError
object
3 properties 3 required
Product
object
A Remote product offering (e.g., EOR, Contractor Management) with its tier and billing frequency.
7 properties 3 required
ForbiddenResponse
object
Returned when the authenticated user or token does not have permission to perform the requested action. Check that the token has the required OAuth2 scopes and…
1 property 1 required
NotFoundResponse
object
Returned when the requested resource does not exist or is not accessible with the current authentication credentials.
1 property
CorTerminationRequestResponse
object
1 property 1 required
UuidSlug
string
Identifier of the employment being terminated.
ManageContractorPlusSubscriptionOperationsParams
object
Defines the operation that must be executed: upgrade or downgrade
1 property 1 required
Currency
object
The type of money in general use in a particular country
4 properties 3 required
CorTerminationRequest
object
8 properties 8 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

remote-subscriptions-api-openapi.yml Raw ↑

Other APIs Remote publishes across the network.

Remote Address Details API
Remote Administrative Details API
Remote Background Checks API
Remote Bank Account Details API
Remote Basic Information API
Remote Benefit Offers API
Remote Benefit Offers By Employment API
Remote Benefit Renewals API
Remote Benefits API
Remote Billing Address Details API
Remote Billing API
Remote Billing Documents API