Skip to main content
GET
/
v1
/
prices
List
curl --request GET \
  --url https://{defaultHost}/v1/prices \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/prices"
  },
  "data": [
    {
      "id": "7065a226-1020-44fa-a3b2-ebd700963fef",
      "object": "price",
      "ad_hoc": false,
      "ad_hoc_max_amount": null,
      "ad_hoc_min_amount": 0,
      "amount": 2900,
      "archived": false,
      "archived_at": null,
      "currency": "usd",
      "current_version": true,
      "full_amount": 2900,
      "license_activation_limit": null,
      "metadata": {},
      "name": null,
      "position": 0,
      "portal_subscription_update_enabled": true,
      "restart_subscription_on_completed": false,
      "revoke_after_days": null,
      "revoke_purchases_on_completed": false,
      "recurring_interval": null,
      "recurring_interval_count": null,
      "recurring_period_count": null,
      "scratch_amount": null,
      "setup_fee_amount": 0,
      "setup_fee_enabled": false,
      "setup_fee_trial_enabled": true,
      "setup_fee_name": null,
      "trial_duration_days": null,
      "current_swap": null,
      "product": "4b768248-0138-45d9-9093-eab9e410afbc",
      "renewal_price": null,
      "discarded_at": null,
      "created_at": 1767909733,
      "updated_at": 1767909733
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Query Parameters

ad_hoc
boolean

Only return prices that allow ad hoc amounts or not.

archived
boolean

Only return objects that are archived or not archived.

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.

page
integer

The page of items you want returned.

product_ids[]
string[]

Only return objects that belong to the given products.

sort
string

The sorting column and order to be used for this collection. Available sorting columns for this endpoint are amount, created_at, and updated_at.

Response

200 - application/json

Success

object
string

A string describing the object type returned.

pagination
object
data
array

An array of objects.