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

Authorizations

Authorization
string
headerrequired

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

Path Parameters

purchase_proposal_id
string
required

Body

application/json
status
enum<string>
required
Available options:
APPROVE,
DECLINE

Response

200 - application/json
id
string
required
accountId
string
required
pricePlanId
string
required
quantity
integer
rateCardQuantities
object
idempotencyKey
string
pricePlanVersion
integer
required
purchasePlanOverride
object
associationOverride
object
createdAt
string
required
updatedAt
string
effectiveFrom
string
effectiveUntil
string
expiryDate
string
price
number
invoiceId
string
invoiceCurrency
string
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
comment
string
paymentMode
enum<string>
required
Available options:
PREPAID,
POSTPAID
proposalResponseDate
string