curl --request POST \
--url https://app.sideshift.app/api/oauth/v1/billing/handoff-link \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"subaccountId": "<string>",
"suggestedAmountCents": 25000000,
"reason": "<string>"
}
'import requests
url = "https://app.sideshift.app/api/oauth/v1/billing/handoff-link"
payload = {
"subaccountId": "<string>",
"suggestedAmountCents": 25000000,
"reason": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({subaccountId: '<string>', suggestedAmountCents: 25000000, reason: '<string>'})
};
fetch('https://app.sideshift.app/api/oauth/v1/billing/handoff-link', 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://app.sideshift.app/api/oauth/v1/billing/handoff-link",
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([
'subaccountId' => '<string>',
'suggestedAmountCents' => 25000000,
'reason' => '<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://app.sideshift.app/api/oauth/v1/billing/handoff-link"
payload := strings.NewReader("{\n \"subaccountId\": \"<string>\",\n \"suggestedAmountCents\": 25000000,\n \"reason\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://app.sideshift.app/api/oauth/v1/billing/handoff-link")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"subaccountId\": \"<string>\",\n \"suggestedAmountCents\": 25000000,\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sideshift.app/api/oauth/v1/billing/handoff-link")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"subaccountId\": \"<string>\",\n \"suggestedAmountCents\": 25000000,\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"code": "<string>",
"url": "<string>",
"kind": "subscription",
"suggestedAmountCents": 123,
"reason": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"instructions": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "name is required",
"requestId": "req_..."
}
}{
"error": {
"code": "unauthorized",
"message": "Missing bearer access token",
"requestId": "req_..."
}
}{
"error": {
"code": "insufficient_scope",
"message": "Requires scope 'campaigns:write'",
"requestId": "req_..."
}
}{
"error": {
"code": "not_found",
"message": "Resource not found",
"requestId": "req_..."
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded",
"requestId": "req_..."
}
}Mint a browser billing handoff link
Mint a short-lived (24h) link + code the agent hands to the human user for the BROWSER-ONLY money / purchase actions: paying for / managing the SideShift subscription (kind: subscription), adding funds to the company wallet (kind: wallet_topup), setting up an agency subaccount’s own per-client subscription (kind: agency_client_subscription, pass subaccountId), adding a payment method (kind: add_card), buying an extra job-posting slot (kind: job_post), or buying more recruitment invites (kind: recruitment_invites). None are executable through this API by design. The link grants nothing by itself — the user must log in to the web app and be a member of the token’s company — and never charges anything: the user reviews and confirms every payment in the browser. Reachable while the subscription is INACTIVE (that lapse is the #1 reason a link is needed), and allowed for sandbox grants. Requires only the billing:read scope (the mint exposes no billing data and grants no capability).
curl --request POST \
--url https://app.sideshift.app/api/oauth/v1/billing/handoff-link \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"subaccountId": "<string>",
"suggestedAmountCents": 25000000,
"reason": "<string>"
}
'import requests
url = "https://app.sideshift.app/api/oauth/v1/billing/handoff-link"
payload = {
"subaccountId": "<string>",
"suggestedAmountCents": 25000000,
"reason": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({subaccountId: '<string>', suggestedAmountCents: 25000000, reason: '<string>'})
};
fetch('https://app.sideshift.app/api/oauth/v1/billing/handoff-link', 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://app.sideshift.app/api/oauth/v1/billing/handoff-link",
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([
'subaccountId' => '<string>',
'suggestedAmountCents' => 25000000,
'reason' => '<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://app.sideshift.app/api/oauth/v1/billing/handoff-link"
payload := strings.NewReader("{\n \"subaccountId\": \"<string>\",\n \"suggestedAmountCents\": 25000000,\n \"reason\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://app.sideshift.app/api/oauth/v1/billing/handoff-link")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"subaccountId\": \"<string>\",\n \"suggestedAmountCents\": 25000000,\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sideshift.app/api/oauth/v1/billing/handoff-link")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"subaccountId\": \"<string>\",\n \"suggestedAmountCents\": 25000000,\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"code": "<string>",
"url": "<string>",
"kind": "subscription",
"suggestedAmountCents": 123,
"reason": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"instructions": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "name is required",
"requestId": "req_..."
}
}{
"error": {
"code": "unauthorized",
"message": "Missing bearer access token",
"requestId": "req_..."
}
}{
"error": {
"code": "insufficient_scope",
"message": "Requires scope 'campaigns:write'",
"requestId": "req_..."
}
}{
"error": {
"code": "not_found",
"message": "Resource not found",
"requestId": "req_..."
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded",
"requestId": "req_..."
}
}Authorizations
OAuth 2.1 authorization code + PKCE (S256). Tokens are tenant-bound (company_id) and scoped. Discover endpoints via /.well-known/oauth-authorization-server.
Body
Which browser action the user should land on.
subscription, wallet_topup, agency_client_subscription, add_card, job_post, recruitment_invites Required for kind: agency_client_subscription: the agency subaccount (client) whose per-client subscription to set up. Must be the token tenant itself or a subaccount under it. Ignored for other kinds.
Optional (wallet_topup only): top-up amount in cents to prefill on the add-funds screen. A suggestion only.
1 <= x <= 50000000Optional short context shown to the user on the landing page.
300Response
Created. Returns the minted link.
Show child attributes
Show child attributes