Orders

Residential order management — list, show, create, calculate pricing

Calculate pricing for a residential order

get

Returns the total price for a residential order of the given quantity, optionally applying a coupon. Does not create the order.

Authorizations

api_token

AuthorizationstringRequired

API token generated in the MarsProxies dashboard under /settings. Send it as a Bearer token in the Authorization header.

Query parameters

quantityintegerRequired

Amount of residential traffic to price, in gigabytes.

Example: 10

coupon_codestringOptional

Optional coupon code to apply to the calculation.

Example: MARS15

Responses

200

Calculated pricing

application/json

Total price for the requested residential traffic quantity, optionally discounted by coupon.

totalstringRequired

Calculated total price in USD.

Example: 79.99

401

Missing or invalid API token

application/json

403

Residential API is not enabled for this account

application/json

404

Residential user record not found for this account

application/json

422

Request validation failed

application/json

429

Rate limit exceeded

application/json

500

Unknown error

application/json

get/v1/residential/orders/calculate-pricing

cURLPHPPythonNode.jsJavaGoC#

curl --request GET \
  --url 'https://api.marsproxies.com/v1/residential/orders/calculate-pricing?quantity=10&coupon_code=MARS15' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

{
  "total": "79.99"
}

List residential orders

get

Returns a paginated list of residential orders for the account.

Authorizations

api_token

AuthorizationstringRequired

API token generated in the MarsProxies dashboard under /settings. Send it as a Bearer token in the Authorization header.

Query parameters

pageintegerOptional

Page number to fetch. Defaults to 1.

Example: 1

per_pageintegerOptional

Number of orders per page (1-100). Defaults to 20.

Example: 20

Responses

200

Paginated residential orders

application/json

Paginated list of residential orders.

401

Missing or invalid API token

application/json

403

Residential API is not enabled for this account

application/json

404

Residential user record not found for this account

application/json

422

Pagination parameters failed validation

application/json

429

Rate limit exceeded

application/json

500

Unknown error

application/json

get/v1/residential/orders

cURLPHPPythonNode.jsJavaGoC#

curl --request GET \
  --url 'https://api.marsproxies.com/v1/residential/orders?page=1&per_page=20' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

{
  "data": [
    {
      "id": 912345,
      "product_name": "Residential Proxies",
      "status": "confirmed",
      "amount": 79.99,
      "quantity": 10,
      "created_at": "2026-04-12 10:42:08"
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 5,
    "per_page": 20,
    "total": 84
  }
}

Create a residential order

post

Purchases a residential order for the account. Payment is made either from the account balance or from a saved card when card_id is supplied.

Authorizations

api_token

AuthorizationstringRequired

API token generated in the MarsProxies dashboard under /settings. Send it as a Bearer token in the Authorization header.

Body

application/json

Payload for purchasing a residential order.

quantityintegerRequired

Amount of residential traffic to purchase, in gigabytes.

Example: 10

coupon_codestring · nullableOptional

Optional coupon code to apply to the order for a discount.

Example: MARS15

card_idinteger · nullableOptional

Optional saved card identifier to charge. Omit to charge the account balance.

Example: 4271

Responses

200

Created residential order

application/json

A single residential order.

idintegerRequired

Unique order identifier.

Example: 912345

product_namestringRequired

Name of the product.

Example: Residential Proxies

statusstring · enumRequired

Order lifecycle status.

Example: confirmedPossible values:

amountnumber · floatRequired

Order amount charged, in USD.

Example: 79.99

quantitynumber · floatRequired

Amount of residential traffic, in gigabytes.

Example: 10

created_atstring · date-timeRequired

Timestamp when the order was created.

Example: 2026-04-12 10:42:08

401

Missing or invalid API token

application/json

402

Account balance is not sufficient to complete the order

application/json

403

Residential API is not enabled for this account

application/json

404

Residential user record not found for this account

application/json

422

Request body validation failed

application/json

423

Another order for this account is currently being processed

application/json

429

Rate limit exceeded

application/json

500

Unknown error

application/json

post/v1/residential/orders

cURLPHPPythonNode.jsJavaGoC#

curl --request POST \
  --url https://api.marsproxies.com/v1/residential/orders \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"quantity":10,"coupon_code":"MARS15","card_id":4271}'

{
  "id": 912345,
  "product_name": "Residential Proxies",
  "status": "confirmed",
  "amount": 79.99,
  "quantity": 10,
  "created_at": "2026-04-12 10:42:08"
}

Get a residential order

get

Returns a single residential order owned by the account.

Authorizations

api_token

AuthorizationstringRequired

API token generated in the MarsProxies dashboard under /settings. Send it as a Bearer token in the Authorization header.

Path parameters

orderintegerRequired

Residential order identifier.

Example: 912345

Responses

200

Residential order details

application/json

A single residential order.

idintegerRequired

Unique order identifier.

Example: 912345

product_namestringRequired

Name of the product.

Example: Residential Proxies

statusstring · enumRequired

Order lifecycle status.

Example: confirmedPossible values:

amountnumber · floatRequired

Order amount charged, in USD.

Example: 79.99

quantitynumber · floatRequired

Amount of residential traffic, in gigabytes.

Example: 10

created_atstring · date-timeRequired

Timestamp when the order was created.

Example: 2026-04-12 10:42:08

401

Missing or invalid API token

application/json

403

Residential API is not enabled for this account

application/json

404

Order not found or the residential user record does not exist

application/json

429

Rate limit exceeded

application/json

500

Unknown error

application/json

get/v1/residential/orders/{order}

cURLPHPPythonNode.jsJavaGoC#

curl --request GET \
  --url https://api.marsproxies.com/v1/residential/orders/912345 \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

{
  "id": 912345,
  "product_name": "Residential Proxies",
  "status": "confirmed",
  "amount": 79.99,
  "quantity": 10,
  "created_at": "2026-04-12 10:42:08"
}