Skip to content
Invogi Docs

Build a Paddle.js checkout config for a public Invogi plan (ADMIN+)

POST
/billing/checkout
curl --request POST \
  --url https://api.invogi.com/v1/billing/checkout \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "plan_code": "CORE", "billing_interval": "month", "additional_legal_entities": 0 }'

Authorizations

Section titled “Authorizations”

Request Body

Section titled “Request Body”
Media typeapplication/json
object
plan_code
string
default: CONTROL
Allowed values: CORE CONTROL SCALE
billing_interval
string
default: month
Allowed values: month year
additional_legal_entities
integer
0 <= 100

Responses

Section titled “Responses”

200

Section titled “200”

Paddle.js Checkout.open() options

Media typeapplication/json
object
items
required
Array<object>
object
priceId
required
string
quantity
required
integer
customer
object
email
required
string
customData
required
object
organization_id
required
string format: uuid
settings
required
object
successUrl
required
string format: uri

Example generated

{
  "items": [
    {
      "priceId": "example",
      "quantity": 1
    }
  ],
  "customer": {
    "email": "example"
  },
  "customData": {
    "organization_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  },
  "settings": {
    "successUrl": "https://example.com"
  }
}

400

Section titled “400”

Invalid request

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: NOT_FOUND UNAUTHORIZED FORBIDDEN INVALID_REQUEST CONFLICT RATE_LIMITED USAGE_LIMIT_EXCEEDED PROCESSING_FAILED
message
required
string
request_id
required
string

Example 

{
  "error": {
    "code": "NOT_FOUND"
  }
}

401

Section titled “401”

Missing or invalid API key

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: NOT_FOUND UNAUTHORIZED FORBIDDEN INVALID_REQUEST CONFLICT RATE_LIMITED USAGE_LIMIT_EXCEEDED PROCESSING_FAILED
message
required
string
request_id
required
string

Example 

{
  "error": {
    "code": "NOT_FOUND"
  }
}

403

Section titled “403”

API key lacks required scope/role

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: NOT_FOUND UNAUTHORIZED FORBIDDEN INVALID_REQUEST CONFLICT RATE_LIMITED USAGE_LIMIT_EXCEEDED PROCESSING_FAILED
message
required
string
request_id
required
string

Example 

{
  "error": {
    "code": "NOT_FOUND"
  }
}

409

Section titled “409”

Organization already has a subscription