Get a specific purchase of an account

GET

purchases

{purchase_id}

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

{
  "id": "purchase.1zYnCiM9Bpg.lv25y",
  "accountId": "G234DZZKBKACATFFGVGEMERFI",
  "pricePlanId": "pp.1zYnCiM9Bpg.lv25y",
  "quantity": 1,
  "idempotencyKey": "AAAAABBBDDIIEOO42",
  "pricePlanVersion": 1,
  "purchasePlan": {
    "rateValues": [
      {
        "CurrencyRateValue": {
          "currency": "USD",
          "rate": 10
        }
      },
      {
        "CurrencyRateValue": {
          "currency": "INR",
          "rate": 150
        }
      }
    ],
    "entitlementRateCards": [
      {
        "EntitlementRateCard": {
          "featureId": "feature.1zYnCiM9Bpg.lv25y",
          "featureCredits": 100,
          "expiryDurationSeconds": 1000
        }
      }
    ]
  },
  "features": [
    {
      "id": "feature.1zYnCiM9Bpg.lv25y",
      "name": "DiscountCredits",
      "description": "Discount Credits Feature",
      "effectiveUntil": "2020-01-01T00:00:00Z",
      "grantedCredits": 100,
      "credits": 100,
      "updatedAt": "2020-01-01T00:00:00Z"
    }
  ],
  "createdAt": "2020-01-01T00:00:00Z",
  "updatedAt": "2020-01-01T00:00:00Z"
}

Authorizations

Authorization

string

headerrequired

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

Path Parameters

purchase_id

string

required

Response

200 - application/json

string

required

accountId

string

required

pricePlanId

string

required

quantity

integer

rateCardQuantities

object

idempotencyKey

string

pricePlanVersion

integer

required

purchasePlanOverride

object

purchasePlanOverride.pricingCycleConfig

object

Represents configurations related to pricing cycle

purchasePlanOverride.pricingCycleConfig.interval

enum<string>

required

Interval field allow you to define the billing interval you would like to set

Available options:

WEEKLY,

MONTHLY,

QUARTERLY,

HALF_YEARLY,

ANNUALLY

purchasePlanOverride.pricingCycleConfig.startOffset

object

Represents the start of pricing cycle in terms of

dayOffset - number of days from beginning of week / month and
monthOffset - number of months from beginning of interval (quarter, half-year or year) Note: If a day with offset doesn't exist for a month, closest previous day is considered Examples: WEEKLY -
{dayOffset: 1, monthOffset: NIL} - First day of every week (Monday)
{dayOffset: 3, monthOffset: NIL} - 3rd day of every week (Wednesday)
{dayOffset: LAST, monthOffset: NIL} - Last day of every week (Sunday) MONTHLY -
{dayOffset: 1, monthOffset: NIL} - First day of every month
{dayOffset: 12, monthOffset: NIL} - 12th of every month
{dayOffset: 28, monthOffset: NIL} - 28th of every month. i.e, 28th of Jan, 28th of Feb, ...
{dayOffset: 30, monthOffset: NIL} - 30th of every month. i.e, 28th of Jan, 28th of Feb, ...
{dayOffset: LAST, monthOffset: NIL} - Last day of every month. i.e, 31st of Jan, 28th of Feb, ... QUARTERLY
{dayOffset: 15, monthOffset: FIRST} - 15th Jan, 15th Apr, 15th Jul and 15th Oct
{dayOffset: 15, monthOffset: 2} - 15th Feb, 15th May, 15th Aug and 15th Nov
{dayOffset: 15, monthOffset: LAST} - 15th Mar, 15th Jun, 15th Sep and 15th Dec
{dayOffset: LAST, monthOffset: FIRST} - 31st Jan, 30th Apr, 30th Jul and 31th Oct HALF_YEARLY
{dayOffset: 15, monthOffset: FIRST} - 15th Jan and 15th Jul
{dayOffset: 15, monthOffset: 4} - 15th Apr and 15th Oct
{dayOffset: 15, monthOffset: LAST} - 15th Jun and 15th Dec ANNUALLY
{dayOffset: 15, monthOffset: FIRST} - 15th Jan
{dayOffset: 15, monthOffset: 1} - 15th Jan
{dayOffset: LAST, monthOffset: 2} - 29th Feb on Leap year, 28th otherwise
{dayOffset: 15, monthOffset: 8} - 15th Aug
{dayOffset: 15, monthOffset: LAST} - 15th Dec

purchasePlanOverride.pricingCycleConfig.gracePeriod

integer

required

Togai allows you to ingest past dated events that will be processed by a pricing cycle till the end grace period. For example: Pricing cycle is Monthly from 1st to 30th and gracePeriod is 5 days which next month 1 to 5th date, you can ingest past dated events during this grace period.

purchasePlanOverride.pricingCycleConfig.anniversaryCycle

boolean

Togai calculates the startOffsets based on the date of association instead of requiring from the user and these offsets will be applied as an override if this flag is enabled. Examples: WEEKLY -

23/10/2023 (Monday) - {dayOffset: 1, monthOffset: NIL}
25/10/2023 (Wednesday) - {dayOffset: 3, monthOffset: NIL}
29/10/2023 (Sunday) - {dayOffset: 7, monthOffset: NIL} MONTHLY -
1st Oct - {dayOffset: 1, monthOffset: NIL}
12th Oct - {dayOffset: 12, monthOffset: NIL}
28th Oct - {dayOffset: 28, monthOffset: NIL}
30th Oct - {dayOffset: 30, monthOffset: NIL}
31th Oct - {dayOffset: 31, monthOffset: NIL} QUARTERLY
15th Jan, 15th Apr, 15th Jul and 15th Oct - {dayOffset: 15, monthOffset: 1}
15th Feb, 15th May, 15th Aug and 15th Nov - {dayOffset: 15, monthOffset: 2}
15th Mar, 15th Jun, 15th Sep and 15th Dec - {dayOffset: 15, monthOffset: 3} HALF_YEARLY
15th Jan and 15th Jul - {dayOffset: 15, monthOffset: 1}
15th Apr and 15th Oct - {dayOffset: 15, monthOffset: 4}
15th Jun and 15th Dec - {dayOffset: 15, monthOffset: 6} ANNUALLY
15th Jan - {dayOffset: 15, monthOffset: 1}
29th Feb on Leap year - {dayOffset: 29, monthOffset: 2}
28th Feb - {dayOffset: 28, monthOffset: 2}
15th Aug - {dayOffset: 15, monthOffset: 8}
15th Dec - {dayOffset: 15, monthOffset: 12}

purchasePlanOverride.supportedCurrencies

string[]

purchasePlanOverride.usageRateCards

object[]

purchasePlanOverride.billingEntitlementRateCards

object[]

purchasePlanOverride.billingEntitlementRateCards.featureId

string

required

purchasePlanOverride.billingEntitlementRateCards.featureConfigs

object[]

required

purchasePlanOverride.billingEntitlementRateCards.tag

string

A tag string to group rate cards

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

purchasePlanOverride.billingEntitlementRateCards.displayName

string

Name your rate card, this will be used in invoice

purchasePlanOverride.billingEntitlementRateCards.ratePlan

object

required

Contains all rate related configurations

purchasePlanOverride.billingEntitlementRateCards.rateValues

object[]

required

purchasePlanOverride.billingEntitlementRateCards.recurrenceConfig

object

purchasePlanOverride.entitlementOverageRateCards

object[]

purchasePlanOverride.entitlementOverageRateCards.featureId

string

required

Unique Identifier of the attached Feature

purchasePlanOverride.entitlementOverageRateCards.displayName

string

Name to be displayed during invoice

purchasePlanOverride.entitlementOverageRateCards.tag

string

A tag string to group rate cards

purchasePlanOverride.entitlementOverageRateCards.maxQuantity

number

Maximum quantity allowed for the feature, if not specified, unlimited quantity is allowed

purchasePlanOverride.entitlementOverageRateCards.ratePlan

object

required

Contains all rate related configurations

purchasePlanOverride.entitlementOverageRateCards.rateValues

object[]

required

purchasePlanOverride.entitlementOverageRateCards.billingConfig

object

Represents the billing config of the entitlement overage rate card. If not specified interval:1 and startOffset:0 is taken as default value

purchasePlanOverride.fixedFeeRateCards

object[]

purchasePlanOverride.licenseRateCards

object[]

purchasePlanOverride.licenseRateCards.id

string

required

Unique Identifier of the attached AddOn

purchasePlanOverride.licenseRateCards.displayName

string

Name of the attached AddOn

purchasePlanOverride.licenseRateCards.tag

string

A tag string to group licenseRateCards

purchasePlanOverride.licenseRateCards.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

purchasePlanOverride.licenseRateCards.enableProration

boolean

required

purchasePlanOverride.licenseRateCards.config

object

purchasePlanOverride.licenseRateCards.ratePlan

object

required

Contains all rate related configurations

purchasePlanOverride.licenseRateCards.rateValues

object[]

required

purchasePlanOverride.licenseRateCards.proratedRefundMode

enum<string>

Available options:

NONE,

CREDITS,

PAYMENT

purchasePlanOverride.minimumCommitment

object

purchasePlanOverride.rateDetails

object

rate details for a price plan

purchasePlanOverride.entitlementRateCards

object[]

purchasePlanOverride.creditGrantRateCards

object[]

purchasePlanOverride.creditGrantRateCards.id

string

required

purchasePlanOverride.creditGrantRateCards.displayName

string

purchasePlanOverride.creditGrantRateCards.tag

string

A tag string to group creditGrantRateCard

purchasePlanOverride.creditGrantRateCards.grantDetails

object

required

Grant details of Credit Grant Rate Card

purchasePlanOverride.creditGrantRateCards.rateDetails

object

required

Amount to be credited

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

purchasePlanOverride.creditGrantRateCards.type

enum<string>

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

Available options:

ONE_TIME,

RECURRING

purchasePlanOverride.creditGrantRateCards.recurrenceConfig

object

associationOverride

object

associationOverride.pricingCycleConfig

object

Represents configurations related to pricing cycle

associationOverride.pricingCycleConfig.interval

enum<string>

required

Interval field allow you to define the billing interval you would like to set

Available options:

WEEKLY,

MONTHLY,

QUARTERLY,

HALF_YEARLY,

ANNUALLY

associationOverride.pricingCycleConfig.startOffset

object

Represents the start of pricing cycle in terms of

dayOffset - number of days from beginning of week / month and
monthOffset - number of months from beginning of interval (quarter, half-year or year) Note: If a day with offset doesn't exist for a month, closest previous day is considered Examples: WEEKLY -
{dayOffset: 1, monthOffset: NIL} - First day of every week (Monday)
{dayOffset: 3, monthOffset: NIL} - 3rd day of every week (Wednesday)
{dayOffset: LAST, monthOffset: NIL} - Last day of every week (Sunday) MONTHLY -
{dayOffset: 1, monthOffset: NIL} - First day of every month
{dayOffset: 12, monthOffset: NIL} - 12th of every month
{dayOffset: 28, monthOffset: NIL} - 28th of every month. i.e, 28th of Jan, 28th of Feb, ...
{dayOffset: 30, monthOffset: NIL} - 30th of every month. i.e, 28th of Jan, 28th of Feb, ...
{dayOffset: LAST, monthOffset: NIL} - Last day of every month. i.e, 31st of Jan, 28th of Feb, ... QUARTERLY
{dayOffset: 15, monthOffset: FIRST} - 15th Jan, 15th Apr, 15th Jul and 15th Oct
{dayOffset: 15, monthOffset: 2} - 15th Feb, 15th May, 15th Aug and 15th Nov
{dayOffset: 15, monthOffset: LAST} - 15th Mar, 15th Jun, 15th Sep and 15th Dec
{dayOffset: LAST, monthOffset: FIRST} - 31st Jan, 30th Apr, 30th Jul and 31th Oct HALF_YEARLY
{dayOffset: 15, monthOffset: FIRST} - 15th Jan and 15th Jul
{dayOffset: 15, monthOffset: 4} - 15th Apr and 15th Oct
{dayOffset: 15, monthOffset: LAST} - 15th Jun and 15th Dec ANNUALLY
{dayOffset: 15, monthOffset: FIRST} - 15th Jan
{dayOffset: 15, monthOffset: 1} - 15th Jan
{dayOffset: LAST, monthOffset: 2} - 29th Feb on Leap year, 28th otherwise
{dayOffset: 15, monthOffset: 8} - 15th Aug
{dayOffset: 15, monthOffset: LAST} - 15th Dec

associationOverride.pricingCycleConfig.gracePeriod

integer

required

associationOverride.pricingCycleConfig.anniversaryCycle

boolean

Togai calculates the startOffsets based on the date of association instead of requiring from the user and these offsets will be applied as an override if this flag is enabled. Examples: WEEKLY -

23/10/2023 (Monday) - {dayOffset: 1, monthOffset: NIL}
25/10/2023 (Wednesday) - {dayOffset: 3, monthOffset: NIL}
29/10/2023 (Sunday) - {dayOffset: 7, monthOffset: NIL} MONTHLY -
1st Oct - {dayOffset: 1, monthOffset: NIL}
12th Oct - {dayOffset: 12, monthOffset: NIL}
28th Oct - {dayOffset: 28, monthOffset: NIL}
30th Oct - {dayOffset: 30, monthOffset: NIL}
31th Oct - {dayOffset: 31, monthOffset: NIL} QUARTERLY
15th Jan, 15th Apr, 15th Jul and 15th Oct - {dayOffset: 15, monthOffset: 1}
15th Feb, 15th May, 15th Aug and 15th Nov - {dayOffset: 15, monthOffset: 2}
15th Mar, 15th Jun, 15th Sep and 15th Dec - {dayOffset: 15, monthOffset: 3} HALF_YEARLY
15th Jan and 15th Jul - {dayOffset: 15, monthOffset: 1}
15th Apr and 15th Oct - {dayOffset: 15, monthOffset: 4}
15th Jun and 15th Dec - {dayOffset: 15, monthOffset: 6} ANNUALLY
15th Jan - {dayOffset: 15, monthOffset: 1}
29th Feb on Leap year - {dayOffset: 29, monthOffset: 2}
28th Feb - {dayOffset: 28, monthOffset: 2}
15th Aug - {dayOffset: 15, monthOffset: 8}
15th Dec - {dayOffset: 15, monthOffset: 12}

associationOverride.supportedCurrencies

string[]

associationOverride.usageRateCards

object[]

associationOverride.billingEntitlementRateCards

object[]

associationOverride.billingEntitlementRateCards.featureId

string

required

associationOverride.billingEntitlementRateCards.featureConfigs

object[]

required

associationOverride.billingEntitlementRateCards.tag

string

A tag string to group rate cards

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

associationOverride.billingEntitlementRateCards.displayName

string

Name your rate card, this will be used in invoice

associationOverride.billingEntitlementRateCards.ratePlan

object

required

Contains all rate related configurations

associationOverride.billingEntitlementRateCards.rateValues

object[]

required

associationOverride.billingEntitlementRateCards.recurrenceConfig

object

associationOverride.entitlementOverageRateCards

object[]

associationOverride.entitlementOverageRateCards.featureId

string

required

Unique Identifier of the attached Feature

associationOverride.entitlementOverageRateCards.displayName

string

Name to be displayed during invoice

associationOverride.entitlementOverageRateCards.tag

string

A tag string to group rate cards

associationOverride.entitlementOverageRateCards.maxQuantity

number

Maximum quantity allowed for the feature, if not specified, unlimited quantity is allowed

associationOverride.entitlementOverageRateCards.ratePlan

object

required

Contains all rate related configurations

associationOverride.entitlementOverageRateCards.rateValues

object[]

required

associationOverride.entitlementOverageRateCards.billingConfig

object

Represents the billing config of the entitlement overage rate card. If not specified interval:1 and startOffset:0 is taken as default value

associationOverride.fixedFeeRateCards

object[]

associationOverride.licenseRateCards

object[]

associationOverride.licenseRateCards.id

string

required

Unique Identifier of the attached AddOn

associationOverride.licenseRateCards.displayName

string

Name of the attached AddOn

associationOverride.licenseRateCards.tag

string

A tag string to group licenseRateCards

associationOverride.licenseRateCards.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

associationOverride.licenseRateCards.enableProration

boolean

required

associationOverride.licenseRateCards.config

object

associationOverride.licenseRateCards.ratePlan

object

required

Contains all rate related configurations

associationOverride.licenseRateCards.rateValues

object[]

required

associationOverride.licenseRateCards.proratedRefundMode

enum<string>

Available options:

NONE,

CREDITS,

PAYMENT

associationOverride.minimumCommitment

object

associationOverride.rateDetails

object

rate details for a price plan

associationOverride.entitlementRateCards

object[]

associationOverride.creditGrantRateCards

object[]

associationOverride.creditGrantRateCards.id

string

required

associationOverride.creditGrantRateCards.displayName

string

associationOverride.creditGrantRateCards.tag

string

A tag string to group creditGrantRateCard

associationOverride.creditGrantRateCards.grantDetails

object

required

Grant details of Credit Grant Rate Card

associationOverride.creditGrantRateCards.rateDetails

object

required

Amount to be credited

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

associationOverride.creditGrantRateCards.type

enum<string>

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

Available options:

ONE_TIME,

RECURRING

associationOverride.creditGrantRateCards.recurrenceConfig

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

purchasePlan

object

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

purchasePlan.rateDetails

object

rate details for a price plan

purchasePlan.entitlementRateCards

object[]

purchasePlan.billingEntitlementRateCards

object[]

purchasePlan.billingEntitlementRateCards.featureId

string

required

purchasePlan.billingEntitlementRateCards.featureConfigs

object[]

required

purchasePlan.billingEntitlementRateCards.tag

string

A tag string to group rate cards

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

purchasePlan.billingEntitlementRateCards.displayName

string

Name your rate card, this will be used in invoice

purchasePlan.billingEntitlementRateCards.ratePlan

object

required

Contains all rate related configurations

purchasePlan.billingEntitlementRateCards.rateValues

object[]

required

purchasePlan.billingEntitlementRateCards.recurrenceConfig

object

purchasePlan.creditGrantRateCards

object[]

purchasePlan.creditGrantRateCards.id

string

required

purchasePlan.creditGrantRateCards.displayName

string

purchasePlan.creditGrantRateCards.tag

string

A tag string to group creditGrantRateCard

purchasePlan.creditGrantRateCards.grantDetails

object

required

Grant details of Credit Grant Rate Card

purchasePlan.creditGrantRateCards.rateDetails

object

required

Amount to be credited

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

purchasePlan.creditGrantRateCards.type

enum<string>

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

Available options:

ONE_TIME,

RECURRING

purchasePlan.creditGrantRateCards.recurrenceConfig

object

features

object[]

Initiate a purchase List all proposals of an account

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

{
  "id": "purchase.1zYnCiM9Bpg.lv25y",
  "accountId": "G234DZZKBKACATFFGVGEMERFI",
  "pricePlanId": "pp.1zYnCiM9Bpg.lv25y",
  "quantity": 1,
  "idempotencyKey": "AAAAABBBDDIIEOO42",
  "pricePlanVersion": 1,
  "purchasePlan": {
    "rateValues": [
      {
        "CurrencyRateValue": {
          "currency": "USD",
          "rate": 10
        }
      },
      {
        "CurrencyRateValue": {
          "currency": "INR",
          "rate": 150
        }
      }
    ],
    "entitlementRateCards": [
      {
        "EntitlementRateCard": {
          "featureId": "feature.1zYnCiM9Bpg.lv25y",
          "featureCredits": 100,
          "expiryDurationSeconds": 1000
        }
      }
    ]
  },
  "features": [
    {
      "id": "feature.1zYnCiM9Bpg.lv25y",
      "name": "DiscountCredits",
      "description": "Discount Credits Feature",
      "effectiveUntil": "2020-01-01T00:00:00Z",
      "grantedCredits": 100,
      "credits": 100,
      "updatedAt": "2020-01-01T00:00:00Z"
    }
  ],
  "createdAt": "2020-01-01T00:00:00Z",
  "updatedAt": "2020-01-01T00:00:00Z"
}

Introduction

APIs

Get a specific purchase of an account

Authorizations

Path Parameters

Response