PortOutCredentials

  • Name
    object
    Type
    string
    Description

    Type of object is always portOutCredentials.

    Allowed values: portOutCredentials 
  • Name
    accountNumber
    Type
    string
    Description

    The account number on the service provider.

    Example: "123456789"
  • Name
    accountPin
    Type
    nullable string
    Description

    The account pin on the service provider. This value will always be null in all events.

    Example: "1234"
  • Name
    behavior
    Type
    string
    Status
    PREVIEW
    Description

    The behavior of the port out credentials.

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

    Port out credentials 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
    expiresAt
    Type
    string
    Description

    Time when the port-out credentials expire and won't be valid anymore.

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

    Unique identifier of the subscription affected.

    Example: "sub_0SNlurA049MEWV2gSfSxi00xlPIi"

Example

{
  "object": "portOutCredentials",
  "accountNumber": "123456789",
  "accountPin": "1234",
  "behavior": "portOut",
  "expiresAt": "2022-02-21T19:38:34.0Z",
  "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
}