# List coupons.

List coupons.

Endpoint: GET /coupons
Version: 1.0.0
Security: Token

## Query parameters:

  - `filter[search]` (string)
    Return coupons that have a name matching this field.
    Example: "00000000-0000-4000-8000-000000000000"

  - `include` (string)
    Comma separated list of optional data to include in the response.
    Example: "promotion_codes"

  - `sort` (string)
    Comma separated list of fields used for sorting. Placing a minus symbol in front of a field name sorts in descending order. Defaults to -created_at.
    Example: "-created_at"

  - `per_page` (string)
    The number of items per page. Defaults to 25.
    Example: "25"

  - `page` (string)
    The requested page. Defaults to 1.
    Example: "2"

## Response 200 fields (application/json):

  - `status` (string, required)
    What was the state of the request?
    Example: "success"

  - `data` (array,null)
    A collection of objects.

  - `data.id` (string, required)
    ID of the entity. UUID Version 4.
    Example: "00000000-0000-4000-8000-000000000000"

  - `data.name` (string)
    Name of the coupon displayed to customers on orders.
    Example: "VIP Customer Discount"

  - `data.is_active` (boolean)
    Indicates if the coupon is currently active.
    Example: true

  - `data.is_percent_off` (boolean)
    Indicates if the coupon is a percent off coupon.
    Example: true

  - `data.percent_off` (number)
    A decimal value representing the percent that will be taken off the subtotal of an order this coupon is applied to. For example, 0.500 would represent an applied discount of 50%, meaning an order with a subtotal of $100 would result in a balance of $50.
    Example: 0.075

  - `data.amount_off` (integer)
    Amount that will be taken off the subtotal of any orders this coupon is applied to. Amount represented in the smallest currency unit (that is, 100 cents for $1.00).
    Example: 2500

  - `data.amount_off_formatted` (string)
    The amount off formatted as a string.
    Example: "$25.00"

  - `data.promotion_codes` (array)

  - `data.promotion_codes.code` (string, required)
    The customer-facing code. This code must be unique across all active promotion codes.
    Example: "SPRING_SALE"

  - `data.promotion_codes.times_redeemed` (integer)
    The number of times the coupon has been redeemed.
    Example: 10

  - `data.promotion_codes.start_at` (string,null)
    The date and time (ISO 8601 format) when the promotion code will be active.
    Example: "2021-06-30T20:30:00Z"

  - `data.promotion_codes.end_at` (string,null)
    The date and time (ISO 8601 format) when the promotion code will no longer be active.
    Example: "2021-06-30T20:30:00Z"

  - `data.promotion_codes.max_redemptions` (integer,null)
    The maximum number of times the promotion code can be redeemed.
    Example: 10

  - `data.promotion_codes.max_redemptions_per_customer` (integer,null)
    The maximum number of times the promotion code can be redeemed per customer.
    Example: 10

  - `data.promotion_codes.first_time_only` (boolean,null)
    Indicates if the promotion code can only be redeemed once per customer.
    Example: true

  - `data.promotion_codes.minimum_amount` (integer,null)
    The minimum amount that must be in the cart before the promotion code can be applied.
    Example: 1000

  - `data.promotion_codes.is_portal_mobile_app_only` (boolean,null)
    Indicates if the promotion code can only be redeemed on the portal mobile app.
    Example: true

  - `data.discountables` (array)

  - `data.discountables.object` (string)
    String representing the object’s type. Objects of the same type share the same schema.
    Example: "DISCOUNTABLE"

  - `data.discountables.discountable` (object)
    A discountable item.

  - `data.discountables.discountable.object` (string)
    A canonical value representing a resource.
    Example: "PRODUCT"

  - `data.discountables.discountable.title` (string)
    The title of the item.
    Example: "House photos"

  - `data.discountables.discountable.description` (string)
    The description of the item.
    Example: "Capture photos of a house for sale."

  - `data.discountables.discountable.active` (boolean)
    The active status of an item.
    Example: true

  - `data.discountables.discountable.type` (string)
    The type of item.
    Example: "MAIN"

  - `data.discountables.discountable.is_twilight` (boolean)
    Whether the item is available during twilight hours.
    Example: true

  - `data.discountables.discountable.image_url` (string,null)
    A URL for an example property image.
    Example: "https://picsum.photos/400/200"

  - `data.discountables.discountable.is_serviceable` (boolean)
    Whether the item is serviceable.
    Example: true

  - `data.discountables.discountable.requires_separate_booking` (boolean)
    Whether the item requires a separate booking.
    Example: true

  - `data.discountables.discountable.always_display_addons` (boolean)
    Whether to always display addons for the item.
    Example: true

  - `data.discountables.discountable.variant_filter_type` (string,null)
    The type of variant filter.
    Example: "ALL"

  - `data.discountables.discountable.avalara_tax_code` (string,null)
    The Avalara tax code for the item.
    Example: "12345"

  - `data.discountables.discountable.limit_quantity_amount` (integer,null)
    The limit quantity amount for the item.
    Example: 10

  - `data.discountables.discountable.limit_quantity` (boolean)
    Whether the item has a limit quantity.
    Example: true

  - `data.discountables.discountable.is_filterable` (boolean)
    Whether the item is filterable.
    Example: true

  - `data.discountables.discountable.is_esoft_adjustment` (boolean)
    Whether the item is an eSoft adjustment.
    Example: true

  - `data.discountables.discountable.variants` (array)

  - `data.discountables.discountable.variants.title` (string, required)
    The title of the product variant.
    Example: "House photos"

  - `data.discountables.discountable.variants.price` (integer)
    A positive integer in the smallest currency unit (that is, 100 cents for $1.00) representing the price of the product variant.
    Example: 10000

  - `data.discountables.discountable.variants.price_amount` (integer)
    A positive integer in the smallest currency unit (that is, 100 cents for $1.00) representing the price of the product variant.
    Example: 10000

  - `data.discountables.discountable.variants.base_price_amount` (integer)
    A positive integer in the smallest currency unit (that is, 100 cents for $1.00) representing the price of the product variant.
    Example: 10000

  - `data.discountables.discountable.variants.base_is_hidden` (boolean)
    Indicates if the base price of the product variant is hidden.
    Example: true

  - `data.discountables.discountable.variants.display_original_price` (boolean)
    Indicates if the original price of the product variant should be displayed.
    Example: true

  - `data.discountables.discountable.variants.duration` (integer)
    The duration of the product item, in minutes.
    Example: 60

  - `data.discountables.discountable.categories` (array)

  - `data.discountables.discountable.categories.title` (string, required)
    The title of the product category.
    Example: "Photography"

  - `data.discountables.discountable.categories.name` (string)
    The name of the product category.
    Example: "Photography"

  - `data.discountables.discountable.categories.slug` (string)
    The slug of the product category.
    Example: "photography"

  - `data.discountables.discountable.categories.color` (string)
    The color of the product category.
    Example: "#000000"

  - `data.discountables.discountable.categories.type` (string)
    The type of the product category.
    Example: "product"

  - `data.discountables.discountable.quickbooks_item_id` (string,null)
    The Quickbooks item ID for the item.
    Example: "12345"

  - `data.discountables.discountable.amount` (number)
    The amount of the item.
    Example: 100

  - `data.discountables.discountable.name` (string)
    The name of the item.
    Example: "Flat Fee"

  - `data.created_at` (string,null)
    The date and time (ISO 8601 format) when the order was created.
    Example: "2021-06-30T20:30:00Z"

  - `meta` (object)
    Metadata about a paginated response.

  - `meta.total` (integer, required)
    Total number of records.
    Example: 50

  - `meta.per_page` (integer, required)
    Number of records per page.
    Example: 15

  - `meta.current_page` (integer, required)
    The current page.
    Example: 1

  - `meta.last_page` (integer, required)
    The last page of records.
    Example: 4

  - `meta.from` (integer,null)
    The ID of the first record on this page. This is specified as either integer or null purely for spec testing purposes. The model which is autogenerated from this definition will be thrown out and written by-hand.
    Example: 1

  - `meta.to` (integer,null)
    The ID of the last record on this page. This is specified as either integer or null purely for spec testing purposes. The model which is autogenerated from this definition will be thrown out and written by-hand.
    Example: 15

  - `meta.path` (string, required)
    The current paged path.
    Example: "https://api.aryeo.com/v1/{path}"

  - `meta.links` (array,null)
    Links.

  - `meta.links.url` (string,null, required)
    The URL of the page.
    Example: "https://admin.aryeo.test/api/v1/companies?page=2"

  - `meta.links.label` (string, required)
    The label of the page.
    Example: "2"

  - `meta.links.active` (boolean, required)
    Whether the page is active.
    Example: true

  - `meta.links.page` (integer,null)
    The page number this link points to.
    Example: 2

  - `links` (object)
    Related links for a paginated response.

  - `links.first` (string, required)
    The first page.
    Example: "https://api.aryeo.com/v1/{path}?page=1"

  - `links.last` (string, required)
    The last page.
    Example: "https://api.aryeo.com/v1/{path}?page=10"

  - `links.prev` (string,null)
    The previous page. This is specified as either string or null purely for spec testing purposes. The model which is autogenerated from this definition will be thrown out and written by-hand.
    Example: "https://api.aryeo.com/v1/{path}?page=2"

  - `links.next` (string,null)
    The next page. This is specified as either string or null purely for spec testing purposes. The model which is autogenerated from this definition will be thrown out and written by-hand.
    Example: "https://api.aryeo.com/v1/{path}?page=3"

  - `timestamp` (string,null)
    The request timestamp (ISO 8601).
    Example: "2021-06-30T20:30:00Z"

## Response 403 fields (application/json):

  - `status` (string, required)
    What was the state of the request?
    Example: "error"

  - `message` (string, required)
    The error message.
    Example: "{ApiError message.}"

  - `code` (integer,null)
    A numeric code corresponding to the error.
    Example: 403

## Response 404 fields (application/json):

  - `status` (string, required)
    What was the state of the request?
    Example: "error"

  - `message` (string, required)
    The error message.
    Example: "{ApiError message.}"

  - `code` (integer,null)
    A numeric code corresponding to the error.
    Example: 404

## Response 422 fields (application/json):

  - `status` (string, required)
    What was the state of the request?
    Example: "fail"

## Response 500 fields (application/json):

  - `status` (string, required)
    What was the state of the request?
    Example: "error"

  - `message` (string, required)
    The error message.
    Example: "{ApiError message.}"

  - `code` (integer,null)
    A numeric code corresponding to the error.
    Example: 500