TAtalon
Additional costs

Update additional cost

[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

Updates an existing additional cost. Once created, the only property of an additional cost that cannot be changed is the name property (or API name in the Campaign Manager). This restriction is in place to prevent accidentally breaking live integrations.

put/v1/additional_costs/{additionalCostId}

Request

Path parameters

additionalCostIdinteger required

The ID of the additional cost. You can find the ID the the Campaign Manager's URL when you display the details of the cost in Account > Tools > Additional costs.

Request body

namestring required

The internal name used in API requests.

titlestring required

The human-readable name for the additional cost that will be shown in the Campaign Manager. Like name, the combination of entity and title must also be unique.

descriptionstring required

A description of this additional cost.

subscribedApplicationsIdsinteger[]

A list of the IDs of the applications that are subscribed to this additional cost.

type'session' | 'item' | 'both'

The type of additional cost. Possible value:

  • session: Additional cost will be added per session.
  • item: Additional cost will be added per item.
  • both: Additional cost will be added per item and session.

Example request

{
  "name": "shippingFee",
  "title": "Shipping fee",
  "description": "A shipping fee",
  "subscribedApplicationsIds": [
    3,
    13
  ],
  "type": "session"
}

Response

OK

idinteger required

The internal ID of this entity.

createdstring date-time required

The time this entity was created.

accountIdinteger required

The ID of the account that owns this entity.

namestring required

The internal name used in API requests.

titlestring required

The human-readable name for the additional cost that will be shown in the Campaign Manager. Like name, the combination of entity and title must also be unique.

descriptionstring required

A description of this additional cost.

subscribedApplicationsIdsinteger[]

A list of the IDs of the applications that are subscribed to this additional cost.

type'session' | 'item' | 'both'

The type of additional cost. Possible value:

  • session: Additional cost will be added per session.
  • item: Additional cost will be added per item.
  • both: Additional cost will be added per item and session.

Example response

{
  "id": 6,
  "created": "2020-06-10T09:05:27.993483Z",
  "accountId": 3886,
  "name": "shippingFee",
  "title": "Shipping fee",
  "description": "A shipping fee",
  "subscribedApplicationsIds": [
    3,
    13
  ],
  "type": "session"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.