Rate cards

Price lists for services. Rate cards define company-wide or client-specific pricing templates. Each rate card contains prices for service types with billing configuration. Client-specific rate cards override defaults for that company.

Attributes

archived_at string
Response

Timestamp when this rate card was archived, or null if it is still active.
company company
Response

The company this rate card is associated with.
company_id integer
Request Parameter `filter`

ID of the company this rate card is associated with.
created_at string
Response Parameter `filter` Parameter `sort`

Timestamp when this rate card was created.
creator person
Response

The person who created this rate card.
name string
Response Request Parameter `filter` Parameter `sort`

The name of this rate card.
organization organization
Response

The organization this rate card belongs to.
prices_count object
Response

The number of prices defined on this rate card.
status integer
Parameter `filter` Enum

The current status of this rate card (active or archived).

Enum Values (2 values)

  • 1
  • 2
updated_at string
Response

Timestamp when this rate card was last updated.

Operations

GET /api/v2/rate_cards
Get rate cards
POST /api/v2/rate_cards
Create a price
POST /api/v2/rate_cards/copy
Copy a rate card
DELETE /api/v2/rate_cards/{id}
Deletes a price
GET /api/v2/rate_cards/{id}
Gets a rate card
PATCH /api/v2/rate_cards/{id}
Update a price
PATCH /api/v2/rate_cards/{id}/archive
Archives a rate card
PATCH /api/v2/rate_cards/{id}/restore
Restores a rate card