Get Pricing Model

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

{
  "pricingModel": {
    "id": "<string>",
    "createdAt": 0,
    "updatedAt": 0,
    "livemode": true,
    "organizationId": "<string>",
    "isDefault": true,
    "name": "<string>",
    "products": [
      {
        "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>"
          }
        ]
      }
    ],
    "usageMeters": [
      {
        "id": "<string>",
        "createdAt": 0,
        "updatedAt": 0,
        "livemode": true,
        "organizationId": "<string>",
        "name": "<string>",
        "pricingModelId": "<string>",
        "slug": "<string>",
        "aggregationType": "sum"
      }
    ],
    "defaultProduct": {
      "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

pricing-models

{id}

Get Pricing Model

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

{
  "pricingModel": {
    "id": "<string>",
    "createdAt": 0,
    "updatedAt": 0,
    "livemode": true,
    "organizationId": "<string>",
    "isDefault": true,
    "name": "<string>",
    "products": [
      {
        "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>"
          }
        ]
      }
    ],
    "usageMeters": [
      {
        "id": "<string>",
        "createdAt": 0,
        "updatedAt": 0,
        "livemode": true,
        "organizationId": "<string>",
        "name": "<string>",
        "pricingModelId": "<string>",
        "slug": "<string>",
        "aggregationType": "sum"
      }
    ],
    "defaultProduct": {
      "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

pricingModel

object

required

Show child attributes

pricingModel.id

string

required

pricingModel.createdAt

integer

required

Epoch milliseconds.

Required range: -9007199254740991 <= x <= 9007199254740991

pricingModel.updatedAt

integer

required

Epoch milliseconds.

Required range: -9007199254740991 <= x <= 9007199254740991

pricingModel.livemode

boolean

required

pricingModel.organizationId

string

required

pricingModel.isDefault

boolean

required

pricingModel.name

string

required

pricingModel.products

object[]

required

Show child attributes

pricingModel.products.id

string

required

pricingModel.products.createdAt

integer

required

Epoch milliseconds.

Required range: -9007199254740991 <= x <= 9007199254740991

pricingModel.products.updatedAt

integer

required

Epoch milliseconds.

Required range: -9007199254740991 <= x <= 9007199254740991

pricingModel.products.livemode

boolean

required

pricingModel.products.name

string

required

pricingModel.products.description

string | null

required

pricingModel.products.imageURL

string | null

required

pricingModel.products.organizationId

string

required

pricingModel.products.active

boolean

required

pricingModel.products.singularQuantityLabel

string | null

required

pricingModel.products.pluralQuantityLabel

string | null

required

pricingModel.products.pricingModelId

string

required

pricingModel.products.default

boolean

required

pricingModel.products.slug

string | null

required

pricingModel.products.prices

object[]

required

Option 1
Option 2
Option 3

Show child attributes

pricingModel.products.prices.id

string

required

pricingModel.products.prices.createdAt

integer

required

Epoch milliseconds.

Required range: -9007199254740991 <= x <= 9007199254740991

pricingModel.products.prices.updatedAt

integer

required

Epoch milliseconds.

Required range: -9007199254740991 <= x <= 9007199254740991

pricingModel.products.prices.livemode

boolean

required

pricingModel.products.prices.intervalUnit

enum<string>

required

Available options:

day,

week,

month,

year

pricingModel.products.prices.name

string | null

required

pricingModel.products.prices.intervalCount

integer

required

A positive integer

Required range: x <= 9007199254740991

pricingModel.products.prices.type

string

required

Allowed value: "subscription"

pricingModel.products.prices.isDefault

boolean

required

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

pricingModel.products.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

pricingModel.products.prices.usageEventsPerUnit

null

required

Omitted.

pricingModel.products.prices.productId

string

required

pricingModel.products.prices.active

boolean

required

pricingModel.products.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

pricingModel.products.prices.slug

string | null

required

pricingModel.products.prices.usageMeterId

null

required

Omitted.

pricingModel.products.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

pricingModel.products.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

pricingModel.products.defaultPrice.id

string

required

pricingModel.products.defaultPrice.createdAt

integer

required

Epoch milliseconds.

Required range: -9007199254740991 <= x <= 9007199254740991

pricingModel.products.defaultPrice.updatedAt

integer

required

Epoch milliseconds.

Required range: -9007199254740991 <= x <= 9007199254740991

pricingModel.products.defaultPrice.livemode

boolean

required

pricingModel.products.defaultPrice.intervalUnit

enum<string>

required

Available options:

day,

week,

month,

year

pricingModel.products.defaultPrice.name

string | null

required

pricingModel.products.defaultPrice.intervalCount

integer

required

A positive integer

Required range: x <= 9007199254740991

pricingModel.products.defaultPrice.type

string

required

Allowed value: "subscription"

pricingModel.products.defaultPrice.isDefault

boolean

required

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

pricingModel.products.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

pricingModel.products.defaultPrice.usageEventsPerUnit

null

required

Omitted.

pricingModel.products.defaultPrice.productId

string

required

pricingModel.products.defaultPrice.active

boolean

required

pricingModel.products.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

pricingModel.products.defaultPrice.slug

string | null

required

pricingModel.products.defaultPrice.usageMeterId

null

required

Omitted.

pricingModel.products.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

pricingModel.products.features

object[]

required

Option 1
Option 2

Show child attributes

pricingModel.products.features.id

string

required

pricingModel.products.features.createdAt

integer

required

Epoch milliseconds.

Required range: -9007199254740991 <= x <= 9007199254740991

pricingModel.products.features.updatedAt

integer

required

Epoch milliseconds.

Required range: -9007199254740991 <= x <= 9007199254740991

pricingModel.products.features.livemode

boolean

required

pricingModel.products.features.organizationId

string

required

pricingModel.products.features.type

string

required

Allowed value: "toggle"

pricingModel.products.features.slug

string

required

pricingModel.products.features.name

string

required

pricingModel.products.features.description

string

required

pricingModel.products.features.pricingModelId

string

required

pricingModel.products.features.active

boolean

required

pricingModel.products.features.amount

null

pricingModel.products.features.usageMeterId

null

pricingModel.products.features.renewalFrequency

null

pricingModel.usageMeters

object[]

required

Show child attributes

pricingModel.usageMeters.id

string

required

pricingModel.usageMeters.createdAt

integer

required

Epoch milliseconds.

Required range: -9007199254740991 <= x <= 9007199254740991

pricingModel.usageMeters.updatedAt

integer

required

Epoch milliseconds.

Required range: -9007199254740991 <= x <= 9007199254740991

pricingModel.usageMeters.livemode

boolean

required

pricingModel.usageMeters.organizationId

string

required

pricingModel.usageMeters.name

string

required

pricingModel.usageMeters.pricingModelId

string

required

pricingModel.usageMeters.slug

string

required

pricingModel.usageMeters.aggregationType

enum<string>

required

The type of aggregation to perform on the usage meter. Defaults to "sum", which aggregates all the usage event amounts for the billing period. "count_distinct_properties" counts the number of distinct properties in the billing period for a given meter.

Available options:

sum,

count_distinct_properties

pricingModel.defaultProduct

object

The default product for the pricing model. If no product is explicitly set as default, will return undefined.

Show child attributes

pricingModel.defaultProduct.id

string

required

pricingModel.defaultProduct.createdAt

integer

required

Epoch milliseconds.

Required range: -9007199254740991 <= x <= 9007199254740991

pricingModel.defaultProduct.updatedAt

integer

required

Epoch milliseconds.

Required range: -9007199254740991 <= x <= 9007199254740991

pricingModel.defaultProduct.livemode

boolean

required

pricingModel.defaultProduct.name

string

required

pricingModel.defaultProduct.description

string | null

required

pricingModel.defaultProduct.imageURL

string | null

required

pricingModel.defaultProduct.organizationId

string

required

pricingModel.defaultProduct.active

boolean

required

pricingModel.defaultProduct.singularQuantityLabel

string | null

required

pricingModel.defaultProduct.pluralQuantityLabel

string | null

required

pricingModel.defaultProduct.pricingModelId

string

required

pricingModel.defaultProduct.default

boolean

required

pricingModel.defaultProduct.slug

string | null

required

pricingModel.defaultProduct.prices

object[]

required

Option 1
Option 2
Option 3

Show child attributes

pricingModel.defaultProduct.prices.id

string

required

pricingModel.defaultProduct.prices.createdAt

integer

required

Epoch milliseconds.

Required range: -9007199254740991 <= x <= 9007199254740991

pricingModel.defaultProduct.prices.updatedAt

integer

required

Epoch milliseconds.

Required range: -9007199254740991 <= x <= 9007199254740991

pricingModel.defaultProduct.prices.livemode

boolean

required

pricingModel.defaultProduct.prices.intervalUnit

enum<string>

required

Available options:

day,

week,

month,

year

pricingModel.defaultProduct.prices.name

string | null

required

pricingModel.defaultProduct.prices.intervalCount

integer

required

A positive integer

Required range: x <= 9007199254740991

pricingModel.defaultProduct.prices.type

string

required

Allowed value: "subscription"

pricingModel.defaultProduct.prices.isDefault

boolean

required

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

pricingModel.defaultProduct.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

pricingModel.defaultProduct.prices.usageEventsPerUnit

null

required

Omitted.

pricingModel.defaultProduct.prices.productId

string

required

pricingModel.defaultProduct.prices.active

boolean

required

pricingModel.defaultProduct.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

pricingModel.defaultProduct.prices.slug

string | null

required

pricingModel.defaultProduct.prices.usageMeterId

null

required

Omitted.

pricingModel.defaultProduct.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

pricingModel.defaultProduct.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

pricingModel.defaultProduct.defaultPrice.id

string

required

pricingModel.defaultProduct.defaultPrice.createdAt

integer

required

Epoch milliseconds.

Required range: -9007199254740991 <= x <= 9007199254740991

pricingModel.defaultProduct.defaultPrice.updatedAt

integer

required

Epoch milliseconds.

Required range: -9007199254740991 <= x <= 9007199254740991

pricingModel.defaultProduct.defaultPrice.livemode

boolean

required

pricingModel.defaultProduct.defaultPrice.intervalUnit

enum<string>

required

Available options:

day,

week,

month,

year

pricingModel.defaultProduct.defaultPrice.name

string | null

required

pricingModel.defaultProduct.defaultPrice.intervalCount

integer

required

A positive integer

Required range: x <= 9007199254740991

pricingModel.defaultProduct.defaultPrice.type

string

required

Allowed value: "subscription"

pricingModel.defaultProduct.defaultPrice.isDefault

boolean

required

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

pricingModel.defaultProduct.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

pricingModel.defaultProduct.defaultPrice.usageEventsPerUnit

null

required

Omitted.

pricingModel.defaultProduct.defaultPrice.productId

string

required

pricingModel.defaultProduct.defaultPrice.active

boolean

required

pricingModel.defaultProduct.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

pricingModel.defaultProduct.defaultPrice.slug

string | null

required

pricingModel.defaultProduct.defaultPrice.usageMeterId

null

required

Omitted.

pricingModel.defaultProduct.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

pricingModel.defaultProduct.features

object[]

required

Option 1
Option 2

Show child attributes

pricingModel.defaultProduct.features.id

string

required

pricingModel.defaultProduct.features.createdAt

integer

required

Epoch milliseconds.

Required range: -9007199254740991 <= x <= 9007199254740991

pricingModel.defaultProduct.features.updatedAt

integer

required

Epoch milliseconds.

Required range: -9007199254740991 <= x <= 9007199254740991

pricingModel.defaultProduct.features.livemode

boolean

required

pricingModel.defaultProduct.features.organizationId

string

required

pricingModel.defaultProduct.features.type

string

required

Allowed value: "toggle"

pricingModel.defaultProduct.features.slug

string

required

pricingModel.defaultProduct.features.name

string

required

pricingModel.defaultProduct.features.description

string

required

pricingModel.defaultProduct.features.pricingModelId

string

required

pricingModel.defaultProduct.features.active

boolean

required

pricingModel.defaultProduct.features.amount

null

pricingModel.defaultProduct.features.usageMeterId

null

pricingModel.defaultProduct.features.renewalFrequency

null

Setup a PricingModel Update Pricing Model

⌘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 Pricing Model

Authorizations

Path Parameters

Response