Coupon usage

Authorizations

• Authorization string required header

  Generate a store API key from the store's Metorik API settings in Metorik, and choose the scopes needed for the endpoints you want to call.

Query Parameters

• end_date string required

  End date in the store timezone using YYYY-MM-DD format. Example: 2026-02-28

• has_usage boolean

  Filter coupons by whether they were used in the selected period. Example: true

• order_by string enum

  Sort field. Example: coupon_created_at

• order_dir string enum

  Sort direction. Example: desc

• order_filters string

  Optional JSON-encoded array of order-level filters applied before calculating coupon usage and sales. See Order Filters Reference. Example: [{"field":"billing_address_country","operator":"eq","value":"US"}]

• page integer

  Page number for pagination. Example: 1

• per_page integer

  Number of coupons per page. Min 1, max 100. Example: 10

• search string

  Search term to filter coupons. Example: SUMMER

• start_date string required

  Start date in the store timezone using YYYY-MM-DD format. Example: 2026-02-01

Headers

• Accept string required

  Response format header. Example: application/json

• data[] object array

  + - Show Child Attributes

  • coupon_id integer
  • code string
  • status string
  • coupon_created_at string
  • coupon_updated_at string
  • date_expires string nullable
  • amount integer
  • discount_type string
  • usage_count integer
  • total_discounted integer
  • sales_generated number
  • sales_generated_cost number
  • sales_generated_gross_profit number
  • last_used_at string
  • resource_link string
• pagination object

  + - Show Child Attributes

  • current_page integer
  • per_page integer
  • has_more_pages boolean