Skip to main content
POST
/
api
/
payments
/
stripe
/
{environment}
/
customer-portal-sessions
Create Stripe Customer Portal Session
curl --request POST \
  --url https://api.example.com/api/payments/stripe/{environment}/customer-portal-sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "subject": {
    "type": "team",
    "id": "team_123"
  },
  "returnUrl": "https://app.example.com/billing"
}
'
import requests

url = "https://api.example.com/api/payments/stripe/{environment}/customer-portal-sessions"

payload = {
"subject": {
"type": "team",
"id": "team_123"
},
"returnUrl": "https://app.example.com/billing"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
subject: {type: 'team', id: 'team_123'},
returnUrl: 'https://app.example.com/billing'
})
};

fetch('https://api.example.com/api/payments/stripe/{environment}/customer-portal-sessions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/payments/stripe/{environment}/customer-portal-sessions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'subject' => [
'type' => 'team',
'id' => 'team_123'
],
'returnUrl' => 'https://app.example.com/billing'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/api/payments/stripe/{environment}/customer-portal-sessions"

payload := strings.NewReader("{\n \"subject\": {\n \"type\": \"team\",\n \"id\": \"team_123\"\n },\n \"returnUrl\": \"https://app.example.com/billing\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/api/payments/stripe/{environment}/customer-portal-sessions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"subject\": {\n \"type\": \"team\",\n \"id\": \"team_123\"\n },\n \"returnUrl\": \"https://app.example.com/billing\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/payments/stripe/{environment}/customer-portal-sessions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"subject\": {\n \"type\": \"team\",\n \"id\": \"team_123\"\n },\n \"returnUrl\": \"https://app.example.com/billing\"\n}"

response = http.request(request)
puts response.read_body
{
  "customerPortalSession": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "subjectType": "<string>",
    "subjectId": "<string>",
    "customerId": "cus_123",
    "returnUrl": "https://app.example.com/billing",
    "configuration": "<string>",
    "url": "https://billing.stripe.com/p/session/test_123",
    "lastError": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}
{
"error": "INVALID_INPUT",
"message": "environment: Invalid enum value",
"statusCode": 400,
"nextActions": "<string>"
}
{
"error": "INVALID_INPUT",
"message": "environment: Invalid enum value",
"statusCode": 400,
"nextActions": "<string>"
}
{
"error": "INVALID_INPUT",
"message": "environment: Invalid enum value",
"statusCode": 400,
"nextActions": "<string>"
}
{
"error": "INVALID_INPUT",
"message": "environment: Invalid enum value",
"statusCode": 400,
"nextActions": "<string>"
}
{
"error": "INVALID_INPUT",
"message": "environment: Invalid enum value",
"statusCode": 400,
"nextActions": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

environment
enum<string>
required

Payment provider environment.

Available options:
test,
live

Body

application/json
subject
object
required
returnUrl
string<uri>
configuration
string
Required string length: 1 - 255

Response

Customer Portal Session created

customerPortalSession
object
required