Create Portal Session

POST

/api/v1/billing/portal

curl --request POST \
  --url https://example.com/api/v1/billing/portal \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "return_url": "http://localhost:3000/dashboard" }'

Create a Stripe Billing Portal session.

Authorizations

• HTTPBearer

Request Body ^required

Media type application/json

PortalRequest

object

return_url

Return Url

string

default: http://localhost:3000/dashboard

Responses

200

Successful Response

Media type application/json

PortalResponse

object

url

required

Url

string

Example ^generated

{
  "url": "example"
}

422

Validation Error

Media type application/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example ^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}