Billing Plans V1

Billing plan operations

Get all 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]
Array of strings

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

Response Schema: application/json
Array of objects (BillingPlan)
object (Metadata)
401

Authentication error

Response Schema: application/json
Array of objects (Error Base)
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

Response Schema: application/json
Array of objects (Error Base)
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.

get/wireless/billing_plans
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      • "data_allocation_per_sim": 0,
      • "default": true,
      • "inserted_at": "string",
      • "name": "string",
      • "regions": [
        • "string"
        ],
      • "type": "string",
      • "updated_at": "string"
      }
    ],
  • "metadata": {
    • "total_pages": 13,
    • "total_results": 13,
    • "page_number": 3,
    • "page_size": 1
    }
}
Create billing plan
Creates a new billing plan. The billing plan name must be unique.


Request 
Request Body schema: application/json
required
Create 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


 
name
string
The name of the billing plan


 
regions
Array of strings
The regions for which this billing plan applies


 
type
string
The type of billing plan


 
Responses 
200
Successful response


Response Schema: application/json
object (BillingPlan) 
 
id
string <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
Array of strings
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


 
401
Authentication error


Response Schema: application/json
Array of objects (Error Base) 
 
 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


Response Schema: application/json
Array of objects (Error Base) 
 
 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.


 
post/wireless/billing_plans
Request samples 
application/json
{
  • "data_allocation_per_sim": 0,
  • "default": true,
  • "name": "string",
  • "regions": [
    • "string"
    ],
  • "type": "string"
}
Response samples 
application/json
{
  • "data": {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "data_allocation_per_sim": 0,
    • "default": true,
    • "inserted_at": "string",
    • "name": "string",
    • "regions": [
      • "string"
      ],
    • "type": "string",
    • "updated_at": "string"
    }
}
Get billing plan
Returns the details regarding a specific SIM card.


Request 
path Parameters
id
required
string <uuid> 
The unique identifier of the billing plan


 
Responses 
200
Successful response


Response Schema: application/json
object (BillingPlan) 
 
id
string <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
Array of strings
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


 
401
Authentication error


Response Schema: application/json
Array of objects (Error Base) 
 
 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


Response Schema: application/json
Array of objects (Error Base) 
 
 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.


 
get/wireless/billing_plans/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "data_allocation_per_sim": 0,
    • "default": true,
    • "inserted_at": "string",
    • "name": "string",
    • "regions": [
      • "string"
      ],
    • "type": "string",
    • "updated_at": "string"
    }
}
Update billing plan
Updates a specific billing plan.


Request 
path Parameters
id
required
string <uuid> 
The unique identifier of the billing plan


 
Request Body schema: application/json
required
Billing plan update request


data_allocation_per_sim
integer
How much data can each SIM card consume


 
default
boolean
Is the billing plan the default billing plan


 
name
string
The name of the billing plan


 
regions
Array of strings
The regions for which this billing plan applies


 
type
string
The type of billing plan


 
Responses 
200
Successful response


Response Schema: application/json
object (BillingPlan) 
 
id
string <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
Array of strings
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


 
401
Authentication error


Response Schema: application/json
Array of objects (Error Base) 
 
 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


Response Schema: application/json
Array of objects (Error Base) 
 
 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.


 
patch/wireless/billing_plans/{id}
Request samples 
application/json
{
  • "data_allocation_per_sim": 0,
  • "default": true,
  • "name": "string",
  • "regions": [
    • "string"
    ],
  • "type": "string"
}
Response samples 
application/json
{
  • "data": {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "data_allocation_per_sim": 0,
    • "default": true,
    • "inserted_at": "string",
    • "name": "string",
    • "regions": [
      • "string"
      ],
    • "type": "string",
    • "updated_at": "string"
    }
}
Delete billing plan
If the provided billing plan is not the default billing plan and is not associated with any SIM card groups, it will be deleted.


Request 
path Parameters
id
required
string <uuid> 
The unique identifier of the billing plan


 
Responses 
200
Successful response


Response Schema: application/json
object (BillingPlan) 
 
id
string <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
Array of strings
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


 
401
Authentication error


Response Schema: application/json
Array of objects (Error Base) 
 
 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


Response Schema: application/json
Array of objects (Error Base) 
 
 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.


 
delete/wireless/billing_plans/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "data_allocation_per_sim": 0,
    • "default": true,
    • "inserted_at": "string",
    • "name": "string",
    • "regions": [
      • "string"
      ],
    • "type": "string",
    • "updated_at": "string"
    }
}