(DEPRECATED) Get a specific purchase of an account

id

string

required

accountId

string

required

Minimum length: 1

createdAt

string

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 length: 1

quantity

integer

rateCardQuantities

object

idempotencyKey

string

pricePlanVersion

integer

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.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.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.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: LAST, 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: LAST, monthOffset: 2}
28th Feb - {dayOffset: LAST, monthOffset: 2}
15th Aug - {dayOffset: 15, monthOffset: 8}
15th Dec - {dayOffset: 15, monthOffset: 12}

purchasePlanOverride.supportedCurrencies

string[]

purchasePlanOverride.usageRateCards

object[]

purchasePlanOverride.usageRateCards.displayName

string

Name your rate card, this will be displayed in the Togai App

purchasePlanOverride.usageRateCards.name

string

Unique identifier for the rate card in a price plan. If left null it is auto-generated.

purchasePlanOverride.usageRateCards.tag

string

A tag string to group usageRateCards

purchasePlanOverride.usageRateCards.usageMeterId

string

required

purchasePlanOverride.usageRateCards.ratePlan

object

required

Contains all rate related configurations

purchasePlanOverride.usageRateCards.rateValues

object[]

required

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 rate card will be invoiced in the previous billing cycle. If IN_ARREARS, the rate card will be invoiced in the current billing cycle. If PREPAID, credits/entitlements will be granted only after invoice is paid

Available options:

IN_ADVANCE,

IN_ARREARS,

PREPAID

purchasePlanOverride.billingEntitlementRateCards.displayName

string

Name your rate card, this will be used in invoice

purchasePlanOverride.billingEntitlementRateCards.name

string

Unique identifier for the rate card in a price plan. If left null it is auto-generated.

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

Maximum length: 50

purchasePlanOverride.entitlementOverageRateCards.displayName

string

Name to be displayed during invoice

purchasePlanOverride.entitlementOverageRateCards.name

string

Unique identifier for the rate card in a price plan. If left null it is auto-generated.

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

Maximum length: 50

purchasePlanOverride.licenseRateCards.type

enum<string>

LICENSE: Addon can be used in license rate cards FIXED_FEE: Addon can be used in fixed fee rate cards CREDIT_GRANT: Addon can be used in credit grant rate cards NAMED_LICENSE: Addon can be used in license rate cards

Available options:

LICENSE,

FIXED_FEE,

CREDIT_GRANT,

NAMED_LICENSE

purchasePlanOverride.licenseRateCards.displayName

string

Name of the attached AddOn

purchasePlanOverride.licenseRateCards.name

string

Unique identifier for the rate card in a price plan. If left null it is auto-generated.

purchasePlanOverride.licenseRateCards.tag

string

A tag string to group licenseRateCards

purchasePlanOverride.licenseRateCards.invoiceTiming

enum<string>

If IN_ADVANCE, the rate card will be invoiced in the previous billing cycle. If IN_ARREARS, the rate card will be invoiced in the current billing cycle. If PREPAID, credits/entitlements will be granted only after invoice is paid

Available options:

IN_ADVANCE,

IN_ARREARS,

PREPAID

purchasePlanOverride.licenseRateCards.usageCycle

enum<string>

UsageCycleInterval field allows you to treat the billing interval as many smaller windows. Revenue is calculated for each of the windows (usage cycles) and their sum is considered as the billing interval revenue. Example: 1 Named License being used across entire billing interval. Rate Value: $1/license CASE 1: Without usage cycle. $1 is charged for the entire billing cycle. CASE 2: Usage cycle is configure to be WEEKLY and the billing interval has 4 weeks. In this case $1 is charged for each week totalling to $4 across for the billing interval

Available options:

WEEKLY,

MONTHLY,

QUARTERLY,

HALF_YEARLY,

ANNUALLY

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,

WALLET

purchasePlanOverride.minimumCommitment

object

purchasePlanOverride.creditGrantRateCards

object[]

purchasePlanOverride.creditGrantRateCards.id

string

required

purchasePlanOverride.creditGrantRateCards.displayName

string

purchasePlanOverride.creditGrantRateCards.name

string

Unique identifier for the rate card in a price plan. If left null it is auto-generated.

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 rate card will be invoiced in the previous billing cycle. If IN_ARREARS, the rate card will be invoiced in the current billing cycle. If PREPAID, credits/entitlements will be granted only after invoice is paid

Available options:

IN_ADVANCE,

IN_ARREARS,

PREPAID

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

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.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: LAST, 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: LAST, monthOffset: 2}
28th Feb - {dayOffset: LAST, monthOffset: 2}
15th Aug - {dayOffset: 15, monthOffset: 8}
15th Dec - {dayOffset: 15, monthOffset: 12}

associationOverride.supportedCurrencies

string[]

associationOverride.usageRateCards

object[]

associationOverride.usageRateCards.displayName

string

Name your rate card, this will be displayed in the Togai App

associationOverride.usageRateCards.name

string

Unique identifier for the rate card in a price plan. If left null it is auto-generated.

associationOverride.usageRateCards.tag

string

A tag string to group usageRateCards

associationOverride.usageRateCards.usageMeterId

string

required

associationOverride.usageRateCards.ratePlan

object

required

Contains all rate related configurations

associationOverride.usageRateCards.rateValues

object[]

required

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 rate card will be invoiced in the previous billing cycle. If IN_ARREARS, the rate card will be invoiced in the current billing cycle. If PREPAID, credits/entitlements will be granted only after invoice is paid

Available options:

IN_ADVANCE,

IN_ARREARS,

PREPAID

associationOverride.billingEntitlementRateCards.displayName

string

Name your rate card, this will be used in invoice

associationOverride.billingEntitlementRateCards.name

string

Unique identifier for the rate card in a price plan. If left null it is auto-generated.

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

Maximum length: 50

associationOverride.entitlementOverageRateCards.displayName

string

Name to be displayed during invoice

associationOverride.entitlementOverageRateCards.name

string

Unique identifier for the rate card in a price plan. If left null it is auto-generated.

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

Maximum length: 50

associationOverride.licenseRateCards.type

enum<string>

LICENSE: Addon can be used in license rate cards FIXED_FEE: Addon can be used in fixed fee rate cards CREDIT_GRANT: Addon can be used in credit grant rate cards NAMED_LICENSE: Addon can be used in license rate cards

Available options:

LICENSE,

FIXED_FEE,

CREDIT_GRANT,

NAMED_LICENSE

associationOverride.licenseRateCards.displayName

string

Name of the attached AddOn

associationOverride.licenseRateCards.name

string

Unique identifier for the rate card in a price plan. If left null it is auto-generated.

associationOverride.licenseRateCards.tag

string

A tag string to group licenseRateCards

associationOverride.licenseRateCards.invoiceTiming

enum<string>

If IN_ADVANCE, the rate card will be invoiced in the previous billing cycle. If IN_ARREARS, the rate card will be invoiced in the current billing cycle. If PREPAID, credits/entitlements will be granted only after invoice is paid

Available options:

IN_ADVANCE,

IN_ARREARS,

PREPAID

associationOverride.licenseRateCards.usageCycle

enum<string>

UsageCycleInterval field allows you to treat the billing interval as many smaller windows. Revenue is calculated for each of the windows (usage cycles) and their sum is considered as the billing interval revenue. Example: 1 Named License being used across entire billing interval. Rate Value: $1/license CASE 1: Without usage cycle. $1 is charged for the entire billing cycle. CASE 2: Usage cycle is configure to be WEEKLY and the billing interval has 4 weeks. In this case $1 is charged for each week totalling to $4 across for the billing interval

Available options:

WEEKLY,

MONTHLY,

QUARTERLY,

HALF_YEARLY,

ANNUALLY

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,

WALLET

associationOverride.minimumCommitment

object

associationOverride.creditGrantRateCards

object[]

associationOverride.creditGrantRateCards.id

string

required

associationOverride.creditGrantRateCards.displayName

string

associationOverride.creditGrantRateCards.name

string

Unique identifier for the rate card in a price plan. If left null it is auto-generated.

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 rate card will be invoiced in the previous billing cycle. If IN_ARREARS, the rate card will be invoiced in the current billing cycle. If PREPAID, credits/entitlements will be granted only after invoice is paid

Available options:

IN_ADVANCE,

IN_ARREARS,

PREPAID

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

walletTopupDetails

object

Information related to wallet topup purchase

updatedAt

string

effectiveFrom

string

effectiveUntil

string

expiryDate

string

price

number

invoiceId

string

invoiceCurrency

string

comment

string

purchasePlan

object

purchasePlan.supportedCurrencies

string[]

required

purchasePlan.activeCurrencies

string[]

required

purchasePlan.pricingCycleConfig

object

Represents configurations related to pricing cycle

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

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

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

purchasePlan.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: LAST, 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: LAST, monthOffset: 2}
28th Feb - {dayOffset: LAST, monthOffset: 2}
15th Aug - {dayOffset: 15, monthOffset: 8}
15th Dec - {dayOffset: 15, monthOffset: 12}

purchasePlan.usageRateCards

object[]

purchasePlan.fixedFeeRateCards

object[]

purchasePlan.licenseRateCards

object[]

purchasePlan.licenseRateCards.id

string

required

Unique Identifier of the attached AddOn

Maximum length: 50

purchasePlan.licenseRateCards.type

enum<string>

LICENSE: Addon can be used in license rate cards FIXED_FEE: Addon can be used in fixed fee rate cards CREDIT_GRANT: Addon can be used in credit grant rate cards NAMED_LICENSE: Addon can be used in license rate cards

Available options:

LICENSE,

FIXED_FEE,

CREDIT_GRANT,

NAMED_LICENSE

purchasePlan.licenseRateCards.displayName

string

Name of the attached AddOn

purchasePlan.licenseRateCards.name

string

Unique identifier for the rate card in a price plan. If left null it is auto-generated.

purchasePlan.licenseRateCards.tag

string

A tag string to group licenseRateCards

purchasePlan.licenseRateCards.invoiceTiming

enum<string>

If IN_ADVANCE, the rate card will be invoiced in the previous billing cycle. If IN_ARREARS, the rate card will be invoiced in the current billing cycle. If PREPAID, credits/entitlements will be granted only after invoice is paid

Available options:

IN_ADVANCE,

IN_ARREARS,

PREPAID

purchasePlan.licenseRateCards.usageCycle

enum<string>

UsageCycleInterval field allows you to treat the billing interval as many smaller windows. Revenue is calculated for each of the windows (usage cycles) and their sum is considered as the billing interval revenue. Example: 1 Named License being used across entire billing interval. Rate Value: $1/license CASE 1: Without usage cycle. $1 is charged for the entire billing cycle. CASE 2: Usage cycle is configure to be WEEKLY and the billing interval has 4 weeks. In this case $1 is charged for each week totalling to $4 across for the billing interval

Available options:

WEEKLY,

MONTHLY,

QUARTERLY,

HALF_YEARLY,

ANNUALLY

purchasePlan.licenseRateCards.enableProration

boolean

required

purchasePlan.licenseRateCards.config

object

purchasePlan.licenseRateCards.ratePlan

object

required

Contains all rate related configurations

purchasePlan.licenseRateCards.rateValues

object[]

required

purchasePlan.licenseRateCards.proratedRefundMode

enum<string>

Available options:

NONE,

CREDITS,

PAYMENT,

WALLET

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 rate card will be invoiced in the previous billing cycle. If IN_ARREARS, the rate card will be invoiced in the current billing cycle. If PREPAID, credits/entitlements will be granted only after invoice is paid

Available options:

IN_ADVANCE,

IN_ARREARS,

PREPAID

purchasePlan.billingEntitlementRateCards.displayName

string

Name your rate card, this will be used in invoice

purchasePlan.billingEntitlementRateCards.name

string

Unique identifier for the rate card in a price plan. If left null it is auto-generated.

purchasePlan.billingEntitlementRateCards.ratePlan

object

required

Contains all rate related configurations

purchasePlan.billingEntitlementRateCards.rateValues

object[]

required

purchasePlan.billingEntitlementRateCards.recurrenceConfig

object

purchasePlan.entitlementOverageRateCards

object[]

purchasePlan.entitlementOverageRateCards.featureId

string

required

Unique Identifier of the attached Feature

Maximum length: 50

purchasePlan.entitlementOverageRateCards.displayName

string

Name to be displayed during invoice

purchasePlan.entitlementOverageRateCards.name

string

Unique identifier for the rate card in a price plan. If left null it is auto-generated.

purchasePlan.entitlementOverageRateCards.tag

string

A tag string to group rate cards

purchasePlan.entitlementOverageRateCards.maxQuantity

number

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

purchasePlan.entitlementOverageRateCards.ratePlan

object

required

Contains all rate related configurations

purchasePlan.entitlementOverageRateCards.rateValues

object[]

required

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

purchasePlan.minimumCommitment

object

purchasePlan.creditGrantRateCards

object[]

purchasePlan.creditGrantRateCards.id

string

required

purchasePlan.creditGrantRateCards.displayName

string

purchasePlan.creditGrantRateCards.name

string

Unique identifier for the rate card in a price plan. If left null it is auto-generated.

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 rate card will be invoiced in the previous billing cycle. If IN_ARREARS, the rate card will be invoiced in the current billing cycle. If PREPAID, credits/entitlements will be granted only after invoice is paid

Available options:

IN_ADVANCE,

IN_ARREARS,

PREPAID

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

purchasePlan.type

enum<string>

Type of price plan

Available options:

BILLING,

PURCHASE

purchasePlan.deferredRevenue

boolean

purchasePlan.allow_ongoing_cycle_updates

any

Allow changes to price plan from the beginning of the ongoing cycle. type: boolean

features

object[]

Introduction

APIs

(DEPRECATED) Get a specific purchase of an account

Authorizations

Path Parameters

Response