LogoLogo
System Status
2020-01-07
2020-01-07
  • 2020-01-07
  • Charges
  • Checkouts
  • Country specifications
  • Customers
  • Events
  • Fees
  • File links
  • Files
  • Fulfillments
  • Orders
  • Payouts
  • Refunds
  • Returns
  • SKUs
  • Sales summaries
  • Sales transactions
  • Sources
  • Webhooks
Powered by GitBook
On this page

Fees

PreviousEventsNextFile links

Last updated 6 months ago

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.

Gets a Fee by ID

get

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

Path parameters
idstringRequired

Fee identifier.

Responses
200
OK.
application/json
400
400 Bad Request
application/json
401
401 Unauthorized
application/json
403
403 Forbidden
application/json
404
404 Not Found
application/json
405
405 Method Not Allowed
application/json
406
406 Not Acceptable
application/json
408
408 Request Timeout
application/json
429
429 Too Many Requests
application/json
500
500 Internal Server Error
application/json
502
502 Bad Gateway Error
application/json
503
503 Service Unavailable Error
application/json
504
504 Gateway Timeout Error
application/json
get
GET /fees/{id} HTTP/1.1
Host: api.digitalriver.com
Accept: */*
{
  "id": "fee_1971b9b5-7d6b-49d5-b2a6-88ca7e53f750",
  "createdTime": "2025-05-09T05:12:22.815Z",
  "type": "weee",
  "skuId": "sku_7834561209",
  "category": "OLED TVs.",
  "value": "85\" Class Q900 QLED Smart 8K UHD TV.",
  "amount": 0.5,
  "currency": "USD",
  "country": "US",
  "subdivisions": [
    "CA"
  ],
  "visible": true,
  "liveMode": false,
  "metadata": {
    "coupon": "iOS"
  },
  "updatedTime": "2025-05-09T05:12:22.815Z"
}

Deletes a fee by ID

delete

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

Path parameters
idintegerRequired

Fee ID

Responses
204
204 No Content
400
400 Bad Request
application/json
401
401 Unauthorized
application/json
403
403 Forbidden
application/json
404
401 Not Found
application/json
405
405 Method Not Allowed
application/json
406
406 Not Acceptable
application/json
408
408 Request Timeout
application/json
409
409 Conflict
application/json
429
429 Too Many Requests
application/json
500
500 Internal Server Error
application/json
502
502 Bad Gateway Error
application/json
503
503 Service Unavailable Error
application/json
504
504 Gateway Timeout Error
application/json
delete
DELETE /fees/{id} HTTP/1.1
Host: api.digitalriver.com
Accept: */*

No content

  • GETReturns a list of fees
  • POSTCreates a fee
  • GETGets a Fee by ID
  • POSTUpdates an existing Fee
  • DELETEDeletes a fee by ID

Updates an existing Fee

post

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

Path parameters
idstringRequired

Fee identifier.

Body
typestring · enumOptional

Type of fee.

Example: weeePossible values:
categorystringOptional

.

Example: OLED TVs.
valuestringOptional

.

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

The fee amount.

Example: 0.5
currencystringOptional

3-letter ISO currency code.

Example: USD
countrystringOptional

2-letter country code.

Example: US
subdivisionsstring[]Optional

Array of ISO 3166-2 subdivision codes.

Example: ["CA"]
visiblebooleanOptional

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.

Default: falseExample: true
metadataany ofOptional
or
or
Responses
200
200 OK
application/json
400
400 Bad Request
application/json
401
401 Unauthorized
application/json
403
403 Forbidden
application/json
404
401 Not Found
application/json
405
405 Method Not Allowed
application/json
406
406 Not Acceptable
application/json
408
408 Request Timeout
application/json
409
409 Conflict
application/json
429
429 Too Many Requests
application/json
500
500 Internal Server Error
application/json
502
502 Bad Gateway Error
application/json
503
503 Service Unavailable Error
application/json
504
504 Gateway Timeout Error
application/json
post
POST /fees/{id} HTTP/1.1
Host: api.digitalriver.com
Content-Type: application/json
Accept: */*
Content-Length: 196

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

Returns a list of fees

get

Get all Fees.

Query parameters
createdTimestring · date-timeOptional

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-timeOptional

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
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.

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
400
400 Bad Request
application/json
401
401 Unauthorized
application/json
403
403 Forbidden
application/json
405
405 Method Not Allowed
application/json
406
406 Not Acceptable
application/json
408
408 Request Timeout
application/json
429
429 Too Many Requests
application/json
500
500 Internal Server Error
application/json
502
502 Bad Gateway Error
application/json
503
503 Service Unavailable Error
application/json
504
504 Gateway Timeout Error
application/json
get
GET /fees HTTP/1.1
Host: api.digitalriver.com
Accept: */*
{
  "hasMore": true,
  "data": [
    {
      "id": "fee_1971b9b5-7d6b-49d5-b2a6-88ca7e53f750",
      "createdTime": "2025-05-09T05:12:22.815Z",
      "type": "weee",
      "skuId": "sku_7834561209",
      "category": "OLED TVs.",
      "value": "85\" Class Q900 QLED Smart 8K UHD TV.",
      "amount": 0.5,
      "currency": "USD",
      "country": "US",
      "subdivisions": [
        "CA"
      ],
      "visible": true,
      "liveMode": false,
      "metadata": {
        "coupon": "iOS"
      },
      "updatedTime": "2025-05-09T05:12:22.815Z"
    }
  ]
}

Creates a fee

post

Adds a new fee to an existing SKU.

Body
typestring · enumRequired

Type of fee.

Example: weeePossible values:
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
subdivisionsstring[]Optional

Array of ISO 3166-2 subdivision codes.

Example: ["CA"]
visiblebooleanOptional

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.

Default: falseExample: true
metadataany ofOptional
or
or
Responses
201
201 Created
application/json
400
400 Bad Request
application/json
401
401 Unauthorized
application/json
403
403 Forbidden
application/json
405
405 Method Not Allowed
application/json
406
406 Not Acceptable
application/json
408
408 Request Timeout
application/json
409
409 Conflict
application/json
429
429 Too Many Requests
application/json
500
500 Internal Server Error
application/json
502
502 Bad Gateway Error
application/json
503
503 Service Unavailable Error
application/json
504
504 Gateway Timeout Error
application/json
post
POST /fees HTTP/1.1
Host: api.digitalriver.com
Content-Type: application/json
Accept: */*
Content-Length: 221

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