Update payment settings
curl --request PATCH \
--url https://api.custral.com/v1/billing/settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"customerKey": "<string>",
"billingContact": "<string>",
"quoteFrom": [
{
"object": "<string>",
"link": "<string>"
}
],
"payerParent": "<string>",
"billingFields": {},
"paymentMethods": [],
"paymentTermsDays": 182,
"allowedReturnDomains": [
"<string>"
],
"stripeMatchMetadataKey": "<string>"
}
'import requests
url = "https://api.custral.com/v1/billing/settings"
payload = {
"customerKey": "<string>",
"billingContact": "<string>",
"quoteFrom": [
{
"object": "<string>",
"link": "<string>"
}
],
"payerParent": "<string>",
"billingFields": {},
"paymentMethods": [],
"paymentTermsDays": 182,
"allowedReturnDomains": ["<string>"],
"stripeMatchMetadataKey": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
customerKey: '<string>',
billingContact: '<string>',
quoteFrom: [{object: '<string>', link: '<string>'}],
payerParent: '<string>',
billingFields: {},
paymentMethods: [],
paymentTermsDays: 182,
allowedReturnDomains: ['<string>'],
stripeMatchMetadataKey: '<string>'
})
};
fetch('https://api.custral.com/v1/billing/settings', 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.custral.com/v1/billing/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'customerKey' => '<string>',
'billingContact' => '<string>',
'quoteFrom' => [
[
'object' => '<string>',
'link' => '<string>'
]
],
'payerParent' => '<string>',
'billingFields' => [
],
'paymentMethods' => [
],
'paymentTermsDays' => 182,
'allowedReturnDomains' => [
'<string>'
],
'stripeMatchMetadataKey' => '<string>'
]),
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.custral.com/v1/billing/settings"
payload := strings.NewReader("{\n \"customerKey\": \"<string>\",\n \"billingContact\": \"<string>\",\n \"quoteFrom\": [\n {\n \"object\": \"<string>\",\n \"link\": \"<string>\"\n }\n ],\n \"payerParent\": \"<string>\",\n \"billingFields\": {},\n \"paymentMethods\": [],\n \"paymentTermsDays\": 182,\n \"allowedReturnDomains\": [\n \"<string>\"\n ],\n \"stripeMatchMetadataKey\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.custral.com/v1/billing/settings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"customerKey\": \"<string>\",\n \"billingContact\": \"<string>\",\n \"quoteFrom\": [\n {\n \"object\": \"<string>\",\n \"link\": \"<string>\"\n }\n ],\n \"payerParent\": \"<string>\",\n \"billingFields\": {},\n \"paymentMethods\": [],\n \"paymentTermsDays\": 182,\n \"allowedReturnDomains\": [\n \"<string>\"\n ],\n \"stripeMatchMetadataKey\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.custral.com/v1/billing/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customerKey\": \"<string>\",\n \"billingContact\": \"<string>\",\n \"quoteFrom\": [\n {\n \"object\": \"<string>\",\n \"link\": \"<string>\"\n }\n ],\n \"payerParent\": \"<string>\",\n \"billingFields\": {},\n \"paymentMethods\": [],\n \"paymentTermsDays\": 182,\n \"allowedReturnDomains\": [\n \"<string>\"\n ],\n \"stripeMatchMetadataKey\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"customersObject": {
"key": "companies",
"name": "Companies"
},
"customerKey": "<string>",
"billingContact": "<string>",
"quoteFrom": [
{
"object": "<string>",
"link": "<string>"
}
],
"payerParent": "<string>",
"billingFields": {},
"paymentMethods": [
"card"
],
"defaultCollectionMethod": "autopay",
"paymentTermsDays": 123,
"allowedReturnDomains": [
"<string>"
],
"stripeMatchMetadataKey": "<string>"
},
"reqId": "req_2a1f9c8e7b6d5"
}Billing
Update payment settings
Change the payment settings you name; "" clears one. An unknown key is refused by name (object_key_not_found, property_key_not_found), never dropped. The key’s creator must be a workspace admin. Requires scope: billing:admin.
PATCH
/
v1
/
billing
/
settings
Update payment settings
curl --request PATCH \
--url https://api.custral.com/v1/billing/settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"customerKey": "<string>",
"billingContact": "<string>",
"quoteFrom": [
{
"object": "<string>",
"link": "<string>"
}
],
"payerParent": "<string>",
"billingFields": {},
"paymentMethods": [],
"paymentTermsDays": 182,
"allowedReturnDomains": [
"<string>"
],
"stripeMatchMetadataKey": "<string>"
}
'import requests
url = "https://api.custral.com/v1/billing/settings"
payload = {
"customerKey": "<string>",
"billingContact": "<string>",
"quoteFrom": [
{
"object": "<string>",
"link": "<string>"
}
],
"payerParent": "<string>",
"billingFields": {},
"paymentMethods": [],
"paymentTermsDays": 182,
"allowedReturnDomains": ["<string>"],
"stripeMatchMetadataKey": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
customerKey: '<string>',
billingContact: '<string>',
quoteFrom: [{object: '<string>', link: '<string>'}],
payerParent: '<string>',
billingFields: {},
paymentMethods: [],
paymentTermsDays: 182,
allowedReturnDomains: ['<string>'],
stripeMatchMetadataKey: '<string>'
})
};
fetch('https://api.custral.com/v1/billing/settings', 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.custral.com/v1/billing/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'customerKey' => '<string>',
'billingContact' => '<string>',
'quoteFrom' => [
[
'object' => '<string>',
'link' => '<string>'
]
],
'payerParent' => '<string>',
'billingFields' => [
],
'paymentMethods' => [
],
'paymentTermsDays' => 182,
'allowedReturnDomains' => [
'<string>'
],
'stripeMatchMetadataKey' => '<string>'
]),
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.custral.com/v1/billing/settings"
payload := strings.NewReader("{\n \"customerKey\": \"<string>\",\n \"billingContact\": \"<string>\",\n \"quoteFrom\": [\n {\n \"object\": \"<string>\",\n \"link\": \"<string>\"\n }\n ],\n \"payerParent\": \"<string>\",\n \"billingFields\": {},\n \"paymentMethods\": [],\n \"paymentTermsDays\": 182,\n \"allowedReturnDomains\": [\n \"<string>\"\n ],\n \"stripeMatchMetadataKey\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.custral.com/v1/billing/settings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"customerKey\": \"<string>\",\n \"billingContact\": \"<string>\",\n \"quoteFrom\": [\n {\n \"object\": \"<string>\",\n \"link\": \"<string>\"\n }\n ],\n \"payerParent\": \"<string>\",\n \"billingFields\": {},\n \"paymentMethods\": [],\n \"paymentTermsDays\": 182,\n \"allowedReturnDomains\": [\n \"<string>\"\n ],\n \"stripeMatchMetadataKey\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.custral.com/v1/billing/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customerKey\": \"<string>\",\n \"billingContact\": \"<string>\",\n \"quoteFrom\": [\n {\n \"object\": \"<string>\",\n \"link\": \"<string>\"\n }\n ],\n \"payerParent\": \"<string>\",\n \"billingFields\": {},\n \"paymentMethods\": [],\n \"paymentTermsDays\": 182,\n \"allowedReturnDomains\": [\n \"<string>\"\n ],\n \"stripeMatchMetadataKey\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"customersObject": {
"key": "companies",
"name": "Companies"
},
"customerKey": "<string>",
"billingContact": "<string>",
"quoteFrom": [
{
"object": "<string>",
"link": "<string>"
}
],
"payerParent": "<string>",
"billingFields": {},
"paymentMethods": [
"card"
],
"defaultCollectionMethod": "autopay",
"paymentTermsDays": 123,
"allowedReturnDomains": [
"<string>"
],
"stripeMatchMetadataKey": "<string>"
},
"reqId": "req_2a1f9c8e7b6d5"
}Authorizations
A Custral API key, created in Settings → Developers → Applications, sent as Authorization: Bearer sk_…. The X-Api-Key header is also accepted and takes precedence. Use a secret key (sk_…) from your server; a publishable key (pk_…) may hold only objects:read and usage:write. Never expose a secret key in a browser.
Body
application/json
Omitted fields stay as they are; "" clears a key. The customers object itself is picked in the app.
Was this page helpful?