Skip to main content

Get all billing plans

GET 

/wireless/billing_plans

Returns a list of all your billing plans

Request

Query Parameters

    include_sim_card_groups boolean

    Specifies whether the SIM card groups be included in the result payload.

    filter[name] string

    Filter billing plan based by name.

    filter[regions] string[]

    Filter billing plans by supported regions.

    page[number] number

    Current page based on pagination settings.

    page[size] number

    Number of results to return per page based on pagination settings.

Responses

200: Successful response

Schema

    data

    object[]

  • Array [

  • id uuid

    The id of the billing plan

    data_allocation_per_sim integer

    How much data can each SIM card consume

    default boolean

    Is the billing plan the default billing plan

    inserted_at string

    When was the billing plan created

    name string

    The name of the billing plan

    regions string[]

    The regions for which this billing plan applies

    type string

    The type of billing plan

    updated_at string

    When was the billing plan last updated

  • ]

  • metadata

    object

    total_pages double

    Total number of pages based on pagination settings

    total_results double

    Total number of results

    page_number double

    Current Page based on pagination settings (included when defaults are used.)

    page_size double

    Number of results to return per page based on pagination settings (included when defaults are used.)

401: Authentication error

Schema

    errors

    object[]

  • Array [

  • code string

    an application-specific error code, expressed as a stringified integer.

    title string

    a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.

    detail string

    a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

    pointer string

    JSON pointer to the field which is causing the error.

  • ]

403: Authorization error

Schema

    errors

    object[]

  • Array [

  • code string

    an application-specific error code, expressed as a stringified integer.

    title string

    a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.

    detail string

    a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

    pointer string

    JSON pointer to the field which is causing the error.

  • ]

Loading...