Billing

Queries billing periods accessible to the current customer.

Changed on

The has_billables filter selects periods by whether they have anything to invoice — billable response cost, a manual charge, or an external-service charge. It is not applied unless requested.

get/billing-periods

Request

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

Query parameters

pageinteger

The 1-based page index.

page_sizeinteger

The number of items per page.

sortstring[]

Sort fields. Prefix with - for descending order (e.g. -created_at).

eqstring
neqstring
gtstring
gtestring
ltstring
ltestring
containsstring
starts_withstring
ends_withstring
instring[]
not_containsstring

Filter by status.

eqstring
neqstring
gtstring
gtestring
ltstring
ltestring
containsstring
starts_withstring
ends_withstring
instring[]
not_containsstring

Filter by organization_id.

eqstring
neqstring
gtstring
gtestring
ltstring
ltestring
containsstring
starts_withstring
ends_withstring
instring[]
not_containsstring

Filter by start_date.

eqstring
neqstring
gtstring
gtestring
ltstring
ltestring
containsstring
starts_withstring
ends_withstring
instring[]
not_containsstring

Filter by end_date.

eqstring
neqstring
gtstring
gtestring
ltstring
ltestring
containsstring
starts_withstring
ends_withstring
instring[]
not_containsstring

Filter by has_billables.

eqstring
neqstring
gtstring
gtestring
ltstring
ltestring
containsstring
starts_withstring
ends_withstring
instring[]
not_containsstring

Filter by net_invoiceable_amount.

eqstring
neqstring
gtstring
gtestring
ltstring
ltestring
containsstring
starts_withstring
ends_withstring
instring[]
not_containsstring

Filter by settled_at.

logic'and' | 'or'

How to combine the field filters: "and" (default) requires every filter to match, "or" requires any of them to match.

Response

OK

totalinteger required
pageinteger required
pageSizeinteger required
totalPagesinteger

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

    • info

      added the new optional query request parameter net_invoiceable_amount

    • info

      added the new optional query request parameter settled_at

    • info

      added the enum value -net_invoiceable_amount to the property items/ of the query request parameter sort

    • info

      added the enum value -settled_at to the property items/ of the query request parameter sort

    • info

      added the enum value net_invoiceable_amount to the property items/ of the query request parameter sort

    • info

      added the enum value settled_at to the property items/ of the query request parameter sort

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property // to the response with the status