Plans 🛒
This page details all the endpoints required to create a plan for a list of devices and fetch plans created.
Last updated
This page details all the endpoints required to create a plan for a list of devices and fetch plans created.
Last updated
GET https://api.getgamp.com/v1/plan/pricing/check
Fetch the pricing for the plan to be purchased
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
POST https://api.getgamp.com/v1/plan/create
Create a new plan
GET https://api.getgamp.com/v1/plan/:reference
Fetch a plan
GET https://api.getgamp.com/v1/plan
Fetch a list of plans
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
product*
String
The type of product to be purchased. Available products include "device_protection_plan" and "screen_protection_plan"
deviceType*
String
"phone" or "laptop". Kindly note that tablets are still classified under phones.
duration*
String
"6" or "12" months
numOfDevices
String
Number of devices to be protected
Authorization*
String
Set value to Bearer SECRET_KEY
Authorization*
String
Set value to Bearer SECRET_KEY
product*
String
The type of product being purchased. Available products include "device_protection_plan". "screen_protection_plan" will be deprecated.
planType*
String
This refers to available tiers of the products. Available plan types include "basic", "premium" and "custom"
deviceType
String
The type of device being protected. It can be set as either 'phone' or 'laptop'.
duration*
Number
The duration of the plan in months. Accepted durations include 6 & 12
metadata
Object
JSON object of custom data. The custom data can be determined by the developer and will be available on the plan document/instance for reference.
customer*
Object
JSON object of customer data containing the customer's email and phoneNumber keys.
uniqueDeviceNumber
String
The IMEI/Serial number of device to be covered by the plan
pricePerDevice
String
The price per 6 months protection that the user needs to pay to access X10 of coverage through custom protection. It is needed for creating custom (flexible) protection plans.
notifyCustomer
Boolean
true if you want your customers to receive sms notifications from gamp and false if not.
reference*
String
The reference linked to the plan
Authorization*
String
Set value to Bearer SECRET_KEY
reference
String
The reference you specified or we assigned to the plan
planId
String
The ID we assigned to the plan.
cuid
String
The unique ID you specified for or we assigned to the customer's profile
String
The user's email address
product
String
"device_protection_plan" or "screen_protection_plan"
planType*
String
"basic" or "premium" or "custom"
Authorization*
String
Set value to Bearer SECRET_KEY