Sign in

v1

latestOpenAPI 3.1.0MIT2026-08-0492100246.4 KB
teams

Start the checkout process for a subscription order.

post/teams/{team_name}/subscription-orders

Path parameters

team_namestring required

The unique name for the team.

Example:cloudquery

Request body

plan'free' | 'paid' | 'enterprise' | 'trial' required

The plan the team is on (trial is deprecated)

success_urlstring required

URL to redirect to after successful order completion

cancel_urlstring required

URL to redirect to after order cancellation

Example request

{
  "success_url": "https://cloud.cloudquery.io/order-completion",
  "cancel_url": "https://cloud.cloudquery.io/order-cancelled"
}

Response

Response

idstring uuid required

ID of the team subscription order

team_namestring required

The unique name for the team.

plan'free' | 'paid' | 'enterprise' | 'trial' required

The plan the team is on (trial is deprecated)

status'pending' | 'completed' | 'cancelled' required
created_atstring date-time required
updated_atstring date-time required
completed_atstring date-time
completion_urlstring uri

Stripe URL for completing purchase. Only shown in response to POST request when a paid plan is selected.

Example response

{
  "id": "12345678-1234-1234-1234-1234567890ab",
  "team_name": "cloudquery",
  "created_at": "2017-07-14T16:53:42Z",
  "updated_at": "2017-07-14T16:53:42Z",
  "completed_at": "2017-07-14T16:53:42Z"
}