(DEPRECATED) Initiate a purchase

curl --request POST \
  --url https://api.togai.com/accounts/{account_id}/purchases \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pricePlanId": "pp.20txw0FrqjQ.byM8V",
  "type": "ENTITLEMENT_GRANT",
  "rateCardQuantities": {
    "feature.20txvOAhiIS.m3X3d": 1.2
  }
}
'

{
  "id": "purchase.1zYnCiM9Bpg.lv25y",
  "accountId": "G234DZZKBKACATFFGVGEMERFI",
  "pricePlanId": "pp.1zYnCiM9Bpg.lv25y",
  "quantity": 1,
  "idempotencyKey": "AAAAAABBBEEEDDSS23",
  "pricePlanVersion": 1,
  "purchasePlanOverride": {
    "billingEntitlementRateCards": [
      {
        "featureId": "feature.20jxa18BdUW.d4XQw",
        "featureConfigs": [
          {
            "featureCreditLimit": 100,
            "effectiveUntil": "P20D"
          }
        ],
        "invoiceTiming": "IN_ADVANCE",
        "ratePlan": {
          "pricingModel": "TIERED",
          "slabs": [
            {
              "order": 1,
              "startAfter": 0,
              "priceType": "PER_UNIT",
              "slabConfig": {}
            }
          ]
        },
        "rateValues": [
          {
            "currency": "USD",
            "slabRates": [
              {
                "order": 1,
                "rate": 1,
                "slabRateConfig": {}
              }
            ]
          }
        ],
        "displayName": "feature1"
      }
    ]
  },
  "type": "ENTITLEMENT_GRANT",
  "status": "SUCCESS",
  "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>"
}

POST

accounts

{account_id}

purchases

curl --request POST \
  --url https://api.togai.com/accounts/{account_id}/purchases \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pricePlanId": "pp.20txw0FrqjQ.byM8V",
  "type": "ENTITLEMENT_GRANT",
  "rateCardQuantities": {
    "feature.20txvOAhiIS.m3X3d": 1.2
  }
}
'

{
  "id": "purchase.1zYnCiM9Bpg.lv25y",
  "accountId": "G234DZZKBKACATFFGVGEMERFI",
  "pricePlanId": "pp.1zYnCiM9Bpg.lv25y",
  "quantity": 1,
  "idempotencyKey": "AAAAAABBBEEEDDSS23",
  "pricePlanVersion": 1,
  "purchasePlanOverride": {
    "billingEntitlementRateCards": [
      {
        "featureId": "feature.20jxa18BdUW.d4XQw",
        "featureConfigs": [
          {
            "featureCreditLimit": 100,
            "effectiveUntil": "P20D"
          }
        ],
        "invoiceTiming": "IN_ADVANCE",
        "ratePlan": {
          "pricingModel": "TIERED",
          "slabs": [
            {
              "order": 1,
              "startAfter": 0,
              "priceType": "PER_UNIT",
              "slabConfig": {}
            }
          ]
        },
        "rateValues": [
          {
            "currency": "USD",
            "slabRates": [
              {
                "order": 1,
                "rate": 1,
                "slabRateConfig": {}
              }
            ]
          }
        ],
        "displayName": "feature1"
      }
    ]
  },
  "type": "ENTITLEMENT_GRANT",
  "status": "SUCCESS",
  "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

account_id

string

required

account_id corresponding to an account

Maximum string length: 50

Example:

"ACC00001"

Body

application/json

Payload to initiate a purchase

Create a purchase for an account

pricePlanId

string

Id of the price plan, Required for ENTITLEMENT_GRANT, ASSOCIATION purchase

quantity

integer<int32>

rateCardQuantities

object

Show child attributes

idempotencyKey

string

purchasePlanOverride

object

entitlements override options for purchase of a price plan for an account

Show child attributes

associationOverride

object

Show child attributes

walletTopupDetails

object

Information related to wallet topup purchase

Show child attributes

effectiveFrom

string<date>

effectiveUntil

string<date>

expiryDate

string<date-time>

type

enum<string>

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

Response

Response for initiation of a purchase of entitlement plan for an account

Represents a Purchase

string

required

accountId

string

required

Minimum string length: 1

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

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

pricePlanId

string

Id of the price plan, Required for ENTITLEMENT_GRANT, ASSOCIATION purchase

Minimum string length: 1

quantity

integer<int32>

rateCardQuantities

object

Show child attributes

idempotencyKey

string

pricePlanVersion

integer<int32>

purchasePlanOverride

object

Show child attributes

associationOverride

object

Show child attributes

walletTopupDetails

object

Information related to wallet topup purchase

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

Introduction

APIs

Authorizations

Path Parameters

Body

Response