apply monetization configuration
curl --request POST \
--url https://api.unprice.dev/v1/monetization/apply \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"config": {
"plans": [
{
"slug": "<string>",
"title": "<string>",
"version": {
"billingConfig": {
"name": "<string>",
"intervalCount": 30
},
"features": [
{
"featureSlug": "<string>",
"config": {
"price": "<string>",
"tiers": [
{
"unitPrice": "<string>",
"flatPrice": "<string>",
"firstUnit": 2,
"lastUnit": 2,
"label": "<string>"
}
],
"units": 2
},
"limit": 123
}
],
"paymentMethodRequired": true
},
"description": "<string>",
"defaultPlan": true
}
],
"events": [],
"features": []
}
}
'import requests
url = "https://api.unprice.dev/v1/monetization/apply"
payload = { "config": {
"plans": [
{
"slug": "<string>",
"title": "<string>",
"version": {
"billingConfig": {
"name": "<string>",
"intervalCount": 30
},
"features": [
{
"featureSlug": "<string>",
"config": {
"price": "<string>",
"tiers": [
{
"unitPrice": "<string>",
"flatPrice": "<string>",
"firstUnit": 2,
"lastUnit": 2,
"label": "<string>"
}
],
"units": 2
},
"limit": 123
}
],
"paymentMethodRequired": True
},
"description": "<string>",
"defaultPlan": True
}
],
"events": [],
"features": []
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
config: {
plans: [
{
slug: '<string>',
title: '<string>',
version: {
billingConfig: {name: '<string>', intervalCount: 30},
features: [
{
featureSlug: '<string>',
config: {
price: '<string>',
tiers: [
{
unitPrice: '<string>',
flatPrice: '<string>',
firstUnit: 2,
lastUnit: 2,
label: '<string>'
}
],
units: 2
},
limit: 123
}
],
paymentMethodRequired: true
},
description: '<string>',
defaultPlan: true
}
],
events: [],
features: []
}
})
};
fetch('https://api.unprice.dev/v1/monetization/apply', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.unprice.dev/v1/monetization/apply",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'config' => [
'plans' => [
[
'slug' => '<string>',
'title' => '<string>',
'version' => [
'billingConfig' => [
'name' => '<string>',
'intervalCount' => 30
],
'features' => [
[
'featureSlug' => '<string>',
'config' => [
'price' => '<string>',
'tiers' => [
[
'unitPrice' => '<string>',
'flatPrice' => '<string>',
'firstUnit' => 2,
'lastUnit' => 2,
'label' => '<string>'
]
],
'units' => 2
],
'limit' => 123
]
],
'paymentMethodRequired' => true
],
'description' => '<string>',
'defaultPlan' => true
]
],
'events' => [
],
'features' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.unprice.dev/v1/monetization/apply"
payload := strings.NewReader("{\n \"config\": {\n \"plans\": [\n {\n \"slug\": \"<string>\",\n \"title\": \"<string>\",\n \"version\": {\n \"billingConfig\": {\n \"name\": \"<string>\",\n \"intervalCount\": 30\n },\n \"features\": [\n {\n \"featureSlug\": \"<string>\",\n \"config\": {\n \"price\": \"<string>\",\n \"tiers\": [\n {\n \"unitPrice\": \"<string>\",\n \"flatPrice\": \"<string>\",\n \"firstUnit\": 2,\n \"lastUnit\": 2,\n \"label\": \"<string>\"\n }\n ],\n \"units\": 2\n },\n \"limit\": 123\n }\n ],\n \"paymentMethodRequired\": true\n },\n \"description\": \"<string>\",\n \"defaultPlan\": true\n }\n ],\n \"events\": [],\n \"features\": []\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.unprice.dev/v1/monetization/apply")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"config\": {\n \"plans\": [\n {\n \"slug\": \"<string>\",\n \"title\": \"<string>\",\n \"version\": {\n \"billingConfig\": {\n \"name\": \"<string>\",\n \"intervalCount\": 30\n },\n \"features\": [\n {\n \"featureSlug\": \"<string>\",\n \"config\": {\n \"price\": \"<string>\",\n \"tiers\": [\n {\n \"unitPrice\": \"<string>\",\n \"flatPrice\": \"<string>\",\n \"firstUnit\": 2,\n \"lastUnit\": 2,\n \"label\": \"<string>\"\n }\n ],\n \"units\": 2\n },\n \"limit\": 123\n }\n ],\n \"paymentMethodRequired\": true\n },\n \"description\": \"<string>\",\n \"defaultPlan\": true\n }\n ],\n \"events\": [],\n \"features\": []\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.unprice.dev/v1/monetization/apply")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"config\": {\n \"plans\": [\n {\n \"slug\": \"<string>\",\n \"title\": \"<string>\",\n \"version\": {\n \"billingConfig\": {\n \"name\": \"<string>\",\n \"intervalCount\": 30\n },\n \"features\": [\n {\n \"featureSlug\": \"<string>\",\n \"config\": {\n \"price\": \"<string>\",\n \"tiers\": [\n {\n \"unitPrice\": \"<string>\",\n \"flatPrice\": \"<string>\",\n \"firstUnit\": 2,\n \"lastUnit\": 2,\n \"label\": \"<string>\"\n }\n ],\n \"units\": 2\n },\n \"limit\": 123\n }\n ],\n \"paymentMethodRequired\": true\n },\n \"description\": \"<string>\",\n \"defaultPlan\": true\n }\n ],\n \"events\": [],\n \"features\": []\n }\n}"
response = http.request(request)
puts response.read_body{
"plans": [
{
"slug": "<string>",
"planVersionId": "<string>",
"status": "created"
}
],
"staleDrafts": [
{
"slug": "<string>",
"planVersionId": "<string>"
}
],
"integrationContract": {
"defaultPlan": {
"slug": "<string>",
"planVersionId": "<string>",
"note": "<string>"
},
"events": [
{
"slug": "<string>",
"name": "<string>",
"requiredProperties": [
"<string>"
]
}
],
"features": [
{
"slug": "<string>",
"kind": "flat-access",
"eventSlug": "<string>",
"planSlugs": [
"<string>"
]
}
],
"warnings": [
{
"featureSlug": "<string>",
"code": "usage_unknown_before_work",
"message": "<string>"
}
]
},
"reviewUrl": "<string>"
}{
"error": {
"code": "BAD_REQUEST",
"docs": "https://docs.unprice.dev/api-reference/errors/code/BAD_REQUEST",
"message": "<string>",
"requestId": "req_1234",
"details": {
"kind": "invalid_config",
"issues": [
{
"path": "config.plans[0].version.features[1].featureSlug",
"message": "<string>"
}
]
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"docs": "https://docs.unprice.dev/api-reference/errors/code/UNAUTHORIZED",
"message": "<string>",
"requestId": "req_1234",
"details": {
"kind": "invalid_config",
"issues": [
{
"path": "config.plans[0].version.features[1].featureSlug",
"message": "<string>"
}
]
}
}
}{
"error": {
"code": "FORBIDDEN",
"docs": "https://docs.unprice.dev/api-reference/errors/code/FORBIDDEN",
"message": "<string>",
"requestId": "req_1234",
"details": {
"kind": "invalid_config",
"issues": [
{
"path": "config.plans[0].version.features[1].featureSlug",
"message": "<string>"
}
]
}
}
}{
"error": {
"code": "NOT_FOUND",
"docs": "https://docs.unprice.dev/api-reference/errors/code/NOT_FOUND",
"message": "<string>",
"requestId": "req_1234",
"details": {
"kind": "invalid_config",
"issues": [
{
"path": "config.plans[0].version.features[1].featureSlug",
"message": "<string>"
}
]
}
}
}{
"error": {
"code": "CONFLICT",
"docs": "https://docs.unprice.dev/api-reference/errors/code/CONFLICT",
"message": "<string>",
"requestId": "req_1234",
"details": {
"kind": "invalid_config",
"issues": [
{
"path": "config.plans[0].version.features[1].featureSlug",
"message": "<string>"
}
]
}
}
}{
"error": {
"code": "PRECONDITION_FAILED",
"docs": "https://docs.unprice.dev/api-reference/errors/code/PRECONDITION_FAILED",
"message": "<string>",
"requestId": "req_1234",
"details": {
"kind": "invalid_config",
"issues": [
{
"path": "config.plans[0].version.features[1].featureSlug",
"message": "<string>"
}
]
}
}
}{
"error": {
"code": "PAYLOAD_TOO_LARGE",
"docs": "https://docs.unprice.dev/api-reference/errors/code/PAYLOAD_TOO_LARGE",
"message": "<string>",
"requestId": "req_1234",
"details": {
"kind": "invalid_config",
"issues": [
{
"path": "config.plans[0].version.features[1].featureSlug",
"message": "<string>"
}
]
}
}
}{
"error": {
"code": "TOO_MANY_REQUESTS",
"docs": "https://docs.unprice.dev/api-reference/errors/code/TOO_MANY_REQUESTS",
"message": "<string>",
"requestId": "req_1234",
"details": {
"kind": "invalid_config",
"issues": [
{
"path": "config.plans[0].version.features[1].featureSlug",
"message": "<string>"
}
]
}
}
}{
"error": {
"code": "INTERNAL_SERVER_ERROR",
"docs": "https://docs.unprice.dev/api-reference/errors/code/INTERNAL_SERVER_ERROR",
"message": "<string>",
"requestId": "req_1234",
"details": {
"kind": "invalid_config",
"issues": [
{
"path": "config.plans[0].version.features[1].featureSlug",
"message": "<string>"
}
]
}
}
}monetization
apply monetization configuration
Turn one configuration document into draft plan versions for this project. Nothing is published: a human reviews and publishes the drafts from the dashboard.
POST
/
v1
/
monetization
/
apply
apply monetization configuration
curl --request POST \
--url https://api.unprice.dev/v1/monetization/apply \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"config": {
"plans": [
{
"slug": "<string>",
"title": "<string>",
"version": {
"billingConfig": {
"name": "<string>",
"intervalCount": 30
},
"features": [
{
"featureSlug": "<string>",
"config": {
"price": "<string>",
"tiers": [
{
"unitPrice": "<string>",
"flatPrice": "<string>",
"firstUnit": 2,
"lastUnit": 2,
"label": "<string>"
}
],
"units": 2
},
"limit": 123
}
],
"paymentMethodRequired": true
},
"description": "<string>",
"defaultPlan": true
}
],
"events": [],
"features": []
}
}
'import requests
url = "https://api.unprice.dev/v1/monetization/apply"
payload = { "config": {
"plans": [
{
"slug": "<string>",
"title": "<string>",
"version": {
"billingConfig": {
"name": "<string>",
"intervalCount": 30
},
"features": [
{
"featureSlug": "<string>",
"config": {
"price": "<string>",
"tiers": [
{
"unitPrice": "<string>",
"flatPrice": "<string>",
"firstUnit": 2,
"lastUnit": 2,
"label": "<string>"
}
],
"units": 2
},
"limit": 123
}
],
"paymentMethodRequired": True
},
"description": "<string>",
"defaultPlan": True
}
],
"events": [],
"features": []
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
config: {
plans: [
{
slug: '<string>',
title: '<string>',
version: {
billingConfig: {name: '<string>', intervalCount: 30},
features: [
{
featureSlug: '<string>',
config: {
price: '<string>',
tiers: [
{
unitPrice: '<string>',
flatPrice: '<string>',
firstUnit: 2,
lastUnit: 2,
label: '<string>'
}
],
units: 2
},
limit: 123
}
],
paymentMethodRequired: true
},
description: '<string>',
defaultPlan: true
}
],
events: [],
features: []
}
})
};
fetch('https://api.unprice.dev/v1/monetization/apply', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.unprice.dev/v1/monetization/apply",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'config' => [
'plans' => [
[
'slug' => '<string>',
'title' => '<string>',
'version' => [
'billingConfig' => [
'name' => '<string>',
'intervalCount' => 30
],
'features' => [
[
'featureSlug' => '<string>',
'config' => [
'price' => '<string>',
'tiers' => [
[
'unitPrice' => '<string>',
'flatPrice' => '<string>',
'firstUnit' => 2,
'lastUnit' => 2,
'label' => '<string>'
]
],
'units' => 2
],
'limit' => 123
]
],
'paymentMethodRequired' => true
],
'description' => '<string>',
'defaultPlan' => true
]
],
'events' => [
],
'features' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.unprice.dev/v1/monetization/apply"
payload := strings.NewReader("{\n \"config\": {\n \"plans\": [\n {\n \"slug\": \"<string>\",\n \"title\": \"<string>\",\n \"version\": {\n \"billingConfig\": {\n \"name\": \"<string>\",\n \"intervalCount\": 30\n },\n \"features\": [\n {\n \"featureSlug\": \"<string>\",\n \"config\": {\n \"price\": \"<string>\",\n \"tiers\": [\n {\n \"unitPrice\": \"<string>\",\n \"flatPrice\": \"<string>\",\n \"firstUnit\": 2,\n \"lastUnit\": 2,\n \"label\": \"<string>\"\n }\n ],\n \"units\": 2\n },\n \"limit\": 123\n }\n ],\n \"paymentMethodRequired\": true\n },\n \"description\": \"<string>\",\n \"defaultPlan\": true\n }\n ],\n \"events\": [],\n \"features\": []\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.unprice.dev/v1/monetization/apply")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"config\": {\n \"plans\": [\n {\n \"slug\": \"<string>\",\n \"title\": \"<string>\",\n \"version\": {\n \"billingConfig\": {\n \"name\": \"<string>\",\n \"intervalCount\": 30\n },\n \"features\": [\n {\n \"featureSlug\": \"<string>\",\n \"config\": {\n \"price\": \"<string>\",\n \"tiers\": [\n {\n \"unitPrice\": \"<string>\",\n \"flatPrice\": \"<string>\",\n \"firstUnit\": 2,\n \"lastUnit\": 2,\n \"label\": \"<string>\"\n }\n ],\n \"units\": 2\n },\n \"limit\": 123\n }\n ],\n \"paymentMethodRequired\": true\n },\n \"description\": \"<string>\",\n \"defaultPlan\": true\n }\n ],\n \"events\": [],\n \"features\": []\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.unprice.dev/v1/monetization/apply")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"config\": {\n \"plans\": [\n {\n \"slug\": \"<string>\",\n \"title\": \"<string>\",\n \"version\": {\n \"billingConfig\": {\n \"name\": \"<string>\",\n \"intervalCount\": 30\n },\n \"features\": [\n {\n \"featureSlug\": \"<string>\",\n \"config\": {\n \"price\": \"<string>\",\n \"tiers\": [\n {\n \"unitPrice\": \"<string>\",\n \"flatPrice\": \"<string>\",\n \"firstUnit\": 2,\n \"lastUnit\": 2,\n \"label\": \"<string>\"\n }\n ],\n \"units\": 2\n },\n \"limit\": 123\n }\n ],\n \"paymentMethodRequired\": true\n },\n \"description\": \"<string>\",\n \"defaultPlan\": true\n }\n ],\n \"events\": [],\n \"features\": []\n }\n}"
response = http.request(request)
puts response.read_body{
"plans": [
{
"slug": "<string>",
"planVersionId": "<string>",
"status": "created"
}
],
"staleDrafts": [
{
"slug": "<string>",
"planVersionId": "<string>"
}
],
"integrationContract": {
"defaultPlan": {
"slug": "<string>",
"planVersionId": "<string>",
"note": "<string>"
},
"events": [
{
"slug": "<string>",
"name": "<string>",
"requiredProperties": [
"<string>"
]
}
],
"features": [
{
"slug": "<string>",
"kind": "flat-access",
"eventSlug": "<string>",
"planSlugs": [
"<string>"
]
}
],
"warnings": [
{
"featureSlug": "<string>",
"code": "usage_unknown_before_work",
"message": "<string>"
}
]
},
"reviewUrl": "<string>"
}{
"error": {
"code": "BAD_REQUEST",
"docs": "https://docs.unprice.dev/api-reference/errors/code/BAD_REQUEST",
"message": "<string>",
"requestId": "req_1234",
"details": {
"kind": "invalid_config",
"issues": [
{
"path": "config.plans[0].version.features[1].featureSlug",
"message": "<string>"
}
]
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"docs": "https://docs.unprice.dev/api-reference/errors/code/UNAUTHORIZED",
"message": "<string>",
"requestId": "req_1234",
"details": {
"kind": "invalid_config",
"issues": [
{
"path": "config.plans[0].version.features[1].featureSlug",
"message": "<string>"
}
]
}
}
}{
"error": {
"code": "FORBIDDEN",
"docs": "https://docs.unprice.dev/api-reference/errors/code/FORBIDDEN",
"message": "<string>",
"requestId": "req_1234",
"details": {
"kind": "invalid_config",
"issues": [
{
"path": "config.plans[0].version.features[1].featureSlug",
"message": "<string>"
}
]
}
}
}{
"error": {
"code": "NOT_FOUND",
"docs": "https://docs.unprice.dev/api-reference/errors/code/NOT_FOUND",
"message": "<string>",
"requestId": "req_1234",
"details": {
"kind": "invalid_config",
"issues": [
{
"path": "config.plans[0].version.features[1].featureSlug",
"message": "<string>"
}
]
}
}
}{
"error": {
"code": "CONFLICT",
"docs": "https://docs.unprice.dev/api-reference/errors/code/CONFLICT",
"message": "<string>",
"requestId": "req_1234",
"details": {
"kind": "invalid_config",
"issues": [
{
"path": "config.plans[0].version.features[1].featureSlug",
"message": "<string>"
}
]
}
}
}{
"error": {
"code": "PRECONDITION_FAILED",
"docs": "https://docs.unprice.dev/api-reference/errors/code/PRECONDITION_FAILED",
"message": "<string>",
"requestId": "req_1234",
"details": {
"kind": "invalid_config",
"issues": [
{
"path": "config.plans[0].version.features[1].featureSlug",
"message": "<string>"
}
]
}
}
}{
"error": {
"code": "PAYLOAD_TOO_LARGE",
"docs": "https://docs.unprice.dev/api-reference/errors/code/PAYLOAD_TOO_LARGE",
"message": "<string>",
"requestId": "req_1234",
"details": {
"kind": "invalid_config",
"issues": [
{
"path": "config.plans[0].version.features[1].featureSlug",
"message": "<string>"
}
]
}
}
}{
"error": {
"code": "TOO_MANY_REQUESTS",
"docs": "https://docs.unprice.dev/api-reference/errors/code/TOO_MANY_REQUESTS",
"message": "<string>",
"requestId": "req_1234",
"details": {
"kind": "invalid_config",
"issues": [
{
"path": "config.plans[0].version.features[1].featureSlug",
"message": "<string>"
}
]
}
}
}{
"error": {
"code": "INTERNAL_SERVER_ERROR",
"docs": "https://docs.unprice.dev/api-reference/errors/code/INTERNAL_SERVER_ERROR",
"message": "<string>",
"requestId": "req_1234",
"details": {
"kind": "invalid_config",
"issues": [
{
"path": "config.plans[0].version.features[1].featureSlug",
"message": "<string>"
}
]
}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
The desired monetization configuration for the project the key belongs to
The whole desired monetization configuration for a project
Show child attributes
Show child attributes
Response
Per-plan outcomes, drafts left behind by earlier documents, what the application has to call at runtime, and a dashboard link to the first draft created for review
One outcome per plan, in the same order as the plans of the submitted document
Show child attributes
Show child attributes
Drafts made by an earlier, now-superseded document, plus same-hash duplicates left by a concurrent apply. Reported, never deleted
Show child attributes
Show child attributes
What the application has to call at runtime for this configuration to work
Show child attributes
Show child attributes
Dashboard link to the first draft this apply created, for a human to review and publish. Null when no draft was created — every plan was already unchanged or published — and also null when the link could not be built, so a null here does not prove nothing was created; read plans for that