System Status

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 Regulatory fees for more information.

Returns a list of fees

get

Get all Fees.

Authorizations
Query parameters
endingBeforestringOptional

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.

startingAfterstringOptional

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: 100Optional

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

typestringOptional

Only return fees of this type.

skuIdstringOptional

Only return fees for this sku.

categorystringOptional

Only return fees in this category.

countrystringOptional

Only returns fees for this country.

idsstring[]Optional

Only return objects with these IDs.

Responses
200
200 OK
application/json
get
GET /fees HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "hasMore": true,
  "data": [
    {
      "id": "fee_1971b9b5-7d6b-49d5-b2a6-88ca7e53f750",
      "createdTime": {
        "offset": {
          "totalSeconds": 0,
          "id": "Z",
          "rules": {
            "fixedOffset": true,
            "transitions": [],
            "transitionRules": []
          }
        },
        "nano": 0,
        "year": 2018,
        "monthValue": 4,
        "dayOfMonth": 25,
        "hour": 20,
        "minute": 36,
        "second": 0,
        "dayOfWeek": "WEDNESDAY",
        "dayOfYear": 115,
        "month": "APRIL"
      },
      "type": "weee",
      "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",
      "subdivisions": [
        "CA"
      ],
      "liveMode": false,
      "metadata": {
        "coupon": "iOS"
      },
      "updatedTime": {
        "offset": {
          "totalSeconds": 0,
          "id": "Z",
          "rules": {
            "fixedOffset": true,
            "transitions": [],
            "transitionRules": []
          }
        },
        "nano": 0,
        "year": 2018,
        "monthValue": 4,
        "dayOfMonth": 25,
        "hour": 20,
        "minute": 36,
        "second": 0,
        "dayOfWeek": "WEDNESDAY",
        "dayOfYear": 115,
        "month": "APRIL"
      }
    }
  ]
}

Creates a fee

post

This method adds a new fee to an existing SKU.

Authorizations
Body
typestring · enumRequired

The type of fee.

Example: weeePossible values:
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
complianceAgencystringOptional

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

Example: WEEE_ecologic
feeExemptionstringOptional

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

Example: exempt
brandNamestringOptional

The product's brand name.

Example: Samsung
weightAndUnitsstringOptional

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
subdivisionsstring[]Optional

An array of ISO 3166-2 subdivision codes.

Example: ["CA"]
Responses
201
201 Created
application/json
post
POST /fees HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 448

{
  "type": "weee",
  "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": {
    "weeeRegistrationId": "text"
  },
  "weightAndUnits": "3.00 kg",
  "currency": "USD",
  "country": "US",
  "subdivisions": [
    "CA"
  ],
  "metadata": {
    "coupon": "iOS"
  }
}
{
  "id": "fee_1971b9b5-7d6b-49d5-b2a6-88ca7e53f750",
  "createdTime": {
    "offset": {
      "totalSeconds": 0,
      "id": "Z",
      "rules": {
        "fixedOffset": true,
        "transitions": [],
        "transitionRules": []
      }
    },
    "nano": 0,
    "year": 2018,
    "monthValue": 4,
    "dayOfMonth": 25,
    "hour": 20,
    "minute": 36,
    "second": 0,
    "dayOfWeek": "WEDNESDAY",
    "dayOfYear": 115,
    "month": "APRIL"
  },
  "type": "weee",
  "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",
  "subdivisions": [
    "CA"
  ],
  "liveMode": false,
  "metadata": {
    "coupon": "iOS"
  },
  "updatedTime": {
    "offset": {
      "totalSeconds": 0,
      "id": "Z",
      "rules": {
        "fixedOffset": true,
        "transitions": [],
        "transitionRules": []
      }
    },
    "nano": 0,
    "year": 2018,
    "monthValue": 4,
    "dayOfMonth": 25,
    "hour": 20,
    "minute": 36,
    "second": 0,
    "dayOfWeek": "WEDNESDAY",
    "dayOfYear": 115,
    "month": "APRIL"
  }
}

Gets a Fee by identifier

get

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

Authorizations
Path parameters
idstringRequired

Fee identifier.

Responses
200
OK
application/json
get
GET /fees/{id} HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "fee_1971b9b5-7d6b-49d5-b2a6-88ca7e53f750",
  "createdTime": {
    "offset": {
      "totalSeconds": 0,
      "id": "Z",
      "rules": {
        "fixedOffset": true,
        "transitions": [],
        "transitionRules": []
      }
    },
    "nano": 0,
    "year": 2018,
    "monthValue": 4,
    "dayOfMonth": 25,
    "hour": 20,
    "minute": 36,
    "second": 0,
    "dayOfWeek": "WEDNESDAY",
    "dayOfYear": 115,
    "month": "APRIL"
  },
  "type": "weee",
  "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",
  "subdivisions": [
    "CA"
  ],
  "liveMode": false,
  "metadata": {
    "coupon": "iOS"
  },
  "updatedTime": {
    "offset": {
      "totalSeconds": 0,
      "id": "Z",
      "rules": {
        "fixedOffset": true,
        "transitions": [],
        "transitionRules": []
      }
    },
    "nano": 0,
    "year": 2018,
    "monthValue": 4,
    "dayOfMonth": 25,
    "hour": 20,
    "minute": 36,
    "second": 0,
    "dayOfWeek": "WEDNESDAY",
    "dayOfYear": 115,
    "month": "APRIL"
  }
}

Updates an existing Fee

post

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

Authorizations
Path parameters
idstringRequired

Fee identifier

Body
typestring · enumOptional

The type of fee.

Example: weeePossible values:
skuIdstringOptional

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

Example: sku_7834561209
categorystringOptional

The category of the fee as defined by regulatory law.

Example: 3. IT and Telecommunication Equipment
valuestringOptional

The value of the product.

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

The fee amount.

Example: 0.5
complianceAgencystringOptional

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

feeExemptionstringOptional

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

Example: exempt
brandNamestringOptional

The product's brand name.

Example: Samsung
weightAndUnitsstringOptional

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

Example: 3.00 kg
currencystringOptional

A three-letter ISO 4217 currency code.

Example: USD
countrystringOptional

A two-letter ISO 3166 country code.

Example: US
subdivisionsstring[]Optional

An array of ISO 3166-2 subdivision codes.

Example: ["CA"]
Responses
200
200 OK
application/json
post
POST /fees/{id} HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 439

{
  "type": "weee",
  "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",
  "currency": "USD",
  "country": "US",
  "subdivisions": [
    "CA"
  ],
  "metadata": {
    "coupon": "iOS"
  }
}
{
  "id": "fee_1971b9b5-7d6b-49d5-b2a6-88ca7e53f750",
  "createdTime": {
    "offset": {
      "totalSeconds": 0,
      "id": "Z",
      "rules": {
        "fixedOffset": true,
        "transitions": [],
        "transitionRules": []
      }
    },
    "nano": 0,
    "year": 2018,
    "monthValue": 4,
    "dayOfMonth": 25,
    "hour": 20,
    "minute": 36,
    "second": 0,
    "dayOfWeek": "WEDNESDAY",
    "dayOfYear": 115,
    "month": "APRIL"
  },
  "type": "weee",
  "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",
  "subdivisions": [
    "CA"
  ],
  "liveMode": false,
  "metadata": {
    "coupon": "iOS"
  },
  "updatedTime": {
    "offset": {
      "totalSeconds": 0,
      "id": "Z",
      "rules": {
        "fixedOffset": true,
        "transitions": [],
        "transitionRules": []
      }
    },
    "nano": 0,
    "year": 2018,
    "monthValue": 4,
    "dayOfMonth": 25,
    "hour": 20,
    "minute": 36,
    "second": 0,
    "dayOfWeek": "WEDNESDAY",
    "dayOfYear": 115,
    "month": "APRIL"
  }
}

Deletes a fee by identifier

delete

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

Authorizations
Path parameters
idstringRequired

Fee ID

Responses
204
204 No Content
delete
DELETE /fees/{id} HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content
PreviousEventsNextFile links

Last updated