Core Resources

Billing

Access billing details, invoices, and usage information for your Serverista account.

Delete payment method

Delete a payment method from the account

Accepts: application/json
Returns: application/json

Parameters

URL Params
id
string
Payment method id

Response

object of GenericResponse

Reference Type:  GenericResponse

message
string
A human-readable message describing the result of the operation.
example: User created successfully.
success
boolean
Indicates whether the operation was successful.
example: true
DELETE /v1/wallet/cards/:id
curl -X DELETE https://api.serverista.com/v1/wallet/cards/:id \
  -H "Authorization: ApiKey YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d ''
Response

{
  "message": "example_message",
  "success": true
}

List orders

List all orders of current account

Accepts: application/json
Returns: application/json

Parameters

no parameters


Response

array of Order

Reference Type:  Order

user_id
integer
Identifier of the user who placed the order.
example: 12
account_id
integer
Identifier of the account associated with the order.
example: 5
created_at
string
Timestamp when the order was created.
example: 2025-10-31T14:23:00Z
id
integer
Unique identifier of the order.
example: 42
order_plans
array of OrderPlan
Reference Type: OrderPlan

List of plans or services included in the order.
example: {OrderPlan}
unique_id
string
Globally unique identifier for the order.
example: 88-77045-10138
updated_at
string
Timestamp when the order was last updated.
example: 2025-11-01T09:45:00Z
GET /v1/orders
curl -X GET https://api.serverista.com/v1/orders \
  -H "Authorization: ApiKey YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d ''
Response
[
{
  "account_id": 123,
  "created_at": "example_created_at",
  "id": 123,
  "order_plans": [
    {
      "...": null
    }
  ],
  "unique_id": "example_unique_id",
  "updated_at": "example_updated_at",
  "user_id": 123
}
]

Pay invoice

Pay invoice manually

Accepts: application/json
Returns: application/json

Parameters

URL Params
id
string
Invoice id

Response

object of InvoicePayment

Reference Type:  InvoicePayment

paid
boolean
Indicates whether the invoice is paid.
example: true
payment_ref
string
Reference ID for the payment transaction.
example: pay_9f8e7d6c5b4a3
message
string
Optional message or description related to the payment.
example: Payment successfully processed via Stripe.
outstanding
string
Remaining outstanding amount after payment.
example: "0.00"
POST /v1/invoices/:id/payments
curl -X POST https://api.serverista.com/v1/invoices/:id/payments \
  -H "Authorization: ApiKey YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d ''
Response

{
  "message": "example_message",
  "outstanding": "example_outstanding",
  "paid": true,
  "payment_ref": "example_payment_ref"
}

List payment methods

Returns a list of all payment methods

Accepts: application/json
Returns: application/json

Parameters

no parameters


Response

array of PaymentMethod

Reference Type:  PaymentMethod

default
boolean
Indicates whether this is the user's default payment method.
example: true
exp
string
Expiration date of the payment method in MM/YY format.
example: 12/27
id
string
Unique identifier of the payment method.
example: 123
last4
string
Last four digits of the payment method number.
example: 4242
brand
string
Brand or type of the payment method (e.g., Visa, Mastercard, etc.).
example: Visa
GET /v1/wallet/cards
curl -X GET https://api.serverista.com/v1/wallet/cards \
  -H "Authorization: ApiKey YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d ''
Response
[
{
  "brand": "example_brand",
  "default": true,
  "exp": "example_exp",
  "id": "example_id",
  "last4": "example_last4"
}
]

Update payment method

Updates default payment method

Accepts: application/json
Returns: application/json

Parameters

URL Params
id
string
Payment method id

Response

object of GenericResponse

Reference Type:  GenericResponse

message
string
A human-readable message describing the result of the operation.
example: User created successfully.
success
boolean
Indicates whether the operation was successful.
example: true
POST /v1/wallet/cards/:id/default
curl -X POST https://api.serverista.com/v1/wallet/cards/:id/default \
  -H "Authorization: ApiKey YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d ''
Response

{
  "message": "example_message",
  "success": true
}

List invoices

List all invoices in current account

Accepts: application/json
Returns: application/json

Parameters

no parameters


Response

array of Invoice

Reference Type:  Invoice

to_date
string
End date of the billing period.
example: 2025-06-30T23:59:59Z
unique_id
string
Unique system-wide identifier for the invoice.
example: inv_9f8e7d6c5b4a3
subtotal_amount
string
Subtotal amount before taxes and discounts.
example: "100.00"
total_amount
string
Total invoice amount after taxes and discounts.
example: "115.00"
vat_amount
string
VAT or tax amount applied to this invoice.
example: "20.00"
billing_month
string
The billing month this invoice covers.
example: 2025-06-01T00:00:00Z
from_date
string
Start date of the billing period.
example: 2025-06-01T00:00:00Z
payment_ref_id
string
Reference ID for the payment transaction.
example: pay_abc123xyz
tax_id
string
Tax identifier associated with the billing account.
example: EU123456789
created_at
string
Timestamp when the invoice was created.
example: 2025-06-30T12:00:00Z
due_date
string
Due date for payment.
example: 2025-07-01T00:00:00Z
id
integer
Unique identifier of the invoice.
example: 1001
invoice_items
array of InvoiceItem
Reference Type: InvoiceItem

List of individual items billed within this invoice.
example: {"plan_id":"2","amount":"50.00","billing_for":"Jun 2025"}
outstanding_amount
string
Remaining unpaid amount for this invoice.
example: "0.00"
updated_at
string
Timestamp when the invoice was last updated.
example: 2025-07-01T11:00:00Z
account_id
integer
Identifier of the account associated with this invoice.
example: 5
discount
string
Discount applied to the subtotal (if any).
example: "5.00"
invoice_number
string
Human-readable invoice number.
example: INV-2025-0001
paid
boolean
Indicates whether the invoice has been fully paid.
example: true
paid_at
string
Timestamp when the invoice was paid, if applicable.
example: 2025-07-01T10:45:00Z
GET /v1/invoices
curl -X GET https://api.serverista.com/v1/invoices \
  -H "Authorization: ApiKey YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d ''
Response
[
{
  "account_id": 123,
  "billing_month": "example_billing_month",
  "created_at": "example_created_at",
  "discount": "example_discount",
  "due_date": "example_due_date",
  "from_date": "example_from_date",
  "id": 123,
  "invoice_items": [
    {
      "...": null
    }
  ],
  "invoice_number": "example_invoice_number",
  "outstanding_amount": "example_outstanding_amount",
  "paid": true,
  "paid_at": "example_paid_at",
  "payment_ref_id": "example_payment_ref_id",
  "subtotal_amount": "example_subtotal_amount",
  "tax_id": "example_tax_id",
  "to_date": "example_to_date",
  "total_amount": "example_total_amount",
  "unique_id": "example_unique_id",
  "updated_at": "example_updated_at",
  "vat_amount": "example_vat_amount"
}
]

Get order

Get an order by id

Accepts: application/json
Returns: application/json

Parameters

URL Params
id
string
Order id

Response

object of Order

Reference Type:  Order

created_at
string
Timestamp when the order was created.
example: 2025-10-31T14:23:00Z
id
integer
Unique identifier of the order.
example: 42
order_plans
array of OrderPlan
Reference Type: OrderPlan

List of plans or services included in the order.
example: {OrderPlan}
unique_id
string
Globally unique identifier for the order.
example: 88-77045-10138
updated_at
string
Timestamp when the order was last updated.
example: 2025-11-01T09:45:00Z
user_id
integer
Identifier of the user who placed the order.
example: 12
account_id
integer
Identifier of the account associated with the order.
example: 5
GET /v1/orders/:id
curl -X GET https://api.serverista.com/v1/orders/:id \
  -H "Authorization: ApiKey YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d ''
Response

{
  "account_id": 123,
  "created_at": "example_created_at",
  "id": 123,
  "order_plans": [
    {
      "...": null
    }
  ],
  "unique_id": "example_unique_id",
  "updated_at": "example_updated_at",
  "user_id": 123
}