Skip to Content
veriom

Start plan checkout

Open Stripe Checkout so an admin can buy the Starter or Growth plan. Needs an admin in a browser session with a recent step-up. Checkout bills the plan's price for the chosen interval (monthly, or yearly at the catalog's discount), and the workspace changes plan only once Stripe confirms the subscription to the billing webhook. A promotion code is applied up front when given; otherwise the customer may enter one on the Checkout page. A workspace that already has a subscription changes it in the billing portal, and a plan Veriom invoices changes through an upgrade request.

POST
/v1/workspaces/{workspace_id}/plan/checkout

Open Stripe Checkout so an admin can buy the Starter or Growth plan.

Needs an admin in a browser session with a recent step-up. Checkout bills the plan's price for the chosen interval (monthly, or yearly at the catalog's discount), and the workspace changes plan only once Stripe confirms the subscription to the billing webhook. A promotion code is applied up front when given; otherwise the customer may enter one on the Checkout page. A workspace that already has a subscription changes it in the billing portal, and a plan Veriom invoices changes through an upgrade request.

Authorization

workspaceToken
headerAuthorizationBearer <vat_<opaque-token>>

Expiring, hashed workspace token with explicit scopes.

Path Parameters

workspace_id*Workspace Id
Formatuuid

Header Parameters

Idempotency-Key?|null

Request Body

application/json
  1. body
interval?BillingInterval

Pay every month, or a year at a time at a discount.

Default"month"
Value in"month""year"
plan*Plan
Value in"starter""growth"
promotion_code?|

A promotion code to apply up front. Without one, the Checkout page lets the customer enter a code.

Response Body

Successful Response

application/json
  1. response
checkout_url*Checkout Url

The Stripe Checkout page to send the browser to.

expires_at*|

When the Checkout page stops accepting.

Example Request
curl -X POST 'https://api.veriom.ai/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/plan/checkout' \  -H 'Content-Type: application/json' \  -d '{  "plan": "starter"}'
Example Response
{  "checkout_url": "string",  "expires_at": "2019-08-24T14:15:22Z"}