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 3 months ago

Returns a list of fees

Get all Fees.

get

/fees

Query parameters

createdTimestring · date-time

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:

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

updatedTimestring · date-time

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:

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

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.

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'

200

400

401

403

405

406

408

429

500

502

503

504

{
  "hasMore": true,
  "data": [
    {
      "id": "fee_1971b9b5-7d6b-49d5-b2a6-88ca7e53f750",
      "createdTime": "2025-02-23T02:48:57.733Z",
      "type": "weee",
      "skuId": "sku_7834561209",
      "category": "OLED TVs.",
      "value": "85\" Class Q900 QLED Smart 8K UHD TV.",
      "amount": 0.5,
      "currency": "USD",
      "country": "US",
      "visible": true,
      "liveMode": false,
      "updatedTime": "2025-02-23T02:48:57.733Z",
      "subdivisions": [
        "CA"
      ],
      "metadata": {
        "coupon": "iOS"
      }
    }
  ]
}

200 OK

Creates a fee

Adds a new fee to an existing SKU.

post

/fees

Body

skuIdstringrequired

Example: sku_7834561209

categorystringrequired

Example: OLED TVs.

valuestringrequired

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

amountnumber · doublerequired

The fee amount.

Example: 0.5

currencystringrequired

3-letter ISO currency code.

Example: USD

countrystringrequired

2-letter country code.

Example: US

visibleboolean

If false indicates that the jurisdiction requires that the fee be included in the price displayed to the shopper. If true indicates that the jurisdiction requires fee-exclusive pricing.

Example: true

typestring · enumrequired

Type of fee.

Example: weee

Options: battery, weee, copyright, e_waste

subdivisionsstring[]

Array of ISO 3166-2 subdivision codes.

Example: ["CA"]

metadataany of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.digitalriver.com/fees' \
  --header 'Content-Type: application/json' \
  --data '{"skuId":"sku_7834561209","category":"OLED TVs.","value":"85\" Class Q900 QLED Smart 8K UHD TV.","amount":0.5,"currency":"USD","country":"US","visible":true,"type":"weee","subdivisions":["CA"],"metadata":{"coupon":"iOS"}}'

201

400

401

403

405

406

408

409

429

500

502

503

504

{
  "id": "fee_1971b9b5-7d6b-49d5-b2a6-88ca7e53f750",
  "createdTime": "2025-02-23T02:48:57.733Z",
  "type": "weee",
  "skuId": "sku_7834561209",
  "category": "OLED TVs.",
  "value": "85\" Class Q900 QLED Smart 8K UHD TV.",
  "amount": 0.5,
  "currency": "USD",
  "country": "US",
  "visible": true,
  "liveMode": false,
  "updatedTime": "2025-02-23T02:48:57.733Z",
  "subdivisions": [
    "CA"
  ],
  "metadata": {
    "coupon": "iOS"
  }
}

201 Created

Gets a Fee by ID

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

get

/fees/{id}

Path parameters

idstringrequired

Fee identifier.

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

401

403

404

405

406

408

429

500

502

503

504

{
  "id": "fee_1971b9b5-7d6b-49d5-b2a6-88ca7e53f750",
  "createdTime": "2025-02-23T02:48:57.733Z",
  "type": "weee",
  "skuId": "sku_7834561209",
  "category": "OLED TVs.",
  "value": "85\" Class Q900 QLED Smart 8K UHD TV.",
  "amount": 0.5,
  "currency": "USD",
  "country": "US",
  "visible": true,
  "liveMode": false,
  "updatedTime": "2025-02-23T02:48:57.733Z",
  "subdivisions": [
    "CA"
  ],
  "metadata": {
    "coupon": "iOS"
  }
}

OK.

Updates an existing Fee

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

post

/fees/{id}

Path parameters

idstringrequired

Fee identifier.

Body

categorystring

Example: OLED TVs.

valuestring

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

amountnumber · double

The fee amount.

Example: 0.5

currencystring

3-letter ISO currency code.

Example: USD

countrystring

2-letter country code.

Example: US

visibleboolean

If false indicates that the jurisdiction requires that the fee be included in the price displayed to the shopper. If true indicates that the jurisdiction requires fee-exclusive pricing.

Example: true

typestring · enum

Type of fee.

Example: weee

Options: battery, weee, copyright, e_waste

subdivisionsstring[]

Array of ISO 3166-2 subdivision codes.

Example: ["CA"]

metadataany of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.digitalriver.com/fees/{id}' \
  --header 'Content-Type: application/json' \
  --data '{"category":"OLED TVs.","value":"85\" Class Q900 QLED Smart 8K UHD TV.","amount":0.5,"currency":"USD","country":"US","visible":true,"type":"weee","subdivisions":["CA"],"metadata":{"coupon":"iOS"}}'

200

400

401

403

404

405

406

408

409

429

500

502

503

504

{
  "id": "fee_1971b9b5-7d6b-49d5-b2a6-88ca7e53f750",
  "createdTime": "2025-02-23T02:48:57.733Z",
  "type": "weee",
  "skuId": "sku_7834561209",
  "category": "OLED TVs.",
  "value": "85\" Class Q900 QLED Smart 8K UHD TV.",
  "amount": 0.5,
  "currency": "USD",
  "country": "US",
  "visible": true,
  "liveMode": false,
  "updatedTime": "2025-02-23T02:48:57.733Z",
  "subdivisions": [
    "CA"
  ],
  "metadata": {
    "coupon": "iOS"
  }
}

200 OK

Deletes a fee by ID

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

delete

/fees/{id}

Path parameters

idintegerrequired

Fee ID

Responses

application/json

cURL

JavaScript

Python

HTTP

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

204

400

401

403

404

405

406

408

409

429

500

502

503

504

No body

204 No Content