Create a billing portal session

POST

/api/workspaces/{workspaceId}/billing/portal

curl --request POST \
  --url http://localhost:8080/api/workspaces/example/billing/portal \
  --header 'Content-Type: application/json' \
  --cookie auth_session=<auth_session> \
  --data '{ "successUrl": "https://example.com", "cancelUrl": "https://example.com", "returnUrl": "https://example.com" }'

• Configured API base URL

Authorizations

• cookieAuth
• bearerAuth

Parameters

Path Parameters

workspaceId

required

string

Request Body

Media typeapplication/json

object

successUrl

string format: uri

cancelUrl

string format: uri

returnUrl

string format: uri

Example ^generated

{
  "successUrl": "https://example.com",
  "cancelUrl": "https://example.com",
  "returnUrl": "https://example.com"
}

Responses

200

Stripe-hosted URL to redirect the user to.

Media typeapplication/json

object

url

required

string format: uri

Example ^generated

{
  "url": "https://example.com"
}

400

Invalid request

Media typeapplication/json

object

success

boolean

error

required

string

Example

{
  "error": "Human-readable error message"
}

401

Authentication required

Media typeapplication/json

object

success

boolean

error

required

string

Example

{
  "error": "Human-readable error message"
}

403

Forbidden

Media typeapplication/json

object

success

boolean

error

required

string

Example

{
  "error": "Human-readable error message"
}

404

Not found

Media typeapplication/json

object

success

boolean

error

required

string

Example

{
  "error": "Human-readable error message"
}

409

Conflict

Media typeapplication/json

object

success

boolean

error

required

string

Example

{
  "error": "Human-readable error message"
}

500

Internal server error

Media typeapplication/json

object

success

boolean

error

required

string

Example

{
  "error": "Human-readable error message"
}