younifyd
Menu

Get Additional Costs

List additional costs

GET/v1/additional_costs

Use it in a workflow

  1. Add a step and choose the Talon.One connector.
  2. Pick the Get Additional Costs action (under management).
  3. Fill in the fields below, then reference the result from later steps as {{getAdditionalCosts.response.data}}.

Request

Query parameters

pageSizeinteger (int64)

The number of items in the response.

Default 1000

skipinteger (int64)

The number of items to skip when paging through large result sets.

sortstring

The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.

Response

Returns 200 with an object. Read it in later steps with {{getAdditionalCosts.response.data.<field>}}.

totalResultSizeinteger (int64)
dataarray<object>
idinteger (int64)required

The internal ID of this entity.

createdstring (date-time)required

The time this entity was created.

accountIdinteger (int64)required

The ID of the account that owns this entity.

namestringrequired

The internal name used in API requests.

titlestringrequired

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.

descriptionstringrequired

A description of this additional cost.

subscribedApplicationsIdsarray<integer (int64)>

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

typestring

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.

One ofsessionitembothDefault "session"

json
{
  "totalResultSize": 1,
  "data": [
    {
      "accountId": 3886,
      "created": {},
      "name": "shippingFee",
      "subscribedApplicationsIds": [
        3,
        13
      ],
      "description": "A shipping fee",
      "id": 6,
      "title": "Shipping fee",
      "type": "session"
    }
  ]
}

Need more? See the Talon.One guide for connection setup and behaviour shared by every action.