Get all purchases for an account

GET

accounts

{account_id}

purchases

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

{
  "data": [
    {
      "id": "purchase.1zYnCiM9Bpg.lv25y",
      "pricePlanId": "pp.20dINmd0lBg.05sKa",
      "pricePlanName": "Entitlement Plan",
      "quantity": 1,
      "pricePlanVersion": 1,
      "status": "SUCCESS",
      "idempotencyKey": "AAAAABBBBDDDD7730",
      "createdAt": "2020-01-01T00:00:00Z",
      "updatedAt": "2020-01-01T00:00:00Z"
    },
    {
      "id": "purchase.20txx14r0m8.VKxaB",
      "pricePlanId": "pp.20txw0FrqjQ.byM8V",
      "pricePlanName": "pp_feature_purchase",
      "pricePlanVersion": 1,
      "status": "SUCCESS",
      "purchasePlan": {
        "rateDetails": null,
        "entitlementRateCards": null,
        "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": null
                }
              ]
            },
            "rateValues": [
              {
                "currency": "USD",
                "slabRates": [
                  {
                    "order": 1,
                    "rate": 1,
                    "slabRateConfig": null
                  }
                ]
              }
            ],
            "displayName": "feature1"
          }
        ]
      },
      "createdAt": "2023-07-31T15:49:25.007848Z",
      "quantity": null,
      "rateCardQuantities": {
        "feature.20txvOAhiIS.m3X3d": 1.2
      },
      "price": 120,
      "invoiceCurrency": "USD",
      "updatedAt": "2023-07-31T15:51:35.093598Z"
    }
  ]
}

Authorizations

Authorization

string

headerrequired

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

Response

200 - application/json

data

object[]

data.id

string

required

data.pricePlanId

string

required

data.pricePlanName

string

required

data.quantity

integer

data.rateCardQuantities

object

data.pricePlanVersion

integer

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.idempotencyKey

string

data.purchasePlan

object

required

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

data.purchasePlan.rateDetails

object

rate details for a price plan

data.purchasePlan.entitlementRateCards

object[]

data.purchasePlan.billingEntitlementRateCards

object[]

data.purchasePlan.billingEntitlementRateCards.featureId

string

required

data.purchasePlan.billingEntitlementRateCards.featureConfigs

object[]

required

data.purchasePlan.billingEntitlementRateCards.tag

string

A tag string to group rate cards

data.purchasePlan.billingEntitlementRateCards.invoiceTiming

enum<string>

required

If IN_ADVANCE, the fixed fee will be invoiced in the previous billing cycle. If IN_ARREARS, the fixed fee will be invoiced in the current billing cycle.

Available options:

IN_ADVANCE,

IN_ARREARS

data.purchasePlan.billingEntitlementRateCards.displayName

string

Name your rate card, this will be used in invoice

data.purchasePlan.billingEntitlementRateCards.ratePlan

object

required

Contains all rate related configurations

data.purchasePlan.billingEntitlementRateCards.rateValues

object[]

required

data.purchasePlan.billingEntitlementRateCards.recurrenceConfig

object

data.purchasePlan.creditGrantRateCards

object[]

data.purchasePlan.creditGrantRateCards.id

string

required

data.purchasePlan.creditGrantRateCards.displayName

string

data.purchasePlan.creditGrantRateCards.tag

string

A tag string to group creditGrantRateCard

data.purchasePlan.creditGrantRateCards.grantDetails

object

required

Grant details of Credit Grant Rate Card

data.purchasePlan.creditGrantRateCards.rateDetails

object

required

Amount to be credited

data.purchasePlan.creditGrantRateCards.invoiceTiming

enum<string>

If IN_ADVANCE, the fixed fee will be invoiced in the previous billing cycle. If IN_ARREARS, the fixed fee will be invoiced in the current billing cycle.

Available options:

IN_ADVANCE,

IN_ARREARS

data.purchasePlan.creditGrantRateCards.type

enum<string>

Credit grant applies either for a one-time occurrence or for each cycle.

Available options:

ONE_TIME,

RECURRING

data.purchasePlan.creditGrantRateCards.recurrenceConfig

object

data.price

number

data.invoiceCurrency

string

data.createdAt

string

required

data.updatedAt

string

data.type

enum<string>

required

Available options:

ENTITLEMENT_GRANT,

ASSOCIATION

nextToken

string

context

object

Dissociate or associate a price plan with an account Initiate a purchase

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

{
  "data": [
    {
      "id": "purchase.1zYnCiM9Bpg.lv25y",
      "pricePlanId": "pp.20dINmd0lBg.05sKa",
      "pricePlanName": "Entitlement Plan",
      "quantity": 1,
      "pricePlanVersion": 1,
      "status": "SUCCESS",
      "idempotencyKey": "AAAAABBBBDDDD7730",
      "createdAt": "2020-01-01T00:00:00Z",
      "updatedAt": "2020-01-01T00:00:00Z"
    },
    {
      "id": "purchase.20txx14r0m8.VKxaB",
      "pricePlanId": "pp.20txw0FrqjQ.byM8V",
      "pricePlanName": "pp_feature_purchase",
      "pricePlanVersion": 1,
      "status": "SUCCESS",
      "purchasePlan": {
        "rateDetails": null,
        "entitlementRateCards": null,
        "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": null
                }
              ]
            },
            "rateValues": [
              {
                "currency": "USD",
                "slabRates": [
                  {
                    "order": 1,
                    "rate": 1,
                    "slabRateConfig": null
                  }
                ]
              }
            ],
            "displayName": "feature1"
          }
        ]
      },
      "createdAt": "2023-07-31T15:49:25.007848Z",
      "quantity": null,
      "rateCardQuantities": {
        "feature.20txvOAhiIS.m3X3d": 1.2
      },
      "price": 120,
      "invoiceCurrency": "USD",
      "updatedAt": "2023-07-31T15:51:35.093598Z"
    }
  ]
}

Introduction

APIs

Authorizations

Path Parameters

Response