Skip to main content
GET
Get price

Headers

x-environment
string<uuid>
required

Configure which environment the request will handle. If the provided credentials do not allow access to this specified environment, a 403 Forbidden response is returned.

Path Parameters

priceId
string<uuid>
required

Response

OK

id
string<uuid>
read-only

Unique id for the price.

name
string | null
read-only

Name of the price.

description
string | null

Internal description for this price, not shown to customers. Typically notes for your team.

priceModel
enum<string>
Available options:
fee,
volume,
graduated,
package
purchase
enum<string>
Available options:
one_time,
recurring
termCount
integer<int32>

Billing cycle's term frequency (count).

termUnit
enum<string>
Available options:
day,
week,
month,
year
pricing
object | null
read-only