Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

CampaignBudget - Promotion Module Data Models Reference

This documentation provides a reference to the CampaignBudget data model. It belongs to the Promotion Module.

idPrimaryKeyModifier<IdProperty>
The ID of the campaign budget.
typeEnumProperty<typeof CampaignBudgetType>
The type of the campaign budget
usedBigNumberProperty
How much of the budget has been used. if the limit is spend, this property holds the total amount discounted so far. if the limit is usage, it holds the number of times the campaign's promotions have been used so far.
campaignBelongsTo<Campaign>
The associated campaign.
currency_codeTextPropertyOptional
The currency code of the campaign budget. @example usd
limitBigNumberPropertyOptional
The limit of the campaign budget
Was this page helpful?