VPSBG's dev hub
HomePricingKnowledge BaseContact us
HomePricingKnowledge BaseContact us
  1. API Reference
  2. 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. API Reference
  2. Orders

List orders

GET
https://api.vpsbg.eu/v1/orders
Orders
List all available orders in your VPSBG account.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params
page
integer 
optional
Which page of paginated results to return.
per_page
integer 
optional
How many results per page to be shown.
filter[status]
string 
optional
Filter orders by Status. Default filter is: pending_payment,paid
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 -g --request GET 'https://api.vpsbg.eu/v1/orders?page&per_page&filter[status]' \
--header 'Accept;'

Responses

🟢200Success
application/json
Body
data
array [object {15}] 
required
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
promo
object  | null 
optional
payment_information
object  | null 
optional
links
object 
required
first
string 
required
last
string 
required
prev
null 
required
next
string 
required
meta
object 
required
current_page
integer 
required
from
integer 
required
last_page
integer 
required
links
array [object {3}] 
required
path
string 
required
per_page
integer 
required
to
integer 
required
total
integer 
required
Example
{
  "data": [
    {
      "id": 7736,
      "tax_rate": 1.2,
      "amount": 0,
      "amount_with_vat": 0,
      "amount_from_balance": 146.17,
      "payment_method": "balance",
      "status": "paid",
      "type": "combined",
      "auto_pay": true,
      "promo_applicable": false,
      "created_at": "2025-01-07T13:08:37.000000Z",
      "due_at": "2025-01-07T22:00:00.000000Z",
      "payment_date": "2025-01-07T13:08:46.000000Z",
      "promo": null,
      "payment_information": null
    },
    {
      "id": 7546,
      "tax_rate": 1.2,
      "amount": 41.67,
      "amount_with_vat": 50,
      "amount_from_balance": 0,
      "payment_method": "card",
      "status": "paid",
      "type": "deposit",
      "auto_pay": false,
      "promo_applicable": false,
      "created_at": "2024-10-16T12:05:52.000000Z",
      "due_at": "2024-10-16T21:00:00.000000Z",
      "payment_date": "2024-10-16T12:06:11.000000Z",
      "promo": null,
      "payment_information": {
        "last_4": 4242,
        "brand": "visa",
        "expiry_month": 3,
        "expiry_year": 2033
      }
    },
    {
      "id": 7486,
      "tax_rate": 1.2,
      "amount": 0,
      "amount_with_vat": 0,
      "amount_from_balance": 27,
      "payment_method": "balance",
      "status": "paid",
      "type": "combined",
      "auto_pay": true,
      "promo_applicable": false,
      "created_at": "2024-09-17T12:59:20.000000Z",
      "due_at": "2024-09-17T21:00:00.000000Z",
      "payment_date": "2024-09-17T12:59:24.000000Z",
      "promo": null,
      "payment_information": null
    },
    {
      "id": 7413,
      "tax_rate": 1.2,
      "amount": 0,
      "amount_with_vat": 0,
      "amount_from_balance": 27,
      "payment_method": "balance",
      "status": "paid",
      "type": "new-service",
      "auto_pay": true,
      "promo_applicable": false,
      "created_at": "2024-09-05T14:43:58.000000Z",
      "due_at": "2024-09-05T21:00:00.000000Z",
      "payment_date": "2024-09-05T14:44:05.000000Z",
      "promo": {
        "code": "fall2403",
        "percentage": 10,
        "minimum_billing_cycle": 3
      },
      "payment_information": null
    }
  ],
  "links": {
    "first": "https://api.vpsbg.eu/v1/orders?page=1",
    "last": "https://api.vpsbg.eu/v1/orders?page=360",
    "prev": null,
    "next": "https://api.vpsbg.eu/v1/orders?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 360,
    "links": [
      {
        "url": null,
        "label": "« Previous",
        "active": false
      },
      {
        "url": "https://api.vpsbg.eu/v1/orders?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": "https://api.vpsbg.eu/v1/orders?page=2",
        "label": "2",
        "active": false
      },
      {
        "url": "https://api.vpsbg.eu/v1/orders?page=3",
        "label": "3",
        "active": false
      },
      {
        "url": "https://api.vpsbg.eu/v1/orders?page=4",
        "label": "4",
        "active": false
      },
      {
        "url": "https://api.vpsbg.eu/v1/orders?page=5",
        "label": "5",
        "active": false
      },
      {
        "url": "https://api.vpsbg.eu/v1/orders?page=6",
        "label": "6",
        "active": false
      },
      {
        "url": "https://api.vpsbg.eu/v1/orders?page=7",
        "label": "7",
        "active": false
      },
      {
        "url": "https://api.vpsbg.eu/v1/orders?page=8",
        "label": "8",
        "active": false
      },
      {
        "url": "https://api.vpsbg.eu/v1/orders?page=9",
        "label": "9",
        "active": false
      },
      {
        "url": "https://api.vpsbg.eu/v1/orders?page=10",
        "label": "10",
        "active": false
      },
      {
        "url": null,
        "label": "...",
        "active": false
      },
      {
        "url": "https://api.vpsbg.eu/v1/orders?page=359",
        "label": "359",
        "active": false
      },
      {
        "url": "https://api.vpsbg.eu/v1/orders?page=360",
        "label": "360",
        "active": false
      },
      {
        "url": "https://api.vpsbg.eu/v1/orders?page=2",
        "label": "Next »",
        "active": false
      }
    ],
    "path": "https://api.vpsbg.eu/v1/orders",
    "per_page": 5,
    "to": 5,
    "total": 1796
  }
}
🟠422Validation error (specified in the response)
🔴500Server Error
Modified at 2025-01-09 10:30:37
Previous
Attack bandwidth
Next
Get an order
Built with