Sign in
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' | 'PendingReview' | 'Closed' 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.

netInvoiceableAmountnumber double nullable

What an invoice for this period would charge, as of the last settlement: usage net of discounts plus charges, minus the voucher coverage already booked. Null until the period has been settled.

voucherCoveragenumber double nullable

How much of the period's billable usage vouchers absorbed at the last settlement.

settlementCurrencystring nullable

The currency the settlement amounts are denominated in.

settledAtstring date-time nullable

When the period was last settled.

settlementStaleboolean required

Whether a billing input changed after the settlement amounts were computed, so they are awaiting a recompute.

closedBystring nullable

The operator who closed the period without invoicing it. Null when the period closed on its own because nothing was left to invoice.

closeReasonstring nullable

Why the period was closed without being invoiced.

closedAtstring date-time nullable

When the period was closed without being invoiced.

Changes

Changed in 3 of the 6 revisions of this API.216

  • 5f993bd211f53See the full diff
    • ○

      added the optional property closeReason to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property closedAt to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property closedBy to the response with the 200 status

      response-optional-property-added

  • fdb89a6eb2fb25See the full diff
    • ●

      added the new Closed enum value to the status/allOf[BillingPeriodStatus]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new PendingReview enum value to the status/allOf[BillingPeriodStatus]/ response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property netInvoiceableAmount to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property settledAt to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property settlementCurrency to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property voucherCoverage to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property settlementStale to the response with the 200 status

      response-required-property-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d779de93a5ee8See the full diff
    • ○

      added the new optional query request parameter includeNonBillable

      new-optional-request-parameter

    • ○

      added the optional property totalNonBillableCost to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property totalNonBillableResponseCount to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property lineItems/allOf[subschema #1]/items/oneOf[ILineItemOtherCharge]/quantity to the response with the 200 status

      response-required-property-added

    • ○

      added the required property lineItems/allOf[subschema #1]/items/oneOf[ILineItemOtherCharge]/unitPrice to the response with the 200 status

      response-required-property-added

    • ○

      added the required property lineItems/allOf[subschema #1]/items/oneOf[ILineItemRefund]/quantity to the response with the 200 status

      response-required-property-added

    • ○

      added the required property lineItems/allOf[subschema #1]/items/oneOf[ILineItemRefund]/unitPrice to the response with the 200 status

      response-required-property-added

    • ○

      added the required property organizationId to the response with the 200 status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog