Get a bundle

GET

/bundles/{bundle_id}

const url = 'https://api.poweredbyaura.com/v1/bundles/bnd_ng_a_1gb_1d';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.poweredbyaura.com/v1/bundles/bnd_ng_a_1gb_1d \
  --header 'Authorization: Bearer <token>'

Authorizations

apiKey

Parameters

Path Parameters

bundle_id

required

string

Example

bnd_ng_a_1gb_1d

Responses

200

The bundle.

application/json

object

required

string

object

required

string

Allowed value: bundle

network_id

required

string

name

required

The bundle’s name as shown to your customer.

string

data_mb

required

Data allowance in megabytes (1 GB = 1024 MB).

integer

validity_hours

required

How long the customer has to use the data after it is credited.

integer

price

required

Your contracted price for this bundle.

object

amount

required

Amount in the currency’s minor unit (kobo for NGN).

integer

currency

required

ISO 4217 currency code.

string

/^[A-Z]{3}$/

available

required

Whether the bundle can be bought right now.

boolean

Examples

bundle

A one-day bundle

{
  "id": "bnd_ng_a_1gb_1d",
  "object": "bundle",
  "network_id": "net_ng_a",
  "name": "1GB Daily",
  "data_mb": 1024,
  "validity_hours": 24,
  "price": {
    "amount": 35000,
    "currency": "NGN"
  },
  "available": true
}

Headers

Aura-Request-Id

string

Example

req_7Kp2Vx9QmR4t

A unique ID for this request. Quote it when you contact your technical contact.

401

The API key is missing, wrong or revoked.

application/json

object

error

required

object

code

required

A stable, machine-readable code. New codes may be added in v1, so treat an unknown code by its HTTP status and retryable flag.

string

Allowed values: invalid_request invalid_phone_number invalid_api_key ip_not_allowed not_found insufficient_balance reference_conflict bundle_unavailable network_mismatch unsupported_network rate_limited internal_error network_unavailable

message

required

A human-readable explanation. Do not parse it; use code.

string

param

The request field the error is about, when there is one.

string

retryable

required

Whether the same request can succeed if you retry it later.

boolean

request_id

required

string

details

Extra facts about the error, such as the existing purchase or the network’s status.

object

key

additional properties

any

Examples

invalidKey

{
  "error": {
    "code": "invalid_api_key",
    "message": "The API key is not valid.",
    "retryable": false,
    "request_id": "req_2Mz6Rt8KcW1p"
  }
}

Headers

Aura-Request-Id

string

Example

req_7Kp2Vx9QmR4t

A unique ID for this request. Quote it when you contact your technical contact.

404

No such resource on your account.

application/json

object

error

required

object

code

required

A stable, machine-readable code. New codes may be added in v1, so treat an unknown code by its HTTP status and retryable flag.

string

message

required

A human-readable explanation. Do not parse it; use code.

string

param

The request field the error is about, when there is one.

string

retryable

required

Whether the same request can succeed if you retry it later.

boolean

request_id

required

string

details

Extra facts about the error, such as the existing purchase or the network’s status.

object

key

additional properties

any

Examples

notFound

{
  "error": {
    "code": "not_found",
    "message": "No purchase pur_01JA7ZK3Q9W2D8M5X4N6B1C0VX on this account.",
    "retryable": false,
    "request_id": "req_8Wc3Ld5YhF2k"
  }
}

Headers

Aura-Request-Id

string

Example

req_7Kp2Vx9QmR4t

A unique ID for this request. Quote it when you contact your technical contact.