Pricing Plans

Show product prices in the company's desired currency

list product prices in the company's desired currency. the endpoint currently only returns the product prices for the EOR monthly product and the contractor products (Standard, Plus and COR). the product prices are then used to create a pricing plan for the company.

Authentication

This endpoint requires the following token type:

  • Client credentials access token (OAuth2ClientCredentials) — obtained through the Client Credentials flow or the Refresh Token flow. See Authentication for partners.

Scopes

Any one of the scopes in a token type's row is enough. all:read and all:write work too.

Token typeCategoryRead only ScopeWrite only Scope (read access implicit)
Client credentials access tokenManage companies (company_management)View pricing plans (pricing_plan:read)Manage pricing plans (pricing_plan:write)
get/v1/companies/{company_id}/product-prices

Request

  • Base URL
    https://gateway.remote.com
  • URL
    https://gateway.remote.com/v1/companies/{company_id}/product-prices
  • Auth
    • OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.manage
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: pricing_plan:read
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: all:read
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: all:write

Path parameters

company_idstring uuid required

A unique identifier in UUID v4 format.

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

Company ID

Response

Success

Example response

{
  "data": {
    "product_prices": [
      {
        "base_price": {
          "amount": 29900,
          "currency": {
            "code": "CZK",
            "name": "Czech Koruna",
            "symbol": "Kč"
          }
        },
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "EOR Monthly Core"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.