Skip to content
Leadtime
English
EnglishDeutschNot translated
Esc
↑↓navigate↵open⌘Jpreview

Get project billing settings

What are Project Billing Settings? Project billing settings define how invoices are created and structured for a specific project. These settings control invoice formatting, billing rules, default recipients, and support contingent (retainer) configurations.

What data is returned:

  • Invoice structure settings: Whether to combine support and subscription invoices or split them separately
  • Billing rules: Whether bug tasks are billable
  • Default invoice recipient: The contact person from the customer organization who receives invoices
  • Support contingent (retainer) configuration: Monthly hour packages at fixed prices for recurring support/maintenance services
  • Billing version snapshots: Project versions used as the basis for invoicing (Single projects only)

Support Contingents (Retainers): Support contingents allow you to allocate monthly hour packages at a fixed price. They are perfect for recurring support, maintenance, or service tasks and get suggested automatically in invoice review. Unused hours can optionally be carried over to subsequent months.

Billing Versions: For Single projects, you can select which project version snapshot will be used as the basis for billing. This includes components, manual items, and products as agreed in that version. You can also optionally select a separate subscription billing version for products with recurring payments.

Permission requirements: Requires Projects.seeAnyProject permission to view billing settings.

GET/projects/{id}/billing-settings
Authorization
AuthorizationOAuth2 access token · headerrequired
Scopes:api:read
or
AuthorizationBearer token (JWT) · headerrequired
Path parameters
idstring<uuid>required

Project ID

Responses
200

Project billing settings retrieved successfully

allowMixedBillingbooleanrequired

Controls invoice structure: true = combined invoices (support and subscriptions on one invoice), false = split invoices (support invoices generated separately). Combined invoices bill support efforts by booked hours and subscriptions together. Split invoices generate separate invoices for each billing type.

billingProjectSnapshotIdobject | nullrequired

Project version snapshot ID used as the basis for main billing. This version includes components, manual items, and products as agreed with the customer. Only applicable for Single project type. The selected version determines what items and prices are included when generating invoices for the project.

bugsAreBillablebooleanrequired

Determines whether time spent on tasks with "Bug" activity type can be billed to the customer. When true, bug tasks are included in billable hours. When false, bug tasks are excluded from billing calculations.

idstringrequired

Unique identifier for the project. Format: UUID v4.

includeComponentsInBillingbooleanrequired

When true, component hours and amounts are included in estimates and invoices. When false, component totals are excluded from billing calculations.

invoiceContactIdobject | nullrequired

Default invoice recipient contact person from the customer organization. This is the OrganizationMember ID who will receive invoices. This person is auto-filled when creating invoices but can be changed during invoice creation. Set to null if no default recipient is configured.

productsBillingProjectSnapshotIdobject | nullrequired

Project version snapshot ID used for billing subscriptions independently of the main project scope. This allows products with recurring payments to be billed separately using a different version snapshot. Only applicable for Single project type. If not set, the main billing version (billingProjectSnapshotId) is used automatically for subscriptions.

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

404

Project not found or user does not have access

Try it
Server
Authorization
Parameters
Request
curl -X GET "https://leadtime.app/api/public/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/billing-settings" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Response
{
  "allowMixedBilling": true,
  "billingProjectSnapshotId": "123e4567-e89b-12d3-a456-426614174002",
  "bugsAreBillable": true,
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "includeComponentsInBilling": true,
  "invoiceContactId": "123e4567-e89b-12d3-a456-426614174001",
  "productsBillingProjectSnapshotId": "123e4567-e89b-12d3-a456-426614174003"
}