Skip to content
Updawg

`POST /v1/orgs/{org}/billing/checkout`.

POST
/v1/orgs/{org}/billing/checkout
curl --request POST \
  --url https://api.updawg.net/v1/orgs/example/billing/checkout \
  --header 'Content-Type: application/json' \
  --data '{ "plan": "example" }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
org
required
string

Organization slug.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
plan
required

team or business.

string
Examplegenerated
{
  "plan": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Where to send the person to pay.

Media typeapplication/json
object
url
required

Stripe Checkout. Send the person here; they come back to the portal’s billing page either way.

string
Examplegenerated
{
  "url": "example"
}

400

Section titled “400”

Not a plan sold through checkout: team, business or enterprise.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string
Examplegenerated
{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

401

Section titled “401”

No session.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string
Examplegenerated
{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

403

Section titled “403”

Only an owner, in person, manages billing.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string
Examplegenerated
{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

404

Section titled “404”

No such organization, or not yours.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string
Examplegenerated
{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

409

Section titled “409”

Already subscribed (already-subscribed), or on Enterprise by contract with no subscription (enterprise-contract).

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string
Examplegenerated
{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

429

Section titled “429”

Over the organization’s request limit. Retry-After says when to try again; RateLimit-Limit is the burst.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string
Examplegenerated
{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

503

Section titled “503”

This deployment takes no payments (billing-unavailable).

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string
Examplegenerated
{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}