Medusa
Store APIAdmin API
Store APIAdmin API
Discord
Twitter
Linkedin
Github
  1. Discounts
  • Auth
    • Get Current User
      GET
    • User Logout
      DELETE
    • User Login
      POST
    • User Login (JWT)
      POST
  • Apps Oauth
    • Generate Token for App
      POST
    • List Applications
      GET
  • Batch Jobs
    • Cancel a Batch Job
      POST
    • Get a Batch Job
      GET
    • Confirm a Batch Job
      POST
    • List Batch Jobs
      GET
    • Create a Batch Job
      POST
  • Currencies
    • List Currency
    • Update a Currency
  • Customers
    • Create a Customer
    • List Customers
    • Update a Customer
    • Get a Customer
  • Customer Groups
    • Remove Customers from Group
    • Add Customers to Group
    • List Customers
    • Create a Customer Group
    • List Customer Groups
    • Get a Customer Group
    • Delete a Customer Group
    • Update a Customer Group
  • Discounts
    • Create a Condition
      POST
    • Create a Discount
      POST
    • List Discounts
      GET
    • Get a Condition
      GET
    • Update a Condition
      POST
    • Delete a Condition
      DELETE
    • Create a Dynamic Code
      POST
    • Remove Batch Resources
      DELETE
    • Add Batch Resources
      POST
    • Get Discount by Code
      GET
    • Delete a Dynamic Code
      DELETE
    • Add Region to Discount
      POST
    • Remove Region
      DELETE
    • Delete a Discount
      DELETE
    • Update a Discount
      POST
    • Get a Discount
      GET
  • Draft Orders
    • Create a Line Item
    • Delete a Line Item
    • Update a Line Item
    • Update a Draft Order
    • Delete a Draft Order
    • Get a Draft Order
    • Create a Draft Order
    • List Draft Orders
    • Mark Paid
  • Gift Cards
    • Create a Gift Card
    • List Gift Cards
    • Delete a Gift Card
    • Get a Gift Card
    • Update a Gift Card
  • Inventory Items
    • Create an Inventory Item
    • List Inventory Items
    • List Inventory Level
    • Create an Location Level
    • Update an Inventory Item
    • Get an Inventory Item
    • Delete an Inventory Item
    • Update a Location Level
    • Delete a Location Level
  • Invites
    • Lists Invites
    • Create an Invite
    • Delete an Invite
    • Accept an Invite
    • Resend an Invite
  • Notes
    • List Notes
    • Create a Note
    • Get a Note
    • Delete a Note
    • Update a Note
  • Notifications
    • Resend Notification
    • List Notifications
  • Orders
    • Create a Reservation
    • Cancel Claim's Fulfillment
    • Ship a Claim's Fulfillment
    • Cancel Swap's Fulfilmment
    • Get Order Reservations
    • Add a Shipping Method
    • Create a Refund
    • Get an Order
    • Update an Order
    • Create a Fulfillment
    • Cancel a Swap
    • List Orders
    • Create a Swap
    • Complete an Order
    • Create a Swap Fulfillment
    • Cancel a Claim
    • Process a Swap Payment
    • Ship a Fulfillment
    • Capture an Order's Payments
    • Archive Order
    • Update a Claim
    • Request a Return
    • Create a Claim Fulfillment
    • Ship a Swap's Fulfillment
    • Cancel a Fulfilmment
    • Create a Claim
    • Cancel an Order
  • Order Edits
    • Delete a Line Item Change
    • Add a Line Item
    • Upsert Line Item Change
    • Delete Line Item
    • Cancel an Order Edit
    • Delete an Order Edit
    • Get an Order Edit
    • Update an Order Edit
    • Request Confirmation
    • Create an OrderEdit
    • List Order Edits
    • Confirm an OrderEdit
  • Payments
    • Capture a Payment
    • Get Payment details
    • Refund Payment
  • Payment Collections
    • Delete a Payment Collection
    • Get a Payment Collection
    • Update Payment Collection
    • Mark Authorized
  • Product Collections
    • Add Products to Collection
    • Remove Products from Collection
    • Get a Collection
    • Update a Collection
    • Delete a Collection
    • List Collections
    • Create a Collection
  • Product Tags
    • List Product Tags
  • Product Types
    • List Product Types
  • Product Variants
    • Get Variant's Inventory
    • List Product Variants
    • Get a Product variant
  • Price Lists
    • Delete a Product's Prices
    • List Products
    • Delete a Variant's Prices
    • Get a Price List
    • Update a Price List
    • Delete a Price List
    • Add or Update Prices
    • Delete Prices
    • Create a Price List
    • List Price Lists
  • Products
    • List Product Types
    • List Tags Usage Number
    • List a Product's Variants
    • Create a Product Variant
    • Update a Product Variant
    • Delete a Product Variant
    • Add a Product Option
    • Set Metadata
    • Delete a Product Option
    • Update a Product Option
    • List Products
    • Create a Product
    • Delete a Product
    • Update a Product
    • Get a Product
  • Product Categories
    • Create a Product Category
    • List Product Categories
    • Update a Product Category
    • Delete a Product Category
    • Get a Product Category
    • Add Products to a Category
    • Remove Products from Category
  • Publishable Api Keys
    • List Sales Channels
    • Delete Publishable API Key
    • Get a Publishable API Key
    • Revoke a Publishable API Key
    • Remove Sales Channels
    • Add Sales Channels
    • Update Publishable API Key
    • List Publishable API keys
    • Create Publishable API Key
  • Reservations
    • Delete a Reservation
    • Update a Reservation
    • Get a Reservation
    • Create a Reservation
    • List Reservations
  • Regions
    • List Fulfillment Options
    • Add Country
    • Remove Fulfillment Provider
    • Remove Payment Provider
    • Add Payment Provider
    • Delete a Region
    • Update a Region
    • Get a Region
    • List Regions
    • Create a Region
    • Add Fulfillment Provider
    • Remove Country
  • Return Reasons
    • Get a Return Reason
    • Delete a Return Reason
    • Update a Return Reason
    • List Return Reasons
    • Create a Return Reason
  • Returns
    • Receive a Return
    • List Returns
    • Cancel a Return
  • Sales Channels
    • Remove Stock Location from Sales Channels.
    • Associate a Stock Location
    • Get a Sales Channel
    • Delete a Sales Channel
    • Update a Sales Channel
    • Remove Products from Sales Channel
    • Add Products to Sales Channel
    • Create a Sales Channel
    • List Sales Channels
  • Shipping Options
    • Update Shipping Option
    • Get a Shipping Option
    • Delete Shipping Option
    • List Shipping Options
    • Create Shipping Option
  • Shipping Profiles
    • List Shipping Profiles
    • Create a Shipping Profile
    • Delete a Shipping Profile
    • Update a Shipping Profile
    • Get a Shipping Profile
  • Stock Locations
    • Get a Stock Location
    • List Stock Locations
    • Create a Stock Location
    • Update a Stock Location
    • Delete a Stock Location
  • Store
    • List Payment Providers
    • Add a Currency Code
    • Remove a Currency
    • List Tax Providers
    • Update Store Details
    • Get Store details
  • Swaps
    • Get a Swap
    • List Swaps
  • Uploads
    • Upload Files
    • Delete an Uploaded File
    • Get a File's Download URL
    • Protected File Upload
  • Tax Rates
    • Add to Shipping Options
    • Remove Shipping Options from Rate
    • Create a Tax Rate
    • List Tax Rates
    • Add to Products
    • Remove Products from Rate
    • Delete a Tax Rate
    • Get a Tax Rate
    • Update a Tax Rate
    • Add to Product Types
    • Remove Product Types from Rate
  • Users
    • Reset Password
    • Request Password Reset
    • Get a User
    • Delete a User
    • Update a User
    • Create a User
    • List Users
  1. Discounts

Delete a Condition

DELETE
/admin/discounts/{discount_id}/conditions/{condition_id}
Discounts
Deletes a Discount Condition. This does not delete resources associated to the discount condition.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request DELETE '{{BASE_URL}}/admin/discounts//conditions/'
Response Response Example
200 - Example 1
{
    "id": "string",
    "object": "discount-condition",
    "deleted": true,
    "discount": {
        "id": "disc_01F0YESMW10MGHWJKZSDDMN0VN",
        "code": "10DISC",
        "is_dynamic": false,
        "rule_id": "dru_01F0YESMVK96HVX7N419E3CJ7C",
        "is_disabled": false,
        "parent_discount_id": "disc_01G8ZH853YPY9B94857DY91YGW",
        "parent_discount": {},
        "starts_at": "2019-08-24T14:15:22Z",
        "ends_at": "2019-08-24T14:15:22Z",
        "valid_duration": "P3Y6M4DT12H30M5S",
        "usage_limit": 100,
        "usage_count": 0,
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "deleted_at": "2019-08-24T14:15:22Z",
        "metadata": {
            "car": "white"
        },
        "rule": {
            "id": "dru_01F0YESMVK96HVX7N419E3CJ7C",
            "description": "10 Percent",
            "value": 10,
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z",
            "type": "fixed",
            "allocation": "total",
            "conditions": [
                {}
            ],
            "metadata": {
                "car": "white"
            }
        },
        "regions": [
            {
                "id": "reg_01G1G5V26T9H8Y0M4JNE3YGA4G",
                "name": "EU",
                "tax_rate": 0,
                "tax_code": null,
                "gift_cards_taxable": true,
                "automatic_taxes": true,
                "tax_provider_id": null,
                "includes_tax": false,
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z",
                "deleted_at": "2019-08-24T14:15:22Z",
                "currency_code": "usd",
                "metadata": {
                    "car": "white"
                },
                "currency": {
                    "symbol": "$",
                    "symbol_native": "$",
                    "name": "US Dollar",
                    "includes_tax": false,
                    "code": "usd"
                },
                "countries": [
                    {
                        "id": 109,
                        "name": "ITALY",
                        "display_name": "Italy",
                        "region_id": "reg_01G1G5V26T9H8Y0M4JNE3YGA4G",
                        "region": {},
                        "iso_2": "it",
                        "iso_3": "ita",
                        "num_code": 380
                    }
                ],
                "tax_provider": {
                    "id": "manual",
                    "is_installed": true
                },
                "payment_providers": [
                    {
                        "id": "manual",
                        "is_installed": true
                    }
                ],
                "fulfillment_providers": [
                    {
                        "id": "manual",
                        "is_installed": true
                    }
                ],
                "tax_rates": [
                    {
                        "id": "txr_01G8XDBAWKBHHJRKH0AV02KXBR",
                        "rate": 10,
                        "code": "tax01",
                        "name": "Tax Example",
                        "region_id": "reg_01G1G5V26T9H8Y0M4JNE3YGA4G",
                        "region": {},
                        "product_count": 10,
                        "product_type_count": 2,
                        "shipping_option_count": 1,
                        "created_at": "2019-08-24T14:15:22Z",
                        "updated_at": "2019-08-24T14:15:22Z",
                        "metadata": {
                            "car": "white"
                        },
                        "product_types": [
                            {
                                "id": "ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A",
                                "value": "Clothing",
                                "created_at": "2019-08-24T14:15:22Z",
                                "updated_at": "2019-08-24T14:15:22Z",
                                "deleted_at": "2019-08-24T14:15:22Z",
                                "metadata": {
                                    "car": "white"
                                }
                            }
                        ],
                        "shipping_options": [
                            {
                                "id": "so_01G1G5V27GYX4QXNARRQCW1N8T",
                                "name": "PostFake Standard",
                                "region_id": "reg_01G1G5V26T9H8Y0M4JNE3YGA4G",
                                "region": {},
                                "profile_id": "sp_01G1G5V239ENSZ5MV4JAR737BM",
                                "provider_id": "manual",
                                "amount": 200,
                                "is_return": false,
                                "admin_only": false,
                                "includes_tax": false,
                                "created_at": "2019-08-24T14:15:22Z",
                                "updated_at": "2019-08-24T14:15:22Z",
                                "deleted_at": "2019-08-24T14:15:22Z",
                                "price_type": "flat_rate",
                                "data": {},
                                "metadata": {
                                    "car": "white"
                                },
                                "provider": {
                                    "id": "manual",
                                    "is_installed": true
                                },
                                "requirements": [
                                    {
                                        "id": "sor_01G1G5V29AB4CTNDRFSRWSRKWD",
                                        "shipping_option_id": "so_01G1G5V27GYX4QXNARRQCW1N8T",
                                        "shipping_option": {},
                                        "amount": 100,
                                        "deleted_at": "2019-08-24T14:15:22Z",
                                        "type": "min_subtotal"
                                    }
                                ],
                                "profile": {
                                    "id": "sp_01G1G5V239ENSZ5MV4JAR737BM",
                                    "name": "Default Shipping Profile",
                                    "created_at": "2019-08-24T14:15:22Z",
                                    "updated_at": "2019-08-24T14:15:22Z",
                                    "deleted_at": "2019-08-24T14:15:22Z",
                                    "type": "default",
                                    "products": [
                                        {}
                                    ],
                                    "shipping_options": [
                                        {}
                                    ],
                                    "metadata": {
                                        "car": "white"
                                    }
                                }
                            }
                        ],
                        "products": [
                            {
                                "id": "prod_01G1G5V2MBA328390B5AXJ610F",
                                "title": "Medusa Coffee Mug",
                                "subtitle": "string",
                                "description": "Every programmer's best friend.",
                                "handle": "coffee-mug",
                                "is_giftcard": false,
                                "thumbnail": "http://example.com",
                                "profile_id": "sp_01G1G5V239ENSZ5MV4JAR737BM",
                                "weight": null,
                                "length": null,
                                "height": null,
                                "width": null,
                                "hs_code": null,
                                "origin_country": null,
                                "mid_code": null,
                                "material": null,
                                "collection_id": "pcol_01F0YESBFAZ0DV6V831JXWH0BG",
                                "type_id": "ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A",
                                "discountable": true,
                                "external_id": null,
                                "created_at": "2019-08-24T14:15:22Z",
                                "updated_at": "2019-08-24T14:15:22Z",
                                "deleted_at": "2019-08-24T14:15:22Z",
                                "status": "draft",
                                "metadata": {
                                    "car": "white"
                                },
                                "images": [
                                    {
                                        "id": "img_01G749BFYR6T8JTVW6SGW3K3E6",
                                        "url": "http://example.com",
                                        "created_at": "2019-08-24T14:15:22Z",
                                        "updated_at": "2019-08-24T14:15:22Z",
                                        "deleted_at": "2019-08-24T14:15:22Z",
                                        "metadata": {
                                            "car": "white"
                                        }
                                    }
                                ],
                                "categories": [
                                    {
                                        "id": "pcat_01G2SG30J8C85S4A5CHM2S1NS2",
                                        "name": "Regular Fit",
                                        "handle": "regular-fit",
                                        "mpath": "pcat_id1.pcat_id2.pcat_id3",
                                        "is_internal": false,
                                        "is_active": false,
                                        "rank": 0,
                                        "parent_category_id": null,
                                        "parent_category": {},
                                        "created_at": "2019-08-24T14:15:22Z",
                                        "updated_at": "2019-08-24T14:15:22Z",
                                        "category_children": [
                                            {}
                                        ],
                                        "products": [
                                            {}
                                        ]
                                    }
                                ],
                                "collection": {
                                    "id": "pcol_01F0YESBFAZ0DV6V831JXWH0BG",
                                    "title": "Summer Collection",
                                    "handle": "summer-collection",
                                    "created_at": "2019-08-24T14:15:22Z",
                                    "updated_at": "2019-08-24T14:15:22Z",
                                    "deleted_at": "2019-08-24T14:15:22Z",
                                    "products": [
                                        {}
                                    ],
                                    "metadata": {
                                        "car": "white"
                                    }
                                },
                                "tags": [
                                    {
                                        "id": "ptag_01G8K2MTMG9168F2B70S1TAVK3",
                                        "value": "Pants",
                                        "created_at": "2019-08-24T14:15:22Z",
                                        "updated_at": "2019-08-24T14:15:22Z",
                                        "deleted_at": "2019-08-24T14:15:22Z",
                                        "metadata": {
                                            "car": "white"
                                        }
                                    }
                                ],
                                "profile": {
                                    "id": "sp_01G1G5V239ENSZ5MV4JAR737BM",
                                    "name": "Default Shipping Profile",
                                    "created_at": "2019-08-24T14:15:22Z",
                                    "updated_at": "2019-08-24T14:15:22Z",
                                    "deleted_at": "2019-08-24T14:15:22Z",
                                    "type": "default",
                                    "products": [
                                        {}
                                    ],
                                    "shipping_options": [
                                        {}
                                    ],
                                    "metadata": {
                                        "car": "white"
                                    }
                                },
                                "profiles": [
                                    {
                                        "id": "sp_01G1G5V239ENSZ5MV4JAR737BM",
                                        "name": "Default Shipping Profile",
                                        "created_at": "2019-08-24T14:15:22Z",
                                        "updated_at": "2019-08-24T14:15:22Z",
                                        "deleted_at": "2019-08-24T14:15:22Z",
                                        "type": "default",
                                        "products": [
                                            {}
                                        ],
                                        "shipping_options": [
                                            {}
                                        ],
                                        "metadata": {
                                            "car": "white"
                                        }
                                    }
                                ],
                                "type": {
                                    "id": "ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A",
                                    "value": "Clothing",
                                    "created_at": "2019-08-24T14:15:22Z",
                                    "updated_at": "2019-08-24T14:15:22Z",
                                    "deleted_at": "2019-08-24T14:15:22Z",
                                    "metadata": {
                                        "car": "white"
                                    }
                                },
                                "sales_channels": [
                                    {
                                        "id": "sc_01G8X9A7ESKAJXG2H0E6F1MW7A",
                                        "name": "Market",
                                        "description": "Multi-vendor market",
                                        "is_disabled": false,
                                        "created_at": "2019-08-24T14:15:22Z",
                                        "updated_at": "2019-08-24T14:15:22Z",
                                        "deleted_at": "2019-08-24T14:15:22Z",
                                        "metadata": {
                                            "car": "white"
                                        },
                                        "locations": [
                                            {
                                                "id": "scloc_01G8X9A7ESKAJXG2H0E6F1MW7A",
                                                "sales_channel_id": "sc_01G8X9A7ESKAJXG2H0E6F1MW7A",
                                                "location_id": "string",
                                                "sales_channel": {},
                                                "created_at": "2019-08-24T14:15:22Z",
                                                "updated_at": "2019-08-24T14:15:22Z",
                                                "deleted_at": "2019-08-24T14:15:22Z"
                                            }
                                        ]
                                    }
                                ],
                                "options": [
                                    {
                                        "id": "opt_01F0YESHQBZVKCEXJ24BS6PCX3",
                                        "title": "Size",
                                        "product_id": "prod_01G1G5V2MBA328390B5AXJ610F",
                                        "product": {},
                                        "created_at": "2019-08-24T14:15:22Z",
                                        "updated_at": "2019-08-24T14:15:22Z",
                                        "deleted_at": "2019-08-24T14:15:22Z",
                                        "metadata": {
                                            "car": "white"
                                        },
                                        "values": [
                                            {
                                                "id": "optval_01F0YESHR7S6ECD03RF6W12DSJ",
                                                "value": "large",
                                                "option_id": "opt_01F0YESHQBZVKCEXJ24BS6PCX3",
                                                "option": {},
                                                "variant_id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6",
                                                "variant": {},
                                                "created_at": "2019-08-24T14:15:22Z",
                                                "updated_at": "2019-08-24T14:15:22Z",
                                                "deleted_at": "2019-08-24T14:15:22Z",
                                                "metadata": {
                                                    "car": "white"
                                                }
                                            }
                                        ]
                                    }
                                ],
                                "variants": [
                                    {
                                        "id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6",
                                        "title": "Small",
                                        "product_id": "prod_01G1G5V2MBA328390B5AXJ610F",
                                        "product": {},
                                        "sku": "shirt-123",
                                        "barcode": null,
                                        "ean": null,
                                        "upc": null,
                                        "variant_rank": 0,
                                        "inventory_quantity": 100,
                                        "allow_backorder": false,
                                        "manage_inventory": true,
                                        "hs_code": null,
                                        "origin_country": null,
                                        "mid_code": null,
                                        "material": null,
                                        "weight": null,
                                        "length": null,
                                        "height": null,
                                        "width": null,
                                        "created_at": "2019-08-24T14:15:22Z",
                                        "updated_at": "2019-08-24T14:15:22Z",
                                        "deleted_at": "2019-08-24T14:15:22Z",
                                        "purchasable": true,
                                        "metadata": {
                                            "car": "white"
                                        },
                                        "options": [
                                            {
                                                "id": "optval_01F0YESHR7S6ECD03RF6W12DSJ",
                                                "value": "large",
                                                "option_id": "opt_01F0YESHQBZVKCEXJ24BS6PCX3",
                                                "option": {},
                                                "variant_id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6",
                                                "variant": {},
                                                "created_at": "2019-08-24T14:15:22Z",
                                                "updated_at": "2019-08-24T14:15:22Z",
                                                "deleted_at": "2019-08-24T14:15:22Z",
                                                "metadata": {
                                                    "car": "white"
                                                }
                                            }
                                        ],
                                        "inventory_items": [
                                            {
                                                "id": "pvitem_01G8X9A7ESKAJXG2H0E6F1MW7A",
                                                "inventory_item_id": "string",
                                                "variant_id": "string",
                                                "variant": {},
                                                "required_quantity": 1,
                                                "created_at": "2019-08-24T14:15:22Z",
                                                "updated_at": "2019-08-24T14:15:22Z",
                                                "deleted_at": "2019-08-24T14:15:22Z"
                                            }
                                        ],
                                        "prices": [
                                            {
                                                "id": "ma_01F0YESHRFQNH5S8Q0PK84YYZN",
                                                "amount": 100,
                                                "min_quantity": 1,
                                                "max_quantity": 1,
                                                "price_list_id": "pl_01G8X3CKJXCG5VXVZ87H9KC09W",
                                                "price_list": {},
                                                "variant_id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6",
                                                "variant": {},
                                                "region_id": "reg_01G1G5V26T9H8Y0M4JNE3YGA4G",
                                                "region": {},
                                                "created_at": "2019-08-24T14:15:22Z",
                                                "updated_at": "2019-08-24T14:15:22Z",
                                                "deleted_at": "2019-08-24T14:15:22Z",
                                                "currency_code": "usd",
                                                "currency": {
                                                    "symbol": "$",
                                                    "symbol_native": "$",
                                                    "name": "US Dollar",
                                                    "includes_tax": false,
                                                    "code": "usd"
                                                }
                                            }
                                        ]
                                    }
                                ]
                            }
                        ]
                    }
                ]
            }
        ]
    }
}

Request

Path Params
discount_id
string 
required
The ID of the Discount
condition_id
string 
required
The ID of the Discount Condition
Query Params
expand
string 
optional
Comma-separated relations that should be expanded in the returned discount.
fields
string 
optional
Comma-separated fields that should be included in the returned discount.

Responses

🟢200OK
application/json
Body
id
string 
required
The ID of the deleted Discount Condition
object
string 
required
The type of the object that was deleted.
Default:
discount-condition
deleted
boolean 
required
Whether the discount condition was deleted successfully.
Default:
true
discount
object (Discount) 
required
A discount can be applied to a cart for promotional purposes.
id
string 
required
The discount's ID
Example:
disc_01F0YESMW10MGHWJKZSDDMN0VN
code
string 
required
A unique code for the discount - this will be used by the customer to apply the discount
Example:
10DISC
is_dynamic
boolean 
required
A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts
Example:
false
rule_id
string  | null 
required
The ID of the discount rule that defines how the discount will be applied to a cart.
Example:
dru_01F0YESMVK96HVX7N419E3CJ7C
is_disabled
boolean 
required
Whether the Discount has been disabled. Disabled discounts cannot be applied to carts
Example:
false
parent_discount_id
string  | null 
required
The Discount that the discount was created from. This will always be a dynamic discount
Example:
disc_01G8ZH853YPY9B94857DY91YGW
parent_discount
object  | null 
optional
The details of the parent discount that this discount was created from.
starts_at
string <date-time>
required
The time at which the discount can be used.
ends_at
string <date-time> | null 
required
The time at which the discount can no longer be used.
valid_duration
string  | null 
required
Duration the discount runs between
Example:
P3Y6M4DT12H30M5S
usage_limit
integer  | null 
required
The maximum number of times that a discount can be used.
Example:
100
usage_count
integer 
required
The number of times a discount has been used.
Default:
0
Example:
50
created_at
string <date-time>
required
The date with timezone at which the resource was created.
updated_at
string <date-time>
required
The date with timezone at which the resource was updated.
deleted_at
string <date-time> | null 
required
The date with timezone at which the resource was deleted.
metadata
object  | null 
required
An optional key-value map with additional details
Example:
{"car":"white"}
rule
object (Discount Rule) 
optional
A discount rule defines how a Discount is calculated when applied to a Cart.
regions
array[object (Region) {19}] 
optional
The details of the regions in which the Discount can be used.
🟠400Client Error or Multiple Errors
🟠401User is not authorized. Must log in first
🟠404Not Found Error
🟠409Invalid State Error
🟠422Invalid Request Error
🔴500Server Error
Previous
Update a Condition
Next
Create a Dynamic Code
Built with