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

CampaignBudgetDTO

The campaign budget details.

idstring
The ID of the campaign budget.
typeCampaignBudgetTypeValuesOptional
The type of the campaign budget:
  • spend indicates that the budget is limited by the amount discounted by the promotions in the associated campaign.
  • usage indicates that the budget is limited by the number of times the promotions of the associated campaign have been used.
limitnull | numberOptional
The limit of the campaign budget.
usednumberOptional
The usage from the campaign budget's limit:
  • If the budget's type is spend, the value of this attribute is the amount discounted so far by the promotions in the associated campaign.
  • If the budget's type is usage, the value of this attribute is the number of times the promotions of the associated campaign have been used so far.
currency_codestringOptional
The currency of the campaign.
Was this page helpful?
Edit this page
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break
⇧↵