docs.jsonld
type: ApiDocumentation
title: Buildrush API
entrypoint: /api
supported class: Error
supported class: ConstraintViolation
supported class: ManagementBillingAccount
supported class: ManagementChargeback
supported class: ManagementDunningQueue
supported class: ManagementImpersonation
supported class: ManagementInstallation
supported class: ManagementInvoice
supported class: ManagementMe
supported class: ManagementRefundTriage
supported class: ManagementUser
supported class: ManagementWebhookPayload
supported class: Assignments
supported class: GitHub
supported class: Installations
supported class: Billing
supported class: BuildRushAccount
supported class: CacheDashboardToken
supported class: EmailVerification
supported class: GitHubWebhook
supported class: Health
supported class: Internal
supported class: Notifications
supported class: NotificationStatuses
supported class: RunnerDashboardToken
supported class: UsageRunner
supported class: Entrypoint
supported class: ConstraintViolationList

Error
type: Class
title: Error
supported property: SupportedProperty
  property: Error/id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Error/title
  title: title
  required: false
  readable: true
  writeable: false
  description: A short, human-readable summary of the problem.
supported property: SupportedProperty
  property: Error/detail
  title: detail
  required: false
  readable: true
  writeable: false
  description: A human-readable explanation specific to this occurrence of the problem.
supported property: SupportedProperty
  property: Error/instance
  title: instance
  required: false
  readable: true
  writeable: false
  description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
supported property: SupportedProperty
  property: Error/type
  title: type
  required: false
  readable: true
  writeable: false
  description: A URI reference that identifies the problem type
supported property: SupportedProperty
  property: Error/meta
  title: meta
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Error/source
  title: source
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Error/description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/trace
  title: trace
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/message
  title: message
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/code
  title: code
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/file
  title: file
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/line
  title: line
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/trace
  title: trace
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Error resource.
  method: GET
  returns: Error
  title: getError
description: A representation of common errors.
sub class of: Error

Error/id
type: Property
domain: Error
the hydra core vocabulary: id
range: string

Error/title
type: Property
domain: Error
the hydra core vocabulary: title
range: string

Error/detail
type: Property
domain: Error
the hydra core vocabulary: detail
range: string

Error/instance
type: Property
domain: Error
the hydra core vocabulary: instance
range: string

Error/type
type: Property
domain: Error
the hydra core vocabulary: type
range: string

Error/meta
type: Property
domain: Error
the hydra core vocabulary: meta

Error/source
type: Property
domain: Error
the hydra core vocabulary: source

Error/description
type: Property
domain: Error
the hydra core vocabulary: description
range: string

Error/trace
type: Property
domain: Error
the hydra core vocabulary: trace

Error/message
type: Property
domain: Error
the hydra core vocabulary: message
range: string

Error/code
type: Property
domain: Error
the hydra core vocabulary: code
range: integer

Error/file
type: Property
domain: Error
the hydra core vocabulary: file
range: string

Error/line
type: Property
domain: Error
the hydra core vocabulary: line
range: integer

ConstraintViolation
type: Class
title: ConstraintViolation
supported property: SupportedProperty
  property: ConstraintViolation/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/errorTitle
  title: errorTitle
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/violations
  title: violations
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/detail
  title: detail
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/message
  title: message
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/code
  title: code
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/file
  title: file
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/line
  title: line
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/type
  title: type
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/title
  title: title
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/instance
  title: instance
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/statusCode
  title: statusCode
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/headers
  title: headers
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/trace
  title: trace
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/previous
  title: previous
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
description: Unprocessable entity
sub class of: Error

ConstraintViolation/status
type: Property
domain: ConstraintViolation
the hydra core vocabulary: status
range: integer

ConstraintViolation/errorTitle
type: Property
domain: ConstraintViolation
the hydra core vocabulary: errorTitle
range: string

ConstraintViolation/violations
type: Property
domain: ConstraintViolation
the hydra core vocabulary: violations
range: ConstraintViolationList

ConstraintViolation/detail
type: Property
domain: ConstraintViolation
the hydra core vocabulary: detail
range: string

ConstraintViolation/message
type: Property
domain: ConstraintViolation
the hydra core vocabulary: message
range: string

ConstraintViolation/code
type: Property
domain: ConstraintViolation
the hydra core vocabulary: code
range: string
range: integer

ConstraintViolation/file
type: Property
domain: ConstraintViolation
the hydra core vocabulary: file
range: string

ConstraintViolation/line
type: Property
domain: ConstraintViolation
the hydra core vocabulary: line
range: integer

ConstraintViolation/description
type: Property
domain: ConstraintViolation
the hydra core vocabulary: description
range: string

ConstraintViolation/type
type: Property
domain: ConstraintViolation
the hydra core vocabulary: type
range: string

ConstraintViolation/title
type: Property
domain: ConstraintViolation
the hydra core vocabulary: title
range: string

ConstraintViolation/instance
type: Property
domain: ConstraintViolation
the hydra core vocabulary: instance
range: string

ConstraintViolation/statusCode
type: Property
domain: ConstraintViolation
the hydra core vocabulary: statusCode
range: integer

ConstraintViolation/headers
type: Property
domain: ConstraintViolation
the hydra core vocabulary: headers

ConstraintViolation/trace
type: Property
domain: ConstraintViolation
the hydra core vocabulary: trace

ConstraintViolation/previous
type: Property
domain: ConstraintViolation
the hydra core vocabulary: previous
range: integer

ManagementBillingAccount
type: Class
title: ManagementBillingAccount
supported property: SupportedProperty
  property: ManagementBillingAccount/id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementBillingAccount/state
  title: state
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementBillingAccount/paymentProviderType
  title: paymentProviderType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementBillingAccount/invoiceDocumentProviderType
  title: invoiceDocumentProviderType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementBillingAccount/taxProviderType
  title: taxProviderType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementBillingAccount/paymentProviderCustomerId
  title: paymentProviderCustomerId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementBillingAccount/paymentProviderMandateId
  title: paymentProviderMandateId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementBillingAccount/hasBillingInformation
  title: hasBillingInformation
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementBillingAccount/customerType
  title: customerType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementBillingAccount/installation
  title: installation
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementBillingAccount/planName
  title: planName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementBillingAccount/subscriptionState
  title: subscriptionState
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementBillingAccount/pendingPlanName
  title: pendingPlanName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementBillingAccount/healthStatus
  title: healthStatus
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementBillingAccount/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementBillingAccount/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a ManagementBillingAccount resource.
  method: GET
  returns: ManagementBillingAccount
  title: getManagementBillingAccount
supported operation: Operation
  type: FindAction
  description: Retrieves a ManagementBillingAccount resource.
  method: GET
  returns: ManagementBillingAccount
  title: getManagementBillingAccount
supported operation: Operation
  type: FindAction
  description: Retrieves a ManagementBillingAccount resource.
  method: GET
  returns: ManagementBillingAccount
  title: getManagementBillingAccount
supported operation: Operation
  description: Updates the ManagementBillingAccount resource.
  expects: ManagementBillingAccount
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: ManagementBillingAccount
  title: patchManagementBillingAccount
description: Platform admin billing account management

ManagementBillingAccount/id
type: Property
domain: ManagementBillingAccount
the hydra core vocabulary: id
range: string

ManagementBillingAccount/state
type: Property
domain: ManagementBillingAccount
the hydra core vocabulary: state
range: string

ManagementBillingAccount/paymentProviderType
type: Property
domain: ManagementBillingAccount
the hydra core vocabulary: paymentProviderType
range: string

ManagementBillingAccount/invoiceDocumentProviderType
type: Property
domain: ManagementBillingAccount
the hydra core vocabulary: invoiceDocumentProviderType
range: string

ManagementBillingAccount/taxProviderType
type: Property
domain: ManagementBillingAccount
the hydra core vocabulary: taxProviderType
range: string

ManagementBillingAccount/paymentProviderCustomerId
type: Property
domain: ManagementBillingAccount
the hydra core vocabulary: paymentProviderCustomerId
range: string

ManagementBillingAccount/paymentProviderMandateId
type: Property
domain: ManagementBillingAccount
the hydra core vocabulary: paymentProviderMandateId
range: string

ManagementBillingAccount/hasBillingInformation
type: Property
domain: ManagementBillingAccount
the hydra core vocabulary: hasBillingInformation
range: boolean

ManagementBillingAccount/customerType
type: Property
domain: ManagementBillingAccount
the hydra core vocabulary: customerType
range: string

ManagementBillingAccount/installation
type: Property
domain: ManagementBillingAccount
the hydra core vocabulary: installation
range: string
range: integer

ManagementBillingAccount/planName
type: Property
domain: ManagementBillingAccount
the hydra core vocabulary: planName
range: string

ManagementBillingAccount/subscriptionState
type: Property
domain: ManagementBillingAccount
the hydra core vocabulary: subscriptionState
range: string

ManagementBillingAccount/pendingPlanName
type: Property
domain: ManagementBillingAccount
the hydra core vocabulary: pendingPlanName
range: string

ManagementBillingAccount/healthStatus
type: Property
domain: ManagementBillingAccount
the hydra core vocabulary: healthStatus
range: string

ManagementBillingAccount/createdAt
type: Property
domain: ManagementBillingAccount
the hydra core vocabulary: createdAt
range: string

ManagementBillingAccount/updatedAt
type: Property
domain: ManagementBillingAccount
the hydra core vocabulary: updatedAt
range: string

ManagementChargeback
type: Class
title: ManagementChargeback
supported property: SupportedProperty
  property: ManagementChargeback/chargebackId
  title: chargebackId
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a ManagementChargeback resource.
  method: GET
  returns: ManagementChargeback
  title: getManagementChargeback
supported operation: Operation
  description: Updates the ManagementChargeback resource.
  expects: ManagementChargeback
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: ManagementChargeback
  title: patchManagementChargeback
description: Platform admin chargeback management

ManagementChargeback/chargebackId
type: Property
domain: ManagementChargeback
the hydra core vocabulary: chargebackId
range: string

ManagementDunningQueue
type: Class
title: ManagementDunningQueue
supported property: SupportedProperty
  property: ManagementDunningQueue/id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementDunningQueue/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementDunningQueue/attemptNumber
  title: attemptNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementDunningQueue/firstFailureAt
  title: firstFailureAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementDunningQueue/nextRetryAt
  title: nextRetryAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementDunningQueue/invoiceId
  title: invoiceId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementDunningQueue/invoiceState
  title: invoiceState
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementDunningQueue/billingAccountId
  title: billingAccountId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementDunningQueue/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a ManagementDunningQueue resource.
  method: GET
  returns: ManagementDunningQueue
  title: getManagementDunningQueue
description: Platform admin dunning queue viewer + manual actions

ManagementDunningQueue/id
type: Property
domain: ManagementDunningQueue
the hydra core vocabulary: id
range: string

ManagementDunningQueue/status
type: Property
domain: ManagementDunningQueue
the hydra core vocabulary: status
range: string

ManagementDunningQueue/attemptNumber
type: Property
domain: ManagementDunningQueue
the hydra core vocabulary: attemptNumber
range: integer

ManagementDunningQueue/firstFailureAt
type: Property
domain: ManagementDunningQueue
the hydra core vocabulary: firstFailureAt
range: string

ManagementDunningQueue/nextRetryAt
type: Property
domain: ManagementDunningQueue
the hydra core vocabulary: nextRetryAt
range: string

ManagementDunningQueue/invoiceId
type: Property
domain: ManagementDunningQueue
the hydra core vocabulary: invoiceId
range: string

ManagementDunningQueue/invoiceState
type: Property
domain: ManagementDunningQueue
the hydra core vocabulary: invoiceState
range: string

ManagementDunningQueue/billingAccountId
type: Property
domain: ManagementDunningQueue
the hydra core vocabulary: billingAccountId
range: string

ManagementDunningQueue/createdAt
type: Property
domain: ManagementDunningQueue
the hydra core vocabulary: createdAt
range: string

ManagementImpersonation
type: Class
title: ManagementImpersonation
supported property: SupportedProperty
  property: ManagementImpersonation/active
  title: active
  required: false
  readable: true
  writeable: true
  description: Whether an impersonation session is currently active
supported property: SupportedProperty
  property: ManagementImpersonation/admin
  title: admin
  required: false
  readable: true
  writeable: true
  description: Admin user performing the impersonation
supported property: SupportedProperty
  property: ManagementImpersonation/target
  title: target
  required: false
  readable: true
  writeable: true
  description: Target user being impersonated
supported operation: Operation
  type: FindAction
  description: Retrieves a ManagementImpersonation resource.
  method: GET
  returns: ManagementImpersonation
  title: getManagementImpersonation
description: Platform admin management operations

ManagementImpersonation/active
type: Property
domain: ManagementImpersonation
the hydra core vocabulary: active
range: boolean

ManagementImpersonation/admin
type: Property
domain: ManagementImpersonation
the hydra core vocabulary: admin
range: string

ManagementImpersonation/target
type: Property
domain: ManagementImpersonation
the hydra core vocabulary: target
range: string

ManagementInstallation
type: Class
title: ManagementInstallation
supported property: SupportedProperty
  property: ManagementInstallation/id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementInstallation/installationId
  title: installationId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementInstallation/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementInstallation/targetGitHubAccount
  title: targetGitHubAccount
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementInstallation/cacheEnabled
  title: cacheEnabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementInstallation/runnerV2Enabled
  title: runnerV2Enabled
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a ManagementInstallation resource.
  method: GET
  returns: owl:Nothing
  title: getManagementInstallation
supported operation: Operation
  description: Updates the ManagementInstallation resource.
  expects: ManagementInstallation
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: ManagementInstallation
  title: patchManagementInstallation
description: Platform admin management operations

ManagementInstallation/id
type: Property
domain: ManagementInstallation
the hydra core vocabulary: id
range: string

ManagementInstallation/installationId
type: Property
domain: ManagementInstallation
the hydra core vocabulary: installationId
range: integer

ManagementInstallation/status
type: Property
domain: ManagementInstallation
the hydra core vocabulary: status
range: string

ManagementInstallation/targetGitHubAccount
type: Property
domain: ManagementInstallation
the hydra core vocabulary: targetGitHubAccount
range: string

ManagementInstallation/cacheEnabled
type: Property
domain: ManagementInstallation
the hydra core vocabulary: cacheEnabled
range: boolean

ManagementInstallation/runnerV2Enabled
type: Property
domain: ManagementInstallation
the hydra core vocabulary: runnerV2Enabled
range: boolean

ManagementInvoice
type: Class
title: ManagementInvoice
supported property: SupportedProperty
  property: ManagementInvoice/id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementInvoice/state
  title: state
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementInvoice/invoiceType
  title: invoiceType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementInvoice/totalAmount
  title: totalAmount
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementInvoice/invoiceDate
  title: invoiceDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementInvoice/billingAccountId
  title: billingAccountId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementInvoice/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementInvoice/auditEntries
  title: auditEntries
  required: false
  readable: true
  writeable: true
  description: Audit log entries for this invoice (detail view only).
supported operation: Operation
  type: FindAction
  description: Retrieves a ManagementInvoice resource.
  method: GET
  returns: ManagementInvoice
  title: getManagementInvoice
description: Platform admin invoice management: list, view, manual actions

ManagementInvoice/id
type: Property
domain: ManagementInvoice
the hydra core vocabulary: id
range: string

ManagementInvoice/state
type: Property
domain: ManagementInvoice
the hydra core vocabulary: state
range: string

ManagementInvoice/invoiceType
type: Property
domain: ManagementInvoice
the hydra core vocabulary: invoiceType
range: string

ManagementInvoice/totalAmount
type: Property
domain: ManagementInvoice
the hydra core vocabulary: totalAmount
range: integer

ManagementInvoice/invoiceDate
type: Property
domain: ManagementInvoice
the hydra core vocabulary: invoiceDate
range: string

ManagementInvoice/billingAccountId
type: Property
domain: ManagementInvoice
the hydra core vocabulary: billingAccountId
range: string

ManagementInvoice/createdAt
type: Property
domain: ManagementInvoice
the hydra core vocabulary: createdAt
range: string

ManagementInvoice/auditEntries
type: Property
domain: ManagementInvoice
the hydra core vocabulary: auditEntries

ManagementMe
type: Class
title: ManagementMe
supported property: SupportedProperty
  property: ManagementMe/id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementMe/accountId
  title: accountId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementMe/login
  title: login
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementMe/avatarUrl
  title: avatarUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementMe/isPlatformAdmin
  title: isPlatformAdmin
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementMe/target
  title: target
  required: false
  readable: true
  writeable: true
  description: Impersonation target user (present only when session is an impersonation).
supported operation: Operation
  type: FindAction
  description: Retrieves a ManagementMe resource.
  method: GET
  returns: ManagementMe
  title: getManagementMe
description: Platform admin management operations

ManagementMe/id
type: Property
domain: ManagementMe
the hydra core vocabulary: id
range: string

ManagementMe/accountId
type: Property
domain: ManagementMe
the hydra core vocabulary: accountId
range: integer

ManagementMe/login
type: Property
domain: ManagementMe
the hydra core vocabulary: login
range: string

ManagementMe/avatarUrl
type: Property
domain: ManagementMe
the hydra core vocabulary: avatarUrl
range: string

ManagementMe/isPlatformAdmin
type: Property
domain: ManagementMe
the hydra core vocabulary: isPlatformAdmin
range: boolean

ManagementMe/target
type: Property
domain: ManagementMe
the hydra core vocabulary: target

ManagementRefundTriage
type: Class
title: ManagementRefundTriage
supported property: SupportedProperty
  property: ManagementRefundTriage/id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementRefundTriage/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementRefundTriage/notes
  title: notes
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementRefundTriage/eventType
  title: eventType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementRefundTriage/entityReference
  title: entityReference
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementRefundTriage/providerEventId
  title: providerEventId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementRefundTriage/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementRefundTriage/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a ManagementRefundTriage resource.
  method: GET
  returns: ManagementRefundTriage
  title: getManagementRefundTriage
supported operation: Operation
  type: FindAction
  description: Retrieves a ManagementRefundTriage resource.
  method: GET
  returns: ManagementRefundTriage
  title: getManagementRefundTriage
description: Platform admin refund triage management

ManagementRefundTriage/id
type: Property
domain: ManagementRefundTriage
the hydra core vocabulary: id
range: string

ManagementRefundTriage/status
type: Property
domain: ManagementRefundTriage
the hydra core vocabulary: status
range: string

ManagementRefundTriage/notes
type: Property
domain: ManagementRefundTriage
the hydra core vocabulary: notes
range: string

ManagementRefundTriage/eventType
type: Property
domain: ManagementRefundTriage
the hydra core vocabulary: eventType
range: string

ManagementRefundTriage/entityReference
type: Property
domain: ManagementRefundTriage
the hydra core vocabulary: entityReference
range: string

ManagementRefundTriage/providerEventId
type: Property
domain: ManagementRefundTriage
the hydra core vocabulary: providerEventId
range: string

ManagementRefundTriage/createdAt
type: Property
domain: ManagementRefundTriage
the hydra core vocabulary: createdAt
range: string

ManagementRefundTriage/updatedAt
type: Property
domain: ManagementRefundTriage
the hydra core vocabulary: updatedAt
range: string

ManagementUser
type: Class
title: ManagementUser
supported property: SupportedProperty
  property: ManagementUser/id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementUser/accountId
  title: accountId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementUser/login
  title: login
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementUser/avatarUrl
  title: avatarUrl
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a ManagementUser resource.
  method: GET
  returns: owl:Nothing
  title: getManagementUser
description: Platform admin management operations

ManagementUser/id
type: Property
domain: ManagementUser
the hydra core vocabulary: id
range: string

ManagementUser/accountId
type: Property
domain: ManagementUser
the hydra core vocabulary: accountId
range: integer

ManagementUser/login
type: Property
domain: ManagementUser
the hydra core vocabulary: login
range: string

ManagementUser/avatarUrl
type: Property
domain: ManagementUser
the hydra core vocabulary: avatarUrl
range: string

ManagementWebhookPayload
type: Class
title: ManagementWebhookPayload
supported property: SupportedProperty
  property: ManagementWebhookPayload/id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementWebhookPayload/providerType
  title: providerType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementWebhookPayload/providerEventId
  title: providerEventId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementWebhookPayload/eventType
  title: eventType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementWebhookPayload/domainEvent
  title: domainEvent
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementWebhookPayload/entityType
  title: entityType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementWebhookPayload/entityReference
  title: entityReference
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementWebhookPayload/processedAt
  title: processedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ManagementWebhookPayload/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a ManagementWebhookPayload resource.
  method: GET
  returns: ManagementWebhookPayload
  title: getManagementWebhookPayload
description: Platform admin payment webhook payload viewer + replay

ManagementWebhookPayload/id
type: Property
domain: ManagementWebhookPayload
the hydra core vocabulary: id
range: string

ManagementWebhookPayload/providerType
type: Property
domain: ManagementWebhookPayload
the hydra core vocabulary: providerType
range: string

ManagementWebhookPayload/providerEventId
type: Property
domain: ManagementWebhookPayload
the hydra core vocabulary: providerEventId
range: string

ManagementWebhookPayload/eventType
type: Property
domain: ManagementWebhookPayload
the hydra core vocabulary: eventType
range: string

ManagementWebhookPayload/domainEvent
type: Property
domain: ManagementWebhookPayload
the hydra core vocabulary: domainEvent
range: string

ManagementWebhookPayload/entityType
type: Property
domain: ManagementWebhookPayload
the hydra core vocabulary: entityType
range: string

ManagementWebhookPayload/entityReference
type: Property
domain: ManagementWebhookPayload
the hydra core vocabulary: entityReference
range: string

ManagementWebhookPayload/processedAt
type: Property
domain: ManagementWebhookPayload
the hydra core vocabulary: processedAt
range: string

ManagementWebhookPayload/createdAt
type: Property
domain: ManagementWebhookPayload
the hydra core vocabulary: createdAt
range: string

Assignments
type: Class
title: Assignments
supported property: SupportedProperty
  property: Assignments/id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Assignments/role
  title: role
  required: false
  readable: true
  writeable: true
  description: Role for the installation
supported property: SupportedProperty
  property: Assignments/gitHubInstallation
  title: gitHubInstallation
  required: false
  readable: true
  writeable: true
  description: Installation
supported property: SupportedProperty
  property: Assignments/gitHubUserAccount
  title: gitHubUserAccount
  required: false
  readable: true
  writeable: true
  description: GitHub user account
supported property: SupportedProperty
  property: Assignments/accessControl
  title: accessControl
  required: false
  readable: true
  writeable: false
  description: Access control information
supported operation: Operation
  type: FindAction
  description: Retrieves a Assignments resource.
  method: GET
  returns: Assignments
  title: getAssignments
supported operation: Operation
  description: Updates the Assignments resource.
  expects: Assignments
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Assignments
  title: patchAssignments
supported operation: Operation
  type: DeleteAction
  description: Deletes the Assignments resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteAssignments
description: Operations related to assignments

Assignments/id
type: Property
domain: Assignments
the hydra core vocabulary: id
range: string

Assignments/role
type: Property
domain: Assignments
the hydra core vocabulary: role

Assignments/gitHubInstallation
type: Property
domain: Assignments
the hydra core vocabulary: gitHubInstallation
max cardinality: 1
range: Installations

Assignments/gitHubUserAccount
type: Property
domain: Assignments
the hydra core vocabulary: gitHubUserAccount
max cardinality: 1
range: GitHub

Assignments/accessControl
type: Property
domain: Assignments
the hydra core vocabulary: accessControl

GitHub
type: Class
title: GitHub
supported property: SupportedProperty
  property: GitHub/id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: GitHub/accountId
  title: accountId
  required: false
  readable: true
  writeable: false
  description: GitHub numeric account ID
supported property: SupportedProperty
  property: GitHub/login
  title: login
  required: false
  readable: true
  writeable: false
  description: GitHub login of the user
supported property: SupportedProperty
  property: GitHub/avatarUrl
  title: avatarUrl
  required: false
  readable: true
  writeable: false
  description: Avatar URL of the user
supported property: SupportedProperty
  property: GitHub/accountType
  title: accountType
  required: false
  readable: true
  writeable: false
  description: Account type of the user
supported property: SupportedProperty
  property: GitHub/isPlatformAdmin
  title: isPlatformAdmin
  required: false
  readable: true
  writeable: false
  description: Whether the current user is a platform admin
supported property: SupportedProperty
  property: GitHub/creditsAvailableCents
  title: creditsAvailableCents
  required: false
  readable: true
  writeable: false
  description: Available free credits in cents
supported property: SupportedProperty
  property: GitHub/creditsLastUpdatedAt
  title: creditsLastUpdatedAt
  required: false
  readable: true
  writeable: false
  description: Last time credits were updated
supported operation: Operation
  type: FindAction
  description: Retrieves a GitHub resource.
  method: GET
  returns: GitHub
  title: getGitHub
supported operation: Operation
  type: FindAction
  description: Retrieves a GitHub resource.
  method: GET
  returns: GitHub
  title: getGitHub
supported operation: Operation
  type: FindAction
  description: Retrieves a GitHub resource.
  method: GET
  returns: GitHub
  title: getGitHub
supported operation: Operation
  type: FindAction
  description: Retrieves a GitHub resource.
  method: GET
  returns: GitHub
  title: getGitHub
supported operation: Operation
  type: FindAction
  description: Retrieves a GitHub resource.
  method: GET
  returns: GitHub
  title: getGitHub
description: Authentication related operations
supported property: SupportedProperty
  property: GitHub/id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: GitHub/accountId
  title: accountId
  required: false
  readable: true
  writeable: false
  description: GitHub numeric account ID
supported property: SupportedProperty
  property: GitHub/login
  title: login
  required: false
  readable: true
  writeable: false
  description: GitHub login of the user
supported property: SupportedProperty
  property: GitHub/avatarUrl
  title: avatarUrl
  required: false
  readable: true
  writeable: false
  description: Avatar URL of the user
supported property: SupportedProperty
  property: GitHub/accountType
  title: accountType
  required: false
  readable: true
  writeable: false
  description: Account type of the user
supported property: SupportedProperty
  property: GitHub/isPlatformAdmin
  title: isPlatformAdmin
  required: false
  readable: true
  writeable: false
  description: Whether the current user is a platform admin
supported property: SupportedProperty
  property: GitHub/creditsAvailableCents
  title: creditsAvailableCents
  required: false
  readable: true
  writeable: false
  description: Available free credits in cents
supported property: SupportedProperty
  property: GitHub/creditsLastUpdatedAt
  title: creditsLastUpdatedAt
  required: false
  readable: true
  writeable: false
  description: Last time credits were updated
supported operation: Operation
  type: FindAction
  description: Retrieves a GitHub resource.
  method: GET
  returns: GitHub
  title: getGitHub
description: Operations related to GitHub user accounts

GitHub/id
type: Property
domain: GitHub
the hydra core vocabulary: id
range: string

GitHub/accountId
type: Property
domain: GitHub
the hydra core vocabulary: accountId
range: integer

GitHub/login
type: Property
domain: GitHub
the hydra core vocabulary: login
range: string

GitHub/avatarUrl
type: Property
domain: GitHub
the hydra core vocabulary: avatarUrl
range: string

GitHub/accountType
type: Property
domain: GitHub
the hydra core vocabulary: accountType

GitHub/isPlatformAdmin
type: Property
domain: GitHub
the hydra core vocabulary: isPlatformAdmin
range: boolean

GitHub/creditsAvailableCents
type: Property
domain: GitHub
the hydra core vocabulary: creditsAvailableCents
range: integer

GitHub/creditsLastUpdatedAt
type: Property
domain: GitHub
the hydra core vocabulary: creditsLastUpdatedAt
range: dateTime

Installations
type: Class
title: Installations
supported property: SupportedProperty
  property: Installations/state
  title: state
  required: false
  readable: true
  writeable: false
  description: Current billing account state
supported property: SupportedProperty
  property: Installations/customerType
  title: customerType
  required: false
  readable: true
  writeable: false
  description: Customer type
supported property: SupportedProperty
  property: Installations/paymentProviderCustomerId
  title: paymentProviderCustomerId
  required: false
  readable: true
  writeable: false
  description: Payment provider customer ID
supported property: SupportedProperty
  property: Installations/paymentProviderMandateId
  title: paymentProviderMandateId
  required: false
  readable: true
  writeable: false
  description: Payment provider mandate ID for recurring payments
supported property: SupportedProperty
  property: Installations/accountType
  title: accountType
  required: false
  readable: true
  writeable: false
  description: Account type (user, organization, enterprise, or null if unknown)
supported property: SupportedProperty
  property: Installations/accountIdentifier
  title: accountIdentifier
  required: false
  readable: true
  writeable: false
  description: Account identifier (e.g., user_123, org_456)
supported property: SupportedProperty
  property: Installations/hasPaymentProviderCustomer
  title: hasPaymentProviderCustomer
  required: false
  readable: true
  writeable: false
  description: Whether billing account has a payment provider customer
supported property: SupportedProperty
  property: Installations/hasPaymentProviderMandate
  title: hasPaymentProviderMandate
  required: false
  readable: true
  writeable: false
  description: Whether billing account has a payment provider mandate for recurring payments
supported property: SupportedProperty
  property: Installations/supportsPaymentPortal
  title: supportsPaymentPortal
  required: false
  readable: true
  writeable: false
  description: Whether the payment provider supports a billing portal
supported property: SupportedProperty
  property: Installations/taxIdVerified
  title: taxIdVerified
  required: false
  readable: true
  writeable: false
  description: Whether the tax ID has been verified by the tax provider
supported property: SupportedProperty
  property: Installations/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
  description: Creation timestamp
supported property: SupportedProperty
  property: Installations/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
  description: Last update timestamp
supported property: SupportedProperty
  property: Installations/authorization
  title: authorization
  required: false
  readable: true
  writeable: false
  description: Current authorization status for the billing account
supported operation: Operation
  type: FindAction
  description: Retrieves a Installations resource.
  method: GET
  returns: Installations
  title: getInstallations
description: Billing account for a GitHub installation (installationId is the installation UUID, not GitHub installationId)
supported operation: Operation
  type: FindAction
  description: Retrieves a Installations resource.
  method: GET
  returns: owl:Nothing
  title: getInstallations
description: Schedule subscription cancellation
supported operation: Operation
  type: FindAction
  description: Retrieves a Installations resource.
  method: GET
  returns: owl:Nothing
  title: getInstallations
description: Claim welcome credits
supported operation: Operation
  type: FindAction
  description: Retrieves a Installations resource.
  method: GET
  returns: owl:Nothing
  title: getInstallations
description: Schedule a downgrade to a lower-tier plan
supported operation: Operation
  type: FindAction
  description: Retrieves a Installations resource.
  method: GET
  returns: owl:Nothing
  title: getInstallations
description: Purchase credits
supported operation: Operation
  type: FindAction
  description: Retrieves a Installations resource.
  method: GET
  returns: owl:Nothing
  title: getInstallations
description: Revert a pending downgrade or cancellation
supported operation: Operation
  type: FindAction
  description: Retrieves a Installations resource.
  method: GET
  returns: owl:Nothing
  title: getInstallations
description: Subscribe to a paid plan
supported property: SupportedProperty
  property: Installations/checkoutUrl
  title: checkoutUrl
  required: false
  readable: true
  writeable: false
  description: Hosted checkout URL the customer is redirected to in order to capture a new mandate.
supported operation: Operation
  type: FindAction
  description: Retrieves a Installations resource.
  method: GET
  returns: owl:Nothing
  title: getInstallations
description: Update the payment method (mandate) for the billing account
supported operation: Operation
  type: FindAction
  description: Retrieves a Installations resource.
  method: GET
  returns: owl:Nothing
  title: getInstallations
description: Upgrade to a higher-tier plan
supported property: SupportedProperty
  property: Installations/balanceAmount
  title: balanceAmount
  required: false
  readable: true
  writeable: false
  description: Current credit balance in fixed-point x10^5
supported property: SupportedProperty
  property: Installations/welcomeCreditsClaimed
  title: welcomeCreditsClaimed
  required: false
  readable: true
  writeable: false
  description: Whether welcome credits have been claimed for this account
supported operation: Operation
  type: FindAction
  description: Retrieves a Installations resource.
  method: GET
  returns: Installations
  title: getInstallations
description: Credit balance for an installation
supported property: SupportedProperty
  property: Installations/installationId
  title: installationId
  required: false
  readable: true
  writeable: false
  description: GitHub numeric installation ID
supported property: SupportedProperty
  property: Installations/status
  title: status
  required: false
  readable: true
  writeable: false
  description: GitHub installation status
supported property: SupportedProperty
  property: Installations/targetGitHubAccount
  title: targetGitHubAccount
  required: false
  readable: true
  writeable: false
  description: GitHub target account
description: Operations related to installations
description: Invoice history for an installation
description: Current subscription for an installation

Installations/state
type: Property
domain: Installations
the hydra core vocabulary: state
range: string

Installations/customerType
type: Property
domain: Installations
the hydra core vocabulary: customerType
range: string

Installations/paymentProviderCustomerId
type: Property
domain: Installations
the hydra core vocabulary: paymentProviderCustomerId
range: string

Installations/paymentProviderMandateId
type: Property
domain: Installations
the hydra core vocabulary: paymentProviderMandateId
range: string

Installations/accountType
type: Property
domain: Installations
the hydra core vocabulary: accountType
range: string

Installations/accountIdentifier
type: Property
domain: Installations
the hydra core vocabulary: accountIdentifier
range: string

Installations/hasPaymentProviderCustomer
type: Property
domain: Installations
the hydra core vocabulary: hasPaymentProviderCustomer
range: boolean

Installations/hasPaymentProviderMandate
type: Property
domain: Installations
the hydra core vocabulary: hasPaymentProviderMandate
range: boolean

Installations/supportsPaymentPortal
type: Property
domain: Installations
the hydra core vocabulary: supportsPaymentPortal
range: boolean

Installations/taxIdVerified
type: Property
domain: Installations
the hydra core vocabulary: taxIdVerified
range: boolean

Installations/createdAt
type: Property
domain: Installations
the hydra core vocabulary: createdAt
range: string

Installations/updatedAt
type: Property
domain: Installations
the hydra core vocabulary: updatedAt
range: string

Installations/authorization
type: Property
domain: Installations
the hydra core vocabulary: authorization
range: string
range: boolean

Billing
type: Class
title: Billing
supported property: SupportedProperty
  property: Billing/firstName
  title: firstName
  required: false
  readable: true
  writeable: true
  description: First name
supported property: SupportedProperty
  property: Billing/lastName
  title: lastName
  required: false
  readable: true
  writeable: true
  description: Last name
supported property: SupportedProperty
  property: Billing/email
  title: email
  required: false
  readable: true
  writeable: true
  description: Email address for billing
supported property: SupportedProperty
  property: Billing/companyName
  title: companyName
  required: false
  readable: true
  writeable: true
  description: Company name (optional)
supported property: SupportedProperty
  property: Billing/countryCode
  title: countryCode
  required: false
  readable: true
  writeable: true
  description: Country code (ISO 3166-1 alpha-2, validated against supported tax jurisdictions)
supported property: SupportedProperty
  property: Billing/state
  title: state
  required: false
  readable: true
  writeable: true
  description: State or province (optional)
supported property: SupportedProperty
  property: Billing/addressLine1
  title: addressLine1
  required: false
  readable: true
  writeable: true
  description: Address line 1
supported property: SupportedProperty
  property: Billing/addressLine2
  title: addressLine2
  required: false
  readable: true
  writeable: true
  description: Address line 2 (optional)
supported property: SupportedProperty
  property: Billing/city
  title: city
  required: false
  readable: true
  writeable: true
  description: City
supported property: SupportedProperty
  property: Billing/zipCode
  title: zipCode
  required: false
  readable: true
  writeable: true
  description: ZIP/Postal code
supported property: SupportedProperty
  property: Billing/phoneNumber
  title: phoneNumber
  required: false
  readable: true
  writeable: true
  description: Phone number in E.164 format (optional)
supported property: SupportedProperty
  property: Billing/taxId
  title: taxId
  required: false
  readable: true
  writeable: true
  description: Tax ID (optional)
supported property: SupportedProperty
  property: Billing/taxIdVerifiedAt
  title: taxIdVerifiedAt
  required: false
  readable: true
  writeable: false
  description: Timestamp of last successful tax ID verification
supported property: SupportedProperty
  property: Billing/taxCalculation
  title: taxCalculation
  required: false
  readable: true
  writeable: false
  description: Tax calculation result (only when withTaxCalculation=true)
supported property: SupportedProperty
  property: Billing/accessControl
  title: accessControl
  required: false
  readable: true
  writeable: false
  description: Access control information
supported operation: Operation
  type: FindAction
  description: Retrieves a Billing resource.
  method: GET
  returns: Billing
  title: getBilling
supported operation: Operation
  description: Updates the Billing resource.
  expects: Billing
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Billing
  title: patchBilling
description: Operations related to billing information
supported operation: Operation
  type: FindAction
  description: Retrieves a Billing resource.
  method: GET
  returns: Billing
  title: getBilling
description: Checkout callback endpoint
supported operation: Operation
  type: FindAction
  description: Retrieves a Billing resource.
  method: GET
  returns: Billing
  title: getBilling
description: Payment provider webhook endpoint
supported property: SupportedProperty
  property: Billing/name
  title: name
  required: false
  readable: true
  writeable: false
  description: Plan display name
supported property: SupportedProperty
  property: Billing/tier
  title: tier
  required: false
  readable: true
  writeable: false
  description: Plan tier (0 = Free, higher = more features)
supported property: SupportedProperty
  property: Billing/monthlyFeeAmount
  title: monthlyFeeAmount
  required: false
  readable: true
  writeable: false
  description: Gross-inclusive monthly subscription fee in fixed-point ×10^5 EUR — the total amount the customer pays at checkout regardless of VAT rate.
supported property: SupportedProperty
  property: Billing/includedCreditAmount
  title: includedCreditAmount
  required: false
  readable: true
  writeable: false
  description: Monthly included credit in fixed-point x10^5
supported property: SupportedProperty
  property: Billing/welcomeCreditAmount
  title: welcomeCreditAmount
  required: false
  readable: true
  writeable: false
  description: Welcome credit in fixed-point x10^5
supported property: SupportedProperty
  property: Billing/discountPercent
  title: discountPercent
  required: false
  readable: true
  writeable: false
  description: Usage discount percentage
supported property: SupportedProperty
  property: Billing/description
  title: description
  required: false
  readable: true
  writeable: false
  description: Marketing description of the plan
supported property: SupportedProperty
  property: Billing/features
  title: features
  required: false
  readable: true
  writeable: false
  description: Plan feature list for display
supported operation: Operation
  type: FindAction
  description: Retrieves a Billing resource.
  method: GET
  returns: Billing
  title: getBilling
description: Billing, checkout, webhooks, and subscription plan APIs

Billing/firstName
type: Property
domain: Billing
the hydra core vocabulary: firstName
range: string

Billing/lastName
type: Property
domain: Billing
the hydra core vocabulary: lastName
range: string

Billing/email
type: Property
domain: Billing
the hydra core vocabulary: email
range: string

Billing/companyName
type: Property
domain: Billing
the hydra core vocabulary: companyName
range: string

Billing/countryCode
type: Property
domain: Billing
the hydra core vocabulary: countryCode
range: string

Billing/state
type: Property
domain: Billing
the hydra core vocabulary: state
range: string

Billing/addressLine1
type: Property
domain: Billing
the hydra core vocabulary: addressLine1
range: string

Billing/addressLine2
type: Property
domain: Billing
the hydra core vocabulary: addressLine2
range: string

Billing/city
type: Property
domain: Billing
the hydra core vocabulary: city
range: string

Billing/zipCode
type: Property
domain: Billing
the hydra core vocabulary: zipCode
range: string

Billing/phoneNumber
type: Property
domain: Billing
the hydra core vocabulary: phoneNumber
range: string

Billing/taxId
type: Property
domain: Billing
the hydra core vocabulary: taxId
range: string

Billing/taxIdVerifiedAt
type: Property
domain: Billing
the hydra core vocabulary: taxIdVerifiedAt
range: string

Billing/taxCalculation
type: Property
domain: Billing
the hydra core vocabulary: taxCalculation
range: string
range: integer
range: decimal

Billing/accessControl
type: Property
domain: Billing
the hydra core vocabulary: accessControl

Installations/checkoutUrl
type: Property
domain: Installations
the hydra core vocabulary: checkoutUrl
range: string

BuildRushAccount
type: Class
title: BuildRushAccount
supported property: SupportedProperty
  property: BuildRushAccount/firstName
  title: firstName
  required: false
  readable: true
  writeable: true
  description: First name
supported property: SupportedProperty
  property: BuildRushAccount/lastName
  title: lastName
  required: false
  readable: true
  writeable: true
  description: Last name
supported property: SupportedProperty
  property: BuildRushAccount/email
  title: email
  required: false
  readable: true
  writeable: true
  description: Email address
supported property: SupportedProperty
  property: BuildRushAccount/emailVerified
  title: emailVerified
  required: false
  readable: true
  writeable: false
  description: Whether the email address has been verified
supported property: SupportedProperty
  property: BuildRushAccount/onboardingCompleted
  title: onboardingCompleted
  required: false
  readable: true
  writeable: false
  description: Whether the user has completed onboarding (email verified + required consents)
supported property: SupportedProperty
  property: BuildRushAccount/tosConsentedAt
  title: tosConsentedAt
  required: false
  readable: true
  writeable: false
  description: Timestamp when Terms of Service were accepted
supported property: SupportedProperty
  property: BuildRushAccount/privacyConsentedAt
  title: privacyConsentedAt
  required: false
  readable: true
  writeable: false
  description: Timestamp when Data Privacy policy was accepted
supported property: SupportedProperty
  property: BuildRushAccount/marketingConsentedAt
  title: marketingConsentedAt
  required: false
  readable: true
  writeable: false
  description: Timestamp when marketing consent was given
supported operation: Operation
  type: FindAction
  description: Retrieves a BuildRushAccount resource.
  method: GET
  returns: BuildRushAccount
  title: getBuildRushAccount
supported operation: Operation
  description: Updates the BuildRushAccount resource.
  expects: BuildRushAccount
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: BuildRushAccount
  title: patchBuildRushAccount
description: Operations related to BuildRush user accounts for the current authenticated user

BuildRushAccount/firstName
type: Property
domain: BuildRushAccount
the hydra core vocabulary: firstName
range: string

BuildRushAccount/lastName
type: Property
domain: BuildRushAccount
the hydra core vocabulary: lastName
range: string

BuildRushAccount/email
type: Property
domain: BuildRushAccount
the hydra core vocabulary: email
range: string

BuildRushAccount/emailVerified
type: Property
domain: BuildRushAccount
the hydra core vocabulary: emailVerified
range: boolean

BuildRushAccount/onboardingCompleted
type: Property
domain: BuildRushAccount
the hydra core vocabulary: onboardingCompleted
range: boolean

BuildRushAccount/tosConsentedAt
type: Property
domain: BuildRushAccount
the hydra core vocabulary: tosConsentedAt
range: dateTime

BuildRushAccount/privacyConsentedAt
type: Property
domain: BuildRushAccount
the hydra core vocabulary: privacyConsentedAt
range: dateTime

BuildRushAccount/marketingConsentedAt
type: Property
domain: BuildRushAccount
the hydra core vocabulary: marketingConsentedAt
range: dateTime

CacheDashboardToken
type: Class
title: CacheDashboardToken
supported property: SupportedProperty
  property: CacheDashboardToken/token
  title: token
  required: false
  readable: true
  writeable: false
  description: The compact RS256 JWT the cache service verifies via JWKS.
supported property: SupportedProperty
  property: CacheDashboardToken/expiresAt
  title: expiresAt
  required: false
  readable: true
  writeable: false
  description: The token's exact expiry (ISO 8601), matching its `exp` claim.
supported property: SupportedProperty
  property: CacheDashboardToken/role
  title: role
  required: false
  readable: true
  writeable: false
  description: The authenticated user's role on this installation.
supported operation: Operation
  type: FindAction
  description: Retrieves a CacheDashboardToken resource.
  method: GET
  returns: owl:Nothing
  title: getCacheDashboardToken
description: Mint a short-lived, installation-scoped token for the cache dashboard read API

CacheDashboardToken/token
type: Property
domain: CacheDashboardToken
the hydra core vocabulary: token
range: string

CacheDashboardToken/expiresAt
type: Property
domain: CacheDashboardToken
the hydra core vocabulary: expiresAt
range: string

CacheDashboardToken/role
type: Property
domain: CacheDashboardToken
the hydra core vocabulary: role
range: string

Installations/balanceAmount
type: Property
domain: Installations
the hydra core vocabulary: balanceAmount
range: integer

Installations/welcomeCreditsClaimed
type: Property
domain: Installations
the hydra core vocabulary: welcomeCreditsClaimed
range: boolean

EmailVerification
type: Class
title: EmailVerification
supported operation: Operation
  type: FindAction
  description: Retrieves a EmailVerification resource.
  method: GET
  returns: owl:Nothing
  title: getEmailVerification
description: Email verification operations

GitHubWebhook
type: Class
title: GitHubWebhook
supported operation: Operation
  type: FindAction
  description: Retrieves a GitHubWebhook resource.
  method: GET
  returns: GitHubWebhook
  title: getGitHubWebhook
description: GitHub App webhook endpoint

Health
type: Class
title: Health
supported operation: Operation
  type: FindAction
  description: Retrieves a Health resource.
  method: GET
  returns: Health
  title: getHealth
description: Health check operations

Installations/installationId
type: Property
domain: Installations
the hydra core vocabulary: installationId
range: integer

Installations/status
type: Property
domain: Installations
the hydra core vocabulary: status

Installations/targetGitHubAccount
type: Property
domain: Installations
the hydra core vocabulary: targetGitHubAccount
max cardinality: 1
range: GitHub

Installations/hasAnyRunnerUsage
type: Property
domain: Installations
the hydra core vocabulary: hasAnyRunnerUsage
range: boolean

Installations/cacheEnabled
type: Property
domain: Installations
the hydra core vocabulary: cacheEnabled
range: boolean

Installations/runnerV2Enabled
type: Property
domain: Installations
the hydra core vocabulary: runnerV2Enabled
range: boolean

Installations/installationHealth
type: Property
domain: Installations
the hydra core vocabulary: installationHealth

Installations/accessControl
type: Property
domain: Installations
the hydra core vocabulary: accessControl

Internal
type: Class
title: Internal
supported property: SupportedProperty
  property: Internal/tenant id
  title: tenant_id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Internal/policy version
  title: policy_version
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Internal/state
  title: state
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Internal/runner v2 enabled
  title: runner_v2_enabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Internal/valid until unix seconds
  title: valid_until_unix_seconds
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Internal/github
  title: github
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Internal/entitlements
  title: entitlements
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Internal/enforcement
  title: enforcement
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Internal resource.
  method: GET
  returns: Internal
  title: getInternal
description: Runner controller installation snapshot (§5.3 single fetch + §5.2 list element). `output: self`, plain-json format — mirrors the InternalInstallation precedent. The `{installationId}` requirement is a UUID so the `/changes` literal route (InstallationSnapshotPage) cannot be captured by this variable route.
supported property: SupportedProperty
  property: Internal/installations
  title: installations
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Internal/next cursor
  title: next_cursor
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Internal/has more
  title: has_more
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Internal resource.
  method: GET
  returns: Internal
  title: getInternal
description: §5.2 changes feed envelope. A single Get reading ?cursor & ?limit from the query (no path identifier, like InternalInstallation's by-owner lookup).
supported property: SupportedProperty
  property: Internal/github owner id
  title: github_owner_id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Internal/github owner
  title: github_owner
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Internal/is active
  title: is_active
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Internal/cache enabled
  title: cache_enabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Internal/quota total bytes
  title: quota_total_bytes
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Internal/inactive since
  title: inactive_since
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Internal/max object bytes
  title: max_object_bytes
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Internal resource.
  method: GET
  returns: Internal
  title: getInternal
description: Cache-service-facing installation lookup resource. Returned by: - `GET /api/v1/internal/cache/installations?github_owner_id={id}` — single-installation lookup - `GET /api/v1/internal/cache/installations/active` — cursor-paginated list of active installations The collection endpoint uses framework-native cursor pagination (`paginationViaCursor`). The response body is a flat JSON array of items; the client derives the next cursor from the last item's `id` and walks the stream until a short page (fewer items than `itemsPerPage`) signals exhaustion. The opaque `?cursor` query parameter is a base64-encoded UUID marking "give me rows strictly greater than this id". `quota_total_bytes` is a plan-tier value resolved via the entitlement resolver (BR-897). `max_object_bytes` is not entitlement-resolved in v1 — it is a stub (always null) and the cache service applies its system default. `cache_enabled` is sourced live from the entity (BR-723).
supported property: SupportedProperty
  property: Internal/github repo id
  title: github_repo_id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Internal/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Internal/default branch
  title: default_branch
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Internal resource.
  method: GET
  returns: Internal
  title: getInternal
description: Repo metadata for the cache-service auth/exchange handler. Returned by `GET /api/v1/internal/cache/installations/{id}/repos/{githubRepoId}`. Includes the repo UUID, GitHub numeric id, `owner/name` full name, and the configured default branch (null defaults are treated as 404 by the provider — see {@see InternalInstallationRepoProvider}).

Internal/tenant id
type: Property
domain: Internal
the hydra core vocabulary: tenant_id
range: string

Internal/policy version
type: Property
domain: Internal
the hydra core vocabulary: policy_version
range: integer

Internal/state
type: Property
domain: Internal
the hydra core vocabulary: state
range: string

Internal/runner v2 enabled
type: Property
domain: Internal
the hydra core vocabulary: runner_v2_enabled
range: boolean

Internal/valid until unix seconds
type: Property
domain: Internal
the hydra core vocabulary: valid_until_unix_seconds
range: integer

Internal/github
type: Property
domain: Internal
the hydra core vocabulary: github

Internal/entitlements
type: Property
domain: Internal
the hydra core vocabulary: entitlements

Internal/enforcement
type: Property
domain: Internal
the hydra core vocabulary: enforcement

Internal/installations
type: Property
domain: Internal
the hydra core vocabulary: installations
range: Internal

Internal/next cursor
type: Property
domain: Internal
the hydra core vocabulary: next_cursor
range: string

Internal/has more
type: Property
domain: Internal
the hydra core vocabulary: has_more
range: boolean

Internal/github owner id
type: Property
domain: Internal
the hydra core vocabulary: github_owner_id
range: integer

Internal/github owner
type: Property
domain: Internal
the hydra core vocabulary: github_owner
range: string

Internal/is active
type: Property
domain: Internal
the hydra core vocabulary: is_active
range: boolean

Internal/cache enabled
type: Property
domain: Internal
the hydra core vocabulary: cache_enabled
range: boolean

Internal/quota total bytes
type: Property
domain: Internal
the hydra core vocabulary: quota_total_bytes
range: integer

Internal/inactive since
type: Property
domain: Internal
the hydra core vocabulary: inactive_since
range: dateTime

Internal/max object bytes
type: Property
domain: Internal
the hydra core vocabulary: max_object_bytes
range: integer

Internal/github repo id
type: Property
domain: Internal
the hydra core vocabulary: github_repo_id
range: integer

Internal/name
type: Property
domain: Internal
the hydra core vocabulary: name
range: string

Internal/default branch
type: Property
domain: Internal
the hydra core vocabulary: default_branch
range: string

Installations/invoiceType
type: Property
domain: Installations
the hydra core vocabulary: invoiceType
range: string

Installations/periodStart
type: Property
domain: Installations
the hydra core vocabulary: periodStart
range: string

Installations/periodEnd
type: Property
domain: Installations
the hydra core vocabulary: periodEnd
range: string

Installations/netSubtotalAmount
type: Property
domain: Installations
the hydra core vocabulary: netSubtotalAmount
range: integer

Installations/taxAmountAmount
type: Property
domain: Installations
the hydra core vocabulary: taxAmountAmount
range: integer

Installations/taxRate
type: Property
domain: Installations
the hydra core vocabulary: taxRate
range: string

Installations/taxStatus
type: Property
domain: Installations
the hydra core vocabulary: taxStatus
range: string

Installations/taxName
type: Property
domain: Installations
the hydra core vocabulary: taxName
range: string

Installations/taxCountryCode
type: Property
domain: Installations
the hydra core vocabulary: taxCountryCode
range: string

Installations/taxProviderTransactionId
type: Property
domain: Installations
the hydra core vocabulary: taxProviderTransactionId
range: string

Installations/taxCode
type: Property
domain: Installations
the hydra core vocabulary: taxCode
range: string

Installations/totalAmountAmount
type: Property
domain: Installations
the hydra core vocabulary: totalAmountAmount
range: integer

Installations/invoiceDate
type: Property
domain: Installations
the hydra core vocabulary: invoiceDate
range: string

Installations/paidAt
type: Property
domain: Installations
the hydra core vocabulary: paidAt
range: string

Installations/paymentInFlightAt
type: Property
domain: Installations
the hydra core vocabulary: paymentInFlightAt
range: string

Installations/lineItems
type: Property
domain: Installations
the hydra core vocabulary: lineItems

Installations/providerInvoiceUrl
type: Property
domain: Installations
the hydra core vocabulary: providerInvoiceUrl
range: string

Installations/providerPdfUrl
type: Property
domain: Installations
the hydra core vocabulary: providerPdfUrl
range: string

Installations/documentProviderVoucherNumber
type: Property
domain: Installations
the hydra core vocabulary: documentProviderVoucherNumber
range: string

Notifications
type: Class
title: Notifications
supported property: SupportedProperty
  property: Notifications/id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Notifications/message
  title: message
  required: false
  readable: true
  writeable: true
  description: Notification message
supported property: SupportedProperty
  property: Notifications/severity
  title: severity
  required: false
  readable: true
  writeable: true
  description: Severity level of the notification
supported property: SupportedProperty
  property: Notifications/scope
  title: scope
  required: false
  readable: true
  writeable: true
  description: Scope of the notification
supported property: SupportedProperty
  property: Notifications/type
  title: type
  required: false
  readable: true
  writeable: true
  description: Machine-readable notification type
supported property: SupportedProperty
  property: Notifications/dismissible
  title: dismissible
  required: false
  readable: true
  writeable: true
  description: Whether the notification can be dismissed
supported property: SupportedProperty
  property: Notifications/expirationDate
  title: expirationDate
  required: false
  readable: true
  writeable: true
  description: Expiration date of the notification
supported property: SupportedProperty
  property: Notifications/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
  description: Creation date of the notification
supported property: SupportedProperty
  property: Notifications/installation
  title: installation
  required: false
  readable: true
  writeable: true
  description: Related installation for installation-scoped notifications
supported property: SupportedProperty
  property: Notifications/notificationStatus
  title: notificationStatus
  required: false
  readable: true
  writeable: true
  description: Status of this notification for the current user
supported property: SupportedProperty
  property: Notifications/accessControl
  title: accessControl
  required: false
  readable: true
  writeable: false
  description: Access control information
supported operation: Operation
  type: FindAction
  description: Retrieves a Notifications resource.
  method: GET
  returns: Notifications
  title: getNotifications
description: Operations related to notifications

Notifications/id
type: Property
domain: Notifications
the hydra core vocabulary: id
range: string

Notifications/message
type: Property
domain: Notifications
the hydra core vocabulary: message
range: string

Notifications/severity
type: Property
domain: Notifications
the hydra core vocabulary: severity

Notifications/scope
type: Property
domain: Notifications
the hydra core vocabulary: scope

Notifications/type
type: Property
domain: Notifications
the hydra core vocabulary: type

Notifications/dismissible
type: Property
domain: Notifications
the hydra core vocabulary: dismissible
range: boolean

Notifications/expirationDate
type: Property
domain: Notifications
the hydra core vocabulary: expirationDate
range: dateTime

Notifications/createdAt
type: Property
domain: Notifications
the hydra core vocabulary: createdAt
range: dateTime

Notifications/installation
type: Property
domain: Notifications
the hydra core vocabulary: installation
max cardinality: 1
range: Installations

Notifications/notificationStatus
type: Property
domain: Notifications
the hydra core vocabulary: notificationStatus
max cardinality: 1
range: NotificationStatuses

Notifications/accessControl
type: Property
domain: Notifications
the hydra core vocabulary: accessControl

NotificationStatuses
type: Class
title: NotificationStatuses
supported property: SupportedProperty
  property: NotificationStatuses/id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: NotificationStatuses/dismissedAt
  title: dismissedAt
  required: false
  readable: true
  writeable: true
  description: When the notification was dismissed
supported property: SupportedProperty
  property: NotificationStatuses/lastSeen
  title: lastSeen
  required: false
  readable: true
  writeable: true
  description: When the notification was last seen
supported property: SupportedProperty
  property: NotificationStatuses/notification
  title: notification
  required: false
  readable: true
  writeable: true
  description: The notification this status belongs to
supported property: SupportedProperty
  property: NotificationStatuses/accessControl
  title: accessControl
  required: false
  readable: true
  writeable: false
  description: Access control information
supported operation: Operation
  type: FindAction
  description: Retrieves a NotificationStatuses resource.
  method: GET
  returns: NotificationStatuses
  title: getNotificationStatuses
supported operation: Operation
  description: Updates the NotificationStatuses resource.
  expects: NotificationStatuses
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: NotificationStatuses
  title: patchNotificationStatuses
description: Operations related to notification status

NotificationStatuses/id
type: Property
domain: NotificationStatuses
the hydra core vocabulary: id
range: string

NotificationStatuses/dismissedAt
type: Property
domain: NotificationStatuses
the hydra core vocabulary: dismissedAt
range: dateTime

NotificationStatuses/lastSeen
type: Property
domain: NotificationStatuses
the hydra core vocabulary: lastSeen
range: dateTime

NotificationStatuses/notification
type: Property
domain: NotificationStatuses
the hydra core vocabulary: notification
max cardinality: 1
range: Notifications

NotificationStatuses/accessControl
type: Property
domain: NotificationStatuses
the hydra core vocabulary: accessControl

Billing/name
type: Property
domain: Billing
the hydra core vocabulary: name
range: string

Billing/tier
type: Property
domain: Billing
the hydra core vocabulary: tier
range: integer

Billing/monthlyFeeAmount
type: Property
domain: Billing
the hydra core vocabulary: monthlyFeeAmount
range: integer

Billing/includedCreditAmount
type: Property
domain: Billing
the hydra core vocabulary: includedCreditAmount
range: integer

Billing/welcomeCreditAmount
type: Property
domain: Billing
the hydra core vocabulary: welcomeCreditAmount
range: integer

Billing/discountPercent
type: Property
domain: Billing
the hydra core vocabulary: discountPercent
range: integer

Billing/description
type: Property
domain: Billing
the hydra core vocabulary: description
range: string

Billing/features
type: Property
domain: Billing
the hydra core vocabulary: features

RunnerDashboardToken
type: Class
title: RunnerDashboardToken
supported property: SupportedProperty
  property: RunnerDashboardToken/token
  title: token
  required: false
  readable: true
  writeable: false
  description: The compact RS256 JWT the runner controller verifies via JWKS.
supported property: SupportedProperty
  property: RunnerDashboardToken/expiresAt
  title: expiresAt
  required: false
  readable: true
  writeable: false
  description: The token's exact expiry (ISO 8601), matching its `exp` claim.
supported property: SupportedProperty
  property: RunnerDashboardToken/role
  title: role
  required: false
  readable: true
  writeable: false
  description: The authenticated user's role on this installation.
supported operation: Operation
  type: FindAction
  description: Retrieves a RunnerDashboardToken resource.
  method: GET
  returns: owl:Nothing
  title: getRunnerDashboardToken
description: Mint a short-lived, installation-scoped token for the runner dashboard read API

RunnerDashboardToken/token
type: Property
domain: RunnerDashboardToken
the hydra core vocabulary: token
range: string

RunnerDashboardToken/expiresAt
type: Property
domain: RunnerDashboardToken
the hydra core vocabulary: expiresAt
range: string

RunnerDashboardToken/role
type: Property
domain: RunnerDashboardToken
the hydra core vocabulary: role
range: string

Installations/planSlug
type: Property
domain: Installations
the hydra core vocabulary: planSlug
range: string

Installations/planName
type: Property
domain: Installations
the hydra core vocabulary: planName
range: string

Installations/cycleStart
type: Property
domain: Installations
the hydra core vocabulary: cycleStart
range: string

Installations/cycleEnd
type: Property
domain: Installations
the hydra core vocabulary: cycleEnd
range: string

Installations/pendingPlanSlug
type: Property
domain: Installations
the hydra core vocabulary: pendingPlanSlug
range: string

Installations/pendingPlanName
type: Property
domain: Installations
the hydra core vocabulary: pendingPlanName
range: string

Installations/cancelledAt
type: Property
domain: Installations
the hydra core vocabulary: cancelledAt
range: string

Installations/currentBalance
type: Property
domain: Installations
the hydra core vocabulary: currentBalance
range: integer

Billing/regions
type: Property
domain: Billing
the hydra core vocabulary: regions

Installations/entryType
type: Property
domain: Installations
the hydra core vocabulary: entryType
range: string

Installations/amountAmount
type: Property
domain: Installations
the hydra core vocabulary: amountAmount
range: integer

Installations/balanceAfterAmount
type: Property
domain: Installations
the hydra core vocabulary: balanceAfterAmount
range: integer

Installations/referenceType
type: Property
domain: Installations
the hydra core vocabulary: referenceType
range: string

Installations/initiatorAvatarUrl
type: Property
domain: Installations
the hydra core vocabulary: initiatorAvatarUrl
range: string

Installations/costAmount
type: Property
domain: Installations
the hydra core vocabulary: costAmount
range: integer

Installations/discountRate
type: Property
domain: Installations
the hydra core vocabulary: discountRate
range: integer

Installations/savingsAmount
type: Property
domain: Installations
the hydra core vocabulary: savingsAmount
range: integer

Installations/skuName
type: Property
domain: Installations
the hydra core vocabulary: skuName
range: string

Installations/expiredGrant
type: Property
domain: Installations
the hydra core vocabulary: expiredGrant

UsageRunner
type: Class
title: UsageRunner
supported property: SupportedProperty
  property: UsageRunner/id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: UsageRunner/sku
  title: sku
  required: false
  readable: true
  writeable: true
  description: SKU code
supported property: SupportedProperty
  property: UsageRunner/skuVersion
  title: skuVersion
  required: false
  readable: true
  writeable: true
  description: SKU version
supported property: SupportedProperty
  property: UsageRunner/quantity
  title: quantity
  required: false
  readable: true
  writeable: true
  description: Usage quantity (duration in seconds)
supported property: SupportedProperty
  property: UsageRunner/measure
  title: measure
  required: false
  readable: true
  writeable: true
  description: Unit of measure
supported property: SupportedProperty
  property: UsageRunner/lifeCycleStartAt
  title: lifeCycleStartAt
  required: false
  readable: true
  writeable: true
  description: Start of measured period
supported property: SupportedProperty
  property: UsageRunner/lifeCycleEndAt
  title: lifeCycleEndAt
  required: false
  readable: true
  writeable: true
  description: End of measured period
supported property: SupportedProperty
  property: UsageRunner/runnerName
  title: runnerName
  required: false
  readable: true
  writeable: true
  description: Runner name
supported property: SupportedProperty
  property: UsageRunner/workflowName
  title: workflowName
  required: false
  readable: true
  writeable: true
  description: Workflow name
supported property: SupportedProperty
  property: UsageRunner/jobName
  title: jobName
  required: false
  readable: true
  writeable: true
  description: Job name
supported property: SupportedProperty
  property: UsageRunner/conclusion
  title: conclusion
  required: false
  readable: true
  writeable: true
  description: Job conclusion
supported property: SupportedProperty
  property: UsageRunner/status
  title: status
  required: false
  readable: true
  writeable: true
  description: Display status — running or finalized
supported property: SupportedProperty
  property: UsageRunner/displayDate
  title: displayDate
  required: false
  readable: true
  writeable: true
  description: UTC date this record belongs to in dashboard views (ISO YYYY-MM-DD)
supported property: SupportedProperty
  property: UsageRunner/displayQuantity
  title: displayQuantity
  required: false
  readable: true
  writeable: true
  description: Presentation quantity in seconds. Non-authoritative for running rows (computed at request time). Use quantity for billing.
supported operation: Operation
  type: FindAction
  description: Retrieves a UsageRunner resource.
  method: GET
  returns: owl:Nothing
  title: getUsageRunner
description: Runner usage records

UsageRunner/id
type: Property
domain: UsageRunner
the hydra core vocabulary: id
range: string

UsageRunner/sku
type: Property
domain: UsageRunner
the hydra core vocabulary: sku
range: string

UsageRunner/skuVersion
type: Property
domain: UsageRunner
the hydra core vocabulary: skuVersion
range: string

UsageRunner/quantity
type: Property
domain: UsageRunner
the hydra core vocabulary: quantity
range: decimal

UsageRunner/measure
type: Property
domain: UsageRunner
the hydra core vocabulary: measure

UsageRunner/lifeCycleStartAt
type: Property
domain: UsageRunner
the hydra core vocabulary: lifeCycleStartAt
range: string

UsageRunner/lifeCycleEndAt
type: Property
domain: UsageRunner
the hydra core vocabulary: lifeCycleEndAt
range: string

UsageRunner/runnerName
type: Property
domain: UsageRunner
the hydra core vocabulary: runnerName
range: string

UsageRunner/workflowName
type: Property
domain: UsageRunner
the hydra core vocabulary: workflowName
range: string

UsageRunner/jobName
type: Property
domain: UsageRunner
the hydra core vocabulary: jobName
range: string

UsageRunner/conclusion
type: Property
domain: UsageRunner
the hydra core vocabulary: conclusion
range: string

UsageRunner/status
type: Link
domain: UsageRunner
the hydra core vocabulary: status

UsageRunner/displayDate
type: Property
domain: UsageRunner
the hydra core vocabulary: displayDate
range: string

UsageRunner/displayQuantity
type: Property
domain: UsageRunner
the hydra core vocabulary: displayQuantity
range: decimal

Entrypoint
type: Class
title: Entrypoint
supported property: SupportedProperty
  property: Entrypoint/managementBillingAccount
  title: getManagementBillingAccountCollection
  description: The collection of ManagementBillingAccount resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/managementChargeback
  title: getManagementChargebackCollection
  description: The collection of ManagementChargeback resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/managementDunningQueue
  title: getManagementDunningQueueCollection
  description: The collection of ManagementDunningQueue resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/managementImpersonation
  title: getManagementImpersonationCollection
  description: The collection of ManagementImpersonation resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/managementInstallation
  title: getManagementInstallationCollection
  description: The collection of ManagementInstallation resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/managementInvoice
  title: getManagementInvoiceCollection
  description: The collection of ManagementInvoice resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/managementRefundTriage
  title: getManagementRefundTriageCollection
  description: The collection of ManagementRefundTriage resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/managementUser
  title: getManagementUserCollection
  description: The collection of ManagementUser resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/managementWebhookPayload
  title: getManagementWebhookPayloadCollection
  description: The collection of ManagementWebhookPayload resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/assignments
  title: getAssignmentsCollection
  description: The collection of Assignments resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/installations
  title: getInstallationsCollection
  description: The collection of Installations resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/installations
  title: getInstallationsCollection
  description: The collection of Installations resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/installations
  title: getInstallationsCollection
  description: The collection of Installations resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/billing
  title: getBillingCollection
  description: The collection of Billing resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/installations
  title: getInstallationsCollection
  description: The collection of Installations resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/installations
  title: getInstallationsCollection
  description: The collection of Installations resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/installations
  title: getInstallationsCollection
  description: The collection of Installations resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/installations
  title: getInstallationsCollection
  description: The collection of Installations resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/installations
  title: getInstallationsCollection
  description: The collection of Installations resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/buildRushAccount
  title: getBuildRushAccountCollection
  description: The collection of BuildRushAccount resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/cacheDashboardToken
  title: getCacheDashboardTokenCollection
  description: The collection of CacheDashboardToken resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/emailVerification
  title: getEmailVerificationCollection
  description: The collection of EmailVerification resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/gitHub
  title: getGitHubCollection
  description: The collection of GitHub resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/gitHubWebhook
  title: getGitHubWebhookCollection
  description: The collection of GitHubWebhook resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/installations
  title: getInstallationsCollection
  description: The collection of Installations resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/internal
  title: getInternalCollection
  description: The collection of Internal resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/installations
  title: getInstallationsCollection
  description: The collection of Installations resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/notifications
  title: getNotificationsCollection
  description: The collection of Notifications resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/notificationStatuses
  title: getNotificationStatusesCollection
  description: The collection of NotificationStatuses resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/billing
  title: getBillingCollection
  description: The collection of Billing resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/billing
  title: getBillingCollection
  description: The collection of Billing resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/runnerDashboardToken
  title: getRunnerDashboardTokenCollection
  description: The collection of RunnerDashboardToken resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/billing
  title: getBillingCollection
  description: The collection of Billing resources
  readable: true
  writeable: false
supported operation: Operation

Entrypoint/managementBillingAccount
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ManagementBillingAccount
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of ManagementBillingAccount resources.
  method: GET
  returns: Collection
  title: getManagementBillingAccountCollection
supported operation: Operation
  type: CreateAction
  description: Creates a ManagementBillingAccount resource.
  expects: ManagementBillingAccount
  method: POST
  returns: ManagementBillingAccount
  title: postManagementBillingAccount
supported operation: Operation
  type: CreateAction
  description: Creates a ManagementBillingAccount resource.
  expects: ManagementBillingAccount
  method: POST
  returns: ManagementBillingAccount
  title: postManagementBillingAccount
supported operation: Operation
  type: CreateAction
  description: Creates a ManagementBillingAccount resource.
  expects: ManagementBillingAccount
  method: POST
  returns: ManagementBillingAccount
  title: postManagementBillingAccount
supported operation: Operation
  type: CreateAction
  description: Creates a ManagementBillingAccount resource.
  expects: ManagementBillingAccount
  method: POST
  returns: ManagementBillingAccount
  title: postManagementBillingAccount
supported operation: Operation
  type: CreateAction
  description: Creates a ManagementBillingAccount resource.
  expects: ManagementBillingAccount
  method: POST
  returns: ManagementBillingAccount
  title: postManagementBillingAccount
supported operation: Operation
  type: CreateAction
  description: Creates a ManagementBillingAccount resource.
  expects: ManagementBillingAccount
  method: POST
  returns: ManagementBillingAccount
  title: postManagementBillingAccount

Entrypoint/managementChargeback
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ManagementChargeback
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of ManagementChargeback resources.
  method: GET
  returns: Collection
  title: getManagementChargebackCollection

Entrypoint/managementDunningQueue
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ManagementDunningQueue
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of ManagementDunningQueue resources.
  method: GET
  returns: Collection
  title: getManagementDunningQueueCollection
supported operation: Operation
  type: CreateAction
  description: Creates a ManagementDunningQueue resource.
  expects: ManagementDunningQueue
  method: POST
  returns: ManagementDunningQueue
  title: postManagementDunningQueue
supported operation: Operation
  type: CreateAction
  description: Creates a ManagementDunningQueue resource.
  expects: ManagementDunningQueue
  method: POST
  returns: ManagementDunningQueue
  title: postManagementDunningQueue
supported operation: Operation
  type: CreateAction
  description: Creates a ManagementDunningQueue resource.
  expects: ManagementDunningQueue
  method: POST
  returns: ManagementDunningQueue
  title: postManagementDunningQueue
supported operation: Operation
  type: CreateAction
  description: Creates a ManagementDunningQueue resource.
  expects: ManagementDunningQueue
  method: POST
  returns: ManagementDunningQueue
  title: postManagementDunningQueue

Entrypoint/managementImpersonation
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ManagementImpersonation
supported operation: Operation
  type: CreateAction
  description: Creates a ManagementImpersonation resource.
  expects: ManagementImpersonation
  method: POST
  returns: ManagementImpersonation
  title: postManagementImpersonation
supported operation: Operation
  type: CreateAction
  description: Creates a ManagementImpersonation resource.
  expects: ManagementImpersonation
  method: POST
  returns: ManagementImpersonation
  title: postManagementImpersonation
supported operation: Operation
  type: CreateAction
  description: Creates a ManagementImpersonation resource.
  expects: ManagementImpersonation
  method: POST
  returns: ManagementImpersonation
  title: postManagementImpersonation

Entrypoint/managementInstallation
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ManagementInstallation
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of ManagementInstallation resources.
  method: GET
  returns: Collection
  title: getManagementInstallationCollection
supported operation: Operation
  type: CreateAction
  description: Creates a ManagementInstallation resource.
  expects: owl:Nothing
  method: POST
  returns: owl:Nothing
  title: postManagementInstallation

Entrypoint/managementInvoice
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ManagementInvoice
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of ManagementInvoice resources.
  method: GET
  returns: Collection
  title: getManagementInvoiceCollection
supported operation: Operation
  type: CreateAction
  description: Creates a ManagementInvoice resource.
  expects: ManagementInvoice
  method: POST
  returns: ManagementInvoice
  title: postManagementInvoice
supported operation: Operation
  type: CreateAction
  description: Creates a ManagementInvoice resource.
  expects: ManagementInvoice
  method: POST
  returns: ManagementInvoice
  title: postManagementInvoice
supported operation: Operation
  type: CreateAction
  description: Creates a ManagementInvoice resource.
  expects: ManagementInvoice
  method: POST
  returns: ManagementInvoice
  title: postManagementInvoice
supported operation: Operation
  type: CreateAction
  description: Creates a ManagementInvoice resource.
  expects: ManagementInvoice
  method: POST
  returns: ManagementInvoice
  title: postManagementInvoice

Entrypoint/managementRefundTriage
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ManagementRefundTriage
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of ManagementRefundTriage resources.
  method: GET
  returns: Collection
  title: getManagementRefundTriageCollection
supported operation: Operation
  type: CreateAction
  description: Creates a ManagementRefundTriage resource.
  expects: ManagementRefundTriage
  method: POST
  returns: ManagementRefundTriage
  title: postManagementRefundTriage

Entrypoint/managementUser
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ManagementUser
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of ManagementUser resources.
  method: GET
  returns: Collection
  title: getManagementUserCollection

Entrypoint/managementWebhookPayload
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ManagementWebhookPayload
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of ManagementWebhookPayload resources.
  method: GET
  returns: Collection
  title: getManagementWebhookPayloadCollection
supported operation: Operation
  type: CreateAction
  description: Creates a ManagementWebhookPayload resource.
  expects: ManagementWebhookPayload
  method: POST
  returns: ManagementWebhookPayload
  title: postManagementWebhookPayload

Entrypoint/assignments
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Assignments
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Assignments resources.
  method: GET
  returns: Collection
  title: getAssignmentsCollection
supported operation: Operation
  type: CreateAction
  description: Creates a Assignments resource.
  expects: Assignments
  method: POST
  returns: Assignments
  title: postAssignments

Entrypoint/installations
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Installations
supported operation: Operation
  type: CreateAction
  description: Creates a Installations resource.
  expects: Installations
  method: POST
  returns: Installations
  title: postInstallations
range:
  equivalent class:
    on property: member
    all values from: Installations
supported operation: Operation
  type: CreateAction
  description: Creates a Installations resource.
  expects: Installations
  method: POST
  returns: Installations
  title: postInstallations
range:
  equivalent class:
    on property: member
    all values from: Installations
supported operation: Operation
  type: CreateAction
  description: Creates a Installations resource.
  expects: Installations
  method: POST
  returns: Installations
  title: postInstallations
range:
  equivalent class:
    on property: member
    all values from: Installations
supported operation: Operation
  type: CreateAction
  description: Creates a Installations resource.
  expects: Installations
  method: POST
  returns: Installations
  title: postInstallations
range:
  equivalent class:
    on property: member
    all values from: Installations
supported operation: Operation
  type: CreateAction
  description: Creates a Installations resource.
  expects: Installations
  method: POST
  returns: Installations
  title: postInstallations
range:
  equivalent class:
    on property: member
    all values from: Installations
supported operation: Operation
  type: CreateAction
  description: Creates a Installations resource.
  expects: Installations
  method: POST
  returns: Installations
  title: postInstallations
range:
  equivalent class:
    on property: member
    all values from: Installations
supported operation: Operation
  type: CreateAction
  description: Creates a Installations resource.
  expects: Installations
  method: POST
  returns: Installations
  title: postInstallations
range:
  equivalent class:
    on property: member
    all values from: Installations
supported operation: Operation
  type: CreateAction
  description: Creates a Installations resource.
  expects: Installations
  method: POST
  returns: Installations
  title: postInstallations
range:
  equivalent class:
    on property: member
    all values from: Installations
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Installations resources.
  method: GET
  returns: Collection
  title: getInstallationsCollection
supported operation: Operation
  type: CreateAction
  description: Creates a Installations resource.
  expects: Installations
  method: POST
  returns: Installations
  title: postInstallations
supported operation: Operation
  type: CreateAction
  description: Creates a Installations resource.
  expects: Installations
  method: POST
  returns: Installations
  title: postInstallations
range:
  equivalent class:
    on property: member
    all values from: Installations
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Installations resources.
  method: GET
  returns: Collection
  title: getInstallationsCollection
range:
  equivalent class:
    on property: member
    all values from: Installations
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Installations resources.
  method: GET
  returns: Collection
  title: getInstallationsCollection

Entrypoint/billing
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Billing
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Billing resources.
  method: GET
  returns: Collection
  title: getBillingCollection
supported operation: Operation
  type: CreateAction
  description: Creates a Billing resource.
  expects: Billing
  method: POST
  returns: Billing
  title: postBilling
range:
  equivalent class:
    on property: member
    all values from: Billing
supported operation: Operation
  type: CreateAction
  description: Creates a Billing resource.
  expects: Billing
  method: POST
  returns: Billing
  title: postBilling
range:
  equivalent class:
    on property: member
    all values from: Billing
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Billing resources.
  method: GET
  returns: Collection
  title: getBillingCollection
range:
  equivalent class:
    on property: member
    all values from: Billing
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Billing resources.
  method: GET
  returns: Collection
  title: getBillingCollection

Entrypoint/buildRushAccount
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: BuildRushAccount
supported operation: Operation
  type: CreateAction
  description: Creates a BuildRushAccount resource.
  expects: BuildRushAccount
  method: POST
  returns: BuildRushAccount
  title: postBuildRushAccount

Entrypoint/cacheDashboardToken
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: CacheDashboardToken
supported operation: Operation
  type: CreateAction
  description: Creates a CacheDashboardToken resource.
  expects: CacheDashboardToken
  method: POST
  returns: CacheDashboardToken
  title: postCacheDashboardToken

Entrypoint/emailVerification
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: EmailVerification
supported operation: Operation
  type: CreateAction
  description: Creates a EmailVerification resource.
  expects: EmailVerification
  method: POST
  returns: EmailVerification
  title: postEmailVerification
supported operation: Operation
  type: CreateAction
  description: Creates a EmailVerification resource.
  expects: EmailVerification
  method: POST
  returns: owl:Nothing
  title: postEmailVerification

Entrypoint/gitHub
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: GitHub
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of GitHub resources.
  method: GET
  returns: Collection
  title: getGitHubCollection

Entrypoint/gitHubWebhook
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: GitHubWebhook
supported operation: Operation
  type: CreateAction
  description: Creates a GitHubWebhook resource.
  expects: GitHubWebhook
  method: POST
  returns: GitHubWebhook
  title: postGitHubWebhook

Entrypoint/internal
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Internal
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Internal resources.
  method: GET
  returns: Collection
  title: getInternalCollection

Entrypoint/notifications
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Notifications
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Notifications resources.
  method: GET
  returns: Collection
  title: getNotificationsCollection

Entrypoint/notificationStatuses
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: NotificationStatuses
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of NotificationStatuses resources.
  method: GET
  returns: Collection
  title: getNotificationStatusesCollection
supported operation: Operation
  type: CreateAction
  description: Creates a NotificationStatuses resource.
  expects: NotificationStatuses
  method: POST
  returns: NotificationStatuses
  title: postNotificationStatuses

Entrypoint/runnerDashboardToken
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: RunnerDashboardToken
supported operation: Operation
  type: CreateAction
  description: Creates a RunnerDashboardToken resource.
  expects: RunnerDashboardToken
  method: POST
  returns: RunnerDashboardToken
  title: postRunnerDashboardToken

Entrypoint/usageRunner
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: UsageRunner
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of UsageRunner resources.
  method: GET
  returns: Collection
  title: getUsageRunnerCollection

ConstraintViolationList
type: Class
title: ConstraintViolationList
description: A constraint violation List.
supported property: SupportedProperty
  property: ConstraintViolationList/propertyPath
  title: propertyPath
  description: The property path of the violation
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolationList/message
  title: message
  description: The message associated with the violation
  readable: true
  writeable: false

ConstraintViolationList/propertyPath
type: Property
label: propertyPath
domain: ConstraintViolationList
range: string

ConstraintViolationList/message
type: Property
label: message
domain: ConstraintViolationList
range: string

SupportedProperty
property: Installations/hasAnyRunnerUsage
title: hasAnyRunnerUsage
required: false
readable: true
writeable: false
description: Whether any runner usage records exist for this installation (regardless of date filters)

SupportedProperty
property: Installations/cacheEnabled
title: cacheEnabled
required: false
readable: true
writeable: false
description: Whether the Actions Cache feature is enabled for this installation

SupportedProperty
property: Installations/runnerV2Enabled
title: runnerV2Enabled
required: false
readable: true
writeable: false
description: Whether the Runner v2 feature is enabled for this installation

SupportedProperty
property: Installations/installationHealth
title: installationHealth
required: false
readable: true
writeable: false
description: Installation health status (independent of GitHub App lifecycle status)

SupportedProperty
property: Installations/accessControl
title: accessControl
required: false
readable: true
writeable: false
description: Access control information

Operation
type: FindAction
description: Retrieves a Installations resource.
method: GET
returns: Installations
title: getInstallations

SupportedProperty
property: Installations/invoiceType
title: invoiceType
required: false
readable: true
writeable: false
description: Invoice type (cycle, upgrade_proration, credit_purchase)

SupportedProperty
property: Installations/state
title: state
required: false
readable: true
writeable: false
description: Invoice state (draft, finalized, document_issued, submitted, paid, payment_failed, cancelled, written_off)

SupportedProperty
property: Installations/periodStart
title: periodStart
required: false
readable: true
writeable: false
description: Period start

SupportedProperty
property: Installations/periodEnd
title: periodEnd
required: false
readable: true
writeable: false
description: Period end

SupportedProperty
property: Installations/netSubtotalAmount
title: netSubtotalAmount
required: false
readable: true
writeable: false
description: Net subtotal in fixed-point x10^5

SupportedProperty
property: Installations/taxAmountAmount
title: taxAmountAmount
required: false
readable: true
writeable: false
description: Tax amount in fixed-point x10^5

SupportedProperty
property: Installations/taxRate
title: taxRate
required: false
readable: true
writeable: false
description: Tax rate percentage (e.g., "19.000")

SupportedProperty
property: Installations/taxStatus
title: taxStatus
required: false
readable: true
writeable: false
description: Tax status (taxable, reverse_charged, non_taxable, exempt)

SupportedProperty
property: Installations/taxName
title: taxName
required: false
readable: true
writeable: false
description: Tax name (e.g., "VAT", "Sales tax")

SupportedProperty
property: Installations/taxCountryCode
title: taxCountryCode
required: false
readable: true
writeable: false
description: ISO 3166-1 alpha-2 country code for tax jurisdiction

SupportedProperty
property: Installations/taxProviderTransactionId
title: taxProviderTransactionId
required: false
readable: true
writeable: false
description: Tax provider transaction ID

SupportedProperty
property: Installations/taxCode
title: taxCode
required: false
readable: true
writeable: false
description: Tax code used for calculation (e.g., "eservice")

SupportedProperty
property: Installations/totalAmountAmount
title: totalAmountAmount
required: false
readable: true
writeable: false
description: Total amount in fixed-point x10^5

SupportedProperty
property: Installations/invoiceDate
title: invoiceDate
required: false
readable: true
writeable: false
description: Invoice date (purchase or cycle start)

SupportedProperty
property: Installations/paidAt
title: paidAt
required: false
readable: true
writeable: false
description: When invoice was paid

SupportedProperty
property: Installations/paymentInFlightAt
title: paymentInFlightAt
required: false
readable: true
writeable: false
description: When payment entered in-flight state (SEPA pending clearance)

SupportedProperty
property: Installations/lineItems
title: lineItems
required: false
readable: true
writeable: false
description: Invoice line items

SupportedProperty
property: Installations/providerInvoiceUrl
title: providerInvoiceUrl
required: false
readable: true
writeable: false
description: Provider invoice URL

SupportedProperty
property: Installations/providerPdfUrl
title: providerPdfUrl
required: false
readable: true
writeable: false
description: Provider invoice PDF URL

SupportedProperty
property: Installations/documentProviderVoucherNumber
title: documentProviderVoucherNumber
required: false
readable: true
writeable: false
description: Sequential invoice number assigned by the document provider (GoBD)

SupportedProperty
property: Installations/createdAt
title: createdAt
required: false
readable: true
writeable: false
description: Creation timestamp

Operation
type: FindAction
description: Retrieves a Installations resource.
method: GET
returns: Installations
title: getInstallations

Operation
type: FindAction
description: Retrieves a Installations resource.
method: GET
returns: Installations
title: getInstallations

SupportedProperty
property: Installations/planSlug
title: planSlug
required: false
readable: true
writeable: false
description: Current plan slug

SupportedProperty
property: Installations/planName
title: planName
required: false
readable: true
writeable: false
description: Current plan display name

SupportedProperty
property: Installations/state
title: state
required: false
readable: true
writeable: false
description: Subscription state (none, pending_payment, active, pending_renewal, change_scheduled, cancellation_scheduled). pending_payment is a transient state used during initial subscribe and upgrade flows while the first payment is being collected. pending_renewal is a transient state during automated cycle renewal while the mandate-driven charge is in flight; it clears back to active once the renewal invoice is paid.

SupportedProperty
property: Installations/cycleStart
title: cycleStart
required: false
readable: true
writeable: false
description: Current billing cycle start

SupportedProperty
property: Installations/cycleEnd
title: cycleEnd
required: false
readable: true
writeable: false
description: Current billing cycle end

SupportedProperty
property: Installations/pendingPlanSlug
title: pendingPlanSlug
required: false
readable: true
writeable: false
description: Pending plan slug (for scheduled downgrade)

SupportedProperty
property: Installations/pendingPlanName
title: pendingPlanName
required: false
readable: true
writeable: false
description: Pending plan display name

SupportedProperty
property: Installations/cancelledAt
title: cancelledAt
required: false
readable: true
writeable: false
description: When cancellation was scheduled

SupportedProperty
property: Installations/currentBalance
title: currentBalance
required: false
readable: true
writeable: false
description: Current credit balance in fixed-point x10^5

Operation
type: FindAction
description: Retrieves a Installations resource.
method: GET
returns: Installations
title: getInstallations

SupportedProperty
property: Billing/name
title: name
required: false
readable: true
writeable: false
description: Country display name

SupportedProperty
property: Billing/regions
title: regions
required: false
readable: true
writeable: false
description: Sub-national regions (empty for countries without sub-national tax jurisdictions)

Operation
type: FindAction
description: Retrieves a Billing resource.
method: GET
returns: owl:Nothing
title: getBilling

SupportedProperty
property: Installations/entryType
title: entryType
required: false
readable: true
writeable: true
description: Entry type

SupportedProperty
property: Installations/amountAmount
title: amountAmount
required: false
readable: true
writeable: true
description: Credit amount change in fixed-point x10^5

SupportedProperty
property: Installations/balanceAfterAmount
title: balanceAfterAmount
required: false
readable: true
writeable: true
description: Balance after this transaction in fixed-point x10^5

SupportedProperty
property: Installations/createdAt
title: createdAt
required: false
readable: true
writeable: true
description: Transaction timestamp

SupportedProperty
property: Installations/referenceType
title: referenceType
required: false
readable: true
writeable: true
description: Reference type (e.g. sku_billing, credit_claim)

SupportedProperty
property: Installations/initiatorAvatarUrl
title: initiatorAvatarUrl
required: false
readable: true
writeable: true
description: Initiator avatar URL

SupportedProperty
property: Installations/costAmount
title: costAmount
required: false
readable: true
writeable: true
description: Gross cost before discount in fixed-point x10^5

SupportedProperty
property: Installations/planName
title: planName
required: false
readable: true
writeable: true
description: Plan name snapshotted at job-dispatch time (e.g. "Starter", "Professional"). The value is captured when the runner SKU is dispatched and carried forward to the billing record, so it reflects the plan in force when the work began — not necessarily the plan in force when the entry was finalized. Null for non-usage entries and for usage entries whose dispatch-time plan is no longer recoverable.

SupportedProperty
property: Installations/discountRate
title: discountRate
required: false
readable: true
writeable: true
description: Discount percentage (e.g. 20 for 20%)

SupportedProperty
property: Installations/savingsAmount
title: savingsAmount
required: false
readable: true
writeable: true
description: Savings from discount in fixed-point x10^5

SupportedProperty
property: Installations/skuName
title: skuName
required: false
readable: true
writeable: true
description: SKU catalog name

SupportedProperty
property: Installations/expiredGrant
title: expiredGrant
required: false
readable: true
writeable: true
description: Provenance of the MONTHLY_INCLUDED_CREDIT grant this credit_expiration row offset. Null on non-expiration entries.

Operation
type: FindAction
description: Retrieves a Installations resource.
method: GET
returns: owl:Nothing
title: getInstallations

SupportedProperty
property: Entrypoint/installations
title: getInstallationsCollection
description: The collection of Installations resources
readable: true
writeable: false

SupportedProperty
property: Entrypoint/usageRunner
title: getUsageRunnerCollection
description: The collection of UsageRunner resources
readable: true
writeable: false

Operation
method: GET
title: index
description: The API Entrypoint.
returns: Entrypoint