Get Product

curl --request GET \
  --url https://app.flowglad.com/api/v1/products/{id} \
  --header 'Authorization: <api-key>'

{
  "id": "<string>",
  "createdAt": 0,
  "updatedAt": 0,
  "livemode": true,
  "name": "<string>",
  "description": "<string>",
  "imageURL": "<string>",
  "organizationId": "<string>",
  "active": true,
  "singularQuantityLabel": "<string>",
  "pluralQuantityLabel": "<string>",
  "pricingModelId": "<string>",
  "default": true,
  "slug": "<string>",
  "prices": [
    {
      "id": "<string>",
      "createdAt": 0,
      "updatedAt": 0,
      "livemode": true,
      "intervalUnit": "day",
      "name": "<string>",
      "intervalCount": 123,
      "type": "<string>",
      "isDefault": true,
      "unitPrice": 4503599627370495,
      "usageEventsPerUnit": "<unknown>",
      "productId": "<string>",
      "active": true,
      "currency": "USD",
      "slug": "<string>",
      "usageMeterId": "<unknown>",
      "trialPeriodDays": 4503599627370495
    }
  ],
  "defaultPrice": {
    "id": "<string>",
    "createdAt": 0,
    "updatedAt": 0,
    "livemode": true,
    "intervalUnit": "day",
    "name": "<string>",
    "intervalCount": 123,
    "type": "<string>",
    "isDefault": true,
    "unitPrice": 4503599627370495,
    "usageEventsPerUnit": "<unknown>",
    "productId": "<string>",
    "active": true,
    "currency": "USD",
    "slug": "<string>",
    "usageMeterId": "<unknown>",
    "trialPeriodDays": 4503599627370495
  },
  "features": [
    {
      "id": "<string>",
      "createdAt": 0,
      "updatedAt": 0,
      "livemode": true,
      "organizationId": "<string>",
      "type": "<string>",
      "slug": "<string>",
      "name": "<string>",
      "description": "<string>",
      "pricingModelId": "<string>",
      "active": true,
      "amount": "<unknown>",
      "usageMeterId": "<unknown>",
      "renewalFrequency": "<unknown>"
    }
  ]
}

GET

api

products

{id}

Get Product

curl --request GET \
  --url https://app.flowglad.com/api/v1/products/{id} \
  --header 'Authorization: <api-key>'

{
  "id": "<string>",
  "createdAt": 0,
  "updatedAt": 0,
  "livemode": true,
  "name": "<string>",
  "description": "<string>",
  "imageURL": "<string>",
  "organizationId": "<string>",
  "active": true,
  "singularQuantityLabel": "<string>",
  "pluralQuantityLabel": "<string>",
  "pricingModelId": "<string>",
  "default": true,
  "slug": "<string>",
  "prices": [
    {
      "id": "<string>",
      "createdAt": 0,
      "updatedAt": 0,
      "livemode": true,
      "intervalUnit": "day",
      "name": "<string>",
      "intervalCount": 123,
      "type": "<string>",
      "isDefault": true,
      "unitPrice": 4503599627370495,
      "usageEventsPerUnit": "<unknown>",
      "productId": "<string>",
      "active": true,
      "currency": "USD",
      "slug": "<string>",
      "usageMeterId": "<unknown>",
      "trialPeriodDays": 4503599627370495
    }
  ],
  "defaultPrice": {
    "id": "<string>",
    "createdAt": 0,
    "updatedAt": 0,
    "livemode": true,
    "intervalUnit": "day",
    "name": "<string>",
    "intervalCount": 123,
    "type": "<string>",
    "isDefault": true,
    "unitPrice": 4503599627370495,
    "usageEventsPerUnit": "<unknown>",
    "productId": "<string>",
    "active": true,
    "currency": "USD",
    "slug": "<string>",
    "usageMeterId": "<unknown>",
    "trialPeriodDays": 4503599627370495
  },
  "features": [
    {
      "id": "<string>",
      "createdAt": 0,
      "updatedAt": 0,
      "livemode": true,
      "organizationId": "<string>",
      "type": "<string>",
      "slug": "<string>",
      "name": "<string>",
      "description": "<string>",
      "pricingModelId": "<string>",
      "active": true,
      "amount": "<unknown>",
      "usageMeterId": "<unknown>",
      "renewalFrequency": "<unknown>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Path Parameters

string

required

Response

Successful response

string

required

createdAt

integer

required

Epoch milliseconds.

Required range: -9007199254740991 <= x <= 9007199254740991

updatedAt

integer

required

Epoch milliseconds.

Required range: -9007199254740991 <= x <= 9007199254740991

livemode

boolean

required

name

string

required

description

string | null

required

imageURL

string | null

required

organizationId

string

required

active

boolean

required

singularQuantityLabel

string | null

required

pluralQuantityLabel

string | null

required

pricingModelId

string

required

default

boolean

required

slug

string | null

required

prices

object[]

required

Option 1
Option 2
Option 3

Show child attributes

prices.id

string

required

prices.createdAt

integer

required

Epoch milliseconds.

Required range: -9007199254740991 <= x <= 9007199254740991

prices.updatedAt

integer

required

Epoch milliseconds.

Required range: -9007199254740991 <= x <= 9007199254740991

prices.livemode

boolean

required

prices.intervalUnit

enum<string>

required

Available options:

day,

week,

month,

year

prices.name

string | null

required

prices.intervalCount

integer

required

A positive integer

Required range: x <= 9007199254740991

prices.type

string

required

Allowed value: "subscription"

prices.isDefault

boolean

required

Whether or not this price is the default price for the product.

prices.unitPrice

required

The price per unit. This should be in the smallest unit of the currency. For example, if the currency is USD, GBP, CAD, EUR or SGD, the price should be in cents.

Required range: 0 < x <= 9007199254740991

prices.usageEventsPerUnit

null

required

Omitted.

prices.productId

string

required

prices.active

boolean

required

prices.currency

enum<string>

required

Currency code

Available options:

USD,

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BWP,

BYN,

BZD,

CAD,

CDF,

CHF,

CLP,

CNY,

COP,

CRC,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HTG,

HUF,

IDR,

ILS,

INR,

ISK,

JMD,

JPY,

KES,

KGS,

KHR,

KMF,

KRW,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SEK,

SGD,

SHP,

SLE,

SOS,

SRD,

STD,

SZL,

THB,

TJS,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

UYU,

UZS,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW

prices.slug

string | null

required

prices.usageMeterId

null

required

Omitted.

prices.trialPeriodDays

The trial period in days. If the trial period is 0 or null, there will be no trial period.

Required range: 0 < x <= 9007199254740991

defaultPrice

object

required

The default price for the product. If no price is explicitly set as default, will return the first price created for the product..

Option 1
Option 2
Option 3

Show child attributes

defaultPrice.id

string

required

defaultPrice.createdAt

integer

required

Epoch milliseconds.

Required range: -9007199254740991 <= x <= 9007199254740991

defaultPrice.updatedAt

integer

required

Epoch milliseconds.

Required range: -9007199254740991 <= x <= 9007199254740991

defaultPrice.livemode

boolean

required

defaultPrice.intervalUnit

enum<string>

required

Available options:

day,

week,

month,

year

defaultPrice.name

string | null

required

defaultPrice.intervalCount

integer

required

A positive integer

Required range: x <= 9007199254740991

defaultPrice.type

string

required

Allowed value: "subscription"

defaultPrice.isDefault

boolean

required

Whether or not this price is the default price for the product.

defaultPrice.unitPrice

required

The price per unit. This should be in the smallest unit of the currency. For example, if the currency is USD, GBP, CAD, EUR or SGD, the price should be in cents.

Required range: 0 < x <= 9007199254740991

defaultPrice.usageEventsPerUnit

null

required

Omitted.

defaultPrice.productId

string

required

defaultPrice.active

boolean

required

defaultPrice.currency

enum<string>

required

Currency code

Available options:

USD,

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BWP,

BYN,

BZD,

CAD,

CDF,

CHF,

CLP,

CNY,

COP,

CRC,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HTG,

HUF,

IDR,

ILS,

INR,

ISK,

JMD,

JPY,

KES,

KGS,

KHR,

KMF,

KRW,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SEK,

SGD,

SHP,

SLE,

SOS,

SRD,

STD,

SZL,

THB,

TJS,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

UYU,

UZS,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW

defaultPrice.slug

string | null

required

defaultPrice.usageMeterId

null

required

Omitted.

defaultPrice.trialPeriodDays

The trial period in days. If the trial period is 0 or null, there will be no trial period.

Required range: 0 < x <= 9007199254740991

features

object[]

required

Option 1
Option 2

Show child attributes

features.id

string

required

features.createdAt

integer

required

Epoch milliseconds.

Required range: -9007199254740991 <= x <= 9007199254740991

features.updatedAt

integer

required

Epoch milliseconds.

Required range: -9007199254740991 <= x <= 9007199254740991

features.livemode

boolean

required

features.organizationId

string

required

features.type

string

required

Allowed value: "toggle"

features.slug

string

required

features.name

string

required

features.description

string

required

features.pricingModelId

string

required

features.active

boolean

required

features.amount

null

features.usageMeterId

null

features.renewalFrequency

null

Create Product Update Product

⌘I

API Documentation

Payments

Checkout Sessions

Products

Prices

Purchases

Customer

Discounts

Invoice Line Items

Invoices

Pricing Models

API Keys

Subscriptions

Payment Methods

Usage Meters

Usage Events

Webhooks

Features

Product Features

Subscription Item Features

Get Product

Authorizations

Path Parameters

Response