Skip to main content
GET
/
v1
/
prices
/
{id}
Get Price
curl --request GET \
  --url https://api.withflex.com/v1/prices/{id} \
  --header 'Authorization: Bearer <token>'
{
  "price": {
    "price_id": "<string>",
    "unit_amount": 123,
    "active": true,
    "product": {
      "product_id": "<string>",
      "name": "<string>",
      "created_at": "<string>",
      "active": true,
      "hsa_fsa_eligibility": "not_eligible",
      "test_mode": true,
      "description": "<string>",
      "document_description": "<string>",
      "visit_type": "cbtSleep",
      "upc_code": "<string>",
      "gtin": "<string>",
      "reference_gtin": "<string>",
      "metadata": {},
      "url": "<string>"
    },
    "created_at": "<string>",
    "type": "one_time",
    "test_mode": true,
    "description": "<string>",
    "trial_period_days": 123,
    "recurring": {
      "interval": "daily",
      "interval_count": 1,
      "trial_period_days": 1
    },
    "metadata": {},
    "hsa_fsa_eligibility": "not_eligible"
  }
}

Authorizations

​
Authorization
string
header
required

Use a Bearer token to access this API.

Query Parameters

​
limit
integer<int32> | null
​
offset
integer<int32> | null
​
active
boolean | null
​
product
string | null
​
expand_product
boolean | null
​
starting_after
string | null

A cursor for use in pagination. starting_after is a price ID that defines your place in the list. For instance, if you make a list request and receive 20 prices, ending with fprice_xyz, your subsequent call can include starting_after=fprice_xyz to fetch the next page.

​
ending_before
string | null

A cursor for use in pagination. ending_before is a price ID that defines your place in the list. For instance, if you make a list request and receive 20 prices, starting with fprice_abc, your subsequent call can include ending_before=fprice_abc to fetch the previous page.

Response

​
price
object
required

Prices define the unit cost and (optional) billing cycle for both recurring and one-time purchases of products. Prices belong to a given product. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices.