Skip to main content
GET
/
v1
/
auto_fees
List
curl --request GET \
  --url https://{defaultHost}/v1/auto_fees \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/auto_fees"
  },
  "data": [
    {
      "id": "5a1bd383-b942-44cc-8710-d56a00b1c782",
      "object": "auto_fee",
      "enabled": true,
      "amount_adjustment": null,
      "currency": "usd",
      "discount": false,
      "end_at": null,
      "expired": false,
      "fee_target": "line_item",
      "metadata": {},
      "name": "Auto Fee 1",
      "ongoing": true,
      "percent_adjustment": 5,
      "rules": null,
      "start_at": 1767909671,
      "created_at": 1767909671,
      "updated_at": 1767909671
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

enabled
boolean

Only return objects that are enabled or not enabled.

expired
boolean

Only return objects that have expired or not expired.

ids[]
string[]

Only return objects with the given IDs.

limit
integer

A limit on the number of items to be returned, between 1 and 100.

ongoing
boolean

Only return objects that are ongoing or not ongoing.

page
integer

The page of items you want returned.

Response

200 - application/json

Success

object
string

A string describing the object type returned.

pagination
object
data
array

An array of objects.