Approve or decline a purchase of a billing plan

curl --request POST \
  --url https://api.togai.com/purchase_proposals/{purchase_proposal_id}/update_status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "APPROVE"
}
'

import requests

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

payload = { "status": "APPROVE" }
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({status: 'APPROVE'})
};

fetch('https://api.togai.com/purchase_proposals/{purchase_proposal_id}/update_status', 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}/update_status",
  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([
    'status' => 'APPROVE'
  ]),
  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.togai.com/purchase_proposals/{purchase_proposal_id}/update_status"

	payload := strings.NewReader("{\n  \"status\": \"APPROVE\"\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.togai.com/purchase_proposals/{purchase_proposal_id}/update_status")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"status\": \"APPROVE\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.togai.com/purchase_proposals/{purchase_proposal_id}/update_status")

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  \"status\": \"APPROVE\"\n}"

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

{
  "id": "purchase.20rvWRxQcQK.0ZwPG",
  "accountId": "account2394",
  "pricePlanId": "pp.20rqb4MK9ia.TD0eG",
  "createdAt": {},
  "status": "PROPOSAL_ACTIVE",
  "pricePlanOverride": {
    "pricingCycleConfig": {
      "interval": "MONTHLY",
      "startOffset": {
        "dayOffset": 2,
        "monthOffset": "NIL"
      },
      "gracePeriod": 3,
      "anniversaryCycle": false
    }
  },
  "updatedAt": {},
  "effectiveFrom": {},
  "effectiveUntil": {},
  "comment": "Proposal Approved"
}

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

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

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

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

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

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

POST

purchase_proposals

{purchase_proposal_id}

update_status

Approve or decline a purchase of a billing plan

curl --request POST \
  --url https://api.togai.com/purchase_proposals/{purchase_proposal_id}/update_status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "APPROVE"
}
'

import requests

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

payload = { "status": "APPROVE" }
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({status: 'APPROVE'})
};

fetch('https://api.togai.com/purchase_proposals/{purchase_proposal_id}/update_status', 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}/update_status",
  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([
    'status' => 'APPROVE'
  ]),
  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.togai.com/purchase_proposals/{purchase_proposal_id}/update_status"

	payload := strings.NewReader("{\n  \"status\": \"APPROVE\"\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.togai.com/purchase_proposals/{purchase_proposal_id}/update_status")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"status\": \"APPROVE\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.togai.com/purchase_proposals/{purchase_proposal_id}/update_status")

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  \"status\": \"APPROVE\"\n}"

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

{
  "id": "purchase.20rvWRxQcQK.0ZwPG",
  "accountId": "account2394",
  "pricePlanId": "pp.20rqb4MK9ia.TD0eG",
  "createdAt": {},
  "status": "PROPOSAL_ACTIVE",
  "pricePlanOverride": {
    "pricingCycleConfig": {
      "interval": "MONTHLY",
      "startOffset": {
        "dayOffset": 2,
        "monthOffset": "NIL"
      },
      "gracePeriod": 3,
      "anniversaryCycle": false
    }
  },
  "updatedAt": {},
  "effectiveFrom": {},
  "effectiveUntil": {},
  "comment": "Proposal Approved"
}

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

Body

application/json

Payload to approve or decline a proposal

Approve or decline a proposal of a billing plan for an account

status

enum<string>

required

Available options:

APPROVE,

DECLINE

Response

Response to update proposal status request

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>

Introduction

APIs

Approve or decline a purchase of a billing plan

Authorizations

Path Parameters

Body

Response