Retain the first free provider account
curl --request POST \
--url https://api.interchange.io/api/v2/buyer/activation/provider-binding \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"advertiserId": "<string>",
"connectionId": "<string>",
"accountId": "<string>"
}
'import requests
url = "https://api.interchange.io/api/v2/buyer/activation/provider-binding"
payload = {
"advertiserId": "<string>",
"connectionId": "<string>",
"accountId": "<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({advertiserId: '<string>', connectionId: '<string>', accountId: '<string>'})
};
fetch('https://api.interchange.io/api/v2/buyer/activation/provider-binding', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"previousState": "unbound_free",
"activation": {
"schemaVersion": "1.3",
"activationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workloadId": "<string>",
"state": "unbound_free",
"expiresAt": "2023-11-07T05:31:56Z",
"allowance": {
"ttlDays": 30,
"cleanup": "automatic_at_expiry",
"spendCap": {
"amountMinor": 4503599627370495,
"currency": "USD"
},
"grants": [
"<string>"
],
"prohibitedOperations": [
"<string>"
]
},
"account": {
"accessPosture": "SANDBOX_ONLY",
"source": "EXPLICIT"
},
"claim": {
"available": true,
"preservesActivationId": true
}
},
"bindingRef": "<string>",
"cleanupCancelled": true
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Account
Retain the first free provider account
Atomically map the first customer-local provider account and retain the unclaimed WorkOS Agent Registration as BOUND_FREE. Interchange derives this exact zero-spend lifecycle capability from the verified Agent Registration and its activation state; no separate WorkOS permission or identity claim is required.
POST
/
activation
/
provider-binding
Retain the first free provider account
curl --request POST \
--url https://api.interchange.io/api/v2/buyer/activation/provider-binding \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"advertiserId": "<string>",
"connectionId": "<string>",
"accountId": "<string>"
}
'import requests
url = "https://api.interchange.io/api/v2/buyer/activation/provider-binding"
payload = {
"advertiserId": "<string>",
"connectionId": "<string>",
"accountId": "<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({advertiserId: '<string>', connectionId: '<string>', accountId: '<string>'})
};
fetch('https://api.interchange.io/api/v2/buyer/activation/provider-binding', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"previousState": "unbound_free",
"activation": {
"schemaVersion": "1.3",
"activationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workloadId": "<string>",
"state": "unbound_free",
"expiresAt": "2023-11-07T05:31:56Z",
"allowance": {
"ttlDays": 30,
"cleanup": "automatic_at_expiry",
"spendCap": {
"amountMinor": 4503599627370495,
"currency": "USD"
},
"grants": [
"<string>"
],
"prohibitedOperations": [
"<string>"
]
},
"account": {
"accessPosture": "SANDBOX_ONLY",
"source": "EXPLICIT"
},
"claim": {
"available": true,
"preservesActivationId": true
}
},
"bindingRef": "<string>",
"cleanupCancelled": true
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Authorizations
API key or access token
Body
application/json
Response
Retain the first free provider account
Available options:
unbound_free, bound_free Stable activation lineage, current workload attachment state, and the bounded authority available to a registered buyer agent. Human and agent principals use Buyer Setup for the same Account capability decisions after binding.
Show child attributes
Show child attributes
Privacy-safe stable reference for the retained provider mapping. It is not a provider or database identifier.
Pattern:
^provider-binding:sha256:[a-f0-9]{64}$Available options:
true