Box’a’Fox
API referenceData

Data ledger

GET
/v1/data/ledger

Top-ups, usage (one negative row per network per day), expiry, restore, adjustments, refunds.

Authorization

ApiKey
headerX-API-Key<token>

prx_live_<40 base62>

Query Parameters

page?integer
Formatint64
Range1 <= value
Default1
per_page?integer
Formatint64
Range1 <= value <= 100
Default25
sort_by?string

created_at or created_at_desc (default).

network?string
Value in"residential""mobile"
reason?string
Value in"purchase""usage""expiry""restore""adjustment""refund""provisioning_failed"
min_created_at?string
Formatdate-time
max_created_at?string
Formatdate-time

Response Body

OK

application/json
  1. response
data*array<>|null
message*string
page*integer

Current page (1-based).

Formatint64
per_page*integer

Items per page (1–100).

Formatint64
total_count*integer

Exact total across all pages.

Formatint64
curl -X GET "https://example.com/v1/data/ledger"
{  "data": [    {      "bytes": 0,      "created_at": "2019-08-24T14:15:22Z",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "network": "residential",      "order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",      "period_date": "2019-08-24",      "reason": "purchase"    }  ],  "message": "OK",  "page": 1,  "per_page": 25,  "total_count": 137}

Price a cart POST

Prices a cart without buying it. A cart that cannot be bought is not an error: the answer has is_valid=false and invalid_reason. A malformed request is still 400.

Targeting options for mobile GET

Countries and the targeting options below them. Refreshed every 6 hours. Supports ETag / If-None-Match.