PortOut

Preview

This schema is currently in preview and might change in the future.

We’re excited to hear your feedback and ideas. Please send an email to support@gigs.com to share your thoughts.

Port out is required when a user wants to keep their number when cancelling their subscription. There are multiple steps involved between the user, the current carrier, and the new carrier.

  • Name
    object
    Type
    string
    Description

    Type of object is always portOut.

    Allowed values: portOut 
  • Name
    id
    Type
    string
    Description

    Unique identifier for the port out.

    Example: "pto_0SNlurA049MEWV4DWEaT4SaeDI8s"
  • Name
    behavior
    Type
    string
    Description

    The behavior of the port out.

    A value of portOut indicates that using this port out will transfer the phone number to the recipient provider.

    Port out with behavior cancelOnly will cancel the service without transferring the number. This behavior is currently only available for local plans in the United Kingdom.

    Example: "portOut"
    Allowed values: cancelOnly portOut 
  • Name
    createdAt
    Type
    string
    Description

    Time when the port out was created.

    Example: "2020-01-01T00:00:00Z"
  • Name
    expiredAt
    Type
    nullable string
    Description

    Time when the port out expires and won't be valid anymore.

    Example: "2022-02-21T19:38:34Z"
  • Name
    failureReason
    Type
    nullable string
    Description

    The reason for the port out failure.

    Example: "consentNotGiven"
    Allowed values: consentNotGiven consentRequestCanceled 
  • Name
    status
    Type
    string
    Description

    The current status of the port out.

    Example: "issued"
    Allowed values: expired failed initiated issued processing 
  • Name
    subscription
    Type
    string
    Description

    Unique identifier of the subscription affected.

    Example: "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
  • Name
    user
    Type
    string
    Description

    Unique identifier for the user this port out credentials are for.

    Example: "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"

Example

{
  "object": "portOut",
  "id": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
  "behavior": "portOut",
  "createdAt": "2020-01-01T01:01:01.0Z",
  "expiredAt": "2022-02-21T19:38:34Z",
  "failureReason": "consentNotGiven",
  "status": "issued",
  "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
  "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
}