Sign in

v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
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:

  1. Create a pricing plan from a partner template
  2. Create a pricing plan from a product price

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

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage companies (company_management)-Manage pricing plans (pricing_plan:write)
post/v1/companies/{company_id}/pricing-plans

Path parameters

company_idstring uuid required

Identifier of the employment being terminated.

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

Company ID

Request body

OR

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"
    }
  }
}