AXaxilioai
Billing

List billing history

Changed on

Paginated invoice history for the caller's organization with optional filters and sort.

get/billing/history

Request

Query parameters

limitinteger

max items per page

offsetinteger

pagination offset

searchstring

free-text search across invoice number/description

billing_cycle'daily' | 'weekly' | 'monthly' | 'yearly'

filter by billing cycle

status'paid' | 'pending' | 'failed' | 'void'

only invoices at this status

invoiced_afterstring date-time

only invoices created at/after this time (RFC 3339)

invoiced_beforestring date-time

only invoices created at/before this time (RFC 3339; with invoiced_after, an exact calendar month)

plan_namestring

filter by plan name

phone_idstring

filter to invoices for a dedicated phone

order_bystring

Sort expression '<field> [asc|desc]', direction defaulting to desc; field is invoiced_at, amount_microdollars, status, plan_name, invoice_number or paid_at.

Response

OK

limitinteger required

Page size used for this response.

offsetinteger required

Pagination offset used for this response.

totalinteger required

Total number of invoices matching the query.

Changes

  • ecca093572e0Revision changes
    • breaking

      the query request parameter billing_cycle was restricted to a list of enum values

    • breaking

      the query request parameter status was restricted to a list of enum values

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • warning

      deleted the query request parameter date_from

    • warning

      deleted the query request parameter date_to

    • warning

      deleted the query request parameter sort_by

    • warning

      deleted the query request parameter sort_order

    • warning

      removed the optional property // from the response with the status

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • info

      added the new optional query request parameter invoiced_after

    • info

      added the new optional query request parameter invoiced_before

    • info

      added the new optional query request parameter order_by

    • info

      added the new enum value daily to the query request parameter billing_cycle

    • info

      added the new enum value failed to the query request parameter status

    • info

      added the new enum value monthly to the query request parameter billing_cycle

    • info

      added the new enum value paid to the query request parameter status

    • info

      added the new enum value pending to the query request parameter status

    • info

      added the new enum value void to the query request parameter status

    • info

      added the new enum value weekly to the query request parameter billing_cycle

    • info

      added the new enum value yearly to the query request parameter billing_cycle

    • info

      added the non-success response with the status

    • info

      added the non-success 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

    • info

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

    • info

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

  • 261c340a3f6dRevision changes
    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • info

      the endpoint scheme security bearerAuth was removed from the API

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status