cURL

curl --request GET \
  --url http://localhost:3000/billing/portal \
  --header 'Authorization: Bearer <token>'

{
  "statusCode": 123,
  "message": "OK",
  "data": {
    "url": "<string>"
  }
}

Billing

Get billingportal

Generate a short-lived Stripe Billing Portal session for an organization admin.
This portal link allows the admin to manage billing-related tasks securely within Stripe’s hosted UI.

What the portal provides

View all current and past subscriptions tied to the organization
Update payment methods (cards, bank accounts, etc.)
View/download invoices and receipts
Cancel or resume subscriptions
Update billing information

The returned url is a temporary, single-use HTTPS link to Stripe’s billing portal, e.g.:

https://billing.stripe.com/p/session/test_YWNjdF8xUjVENkJDdnlkaXZnY21CLF9UNzRYcVA3eDZ4eEExS0I2ZDNLUmhVUHVXWGZSd2xC01003ZjV6GWq

⚠️ Security note: This URL is short-lived and should only be shown to the authenticated admin requesting it. Do not persist or reuse it in your own database.

GET

billing

portal

cURL

curl --request GET \
  --url http://localhost:3000/billing/portal \
  --header 'Authorization: Bearer <token>'

{
  "statusCode": 123,
  "message": "OK",
  "data": {
    "url": "<string>"
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

orgId

string<uuid>

required

Response

Default Response

statusCode

number

message

string

default:OK

data

object

Show child attributes

Get a single invoice Post billingsession

Documentation Index

Authorizations

Query Parameters

Response