Retrieve a list of Billing Periods for a Super SIM.

GET /v1/Sims/{SimSid}/BillingPeriods

Billing Period for an IoT Super SIM

Retrieve a list of Billing Periods for a Super SIM.

Path parameters

  • SimSid string Required

    The SID of the Super SIM to list Billing Periods for.

Query parameters

  • PageSize integer(int64)

    How many resources to return in each list page. The default is 50, and the maximum is 1000.

    Minimum value is 1, maximum value is 1000.

  • Page integer

    The page index. This value is simply for client state.

    Minimum value is 0.

  • PageToken string

    The page token. This is provided by the API.

Responses

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • billing_periods array[object]
      Hide billing_periods attributes Show billing_periods attributes object
      • sid string | null

        The SID of the Billing Period.

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^HB[0-9a-fA-F]{32}$.

      • account_sid string | null

        The SID of the Account the Super SIM belongs to.

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

      • sim_sid string | null

        The SID of the Super SIM the Billing Period belongs to.

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^HS[0-9a-fA-F]{32}$.

      • start_time string(date-time) | null

        The start time of the Billing Period specified in ISO 8601 format.

      • end_time string(date-time) | null

        The end time of the Billing Period specified in ISO 8601 format.

      • period_type string

        The type of Billing Period. Can be ready or active.

        Values are ready or active.

      • date_created string(date-time) | null

        The date and time in GMT when the resource was created specified in ISO 8601 format.

      • date_updated string(date-time) | null

        The date and time in GMT when the resource was last updated specified in ISO 8601 format.

    • meta object
      Hide meta attributes Show meta attributes object
      • first_page_url string(uri)
      • key string
      • next_page_url string(uri) | null
      • page integer
      • page_size integer
      • previous_page_url string(uri) | null
      • url string(uri)
GET /v1/Sims/{SimSid}/BillingPeriods
curl \
 --request GET 'https://supersim.twilio.com/v1/Sims/{SimSid}/BillingPeriods' \
 --user "username:password"
{
  "meta": {
    "key": "billing_periods",
    "url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods?PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods?PageSize=50&Page=0",
    "previous_page_url": null
  },
  "billing_periods": []
}
{
  "meta": {
    "key": "billing_periods",
    "url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods?PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods?PageSize=50&Page=0",
    "previous_page_url": null
  },
  "billing_periods": [
    {
      "sid": "HBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "end_time": "2021-07-09T13:18:15Z",
      "start_time": "2021-06-09T13:18:15Z",
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "period_type": "active",
      "date_created": "2021-06-09T13:18:16Z",
      "date_updated": "2021-06-09T13:18:16Z"
    }
  ]
}
{
  "meta": {
    "key": "billing_periods",
    "url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods?PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods?PageSize=50&Page=0",
    "previous_page_url": null
  },
  "billing_periods": [
    {
      "sid": "HBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "end_time": "2021-07-09T13:18:15Z",
      "start_time": "2021-06-09T13:18:15Z",
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "period_type": "ready",
      "date_created": "2021-06-09T13:18:16Z",
      "date_updated": "2021-06-09T13:18:16Z"
    }
  ]
}