github-actions[bot]andolivermrbl
858b3e3b9b
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
13 lines
1.9 KiB
Plaintext
13 lines
1.9 KiB
Plaintext
---
|
|
displayed_sidebar: promotionReference
|
|
---
|
|
|
|
import { TypeList } from "docs-ui"
|
|
|
|
# CampaignBudgetUsageDTO
|
|
|
|
Record of promotion usage as part of a campaign whose budget type
|
|
is `use_by_attribute` or `spend_by_attribute`.
|
|
|
|
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the campaign budget usage.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute_value","type":"`string`","description":"The value of the attribute that the promotion was used by.\nFor example, if the budget campaign's attribute is `customer_id`,',\nthis value will be the ID of the customer that used the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"used","type":"`number`","description":"The amount of times the promotion was used or\nthe amount of money discounted by the promotion,\ndepending on the campaign budget's type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"budget_id","type":"`string`","description":"The ID of the campaign budget.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_used","type":"`Record<string, any>`","description":"The raw used value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date and time the campaign budget usage was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date and time the campaign budget usage was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string`","description":"The date and time the campaign budget usage was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="CampaignBudgetUsageDTO"/>
|