Clients prices

Clients prices represent default prices that is applied to all jobs created whatever the client. These prices can be overridden at the client level.

The client price object

Properties

  • idstring

    Unique identifier for the object.

  • currencyobject

    The currency.

  • domainobject

    The domain of expertise.

  • languagePairobject

    The language pair.

  • matchesarray

    The matches.

  • matchesTypestring

    How the matches are calculated. Valid values are fixed or percentage.

  • quantityTypeobject

    The quantity type.

  • serviceobject

    The service.

  • unitCostnumber

    The cost per unit.

client price object

{
  "id": "6548c1965136b418fd626e83",
  "service": {
     "id": "6548c16d5136b418fd626e5f", 
     "name": "Translation" 
  },
  "quantityType": {
    "id": "6548c16d5136b418fd626e61", 
    "name": "Words" 
  },
  "currency": { 
    "code": "EUR", 
    "symbol": "€" 
  },
  "unitCost": 0.16,
  "matchesType": "fixed",
  "matches": [
    {
      "percentage": 1,
      "unitCost": 0.16,
      "id": "655c61aa0ecf6202a9edb710",
      "name": "0%"
    },
    {
      "percentage": 1,
      "unitCost": 0.08,
      "id": "655c61a70ecf6202a9edb70e",
      "name": "100%"
    },
    {
      "percentage": 1,
      "unitCost": 0.12,
      "id": "655c61af0ecf6202a9edb712",
      "name": "Fuzzies"
    }
  ]
}
GET/v2/account/prices/clients/

List all clients prices

This endpoint allows you to retrieve all the clients prices. This endpoint is paginated.

Request

GET
/v2/account/prices/clients/
curl -G https://api.lsp.expert/v2/account/prices/clients/ \
  -u {key}:

Response

{
  "items": [
    {
      "id": "6548c1965136b418fd626e83",
      "service": {
        "id": "6548c16d5136b418fd626e5f", 
        "name": "Translation" 
      },
      "quantityType": {
        "id": "6548c16d5136b418fd626e61", 
        "name": "Words" 
      },
      "currency": { 
        "code": "EUR", 
        "symbol": "€" 
      },
      "unitCost": 0.16,
      "matchesType": "fixed",
      "matches": [
        {
          "percentage": 1,
          "unitCost": 0.16,
          "id": "655c61aa0ecf6202a9edb710",
          "name": "0%"
        },
        {
          "percentage": 1,
          "unitCost": 0.08,
          "id": "655c61a70ecf6202a9edb70e",
          "name": "100%"
        },
        {
          "percentage": 1,
          "unitCost": 0.12,
          "id": "655c61af0ecf6202a9edb712",
          "name": "Fuzzies"
        }
      ]
    }
    // ...
  ],
  "pageSize": 20,
  "page": 1,
  "totalPages": 1,
  "totalItems": 2,
  "hasNextPage": false,
  "hasPreviousPage": false
}
POST/v2/account/prices/clients/

Create a client price

This endpoint allows you to add a new client price.

Parameters

  • currencystring Required

    The currency code (ISO, e.g., EUR).

  • domainstring

    The domain of expertise id.

  • languagePairstring

    The language pair id.

  • matchesTypestring Required

    How the matches are calculated. Valid values are fixed or percentage.

  • quantityTypestring Required

    The quantity type id.

  • servicestring Required

    The service id.

  • unitCostnumber Required

    The cost per unit.

Request

POST
/v2/account/prices/clients/
curl https://api.lsp.expert/v2/account/prices/clients/ \
  -u {key}: \
  -d currency="EUR" \
  -d quantityType="6548c16d5136b418fd626e61" \
  -d service="6548c16d5136b418fd626e5f"
  -d languagePair="659bf8f35959fed584cd38e1"
  -d unitCost=0.16
  -d matchesType="fixed"

Response

{
  "id": "66e7f69da9d8b6741f4a441d",
  "languagePair": {
    "id": "659bf8f35959fed584cd38e1",
    "source": { 
      "code": "en", 
      "name": "English" 
    },
    "target": { 
      "code": "fr", 
      "name": "French" 
    },
    "bidirectional": false
  },
  "currency": { 
    "code": "EUR", 
    "symbol": "€" 
  },
  "unitCost": 0.16,
  "matchesType": "fixed",
  "service": { 
    "id": "6548c16d5136b418fd626e5f", 
    "name": "Translation" 
  },
  "quantityType": { 
    "id": "6548c16d5136b418fd626e61", 
    "name": "Words" 
  },
  "matches": []
}
GET/v2/account/prices/clients/:id

Retrieve a client price

This endpoint allows you to retrieve a client price by providing their id.

Request

GET
/v2/account/prices/clients/:id
curl https://api.lsp.expert/v2/account/prices/clients/66e7f69da9d8b6741f4a441d \
  -u {key}:

Response

{
  "id": "66e7f69da9d8b6741f4a441d",
  "languagePair": {
    "id": "659bf8f35959fed584cd38e1",
    "source": { 
      "code": "en", 
      "name": "English" 
    },
    "target": { 
      "code": "fr", 
      "name": "French" 
    },
    "bidirectional": false
  },
  "currency": { 
    "code": "EUR", 
    "symbol": "€" 
  },
  "unitCost": 0.16,
  "matchesType": "fixed",
  "service": { 
    "id": "6548c16d5136b418fd626e5f", 
    "name": "Translation" 
  },
  "quantityType": { 
    "id": "6548c16d5136b418fd626e61", 
    "name": "Words" 
  },
  "matches": []
}
PUT/v2/account/prices/clients/:id

Update a client price

This endpoint allows you to perform an update on a client price. Any parameters not provided will be left unchanged.

Parameters

  • matchesTypestring

    How the matches are calculated. Valid values are fixed or percentage.

  • unitCostnumber Required

    The cost per unit.

Request

PUT
/v2/account/prices/clients/:id
curl -X PUT https://api.lsp.expert/v2/account/prices/clients/66e7f69da9d8b6741f4a441d \
  -u {key}: \
  -d unitCost="0.18"

Response

{
  "id": "66e7f69da9d8b6741f4a441d",
  "languagePair": {
    "id": "659bf8f35959fed584cd38e1",
    "source": { 
      "code": "en", 
      "name": "English" 
    },
    "target": { 
      "code": "fr", 
      "name": "French" 
    },
    "bidirectional": false
  },
  "currency": { 
    "code": "EUR", 
    "symbol": "€" 
  },
  "unitCost": 0.18,
  "matchesType": "fixed",
  "service": { 
    "id": "6548c16d5136b418fd626e5f", 
    "name": "Translation" 
  },
  "quantityType": { 
    "id": "6548c16d5136b418fd626e61", 
    "name": "Words" 
  },
  "matches": []
}
DELETE/v2/account/prices/clients/:id

Delete a client price

This endpoint allows you to delete a client price.

Request

DELETE
/v2/account/prices/clients/:id
curl -X DELETE https://api.lsp.expert/v2/account/prices/clients/66e7f69da9d8b6741f4a441d \
  -u {key}:
POST/v2/account/prices/clients/:id/matches

Add a match for a client price

This endpoint allows you to add a match category on a client price.

Parameters

  • matchstring Required

    The match id.

  • percentagenumber

    The percentage of the price unit cost. (If matchesType is percentage)

  • unitCostnumber

    The cost per unit. (If matchesType is fixed)

Request

POST
/v2/account/prices/clients/:id/matches
curl https://api.lsp.expert/v2/account/prices/clients/66e7f69da9d8b6741f4a441d/match \
  -u {key}: \
  -d match="655c61aa0ecf6202a9edb710" \
  -d unitCost=0.16

Response

{
  "id": "66e830a5a9d8b6741f4a4423",
  "service": { 
    "id": "6548c16d5136b418fd626e5f", 
    "name": "Translation" 
  },
  "languagePair": {
    "source": { 
      "code": "en", 
      "name": "English" 
    },
    "target": { 
      "code": "fr", 
      "name": "French" 
    },
    "id": "659bf8f35959fed584cd38e1",
    "bidirectional": false
  },
  "quantityType": { 
    "id": "6548c16d5136b418fd626e61", 
    "name": "Words" 
  },
  "currency": { 
    "code": "EUR", 
    "symbol": "€" 
  },
  "unitCost": 0.18,
  "matchesType": "fixed",
  "matches": [
    {
      "percentage": 1,
      "unitCost": 0.16,
      "id": "655c61aa0ecf6202a9edb710",
      "name": "0%"
    }
  ]  
}
PUT/v2/account/prices/clients/:id/matches/:matchId

Update a match for a client price

This endpoint allows you to update a match category on a client price.

Parameters

  • percentagenumber

    percentage

  • unitCostnumber

    The cost per unit.

Request

PUT
/v2/account/prices/clients/:id/matches/:matchId
curl https://api.lsp.expert/v2/account/prices/clients/66e7f69da9d8b6741f4a441d/match/655c61aa0ecf6202a9edb710 \
  -u {key}: \
  -d match="655c61aa0ecf6202a9edb710" \
  -d unitCost=0.18

Response

{
  "id": "66e830a5a9d8b6741f4a4423",
  "service": { 
    "id": "6548c16d5136b418fd626e5f", 
    "name": "Translation" 
  },
  "languagePair": {
    "source": { 
      "code": "en", 
      "name": "English" 
    },
    "target": { 
      "code": "fr", 
      "name": "French" 
    },
    "id": "659bf8f35959fed584cd38e1",
    "bidirectional": false
  },
  "quantityType": { 
    "id": "6548c16d5136b418fd626e61", 
    "name": "Words" 
  },
  "currency": { 
    "code": "EUR", 
    "symbol": "€" 
  },
  "unitCost": 0.18,
  "matchesType": "fixed",
  "matches": [
    {
      "percentage": 1,
      "unitCost": 0.18,
      "id": "655c61aa0ecf6202a9edb710",
      "name": "0%"
    }
  ]  
}
PUT/v2/account/prices/clients/:id/matches/:matchId/move/:newPosition

Move a match for a client price

This endpoint allows you to modify a match category order. Note that this order is used when adding a price.

Request

PUT
/v2/account/prices/clients/:id/matches/:matchId/move/:newPosition
curl https://api.lsp.expert/v2/account/prices/clients/66e7f69da9d8b6741f4a441d/matches/655c61aa0ecf6202a9edb710/move/1 \
  -u {key}: \

Response

{
  "id": "66e830a5a9d8b6741f4a4423",
  "service": { 
    "id": "6548c16d5136b418fd626e5f", 
    "name": "Translation" 
  },
  "languagePair": {
    "source": { 
      "code": "en", 
      "name": "English" 
    },
    "target": { 
      "code": "fr", 
      "name": "French" 
    },
    "id": "659bf8f35959fed584cd38e1",
    "bidirectional": false
  },
  "quantityType": { 
    "id": "6548c16d5136b418fd626e61", 
    "name": "Words" 
  },
  "currency": { 
    "code": "EUR", 
    "symbol": "€" 
  },
  "unitCost": 0.18,
  "matchesType": "fixed",
  "matches": [
    {
      "percentage": 1,
      "unitCost": 0.18,
      "id": "655c61aa0ecf6202a9edb710",
      "name": "0%"
    }
  ]  
}
DEL/v2/account/prices/clients/:id/matches/:matchId

Remove a match for a client price

This endpoint allows you to remove a match category on a client price.

Request

POST
/v2/account/prices/clients/:id/matches/:matchId
curl https://api.lsp.expert/v2/account/prices/clients/66e7f69da9d8b6741f4a441d/matches/655c61aa0ecf6202a9edb710 \
  -u {key}:

Response

{
  "id": "66e830a5a9d8b6741f4a4423",
  "service": { 
    "id": "6548c16d5136b418fd626e5f", 
    "name": "Translation" 
  },
  "languagePair": {
    "source": { 
      "code": "en", 
      "name": "English" 
    },
    "target": { 
      "code": "fr", 
      "name": "French" 
    },
    "id": "659bf8f35959fed584cd38e1",
    "bidirectional": false
  },
  "quantityType": { 
    "id": "6548c16d5136b418fd626e61", 
    "name": "Words" 
  },
  "currency": { 
    "code": "EUR", 
    "symbol": "€" 
  },
  "unitCost": 0.18,
  "matchesType": "fixed",
  "matches": []  
}
GET/v2/account/prices/clients/

Search clients prices

Search a price using query languages.

Available query parameters for search

  • service.id[]string

    The service id(s).

  • quantityType.id[]string

    The quantity type id(s).

  • domain.id[]string

    The domain id(s).

  • languagePair.id[]string

    The language pair id(s).

  • currency[]string

    The currency code(s).

Request

GET
/v2/account/prices/clients/
curl -G https://api.lsp.expert/v2/account/prices/clients/ \
  -u {key}: \
  -d "service.id[]=6548c16d5136b418fd626e5f"