List pricing schedules of an account

curl --request GET \
  --url https://api.togai.com/accounts/{account_id}/pricing_schedules \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.togai.com/accounts/{account_id}/pricing_schedules"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.togai.com/accounts/{account_id}/pricing_schedules', 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.togai.com/accounts/{account_id}/pricing_schedules",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.togai.com/accounts/{account_id}/pricing_schedules"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.togai.com/accounts/{account_id}/pricing_schedules")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": [
    {
      "pricePlanId": "pp.bs8932bf328"
    },
    {
      "startDate": "2080-10-04T00:00:00Z",
      "endDate": "2099-10-04T00:00:00Z",
      "pricePlanDetails": {
        "supportedCurrencies": [
          "USD"
        ],
        "activeCurrencies": [
          "USD"
        ],
        "pricingCycleConfig": {
          "interval": "MONTHLY",
          "startOffset": {
            "dayOffset": "4",
            "monthOffset": "NIL"
          },
          "gracePeriod": 3,
          "anniversaryCycle": false
        },
        "usageRateCards": [
          {
            "displayName": "Local Rides",
            "usageMeterId": "um.1zYnCiM9Bpg.1zYn",
            "ratePlan": {
              "pricingModel": "TIERED",
              "slabs": [
                {
                  "order": 1,
                  "startAfter": 0,
                  "priceType": "FLAT"
                }
              ]
            },
            "rateValues": [
              {
                "currency": "USD",
                "slabRates": [
                  {
                    "rate": 40,
                    "order": 1
                  }
                ]
              }
            ]
          }
        ],
        "fixedFeeRateCards": [
          {
            "id": "addon.2077efUBMXo.DyzlZ",
            "displayName": "Maintenance",
            "rateValues": [
              {
                "currency": "USD",
                "rate": 10
              }
            ]
          }
        ],
        "minimumCommitment": {
          "displayName": "Minimum Commitment",
          "rateValues": [
            {
              "currency": "USD",
              "rate": 10
            }
          ]
        }
      }
    }
  ],
  "nextToken": "eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ=="
}

{
  "message": "<Reason message>"
}

{
  "message": "<Reason message>"
}

{
  "message": "<Reason message>"
}

{
  "message": "<Reason message>"
}

{
  "message": "<Reason message>"
}

{
  "message": "<Reason message>"
}

GET

accounts

{account_id}

pricing_schedules

List pricing schedules of an account

curl --request GET \
  --url https://api.togai.com/accounts/{account_id}/pricing_schedules \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.togai.com/accounts/{account_id}/pricing_schedules"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.togai.com/accounts/{account_id}/pricing_schedules', 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.togai.com/accounts/{account_id}/pricing_schedules",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.togai.com/accounts/{account_id}/pricing_schedules"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.togai.com/accounts/{account_id}/pricing_schedules")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": [
    {
      "pricePlanId": "pp.bs8932bf328"
    },
    {
      "startDate": "2080-10-04T00:00:00Z",
      "endDate": "2099-10-04T00:00:00Z",
      "pricePlanDetails": {
        "supportedCurrencies": [
          "USD"
        ],
        "activeCurrencies": [
          "USD"
        ],
        "pricingCycleConfig": {
          "interval": "MONTHLY",
          "startOffset": {
            "dayOffset": "4",
            "monthOffset": "NIL"
          },
          "gracePeriod": 3,
          "anniversaryCycle": false
        },
        "usageRateCards": [
          {
            "displayName": "Local Rides",
            "usageMeterId": "um.1zYnCiM9Bpg.1zYn",
            "ratePlan": {
              "pricingModel": "TIERED",
              "slabs": [
                {
                  "order": 1,
                  "startAfter": 0,
                  "priceType": "FLAT"
                }
              ]
            },
            "rateValues": [
              {
                "currency": "USD",
                "slabRates": [
                  {
                    "rate": 40,
                    "order": 1
                  }
                ]
              }
            ]
          }
        ],
        "fixedFeeRateCards": [
          {
            "id": "addon.2077efUBMXo.DyzlZ",
            "displayName": "Maintenance",
            "rateValues": [
              {
                "currency": "USD",
                "rate": 10
              }
            ]
          }
        ],
        "minimumCommitment": {
          "displayName": "Minimum Commitment",
          "rateValues": [
            {
              "currency": "USD",
              "rate": 10
            }
          ]
        }
      }
    }
  ],
  "nextToken": "eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ=="
}

{
  "message": "<Reason message>"
}

{
  "message": "<Reason message>"
}

{
  "message": "<Reason message>"
}

{
  "message": "<Reason message>"
}

{
  "message": "<Reason message>"
}

{
  "message": "<Reason message>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

account_id

string

required

account_id corresponding to an account

Maximum string length: 50

Example:

"ACC00001"

Query Parameters

nextToken

string

Example:

"eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ=="

pageSize

number

Example:

10

start_date

string

Example:

"2023-03-30T10:41:10.088499"

end_date

string

Example:

"2099-03-30T10:41:10.088499"

Response

Response for list pricing schedules request

data

object[]

Show child attributes

nextToken

string

previousToken

string

Introduction

APIs

List pricing schedules of an account

Authorizations

Path Parameters

Query Parameters

Response