curl --request PUT \
--url https://{subdomain}.conveyour.com/api/org/billing \
--header 'Content-Type: application/json' \
--header 'x-conveyour-token: <api-key>' \
--data '
{
"billing_action": "<string>",
"payment_method_id": "<string>",
"payment_intent_id": "<string>",
"invoice_id": "<string>"
}
'const options = {
method: 'PUT',
headers: {'x-conveyour-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
billing_action: '<string>',
payment_method_id: '<string>',
payment_intent_id: '<string>',
invoice_id: '<string>'
})
};
fetch('https://{subdomain}.conveyour.com/api/org/billing', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {
method: 'PUT',
headers: {'x-conveyour-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
billing_action: '<string>',
payment_method_id: '<string>',
payment_intent_id: '<string>',
invoice_id: '<string>'
})
};
fetch('https://{subdomain}.conveyour.com/api/org/billing', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{subdomain}.conveyour.com/api/org/billing"
payload = {
"billing_action": "<string>",
"payment_method_id": "<string>",
"payment_intent_id": "<string>",
"invoice_id": "<string>"
}
headers = {
"x-conveyour-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{subdomain}.conveyour.com/api/org/billing",
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([
'billing_action' => '<string>',
'payment_method_id' => '<string>',
'payment_intent_id' => '<string>',
'invoice_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-conveyour-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"status": "ok",
"message": "success",
"data": {
"payment_intent_id": "pi_...",
"client_secret": "pi_..._secret_...",
"payment_method": "pm_..."
}
}{
"status": "failed",
"message": "Lacking necessary permission add_contacts",
"data": {
"permission": "add_contacts"
}
}Update billing details
Updates the default payment method. Requires the manage_billing permission. The exact fields consumed depend on the billing_action supplied.
Update the default payment method (manage_billing)
Not callable with an API key. Requires manage_billing, which ConveYour never grants to service accounts (deny_for_types: [service]), so every API key gets 403. Only a signed-in user with this permission can call it.
Permission: requires manage_billing.
curl --request PUT \
--url https://{subdomain}.conveyour.com/api/org/billing \
--header 'Content-Type: application/json' \
--header 'x-conveyour-token: <api-key>' \
--data '
{
"billing_action": "<string>",
"payment_method_id": "<string>",
"payment_intent_id": "<string>",
"invoice_id": "<string>"
}
'const options = {
method: 'PUT',
headers: {'x-conveyour-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
billing_action: '<string>',
payment_method_id: '<string>',
payment_intent_id: '<string>',
invoice_id: '<string>'
})
};
fetch('https://{subdomain}.conveyour.com/api/org/billing', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {
method: 'PUT',
headers: {'x-conveyour-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
billing_action: '<string>',
payment_method_id: '<string>',
payment_intent_id: '<string>',
invoice_id: '<string>'
})
};
fetch('https://{subdomain}.conveyour.com/api/org/billing', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{subdomain}.conveyour.com/api/org/billing"
payload = {
"billing_action": "<string>",
"payment_method_id": "<string>",
"payment_intent_id": "<string>",
"invoice_id": "<string>"
}
headers = {
"x-conveyour-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{subdomain}.conveyour.com/api/org/billing",
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([
'billing_action' => '<string>',
'payment_method_id' => '<string>',
'payment_intent_id' => '<string>',
'invoice_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-conveyour-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"status": "ok",
"message": "success",
"data": {
"payment_intent_id": "pi_...",
"client_secret": "pi_..._secret_...",
"payment_method": "pm_..."
}
}{
"status": "failed",
"message": "Lacking necessary permission add_contacts",
"data": {
"permission": "add_contacts"
}
}Authorizations
Your API key token. Contacts endpoints require a Server-only — Full API key — see Authentication.
Query Parameters
Team scope for the request, as one or more team ObjectIds. The brackets are required: PHP keeps only the last value for a repeated plain key, so teams=A&teams=B silently resolves to B alone. On requests with a JSON body you may send teams (no brackets) in the body instead.
Values that are not valid ObjectIds are silently ignored — a mistyped team ID behaves as if no team was sent. See the teams section of the API conventions guide.
Body
The billing action to perform (e.g. setup, attach, or authenticate a payment method). Determines which other fields are required.
Stripe payment method ID. Required when attaching a payment method.
Stripe payment intent ID. Used when authenticating a payment intent.
Stripe invoice ID to pay after attaching the payment method.
Response
Success.
The common response envelope shared by all ConveYour endpoints.