API ReferenceAdmin Seat Preview
Seat Preview
POST
/v1/admin/seat-previewAuthorization
HTTPBearer AuthorizationBearer <token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
A/C — set the full prospective group selection on one app. A set smaller
than what is saved is a detach (negative billable_delta + revokes_access_for).
A management body like every other (D9): the request is a discriminated
UNION, which the hygiene meta-test could not see until it unwrapped generic
body annotations (second-round review, F2) — these two members were the
last management bodies on plain BaseModel.
Response Body
application/json
application/json
curl -X POST "https://example.com/v1/admin/seat-preview" \ -H "Content-Type: application/json" \ -d '{ "change": "app_groups", "app_type": "oidc", "app_id": "string" }'{ "billing_model": "string", "workforce_attached": true, "tenant_seats_now": 0, "tenant_seats_projected": 0, "new_subjects": 0, "already_seats": 0, "revokes_access_for": 0, "group_member_count": 0, "raises_billable_peak": true, "already_seat_ids": [ "string" ], "account_seats_now": 0, "account_seats_projected": 0, "seat_minimum": 0, "billable_delta": 0, "unit_amount_cents": 0, "currency": "string", "delta_amount_cents": 0, "recorded_peak_this_cycle": 0, "next_invoice_at": "2019-08-24T14:15:22Z", "subscription_status": "string", "trial_end": "2019-08-24T14:15:22Z"}{ "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string", "input": null, "ctx": {} } ]}