Sign in
OpenAPI 3.0.42026-08-13351856967.1 KB

d779de93a5ee

Billing

Gets the overview for a billing period by its ID.

Set includeNonBillable to also report the period's non-billable cost. The existing totals stay billable-only; the non-billable amounts are reported in their own fields.

get/billing-period/{billingPeriodId}

Path parameters

billingPeriodIdstring required

The ID of the billing period to retrieve.

Query parameters

includeNonBillableboolean

Whether to also report non-billable cost.

Response

OK

idstring required

The billing period ID.

organizationIdstring required

The organization the billing period belongs to.

startDatestring date-time required

The start date of the billing period.

endDatestring date-time required

The end date of the billing period.

status'Open' | 'Invoiced' | 'Void' | 'Reconciling' required
totalGrossCostnumber double required

The total gross cost before discounts.

totalDiscountnumber double required

The total discount amount.

totalNetCostnumber double required

The total net cost after discounts.

totalResponseCountinteger required

The total number of billable responses.

totalNonBillableCostnumber double nullable

The gross cost of the period's non-billable activity, if it was requested.

totalNonBillableResponseCountinteger nullable

The total number of non-billable responses, if it was requested.