Skip to main content
GET
Get a server's billing service

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

server
string
required

The server UUID

Example:

"ecc6f4f1"

Response

BillingServiceData · object | null

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

service_id
integer
required

The service id ID.

Example:

7312

name
string
required

The name shown to customers.

Example:

"Standard 4 GB"

hostname
string | null
required

The fully qualified hostname.

Example:

"lambda-core.blackmesa.example.com"

status
string | null
required

The value of status.

Example:

"Active"

billing_cycle
string | null
required

How often the service renews and is billed.

Example:

"Monthly"

recurring_amount
string | null
required

The amount charged each billing cycle.

Example:

"12.00"

currency
string | null
required

The three-letter currency code used for monetary amounts.

Example:

"USD"

server_id
string | null
required

The server id ID.

Example:

"ecc6f4f1"

next_due_date
string | null
required

The value of next_due_date.

Example:

"2026-10-02"

period
ServicePeriodData · object | null
required

The value of period.

Example:
autopay
boolean
required

Whether anything will be charged automatically. The tick or the cross in the Autopay column.

Example:

true

autopay_ending
boolean
required

Autopay that has been turned off but has not stopped yet. Its own state, drawn between the tick and the cross.

Example:

false

subscription
BillingServiceSubscriptionData · object | null
required

The value of subscription.

Example:
cancellation
BillingServiceCancellationData · object | null
required

The value of cancellation.

Example:

null

can_start_subscription
boolean
required

Whether the customer can start subscription.

Example:

false

can_cancel_subscription
boolean
required

Whether the customer can cancel subscription.

Example:

true

can_change_cycle
boolean
required

Whether the customer can change cycle.

Example:

true

can_cancel_service
boolean
required

Whether the customer can cancel service.

Example:

true

can_withdraw_cancellation
boolean
required

Whether the customer can withdraw cancellation.

Example:

false

immediate_refund
string | null
required

What stopping this service today would put back on the account, in the currency beside it.

Example:

"7.20"

pays_from_credit
boolean
required

Whether renewals of this service are paid out of the account's credit balance where there is one. True unless the customer has turned it off, which is what the balance does by default.

Example:

true

can_change_credit
boolean
required

Whether that can be changed from here. False where the installation does not offer account credit at all, or cannot enforce the answer per service.

Example:

true

autopay_provider
string | null
required

The value of autopay_provider.

Example:

"paddle"

autopay_details
string | null
required

The value of autopay_details.

Example:

"active"

suspension_reason
string | null
required

The value of suspension_reason.

Example:

null