curl --request GET \
--url https://api.interchange.io/api/v2/buyer/activation \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.interchange.io/api/v2/buyer/activation"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.interchange.io/api/v2/buyer/activation', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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
}
}{
"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": {}
}
}Get buyer agent activation
Return the stable activation lineage and bounded authority for the authenticated WorkOS Agent Registration workload.
curl --request GET \
--url https://api.interchange.io/api/v2/buyer/activation \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.interchange.io/api/v2/buyer/activation"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.interchange.io/api/v2/buyer/activation', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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
}
}{
"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
Response
Get buyer agent activation
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.
1.3 Stable activation lineage retained across retries and identity claim.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Stable Interchange workload identifier for this registration.
^agent-registration:\d+$Agent Registration attachment state only. customer_bound does not imply identity proof, Terms acceptance, payment authority, or live eligibility; read Buyer Setup for operation-specific capabilities.
unbound_free, bound_free, customer_bound Expiry of the unbound sandbox registration. Null after customer binding.
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Show child attributes
Show child attributes
Deprecated schema 1.2 compatibility projection for customer-bound clients. It is never an authorization source; use Buyer Setup capabilities. Null for free workloads and whenever the claimed customer authority is absent.
Show child attributes
Show child attributes
Show child attributes
Show child attributes