(DEPRECATED) List all proposals of an account

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

{
  "data": [
    {
      "id": "purchase.1zYnCiM9Bpg.lv25y",
      "pricePlanId": "pp.20dINmd0lBg.05sKa",
      "pricePlanName": "Advanced Tier",
      "type": "ASSOCIATION",
      "status": "PROPOSAL_ACTIVE",
      "paymentMode": "PREPAID",
      "pricePlanVersion": 2,
      "createdAt": "2020-01-01T00:00:00Z",
      "updatedAt": "2020-01-01T00:00:00Z"
    }
  ]
}

GET

accounts

{account_id}

purchase_proposals

(DEPRECATED) List all proposals of an account

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

{
  "data": [
    {
      "id": "purchase.1zYnCiM9Bpg.lv25y",
      "pricePlanId": "pp.20dINmd0lBg.05sKa",
      "pricePlanName": "Advanced Tier",
      "type": "ASSOCIATION",
      "status": "PROPOSAL_ACTIVE",
      "paymentMode": "PREPAID",
      "pricePlanVersion": 2,
      "createdAt": "2020-01-01T00:00:00Z",
      "updatedAt": "2020-01-01T00:00:00Z"
    }
  ]
}

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"

Response

Response for list proposals of an account request

data

object[]

Show child attributes

data.id

string

required

data.status

enum<string>

required

Status of the purchase

Available options:

SUCCESS,

FAILURE,

PENDING,

IN_PROGRESS,

PROPOSAL_ACTIVE,

PROPOSAL_APPROVED,

PROPOSAL_DECLINED,

PROPOSAL_EXPIRED

data.createdAt

string<date-time>

required

data.updatedAt

string<date-time>

required

data.paymentMode

enum<string>

required

Available options:

PREPAID,

POSTPAID

data.type

enum<string>

required

Specifies whether this purchase is for granting entitlements or for an association or for wallet topup or prepaid purchase. If left null, ENTITLEMENT_GRANT is taken as default

Available options:

ENTITLEMENT_GRANT,

ASSOCIATION,

WALLET_TOPUP,

PREPAID

data.pricePlanId

string

data.pricePlanName

string

data.pricePlanVersion

integer<int32>

data.walletTopupDetails

object

Information related to wallet topup purchase

Show child attributes

data.walletTopupDetails.topupAmount

number

required

Specifies the value to be topped up in the wallet

data.walletTopupDetails.purchaseAmount

number

Specifies the amount to be paid to top up wallet with the specified top up amount. If left null, purchase amount will be same as top up amount

data.idempotencyKey

string

data.expiryDate

string<date-time>

nextToken

string

context

object

Show child attributes

context.pageSize

integer

context.sortOrder

enum<string>

Available options:

ASC,

DESC

(DEPRECATED) Get a specific purchase of an account (DEPRECATED) Propose a purchase of a plan

⌘I

Introduction

APIs

(DEPRECATED) List all proposals of an account

Authorizations

Path Parameters

Response