Reference

API Reference

HTTP surface of every Forge Metal service. Operations below are generated from each service's committed OpenAPI 3.1 spec, so what you read here is the same contract the Go handlers serve and the typed TypeScript clients consume.

Sandbox Rental

Sandbox Rental Service v1.0.0. Served at https://rentasandbox.anveio.com.

post/api/v1/billing/checkout

Create Stripe checkout session for credit purchase

Parameters

Idempotency-Keyheaderrequired· string
Stable caller-provided key used to make this mutation retry-safe.

Request Body· required

application/jsonSandboxBillingCheckoutRequest

amount_centsinteger · int64required
Amount in cents
cancel_urlstringrequired
product_idstringrequired
Product context for checkout display and metadata; purchased top-ups are account-scoped
success_urlstringrequired

Responses

200OK
application/jsonBillingURLResponse
- urlstringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

get/api/v1/billing/contracts

List org billing contracts

Responses

200OK
application/jsonBillingContracts
- contractsarray of BillingContractrequired
  cadence_kindstringrequired
  contract_idstringrequired
  ends_atstring · date-time
  entitlement_statestringrequired
  payment_statestringrequired
  pending_change_effective_atstring · date-time
  pending_change_idstring
  pending_change_target_plan_idstring
  pending_change_typestring
  phase_endstring · date-time
  phase_idstringrequired
  phase_startstring · date-time
  plan_idstringrequired
  product_idstringrequired
  starts_atstring · date-timerequired
  statusstringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

post/api/v1/billing/contracts

Create self-serve contract checkout

Parameters

Idempotency-Keyheaderrequired· string
Stable caller-provided key used to make this mutation retry-safe.

Request Body· required

application/jsonSandboxBillingContractRequest

cadenceenum (monthly)
Billing cadence (default monthly)
cancel_urlstringrequired
plan_idstringrequired
Plan to activate
success_urlstringrequired

Responses

200OK
application/jsonBillingURLResponse
- urlstringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

post/api/v1/billing/contracts/{contract_id}/cancel

Schedule contract cancellation

Parameters

Idempotency-Keyheaderrequired· string
Stable caller-provided key used to make this mutation retry-safe.
contract_idpathrequired· string

Responses

200OK
application/jsonBillingCancelContractResponse
- contractBillingContractrequired
  cadence_kindstringrequired
  contract_idstringrequired
  ends_atstring · date-time
  entitlement_statestringrequired
  payment_statestringrequired
  pending_change_effective_atstring · date-time
  pending_change_idstring
  pending_change_target_plan_idstring
  pending_change_typestring
  phase_endstring · date-time
  phase_idstringrequired
  phase_startstring · date-time
  plan_idstringrequired
  product_idstringrequired
  starts_atstring · date-timerequired
  statusstringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

post/api/v1/billing/contracts/{contract_id}/changes

Create invoice-backed contract change

Parameters

Idempotency-Keyheaderrequired· string
Stable caller-provided key used to make this mutation retry-safe.
contract_idpathrequired· string

Request Body· required

application/jsonSandboxBillingContractChangeRequest

cancel_urlstringrequired
success_urlstringrequired
target_plan_idstringrequired
Plan to upgrade into immediately

Responses

200OK
application/jsonBillingURLResponse
- urlstringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

get/api/v1/billing/entitlements

Get org entitlements view

Responses

200OK
application/jsonBillingEntitlementsView
- org_idstringrequired
- productsarray of BillingEntitlementProductSectionrequired
  bucketsarray of BillingEntitlementBucketSectionrequired
  bucket_idstringrequired
  bucket_slotBillingEntitlementSlot
  available_unitsstringrequired
  bucket_displaystringrequired
  bucket_idstringrequired
  coverage_labelstringrequired
  pending_unitsstringrequired
  period_start_unitsstringrequired
  product_displaystringrequired
  product_idstringrequired
  scope_typeenum (account | product | bucket | sku)required
  sku_displaystringrequired
  sku_idstringrequired
  sourcesarray of BillingEntitlementSourceTotalrequired
  available_unitsstringrequired
  inline_expires_atstring · date-time
  labelstringrequired
  pending_unitsstringrequired
  period_start_unitsstringrequired
  plan_idstringrequired
  sourceenum (free_tier | contract | purchase | promo | refund | receivable)required
  spent_unitsstringrequired
  display_namestringrequired
  sku_slotsarray of BillingEntitlementSlotrequired
  available_unitsstringrequired
  bucket_displaystringrequired
  bucket_idstringrequired
  coverage_labelstringrequired
  pending_unitsstringrequired
  period_start_unitsstringrequired
  product_displaystringrequired
  product_idstringrequired
  scope_typeenum (account | product | bucket | sku)required
  sku_displaystringrequired
  sku_idstringrequired
  sourcesarray of BillingEntitlementSourceTotalrequired
  available_unitsstringrequired
  inline_expires_atstring · date-time
  labelstringrequired
  pending_unitsstringrequired
  period_start_unitsstringrequired
  plan_idstringrequired
  sourceenum (free_tier | contract | purchase | promo | refund | receivable)required
  spent_unitsstringrequired
  display_namestringrequired
  product_idstringrequired
  product_slotBillingEntitlementSlot
  available_unitsstringrequired
  bucket_displaystringrequired
  bucket_idstringrequired
  coverage_labelstringrequired
  pending_unitsstringrequired
  period_start_unitsstringrequired
  product_displaystringrequired
  product_idstringrequired
  scope_typeenum (account | product | bucket | sku)required
  sku_displaystringrequired
  sku_idstringrequired
  sourcesarray of BillingEntitlementSourceTotalrequired
  available_unitsstringrequired
  inline_expires_atstring · date-time
  labelstringrequired
  pending_unitsstringrequired
  period_start_unitsstringrequired
  plan_idstringrequired
  sourceenum (free_tier | contract | purchase | promo | refund | receivable)required
  spent_unitsstringrequired
- universalBillingEntitlementSlotrequired
  available_unitsstringrequired
  bucket_displaystringrequired
  bucket_idstringrequired
  coverage_labelstringrequired
  pending_unitsstringrequired
  period_start_unitsstringrequired
  product_displaystringrequired
  product_idstringrequired
  scope_typeenum (account | product | bucket | sku)required
  sku_displaystringrequired
  sku_idstringrequired
  sourcesarray of BillingEntitlementSourceTotalrequired
  available_unitsstringrequired
  inline_expires_atstring · date-time
  labelstringrequired
  pending_unitsstringrequired
  period_start_unitsstringrequired
  plan_idstringrequired
  sourceenum (free_tier | contract | purchase | promo | refund | receivable)required
  spent_unitsstringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

get/api/v1/billing/plans

List contract plans

Responses

200OK
application/jsonBillingPlans
- plansarray of BillingPlanrequired
  activebooleanrequired
  annual_amount_centsstringrequired
  billing_modestringrequired
  currencystringrequired
  display_namestringrequired
  is_defaultbooleanrequired
  monthly_amount_centsstringrequired
  plan_idstringrequired
  product_idstringrequired
  tierstringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

post/api/v1/billing/portal

Create Stripe billing portal session

Parameters

Idempotency-Keyheaderrequired· string
Stable caller-provided key used to make this mutation retry-safe.

Request Body· required

application/jsonSandboxBillingPortalRequest

return_urlstringrequired

Responses

200OK
application/jsonBillingURLResponse
- urlstringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

get/api/v1/billing/statement

Get current billing statement

Parameters

product_idqueryrequired· string
Product to preview

Responses

200OK
application/jsonBillingStatement
- currencystringrequired
- generated_atstring · date-timerequired
- grant_summariesarray of BillingStatementGrantSummaryrequired
  availablestringrequired
  pendingstringrequired
  scope_bucket_idstringrequired
  scope_product_idstringrequired
  scope_typestringrequired
  sourcestringrequired
- line_itemsarray of BillingStatementLineItemrequired
  bucket_display_namestringrequired
  bucket_idstringrequired
  charge_unitsstringrequired
  contract_unitsstringrequired
  free_tier_unitsstringrequired
  plan_idstringrequired
  pricing_phasestringrequired
  product_idstringrequired
  promo_unitsstringrequired
  purchase_unitsstringrequired
  quantitynumber · doublerequired
  quantity_unitstringrequired
  receivable_unitsstringrequired
  refund_unitsstringrequired
  reserved_unitsstringrequired
  sku_display_namestringrequired
  sku_idstringrequired
  unit_ratestringrequired
- org_idstringrequired
- period_endstring · date-timerequired
- period_sourcestringrequired
- period_startstring · date-timerequired
- product_idstringrequired
- totalsBillingStatementTotalsrequired
  charge_unitsstringrequired
  contract_unitsstringrequired
  free_tier_unitsstringrequired
  promo_unitsstringrequired
  purchase_unitsstringrequired
  receivable_unitsstringrequired
  refund_unitsstringrequired
  reserved_unitsstringrequired
  total_due_unitsstringrequired
- unit_labelstringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

post/api/v1/executions

Submit a new execution

Request Body· required

application/jsonSandboxSubmitRequest

idempotency_keystringrequired
kindstringrequired
max_wall_secondsinteger · int64
product_idstring
providerstring
resourcesVMResources
- kernel_imagestring
  Named guest kernel image. Defaults to "default".
- memory_mibinteger · int32required
  Guest RAM in MiB.
- root_disk_gibinteger · int32required
  Root disk quota in GiB; enforced on the per-lease ZFS clone via refquota/refreservation.
- vcpusinteger · int32required
  Number of vCPUs exposed to the guest.
run_commandstring
runner_classstring
Runner class label, for example metal-4vcpu-ubuntu-2404.

Responses

201Created
application/jsonSandboxSubmitExecutionResult
- attempt_idstringrequired
- execution_idstringrequired
- statusstringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

get/api/v1/executions/{execution_id}

Get execution status and latest attempt

Parameters

execution_idpathrequired· string
Execution UUID

Responses

200OK
application/jsonSandboxExecutionRecord
- actor_idstringrequired
- billing_windowsarray of SandboxBillingWindow
  actual_quantityinteger · int64
  attempt_idstringrequired
  billing_window_idstringrequired
  created_atstring · date-timerequired
  pricing_phasestring
  reservation_shapestringrequired
  reserved_quantityinteger · int64required
  settled_atstring · date-time
  statestringrequired
  window_seqinteger · int64required
  window_startstring · date-timerequired
- correlation_idstring
- created_atstring · date-timerequired
- execution_idstringrequired
- external_providerstring
- external_task_idstring
- idempotency_keystring
- kindstringrequired
- latest_attemptSandboxAttemptRecordrequired
  attempt_idstringrequired
  attempt_seqinteger · int64required
  billing_job_idinteger · int64
  completed_atstring · date-time
  created_atstring · date-timerequired
  duration_msinteger · int64
  exec_idstring
  exit_codeinteger · int64
  failure_reasonstring
  lease_idstring
  started_atstring · date-time
  statestringrequired
  stderr_bytesinteger · int64
  stdout_bytesinteger · int64
  trace_idstring
  updated_atstring · date-timerequired
  zfs_writteninteger · int64
- org_idstringrequired
- product_idstringrequired
- providerstring
- run_commandstring
- runner_classstring
- source_kindstring
- source_refstring
- statusstringrequired
- updated_atstring · date-timerequired
- workload_kindstring
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

get/api/v1/executions/{execution_id}/logs

Get latest execution attempt log output

Parameters

execution_idpathrequired· string
Execution UUID

Responses

200OK
application/jsonSandboxExecutionLogs
- attempt_idstringrequired
- execution_idstringrequired
- logsstringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

get/api/v1/github/installations

List GitHub App installations for the current org

Responses

200OK
application/json
array of SandboxGitHubInstallationRecord
- account_loginstringrequired
  account_typestringrequired
  activebooleanrequired
  created_atstring · date-timerequired
  installation_idstringrequired
  GitHub App installation ID encoded as a string for JavaScript-safe transport.
  org_idstringrequired
  updated_atstring · date-timerequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

post/api/v1/github/installations/connect

Start GitHub App installation for the current org

Parameters

Idempotency-Keyheaderrequired· string
Stable caller-provided key used to make this mutation retry-safe.

Responses

201Created
application/jsonSandboxGitHubInstallationConnectResponse
- expires_atstring · date-timerequired
  Time after which the setup URL state is no longer accepted.
- setup_urlstringrequired
  GitHub App installation URL for the current Forge Metal organization.
- statestringrequired
  Opaque installation state token embedded in the GitHub App setup URL.
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

Identity

Identity Service v1.0.0.

get/api/v1/organization

Get organization identity state

Responses

200OK
application/jsonIdentityOrganization
- callerIdentityMemberrequired
  display_namestringrequired
  emailstringrequired
  login_namestringrequired
  role_keysarray of stringrequired
  statestringrequired
  user_idstringrequired
- member_capabilitiesIdentityMemberCapabilitiesDocumentrequired
  enabled_keysarray of stringrequired
  org_idstringrequired
  updated_atstring · date-timerequired
  updated_bystringrequired
  versioninteger · int32required
- namestringrequired
- org_idstringrequired
- permissionsarray of stringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

get/api/v1/organization/api-credentials

List organization API credentials

Responses

200OK
application/jsonIdentityAPICredentials
- credentialsarray of IdentityAPICredentialrequired
  auth_methodstringrequired
  client_idstringrequired
  created_atstring · date-timerequired
  created_bystringrequired
  credential_idstringrequired
  display_namestringrequired
  expires_atstring · date-time
  fingerprintstringrequired
  last_used_atstring · date-time
  org_idstringrequired
  permissionsarray of stringrequired
  policy_version_at_issueinteger · int32required
  revoked_atstring · date-time
  revoked_bystring
  statusstringrequired
  subject_idstringrequired
  updated_atstring · date-timerequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

post/api/v1/organization/api-credentials

Create an API credential

Parameters

Idempotency-Keyheaderrequired· string
Stable caller-provided key used to make this mutation retry-safe.

Request Body· required

application/jsonIdentityCreateAPICredentialRequest

auth_methodenum (private_key_jwt | client_secret)
display_namestringrequired
expires_atstring · date-time
permissionsarray of stringrequired

Responses

201Created
application/jsonIdentityCreateAPICredentialResponse
- credentialIdentityAPICredentialrequired
  auth_methodstringrequired
  client_idstringrequired
  created_atstring · date-timerequired
  created_bystringrequired
  credential_idstringrequired
  display_namestringrequired
  expires_atstring · date-time
  fingerprintstringrequired
  last_used_atstring · date-time
  org_idstringrequired
  permissionsarray of stringrequired
  policy_version_at_issueinteger · int32required
  revoked_atstring · date-time
  revoked_bystring
  statusstringrequired
  subject_idstringrequired
  updated_atstring · date-timerequired
- issued_materialIdentityAPICredentialIssuedMaterialrequired
  auth_methodstringrequired
  client_idstringrequired
  client_secretstring
  fingerprintstringrequired
  key_contentstring
  key_idstring
  token_urlstringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

delete/api/v1/organization/api-credentials/{credential_id}

Revoke an API credential

Parameters

Idempotency-Keyheaderrequired· string
Stable caller-provided key used to make this mutation retry-safe.
credential_idpathrequired· string
Forge Metal API credential ID

Responses

200OK
application/jsonIdentityAPICredential
- auth_methodstringrequired
- client_idstringrequired
- created_atstring · date-timerequired
- created_bystringrequired
- credential_idstringrequired
- display_namestringrequired
- expires_atstring · date-time
- fingerprintstringrequired
- last_used_atstring · date-time
- org_idstringrequired
- permissionsarray of stringrequired
- policy_version_at_issueinteger · int32required
- revoked_atstring · date-time
- revoked_bystring
- statusstringrequired
- subject_idstringrequired
- updated_atstring · date-timerequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

get/api/v1/organization/api-credentials/{credential_id}

Get API credential metadata

Parameters

credential_idpathrequired· string
Forge Metal API credential ID

Responses

200OK
application/jsonIdentityAPICredential
- auth_methodstringrequired
- client_idstringrequired
- created_atstring · date-timerequired
- created_bystringrequired
- credential_idstringrequired
- display_namestringrequired
- expires_atstring · date-time
- fingerprintstringrequired
- last_used_atstring · date-time
- org_idstringrequired
- permissionsarray of stringrequired
- policy_version_at_issueinteger · int32required
- revoked_atstring · date-time
- revoked_bystring
- statusstringrequired
- subject_idstringrequired
- updated_atstring · date-timerequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

post/api/v1/organization/api-credentials/{credential_id}/roll

Roll API credential secret material

Parameters

Idempotency-Keyheaderrequired· string
Stable caller-provided key used to make this mutation retry-safe.
credential_idpathrequired· string
Forge Metal API credential ID

Request Body· required

application/jsonIdentityRollAPICredentialRequest

auth_methodenum (private_key_jwt | client_secret)

Responses

200OK
application/jsonIdentityRollAPICredentialResponse
- credentialIdentityAPICredentialrequired
  auth_methodstringrequired
  client_idstringrequired
  created_atstring · date-timerequired
  created_bystringrequired
  credential_idstringrequired
  display_namestringrequired
  expires_atstring · date-time
  fingerprintstringrequired
  last_used_atstring · date-time
  org_idstringrequired
  permissionsarray of stringrequired
  policy_version_at_issueinteger · int32required
  revoked_atstring · date-time
  revoked_bystring
  statusstringrequired
  subject_idstringrequired
  updated_atstring · date-timerequired
- issued_materialIdentityAPICredentialIssuedMaterialrequired
  auth_methodstringrequired
  client_idstringrequired
  client_secretstring
  fingerprintstringrequired
  key_contentstring
  key_idstring
  token_urlstringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

get/api/v1/organization/member-capabilities

Get organization member capabilities and the static capability catalog

Responses

200OK
application/jsonIdentityMemberCapabilities
- catalogarray of IdentityMemberCapabilityrequired
  default_enabledbooleanrequired
  descriptionstringrequired
  keystringrequired
  labelstringrequired
  permissionsarray of stringrequired
- documentIdentityMemberCapabilitiesDocumentrequired
  enabled_keysarray of stringrequired
  org_idstringrequired
  updated_atstring · date-timerequired
  updated_bystringrequired
  versioninteger · int32required
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

put/api/v1/organization/member-capabilities

Replace the organization's enabled member capability set

Parameters

Idempotency-Keyheaderrequired· string
Stable caller-provided key used to make this mutation retry-safe.

Request Body· required

application/jsonIdentityPutMemberCapabilitiesRequest

enabled_keysarray of stringrequired
versioninteger · int32required

Responses

200OK
application/jsonIdentityMemberCapabilities
- catalogarray of IdentityMemberCapabilityrequired
  default_enabledbooleanrequired
  descriptionstringrequired
  keystringrequired
  labelstringrequired
  permissionsarray of stringrequired
- documentIdentityMemberCapabilitiesDocumentrequired
  enabled_keysarray of stringrequired
  org_idstringrequired
  updated_atstring · date-timerequired
  updated_bystringrequired
  versioninteger · int32required
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

get/api/v1/organization/members

List organization members

Responses

200OK
application/jsonIdentityMembers
- membersarray of IdentityMemberrequired
  display_namestringrequired
  emailstringrequired
  login_namestringrequired
  role_keysarray of stringrequired
  statestringrequired
  user_idstringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

post/api/v1/organization/members

Invite an organization member

Parameters

Idempotency-Keyheaderrequired· string
Stable caller-provided key used to make this mutation retry-safe.

Request Body· required

application/jsonIdentityInviteMemberRequest

emailstringrequired
family_namestring
given_namestring
role_keysarray of stringrequired

Responses

201Created
application/jsonIdentityInviteMemberResponse
- emailstringrequired
- role_keysarray of stringrequired
- statusstringrequired
- user_idstringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

put/api/v1/organization/members/{user_id}/roles

Update organization member roles

Parameters

Idempotency-Keyheaderrequired· string
Stable caller-provided key used to make this mutation retry-safe.
user_idpathrequired· string
Zitadel user ID

Request Body· required

application/jsonIdentityUpdateMemberRolesRequest

role_keysarray of stringrequired

Responses

200OK
application/jsonIdentityMember
- display_namestringrequired
- emailstringrequired
- login_namestringrequired
- role_keysarray of stringrequired
- statestringrequired
- user_idstringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

Mailbox

Mailbox Service vdev. Served at https://mail.anveio.com.

get/api/v1/mail/account

Get the authenticated user's bound mailbox account

Responses

200OK
application/jsonMailboxAccount
- account_idstringrequired
- default_mailbox_idstring
- display_namestringrequired
- email_addressstringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

get/api/v1/mail/emails/{email_id}/body

Fetch and cache an email body

Parameters

email_idpathrequired· string

Responses

200OK
application/jsonMailboxBody
- account_idstringrequired
- email_idstringrequired
- fetched_atstringrequired
- html_bodystringrequired
- text_bodystringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

post/api/v1/mail/emails/{email_id}/flag

Flag an email

Parameters

email_idpathrequired· string

Responses

200OK
application/jsonMailboxMutation
- email_idstringrequired
- statusstringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

post/api/v1/mail/emails/{email_id}/move

Move an email to another mailbox

Parameters

email_idpathrequired· string

Request Body· required

application/jsonMailboxMoveRequest

mailbox_idstringrequired

Responses

200OK
application/jsonMailboxMutation
- email_idstringrequired
- statusstringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

post/api/v1/mail/emails/{email_id}/read

Mark an email as read

Parameters

email_idpathrequired· string

Responses

200OK
application/jsonMailboxMutation
- email_idstringrequired
- statusstringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

post/api/v1/mail/emails/{email_id}/trash

Move an email to trash

Parameters

email_idpathrequired· string

Responses

200OK
application/jsonMailboxMutation
- email_idstringrequired
- statusstringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

post/api/v1/mail/emails/{email_id}/unflag

Unflag an email

Parameters

email_idpathrequired· string

Responses

200OK
application/jsonMailboxMutation
- email_idstringrequired
- statusstringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

post/api/v1/mail/emails/{email_id}/unread

Mark an email as unread

Parameters

email_idpathrequired· string

Responses

200OK
application/jsonMailboxMutation
- email_idstringrequired
- statusstringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

get/api/v1/mail/sync/status

Mailbox sync status

Responses

200OK
application/jsonMailboxServiceStatusResponse
- statusMailboxServiceStatusrequired
  forwarderMailboxForwarderrequired
  enabledbooleanrequired
  forward_target_configuredbooleanrequired
  last_errorstring
  last_forwarded_atstring · date-time
  last_forwarded_email_idstring
  last_sync_atstring · date-time
  mailboxstringrequired
  runningbooleanrequired
  mailbox_syncMailboxSyncrequired
  accountsobjectrequired
  last_discovery_atstring · date-time
  last_errorstring
  runningbooleanrequired
  public_base_urlstringrequired
  stalwart_base_urlstringrequired
  started_atstring · date-timerequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

get/internal/mailbox/v1/accounts

List synced mailbox accounts for operator tooling

Responses

200OK
application/jsonMailboxOperatorAccounts
- accountsarray of MailboxOperatorAccountrequired
  account_idstringrequired
  display_namestringrequired
  email_addressstringrequired
  jmap_account_idstringrequired
  principal_typestringrequired
  synced_atstringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

get/internal/mailbox/v1/accounts/{account_id}/emails

List synced emails for an account

Parameters

account_idpathrequired· string
limitquery· integer · int64
mailbox_idquery· string

Responses

200OK
application/jsonMailboxOperatorEmails
- emailsarray of MailboxOperatorEmailrequired
  account_idstringrequired
  ccarray of MailboxOperatorAddressrequired
  emailstringrequired
  namestringrequired
  email_idstringrequired
  from_emailstringrequired
  from_namestringrequired
  has_attachmentbooleanrequired
  is_answeredbooleanrequired
  is_draftbooleanrequired
  is_flaggedbooleanrequired
  is_seenbooleanrequired
  keywordsobjectrequired
  mailbox_idsarray of stringrequired
  previewstringrequired
  received_atstringrequired
  reply_toarray of MailboxOperatorAddressrequired
  emailstringrequired
  namestringrequired
  sent_atstringrequired
  sizeinteger · int64required
  subjectstringrequired
  synced_atstringrequired
  thread_idstringrequired
  toarray of MailboxOperatorAddressrequired
  emailstringrequired
  namestringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

get/internal/mailbox/v1/accounts/{account_id}/emails/{email_id}

Read an email body for an account

Parameters

account_idpathrequired· string
email_idpathrequired· string

Responses

200OK
application/jsonMailboxOperatorEmailDetail
- account_idstringrequired
- ccarray of MailboxOperatorAddressrequired
  emailstringrequired
  namestringrequired
- email_idstringrequired
- fetched_atstringrequired
- from_emailstringrequired
- from_namestringrequired
- has_attachmentbooleanrequired
- html_bodystringrequired
- is_answeredbooleanrequired
- is_draftbooleanrequired
- is_flaggedbooleanrequired
- is_seenbooleanrequired
- keywordsobjectrequired
- mailbox_idsarray of stringrequired
- previewstringrequired
- received_atstringrequired
- reply_toarray of MailboxOperatorAddressrequired
  emailstringrequired
  namestringrequired
- sent_atstringrequired
- sizeinteger · int64required
- subjectstringrequired
- synced_atstringrequired
- text_bodystringrequired
- thread_idstringrequired
- toarray of MailboxOperatorAddressrequired
  emailstringrequired
  namestringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

get/internal/mailbox/v1/accounts/{account_id}/mailboxes

List synced mailboxes for an account

Parameters

account_idpathrequired· string

Responses

200OK
application/jsonMailboxOperatorMailboxes
- mailboxesarray of MailboxOperatorMailboxrequired
  account_idstringrequired
  idstringrequired
  namestringrequired
  parent_idstringrequired
  rolestringrequired
  sort_orderinteger · int64required
  synced_atstringrequired
  total_emailsinteger · int64required
  total_threadsinteger · int64required
  unread_emailsinteger · int64required
  unread_threadsinteger · int64required
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

Billing

Billing Service v2.0.0. Internal control-plane API; reached from other Forge Metal services, not directly by customers.

post/internal/billing/v1/activate

Activate billing window

Request Body· required

application/jsonBillingActivateWindowRequest

activated_atstring · date-timerequired
window_idstringrequired

Responses

200OK
application/jsonBillingActivateWindowResult
- reservationBillingWindowReservationrequired
  activated_atstring · date-time
  actor_idstringrequired
  allocationobjectrequired
  cost_per_unitstringrequired
  expires_atstring · date-timerequired
  org_idstringrequired
  plan_idstringrequired
  pricing_phasestringrequired
  product_idstringrequired
  renew_bystring · date-time
  reservation_shapestringrequired
  reserved_charge_unitsstringrequired
  reserved_quantityinteger · int32required
  sku_ratesobjectrequired
  source_refstringrequired
  source_typestringrequired
  window_idstringrequired
  window_seqinteger · int32required
  window_startstring · date-timerequired
404Not Found
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.
422Unprocessable Entity
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.
500Internal Server Error
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

post/internal/billing/v1/checkout

Create credit checkout

Request Body· required

application/jsonBillingCreateCheckoutRequest

amount_centsinteger · int64required
cancel_urlstringrequired
org_idstringrequired
product_idstringrequired
success_urlstringrequired

Responses

200OK
application/jsonBillingURLResponse
- urlstringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

post/internal/billing/v1/contracts

Create contract checkout

Request Body· required

application/jsonBillingCreateContractRequest

cadenceenum (monthly)
cancel_urlstringrequired
org_idstringrequired
plan_idstringrequired
success_urlstringrequired

Responses

200OK
application/jsonBillingURLResponse
- urlstringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

post/internal/billing/v1/contracts/{contract_id}/cancel

Cancel contract

Parameters

contract_idpathrequired· string

Request Body· required

application/jsonBillingCancelContractRequest

org_idstringrequired

Responses

200OK
application/jsonBillingCancelContractResponse
- contractBillingContractrequired
  cadence_kindstringrequired
  contract_idstringrequired
  ends_atstring · date-time
  entitlement_statestringrequired
  payment_statestringrequired
  pending_change_effective_atstring · date-time
  pending_change_idstring
  pending_change_target_plan_idstring
  pending_change_typestring
  phase_endstring · date-time
  phase_idstringrequired
  phase_startstring · date-time
  plan_idstringrequired
  product_idstringrequired
  starts_atstring · date-timerequired
  statusstringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

post/internal/billing/v1/contracts/{contract_id}/changes

Create contract change

Parameters

contract_idpathrequired· string

Request Body· required

application/jsonBillingCreateContractChangeRequest

cancel_urlstringrequired
org_idstringrequired
success_urlstringrequired
target_plan_idstringrequired

Responses

200OK
application/jsonBillingContractChangeResponse
- change_idstringrequired
- document_idstring
- finalization_idstring
- price_delta_unitsstringrequired
- statusstringrequired
- urlstringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

get/internal/billing/v1/orgs/{org_id}/contracts

List org contracts

Parameters

org_idpathrequired· string

Responses

200OK
application/jsonBillingContracts
- contractsarray of BillingContractrequired
  cadence_kindstringrequired
  contract_idstringrequired
  ends_atstring · date-time
  entitlement_statestringrequired
  payment_statestringrequired
  pending_change_effective_atstring · date-time
  pending_change_idstring
  pending_change_target_plan_idstring
  pending_change_typestring
  phase_endstring · date-time
  phase_idstringrequired
  phase_startstring · date-time
  plan_idstringrequired
  product_idstringrequired
  starts_atstring · date-timerequired
  statusstringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

get/internal/billing/v1/orgs/{org_id}/documents

List issued billing documents

Parameters

org_idpathrequired· string
product_idquery· string

Responses

200OK
application/jsonBillingDocuments
- documentsarray of BillingDocumentrequired
  adjustment_unitsstringrequired
  currencystringrequired
  cycle_idstringrequired
  document_idstringrequired
  document_kindenum (invoice | statement | internal_statement | credit_note | adjustment_invoice)required
  document_numberstringrequired
  finalization_idstringrequired
  issued_atstring · date-time
  payment_statusstringrequired
  period_endstring · date-timerequired
  period_startstring · date-timerequired
  product_idstringrequired
  statusstringrequired
  stripe_hosted_invoice_urlstring
  stripe_invoice_pdf_urlstring
  stripe_payment_intent_idstring
  subtotal_unitsstringrequired
  tax_unitsstringrequired
  total_due_unitsstringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

get/internal/billing/v1/orgs/{org_id}/entitlements

Get org entitlements view

Parameters

org_idpathrequired· string

Responses

200OK
application/jsonBillingEntitlementsView
- org_idstringrequired
- productsarray of BillingEntitlementProductSectionrequired
  bucketsarray of BillingEntitlementBucketSectionrequired
  bucket_idstringrequired
  bucket_slotBillingEntitlementSlot
  available_unitsstringrequired
  bucket_displaystringrequired
  bucket_idstringrequired
  coverage_labelstringrequired
  pending_unitsstringrequired
  period_start_unitsstringrequired
  product_displaystringrequired
  product_idstringrequired
  scope_typeenum (account | product | bucket | sku)required
  sku_displaystringrequired
  sku_idstringrequired
  sourcesarray of BillingEntitlementSourceTotalrequired
  available_unitsstringrequired
  inline_expires_atstring · date-time
  labelstringrequired
  pending_unitsstringrequired
  period_start_unitsstringrequired
  plan_idstringrequired
  sourceenum (free_tier | contract | purchase | promo | refund | receivable)required
  spent_unitsstringrequired
  display_namestringrequired
  sku_slotsarray of BillingEntitlementSlotrequired
  available_unitsstringrequired
  bucket_displaystringrequired
  bucket_idstringrequired
  coverage_labelstringrequired
  pending_unitsstringrequired
  period_start_unitsstringrequired
  product_displaystringrequired
  product_idstringrequired
  scope_typeenum (account | product | bucket | sku)required
  sku_displaystringrequired
  sku_idstringrequired
  sourcesarray of BillingEntitlementSourceTotalrequired
  available_unitsstringrequired
  inline_expires_atstring · date-time
  labelstringrequired
  pending_unitsstringrequired
  period_start_unitsstringrequired
  plan_idstringrequired
  sourceenum (free_tier | contract | purchase | promo | refund | receivable)required
  spent_unitsstringrequired
  display_namestringrequired
  product_idstringrequired
  product_slotBillingEntitlementSlot
  available_unitsstringrequired
  bucket_displaystringrequired
  bucket_idstringrequired
  coverage_labelstringrequired
  pending_unitsstringrequired
  period_start_unitsstringrequired
  product_displaystringrequired
  product_idstringrequired
  scope_typeenum (account | product | bucket | sku)required
  sku_displaystringrequired
  sku_idstringrequired
  sourcesarray of BillingEntitlementSourceTotalrequired
  available_unitsstringrequired
  inline_expires_atstring · date-time
  labelstringrequired
  pending_unitsstringrequired
  period_start_unitsstringrequired
  plan_idstringrequired
  sourceenum (free_tier | contract | purchase | promo | refund | receivable)required
  spent_unitsstringrequired
- universalBillingEntitlementSlotrequired
  available_unitsstringrequired
  bucket_displaystringrequired
  bucket_idstringrequired
  coverage_labelstringrequired
  pending_unitsstringrequired
  period_start_unitsstringrequired
  product_displaystringrequired
  product_idstringrequired
  scope_typeenum (account | product | bucket | sku)required
  sku_displaystringrequired
  sku_idstringrequired
  sourcesarray of BillingEntitlementSourceTotalrequired
  available_unitsstringrequired
  inline_expires_atstring · date-time
  labelstringrequired
  pending_unitsstringrequired
  period_start_unitsstringrequired
  plan_idstringrequired
  sourceenum (free_tier | contract | purchase | promo | refund | receivable)required
  spent_unitsstringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

get/internal/billing/v1/orgs/{org_id}/grants

List org credit grants

Parameters

org_idpathrequired· string
product_idquery· string
activequery· boolean

Responses

200OK
application/jsonBillingGrants
- grantsarray of BillingGrantrequired
  availablestringrequired
  entitlement_period_idstringrequired
  expires_atstring · date-time
  grant_idstringrequired
  pendingstringrequired
  period_endstring · date-time
  period_startstring · date-time
  policy_versionstringrequired
  scope_bucket_idstringrequired
  scope_product_idstringrequired
  scope_sku_idstringrequired
  scope_typestringrequired
  sourcestringrequired
  source_reference_idstringrequired
  starts_atstring · date-timerequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

get/internal/billing/v1/orgs/{org_id}/statement

Preview current statement

Parameters

org_idpathrequired· string
product_idqueryrequired· string

Responses

200OK
application/jsonBillingStatement
- currencystringrequired
- generated_atstring · date-timerequired
- grant_summariesarray of BillingStatementGrantSummaryrequired
  availablestringrequired
  pendingstringrequired
  scope_bucket_idstringrequired
  scope_product_idstringrequired
  scope_typestringrequired
  sourcestringrequired
- line_itemsarray of BillingStatementLineItemrequired
  bucket_display_namestringrequired
  bucket_idstringrequired
  charge_unitsstringrequired
  contract_unitsstringrequired
  free_tier_unitsstringrequired
  plan_idstringrequired
  pricing_phasestringrequired
  product_idstringrequired
  promo_unitsstringrequired
  purchase_unitsstringrequired
  quantitynumber · doublerequired
  quantity_unitstringrequired
  receivable_unitsstringrequired
  refund_unitsstringrequired
  reserved_unitsstringrequired
  sku_display_namestringrequired
  sku_idstringrequired
  unit_ratestringrequired
- org_idstringrequired
- period_endstring · date-timerequired
- period_sourcestringrequired
- period_startstring · date-timerequired
- product_idstringrequired
- totalsBillingStatementTotalsrequired
  charge_unitsstringrequired
  contract_unitsstringrequired
  free_tier_unitsstringrequired
  promo_unitsstringrequired
  purchase_unitsstringrequired
  receivable_unitsstringrequired
  refund_unitsstringrequired
  reserved_unitsstringrequired
  total_due_unitsstringrequired
- unit_labelstringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

post/internal/billing/v1/portal

Create Stripe portal session

Request Body· required

application/jsonBillingCreatePortalSessionRequest

org_idstringrequired
return_urlstringrequired

Responses

200OK
application/jsonBillingURLResponse
- urlstringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

get/internal/billing/v1/products/{product_id}/plans

List active plans

Parameters

product_idpathrequired· string

Responses

200OK
application/jsonBillingPlans
- plansarray of BillingPlanrequired
  activebooleanrequired
  annual_amount_centsstringrequired
  billing_modestringrequired
  currencystringrequired
  display_namestringrequired
  is_defaultbooleanrequired
  monthly_amount_centsstringrequired
  plan_idstringrequired
  product_idstringrequired
  tierstringrequired
defaultError
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

post/internal/billing/v1/reserve

Reserve billing window

Request Body· required

application/jsonBillingReserveWindowRequest

actor_idstringrequired
allocationobjectrequired
billing_job_idinteger · int64
concurrent_countinteger · int64required
org_idstringrequired
product_idstringrequired
source_refstringrequired
source_typestringrequired
window_seqinteger · int32required

Responses

200OK
application/jsonBillingReserveWindowResult
- reservationBillingWindowReservationrequired
  activated_atstring · date-time
  actor_idstringrequired
  allocationobjectrequired
  cost_per_unitstringrequired
  expires_atstring · date-timerequired
  org_idstringrequired
  plan_idstringrequired
  pricing_phasestringrequired
  product_idstringrequired
  renew_bystring · date-time
  reservation_shapestringrequired
  reserved_charge_unitsstringrequired
  reserved_quantityinteger · int32required
  sku_ratesobjectrequired
  source_refstringrequired
  source_typestringrequired
  window_idstringrequired
  window_seqinteger · int32required
  window_startstring · date-timerequired
402Payment Required
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.
403Forbidden
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.
422Unprocessable Entity
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.
500Internal Server Error
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

post/internal/billing/v1/settle

Settle billing window

Request Body· required

application/jsonBillingSettleWindowRequest

actual_quantityinteger · int32required
usage_summaryobject
window_idstringrequired

Responses

200OK
application/jsonBillingSettleResult
- actual_quantityinteger · int32required
- billable_quantityinteger · int32required
- billed_charge_unitsstringrequired
- settled_atstring · date-timerequired
- window_idstringrequired
- writeoff_charge_unitsstringrequired
- writeoff_quantityinteger · int32required
404Not Found
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.
422Unprocessable Entity
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.
500Internal Server Error
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

post/internal/billing/v1/void

Void billing window

Request Body· required

application/jsonBillingVoidWindowRequest

window_idstringrequired

Responses

200OK
application/jsonBillingVoidWindowResult
- window_idstringrequired
404Not Found
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.
422Unprocessable Entity
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.
500Internal Server Error
application/problem+jsonErrorModel
- detailstring
  A human-readable explanation specific to this occurrence of the problem.
- errorsarray of ErrorDetail
  Optional list of individual error details
  locationstring
  Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
  messagestring
  Error message text
  valueany
  The value at the given location
- instancestring · uri
  A URI reference that identifies the specific occurrence of the problem.
- statusinteger · int64
  HTTP status code
- titlestring
  A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
- typestring · uri
  A URI reference to human-readable documentation for the error.

Schemas

Shared object shapes referenced by operations above. Grouped by service so identically-named types across services don't collide.