Open the Stripe Customer Portal

POST

/orgs/{org}/billing/portal

curl --request POST \
  --url https://api.sloose.com/orgs/org_9f3c/billing/portal \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "returnUrl": "example" }'

• Production
• Staging

Where a customer changes their card, downloads invoices, or cancels. Everything the portal does reaches us back through the webhook.

Session only: billing is a person’s to manage, never an org’s API token’s (D5).

Authorizations

• sessionAuth

Parameters

Path Parameters

org

required

The org id the session was issued for. A token for one org can never read another.

string

Example

org_9f3c

The org id the session was issued for. A token for one org can never read another.

Request Body

Media typeapplication/json

object

returnUrl

Where Stripe sends the browser afterwards.

string | null

key

additional properties

Example^generated

{
  "returnUrl": "example"
}

Responses

200

Send the browser here.

Media typeapplication/json

object

url

required

string

key

additional properties

Example^generated

{
  "url": "example"
}

401

No bearer, or one that is expired, revoked or no longer resolves to a member.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

403

The bearer’s role is too low, it was issued for a different org, it is an API token (SESSION_REQUIRED), or it is a staff member’s view of the org (IMPERSONATION_REFUSED; a read-only view is refused before this, IMPERSONATION_READ_ONLY): billing spends and changes the org’s money, and a view would do it in the member’s name.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

502

Stripe refused the request (PAYMENT_PROVIDER_REFUSED) — nothing was charged, though a step taken before the refusal stands: the org’s first Stripe customer, or an existing customer’s billing email brought up to date — or was unavailable (PAYMENT_PROVIDER_UNAVAILABLE: unreachable, failing or rate-limiting), which may or may not have gone through — check before retrying. Stripe’s own words are logged, not returned.

Media typeapplication/json

object

error

required

string

code

required

string

Allowed values: PAYMENT_PROVIDER_REFUSED PAYMENT_PROVIDER_UNAVAILABLE

key

additional properties

Example

{
  "code": "PAYMENT_PROVIDER_REFUSED"
}

503

Stripe is not configured (STRIPE_NOT_CONFIGURED). An org with no Stripe customer is not refused: the portal makes one.

Media typeapplication/json

object

error

required

string

key

additional properties

Example^generated

{
  "error": "example"
}