A valid request URL is required to generate request examples{
"environment": "live",
"offers": [
{
"kind": "downgrade",
"enabled": true,
"headline": "<string>",
"target_price_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pause_months": 123,
"coupon_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"kinds": [
"downgrade"
]
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}List the save offers
Requires billing:read. What this environment is willing to offer somebody on their way out.
Disabled offers come back too: an offer that vanished when it was switched off would be one the tenant has to retype to switch back on. The customer-facing flow filters — it also withholds any offer the connected gateway cannot actually perform, which is a fact about the adapter rather than about these rows and so is never stored here.
Configuration is per environment, like the rest of the catalogue: trying a discount in test before it reaches a live customer is the point of having two.
A valid request URL is required to generate request examples{
"environment": "live",
"offers": [
{
"kind": "downgrade",
"enabled": true,
"headline": "<string>",
"target_price_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pause_months": 123,
"coupon_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"kinds": [
"downgrade"
]
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Autorizações
A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange. Only a 401 means it is spent; not_a_member (403) is about the organization named in X-Organization-Id and leaves the token good for the others.
Cabeçalhos
The organization the caller is acting on — the org_… code that appears in the panel URL. It identifies; the membership JOIN is what authorizes, so a forged code reads nothing: the answer is not_a_member (403), which does not mean the session is over. Absent, the session's default organization answers, or — if that membership was revoked while the session was open — any other one the caller still holds.
Parâmetros de consulta
Which environment to act in. A view parameter, valid only on the staff surface — a machine credential never chooses its environment, it is resolved from the key.
live, test