Create credit pool

curl --request POST \
  --url https://api.useaira.com/v1/credit-pools/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "currencyUnitCode": "USD",
  "startDate": "2023-12-25",
  "renewalCreditAmount": "<string>",
  "topUpSettings": {
    "creditPackageAmount": "<string>",
    "price": 2
  }
}
'

import requests

url = "https://api.useaira.com/v1/credit-pools/"

payload = {
    "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "currencyUnitCode": "USD",
    "startDate": "2023-12-25",
    "renewalCreditAmount": "<string>",
    "topUpSettings": {
        "creditPackageAmount": "<string>",
        "price": 2
    }
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    customerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    currencyUnitCode: 'USD',
    startDate: '2023-12-25',
    renewalCreditAmount: '<string>',
    topUpSettings: {creditPackageAmount: '<string>', price: 2}
  })
};

fetch('https://api.useaira.com/v1/credit-pools/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.useaira.com/v1/credit-pools/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'customerId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'currencyUnitCode' => 'USD',
    'startDate' => '2023-12-25',
    'renewalCreditAmount' => '<string>',
    'topUpSettings' => [
        'creditPackageAmount' => '<string>',
        'price' => 2
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.useaira.com/v1/credit-pools/"

	payload := strings.NewReader("{\n  \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"currencyUnitCode\": \"USD\",\n  \"startDate\": \"2023-12-25\",\n  \"renewalCreditAmount\": \"<string>\",\n  \"topUpSettings\": {\n    \"creditPackageAmount\": \"<string>\",\n    \"price\": 2\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.useaira.com/v1/credit-pools/")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"currencyUnitCode\": \"USD\",\n  \"startDate\": \"2023-12-25\",\n  \"renewalCreditAmount\": \"<string>\",\n  \"topUpSettings\": {\n    \"creditPackageAmount\": \"<string>\",\n    \"price\": 2\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.useaira.com/v1/credit-pools/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"currencyUnitCode\": \"USD\",\n  \"startDate\": \"2023-12-25\",\n  \"renewalCreditAmount\": \"<string>\",\n  \"topUpSettings\": {\n    \"creditPackageAmount\": \"<string>\",\n    \"price\": 2\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "currencyUnitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "startDate": "2023-12-25",
  "renewalCreditAmount": "<string>",
  "availableAmount": "<string>",
  "scheduleRenewalDate": "2023-12-25",
  "topUpSettings": {
    "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "creditPackageAmount": "<string>",
    "price": 2
  },
  "currencyUnit": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "code": "BRL"
  }
}

{
  "message": "<string>",
  "code": "<string>",
  "details": {},
  "causations": [
    {
      "message": "<string>",
      "code": "<string>",
      "details": {}
    }
  ]
}

{
  "message": "<string>"
}

POST

credit-pools

Create credit pool

curl --request POST \
  --url https://api.useaira.com/v1/credit-pools/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "currencyUnitCode": "USD",
  "startDate": "2023-12-25",
  "renewalCreditAmount": "<string>",
  "topUpSettings": {
    "creditPackageAmount": "<string>",
    "price": 2
  }
}
'

import requests

url = "https://api.useaira.com/v1/credit-pools/"

payload = {
    "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "currencyUnitCode": "USD",
    "startDate": "2023-12-25",
    "renewalCreditAmount": "<string>",
    "topUpSettings": {
        "creditPackageAmount": "<string>",
        "price": 2
    }
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    customerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    currencyUnitCode: 'USD',
    startDate: '2023-12-25',
    renewalCreditAmount: '<string>',
    topUpSettings: {creditPackageAmount: '<string>', price: 2}
  })
};

fetch('https://api.useaira.com/v1/credit-pools/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.useaira.com/v1/credit-pools/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'customerId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'currencyUnitCode' => 'USD',
    'startDate' => '2023-12-25',
    'renewalCreditAmount' => '<string>',
    'topUpSettings' => [
        'creditPackageAmount' => '<string>',
        'price' => 2
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.useaira.com/v1/credit-pools/"

	payload := strings.NewReader("{\n  \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"currencyUnitCode\": \"USD\",\n  \"startDate\": \"2023-12-25\",\n  \"renewalCreditAmount\": \"<string>\",\n  \"topUpSettings\": {\n    \"creditPackageAmount\": \"<string>\",\n    \"price\": 2\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.useaira.com/v1/credit-pools/")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"currencyUnitCode\": \"USD\",\n  \"startDate\": \"2023-12-25\",\n  \"renewalCreditAmount\": \"<string>\",\n  \"topUpSettings\": {\n    \"creditPackageAmount\": \"<string>\",\n    \"price\": 2\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.useaira.com/v1/credit-pools/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"currencyUnitCode\": \"USD\",\n  \"startDate\": \"2023-12-25\",\n  \"renewalCreditAmount\": \"<string>\",\n  \"topUpSettings\": {\n    \"creditPackageAmount\": \"<string>\",\n    \"price\": 2\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "currencyUnitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "startDate": "2023-12-25",
  "renewalCreditAmount": "<string>",
  "availableAmount": "<string>",
  "scheduleRenewalDate": "2023-12-25",
  "topUpSettings": {
    "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "creditPackageAmount": "<string>",
    "price": 2
  },
  "currencyUnit": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "code": "BRL"
  }
}

{
  "message": "<string>",
  "code": "<string>",
  "details": {},
  "causations": [
    {
      "message": "<string>",
      "code": "<string>",
      "details": {}
    }
  ]
}

{
  "message": "<string>"
}

Authorizations

X-API-KEY

string

header

required

API Key Authentication.

Body

application/json

A credit pool object with initial configuration and top-up settings.

customerId

string<uuid>

required

The unique identifier of the customer the credit pool belongs to.

currencyUnitCode

string

required

Code of the currency unit the pool's credits are denominated in. Must be a non-default currency unit registered on the tenant.

Example:

"USD"

startDate

string<date>

required

Date the credit pool starts, when the initial credits are loaded.

renewalCreditAmount

string

required

Amount of credits granted to the pool on each renewal, as a decimal string in the pool's currency unit.

Pattern: ^\d+(\.\d{1,6})?$

topUpSettings

object

required

The top-up settings of the credit pool: the credit package purchased when the pool's balance needs replenishing.

Show child attributes

Response

The request was successfully processed, and the credit pool has been created.

string<uuid>

required

The unique identifier of the credit pool in our system.

customerId

string<uuid>

required

The unique identifier of the customer the credit pool belongs to.

currencyUnitId

string<uuid>

required

The unique identifier of the currency unit the pool's credits are denominated in.

startDate

string<date>

required

Date the credit pool starts, when the initial credits are loaded.

renewalCreditAmount

string

required

Amount of credits granted to the pool on each renewal, as a decimal string in the pool's currency unit.

Pattern: ^\d+(\.\d{1,6})?$

availableAmount

string

required

Current credit balance available for consumption, as a decimal string in the pool's currency unit.

Pattern: ^\d+(\.\d{1,6})?$

scheduleRenewalDate

string<date>

required

Date of the next scheduled renewal, when renewalCreditAmount is granted to the pool.

topUpSettings

object

required

Schema representing the top-up settings of a credit pool: the credit package purchased when the pool's balance needs replenishing. Purchases appear on invoices as credit purchase line items.

Show child attributes

currencyUnit

object

required

Schema representing a currency unit: the unit credits and credit-consuming usage are denominated in. BRL is the default; tenants can define custom credit units.

Show child attributes

Update plan instance

Update credit pool