Fees

The Fees resource in the Digital River API details financial obligations imposed as part of regulatory compliance. These fees are essential for ensuring products meet legal standards across different regions. By managing these fees effectively, businesses can maintain compliance and accurately calculate the final cost of their offerings. See for more information.

PreviousEvents NextFile Links

Last updated 4 months ago

Gets a Fee by identifier

Retrieves the details of a fee. You must supply the unique identifier of the fee.

get

/fees/{id}

Authorizations

Path parameters

idstringrequired

Fee identifier.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.digitalriver.com/fees/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

404

405

406

408

429

500

502

503

504

{
  "id": "fee_1971b9b5-7d6b-49d5-b2a6-88ca7e53f750",
  "createdTime": "2018-04-25T20:36:00Z",
  "skuId": "sku_7834561209",
  "category": "3. IT and Telecommunication Equipment",
  "value": "85\" Class Q900 QLED Smart 8K UHD TV.",
  "amount": 0.5,
  "battery": {
    "quantity": 2,
    "chemicalSystem": "Alkaline",
    "iecCode": "R20"
  },
  "complianceAgency": "text",
  "feeExemption": "exempt",
  "brandName": "Samsung",
  "weee": {
    "weeeRegistrationId": "text"
  },
  "weightAndUnits": "3.00 kg",
  "rateAndUnits": "2.00 EUR",
  "currency": "USD",
  "country": "US",
  "liveMode": false,
  "metadata": {
    "coupon": "iOS"
  },
  "updatedTime": "2018-04-25T20:36:00Z",
  "type": "weee",
  "subdivisions": [
    "CA"
  ]
}

Updates an existing Fee

Updates the specified Fee by setting the values of the parameters passed. Any parameters not provided remain unchanged.

post

/fees/{id}

Authorizations

Path parameters

idstringrequired

Fee identifier

Body

skuIdstring

The unique identifer of the stock keeping unit associated with the fee.

Example: sku_7834561209

categorystring

The category of the fee as defined by regulatory law.

Example: 3. IT and Telecommunication Equipment

valuestring

The value of the product.

Example: 85" Class Q900 QLED Smart 8K UHD TV.

amountnumber · double

The fee amount.

Example: 0.5

batteryBattery

A battery fee designed to make entities that produce and sell batteries responsible for collecting recycling fees.

complianceAgencystring

The unique identifier of the recycling agency associated with the product's jurisdiction.

feeExemptionstring

Indicates whether business to business sales are exempt from paying the fee.

Example: exempt

brandNamestring

The product's brand name.

Example: Samsung

weeeWEEE

Fees that represent waste electrical and electronic equipment.

weightAndUnitsstring

The weight of the unit, minus packaging or batteries, and the unit of measurement applied to the weight.

Example: 3.00 kg

currencystring

A three-letter ISO 4217 currency code.

Example: USD

countrystring

A two-letter ISO 3166 country code.

Example: US

metadataMetadata

Key-value pairs used to store additional data. Value can be string, boolean or integer types.

Example: {"coupon":"iOS"}

typestring · enum

The type of fee.

Example: weee

Options: battery, weee, copyright, e_waste, packaging

subdivisionsstring[]

An array of ISO 3166-2 subdivision codes.

Example: ["CA"]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.digitalriver.com/fees/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"skuId":"sku_7834561209","category":"3. IT and Telecommunication Equipment","value":"85\" Class Q900 QLED Smart 8K UHD TV.","amount":0.5,"battery":{"quantity":2,"chemicalSystem":"Alkaline","iecCode":"R20"},"feeExemption":"exempt","brandName":"Samsung","weee":{},"weightAndUnits":"3.00 kg","currency":"USD","country":"US","metadata":{"coupon":"iOS"},"type":"weee","subdivisions":["CA"]}'

200

400

401

403

404

405

406

408

409

429

500

502

503

504

{
  "id": "fee_1971b9b5-7d6b-49d5-b2a6-88ca7e53f750",
  "createdTime": "2018-04-25T20:36:00Z",
  "skuId": "sku_7834561209",
  "category": "3. IT and Telecommunication Equipment",
  "value": "85\" Class Q900 QLED Smart 8K UHD TV.",
  "amount": 0.5,
  "battery": {
    "quantity": 2,
    "chemicalSystem": "Alkaline",
    "iecCode": "R20"
  },
  "complianceAgency": "text",
  "feeExemption": "exempt",
  "brandName": "Samsung",
  "weee": {
    "weeeRegistrationId": "text"
  },
  "weightAndUnits": "3.00 kg",
  "rateAndUnits": "2.00 EUR",
  "currency": "USD",
  "country": "US",
  "liveMode": false,
  "metadata": {
    "coupon": "iOS"
  },
  "updatedTime": "2018-04-25T20:36:00Z",
  "type": "weee",
  "subdivisions": [
    "CA"
  ]
}

200 OK

Deletes a fee by identifier

Permanently deletes a fee. Supply the unique identifier of the fee.

delete

/fees/{id}

Authorizations

Path parameters

idstringrequired

Fee ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.digitalriver.com/fees/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

400

401

403

404

405

406

408

409

429

500

502

503

504

No body

204 No Content

Returns a list of fees

Get all Fees.

get

/fees

Authorizations

Query parameters

createdTimeobject

A filter on the list based on the createdTime field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

eq—return values where the createdTime field equals to this timestamp
gt—return values where the createdTime field is after this timestamp
gte—return values where the createdTime field is after or equal to this timestamp
lt—return values where the createdTime field is before this timestamp
lte—return values where the createdTime field is before or equal to this timestamp

Example: createdTime[gt]=2020-09-22T12:09:44Z

updatedTimeobject

A filter on the list based on the updatedTime field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

eq—return values where the updatedTime field equals this timestamp
gt—return values where the updatedTime field is after this timestamp
gte—return values where the updatedTime field is after or equal to this timestamp
lt—return values where the updatedTime field is before this timestamp
lte—return values where the updatedTime field is before or equal to this timestamp

Example: updatedTime[gt]=2020-09-22T12:09:44Z

endingBeforestring

A cursor for use in pagination. The endingBefore parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with xyz your subsequent calls can include endingBefore=xyz in order to fetch the previous page of the list.

startingAfterstring

A cursor for use in pagination. The startingAfter parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with xyz, your subsequent calls can include startingAfter=xyz in order to fetch the next page of the list.

limitinteger · min: 1 · max: 100

A limit on the number of objects returned. Limit can range between 1 and 100, and the default is 10.

typestring

Only return fees of this type.

skuIdstring

Only return fees for this sku.

categorystring

Only return fees in this category.

countrystring

Only returns fees for this country.

idsstring[]

Only return objects with these IDs.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.digitalriver.com/fees' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

405

406

408

429

500

502

503

504

{
  "hasMore": true,
  "data": [
    {
      "id": "fee_1971b9b5-7d6b-49d5-b2a6-88ca7e53f750",
      "createdTime": "2018-04-25T20:36:00Z",
      "skuId": "sku_7834561209",
      "category": "3. IT and Telecommunication Equipment",
      "value": "85\" Class Q900 QLED Smart 8K UHD TV.",
      "amount": 0.5,
      "battery": {
        "quantity": 2,
        "chemicalSystem": "Alkaline",
        "iecCode": "R20"
      },
      "complianceAgency": "text",
      "feeExemption": "exempt",
      "brandName": "Samsung",
      "weee": {
        "weeeRegistrationId": "text"
      },
      "weightAndUnits": "3.00 kg",
      "rateAndUnits": "2.00 EUR",
      "currency": "USD",
      "country": "US",
      "liveMode": false,
      "metadata": {
        "coupon": "iOS"
      },
      "updatedTime": "2018-04-25T20:36:00Z",
      "type": "weee",
      "subdivisions": [
        "CA"
      ]
    }
  ]
}

200 OK

Creates a fee

This method adds a new fee to an existing SKU.

post

/fees

Authorizations

Body

skuIdstringrequired

The unique identifer of the stock keeping unit associated with the fee.

Example: sku_7834561209

categorystringrequired

The category of the fee as defined by regulatory law.

Example: 3. IT and Telecommunication Equipment

valuestringrequired

The value of the product.

Example: 85" Class Q900 QLED Smart 8K UHD TV.

amountnumber · doublerequired

The fee amount.

Example: 0.5

batteryBattery

A battery fee designed to make entities that produce and sell batteries responsible for collecting recycling fees.

complianceAgencystring

The unique identifier of the recycling agency associated with the product's jurisdiction.

Example: WEEE_ecologic

feeExemptionstring

Indicates whether business to business sales are exempt from paying the fee.

Example: exempt

brandNamestring

The product's brand name.

Example: Samsung

weeeWEEE

Fees that represent waste electrical and electronic equipment.

weightAndUnitsstring

The weight of the unit, minus packaging or batteries, and the unit of measurement applied to the weight.

Example: 3.00 kg

currencystringrequired

A three-letter ISO 4217 currency code.

Example: USD

countrystringrequired

A two-letter ISO 3166 country code.

Example: US

metadataMetadata

Key-value pairs used to store additional data. Value can be string, boolean or integer types.

Example: {"coupon":"iOS"}

typestring · enumrequired

The type of fee.

Example: weee

Options: battery, weee, copyright, e_waste, packaging

subdivisionsstring[]

An array of ISO 3166-2 subdivision codes.

Example: ["CA"]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.digitalriver.com/fees' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"skuId":"sku_7834561209","category":"3. IT and Telecommunication Equipment","value":"85\" Class Q900 QLED Smart 8K UHD TV.","amount":0.5,"battery":{"quantity":2,"chemicalSystem":"Alkaline","iecCode":"R20"},"complianceAgency":"WEEE_ecologic","feeExemption":"exempt","brandName":"Samsung","weee":{},"weightAndUnits":"3.00 kg","currency":"USD","country":"US","metadata":{"coupon":"iOS"},"type":"weee","subdivisions":["CA"]}'

201

400

401

403

405

406

408

409

429

500

502

503

504

{
  "id": "fee_1971b9b5-7d6b-49d5-b2a6-88ca7e53f750",
  "createdTime": "2018-04-25T20:36:00Z",
  "skuId": "sku_7834561209",
  "category": "3. IT and Telecommunication Equipment",
  "value": "85\" Class Q900 QLED Smart 8K UHD TV.",
  "amount": 0.5,
  "battery": {
    "quantity": 2,
    "chemicalSystem": "Alkaline",
    "iecCode": "R20"
  },
  "complianceAgency": "text",
  "feeExemption": "exempt",
  "brandName": "Samsung",
  "weee": {
    "weeeRegistrationId": "text"
  },
  "weightAndUnits": "3.00 kg",
  "rateAndUnits": "2.00 EUR",
  "currency": "USD",
  "country": "US",
  "liveMode": false,
  "metadata": {
    "coupon": "iOS"
  },
  "updatedTime": "2018-04-25T20:36:00Z",
  "type": "weee",
  "subdivisions": [
    "CA"
  ]
}

201 Created