AXaxilioai
Billing

List phone rentals

Changed on

Returns one page of the caller organization's phone rental subscriptions, in any lifecycle state unless status filters it (canceled rentals stay listed so past rentals remain visible). Filter by search, status, plan_interval, cancel_at_period_end, payment_status and a current_period_end_after/current_period_end_before window; order with order_by ('<field> <asc|desc>'). The summary block (active_count, combined monthly cost, per-interval breakdown, upcoming charges) covers every active rental and ignores the filters.

get/billing/phone-rental-subscriptions

Request

Query parameters

limitinteger

max items per page

offsetinteger

pagination offset

searchstring

only rentals whose phone name or nickname contains this text

statusstring[] nullable

only rentals at one of these lifecycle statuses; repeatable. Omit for every status.

plan_intervalstring[] nullable

only rentals on one of these plan intervals; repeatable

cancel_at_period_end'true' | 'false'

true for rentals set to cancel at period end, false for renewing ones

payment_statusstring[] nullable

only rentals in one of these billing states; repeatable

current_period_end_afterstring date-time

only rentals whose current period ends at or after this time (RFC 3339)

current_period_end_beforestring date-time

only rentals whose current period ends at or before this time (RFC 3339)

order_bystring

Sort expression '<field> [asc|desc]', direction defaulting to desc; field is phone_name, current_period_end_at, plan_interval or plan_price_microdollars. Defaults to current_period_end_at asc.

Response

OK

totalinteger required

Count of rentals matching the request (for pagination; has_more is derivable as offset+len(subscriptions) < total).

Changes

  • ecca093572e0Revision changes
    • 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

    • 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

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • info

      added the new optional query request parameter cancel_at_period_end

    • info

      added the new optional query request parameter current_period_end_after

    • info

      added the new optional query request parameter current_period_end_before

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter offset

    • info

      added the new optional query request parameter order_by

    • info

      added the new optional query request parameter payment_status

    • info

      added the new optional query request parameter plan_interval

    • info

      added the new optional query request parameter search

    • info

      added the new optional query request parameter status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

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

    • 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

    • info

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

  • 261c340a3f6dRevision changes
    • breaking

      removed the required property from the response with the status

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • info

      the endpoint scheme security bearerAuth was removed from the API