Pricing Plans

Create a pricing plan for a company

Create a pricing plan for a company, in order to do that we have 2 ways:

Create a pricing plan from a partner template
Create a pricing plan from a product price

The pricing plan is always created in the company's desired currency.

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:write works too.

Token type	Category	Read only Scope	Write only Scope (read access implicit)
Client credentials access token	Manage companies (company_management)	-	Manage pricing plans (pricing_plan:write)

post/v1/companies/{company_id}/pricing-plans

Request

Base URL
https://gateway.remote.com
URL
https://gateway.remote.com/v1/companies/{company_id}/pricing-plans
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:write
- 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

Request body

Example request

{
  "amount": 29900,
  "currency_code": "USD",
  "product_price_id": "37e7f0ce-055c-46a1-b60f-1ac73a083699"
}

Response

Success

Example response

{
  "data": {
    "pricing_plan": {
      "base_price": {
        "amount": 29900,
        "currency": {
          "code": "CZK",
          "name": "Czech Koruna",
          "symbol": "Kč"
        }
      },
      "end_date": "2025-12-31",
      "id": "3b840951-099f-4bd5-90b9-032f7bfe51d9",
      "price": {
        "amount": 29900,
        "currency": {
          "code": "CZK",
          "name": "Czech Koruna",
          "symbol": "Kč"
        }
      },
      "product": {
        "description": "EOR Monthly",
        "features": [
          "Feature 1",
          "Feature 2"
        ],
        "frequency": "monthly",
        "name": "EOR Monthly",
        "short_name": "EOR",
        "tier": "standard"
      },
      "start_date": "2025-01-01",
      "type": "termed"
    }
  }
}

Changes

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