Tariff Subscriptions

Update a tariff subscription

patch/api/v1/external/tariff-subscriptions/{subscriptionId}

Request

Base URL
https://api.wove.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/wove/apis/wove-external-api/docs/api/v1/external/tariff-subscriptions/:subscriptionId/patch.ts
A function with typed inputs. Its response is checked against the schema.

Request body

originCountriesstring[]

Added origins are baselined without a notification; removed origins are dropped.

notifyOn'effective' | 'scheduled' | 'both'

lookaheadDaysinteger

componentValuesobject nullable

Changing it re-baselines every origin without a notification. Null clears it.

includeTreatmentsboolean

isActiveboolean

Response

Subscription updated

successboolean

Example response

{
  "data": {
    "id": "1641343378340540417",
    "hsCode": "22042120",
    "originCountries": [
      "CA",
      "FR"
    ],
    "lookaheadDays": 90
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.