# Logout a portal session

> For the complete machine-readable documentation index, see [llms.txt](https://apidocs.chargebee.com/llms.txt).


[Idempotency Supported](/docs/api/idempotency)

Logs out the portal session. Typically this should be called when customers logout of your application.

If this API is called for a Portal Session that currently is in :

-   "created" status, the session status will be marked as "logged\_out" and the access URL will become invalid.
-   "logged\_in" status, the session status will be marked as "logged\_out" and customer will not be able to use that session.
-   "logged\_out" status, this will return normally without changing any attribute of this resource.

## Sample Request

#### cURL

```bash
curl  https://{site}.chargebee.com/api/v2/portal_sessions/portal___test__KyVnHhSBWm9152sY/logout \
     -X POST  \
     -u {site_api_key}:
```

#### .NET

```dotnet
using ChargeBee.Api;
using ChargeBee.Models;

ApiConfig.Configure("{site}","{site_api_key}");
EntityResult result = PortalSession.Logout("portal___test__KyVnHhSBWm9152sY").Request();

PortalSession portalSession = result.PortalSession;
```

#### Go

```go
package main
import (
    "fmt"
    "github.com/chargebee/chargebee-go/v3"
    portalsessionAction "github.com/chargebee/chargebee-go/v3/actions/portalsession"
)
func main() {
    chargebee.Configure("{site_api_key}","{site}");
    res,err := portalsessionAction.Logout("portal___test__KyVnHhSBWm9152sY").Request()
    if err != nil {
        fmt.Println(err)
    } else {
        PortalSession := res.PortalSession
    }
}
```

#### Go

```go
package main

import (
  "fmt"
  "github.com/chargebee/chargebee-go/v4"
)

func main() {
  config := &chargebee.ClientConfig{
    SiteName: "{site}",
    ApiKey: "{site_api_key}",
  }    
  client := chargebee.NewClient(config)
  req := &chargebee.PortalSessionLogoutRequest{
    Id : "portal___test__KyVnHhSBWm9152sY",
}
  res, err := client.PortalSession.Logout(req)
      if err != nil {
        fmt.Println(err)
    } else {
        PortalSession := res.PortalSession
    }
}
```

#### Java

```java
import com.chargebee.*;
import com.chargebee.ListResult;
import com.chargebee.models.*;
import com.chargebee.models.enums.*;
import java.io.IOException;

public class Sample {

    public static void main(String args[]) throws IOException, Exception {
        Environment.configure("{site}", "{site_api_key}");
        Result result = PortalSession.logout("portal___test__KyVnHhSBWm9152sY").request();

        PortalSession portalSession = result.portalSession();
    }
}
```

#### Java

```java
import com.chargebee.v4.client.ChargebeeClient;
import com.chargebee.v4.models.portalSession.PortalSession;
import com.chargebee.v4.models.portalSession.params.PortalSessionLogoutParams;
import com.chargebee.v4.models.portalSession.responses.PortalSessionLogoutResponse;

public class PortalSessionLogout {

    public static void main(String[] args) {
        ChargebeeClient client = ChargebeeClient.builder()
            .apiKey("{site_api_key}")
            .siteName("{site}")
            .build();

        PortalSessionLogoutResponse response = client.portalSessions().logout("portal___test__KyVnHhSBWm9152sY");

        PortalSession portalSession = response.getPortalSession();
    }
}
```

#### Node.js

```node
import Chargebee from "chargebee";

const chargebee = new Chargebee({
    site: "{site}",
    apiKey: "{site_api_key}",
});

try {
    const result = await chargebee.portalSession.logout("portal___test__KyVnHhSBWm9152sY");

    console.log(result);
    const portalSession = result.portal_session;
} catch (err) {
    console.log(err);
}
```

#### PHP

```php
<?php

require __DIR__ . '/vendor/autoload.php';

use Chargebee\ChargebeeClient;

$chargebee = new ChargebeeClient(options: [
    "site" => "{site}",
    "apiKey" => "{site_api_key}",
]);
$result = $chargebee->portalSession()->logout("portal___test__KyVnHhSBWm9152sY");
$portalSession = $result->portal_session;
```

#### Python

```python
from chargebee import Chargebee

cb_client = Chargebee(api_key="{site_api_key}", site="{site}")
response = cb_client.PortalSession.logout("portal___test__KyVnHhSBWm9152sY")
portal_session = response.portal_session
```

#### Ruby

```ruby
require 'chargebee'

ChargeBee.configure(:site => "{site}",
  :api_key => "{site_api_key}")

result = ChargeBee::PortalSession.logout("portal___test__KyVnHhSBWm9152sY")

portal_session = result.portal_session
```

## Sample Response

```json
{
  "portal_session": {
    "access_url": "https://yourapp.chargebeeportal.com/portal/access/__test__MUfEicuIkiAnAsyvcDLmTysj6myi86uNw",
    "created_at": 1517505974,
    "customer_id": "__test__KyVnHhSBWm90C2sW",
    "expires_at": 1517509574,
    "id": "portal___test__KyVnHhSBWm9152sY",
    "linked_customers": [
      {
        "customer_id": "__test__KyVnHhSBWm90C2sW",
        "has_active_subscription": false,
        "has_billing_address": false,
        "has_payment_method": false,
        "object": "linked_customer"
      },
      {..}
    ],
    "object": "portal_session",
    "redirect_url": "https://yourdomain.com/users/3490354",
    "status": "logged_out",
    "token": "__test__MUfEicuIkiAnAsyvcDLmTysj6myi86uNw"
  }
}
```

## URL Format

**POST** https://[site].chargebee.com/api/v2/portal_sessions/{portal-session-id}/logout

## Returns

- `portal_session` (Portal session object)
  Resource object representing portal\_session