Skip to main content
POST
Create a checkout for an invoice

Authorizations

Authorization
string
header
required

Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.

Path Parameters

invoice
string
required

The invoice number shown on the account.

Example:

18342

Response

The record, as a JSON object. There is no envelope.

The checkout opened for an invoice and whether it supports recurring payments.

checkoutUuid
string
required

The checkout UUID, or null when checkout is unavailable.

Example:

"f50d7440-0ea4-43fb-af5c-2d6dcd1cb672"

renews
boolean
required

The value of renews.

Example:

true