Read an organization's Pro subscription

Parameters

orgpath · required · string

Organization name

Originheader · required · string

This server's origin.

Example request

curl --request GET 'https://commitscale.com/api/v1/orgs/acme/billing' \
  --cookie "__Host-cs_session=$CSCALE_SESSION" \
  --header 'Origin: https://commitscale.com'

Example values illustrate the format. Use your own credentials and identifiers.

Responses

200 Organization billing.

application/json

{
  "buyer_is_you": false,
  "buyer_left": false,
  "monthly_usd": 1,
  "plan": "example",
  "redirect_hosts": [
    "example"
  ],
  "seated": [
    "example"
  ],
  "seats": 1,
  "subscription": {
    "cancel_at_period_end": false,
    "period_end": 1,
    "shape_problems": [
      "example"
    ],
    "status": "example"
  }
}

buyeroptional · string

The buying person's handle, when the account still exists.

buyer_is_yourequired · boolean

Whether the caller bought this subscription.

buyer_leftrequired · boolean

Whether the buying owner has since left or lost ownership.

monthly_usdrequired · integer (int64)

Current monthly price in US dollars at $20 per person.

planrequired · string

Pro when the unblocked subscription is active, trialing, or past due; otherwise Free.

redirect_hostsrequired · array of string

Payment hosts permitted by this server.

Fields of redirect_hosts

Payment hosts permitted by this server.

Each item has this shape.

seatedrequired · array of string

Handles currently covered by this organization's subscription.

Fields of seated

Handles currently covered by this organization's subscription.

Each item has this shape.

seatsrequired · integer (int64)

Current people in the organization, including owners.

subscriptionrequired · null or object

The subscription, or null when none has been recorded.

Fields of subscription

One of these shapes

May be null.

cancel_at_period_endrequired · boolean

Whether cancellation is scheduled for the end of the paid period.

period_endrequired · integer (int64)

End of the paid period as Unix seconds.

shape_problemsrequired · array of string

Configuration problems that need billing support.

Fields of shape_problems

Configuration problems that need billing support.

Each item has this shape.

statusrequired · string

Current Stripe subscription status.

RateLimit and RateLimit-Policy describe the request rate. Follow Retry-After when a response asks you to wait.

Problem responses

Errors use application/problem+json. Act on the stable code, and follow next when present. See the problem format.

billing_not_configured503

Billing is not configured on this server or its billing service.

Billing is unavailable on this server. Try again later or contact support.

billing_unavailable503

Billing could not confirm the request.

Retry the same input with the same idempotency key. Never start another purchase to recover a lost reply.

billing_refused400 / 403 / 404 / 405 / 409 / 410 / 415 / 422 / 429

Billing refused the operation. billing_code names its reason; pending_key identifies a purchase needing resolution.

Review Billing and retry uncertain operations with the original key. Resolve an unfinished personal purchase through billing/requests/resolve. New work after a final refusal needs a fresh key.

check_key_scope403

A check-only key may call the test check, read its own usage and acceptance rule, contact support, and withdraw data sharing.

Use a person's sign-in for account management. More agent power needs the owner's passkey; this key cannot widen itself.

feature_off403

The namespace plan does not include this feature.

Retrying on the same plan will not help. GET /api/v1/namespaces/{namespace}/plan, and the namespace's Plan page in Settings, show what its plan includes.

unauthenticated401

The request carried no credentials.

Use this operation's sign-in method. Bearer credentials use Authorization: Bearer <token>; browser credentials use the session cookie.

invalid_token401

The token is unknown, expired, or revoked, its agent was revoked, or an OAuth token was used outside its MCP resource.

Stop using it. Sign in again, or ask the owner to create a replacement agent key.

forbidden403

The caller may not do this: only people may, only owners may, or the agent was not given this repository or write access.

Stop. Retrying will not help. Ask the owner for the access, or leave the step to a person.

not_found404

It does not exist, or the caller cannot read it: a repository the caller cannot read is reported as not found.

Check the name or ID, and that the token has the repository.

invalid_request400

The request is malformed or breaks a rule, such as a title that is too long, or a body that is not the expected JSON.

Fix the request as detail says. The same request fails the same way.

quota_exceeded429

With 429, the caller used its requests for the minute. With 422, a count limit was reached.

With 429, wait Retry-After seconds and retry. With 422, remove one first.

internal500

The server failed, and logged why.

Retry after Retry-After seconds. A write is safe to retry with the same idempotency key.

unavailable503

With 502, a service the server needs did not answer, such as a sign-in provider. With 503, the server is busy, such as when a workspace is locked or host lookups are full, or a write with an idempotency key runs long: that write goes on, and its answer is kept for the key.

With 502, retry later, or sign in another way. With 503, retry after Retry-After seconds, using the same idempotency key for a write; a long-running write can then replay its answer.