Organizations operations
Manage organizations.
Each operation below is reachable at POST /v1/op/{operation_id} or the resource path POST /v1/{resource}/{action}, with a Bearer token (a gpra_ API key or a session token). Back to the Operations Reference index.
organizations.commitments.list
List the org’s minimum commitments with server-computed burn-down + take-or-pay.
| Scope | orders:read |
| Side-effect | read |
| HTTP | POST /v1/op/organizations.commitments.list · POST /v1/organizations/commitments/list |
| Python / TypeScript | client.organizations.commitments.list(…) |
| CLI | geopera organizations commitments list … |
Request — CommitmentsListInput
| Field | Type | Required | Description |
|---|---|---|---|
commitment_id | string | — | |
include_line_items | boolean | — |
Response — a streaming or binary payload (NDJSON / file / tile). Call the HTTP endpoint directly; the JSON SDK return does not apply.
organizations.commitments.statement
Monthly enterprise statement: all activity (commitment lines flagged) + burn-down + settlement reconciliation.
| Scope | billing:read |
| Side-effect | read |
| HTTP | POST /v1/op/organizations.commitments.statement · POST /v1/organizations/commitments/statement |
| Python / TypeScript | client.organizations.commitments.statement(…) |
| CLI | geopera organizations commitments statement … |
Request — StatementInput
| Field | Type | Required | Description |
|---|---|---|---|
organization_id | string | yes | |
period | string | — |
Response — a streaming or binary payload (NDJSON / file / tile). Call the HTTP endpoint directly; the JSON SDK return does not apply.
organizations.create
Create an organization and enroll the caller as its owner (self-serve onboarding).
| Scope | organizations:write |
| Side-effect | compute |
| HTTP | POST /v1/op/organizations.create · POST /v1/organizations/create |
| Python / TypeScript | client.organizations.create(…) |
| CLI | geopera organizations create … |
Request — OrganizationCreateInput
| Field | Type | Required | Description |
|---|---|---|---|
name | string | yes | |
description | string | — | |
website | string | — | |
industry | string | — | |
size | string | — | |
country | string | — | |
abn | string | — | |
tax_number | string | — | |
billing_email | string | — | |
billing_admin_id | string | — | |
billing_address | object | — | |
enterprise_billing | boolean | — |
Response — OrganizationCreateOutput.