Create billing checkout session REST API

POST

/api/cloud/billing/checkout

curl --request POST \
  --url https://hitkeep.com/api/cloud/billing/checkout \
  --header 'Content-Type: application/json' \
  --cookie hk_token=<hk_token> \
  --data '{ "locale": "example", "plan_code": "pro" }'

Creates a Stripe Checkout session to upgrade the authenticated hosted cloud team to a paid plan.

Authorizations

• cookieAuth

Request Body^required

Media typeapplication/json

object

locale

string

plan_code

required

string

Allowed values: pro business

Responses

200

Billing checkout session

Media typeapplication/json

object

url

required

string

Example^generated

{
  "url": "example"
}

400

Invalid request

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

401

Unauthorized

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

404

Cloud billing account not found

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

409

Use billing portal to manage an existing paid plan

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

502

Unable to start checkout

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}