Billing

Gets the overview for the active billing period.

Changed on
get/billing-period/active

Request

  • Base URL
    https://api.rapidata.ai
  • URL
    https://api.rapidata.ai/billing-period/active
  • Auth
    OpenID Connect (https://auth.rapidata.ai/.well-known/openid-configuration, scopes: openid, profile, email, offline_access, api)

Query parameters

organizationIdstring

Optional organization id. Staff can specify any organization; others see their own.

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.

Changes

  • 9da534659e5fRevision changes
    • info

      the security scope api was added to the endpoint's security scheme OpenIdConnect

  • fdb89a6eb2fbRevision changes
    • warning

      added the new Closed enum value to the //// response property for the response status

    • warning

      added the new PendingReview enum value to the //// response property for the response status