Skip to main content
POST
Publish a draft plan version

Authorizations

Authorization
string
header
required

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

Path Parameters

plan_id
string<MeteroidId>
required

Plan ID

Example:

"plan_7n42DGM5Tflk9n8mt7Fhc7"

Response

Plan published

available_parameters
object
required
created_at
string<date-time>
required
currency
enum<string>
required
Available options:
AED,
AFN,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BTN,
BWP,
BYN,
BZD,
CAD,
CDF,
CHF,
CLP,
CNH,
CNY,
COP,
CRC,
CUC,
CUP,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ERN,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HRK,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
IRR,
ISK,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KPW,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LYD,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MRU,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SDG,
SEK,
SGD,
SHP,
SLL,
SOS,
SRD,
SSP,
STD,
STN,
SVC,
SYP,
SZL,
THB,
TJS,
TMT,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
UYU,
UZS,
VES,
VND,
VUV,
WST,
XAF,
XCD,
XOF,
XPF,
YER,
ZAR,
ZMW,
ZWL
Example:

"EUR"

id
string<MeteroidId>
required
Example:

"plan_7n42DGM5Tflk9n8mt7Fhc7"

name
string
required
net_terms
integer<int32>
required
plan_type
enum<string>
required
Available options:
STANDARD,
FREE,
CUSTOM
price_components
object[]
required
product_family
object
required
status
enum<string>
required
Available options:
DRAFT,
ACTIVE,
INACTIVE,
ARCHIVED
tax_inclusive
boolean
required

The plan's amounts are quoted tax-included ("9.99 incl. VAT"): tax is carved out of them at invoice time instead of being added on top, so the customer pays the quoted price whatever rate applies. A customer who bears no tax (reverse charge, exempt, export) still pays it in full. Defaults to false.

version
integer<int32>
required
version_id
string<MeteroidId>
required
Example:

"plv_7n42DGM5Tflk9n8mt7Fhc7"

billing_cycles
integer<int32> | null
credit_exhausted_rule
object

What usage does once the credit it draws on runs out. Absent on a draft whose rule was not chosen yet: publishing sets the default (pause when the version grants credit or prices usage in a credit unit, invoice otherwise).

description
string | null
entitlements
object[]
issues_license
boolean

Subscriptions to this plan are issued a software license automatically.

minimum_commitment
object | null

Plan-level minimum commitment. When a billing period's charges in scope, before discounts, total less than minimum_commitment.amount, the invoice that closes the period adds a "Minimum commitment" true-up line for the difference. A partial period is prorated by day.

period_start_day
integer<int32> | null
self_service_rank
integer<int32> | null
trial
object | null