Get proposal information

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

import requests

url = "https://api.togai.com/purchase_proposals/{purchase_proposal_id}"

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/purchase_proposals/{purchase_proposal_id}', 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/purchase_proposals/{purchase_proposal_id}",
  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/purchase_proposals/{purchase_proposal_id}"

	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/purchase_proposals/{purchase_proposal_id}")

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

{
  "id": "purchase.1zYnCiM9Bpg.lv25y",
  "accountId": "G234DZZKBKACATFFGVGEMERFI",
  "pricePlanId": "pp.1zYnCiM9Bpg.lv25y",
  "quantity": 1,
  "idempotencyKey": "AAAAAABBBEEEDDSS23",
  "pricePlanVersion": 1,
  "purchasePlanOverrides": {
    "rateValues": [
      {
        "CurrencyRateValue": {
          "currency": "USD",
          "rate": 10
        }
      },
      {
        "CurrencyRateValue": {
          "currency": "INR",
          "rate": 150
        }
      }
    ],
    "entitlementRateCards": [
      {
        "EntitlementRateCard": {
          "featureId": "feature.1zYnCiM9Bpg.lv25y",
          "featureCredits": 100,
          "expiryDurationSeconds": 1000
        }
      }
    ]
  },
  "createdAt": "2020-01-01T00:00:00Z",
  "updatedAt": "2020-01-01T00:00:00Z"
}

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

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

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

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

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

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

GET

purchase_proposals

{purchase_proposal_id}

Get proposal information

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

import requests

url = "https://api.togai.com/purchase_proposals/{purchase_proposal_id}"

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/purchase_proposals/{purchase_proposal_id}', 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/purchase_proposals/{purchase_proposal_id}",
  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/purchase_proposals/{purchase_proposal_id}"

	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/purchase_proposals/{purchase_proposal_id}")

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

{
  "id": "purchase.1zYnCiM9Bpg.lv25y",
  "accountId": "G234DZZKBKACATFFGVGEMERFI",
  "pricePlanId": "pp.1zYnCiM9Bpg.lv25y",
  "quantity": 1,
  "idempotencyKey": "AAAAAABBBEEEDDSS23",
  "pricePlanVersion": 1,
  "purchasePlanOverrides": {
    "rateValues": [
      {
        "CurrencyRateValue": {
          "currency": "USD",
          "rate": 10
        }
      },
      {
        "CurrencyRateValue": {
          "currency": "INR",
          "rate": 150
        }
      }
    ],
    "entitlementRateCards": [
      {
        "EntitlementRateCard": {
          "featureId": "feature.1zYnCiM9Bpg.lv25y",
          "featureCredits": 100,
          "expiryDurationSeconds": 1000
        }
      }
    ]
  },
  "createdAt": "2020-01-01T00:00:00Z",
  "updatedAt": "2020-01-01T00:00:00Z"
}

{
  "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

purchase_proposal_id

string

required

Maximum string length: 512

Example:

"purchase.20rqjgFJf2O.ejl25"

Response

Response for getting a specific proposal

Represents a Purchase

string

required

accountId

string

required

Minimum string length: 1

pricePlanId

string

required

Minimum string length: 1

pricePlanVersion

integer<int32>

required

createdAt

string<date-time>

required

status

enum<string>

required

Status of the purchase

Available options:

SUCCESS,

FAILURE,

PENDING,

IN_PROGRESS,

PROPOSAL_ACTIVE,

PROPOSAL_APPROVED,

PROPOSAL_DECLINED,

PROPOSAL_EXPIRED

type

enum<string>

required

Available options:

ENTITLEMENT_GRANT,

ASSOCIATION

paymentMode

enum<string>

required

Available options:

PREPAID,

POSTPAID

quantity

integer<int32>

rateCardQuantities

object

Show child attributes

idempotencyKey

string

purchasePlanOverride

object

Show child attributes

associationOverride

object

Show child attributes

updatedAt

string<date-time>

effectiveFrom

string<date>

effectiveUntil

string<date>

expiryDate

string<date-time>

price

number

invoiceId

string

invoiceCurrency

string

comment

string

proposalResponseDate

string<date-time>

Propose a purchase of a plan Approve or decline a purchase of a billing plan

Introduction

APIs

Get proposal information

Authorizations

Path Parameters

Response