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

    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.

Responses

  • • 200

    OK

    Hide response attributes Show response attributes object
    • billing_periods array[object]
      Hide billing_periods attributes Show billing_periods attributes
      • 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}$.

      • date_created string(date-time) | null

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

      • date_updated string(date-time) | null

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

      • end_time string(date-time) | null

        The end time of the Billing Period

      • period_type string | null

        The type of the Billing Period

        Values are ready or active.

      • 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}$.

      • 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

    • meta object
      Hide meta attributes Show meta attributes
GET /v1/Sims/{SimSid}/BillingPeriods 
curl \
 -X GET https://supersim.twilio.com/v1/Sims/{SimSid}/BillingPeriods \
 --user "username:password"
Response examples (200) 
{
  "billing_periods": [
    {
      "account_sid": "string",
      "date_created": "2023-05-04T09:42:00+00:00",
      "date_updated": "2023-05-04T09:42:00+00:00",
      "end_time": "2023-05-04T09:42:00+00:00",
      "period_type": "ready",
      "sid": "string",
      "sim_sid": "string",
      "start_time": "2023-05-04T09:42:00+00:00"
    }
  ],
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  }
}