Create a plan/package.
curl --request POST \
--url https://dash.dmly.io/api/v1/plans \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "Starter Membership",
"category_id": "9f1c2b6e-4d3a-4c2b-8e1a-2f3b4c5d6e7f",
"description": "Monthly membership with 5 session credits.",
"billing_type": "recurring",
"price": 49,
"currency": "USD",
"billing_interval": "month",
"interval_count": 1,
"credits": 5,
"is_ecommerce": false,
"notify_email": true,
"notify_whatsapp": true,
"image_url": "https://cdn.example.com/starter.jpg",
"sort_order": 0,
"active": true,
"items": [
{
"item_type": "credit",
"service_id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"credits": 5,
"quantity": 1,
"notes": "5 haircut sessions"
},
{
"item_type": "product",
"product_id": "7f8e9d0c-1b2a-4c3d-9e8f-7a6b5c4d3e2f",
"quantity": 1
}
]
}
'import requests
url = "https://dash.dmly.io/api/v1/plans"
payload = {
"name": "Starter Membership",
"category_id": "9f1c2b6e-4d3a-4c2b-8e1a-2f3b4c5d6e7f",
"description": "Monthly membership with 5 session credits.",
"billing_type": "recurring",
"price": 49,
"currency": "USD",
"billing_interval": "month",
"interval_count": 1,
"credits": 5,
"is_ecommerce": False,
"notify_email": True,
"notify_whatsapp": True,
"image_url": "https://cdn.example.com/starter.jpg",
"sort_order": 0,
"active": True,
"items": [
{
"item_type": "credit",
"service_id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"credits": 5,
"quantity": 1,
"notes": "5 haircut sessions"
},
{
"item_type": "product",
"product_id": "7f8e9d0c-1b2a-4c3d-9e8f-7a6b5c4d3e2f",
"quantity": 1
}
]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Starter Membership',
category_id: '9f1c2b6e-4d3a-4c2b-8e1a-2f3b4c5d6e7f',
description: 'Monthly membership with 5 session credits.',
billing_type: 'recurring',
price: 49,
currency: 'USD',
billing_interval: 'month',
interval_count: 1,
credits: 5,
is_ecommerce: false,
notify_email: true,
notify_whatsapp: true,
image_url: 'https://cdn.example.com/starter.jpg',
sort_order: 0,
active: true,
items: [
{
item_type: 'credit',
service_id: '1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d',
credits: 5,
quantity: 1,
notes: '5 haircut sessions'
},
{
item_type: 'product',
product_id: '7f8e9d0c-1b2a-4c3d-9e8f-7a6b5c4d3e2f',
quantity: 1
}
]
})
};
fetch('https://dash.dmly.io/api/v1/plans', 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://dash.dmly.io/api/v1/plans",
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([
'name' => 'Starter Membership',
'category_id' => '9f1c2b6e-4d3a-4c2b-8e1a-2f3b4c5d6e7f',
'description' => 'Monthly membership with 5 session credits.',
'billing_type' => 'recurring',
'price' => 49,
'currency' => 'USD',
'billing_interval' => 'month',
'interval_count' => 1,
'credits' => 5,
'is_ecommerce' => false,
'notify_email' => true,
'notify_whatsapp' => true,
'image_url' => 'https://cdn.example.com/starter.jpg',
'sort_order' => 0,
'active' => true,
'items' => [
[
'item_type' => 'credit',
'service_id' => '1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d',
'credits' => 5,
'quantity' => 1,
'notes' => '5 haircut sessions'
],
[
'item_type' => 'product',
'product_id' => '7f8e9d0c-1b2a-4c3d-9e8f-7a6b5c4d3e2f',
'quantity' => 1
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://dash.dmly.io/api/v1/plans"
payload := strings.NewReader("{\n \"name\": \"Starter Membership\",\n \"category_id\": \"9f1c2b6e-4d3a-4c2b-8e1a-2f3b4c5d6e7f\",\n \"description\": \"Monthly membership with 5 session credits.\",\n \"billing_type\": \"recurring\",\n \"price\": 49,\n \"currency\": \"USD\",\n \"billing_interval\": \"month\",\n \"interval_count\": 1,\n \"credits\": 5,\n \"is_ecommerce\": false,\n \"notify_email\": true,\n \"notify_whatsapp\": true,\n \"image_url\": \"https://cdn.example.com/starter.jpg\",\n \"sort_order\": 0,\n \"active\": true,\n \"items\": [\n {\n \"item_type\": \"credit\",\n \"service_id\": \"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d\",\n \"credits\": 5,\n \"quantity\": 1,\n \"notes\": \"5 haircut sessions\"\n },\n {\n \"item_type\": \"product\",\n \"product_id\": \"7f8e9d0c-1b2a-4c3d-9e8f-7a6b5c4d3e2f\",\n \"quantity\": 1\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://dash.dmly.io/api/v1/plans")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Starter Membership\",\n \"category_id\": \"9f1c2b6e-4d3a-4c2b-8e1a-2f3b4c5d6e7f\",\n \"description\": \"Monthly membership with 5 session credits.\",\n \"billing_type\": \"recurring\",\n \"price\": 49,\n \"currency\": \"USD\",\n \"billing_interval\": \"month\",\n \"interval_count\": 1,\n \"credits\": 5,\n \"is_ecommerce\": false,\n \"notify_email\": true,\n \"notify_whatsapp\": true,\n \"image_url\": \"https://cdn.example.com/starter.jpg\",\n \"sort_order\": 0,\n \"active\": true,\n \"items\": [\n {\n \"item_type\": \"credit\",\n \"service_id\": \"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d\",\n \"credits\": 5,\n \"quantity\": 1,\n \"notes\": \"5 haircut sessions\"\n },\n {\n \"item_type\": \"product\",\n \"product_id\": \"7f8e9d0c-1b2a-4c3d-9e8f-7a6b5c4d3e2f\",\n \"quantity\": 1\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dash.dmly.io/api/v1/plans")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Starter Membership\",\n \"category_id\": \"9f1c2b6e-4d3a-4c2b-8e1a-2f3b4c5d6e7f\",\n \"description\": \"Monthly membership with 5 session credits.\",\n \"billing_type\": \"recurring\",\n \"price\": 49,\n \"currency\": \"USD\",\n \"billing_interval\": \"month\",\n \"interval_count\": 1,\n \"credits\": 5,\n \"is_ecommerce\": false,\n \"notify_email\": true,\n \"notify_whatsapp\": true,\n \"image_url\": \"https://cdn.example.com/starter.jpg\",\n \"sort_order\": 0,\n \"active\": true,\n \"items\": [\n {\n \"item_type\": \"credit\",\n \"service_id\": \"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d\",\n \"credits\": 5,\n \"quantity\": 1,\n \"notes\": \"5 haircut sessions\"\n },\n {\n \"item_type\": \"product\",\n \"product_id\": \"7f8e9d0c-1b2a-4c3d-9e8f-7a6b5c4d3e2f\",\n \"quantity\": 1\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}{
"message": "<string>"
}Creates a plan via the OfferingService write seam (syncs line items and fires PlanCreated/PlanActivated events). For recurring plans, billing_interval defaults to month and interval_count to 1 when omitted. Each item references a service/product by uuid; credit items grant a credit pool. category_id is a ServiceCategory uuid. Returns 201 with the created plan.
POST
/
plans
Create a plan/package.
curl --request POST \
--url https://dash.dmly.io/api/v1/plans \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "Starter Membership",
"category_id": "9f1c2b6e-4d3a-4c2b-8e1a-2f3b4c5d6e7f",
"description": "Monthly membership with 5 session credits.",
"billing_type": "recurring",
"price": 49,
"currency": "USD",
"billing_interval": "month",
"interval_count": 1,
"credits": 5,
"is_ecommerce": false,
"notify_email": true,
"notify_whatsapp": true,
"image_url": "https://cdn.example.com/starter.jpg",
"sort_order": 0,
"active": true,
"items": [
{
"item_type": "credit",
"service_id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"credits": 5,
"quantity": 1,
"notes": "5 haircut sessions"
},
{
"item_type": "product",
"product_id": "7f8e9d0c-1b2a-4c3d-9e8f-7a6b5c4d3e2f",
"quantity": 1
}
]
}
'import requests
url = "https://dash.dmly.io/api/v1/plans"
payload = {
"name": "Starter Membership",
"category_id": "9f1c2b6e-4d3a-4c2b-8e1a-2f3b4c5d6e7f",
"description": "Monthly membership with 5 session credits.",
"billing_type": "recurring",
"price": 49,
"currency": "USD",
"billing_interval": "month",
"interval_count": 1,
"credits": 5,
"is_ecommerce": False,
"notify_email": True,
"notify_whatsapp": True,
"image_url": "https://cdn.example.com/starter.jpg",
"sort_order": 0,
"active": True,
"items": [
{
"item_type": "credit",
"service_id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"credits": 5,
"quantity": 1,
"notes": "5 haircut sessions"
},
{
"item_type": "product",
"product_id": "7f8e9d0c-1b2a-4c3d-9e8f-7a6b5c4d3e2f",
"quantity": 1
}
]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Starter Membership',
category_id: '9f1c2b6e-4d3a-4c2b-8e1a-2f3b4c5d6e7f',
description: 'Monthly membership with 5 session credits.',
billing_type: 'recurring',
price: 49,
currency: 'USD',
billing_interval: 'month',
interval_count: 1,
credits: 5,
is_ecommerce: false,
notify_email: true,
notify_whatsapp: true,
image_url: 'https://cdn.example.com/starter.jpg',
sort_order: 0,
active: true,
items: [
{
item_type: 'credit',
service_id: '1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d',
credits: 5,
quantity: 1,
notes: '5 haircut sessions'
},
{
item_type: 'product',
product_id: '7f8e9d0c-1b2a-4c3d-9e8f-7a6b5c4d3e2f',
quantity: 1
}
]
})
};
fetch('https://dash.dmly.io/api/v1/plans', 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://dash.dmly.io/api/v1/plans",
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([
'name' => 'Starter Membership',
'category_id' => '9f1c2b6e-4d3a-4c2b-8e1a-2f3b4c5d6e7f',
'description' => 'Monthly membership with 5 session credits.',
'billing_type' => 'recurring',
'price' => 49,
'currency' => 'USD',
'billing_interval' => 'month',
'interval_count' => 1,
'credits' => 5,
'is_ecommerce' => false,
'notify_email' => true,
'notify_whatsapp' => true,
'image_url' => 'https://cdn.example.com/starter.jpg',
'sort_order' => 0,
'active' => true,
'items' => [
[
'item_type' => 'credit',
'service_id' => '1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d',
'credits' => 5,
'quantity' => 1,
'notes' => '5 haircut sessions'
],
[
'item_type' => 'product',
'product_id' => '7f8e9d0c-1b2a-4c3d-9e8f-7a6b5c4d3e2f',
'quantity' => 1
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://dash.dmly.io/api/v1/plans"
payload := strings.NewReader("{\n \"name\": \"Starter Membership\",\n \"category_id\": \"9f1c2b6e-4d3a-4c2b-8e1a-2f3b4c5d6e7f\",\n \"description\": \"Monthly membership with 5 session credits.\",\n \"billing_type\": \"recurring\",\n \"price\": 49,\n \"currency\": \"USD\",\n \"billing_interval\": \"month\",\n \"interval_count\": 1,\n \"credits\": 5,\n \"is_ecommerce\": false,\n \"notify_email\": true,\n \"notify_whatsapp\": true,\n \"image_url\": \"https://cdn.example.com/starter.jpg\",\n \"sort_order\": 0,\n \"active\": true,\n \"items\": [\n {\n \"item_type\": \"credit\",\n \"service_id\": \"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d\",\n \"credits\": 5,\n \"quantity\": 1,\n \"notes\": \"5 haircut sessions\"\n },\n {\n \"item_type\": \"product\",\n \"product_id\": \"7f8e9d0c-1b2a-4c3d-9e8f-7a6b5c4d3e2f\",\n \"quantity\": 1\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://dash.dmly.io/api/v1/plans")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Starter Membership\",\n \"category_id\": \"9f1c2b6e-4d3a-4c2b-8e1a-2f3b4c5d6e7f\",\n \"description\": \"Monthly membership with 5 session credits.\",\n \"billing_type\": \"recurring\",\n \"price\": 49,\n \"currency\": \"USD\",\n \"billing_interval\": \"month\",\n \"interval_count\": 1,\n \"credits\": 5,\n \"is_ecommerce\": false,\n \"notify_email\": true,\n \"notify_whatsapp\": true,\n \"image_url\": \"https://cdn.example.com/starter.jpg\",\n \"sort_order\": 0,\n \"active\": true,\n \"items\": [\n {\n \"item_type\": \"credit\",\n \"service_id\": \"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d\",\n \"credits\": 5,\n \"quantity\": 1,\n \"notes\": \"5 haircut sessions\"\n },\n {\n \"item_type\": \"product\",\n \"product_id\": \"7f8e9d0c-1b2a-4c3d-9e8f-7a6b5c4d3e2f\",\n \"quantity\": 1\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dash.dmly.io/api/v1/plans")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Starter Membership\",\n \"category_id\": \"9f1c2b6e-4d3a-4c2b-8e1a-2f3b4c5d6e7f\",\n \"description\": \"Monthly membership with 5 session credits.\",\n \"billing_type\": \"recurring\",\n \"price\": 49,\n \"currency\": \"USD\",\n \"billing_interval\": \"month\",\n \"interval_count\": 1,\n \"credits\": 5,\n \"is_ecommerce\": false,\n \"notify_email\": true,\n \"notify_whatsapp\": true,\n \"image_url\": \"https://cdn.example.com/starter.jpg\",\n \"sort_order\": 0,\n \"active\": true,\n \"items\": [\n {\n \"item_type\": \"credit\",\n \"service_id\": \"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d\",\n \"credits\": 5,\n \"quantity\": 1,\n \"notes\": \"5 haircut sessions\"\n },\n {\n \"item_type\": \"product\",\n \"product_id\": \"7f8e9d0c-1b2a-4c3d-9e8f-7a6b5c4d3e2f\",\n \"quantity\": 1\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}{
"message": "<string>"
}Authorizations
apiKeyAuthbearerAuth
Your workspace API key. It both authenticates the caller and selects the workspace.
Body
application/json
Show child attributes
Show child attributes
Response
Success.
Was this page helpful?
⌘I