---
title: "Creating a new Rate Card"
method: POST
path: "/rate_cards"
tags: ["Rate Cards (Multiple Currencies)"]
---

# Creating a new Rate Card

`POST /rate_cards`

## Request

- Base URL: `https://api.mavenlink.com/api/v1`
- URL: `https://api.mavenlink.com/api/v1/rate_cards`
- Auth: none declared

Creating a Rate Card automatically creates a Rate Card Version and associates it with the specified
Rate Card Set Version. If you are adding a Rate Card with a new currency on a custom Rate Card Set, it needs to
be added to the account default Rate Card Set first.
When you add a Rate Card with a new currency on a Rate Card Set that already has published Rate Card Set
versions, a cloned Rate Card Version will be added to all previous Rate Card Set Versions on the Rate
Card Set.
A Rate Card can only be created by Administrators on the account.


This endpoint returns structured Rate Card objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the `results` array
and will be indexed by ID in the `rate_cards` top-level JSON key.
Please see our [Response Format](#section/Response-Format) section for more information.

## Query parameters

- `include` string

## Request body

- object
  - `rate_card` object
    - `rate_card_set_id` integer, required: The ID of the Rate Card Set to which the Rate Card belongs.
    - `rate_card_set_version_id` integer: The ID of the Rate Card Set Version to which the Rate Card belongs.
    - `currency` string, required: The currency that the Rate Card represents in the Rate Card. For example, `USD`.
    - `external_reference` object: Typically populated programmatically by a third party system via an integration, this is an optional object that holds data from an external system. It connects objects in an external system with objects in Kantata OX (for example, to connect a Jira issue to a Kantata OX Project).
      - `service_name` string, required: The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique.
      - `service_model` string, required: The object type of the external object this external reference belongs to.
      - `service_model_ref` string, required: The object ID of the external object this external reference belongs to.
      - `status` string: The status of the integration. Options are `successful`, `pending`, or `failed`.
      - `external_message` string: The message on the external object.
      - `external_link` string: The link to the external object.
      - `external_status` string: The status of the external object in the external system.
      - `locked` boolean: Whether the subject is locked.

## Response `200`

Rate Card has been created.

- object
  - `count` integer
  - `meta` object
    - `count` integer
    - `page_count` integer
    - `page_number` integer
    - `page_size` integer
  - `results` object[]
    - `key` string
    - `id` string
  - `rate_cards` object
  - `external_references` object
  - `rate_card_sets` object
  - `rate_card_versions` object

## Other responses

- `400`: Bad Request
- `401`: Unauthorized request
- `403`: Forbidden request
- `404`: Page Not Found
- `422`: Unprocessable Entity
- `503`: Service is unavailable

---

[API](https://skmtc.dev/kantata/apis/kantata-ox-api-documentation.md) - [All operations](https://skmtc.dev/kantata/apis/kantata-ox-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/kantata/apis/kantata-ox-api-documentation/revisions/9d4ebed2fa98?raw)