Skip to main content
POST
Create Product Pricing

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string

The idempotency key that will be used to ensure the request is only performed once

Path Parameters

company_id
string
required

The company ID with the prefix 'cmp_'.

Body

application/json
currency
string
required

The currency for the product pricing

name
string
required

The name of the product pricing

pricing_type
enum<string>
required
Available options:
FIXED,
STEP,
GRADIENT,
VOLUME,
CUSTOM,
SCHEDULED
product_id
string
required

The product ID of the product to which this pricing belongs

type
enum<string>
required

The type of product pricing whether one-time or recurring. Options are SUBS_PRICING for recurring and ONETIME_PRICING for one-time pricing.

Available options:
SUBS_PRICING,
ONETIME_PRICING
base_price
object

The amount which has value in cents and a currency

base_units
number<double>
Required range: x >= 0
billing_frequency
object

The term which includes a frequency interval and a count for number of intervals

charge_type
null | enum<string>
Available options:
PRE_POST,
POST_ONLY
credit_price
object
description
string

The description for the product pricing

display_type
null | string
entitlements
object[] | null

The entitlements that enable features for the product pricing

external_name
string

The externally visible name for the product pricing

fixed_price
object
gradient_price
object[] | null
item_id
null | string

The item ID of the product pricing. Used only for variable pricing

metadata
object

Any additional data as key-value pairs that need to be attached to the product pricing

metric_id
null | string

The billable metric ID of the product pricing. Used only for variable pricing

minimum_spend
object

The amount which has value in cents and a currency

minimum_spend_schedule
object
proration_type
null | enum<string>
Available options:
NONE,
PRORATE_ALL
recognition_schedule
object
scheduled_price
object
step_price
object
tags
string[] | null

Any string tags associated with this product pricing

true_up_frequency
string | null
volume_price
object[] | null

Response

200 - application/json

OK

company_id
string

The company ID for the product pricing

computed_entitlements
object[] | null

The final computed features for the product pricing

created_at
string<date-time>

The date the product pricing was created

currency
string

The currency for the product pricing

description
string

The description for the product pricing

external_name
string

The externally exposed name for the product pricing used on invoices

id
string

The ID of the product pricing in Measure

metadata
object

Any additional data as key-value pairs attached to the product pricing

name
string

The name of the product pricing

num_subs
integer

The number of subscriptions in the company with the product pricing

Required range: x >= 0
override_entitlements
object[] | null

The overridden features for the product pricing

product_id
string

The product ID that the product pricing is attached to

state
string

The state of the product pricing such as ACTIVE or ARCHIVED

tags
string[] | null

Any tags on the product pricing

type
string

The type of product pricing such as recurring or one-time

updated_at
string<date-time>

The date the product pricing was last updated