Update a plan/package (PUT or PATCH).
curl --request PUT \
--url https://dash.dmly.io/api/v1/plans/{plan} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "Starter Membership (Plus)",
"price": 59,
"billing_interval": "month",
"interval_count": 1,
"active": true,
"items": [
{
"item_type": "credit",
"service_id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"credits": 8,
"quantity": 1
}
]
}
'import requests
url = "https://dash.dmly.io/api/v1/plans/{plan}"
payload = {
"name": "Starter Membership (Plus)",
"price": 59,
"billing_interval": "month",
"interval_count": 1,
"active": True,
"items": [
{
"item_type": "credit",
"service_id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"credits": 8,
"quantity": 1
}
]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Starter Membership (Plus)',
price: 59,
billing_interval: 'month',
interval_count: 1,
active: true,
items: [
{
item_type: 'credit',
service_id: '1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d',
credits: 8,
quantity: 1
}
]
})
};
fetch('https://dash.dmly.io/api/v1/plans/{plan}', 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/{plan}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Starter Membership (Plus)',
'price' => 59,
'billing_interval' => 'month',
'interval_count' => 1,
'active' => true,
'items' => [
[
'item_type' => 'credit',
'service_id' => '1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d',
'credits' => 8,
'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/{plan}"
payload := strings.NewReader("{\n \"name\": \"Starter Membership (Plus)\",\n \"price\": 59,\n \"billing_interval\": \"month\",\n \"interval_count\": 1,\n \"active\": true,\n \"items\": [\n {\n \"item_type\": \"credit\",\n \"service_id\": \"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d\",\n \"credits\": 8,\n \"quantity\": 1\n }\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://dash.dmly.io/api/v1/plans/{plan}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Starter Membership (Plus)\",\n \"price\": 59,\n \"billing_interval\": \"month\",\n \"interval_count\": 1,\n \"active\": true,\n \"items\": [\n {\n \"item_type\": \"credit\",\n \"service_id\": \"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d\",\n \"credits\": 8,\n \"quantity\": 1\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dash.dmly.io/api/v1/plans/{plan}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Starter Membership (Plus)\",\n \"price\": 59,\n \"billing_interval\": \"month\",\n \"interval_count\": 1,\n \"active\": true,\n \"items\": [\n {\n \"item_type\": \"credit\",\n \"service_id\": \"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d\",\n \"credits\": 8,\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>"
}Updates a plan via the OfferingService write seam. When items are supplied they fully replace the plan’s existing line items. Fires PlanUpdated and PlanActivated/PlanDeactivated when the active flag changes. category_id is a ServiceCategory uuid.
PUT
/
plans
/
{plan}
Update a plan/package (PUT or PATCH).
curl --request PUT \
--url https://dash.dmly.io/api/v1/plans/{plan} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "Starter Membership (Plus)",
"price": 59,
"billing_interval": "month",
"interval_count": 1,
"active": true,
"items": [
{
"item_type": "credit",
"service_id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"credits": 8,
"quantity": 1
}
]
}
'import requests
url = "https://dash.dmly.io/api/v1/plans/{plan}"
payload = {
"name": "Starter Membership (Plus)",
"price": 59,
"billing_interval": "month",
"interval_count": 1,
"active": True,
"items": [
{
"item_type": "credit",
"service_id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"credits": 8,
"quantity": 1
}
]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Starter Membership (Plus)',
price: 59,
billing_interval: 'month',
interval_count: 1,
active: true,
items: [
{
item_type: 'credit',
service_id: '1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d',
credits: 8,
quantity: 1
}
]
})
};
fetch('https://dash.dmly.io/api/v1/plans/{plan}', 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/{plan}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Starter Membership (Plus)',
'price' => 59,
'billing_interval' => 'month',
'interval_count' => 1,
'active' => true,
'items' => [
[
'item_type' => 'credit',
'service_id' => '1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d',
'credits' => 8,
'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/{plan}"
payload := strings.NewReader("{\n \"name\": \"Starter Membership (Plus)\",\n \"price\": 59,\n \"billing_interval\": \"month\",\n \"interval_count\": 1,\n \"active\": true,\n \"items\": [\n {\n \"item_type\": \"credit\",\n \"service_id\": \"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d\",\n \"credits\": 8,\n \"quantity\": 1\n }\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://dash.dmly.io/api/v1/plans/{plan}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Starter Membership (Plus)\",\n \"price\": 59,\n \"billing_interval\": \"month\",\n \"interval_count\": 1,\n \"active\": true,\n \"items\": [\n {\n \"item_type\": \"credit\",\n \"service_id\": \"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d\",\n \"credits\": 8,\n \"quantity\": 1\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dash.dmly.io/api/v1/plans/{plan}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Starter Membership (Plus)\",\n \"price\": 59,\n \"billing_interval\": \"month\",\n \"interval_count\": 1,\n \"active\": true,\n \"items\": [\n {\n \"item_type\": \"credit\",\n \"service_id\": \"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d\",\n \"credits\": 8,\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.
Path Parameters
Plan id.
Body
application/json
Response
Success.
Was this page helpful?
⌘I

