Skip to main content
GET
/
purchases
/
{purchase_id}
(DEPRECATED) Get a specific purchase of an account
curl --request GET \
  --url https://api.togai.com/purchases/{purchase_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "purchase.20txx14r0m8.VKxaB",
  "accountId": "c102",
  "pricePlanId": "pp.20txw0FrqjQ.byM8V",
  "pricePlanVersion": 1,
  "createdAt": "2023-07-31T15:49:25.007848Z",
  "type": "ENTITLEMENT_GRANT",
  "status": "SUCCESS",
  "purchasePlan": {
    "billingEntitlementRateCards": [
      {
        "featureId": "feature.20txvOAhiIS.m3X3d",
        "featureConfigs": [
          {
            "effectiveUntil": "P20D",
            "featureCreditLimit": 100,
            "effectiveFrom": "PT0S"
          }
        ],
        "invoiceTiming": "IN_ADVANCE",
        "ratePlan": {
          "pricingModel": "TIERED",
          "slabs": [
            {
              "order": 1,
              "startAfter": 0,
              "priceType": "PER_UNIT",
              "slabConfig": {}
            }
          ]
        },
        "rateValues": [
          {
            "currency": "USD",
            "slabRates": [
              {
                "order": 1,
                "rate": 1
              }
            ]
          }
        ],
        "displayName": "feature1"
      }
    ],
    "supportedCurrencies": [
      "USD"
    ],
    "activeCurrencies": [
      "USD"
    ]
  },
  "features": [
    {
      "id": "feature.20txvOAhiIS.m3X3d",
      "name": "feature1",
      "creditsGranted": 120,
      "creditsAvailable": 120,
      "updatedAt": "2023-07-31T15:47:52.570011Z",
      "effectiveFrom": "2023-07-31T15:51:34.308371Z",
      "effectiveUntil": "2023-08-20T15:51:34.308371Z"
    }
  ],
  "rateCardQuantities": {
    "feature.20txvOAhiIS.m3X3d": 1.2
  },
  "updatedAt": "2023-07-31T15:51:35.093598Z",
  "price": 120,
  "invoiceId": "inv.20txx3jeQU4.nlMQh",
  "invoiceCurrency": "USD"
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
purchase_id
string
required
Maximum length: 50
Example:

Response

​
id
string
required
​
accountId
string
required
Minimum length: 1
​
createdAt
string<date-time>
required
​
status
enum<string>
required
Available options:
SUCCESS,
FAILURE,
PENDING,
IN_PROGRESS,
PROPOSAL_ACTIVE,
PROPOSAL_APPROVED,
PROPOSAL_DECLINED,
PROPOSAL_EXPIRED
​
type
enum<string>
required
Available options:
ENTITLEMENT_GRANT,
ASSOCIATION,
WALLET_TOPUP,
PREPAID
​
pricePlanId
string
Minimum length: 1
​
quantity
integer
​
rateCardQuantities
object
​
idempotencyKey
string
​
pricePlanVersion
integer
​
purchasePlanOverride
object
​
associationOverride
object
​
walletTopupDetails
object
​
updatedAt
string<date-time>
​
effectiveFrom
string<date>
​
effectiveUntil
string<date>
​
expiryDate
string<date-time>
​
price
number
​
invoiceId
string
​
invoiceCurrency
string
​
comment
string
​
purchasePlan
object
​
features
PurchaseFeatureDetails · object[]