ConnectSession

Name
object
Type
string
Description
Type of object is always connectSession.
Allowed values: connectSession
Name
id
Type
string
Description
Unique identifier for the Connect Session.
Example: "csn_0SNlurA049MEWV1GWxpaE5D0t2D6"
Name
appearance
Type
Appearance
Description
Name
theme
Type
string
Description
The theme setting that will influence the visual appearance during the Connect Session.
Optional: This property may not always be included.
Example: "light"
Allowed values: light dark
Name
callbackUrl
Type
nullable string
Description
The URL to which the user will be redirected after the Connect Session is completed.
Example: "https://example.com"
Name
intent
Type
Intent
Description
Name
url
Type
nullable string
Description
The session URL. Redirect your users to this URL to take them to Connect. It is only present on all create responses or in the update responses that associate the session with a user. It should not be stored, logged or exposed to anyone other than the user.
Example: "https://connect.gigs.com/checkout/entry?session=csn_0SNlurA049MEWV1GWxpaE5D0t2D6&token=lzODbEyaUQjVRAmalD4pdaq5Nkn1Lw0qTL6Rdsh7PwLVES6N7ImWxnCYbJA99AXp"
Name
user
Type
nullable string
Description
The unique identifier of the user that the session is for.
Example: "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"

ConnectSession object

{
  "object": "connectSession",
  "id": "csn_0SNlurA049MEWV1GWxpaE5D0t2D6",
  "appearance": {
    "theme": "light"
  },
  "callbackUrl": "https://example.com",
  "intent": {
    "browseDataPackages": {
      "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
    },
    "cancelSubscription": {
      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
    },
    "changeSubscription": {
      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
    },
    "checkoutAddon": {
      "addons": [
        "add_0SNlurA049MEWV4VxLfwJc7PJtHc"
      ],
      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
    },
    "checkoutNewSubscription": {
      "device": "dev_0SNlurA049MEWV55CrA9qMvI2FVJ",
      "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
      "sim": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
      "imei": "492388841798923",
      "voucherCode": "PROMO10"
    },
    "completePorting": {
      "behavior": {
        "hideIntroPage": true,
        "hideOutroPage": true
      },
      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
    },
    "confirmPayment": {
      "payment": "pay_0SNlurA049MEWV2HRA0slWFuS8DV"
    },
    "evergreenRoaming": {
      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
      "entryPoint": "browseDataPackages"
    },
    "manageDataPackages": {
      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
    },
    "replaceSim": {
      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
    },
    "requestSupport": {
      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
    },
    "resumeSubscription": {
      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
    },
    "type": "browseDataPackages",
    "viewEsimInstallation": {
      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
      "entryPoint": "manual"
    },
    "viewSubscription": {
      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
    }
  },
  "url": "https://connect.gigs.com/checkout/entry?session=csn_0SNlurA049MEWV1GWxpaE5D0t2D6&token=lzODbEyaUQjVRAmalD4pdaq5Nkn1Lw0qTL6Rdsh7PwLVES6N7ImWxnCYbJA99AXp",
  "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
}