Create a subscription recast
curl --request POST \
--url https://api.salesbricks.com/api/v2/subscriptions/{subscription_id}/recast \
--header 'Content-Type: application/json' \
--header 'X-SALESBRICKS-KEY: <api-key>' \
--data '
{
"starts_at": "2023-12-25",
"contract_length": 2,
"bricks": [
{
"brick_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 123,
"is_unlimited": true,
"discount": [
{
"rate": "<string>",
"amount": 123,
"renews": false
}
]
}
],
"crm_opportunity_id": "<string>",
"adjustment_credit": 123,
"adjustment_credit_label": "<string>",
"plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"discount_coupons": [
"<string>"
],
"phases": [
{
"phase_position": 1,
"bricks": [
{
"brick_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 123,
"is_unlimited": true,
"discount": [
{
"rate": "<string>",
"amount": 123,
"renews": false
}
]
}
],
"starts_at": "2023-12-25",
"contract_length": 2,
"plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"payment_terms": 499,
"discount_coupons": [
"<string>"
]
}
],
"payment_terms": 499,
"custom_order_form_html": "<string>",
"metadata": "<unknown>"
}
'import requests
url = "https://api.salesbricks.com/api/v2/subscriptions/{subscription_id}/recast"
payload = {
"starts_at": "2023-12-25",
"contract_length": 2,
"bricks": [
{
"brick_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 123,
"is_unlimited": True,
"discount": [
{
"rate": "<string>",
"amount": 123,
"renews": False
}
]
}
],
"crm_opportunity_id": "<string>",
"adjustment_credit": 123,
"adjustment_credit_label": "<string>",
"plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"discount_coupons": ["<string>"],
"phases": [
{
"phase_position": 1,
"bricks": [
{
"brick_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 123,
"is_unlimited": True,
"discount": [
{
"rate": "<string>",
"amount": 123,
"renews": False
}
]
}
],
"starts_at": "2023-12-25",
"contract_length": 2,
"plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"payment_terms": 499,
"discount_coupons": ["<string>"]
}
],
"payment_terms": 499,
"custom_order_form_html": "<string>",
"metadata": "<unknown>"
}
headers = {
"X-SALESBRICKS-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-SALESBRICKS-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
starts_at: '2023-12-25',
contract_length: 2,
bricks: [
{
brick_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
quantity: 123,
is_unlimited: true,
discount: [{rate: '<string>', amount: 123, renews: false}]
}
],
crm_opportunity_id: '<string>',
adjustment_credit: 123,
adjustment_credit_label: '<string>',
plan_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
discount_coupons: ['<string>'],
phases: [
{
phase_position: 1,
bricks: [
{
brick_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
quantity: 123,
is_unlimited: true,
discount: [{rate: '<string>', amount: 123, renews: false}]
}
],
starts_at: '2023-12-25',
contract_length: 2,
plan_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
payment_terms: 499,
discount_coupons: ['<string>']
}
],
payment_terms: 499,
custom_order_form_html: '<string>',
metadata: '<unknown>'
})
};
fetch('https://api.salesbricks.com/api/v2/subscriptions/{subscription_id}/recast', 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.salesbricks.com/api/v2/subscriptions/{subscription_id}/recast",
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([
'starts_at' => '2023-12-25',
'contract_length' => 2,
'bricks' => [
[
'brick_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'quantity' => 123,
'is_unlimited' => true,
'discount' => [
[
'rate' => '<string>',
'amount' => 123,
'renews' => false
]
]
]
],
'crm_opportunity_id' => '<string>',
'adjustment_credit' => 123,
'adjustment_credit_label' => '<string>',
'plan_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'discount_coupons' => [
'<string>'
],
'phases' => [
[
'phase_position' => 1,
'bricks' => [
[
'brick_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'quantity' => 123,
'is_unlimited' => true,
'discount' => [
[
'rate' => '<string>',
'amount' => 123,
'renews' => false
]
]
]
],
'starts_at' => '2023-12-25',
'contract_length' => 2,
'plan_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'payment_terms' => 499,
'discount_coupons' => [
'<string>'
]
]
],
'payment_terms' => 499,
'custom_order_form_html' => '<string>',
'metadata' => '<unknown>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-SALESBRICKS-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://api.salesbricks.com/api/v2/subscriptions/{subscription_id}/recast"
payload := strings.NewReader("{\n \"starts_at\": \"2023-12-25\",\n \"contract_length\": 2,\n \"bricks\": [\n {\n \"brick_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 123,\n \"is_unlimited\": true,\n \"discount\": [\n {\n \"rate\": \"<string>\",\n \"amount\": 123,\n \"renews\": false\n }\n ]\n }\n ],\n \"crm_opportunity_id\": \"<string>\",\n \"adjustment_credit\": 123,\n \"adjustment_credit_label\": \"<string>\",\n \"plan_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"discount_coupons\": [\n \"<string>\"\n ],\n \"phases\": [\n {\n \"phase_position\": 1,\n \"bricks\": [\n {\n \"brick_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 123,\n \"is_unlimited\": true,\n \"discount\": [\n {\n \"rate\": \"<string>\",\n \"amount\": 123,\n \"renews\": false\n }\n ]\n }\n ],\n \"starts_at\": \"2023-12-25\",\n \"contract_length\": 2,\n \"plan_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"payment_terms\": 499,\n \"discount_coupons\": [\n \"<string>\"\n ]\n }\n ],\n \"payment_terms\": 499,\n \"custom_order_form_html\": \"<string>\",\n \"metadata\": \"<unknown>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-SALESBRICKS-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://api.salesbricks.com/api/v2/subscriptions/{subscription_id}/recast")
.header("X-SALESBRICKS-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"starts_at\": \"2023-12-25\",\n \"contract_length\": 2,\n \"bricks\": [\n {\n \"brick_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 123,\n \"is_unlimited\": true,\n \"discount\": [\n {\n \"rate\": \"<string>\",\n \"amount\": 123,\n \"renews\": false\n }\n ]\n }\n ],\n \"crm_opportunity_id\": \"<string>\",\n \"adjustment_credit\": 123,\n \"adjustment_credit_label\": \"<string>\",\n \"plan_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"discount_coupons\": [\n \"<string>\"\n ],\n \"phases\": [\n {\n \"phase_position\": 1,\n \"bricks\": [\n {\n \"brick_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 123,\n \"is_unlimited\": true,\n \"discount\": [\n {\n \"rate\": \"<string>\",\n \"amount\": 123,\n \"renews\": false\n }\n ]\n }\n ],\n \"starts_at\": \"2023-12-25\",\n \"contract_length\": 2,\n \"plan_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"payment_terms\": 499,\n \"discount_coupons\": [\n \"<string>\"\n ]\n }\n ],\n \"payment_terms\": 499,\n \"custom_order_form_html\": \"<string>\",\n \"metadata\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.salesbricks.com/api/v2/subscriptions/{subscription_id}/recast")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-SALESBRICKS-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"starts_at\": \"2023-12-25\",\n \"contract_length\": 2,\n \"bricks\": [\n {\n \"brick_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 123,\n \"is_unlimited\": true,\n \"discount\": [\n {\n \"rate\": \"<string>\",\n \"amount\": 123,\n \"renews\": false\n }\n ]\n }\n ],\n \"crm_opportunity_id\": \"<string>\",\n \"adjustment_credit\": 123,\n \"adjustment_credit_label\": \"<string>\",\n \"plan_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"discount_coupons\": [\n \"<string>\"\n ],\n \"phases\": [\n {\n \"phase_position\": 1,\n \"bricks\": [\n {\n \"brick_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 123,\n \"is_unlimited\": true,\n \"discount\": [\n {\n \"rate\": \"<string>\",\n \"amount\": 123,\n \"renews\": false\n }\n ]\n }\n ],\n \"starts_at\": \"2023-12-25\",\n \"contract_length\": 2,\n \"plan_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"payment_terms\": 499,\n \"discount_coupons\": [\n \"<string>\"\n ]\n }\n ],\n \"payment_terms\": 499,\n \"custom_order_form_html\": \"<string>\",\n \"metadata\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contract_value": "<string>",
"pdf_url": "<string>",
"crm_account_id": "<string>",
"crm_opportunity_id": "<string>",
"starts_at": "2023-12-25",
"ends_at": "2023-12-25",
"order_type": "TRIAL"
}{
"error": {
"code": "ERR_BAD_REQUEST",
"message": "Bad request — the input payload is malformed, missing required fields, or contains invalid data."
}
}{
"error": {
"code": "ERR_NOT_FOUND",
"message": "Not found — the resource you are looking for does not exist."
}
}Subscription Recasts
Create a subscription recast
Creates a subscription recast which can be used to replace the terms, dates, and/or entitlements of a customer’s current contract. It essentially scraps the existing agreement and creates a completely new one. Estimate the pricing for the newly created recast order using the /subscriptions/{subscription_id}/recast/{order_id}/estimate endpoint, or start it using /subscriptions/{subscription_id}/recast/{order_id}/start.
How bricks affects existing discounts:
Per-brick discounts are replaced, not merged. The discount sent on a brick becomes that brick’s complete set of discounts for this order, and a brick sent without a discount ends up with none — any discount it previously carried is dropped.
This applies to every brick in the payload, not only the ones being changed. A brick included solely to keep it on the order still needs its discount resent, or it loses it.
Read the current values from the subscription’s line items — discount is returned there in the same shape this endpoint accepts — and send them back for every brick whose discount should carry over.
POST
/
subscriptions
/
{subscription_id}
/
recast
Create a subscription recast
curl --request POST \
--url https://api.salesbricks.com/api/v2/subscriptions/{subscription_id}/recast \
--header 'Content-Type: application/json' \
--header 'X-SALESBRICKS-KEY: <api-key>' \
--data '
{
"starts_at": "2023-12-25",
"contract_length": 2,
"bricks": [
{
"brick_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 123,
"is_unlimited": true,
"discount": [
{
"rate": "<string>",
"amount": 123,
"renews": false
}
]
}
],
"crm_opportunity_id": "<string>",
"adjustment_credit": 123,
"adjustment_credit_label": "<string>",
"plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"discount_coupons": [
"<string>"
],
"phases": [
{
"phase_position": 1,
"bricks": [
{
"brick_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 123,
"is_unlimited": true,
"discount": [
{
"rate": "<string>",
"amount": 123,
"renews": false
}
]
}
],
"starts_at": "2023-12-25",
"contract_length": 2,
"plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"payment_terms": 499,
"discount_coupons": [
"<string>"
]
}
],
"payment_terms": 499,
"custom_order_form_html": "<string>",
"metadata": "<unknown>"
}
'import requests
url = "https://api.salesbricks.com/api/v2/subscriptions/{subscription_id}/recast"
payload = {
"starts_at": "2023-12-25",
"contract_length": 2,
"bricks": [
{
"brick_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 123,
"is_unlimited": True,
"discount": [
{
"rate": "<string>",
"amount": 123,
"renews": False
}
]
}
],
"crm_opportunity_id": "<string>",
"adjustment_credit": 123,
"adjustment_credit_label": "<string>",
"plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"discount_coupons": ["<string>"],
"phases": [
{
"phase_position": 1,
"bricks": [
{
"brick_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 123,
"is_unlimited": True,
"discount": [
{
"rate": "<string>",
"amount": 123,
"renews": False
}
]
}
],
"starts_at": "2023-12-25",
"contract_length": 2,
"plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"payment_terms": 499,
"discount_coupons": ["<string>"]
}
],
"payment_terms": 499,
"custom_order_form_html": "<string>",
"metadata": "<unknown>"
}
headers = {
"X-SALESBRICKS-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-SALESBRICKS-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
starts_at: '2023-12-25',
contract_length: 2,
bricks: [
{
brick_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
quantity: 123,
is_unlimited: true,
discount: [{rate: '<string>', amount: 123, renews: false}]
}
],
crm_opportunity_id: '<string>',
adjustment_credit: 123,
adjustment_credit_label: '<string>',
plan_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
discount_coupons: ['<string>'],
phases: [
{
phase_position: 1,
bricks: [
{
brick_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
quantity: 123,
is_unlimited: true,
discount: [{rate: '<string>', amount: 123, renews: false}]
}
],
starts_at: '2023-12-25',
contract_length: 2,
plan_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
payment_terms: 499,
discount_coupons: ['<string>']
}
],
payment_terms: 499,
custom_order_form_html: '<string>',
metadata: '<unknown>'
})
};
fetch('https://api.salesbricks.com/api/v2/subscriptions/{subscription_id}/recast', 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.salesbricks.com/api/v2/subscriptions/{subscription_id}/recast",
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([
'starts_at' => '2023-12-25',
'contract_length' => 2,
'bricks' => [
[
'brick_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'quantity' => 123,
'is_unlimited' => true,
'discount' => [
[
'rate' => '<string>',
'amount' => 123,
'renews' => false
]
]
]
],
'crm_opportunity_id' => '<string>',
'adjustment_credit' => 123,
'adjustment_credit_label' => '<string>',
'plan_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'discount_coupons' => [
'<string>'
],
'phases' => [
[
'phase_position' => 1,
'bricks' => [
[
'brick_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'quantity' => 123,
'is_unlimited' => true,
'discount' => [
[
'rate' => '<string>',
'amount' => 123,
'renews' => false
]
]
]
],
'starts_at' => '2023-12-25',
'contract_length' => 2,
'plan_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'payment_terms' => 499,
'discount_coupons' => [
'<string>'
]
]
],
'payment_terms' => 499,
'custom_order_form_html' => '<string>',
'metadata' => '<unknown>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-SALESBRICKS-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://api.salesbricks.com/api/v2/subscriptions/{subscription_id}/recast"
payload := strings.NewReader("{\n \"starts_at\": \"2023-12-25\",\n \"contract_length\": 2,\n \"bricks\": [\n {\n \"brick_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 123,\n \"is_unlimited\": true,\n \"discount\": [\n {\n \"rate\": \"<string>\",\n \"amount\": 123,\n \"renews\": false\n }\n ]\n }\n ],\n \"crm_opportunity_id\": \"<string>\",\n \"adjustment_credit\": 123,\n \"adjustment_credit_label\": \"<string>\",\n \"plan_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"discount_coupons\": [\n \"<string>\"\n ],\n \"phases\": [\n {\n \"phase_position\": 1,\n \"bricks\": [\n {\n \"brick_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 123,\n \"is_unlimited\": true,\n \"discount\": [\n {\n \"rate\": \"<string>\",\n \"amount\": 123,\n \"renews\": false\n }\n ]\n }\n ],\n \"starts_at\": \"2023-12-25\",\n \"contract_length\": 2,\n \"plan_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"payment_terms\": 499,\n \"discount_coupons\": [\n \"<string>\"\n ]\n }\n ],\n \"payment_terms\": 499,\n \"custom_order_form_html\": \"<string>\",\n \"metadata\": \"<unknown>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-SALESBRICKS-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://api.salesbricks.com/api/v2/subscriptions/{subscription_id}/recast")
.header("X-SALESBRICKS-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"starts_at\": \"2023-12-25\",\n \"contract_length\": 2,\n \"bricks\": [\n {\n \"brick_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 123,\n \"is_unlimited\": true,\n \"discount\": [\n {\n \"rate\": \"<string>\",\n \"amount\": 123,\n \"renews\": false\n }\n ]\n }\n ],\n \"crm_opportunity_id\": \"<string>\",\n \"adjustment_credit\": 123,\n \"adjustment_credit_label\": \"<string>\",\n \"plan_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"discount_coupons\": [\n \"<string>\"\n ],\n \"phases\": [\n {\n \"phase_position\": 1,\n \"bricks\": [\n {\n \"brick_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 123,\n \"is_unlimited\": true,\n \"discount\": [\n {\n \"rate\": \"<string>\",\n \"amount\": 123,\n \"renews\": false\n }\n ]\n }\n ],\n \"starts_at\": \"2023-12-25\",\n \"contract_length\": 2,\n \"plan_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"payment_terms\": 499,\n \"discount_coupons\": [\n \"<string>\"\n ]\n }\n ],\n \"payment_terms\": 499,\n \"custom_order_form_html\": \"<string>\",\n \"metadata\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.salesbricks.com/api/v2/subscriptions/{subscription_id}/recast")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-SALESBRICKS-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"starts_at\": \"2023-12-25\",\n \"contract_length\": 2,\n \"bricks\": [\n {\n \"brick_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 123,\n \"is_unlimited\": true,\n \"discount\": [\n {\n \"rate\": \"<string>\",\n \"amount\": 123,\n \"renews\": false\n }\n ]\n }\n ],\n \"crm_opportunity_id\": \"<string>\",\n \"adjustment_credit\": 123,\n \"adjustment_credit_label\": \"<string>\",\n \"plan_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"discount_coupons\": [\n \"<string>\"\n ],\n \"phases\": [\n {\n \"phase_position\": 1,\n \"bricks\": [\n {\n \"brick_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 123,\n \"is_unlimited\": true,\n \"discount\": [\n {\n \"rate\": \"<string>\",\n \"amount\": 123,\n \"renews\": false\n }\n ]\n }\n ],\n \"starts_at\": \"2023-12-25\",\n \"contract_length\": 2,\n \"plan_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"payment_terms\": 499,\n \"discount_coupons\": [\n \"<string>\"\n ]\n }\n ],\n \"payment_terms\": 499,\n \"custom_order_form_html\": \"<string>\",\n \"metadata\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contract_value": "<string>",
"pdf_url": "<string>",
"crm_account_id": "<string>",
"crm_opportunity_id": "<string>",
"starts_at": "2023-12-25",
"ends_at": "2023-12-25",
"order_type": "TRIAL"
}{
"error": {
"code": "ERR_BAD_REQUEST",
"message": "Bad request — the input payload is malformed, missing required fields, or contains invalid data."
}
}{
"error": {
"code": "ERR_NOT_FOUND",
"message": "Not found — the resource you are looking for does not exist."
}
}Authorizations
API key for authentication
Path Parameters
Pattern:
^([a-zA-Z\d\-]+)$Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
- SubscriptionInputRecastSinglePhase
- SubscriptionInputRecastMultiPhase
Subscription recast input serializer; similar to SubscriptionInputUpgradeSerializer but with adjustment credits.
This payload has two forms — see anyOf:
- Single-phase — omit
phases; the order-levelstarts_at,contract_length,billing_frequencyandbricksdefine the one phase and are required. - Multi-phase — send
phases; the phases own the timeline, billing frequency and bricks, and the order-level equivalents become optional (omitted, they are derived from the phases).
The fields are declared optional because OpenAPI 3.0 cannot make one field's required depend on another. Sending neither form is a 400.
The start date of the subscription. Required unless phases is provided, in which case phase 0's start date is used.
The length of the contract in months. Required unless phases is provided, in which case it is the sum of the phase lengths.
Required range:
x >= 1The billing frequency. Required unless phases is provided, in which case each phase declares its own billing_frequency.
MONTHLY- MonthlyQUARTERLY- QuarterlySEMI_ANNUALLY- Semi-annuallyANNUALLY- AnnuallyALL_UPFRONT- All upfront
Available options:
MONTHLY, QUARTERLY, SEMI_ANNUALLY, ANNUALLY, ALL_UPFRONT The bricks included in subscription recast. Quantity is used to update the add-on quantity (ie. adding 2 more units should be quantity 2 -> quantity 4). For usage, quantity is used to set the pre-commitment (ie. previously having 5 pre-commitment quantity and updating it to 10 would update the pre-commitment quantity to 10.) Required unless phases is provided.
Show child attributes
Show child attributes
Optional ID of the opportunity (deal in HubSpot) in your connected CRM to link the subscription to. Requires a linked CRM account, and must not be linked to another subscription. Omit for no change; pass an empty string to unlink it.
Maximum string length:
255Credit that will be applied against future invoices. Send null to clear a manual override and re-enable auto-calculation.
The label for the adjustment credit. Defaults to 'Adjustment credit'
Optional plan id to switch plans, otherwise it will use the base order's latest plan version.
Discount coupon codes to apply to the subscription. Currently only supports one discount coupon - only the first one in the list will be applied.
Optional list of phases for multi-phase orders. When provided, ALL phases come from this array (first element = phase 0, second = phase 1, etc.) and starts_at, contract_length, billing_frequency and bricks become optional — omit them and they are derived from the phases. plan_id is still required, and every brick in every phase must belong to it. When absent, the order-level fields define a single phase.
Show child attributes
Show child attributes
The number of days from an invoice being generated that the buyer is expected to pay in
Required range:
0 <= x <= 999The medium by which the order is agreed.
ORDER_FORM- Order formSTRIPE- Stripe
Available options:
ORDER_FORM, STRIPE The custom order form html to use with <html><body>...</body></html> formatting
Optional metadata to add to the subscription. Sending an empty map will delete all keys. Keys prefixed with _ are private and will be ignored.
Response
Serializer for individual subscription order
Unique identifier for the order
Total contract value with currency
URL to download signed order form PDF
ID of the account linked in your connected CRM, if any.
ID of the opportunity linked in your connected CRM, if any.
Start date of the order
End date of the order
TRIAL- TrialSTANDARD- New BusinessRENEWAL- RenewalUPGRADE- UpgradeRECAST- Recast
Available options:
TRIAL, STANDARD, RENEWAL, UPGRADE, RECAST