Purchase support plan - VPSBG's dev hub

This endpoint will create a new order for the selected support plan. After payment, the support plan will be activated.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

string

required

Default:

application/json

Body Params application/json

billing_cycle

integer

required

Can be: 1, 3, 6, 12, 24 months.

>= 1<= 24

Example:

plan

string

required

Plan key of the desired support plan.

Example

{
    "billing_cycle": 1,
    "plan": "professional"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

application/json

Body

integer

required

Example:

200158

tax_rate

number

required

Example:

1.2

amount

number

required

Amount without VAT adjustments.

Example:

amount_with_vat

number

required

Amount adjusted for your VAT when applicable.

Example:

amount_from_balance

number

required

Amount withdrawn from balance once paid.

Example:

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

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:

amount_with_vat

number

required

Amount adjusted for your VAT when applicable.

Example:

type

string

required

Example:

proform

order_ids

array[integer]

required

promo

object | null

optional

code

string

required

Example:

fall2403

percentage

number

optional

Example:

minimum_billing_cycle

integer

required

The minimum billing cycle for which the promo is valid.

Example:

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:

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:

service_minimum_billing_cycle

integer | null

optional

The minimum possible billing cycle of the given service.

Example:

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": 200158,
    "tax_rate": 1.2,
    "amount": 15,
    "amount_with_vat": 18,
    "amount_from_balance": 0,
    "payment_method": "balance",
    "status": "processing",
    "type": "new-service",
    "auto_pay": true,
    "promo_applicable": true,
    "created_at": "2024-09-25T18:34:33.000000Z",
    "due_at": "2024-10-25T18:34:33.000000Z",
    "payment_date": "2024-11-25T18:34:33.000000Z",
    "invoices": [
        {
            "id": 8552,
            "invoice_number": "0000007513",
            "created_at": "2024-09-24T21:00:00.000000Z",
            "amount": 15,
            "amount_with_vat": 18,
            "type": "proform",
            "order_ids": [
                208465
            ]
        }
    ],
    "promo": {
        "code": "fall2403",
        "percentage": 10,
        "minimum_billing_cycle": 3
    },
    "payment_information": {
        "last_4": "4242",
        "brand": "visa",
        "expiry_month": "05",
        "expiry_year": "2028",
        "tx_hash": "cbba72720e562761a1a1a32b04665cfc16356d0fd27ff8144e15df3a5329f87a",
        "tx_amount": "0.002793",
        "confirmed_at": "2024-12-10T22:00:00.000000Z"
    },
    "services": [
        {
            "label": "Cloud VPS 4 GB - cpanel.server.com",
            "sublabel": "87.120.37.46",
            "period_from": 1733781600,
            "period_to": 1741557600,
            "is_period_changeable": false,
            "service_id": 2887,
            "service_billing_cycle": 3,
            "service_minimum_billing_cycle": 1,
            "service_type": "server",
            "amount": 117,
            "amount_with_vat": 140.4,
            "amount_sublabel": "string",
            "promo": {
                "code": "string",
                "percentage": 0
            }
        }
    ]
}

🟠422Validation error (specified in the response)

🔴500Server Error