Record bulk usage events

POST

sdk

usages

bulk

curl --request POST \
  --url https://api.solvapay.com/v1/sdk/usages/bulk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": [
    {
      "customerRef": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "actionType": "api_call",
      "description": "<string>",
      "duration": 1,
      "errorMessage": "<string>",
      "idempotencyKey": "<string>",
      "metadata": {},
      "outcome": "success",
      "productRef": "<string>",
      "purchaseRef": "<string>",
      "units": 1
    }
  ]
}
'

import requests

url = "https://api.solvapay.com/v1/sdk/usages/bulk"

payload = { "events": [
        {
            "customerRef": "<string>",
            "timestamp": "2023-11-07T05:31:56Z",
            "actionType": "api_call",
            "description": "<string>",
            "duration": 1,
            "errorMessage": "<string>",
            "idempotencyKey": "<string>",
            "metadata": {},
            "outcome": "success",
            "productRef": "<string>",
            "purchaseRef": "<string>",
            "units": 1
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    events: [
      {
        customerRef: '<string>',
        timestamp: '2023-11-07T05:31:56Z',
        actionType: 'api_call',
        description: '<string>',
        duration: 1,
        errorMessage: '<string>',
        idempotencyKey: '<string>',
        metadata: {},
        outcome: 'success',
        productRef: '<string>',
        purchaseRef: '<string>',
        units: 1
      }
    ]
  })
};

fetch('https://api.solvapay.com/v1/sdk/usages/bulk', 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.solvapay.com/v1/sdk/usages/bulk",
  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([
    'events' => [
        [
                'customerRef' => '<string>',
                'timestamp' => '2023-11-07T05:31:56Z',
                'actionType' => 'api_call',
                'description' => '<string>',
                'duration' => 1,
                'errorMessage' => '<string>',
                'idempotencyKey' => '<string>',
                'metadata' => [
                                
                ],
                'outcome' => 'success',
                'productRef' => '<string>',
                'purchaseRef' => '<string>',
                'units' => 1
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.solvapay.com/v1/sdk/usages/bulk"

	payload := strings.NewReader("{\n  \"events\": [\n    {\n      \"customerRef\": \"<string>\",\n      \"timestamp\": \"2023-11-07T05:31:56Z\",\n      \"actionType\": \"api_call\",\n      \"description\": \"<string>\",\n      \"duration\": 1,\n      \"errorMessage\": \"<string>\",\n      \"idempotencyKey\": \"<string>\",\n      \"metadata\": {},\n      \"outcome\": \"success\",\n      \"productRef\": \"<string>\",\n      \"purchaseRef\": \"<string>\",\n      \"units\": 1\n    }\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.solvapay.com/v1/sdk/usages/bulk")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"events\": [\n    {\n      \"customerRef\": \"<string>\",\n      \"timestamp\": \"2023-11-07T05:31:56Z\",\n      \"actionType\": \"api_call\",\n      \"description\": \"<string>\",\n      \"duration\": 1,\n      \"errorMessage\": \"<string>\",\n      \"idempotencyKey\": \"<string>\",\n      \"metadata\": {},\n      \"outcome\": \"success\",\n      \"productRef\": \"<string>\",\n      \"purchaseRef\": \"<string>\",\n      \"units\": 1\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.solvapay.com/v1/sdk/usages/bulk")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"events\": [\n    {\n      \"customerRef\": \"<string>\",\n      \"timestamp\": \"2023-11-07T05:31:56Z\",\n      \"actionType\": \"api_call\",\n      \"description\": \"<string>\",\n      \"duration\": 1,\n      \"errorMessage\": \"<string>\",\n      \"idempotencyKey\": \"<string>\",\n      \"metadata\": {},\n      \"outcome\": \"success\",\n      \"productRef\": \"<string>\",\n      \"purchaseRef\": \"<string>\",\n      \"units\": 1\n    }\n  ]\n}"

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

{
  "inserted": 2,
  "results": [
    {
      "reference": "usage_A1B2C3D4",
      "creditDebit": {
        "amount": 100,
        "debited": true,
        "remainingUnits": 99,
        "unitsRemaining": 99,
        "autoRecharge": {
          "triggered": true
        }
      }
    }
  ],
  "success": true
}

Authorizations

Authorization

string

header

required

Provider secret API key (sk_sandbox_… / sk_live_…) supplied as a Bearer token.

Body

application/json

events

object[]

required

Required array length: 1 - 1000 elements

Show child attributes

Response

Bulk usage events processed

inserted

number

required

Number of usage events inserted

Example:

2

results

object[]

required

Show child attributes

success

boolean

required

Example:

true

⌘I

Record bulk usage events

curl --request POST \
  --url https://api.solvapay.com/v1/sdk/usages/bulk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": [
    {
      "customerRef": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "actionType": "api_call",
      "description": "<string>",
      "duration": 1,
      "errorMessage": "<string>",
      "idempotencyKey": "<string>",
      "metadata": {},
      "outcome": "success",
      "productRef": "<string>",
      "purchaseRef": "<string>",
      "units": 1
    }
  ]
}
'

import requests

url = "https://api.solvapay.com/v1/sdk/usages/bulk"

payload = { "events": [
        {
            "customerRef": "<string>",
            "timestamp": "2023-11-07T05:31:56Z",
            "actionType": "api_call",
            "description": "<string>",
            "duration": 1,
            "errorMessage": "<string>",
            "idempotencyKey": "<string>",
            "metadata": {},
            "outcome": "success",
            "productRef": "<string>",
            "purchaseRef": "<string>",
            "units": 1
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    events: [
      {
        customerRef: '<string>',
        timestamp: '2023-11-07T05:31:56Z',
        actionType: 'api_call',
        description: '<string>',
        duration: 1,
        errorMessage: '<string>',
        idempotencyKey: '<string>',
        metadata: {},
        outcome: 'success',
        productRef: '<string>',
        purchaseRef: '<string>',
        units: 1
      }
    ]
  })
};

fetch('https://api.solvapay.com/v1/sdk/usages/bulk', 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.solvapay.com/v1/sdk/usages/bulk",
  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([
    'events' => [
        [
                'customerRef' => '<string>',
                'timestamp' => '2023-11-07T05:31:56Z',
                'actionType' => 'api_call',
                'description' => '<string>',
                'duration' => 1,
                'errorMessage' => '<string>',
                'idempotencyKey' => '<string>',
                'metadata' => [
                                
                ],
                'outcome' => 'success',
                'productRef' => '<string>',
                'purchaseRef' => '<string>',
                'units' => 1
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.solvapay.com/v1/sdk/usages/bulk"

	payload := strings.NewReader("{\n  \"events\": [\n    {\n      \"customerRef\": \"<string>\",\n      \"timestamp\": \"2023-11-07T05:31:56Z\",\n      \"actionType\": \"api_call\",\n      \"description\": \"<string>\",\n      \"duration\": 1,\n      \"errorMessage\": \"<string>\",\n      \"idempotencyKey\": \"<string>\",\n      \"metadata\": {},\n      \"outcome\": \"success\",\n      \"productRef\": \"<string>\",\n      \"purchaseRef\": \"<string>\",\n      \"units\": 1\n    }\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.solvapay.com/v1/sdk/usages/bulk")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"events\": [\n    {\n      \"customerRef\": \"<string>\",\n      \"timestamp\": \"2023-11-07T05:31:56Z\",\n      \"actionType\": \"api_call\",\n      \"description\": \"<string>\",\n      \"duration\": 1,\n      \"errorMessage\": \"<string>\",\n      \"idempotencyKey\": \"<string>\",\n      \"metadata\": {},\n      \"outcome\": \"success\",\n      \"productRef\": \"<string>\",\n      \"purchaseRef\": \"<string>\",\n      \"units\": 1\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.solvapay.com/v1/sdk/usages/bulk")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"events\": [\n    {\n      \"customerRef\": \"<string>\",\n      \"timestamp\": \"2023-11-07T05:31:56Z\",\n      \"actionType\": \"api_call\",\n      \"description\": \"<string>\",\n      \"duration\": 1,\n      \"errorMessage\": \"<string>\",\n      \"idempotencyKey\": \"<string>\",\n      \"metadata\": {},\n      \"outcome\": \"success\",\n      \"productRef\": \"<string>\",\n      \"purchaseRef\": \"<string>\",\n      \"units\": 1\n    }\n  ]\n}"

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

{
  "inserted": 2,
  "results": [
    {
      "reference": "usage_A1B2C3D4",
      "creditDebit": {
        "amount": 100,
        "debited": true,
        "remainingUnits": 99,
        "unitsRemaining": 99,
        "autoRecharge": {
          "triggered": true
        }
      }
    }
  ],
  "success": true
}

Activation

Auto Recharge

Checkout Sessions

Credits

Customers

Limits

Merchant

Meter Events

Payment Intents

Payment Methods

Platform Config

Products

Plans

Purchases

Usage

User Info

Webhooks

Authorizations

Body

Response