open the customer portal

POST/v1/billing/portal

Authorization

AuthorizationBearer token · headerrequired

an organization api key. browser clients use the session cookie instead.

computer_sessionAPI key · cookierequired

first-party httponly browser session; never readable from javascript.

Responses

200OK

urlstring<uri>required

400invalid request

errorobjectrequired

Show properties

codeErrorCoderequired

Allowed:invalid_requestunauthenticatedpermission_deniednot_foundconflictprecondition_failedquota_exceededrate_limitedunsupported_operationinternal_errorcompute_unavailable

messagestringrequired

human-readable, not machine-parseable

request_idstringrequired

detailsFieldError[]

Show properties

Array of FieldError

fieldstringrequired

dotted path into the request body

messagestringrequired

quotaobject

Show properties

limitstringrequired

the entitlement that declined this request

currentintegerrequired

min 0 · max 9007199254740991

maximuminteger | anyrequired

Show properties

Any of:

integer

integer

any

any

plan_idstringrequired

upgrade_urlstring | anyrequired

Show properties

Any of:

string

string

any

any

401unauthenticated

errorobjectrequired

Show properties

codeErrorCoderequired

Allowed:invalid_requestunauthenticatedpermission_deniednot_foundconflictprecondition_failedquota_exceededrate_limitedunsupported_operationinternal_errorcompute_unavailable

messagestringrequired

human-readable, not machine-parseable

request_idstringrequired

detailsFieldError[]

Show properties

Array of FieldError

fieldstringrequired

dotted path into the request body

messagestringrequired

quotaobject

Show properties

limitstringrequired

the entitlement that declined this request

currentintegerrequired

min 0 · max 9007199254740991

maximuminteger | anyrequired

Show properties

Any of:

integer

integer

any

any

plan_idstringrequired

upgrade_urlstring | anyrequired

Show properties

Any of:

string

string

any

any

402quota exceeded

errorobjectrequired

Show properties

codeErrorCoderequired

Allowed:invalid_requestunauthenticatedpermission_deniednot_foundconflictprecondition_failedquota_exceededrate_limitedunsupported_operationinternal_errorcompute_unavailable

messagestringrequired

human-readable, not machine-parseable

request_idstringrequired

detailsFieldError[]

Show properties

Array of FieldError

fieldstringrequired

dotted path into the request body

messagestringrequired

quotaobject

Show properties

limitstringrequired

the entitlement that declined this request

currentintegerrequired

min 0 · max 9007199254740991

maximuminteger | anyrequired

Show properties

Any of:

integer

integer

any

any

plan_idstringrequired

upgrade_urlstring | anyrequired

Show properties

Any of:

string

string

any

any

403permission denied

errorobjectrequired

Show properties

codeErrorCoderequired

Allowed:invalid_requestunauthenticatedpermission_deniednot_foundconflictprecondition_failedquota_exceededrate_limitedunsupported_operationinternal_errorcompute_unavailable

messagestringrequired

human-readable, not machine-parseable

request_idstringrequired

detailsFieldError[]

Show properties

Array of FieldError

fieldstringrequired

dotted path into the request body

messagestringrequired

quotaobject

Show properties

limitstringrequired

the entitlement that declined this request

currentintegerrequired

min 0 · max 9007199254740991

maximuminteger | anyrequired

Show properties

Any of:

integer

integer

any

any

plan_idstringrequired

upgrade_urlstring | anyrequired

Show properties

Any of:

string

string

any

any

404not found

errorobjectrequired

Show properties

codeErrorCoderequired

Allowed:invalid_requestunauthenticatedpermission_deniednot_foundconflictprecondition_failedquota_exceededrate_limitedunsupported_operationinternal_errorcompute_unavailable

messagestringrequired

human-readable, not machine-parseable

request_idstringrequired

detailsFieldError[]

Show properties

Array of FieldError

fieldstringrequired

dotted path into the request body

messagestringrequired

quotaobject

Show properties

limitstringrequired

the entitlement that declined this request

currentintegerrequired

min 0 · max 9007199254740991

maximuminteger | anyrequired

Show properties

Any of:

integer

integer

any

any

plan_idstringrequired

upgrade_urlstring | anyrequired

Show properties

Any of:

string

string

any

any

409conflict with current state

errorobjectrequired

Show properties

codeErrorCoderequired

Allowed:invalid_requestunauthenticatedpermission_deniednot_foundconflictprecondition_failedquota_exceededrate_limitedunsupported_operationinternal_errorcompute_unavailable

messagestringrequired

human-readable, not machine-parseable

request_idstringrequired

detailsFieldError[]

Show properties

Array of FieldError

fieldstringrequired

dotted path into the request body

messagestringrequired

quotaobject

Show properties

limitstringrequired

the entitlement that declined this request

currentintegerrequired

min 0 · max 9007199254740991

maximuminteger | anyrequired

Show properties

Any of:

integer

integer

any

any

plan_idstringrequired

upgrade_urlstring | anyrequired

Show properties

Any of:

string

string

any

any

412precondition failed

errorobjectrequired

Show properties

codeErrorCoderequired

Allowed:invalid_requestunauthenticatedpermission_deniednot_foundconflictprecondition_failedquota_exceededrate_limitedunsupported_operationinternal_errorcompute_unavailable

messagestringrequired

human-readable, not machine-parseable

request_idstringrequired

detailsFieldError[]

Show properties

Array of FieldError

fieldstringrequired

dotted path into the request body

messagestringrequired

quotaobject

Show properties

limitstringrequired

the entitlement that declined this request

currentintegerrequired

min 0 · max 9007199254740991

maximuminteger | anyrequired

Show properties

Any of:

integer

integer

any

any

plan_idstringrequired

upgrade_urlstring | anyrequired

Show properties

Any of:

string

string

any

any

429rate limited

errorobjectrequired

Show properties

codeErrorCoderequired

Allowed:invalid_requestunauthenticatedpermission_deniednot_foundconflictprecondition_failedquota_exceededrate_limitedunsupported_operationinternal_errorcompute_unavailable

messagestringrequired

human-readable, not machine-parseable

request_idstringrequired

detailsFieldError[]

Show properties

Array of FieldError

fieldstringrequired

dotted path into the request body

messagestringrequired

quotaobject

Show properties

limitstringrequired

the entitlement that declined this request

currentintegerrequired

min 0 · max 9007199254740991

maximuminteger | anyrequired

Show properties

Any of:

integer

integer

any

any

plan_idstringrequired

upgrade_urlstring | anyrequired

Show properties

Any of:

string

string

any

any

500internal error

errorobjectrequired

Show properties

codeErrorCoderequired

Allowed:invalid_requestunauthenticatedpermission_deniednot_foundconflictprecondition_failedquota_exceededrate_limitedunsupported_operationinternal_errorcompute_unavailable

messagestringrequired

human-readable, not machine-parseable

request_idstringrequired

detailsFieldError[]

Show properties

Array of FieldError

fieldstringrequired

dotted path into the request body

messagestringrequired

quotaobject

Show properties

limitstringrequired

the entitlement that declined this request

currentintegerrequired

min 0 · max 9007199254740991

maximuminteger | anyrequired

Show properties

Any of:

integer

integer

any

any

plan_idstringrequired

upgrade_urlstring | anyrequired

Show properties

Any of:

string

string

any

any

501unsupported operation

errorobjectrequired

Show properties

codeErrorCoderequired

Allowed:invalid_requestunauthenticatedpermission_deniednot_foundconflictprecondition_failedquota_exceededrate_limitedunsupported_operationinternal_errorcompute_unavailable

messagestringrequired

human-readable, not machine-parseable

request_idstringrequired

detailsFieldError[]

Show properties

Array of FieldError

fieldstringrequired

dotted path into the request body

messagestringrequired

quotaobject

Show properties

limitstringrequired

the entitlement that declined this request

currentintegerrequired

min 0 · max 9007199254740991

maximuminteger | anyrequired

Show properties

Any of:

integer

integer

any

any

plan_idstringrequired

upgrade_urlstring | anyrequired

Show properties

Any of:

string

string

any

any

503compute unavailable

errorobjectrequired

Show properties

codeErrorCoderequired

Allowed:invalid_requestunauthenticatedpermission_deniednot_foundconflictprecondition_failedquota_exceededrate_limitedunsupported_operationinternal_errorcompute_unavailable

messagestringrequired

human-readable, not machine-parseable

request_idstringrequired

detailsFieldError[]

Show properties

Array of FieldError

fieldstringrequired

dotted path into the request body

messagestringrequired

quotaobject

Show properties

limitstringrequired

the entitlement that declined this request

currentintegerrequired

min 0 · max 9007199254740991

maximuminteger | anyrequired

Show properties

Any of:

integer

integer

any

any

plan_idstringrequired

upgrade_urlstring | anyrequired

Show properties

Any of:

string

string

any

any

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Request

curl -X POST "https://api.raster.sh/v1/v1/billing/portal" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.raster.sh/v1/v1/billing/portal", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.post(
    "https://api.raster.sh/v1/v1/billing/portal",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

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

{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "request_id": "string",
    "details": [
      {
        "field": "string",
        "message": "string"
      }
    ],
    "quota": {
      "limit": "running_machines",
      "current": 9007199254740991,
      "maximum": 9007199254740991,
      "plan_id": "string",
      "upgrade_url": "string"
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "request_id": "string",
    "details": [
      {
        "field": "string",
        "message": "string"
      }
    ],
    "quota": {
      "limit": "running_machines",
      "current": 9007199254740991,
      "maximum": 9007199254740991,
      "plan_id": "string",
      "upgrade_url": "string"
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "request_id": "string",
    "details": [
      {
        "field": "string",
        "message": "string"
      }
    ],
    "quota": {
      "limit": "running_machines",
      "current": 9007199254740991,
      "maximum": 9007199254740991,
      "plan_id": "string",
      "upgrade_url": "string"
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "request_id": "string",
    "details": [
      {
        "field": "string",
        "message": "string"
      }
    ],
    "quota": {
      "limit": "running_machines",
      "current": 9007199254740991,
      "maximum": 9007199254740991,
      "plan_id": "string",
      "upgrade_url": "string"
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "request_id": "string",
    "details": [
      {
        "field": "string",
        "message": "string"
      }
    ],
    "quota": {
      "limit": "running_machines",
      "current": 9007199254740991,
      "maximum": 9007199254740991,
      "plan_id": "string",
      "upgrade_url": "string"
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "request_id": "string",
    "details": [
      {
        "field": "string",
        "message": "string"
      }
    ],
    "quota": {
      "limit": "running_machines",
      "current": 9007199254740991,
      "maximum": 9007199254740991,
      "plan_id": "string",
      "upgrade_url": "string"
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "request_id": "string",
    "details": [
      {
        "field": "string",
        "message": "string"
      }
    ],
    "quota": {
      "limit": "running_machines",
      "current": 9007199254740991,
      "maximum": 9007199254740991,
      "plan_id": "string",
      "upgrade_url": "string"
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "request_id": "string",
    "details": [
      {
        "field": "string",
        "message": "string"
      }
    ],
    "quota": {
      "limit": "running_machines",
      "current": 9007199254740991,
      "maximum": 9007199254740991,
      "plan_id": "string",
      "upgrade_url": "string"
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "request_id": "string",
    "details": [
      {
        "field": "string",
        "message": "string"
      }
    ],
    "quota": {
      "limit": "running_machines",
      "current": 9007199254740991,
      "maximum": 9007199254740991,
      "plan_id": "string",
      "upgrade_url": "string"
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "request_id": "string",
    "details": [
      {
        "field": "string",
        "message": "string"
      }
    ],
    "quota": {
      "limit": "running_machines",
      "current": 9007199254740991,
      "maximum": 9007199254740991,
      "plan_id": "string",
      "upgrade_url": "string"
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "request_id": "string",
    "details": [
      {
        "field": "string",
        "message": "string"
      }
    ],
    "quota": {
      "limit": "running_machines",
      "current": 9007199254740991,
      "maximum": 9007199254740991,
      "plan_id": "string",
      "upgrade_url": "string"
    }
  }
}