Sign in

v1

latestOpenAPI 3.1.0MIT2026-08-0492100246.4 KB
addons

Start the checkout process for an addon order.

post/teams/{team_name}/addon-orders

Path parameters

team_namestring required

The unique name for the team.

Example:cloudquery

Request body

addon_teamstring required

The unique name for the team.

addon_type'transformation' | 'visualization' required

Supported types for addons

addon_namestring required

The unique name for the addon.

success_urlstring required

URL to redirect to after successful order completion

cancel_urlstring required

URL to redirect to after order cancellation

Example request

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

Response

Response

idstring uuid required

ID of the addon order

team_namestring required

The unique name for the team.

addon_teamstring required

The unique name for the team.

addon_type'transformation' | 'visualization' required

Supported types for addons

addon_namestring required

The unique name for the addon.

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.

Example response

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