Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer token via Authorization header

Path Parameters

id
string<uuid>
required

Response

The current payment status and checkout URL, if unpaid.

status
enum<string>
required

Lifecycle of a proxy. A freshly created proxy is checking while its billing identity is being resolved — clients should poll until a paymentUrl or a later status appears — then provisioning — or pending_payment until the customer completes checkout — and becomes active once its upstream is assigned. cancelling retains full access through the paid period; when the subscription expires the proxy is ended. error marks a failed provisioning attempt.

Available options:
checking,
pending_payment,
provisioning,
active,
cancelling,
ended,
error
paymentUrl
string | null

Payable checkout URL; omitted after payment.