VPSBG's dev hub
HomePricingKnowledge BaseContact us
HomePricingKnowledge BaseContact us
  1. Orders
  • 👋 Hello
  • API Introduction
    • API Introduction
    • How to generate API key?
  • API Reference
    • User
      • 2FA
        • Get 2FA secret key
        • Enable 2FA
        • Disable 2FA
      • Update user
      • Get account information
    • Balance
      • Balance
      • Deposit funds
      • List balance transactions
    • Affiliate
      • Get affiliate information
      • List conversions
      • List payouts
      • Activate affiliate program
      • Update referral code
    • Invoices
      • List invoices
      • Download an invoice
      • Download invoices
    • Support
      • Tickets
        • List tickets
        • List departments
        • List related services
        • Get a ticket
        • Create new ticket
        • Reply to ticket
        • Mark ticket as resolved
        • Download attachment
      • List plans
      • Purchase support plan
      • Renew support plan
      • Cancel support plan
      • Undo cancel request
    • SSH Keys
      • Get an SSH Key
      • Update SSH Key
      • Delete SSH Key
      • List SSH keys
      • Add SSH Key
    • Servers
      • Scale
        • List plans
        • Calculate scale cost
        • Scale a server
      • Addons
        • List available addons
        • Scale addons
        • Calculate scale cost
        • Purchase new addons
        • Cancel addon
        • Undo cancel request
      • Rescue
        • Enable rescue mode
        • Disable rescue mode
      • List plans
      • List servers
      • Server status
      • Get a server
      • Server metrics
      • Bandwidth
      • Deploy new server
      • Start a server
      • Restart a server
      • Stop a server
      • Power off
      • Cancel server
      • Undo cancel request
      • Change password
      • Update hostname
      • Update SSH Keys
      • Modify ISOs
      • Restore
      • Renew server
      • Reinstall Server
      • Change Primary IP
      • Calculate renew amount
    • Plans
      • Plan addon
      • Plan promo-codes
    • Snapshots
      • List snapshots
      • Delete snapshot
    • Backups
      • List backups
      • Delete backup
    • Server Images
      • List server images
    • Floating IPs
      • List Floating IPs
      • Plans
      • Purchase Floating IPs
      • Attach Floating IP
      • Detach Floating IP
      • Cancel Floating IP
      • Delete Floating IP Cancellation
    • IP Addresses
      • Update IP address
    • Network Protection
      • Geo filter
        • Get current geo filter
        • Set geo filter
        • Update geo filter
        • Delete geo filter
      • Whitelist
        • Get status and list of IPs
        • Whitelist IP addresses
        • Update IP addresses list
        • Delete all rules
      • Blacklist
        • Get status and list of IPs
        • Blacklist IP addresses
        • Update IP addresses list
        • Delete all rules
      • General information
      • Bandwidth
      • List blocked IPs
      • List attacks
      • Get an attack
      • Attack bandwidth
    • Orders
      • List orders
        GET
      • Get an order
        GET
      • Delete order
        DELETE
      • Pay orders
        POST
      • Update order
        PATCH
      • Change renewal period
        PATCH
    • ISOs
      • Get an ISO
      • Delete an ISO
      • List ISOs
      • Add ISO
  1. Orders

Get an order

GET
https://api.vpsbg.eu/v1/orders/{id}
Orders
This endpoint will return data regarding your order.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
id
string 
required
Header Params
Accept
string 
required
Default:
application/json

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.vpsbg.eu/v1/orders/' \
--header 'Accept;'

Responses

🟢200Successfully retrieved order.
application/json
Body
id
integer 
required
Example:
200158
tax_rate
number 
required
Example:
1.2
amount
number 
required
Amount without VAT adjustments.
Example:
15
amount_with_vat
number 
required
Amount adjusted for your VAT when applicable.
Example:
18
amount_from_balance
number 
required
Amount withdrawn from balance once paid.
Example:
0
payment_method
string 
required
Examples:
balance card bankbitcoinbitcoin-ln
status
string 
required
Examples:
processingcancelledpaidawaiting_payment
type
string 
required
Examples:
new-servicerenew-servicescale-servicenew-addoncombineddepositcustomnew-floating-ipscale-addon
auto_pay
boolean 
required
Wether the order will try automatically pay itself.
Default:
true
promo_applicable
boolean 
required
Wether the order can have promo code applied.
Default:
true
created_at
string 
required
Example:
2024-09-25T18:34:33.000000Z
due_at
string 
required
Example:
2024-10-25T18:34:33.000000Z
payment_date
string  | null 
optional
Example:
2024-11-25T18:34:33.000000Z
invoices
array [object {7}] 
required
id
integer 
required
Example:
8552
invoice_number
string 
required
Example:
0000007513
created_at
string 
required
Example:
2024-09-24T21:00:00.000000Z
amount
number 
required
Amount without VAT adjustments.
Example:
15
amount_with_vat
number 
required
Amount adjusted for your VAT when applicable.
Example:
18
type
string 
required
Example:
proform
order_ids
array[integer]
required
promo
object  | null 
optional
code
string 
required
Example:
fall2403
percentage
number 
optional
Example:
10
minimum_billing_cycle
integer 
required
The minimum billing cycle for which the promo is valid.
Example:
3
payment_information
object  | null 
optional
last_4
string 
optional
Last 4 digits of a card. Field present only if paid by a card.
Example:
4242
brand
string 
optional
Card brand. Field present only if paid by a card.
Example:
visa
expiry_month
string 
optional
Card expiry month. Field present only if paid by a card.
Example:
05
expiry_year
string 
optional
Card expiry year. Field present only if paid by a card.
Example:
2028
tx_hash
string 
optional
BTC transaction hash. Field present only if paid by BTC.
Example:
cbba72720e562761a1a1a32b04665cfc16356d0fd27ff8144e15df3a5329f87a
tx_amount
string 
optional
Transaction amount. Field present only if paid by BTC.
Example:
0.002793
confirmed_at
string 
optional
Transaction confirmation date. Field present only if paid by BTC.
Example:
2024-12-10T22:00:00.000000Z
services
array [object {13}] 
required
label
string 
required
Name of your service.
Example:
Cloud VPS 4 GB - cpanel.server.com
sublabel
string  | null 
optional
Any aditional information for the service.
Example:
87.120.37.46
period_from
integer 
required
Timestamp of the start date of the service's billing cycle.
Example:
1733781600
period_to
integer 
required
Timestamp of the end date of the service's billing cycle.
Example:
1741557600
is_period_changeable
boolean 
required
Indicates if the order is applicable for a period change.
Default:
false
service_id
integer  | null 
optional
The id of the current service.
Example:
2887
service_billing_cycle
integer  | null 
optional
Example:
3
service_minimum_billing_cycle
integer  | null 
optional
The minimum possible billing cycle of the given service.
Example:
1
service_type
string 
required
Default:
server
Examples:
servershared-hostingfloating-ipsupportserver-addonhosting-addondiscount
amount
number 
required
Example:
117
amount_with_vat
number 
required
Example:
140.4
amount_sublabel
string 
required
Any aditional information for the amount.
promo
object  | null 
required
Example
{
  "id": 7756,
  "tax_rate": 1.2,
  "amount": 281.83,
  "amount_with_vat": 338.2,
  "amount_from_balance": 0,
  "payment_method": "balance",
  "status": "awaiting_payment",
  "type": "combined",
  "auto_pay": true,
  "promo_applicable": false,
  "created_at": "2025-01-13T14:21:27.000000Z",
  "due_at": "2025-01-27T22:00:00.000000Z",
  "payment_date": null,
  "invoices": [
    {
      "id": 8700,
      "invoice_number": "0000007756",
      "created_at": "2025-01-12T22:00:00.000000Z",
      "amount": 281.83,
      "amount_with_vat": 338.2,
      "type": "proform",
      "order_ids": [
        7756
      ]
    }
  ],
  "promo": null,
  "payment_information": null,
  "services": [
    {
      "label": "Renewal: Cloud VPS 4 GB - ubuntu-2gb [87.121.52.160]",
      "sublabel": null,
      "period_from": 1739138400,
      "period_to": 1754773200,
      "is_period_changeable": true,
      "service_id": 2901,
      "service_billing_cycle": 6,
      "service_minimum_billing_cycle": 1,
      "service_type": "server",
      "amount": 234,
      "amount_with_vat": 280.8,
      "amount_sublabel": "",
      "promo": null
    },
    {
      "label": "Automatic backups (60 GB)",
      "sublabel": null,
      "period_from": 1739138400,
      "period_to": 1754773200,
      "is_period_changeable": false,
      "service_id": 863,
      "service_billing_cycle": null,
      "service_minimum_billing_cycle": null,
      "service_type": "server-addon",
      "amount": 36,
      "amount_with_vat": 43.2,
      "amount_sublabel": "",
      "promo": null
    },
    {
      "label": "Renewal: Floating IP(s) (19 March 2025 - 10 August 2025)",
      "sublabel": "87.121.52.159",
      "period_from": null,
      "period_to": null,
      "is_period_changeable": false,
      "service_id": null,
      "service_billing_cycle": null,
      "service_minimum_billing_cycle": null,
      "service_type": null,
      "amount": 11.83,
      "amount_with_vat": 14.2,
      "amount_sublabel": "",
      "promo": null
    }
  ]
}
🟠401Unauthorized
🔴500Server Error
Previous
List orders
Next
Delete order
Built with