Create/Sign a new Contract
curl --request POST \
--url http://127.0.0.1:8080/v1/c/contract \
--header 'Content-Type: application/json' \
--header 'wb-key: <api-key>' \
--data '
{
"customer": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"plan": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"activation": "2023-11-07T05:31:56Z",
"automatic_payment": true,
"discount_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"feature_configuration": {},
"free_trial_days": 1,
"invoice_trigger": "immediate",
"is_pending": true,
"pricing_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"unit_count_configuration": {}
}
'import requests
url = "http://127.0.0.1:8080/v1/c/contract"
payload = {
"customer": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"plan": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"activation": "2023-11-07T05:31:56Z",
"automatic_payment": True,
"discount_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"feature_configuration": {},
"free_trial_days": 1,
"invoice_trigger": "immediate",
"is_pending": True,
"pricing_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"unit_count_configuration": {}
}
headers = {
"wb-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'wb-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
customer: 'Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670',
plan: 'Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670',
activation: '2023-11-07T05:31:56Z',
automatic_payment: true,
discount_id: 'Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670',
feature_configuration: {},
free_trial_days: 1,
invoice_trigger: 'immediate',
is_pending: true,
pricing_id: 'Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670',
unit_count_configuration: {}
})
};
fetch('http://127.0.0.1:8080/v1/c/contract', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://127.0.0.1:8080/v1/c/contract",
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([
'customer' => 'Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670',
'plan' => 'Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670',
'activation' => '2023-11-07T05:31:56Z',
'automatic_payment' => true,
'discount_id' => 'Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670',
'feature_configuration' => [
],
'free_trial_days' => 1,
'invoice_trigger' => 'immediate',
'is_pending' => true,
'pricing_id' => 'Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670',
'unit_count_configuration' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"wb-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 := "http://127.0.0.1:8080/v1/c/contract"
payload := strings.NewReader("{\n \"customer\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\",\n \"plan\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\",\n \"activation\": \"2023-11-07T05:31:56Z\",\n \"automatic_payment\": true,\n \"discount_id\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\",\n \"feature_configuration\": {},\n \"free_trial_days\": 1,\n \"invoice_trigger\": \"immediate\",\n \"is_pending\": true,\n \"pricing_id\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\",\n \"unit_count_configuration\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("wb-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("http://127.0.0.1:8080/v1/c/contract")
.header("wb-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"customer\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\",\n \"plan\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\",\n \"activation\": \"2023-11-07T05:31:56Z\",\n \"automatic_payment\": true,\n \"discount_id\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\",\n \"feature_configuration\": {},\n \"free_trial_days\": 1,\n \"invoice_trigger\": \"immediate\",\n \"is_pending\": true,\n \"pricing_id\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\",\n \"unit_count_configuration\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://127.0.0.1:8080/v1/c/contract")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["wb-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customer\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\",\n \"plan\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\",\n \"activation\": \"2023-11-07T05:31:56Z\",\n \"automatic_payment\": true,\n \"discount_id\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\",\n \"feature_configuration\": {},\n \"free_trial_days\": 1,\n \"invoice_trigger\": \"immediate\",\n \"is_pending\": true,\n \"pricing_id\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\",\n \"unit_count_configuration\": {}\n}"
response = http.request(request)
puts response.read_body"Cont_cc871a3a-2b38-4689-a32d-14bf2e62b1ae"Contract
Subscribe Customer to a Plan
POST
/
v1
/
c
/
contract
Create/Sign a new Contract
curl --request POST \
--url http://127.0.0.1:8080/v1/c/contract \
--header 'Content-Type: application/json' \
--header 'wb-key: <api-key>' \
--data '
{
"customer": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"plan": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"activation": "2023-11-07T05:31:56Z",
"automatic_payment": true,
"discount_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"feature_configuration": {},
"free_trial_days": 1,
"invoice_trigger": "immediate",
"is_pending": true,
"pricing_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"unit_count_configuration": {}
}
'import requests
url = "http://127.0.0.1:8080/v1/c/contract"
payload = {
"customer": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"plan": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"activation": "2023-11-07T05:31:56Z",
"automatic_payment": True,
"discount_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"feature_configuration": {},
"free_trial_days": 1,
"invoice_trigger": "immediate",
"is_pending": True,
"pricing_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"unit_count_configuration": {}
}
headers = {
"wb-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'wb-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
customer: 'Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670',
plan: 'Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670',
activation: '2023-11-07T05:31:56Z',
automatic_payment: true,
discount_id: 'Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670',
feature_configuration: {},
free_trial_days: 1,
invoice_trigger: 'immediate',
is_pending: true,
pricing_id: 'Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670',
unit_count_configuration: {}
})
};
fetch('http://127.0.0.1:8080/v1/c/contract', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://127.0.0.1:8080/v1/c/contract",
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([
'customer' => 'Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670',
'plan' => 'Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670',
'activation' => '2023-11-07T05:31:56Z',
'automatic_payment' => true,
'discount_id' => 'Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670',
'feature_configuration' => [
],
'free_trial_days' => 1,
'invoice_trigger' => 'immediate',
'is_pending' => true,
'pricing_id' => 'Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670',
'unit_count_configuration' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"wb-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 := "http://127.0.0.1:8080/v1/c/contract"
payload := strings.NewReader("{\n \"customer\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\",\n \"plan\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\",\n \"activation\": \"2023-11-07T05:31:56Z\",\n \"automatic_payment\": true,\n \"discount_id\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\",\n \"feature_configuration\": {},\n \"free_trial_days\": 1,\n \"invoice_trigger\": \"immediate\",\n \"is_pending\": true,\n \"pricing_id\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\",\n \"unit_count_configuration\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("wb-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("http://127.0.0.1:8080/v1/c/contract")
.header("wb-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"customer\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\",\n \"plan\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\",\n \"activation\": \"2023-11-07T05:31:56Z\",\n \"automatic_payment\": true,\n \"discount_id\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\",\n \"feature_configuration\": {},\n \"free_trial_days\": 1,\n \"invoice_trigger\": \"immediate\",\n \"is_pending\": true,\n \"pricing_id\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\",\n \"unit_count_configuration\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://127.0.0.1:8080/v1/c/contract")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["wb-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customer\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\",\n \"plan\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\",\n \"activation\": \"2023-11-07T05:31:56Z\",\n \"automatic_payment\": true,\n \"discount_id\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\",\n \"feature_configuration\": {},\n \"free_trial_days\": 1,\n \"invoice_trigger\": \"immediate\",\n \"is_pending\": true,\n \"pricing_id\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\",\n \"unit_count_configuration\": {}\n}"
response = http.request(request)
puts response.read_body"Cont_cc871a3a-2b38-4689-a32d-14bf2e62b1ae"Authorizations
api-keywb_user_cookie
Body
application/json
Configuration used by a WbCustomer to sign up a Customer to a plan
A supported currency
The format for parsing and reading is the lowercased ISO 4217 currency code (e.g. "usd")
Available options:
usd, eur, gbp, brl, ars Unique identifier of an object. Consists of object class prefix and a UUID
Example:
"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670"
Enum that lists supported payment cycles for contracts:
- Once - one-time payment
- Constant - one-time payment for the duration of the contract
- Week - contract is paid weekly
- Month - contract is paid monthly
- Quarter - contract is paid every quarter
- Year - contract is paid yearly
Available options:
once, hour, day, week, month, quarter, year, constant Unique identifier of an object. Consists of object class prefix and a UUID
Example:
"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670"
Contract activation date. Immediate if empty
Whether the Customer should be charged by Wingback Billing Engine or not If not set, the configuration from Customer profile will be used, and if that is not set either, the default configuration for WbCustomer will be used
Unique identifier of an object. Consists of object class prefix and a UUID
Example:
"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670"
Configuration specifying overrides to apply to new plan during contract upgrade. In addition to the number of units to purchase, it is possible to override price and flat_fee of specific features to create customized plans See FeatureConfiguration for format
Show child attributes
Show child attributes
The optional custom number of days on free trial
Required range:
x >= 0When the invoices should be created
Note: EveryCycle and Periodic aren't yet supported, they will behave as Manual
Available options:
immediate Creates a pending contract. Pending contract has no activation date, and can only be activated manually. Activation date is ignored if this is set to true. Defaults to false
Unique identifier of an object. Consists of object class prefix and a UUID
Example:
"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670"
Configuration specifying the number of units to purchase on the new plan for unit-based features. This is a hashmap where keys are slugs of features, and values are the numbers of units to purchase { "{feature_slug}": {number_of_units} }
Show child attributes
Show child attributes
Response
Updated