--- openapi: 3.0.1 info: title: BYBE API version: v1 description: "\n Welcome to the BYBE API, V1.\n\n You can use this API to access our records of manufacturers,\n rebate offers, and products,\n as well as to validate redemptions for transactions and disburse payouts.\n\n Each route is documented below via the OpenAPI specification.\n Authorization details can be entered using the `Authorize` button on the right.\n " paths: "/v1/clips": get: summary: list clips tags: - Clips description: List clips, optionally filtering by offer_id, the consumer's retailer_identifier, or other options. security: - basic_auth: [] parameters: - name: page in: query required: false description: Page of results to return schema: type: integer - name: limit in: query required: false description: Number of clips per page schema: type: integer - name: offer_id in: query required: false description: Filter to a specific offer schema: type: integer - name: consumer_retailer_identifier in: query required: false description: Filter to a specific consumer schema: type: string responses: '200': description: list of clips content: application/json: examples: unfiltered list of clips: value: clips: - id: 980190962 consumer: id: 980190962 retailer_identifier: RETAILERCONSUMERID created_at: '2026-06-17T13:55:38.873Z' retailer_identifier: 123ABC latitude: '10.12331' longitude: "-120.02332" created_at: '2026-06-17T13:55:38.862Z' offer: id: 980190962 name: Holiday sale on spirits clip_limit: 5 clips_remaining: -3 budget_limit_cents: 2000 budget_limit_currency: USD budget_remaining_cents: 1700 budget_remaining_currency: USD discount_cents: 300 discount_currency: USD conditions: Offer open to residents of KY. Must be 21 years of age. details: Offer details start_date: '2017-10-27T02:13:25.000Z' end_date: '2026-07-17T13:55:38.000Z' per_consumer_limit: 1 redemptions_available: 10 redemptions_remaining: 9 offer_type: discount created_at: '2026-06-17T13:55:38.857Z' updated_at: '2026-06-17T13:55:38.857Z' - id: 1018350795 consumer: id: 980190962 retailer_identifier: RETAILERCONSUMERID created_at: '2026-06-17T13:55:38.873Z' retailer_identifier: 789ABC latitude: '10.12331' longitude: "-120.02332" created_at: '2026-06-17T13:55:38.862Z' offer: id: 621189049 name: Buy one of these, get cash clip_limit: 5 clips_remaining: 3 budget_limit_cents: 2000 budget_limit_currency: USD budget_remaining_cents: 2000 budget_remaining_currency: USD discount_cents: 300 discount_currency: USD conditions: Buy three in OH. details: Offer details start_date: '2017-10-27T02:13:25.000Z' end_date: '2026-07-17T13:55:38.000Z' per_consumer_limit: 1 redemptions_available: 10 redemptions_remaining: 10 offer_type: discount created_at: '2026-06-17T13:55:38.857Z' updated_at: '2026-06-17T13:55:38.857Z' - id: 51848956 consumer: id: 980190962 retailer_identifier: RETAILERCONSUMERID created_at: '2026-06-17T13:55:38.873Z' retailer_identifier: 189DDD latitude: '10.12331' longitude: "-120.02332" created_at: '2026-06-17T13:55:38.862Z' offer: id: 955136116 name: Beer Club clip_limit: 5 clips_remaining: 3 budget_limit_cents: 5000 budget_limit_currency: USD budget_remaining_cents: 5000 budget_remaining_currency: USD discount_cents: 500 discount_currency: USD conditions: Buy 6 get 5 back details: Offer details start_date: '2017-10-27T02:13:25.000Z' end_date: '2026-07-17T13:55:38.000Z' per_consumer_limit: 1 redemptions_available: 1 redemptions_remaining: 1 offer_type: club created_at: '2026-06-17T13:55:38.857Z' updated_at: '2026-06-17T13:55:38.857Z' - id: 374648174 consumer: id: 980190962 retailer_identifier: RETAILERCONSUMERID created_at: '2026-06-17T13:55:38.873Z' retailer_identifier: 189EEE latitude: '10.12331' longitude: "-120.02332" created_at: '2026-06-17T13:55:38.862Z' offer: id: 849914497 name: Beer Club Two clip_limit: 5 clips_remaining: 3 budget_limit_cents: 5000 budget_limit_currency: USD budget_remaining_cents: 5000 budget_remaining_currency: USD discount_cents: 100 discount_currency: USD conditions: Buy 2 get 1 back details: Offer details start_date: '2017-10-27T02:13:25.000Z' end_date: '2026-07-17T13:55:38.000Z' per_consumer_limit: 1 redemptions_available: 1 redemptions_remaining: 1 offer_type: club created_at: '2026-06-17T13:55:38.857Z' updated_at: '2026-06-17T13:55:38.857Z' meta: current_page: 1 total_pages: 1 per_page_limit: 5000 total_records: 4 count: 4 list clips for a specific consumer: value: clips: - id: 980190962 consumer: id: 980190962 retailer_identifier: RETAILERCONSUMERID created_at: '2026-06-17T13:55:38.873Z' retailer_identifier: 123ABC latitude: '10.12331' longitude: "-120.02332" created_at: '2026-06-17T13:55:38.862Z' offer: id: 980190962 name: Holiday sale on spirits clip_limit: 5 clips_remaining: -3 budget_limit_cents: 2000 budget_limit_currency: USD budget_remaining_cents: 1700 budget_remaining_currency: USD discount_cents: 300 discount_currency: USD conditions: Offer open to residents of KY. Must be 21 years of age. details: Offer details start_date: '2017-10-27T02:13:25.000Z' end_date: '2026-07-17T13:55:38.000Z' per_consumer_limit: 1 redemptions_available: 10 redemptions_remaining: 9 offer_type: discount created_at: '2026-06-17T13:55:38.857Z' updated_at: '2026-06-17T13:55:38.857Z' - id: 1018350795 consumer: id: 980190962 retailer_identifier: RETAILERCONSUMERID created_at: '2026-06-17T13:55:38.873Z' retailer_identifier: 789ABC latitude: '10.12331' longitude: "-120.02332" created_at: '2026-06-17T13:55:38.862Z' offer: id: 621189049 name: Buy one of these, get cash clip_limit: 5 clips_remaining: 3 budget_limit_cents: 2000 budget_limit_currency: USD budget_remaining_cents: 2000 budget_remaining_currency: USD discount_cents: 300 discount_currency: USD conditions: Buy three in OH. details: Offer details start_date: '2017-10-27T02:13:25.000Z' end_date: '2026-07-17T13:55:38.000Z' per_consumer_limit: 1 redemptions_available: 10 redemptions_remaining: 10 offer_type: discount created_at: '2026-06-17T13:55:38.857Z' updated_at: '2026-06-17T13:55:38.857Z' - id: 51848956 consumer: id: 980190962 retailer_identifier: RETAILERCONSUMERID created_at: '2026-06-17T13:55:38.873Z' retailer_identifier: 189DDD latitude: '10.12331' longitude: "-120.02332" created_at: '2026-06-17T13:55:38.862Z' offer: id: 955136116 name: Beer Club clip_limit: 5 clips_remaining: 3 budget_limit_cents: 5000 budget_limit_currency: USD budget_remaining_cents: 5000 budget_remaining_currency: USD discount_cents: 500 discount_currency: USD conditions: Buy 6 get 5 back details: Offer details start_date: '2017-10-27T02:13:25.000Z' end_date: '2026-07-17T13:55:38.000Z' per_consumer_limit: 1 redemptions_available: 1 redemptions_remaining: 1 offer_type: club created_at: '2026-06-17T13:55:38.857Z' updated_at: '2026-06-17T13:55:38.857Z' - id: 374648174 consumer: id: 980190962 retailer_identifier: RETAILERCONSUMERID created_at: '2026-06-17T13:55:38.873Z' retailer_identifier: 189EEE latitude: '10.12331' longitude: "-120.02332" created_at: '2026-06-17T13:55:38.862Z' offer: id: 849914497 name: Beer Club Two clip_limit: 5 clips_remaining: 3 budget_limit_cents: 5000 budget_limit_currency: USD budget_remaining_cents: 5000 budget_remaining_currency: USD discount_cents: 100 discount_currency: USD conditions: Buy 2 get 1 back details: Offer details start_date: '2017-10-27T02:13:25.000Z' end_date: '2026-07-17T13:55:38.000Z' per_consumer_limit: 1 redemptions_available: 1 redemptions_remaining: 1 offer_type: club created_at: '2026-06-17T13:55:38.857Z' updated_at: '2026-06-17T13:55:38.857Z' meta: current_page: 1 total_pages: 1 per_page_limit: 5000 total_records: 4 count: 4 list clips for a specific offer: value: clips: - id: 1018350795 consumer: id: 980190962 retailer_identifier: RETAILERCONSUMERID created_at: '2026-06-17T13:55:38.873Z' retailer_identifier: 789ABC latitude: '10.12331' longitude: "-120.02332" created_at: '2026-06-17T13:55:38.862Z' offer: id: 621189049 name: Buy one of these, get cash clip_limit: 5 clips_remaining: 3 budget_limit_cents: 2000 budget_limit_currency: USD budget_remaining_cents: 2000 budget_remaining_currency: USD discount_cents: 300 discount_currency: USD conditions: Buy three in OH. details: Offer details start_date: '2017-10-27T02:13:25.000Z' end_date: '2026-07-17T13:55:38.000Z' per_consumer_limit: 1 redemptions_available: 10 redemptions_remaining: 10 offer_type: discount created_at: '2026-06-17T13:55:38.857Z' updated_at: '2026-06-17T13:55:38.857Z' meta: current_page: 1 total_pages: 1 per_page_limit: 5000 total_records: 1 count: 1 post: summary: create a clip tags: - Clips description: A clip represents a consumer's intent to redeem an offer. Offer clip data will display in the BYBE dashboard to let your team know how many people intended to redeem the offer. security: - basic_auth: [] parameters: [] responses: '201': description: successfully created a clip content: application/json: example: clip: id: 1018350796 retailer_identifier: your_clip_identifier latitude: '42.068443' longitude: "-81.195412" created_at: '2026-06-17T13:55:39.253Z' offer: id: 980190962 name: Holiday sale on spirits budget_limit_cents: 2000 budget_limit_currency: USD budget_remaining_cents: 1700 budget_remaining_currency: USD discount_cents: 300 discount_currency: USD conditions: Offer open to residents of KY. Must be 21 years of age. details: Offer details start_date: '2017-10-27T02:13:25.000Z' end_date: '2026-07-17T13:55:38.000Z' per_consumer_limit: 1 redemptions_available: 10 redemptions_remaining: 9 offer_type: id: 568374289 name: discount created_at: '2026-06-17T13:55:38.868Z' updated_at: '2026-06-17T13:55:38.868Z' created_at: '2026-06-17T13:55:38.857Z' updated_at: '2026-06-17T13:55:38.857Z' consumer: id: 113629430 retailer_identifier: ANOTHER_RETAILER_CONSUMER created_at: '2026-06-17T13:55:38.873Z' '303': description: clip already exists for the same offer and consumer content: application/json: example: location: "/v1/clips/980190962" clip: errors: retailer_identifier: - has already been taken duplicate_clip: - Duplicate clips are not permitted '409': description: a different clip already exists with this retailer_identifier content: application/json: example: clip: errors: retailer_identifier: - has already been taken '422': description: a required field is missing content: application/json: example: clip: errors: retailer_identifier: - can't be blank requestBody: content: application/json: schema: type: object required: - clip properties: clip: type: object required: - offer_id - retailer_identifier properties: offer_id: type: integer description: The ID of the offer to clip retailer_identifier: type: string description: Your unique identifier for this clip consumer: type: object required: - retailer_identifier properties: retailer_identifier: type: string email: type: string description: The email address of the consumer clipping the offer payout_email_override: type: string description: An override email address for payout purposes if different from the consumer email. Only send this if the consumer specifically provided a different email for BYBE rebates latitude: type: number minimum: -90 maximum: 90 longitude: type: number minimum: -180 maximum: 180 "/v1/clips/{id}": parameters: - name: id in: path description: id of the clip required: true schema: type: string get: summary: show clip tags: - Clips security: - basic_auth: [] responses: '200': description: successful content: application/json: example: clip: id: 980190962 consumer: id: 980190962 retailer_identifier: RETAILERCONSUMERID created_at: '2026-06-17T13:55:38.873Z' retailer_identifier: 123ABC latitude: '10.12331' longitude: "-120.02332" created_at: '2026-06-17T13:55:38.862Z' offer: id: 980190962 name: Holiday sale on spirits clip_limit: 5 clips_remaining: -3 budget_limit_cents: 2000 budget_limit_currency: USD budget_remaining_cents: 1700 budget_remaining_currency: USD discount_cents: 300 discount_currency: USD conditions: Offer open to residents of KY. Must be 21 years of age. details: Offer details start_date: '2017-10-27T02:13:25.000Z' end_date: '2026-07-17T13:55:38.000Z' per_consumer_limit: 1 redemptions_available: 10 redemptions_remaining: 9 offer_type: discount created_at: '2026-06-17T13:55:38.857Z' updated_at: '2026-06-17T13:55:38.857Z' "/v1/consumers": post: summary: create a consumer tags: - Consumers description: Creates a consumer object ahead of time, it is recommended to create consumers automatically by creating clips / redemptions instead. security: - basic_auth: [] parameters: [] responses: '200': description: successful content: application/json: example: consumer: id: 1018350796 retailer_identifier: your_consumers_id created_at: '2026-06-17T13:55:39.350Z' requestBody: content: application/json: schema: type: object required: - consumer properties: consumer: type: object required: - retailer_identifier properties: retailer_identifier: type: string payout_email_override: type: string "/v1/consumers/{retailer_identifier}": parameters: - name: retailer_identifier in: path description: the retailer identifier of the consumer that was sent with the clip or redemption requests required: true schema: type: string get: summary: show consumer tags: - Consumers security: - basic_auth: [] responses: '200': description: successful content: application/json: example: consumer: id: 980190962 retailer_identifier: RETAILERCONSUMERID created_at: '2026-06-17T13:55:38.873Z' "/v1/manufacturers": get: summary: list manufacturers tags: - Manufacturers security: - basic_auth: [] parameters: - name: page in: query required: false description: Page of results to return schema: type: integer - name: limit in: query required: false description: Number of manufacturers per page schema: type: integer responses: '200': description: successfully list manufacturers content: application/json: examples: list all manufacturers: value: manufacturers: - id: 1039554827 name: AB InBev logo_image_url: https://s3.us-east-2.amazonaws.com/bybe-cdn/manufacturers/abinbev.png meta: current_page: 1 total_pages: 1 per_page_limit: 5000 total_records: 1 count: 1 "/v1/manufacturers/{id}": parameters: - name: id in: path description: manufacturer_id required: true schema: type: string get: summary: show a manufacturer tags: - Manufacturers security: - basic_auth: [] responses: '200': description: successful content: application/json: examples: test_example: value: manufacturer: id: 1039554827 name: AB InBev logo_image_url: https://s3.us-east-2.amazonaws.com/bybe-cdn/manufacturers/abinbev.png "/v1/offers": get: summary: list offers tags: - Offers security: - basic_auth: [] parameters: - name: show_stores in: query required: false description: Defaults to true. When false, stores associated with offers are omitted from the response. schema: type: boolean - name: show_clips in: query required: false description: Requires consumer_retailer_identifier. When true, includes clip information for each offer indicating whether it has been clipped by the specified consumer. schema: type: boolean - name: show_details in: query required: false description: Defaults to false. When true, includes additional store details in the response. schema: type: boolean - name: prelive in: query required: false description: Defaults to false. When true, includes offers that are not yet live. Client applications should ensure pre-live offers are hidden from end users. schema: type: boolean - name: state in: query schema: "$ref": "#/components/schemas/state_string_enum" required: false description: By default offers from all states are returned. When a state is specified, only offers available in that state are returned. - name: consumer_retailer_identifier in: query required: false description: Adds consumer-specific information to the response, such as whether the offers have been clipped by the specified consumer as well as how many redemptions remain for each offer based on the consumer's previous redemptions. schema: type: string responses: '200': description: successfully list offers content: application/json: examples: unfiltered list of offers: value: offers: - id: 36642025 name: 1Super Saver Special image_url: thing.jpg clip_limit: 5 clips_remaining: 5 budget_limit_cents: 5000 budget_limit_currency: USD budget_remaining_cents: 4000 budget_remaining_currency: USD discount_cents: 500 discount_currency: USD conditions: Buy 2 get 1 back details: Offer details start_date: '2017-10-27' end_date: '2026-06-27' per_consumer_limit: 2 daily_per_consumer_limit: redemptions_available: 4 redemptions_remaining: 2 redemptions_used: 2 offer_type: discount created_at: '2026-06-17T13:55:38.857Z' updated_at: '2026-06-17T13:55:38.857Z' featured: false vibrant_colors: image_content_height: required_products: - quantity: 2 product: retailer_identifier: 123ABC name: 12 Pack of Beer upcs: - '767676767676' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Beer products: - retailer_identifier: 123ABC name: 12 Pack of Beer upcs: - '767676767676' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Beer - retailer_identifier: name: Jug of Vodka upcs: - '434363463463' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider - retailer_identifier: 123ABC name: Soft Apple Cider upcs: - '123123123123' - '989898989898' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider states: - abbreviation: OH name: Ohio - abbreviation: IL name: Illinois stores: - retailer_identifier: 0000Valid - retailer_identifier: CBUS - id: 373731297 name: Buy 2x and Y image_url: thing.jpg clip_limit: 5 clips_remaining: 5 budget_limit_cents: 5000 budget_limit_currency: USD budget_remaining_cents: 5000 budget_remaining_currency: USD discount_cents: 100 discount_currency: USD conditions: Buy 2x and y get z back details: Offer details start_date: '2017-10-27' end_date: '2026-06-27' per_consumer_limit: 2 daily_per_consumer_limit: redemptions_available: 4 redemptions_remaining: 4 redemptions_used: 0 offer_type: discount created_at: '2026-06-17T13:55:38.857Z' updated_at: '2026-06-17T13:55:38.857Z' featured: false vibrant_colors: image_content_height: required_products: - quantity: 2 product: retailer_identifier: 123ABC name: 12 Pack of Beer upcs: - '767676767676' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Beer products: - retailer_identifier: 123ABC name: 12 Pack of Beer upcs: - '767676767676' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Beer - quantity: 1 product: retailer_identifier: 123ABC name: Soft Apple Cider upcs: - '123123123123' - '989898989898' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider products: - retailer_identifier: 123ABC name: Soft Apple Cider upcs: - '123123123123' - '989898989898' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider states: - abbreviation: OH name: Ohio stores: - retailer_identifier: 0000Valid - retailer_identifier: CBUS - id: 567695903 name: Buy w and 2x image_url: thing.jpg clip_limit: 5 clips_remaining: 5 budget_limit_cents: 5000 budget_limit_currency: USD budget_remaining_cents: 5000 budget_remaining_currency: USD discount_cents: 300 discount_currency: USD conditions: Buy w and x get z back details: Offer details start_date: '2017-10-27' end_date: '2026-06-27' per_consumer_limit: 2 daily_per_consumer_limit: redemptions_available: 4 redemptions_remaining: 4 redemptions_used: 0 offer_type: discount created_at: '2026-06-17T13:55:38.857Z' updated_at: '2026-06-17T13:55:38.857Z' featured: false vibrant_colors: image_content_height: required_products: - quantity: 1 product: retailer_identifier: name: Jug of Vodka upcs: - '434363463463' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider products: - retailer_identifier: name: Jug of Vodka upcs: - '434363463463' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider - quantity: 2 product: retailer_identifier: 123ABC name: 12 Pack of Beer upcs: - '767676767676' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Beer products: - retailer_identifier: 123ABC name: 12 Pack of Beer upcs: - '767676767676' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Beer states: - abbreviation: OH name: Ohio stores: - retailer_identifier: 0000Valid - retailer_identifier: CBUS - id: 980190962 name: Holiday sale on spirits image_url: thing.jpg clip_limit: 5 clips_remaining: -3 budget_limit_cents: 2000 budget_limit_currency: USD budget_remaining_cents: 1700 budget_remaining_currency: USD discount_cents: 300 discount_currency: USD conditions: Offer open to residents of KY. Must be 21 years of age. details: Offer details start_date: '2017-10-27' end_date: '2026-07-17' per_consumer_limit: 1 daily_per_consumer_limit: redemptions_available: 10 redemptions_remaining: 9 redemptions_used: 1 offer_type: discount created_at: '2026-06-17T13:55:38.857Z' updated_at: '2026-06-17T13:55:38.857Z' featured: false vibrant_colors: image_content_height: required_products: - quantity: 1 product: retailer_identifier: 123ABC name: Hard Apple Cider upcs: - '123123123123' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider products: - retailer_identifier: 123ABC name: Hard Apple Cider upcs: - '123123123123' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider states: - abbreviation: OH name: Ohio - abbreviation: CA name: California stores: - retailer_identifier: LA - retailer_identifier: 0000Valid - retailer_identifier: CBUS - id: 298486374 name: Holiday sale on booze image_url: thing.jpg clip_limit: 5 clips_remaining: 5 budget_limit_cents: 2000 budget_limit_currency: USD budget_remaining_cents: 2000 budget_remaining_currency: USD discount_cents: 300 discount_currency: USD conditions: Offer open to residents of OH. Must be 21 years of age. details: Offer details start_date: '2017-10-27' end_date: '2026-07-17' per_consumer_limit: 1 daily_per_consumer_limit: redemptions_available: 10 redemptions_remaining: 10 redemptions_used: 0 offer_type: discount created_at: '2026-06-10T13:55:38.000Z' updated_at: '2026-06-10T13:55:38.000Z' featured: false vibrant_colors: image_content_height: required_products: - quantity: 1 product: retailer_identifier: 123ABC name: Hard Apple Cider upcs: - '123123123123' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider products: - retailer_identifier: 123ABC name: Hard Apple Cider upcs: - '123123123123' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider - quantity: 1 product: retailer_identifier: 123ABC name: Hard Apple Cider upcs: - '123123123123' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider products: - retailer_identifier: 123ABC name: Hard Apple Cider upcs: - '123123123123' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider - retailer_identifier: 123ABC name: Soft Apple Cider upcs: - '123123123123' - '989898989898' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider states: - abbreviation: OH name: Ohio stores: - retailer_identifier: 0000Valid - retailer_identifier: CBUS meta: count: 5 filter offers by state: value: offers: - id: 36642025 name: 1Super Saver Special image_url: thing.jpg clip_limit: 5 clips_remaining: 5 budget_limit_cents: 5000 budget_limit_currency: USD budget_remaining_cents: 4000 budget_remaining_currency: USD discount_cents: 500 discount_currency: USD conditions: Buy 2 get 1 back details: Offer details start_date: '2017-10-27' end_date: '2026-06-27' per_consumer_limit: 2 daily_per_consumer_limit: redemptions_available: 4 redemptions_remaining: 2 redemptions_used: 2 offer_type: discount created_at: '2026-06-17T13:55:38.857Z' updated_at: '2026-06-17T13:55:38.857Z' featured: false vibrant_colors: image_content_height: required_products: - quantity: 2 product: retailer_identifier: 123ABC name: 12 Pack of Beer upcs: - '767676767676' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Beer products: - retailer_identifier: 123ABC name: 12 Pack of Beer upcs: - '767676767676' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Beer - retailer_identifier: name: Jug of Vodka upcs: - '434363463463' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider - retailer_identifier: 123ABC name: Soft Apple Cider upcs: - '123123123123' - '989898989898' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider states: - abbreviation: OH name: Ohio - abbreviation: IL name: Illinois stores: - retailer_identifier: 0000Valid - retailer_identifier: CBUS - id: 373731297 name: Buy 2x and Y image_url: thing.jpg clip_limit: 5 clips_remaining: 5 budget_limit_cents: 5000 budget_limit_currency: USD budget_remaining_cents: 5000 budget_remaining_currency: USD discount_cents: 100 discount_currency: USD conditions: Buy 2x and y get z back details: Offer details start_date: '2017-10-27' end_date: '2026-06-27' per_consumer_limit: 2 daily_per_consumer_limit: redemptions_available: 4 redemptions_remaining: 4 redemptions_used: 0 offer_type: discount created_at: '2026-06-17T13:55:38.857Z' updated_at: '2026-06-17T13:55:38.857Z' featured: false vibrant_colors: image_content_height: required_products: - quantity: 2 product: retailer_identifier: 123ABC name: 12 Pack of Beer upcs: - '767676767676' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Beer products: - retailer_identifier: 123ABC name: 12 Pack of Beer upcs: - '767676767676' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Beer - quantity: 1 product: retailer_identifier: 123ABC name: Soft Apple Cider upcs: - '123123123123' - '989898989898' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider products: - retailer_identifier: 123ABC name: Soft Apple Cider upcs: - '123123123123' - '989898989898' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider states: - abbreviation: OH name: Ohio stores: - retailer_identifier: 0000Valid - retailer_identifier: CBUS - id: 567695903 name: Buy w and 2x image_url: thing.jpg clip_limit: 5 clips_remaining: 5 budget_limit_cents: 5000 budget_limit_currency: USD budget_remaining_cents: 5000 budget_remaining_currency: USD discount_cents: 300 discount_currency: USD conditions: Buy w and x get z back details: Offer details start_date: '2017-10-27' end_date: '2026-06-27' per_consumer_limit: 2 daily_per_consumer_limit: redemptions_available: 4 redemptions_remaining: 4 redemptions_used: 0 offer_type: discount created_at: '2026-06-17T13:55:38.857Z' updated_at: '2026-06-17T13:55:38.857Z' featured: false vibrant_colors: image_content_height: required_products: - quantity: 1 product: retailer_identifier: name: Jug of Vodka upcs: - '434363463463' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider products: - retailer_identifier: name: Jug of Vodka upcs: - '434363463463' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider - quantity: 2 product: retailer_identifier: 123ABC name: 12 Pack of Beer upcs: - '767676767676' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Beer products: - retailer_identifier: 123ABC name: 12 Pack of Beer upcs: - '767676767676' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Beer states: - abbreviation: OH name: Ohio stores: - retailer_identifier: 0000Valid - retailer_identifier: CBUS - id: 980190962 name: Holiday sale on spirits image_url: thing.jpg clip_limit: 5 clips_remaining: -3 budget_limit_cents: 2000 budget_limit_currency: USD budget_remaining_cents: 1700 budget_remaining_currency: USD discount_cents: 300 discount_currency: USD conditions: Offer open to residents of KY. Must be 21 years of age. details: Offer details start_date: '2017-10-27' end_date: '2026-07-17' per_consumer_limit: 1 daily_per_consumer_limit: redemptions_available: 10 redemptions_remaining: 9 redemptions_used: 1 offer_type: discount created_at: '2026-06-17T13:55:38.857Z' updated_at: '2026-06-17T13:55:38.857Z' featured: false vibrant_colors: image_content_height: required_products: - quantity: 1 product: retailer_identifier: 123ABC name: Hard Apple Cider upcs: - '123123123123' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider products: - retailer_identifier: 123ABC name: Hard Apple Cider upcs: - '123123123123' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider states: - abbreviation: OH name: Ohio - abbreviation: CA name: California stores: - retailer_identifier: 0000Valid - retailer_identifier: CBUS - id: 298486374 name: Holiday sale on booze image_url: thing.jpg clip_limit: 5 clips_remaining: 5 budget_limit_cents: 2000 budget_limit_currency: USD budget_remaining_cents: 2000 budget_remaining_currency: USD discount_cents: 300 discount_currency: USD conditions: Offer open to residents of OH. Must be 21 years of age. details: Offer details start_date: '2017-10-27' end_date: '2026-07-17' per_consumer_limit: 1 daily_per_consumer_limit: redemptions_available: 10 redemptions_remaining: 10 redemptions_used: 0 offer_type: discount created_at: '2026-06-10T13:55:38.000Z' updated_at: '2026-06-10T13:55:38.000Z' featured: false vibrant_colors: image_content_height: required_products: - quantity: 1 product: retailer_identifier: 123ABC name: Hard Apple Cider upcs: - '123123123123' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider products: - retailer_identifier: 123ABC name: Hard Apple Cider upcs: - '123123123123' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider - quantity: 1 product: retailer_identifier: 123ABC name: Hard Apple Cider upcs: - '123123123123' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider products: - retailer_identifier: 123ABC name: Hard Apple Cider upcs: - '123123123123' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider - retailer_identifier: 123ABC name: Soft Apple Cider upcs: - '123123123123' - '989898989898' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider states: - abbreviation: OH name: Ohio stores: - retailer_identifier: 0000Valid - retailer_identifier: CBUS meta: count: 5 filter offers for a specific consumer: value: offers: - id: 36642025 name: 1Super Saver Special image_url: thing.jpg discount_cents: 500 discount_currency: USD conditions: Buy 2 get 1 back details: Offer details start_date: '2017-10-27' end_date: '2026-06-27' per_consumer_limit: 2 daily_per_consumer_limit: redemptions: [] redemptions_remaining: 2 redemptions_used: 2 consumer_redemptions_remaining: 2 offer_type: discount created_at: '2026-06-17T13:55:38.857Z' updated_at: '2026-06-17T13:55:38.857Z' required_products: - quantity: 2 product: retailer_identifier: 123ABC name: 12 Pack of Beer upcs: - '767676767676' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Beer products: - retailer_identifier: 123ABC name: 12 Pack of Beer upcs: - '767676767676' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Beer - retailer_identifier: name: Jug of Vodka upcs: - '434363463463' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider - retailer_identifier: 123ABC name: Soft Apple Cider upcs: - '123123123123' - '989898989898' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider featured: false stores: - retailer_identifier: 0000Valid - retailer_identifier: CBUS states: - abbreviation: OH name: Ohio - abbreviation: IL name: Illinois - id: 373731297 name: Buy 2x and Y image_url: thing.jpg discount_cents: 100 discount_currency: USD conditions: Buy 2x and y get z back details: Offer details start_date: '2017-10-27' end_date: '2026-06-27' per_consumer_limit: 2 daily_per_consumer_limit: redemptions: [] redemptions_remaining: 4 redemptions_used: 0 consumer_redemptions_remaining: 2 offer_type: discount created_at: '2026-06-17T13:55:38.857Z' updated_at: '2026-06-17T13:55:38.857Z' required_products: - quantity: 2 product: retailer_identifier: 123ABC name: 12 Pack of Beer upcs: - '767676767676' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Beer products: - retailer_identifier: 123ABC name: 12 Pack of Beer upcs: - '767676767676' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Beer - quantity: 1 product: retailer_identifier: 123ABC name: Soft Apple Cider upcs: - '123123123123' - '989898989898' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider products: - retailer_identifier: 123ABC name: Soft Apple Cider upcs: - '123123123123' - '989898989898' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider featured: false stores: - retailer_identifier: 0000Valid - retailer_identifier: CBUS states: - abbreviation: OH name: Ohio - id: 567695903 name: Buy w and 2x image_url: thing.jpg discount_cents: 300 discount_currency: USD conditions: Buy w and x get z back details: Offer details start_date: '2017-10-27' end_date: '2026-06-27' per_consumer_limit: 2 daily_per_consumer_limit: redemptions: [] redemptions_remaining: 4 redemptions_used: 0 consumer_redemptions_remaining: 2 offer_type: discount created_at: '2026-06-17T13:55:38.857Z' updated_at: '2026-06-17T13:55:38.857Z' required_products: - quantity: 1 product: retailer_identifier: name: Jug of Vodka upcs: - '434363463463' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider products: - retailer_identifier: name: Jug of Vodka upcs: - '434363463463' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider - quantity: 2 product: retailer_identifier: 123ABC name: 12 Pack of Beer upcs: - '767676767676' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Beer products: - retailer_identifier: 123ABC name: 12 Pack of Beer upcs: - '767676767676' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Beer featured: false stores: - retailer_identifier: 0000Valid - retailer_identifier: CBUS states: - abbreviation: OH name: Ohio - id: 980190962 name: Holiday sale on spirits image_url: thing.jpg discount_cents: 300 discount_currency: USD conditions: Offer open to residents of KY. Must be 21 years of age. details: Offer details start_date: '2017-10-27' end_date: '2026-07-17' per_consumer_limit: 1 daily_per_consumer_limit: redemptions: - id: 980190962 status: accepted purchase_id: 980190962 offer_id: 980190962 created_at: '2026-06-17T13:55:38.895Z' updated_at: '2026-06-17T13:55:38.895Z' payout_group_id: consumer_balance_id: redemptions_remaining: 9 redemptions_used: 1 consumer_redemptions_remaining: 0 offer_type: discount created_at: '2026-06-17T13:55:38.857Z' updated_at: '2026-06-17T13:55:38.857Z' required_products: - quantity: 1 product: retailer_identifier: 123ABC name: Hard Apple Cider upcs: - '123123123123' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider products: - retailer_identifier: 123ABC name: Hard Apple Cider upcs: - '123123123123' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider featured: false stores: - retailer_identifier: LA - retailer_identifier: 0000Valid - retailer_identifier: CBUS states: - abbreviation: OH name: Ohio - abbreviation: CA name: California - id: 298486374 name: Holiday sale on booze image_url: thing.jpg discount_cents: 300 discount_currency: USD conditions: Offer open to residents of OH. Must be 21 years of age. details: Offer details start_date: '2017-10-27' end_date: '2026-07-17' per_consumer_limit: 1 daily_per_consumer_limit: redemptions: [] redemptions_remaining: 10 redemptions_used: 0 consumer_redemptions_remaining: 1 offer_type: discount created_at: '2026-06-10T13:55:38.000Z' updated_at: '2026-06-10T13:55:38.000Z' required_products: - quantity: 1 product: retailer_identifier: 123ABC name: Hard Apple Cider upcs: - '123123123123' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider products: - retailer_identifier: 123ABC name: Hard Apple Cider upcs: - '123123123123' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider - quantity: 1 product: retailer_identifier: 123ABC name: Hard Apple Cider upcs: - '123123123123' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider products: - retailer_identifier: 123ABC name: Hard Apple Cider upcs: - '123123123123' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider - retailer_identifier: 123ABC name: Soft Apple Cider upcs: - '123123123123' - '989898989898' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider featured: false stores: - retailer_identifier: 0000Valid - retailer_identifier: CBUS states: - abbreviation: OH name: Ohio meta: count: 5 shows prelive offers: value: offers: - id: 36642025 name: 1Super Saver Special image_url: thing.jpg clip_limit: 5 clips_remaining: 5 budget_limit_cents: 5000 budget_limit_currency: USD budget_remaining_cents: 4000 budget_remaining_currency: USD discount_cents: 500 discount_currency: USD conditions: Buy 2 get 1 back details: Offer details start_date: '2017-10-27' end_date: '2026-06-27' per_consumer_limit: 2 daily_per_consumer_limit: redemptions_available: 4 redemptions_remaining: 2 redemptions_used: 2 offer_type: discount created_at: '2026-06-17T13:55:38.857Z' updated_at: '2026-06-17T13:55:38.857Z' featured: false vibrant_colors: image_content_height: required_products: - quantity: 2 product: retailer_identifier: 123ABC name: 12 Pack of Beer upcs: - '767676767676' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Beer products: - retailer_identifier: 123ABC name: 12 Pack of Beer upcs: - '767676767676' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Beer - retailer_identifier: name: Jug of Vodka upcs: - '434363463463' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider - retailer_identifier: 123ABC name: Soft Apple Cider upcs: - '123123123123' - '989898989898' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider states: - abbreviation: OH name: Ohio - abbreviation: IL name: Illinois stores: - retailer_identifier: 0000Valid - retailer_identifier: CBUS - id: 373731297 name: Buy 2x and Y image_url: thing.jpg clip_limit: 5 clips_remaining: 5 budget_limit_cents: 5000 budget_limit_currency: USD budget_remaining_cents: 5000 budget_remaining_currency: USD discount_cents: 100 discount_currency: USD conditions: Buy 2x and y get z back details: Offer details start_date: '2017-10-27' end_date: '2026-06-27' per_consumer_limit: 2 daily_per_consumer_limit: redemptions_available: 4 redemptions_remaining: 4 redemptions_used: 0 offer_type: discount created_at: '2026-06-17T13:55:38.857Z' updated_at: '2026-06-17T13:55:38.857Z' featured: false vibrant_colors: image_content_height: required_products: - quantity: 2 product: retailer_identifier: 123ABC name: 12 Pack of Beer upcs: - '767676767676' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Beer products: - retailer_identifier: 123ABC name: 12 Pack of Beer upcs: - '767676767676' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Beer - quantity: 1 product: retailer_identifier: 123ABC name: Soft Apple Cider upcs: - '123123123123' - '989898989898' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider products: - retailer_identifier: 123ABC name: Soft Apple Cider upcs: - '123123123123' - '989898989898' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider states: - abbreviation: OH name: Ohio stores: - retailer_identifier: 0000Valid - retailer_identifier: CBUS - id: 567695903 name: Buy w and 2x image_url: thing.jpg clip_limit: 5 clips_remaining: 5 budget_limit_cents: 5000 budget_limit_currency: USD budget_remaining_cents: 5000 budget_remaining_currency: USD discount_cents: 300 discount_currency: USD conditions: Buy w and x get z back details: Offer details start_date: '2017-10-27' end_date: '2026-06-27' per_consumer_limit: 2 daily_per_consumer_limit: redemptions_available: 4 redemptions_remaining: 4 redemptions_used: 0 offer_type: discount created_at: '2026-06-17T13:55:38.857Z' updated_at: '2026-06-17T13:55:38.857Z' featured: false vibrant_colors: image_content_height: required_products: - quantity: 1 product: retailer_identifier: name: Jug of Vodka upcs: - '434363463463' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider products: - retailer_identifier: name: Jug of Vodka upcs: - '434363463463' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider - quantity: 2 product: retailer_identifier: 123ABC name: 12 Pack of Beer upcs: - '767676767676' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Beer products: - retailer_identifier: 123ABC name: 12 Pack of Beer upcs: - '767676767676' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Beer states: - abbreviation: OH name: Ohio stores: - retailer_identifier: 0000Valid - retailer_identifier: CBUS - id: 980190962 name: Holiday sale on spirits image_url: thing.jpg clip_limit: 5 clips_remaining: -3 budget_limit_cents: 2000 budget_limit_currency: USD budget_remaining_cents: 1700 budget_remaining_currency: USD discount_cents: 300 discount_currency: USD conditions: Offer open to residents of KY. Must be 21 years of age. details: Offer details start_date: '2017-10-27' end_date: '2026-07-17' per_consumer_limit: 1 daily_per_consumer_limit: redemptions_available: 10 redemptions_remaining: 9 redemptions_used: 1 offer_type: discount created_at: '2026-06-17T13:55:38.857Z' updated_at: '2026-06-17T13:55:38.857Z' featured: false vibrant_colors: image_content_height: required_products: - quantity: 1 product: retailer_identifier: 123ABC name: Hard Apple Cider upcs: - '123123123123' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider products: - retailer_identifier: 123ABC name: Hard Apple Cider upcs: - '123123123123' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider states: - abbreviation: OH name: Ohio - abbreviation: CA name: California stores: - retailer_identifier: LA - retailer_identifier: 0000Valid - retailer_identifier: CBUS - id: 298486374 name: Holiday sale on booze image_url: thing.jpg clip_limit: 5 clips_remaining: 5 budget_limit_cents: 2000 budget_limit_currency: USD budget_remaining_cents: 2000 budget_remaining_currency: USD discount_cents: 300 discount_currency: USD conditions: Offer open to residents of OH. Must be 21 years of age. details: Offer details start_date: '2017-10-27' end_date: '2026-07-17' per_consumer_limit: 1 daily_per_consumer_limit: redemptions_available: 10 redemptions_remaining: 10 redemptions_used: 0 offer_type: discount created_at: '2026-06-10T13:55:38.000Z' updated_at: '2026-06-10T13:55:38.000Z' featured: false vibrant_colors: image_content_height: required_products: - quantity: 1 product: retailer_identifier: 123ABC name: Hard Apple Cider upcs: - '123123123123' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider products: - retailer_identifier: 123ABC name: Hard Apple Cider upcs: - '123123123123' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider - quantity: 1 product: retailer_identifier: 123ABC name: Hard Apple Cider upcs: - '123123123123' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider products: - retailer_identifier: 123ABC name: Hard Apple Cider upcs: - '123123123123' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider - retailer_identifier: 123ABC name: Soft Apple Cider upcs: - '123123123123' - '989898989898' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider states: - abbreviation: OH name: Ohio stores: - retailer_identifier: 0000Valid - retailer_identifier: CBUS meta: count: 5 hides stores if show_stores is false: value: offers: - id: 36642025 name: 1Super Saver Special image_url: thing.jpg clip_limit: 5 clips_remaining: 5 budget_limit_cents: 5000 budget_limit_currency: USD budget_remaining_cents: 4000 budget_remaining_currency: USD discount_cents: 500 discount_currency: USD conditions: Buy 2 get 1 back details: Offer details start_date: '2017-10-27' end_date: '2026-06-27' per_consumer_limit: 2 daily_per_consumer_limit: redemptions_available: 4 redemptions_remaining: 2 redemptions_used: 2 offer_type: discount created_at: '2026-06-17T13:55:38.857Z' updated_at: '2026-06-17T13:55:38.857Z' featured: false vibrant_colors: image_content_height: required_products: - quantity: 2 product: retailer_identifier: 123ABC name: 12 Pack of Beer upcs: - '767676767676' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Beer products: - retailer_identifier: 123ABC name: 12 Pack of Beer upcs: - '767676767676' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Beer - retailer_identifier: name: Jug of Vodka upcs: - '434363463463' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider - retailer_identifier: 123ABC name: Soft Apple Cider upcs: - '123123123123' - '989898989898' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider states: - abbreviation: OH name: Ohio - abbreviation: IL name: Illinois - id: 373731297 name: Buy 2x and Y image_url: thing.jpg clip_limit: 5 clips_remaining: 5 budget_limit_cents: 5000 budget_limit_currency: USD budget_remaining_cents: 5000 budget_remaining_currency: USD discount_cents: 100 discount_currency: USD conditions: Buy 2x and y get z back details: Offer details start_date: '2017-10-27' end_date: '2026-06-27' per_consumer_limit: 2 daily_per_consumer_limit: redemptions_available: 4 redemptions_remaining: 4 redemptions_used: 0 offer_type: discount created_at: '2026-06-17T13:55:38.857Z' updated_at: '2026-06-17T13:55:38.857Z' featured: false vibrant_colors: image_content_height: required_products: - quantity: 2 product: retailer_identifier: 123ABC name: 12 Pack of Beer upcs: - '767676767676' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Beer products: - retailer_identifier: 123ABC name: 12 Pack of Beer upcs: - '767676767676' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Beer - quantity: 1 product: retailer_identifier: 123ABC name: Soft Apple Cider upcs: - '123123123123' - '989898989898' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider products: - retailer_identifier: 123ABC name: Soft Apple Cider upcs: - '123123123123' - '989898989898' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider states: - abbreviation: OH name: Ohio - id: 567695903 name: Buy w and 2x image_url: thing.jpg clip_limit: 5 clips_remaining: 5 budget_limit_cents: 5000 budget_limit_currency: USD budget_remaining_cents: 5000 budget_remaining_currency: USD discount_cents: 300 discount_currency: USD conditions: Buy w and x get z back details: Offer details start_date: '2017-10-27' end_date: '2026-06-27' per_consumer_limit: 2 daily_per_consumer_limit: redemptions_available: 4 redemptions_remaining: 4 redemptions_used: 0 offer_type: discount created_at: '2026-06-17T13:55:38.857Z' updated_at: '2026-06-17T13:55:38.857Z' featured: false vibrant_colors: image_content_height: required_products: - quantity: 1 product: retailer_identifier: name: Jug of Vodka upcs: - '434363463463' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider products: - retailer_identifier: name: Jug of Vodka upcs: - '434363463463' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider - quantity: 2 product: retailer_identifier: 123ABC name: 12 Pack of Beer upcs: - '767676767676' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Beer products: - retailer_identifier: 123ABC name: 12 Pack of Beer upcs: - '767676767676' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Beer states: - abbreviation: OH name: Ohio - id: 980190962 name: Holiday sale on spirits image_url: thing.jpg clip_limit: 5 clips_remaining: -3 budget_limit_cents: 2000 budget_limit_currency: USD budget_remaining_cents: 1700 budget_remaining_currency: USD discount_cents: 300 discount_currency: USD conditions: Offer open to residents of KY. Must be 21 years of age. details: Offer details start_date: '2017-10-27' end_date: '2026-07-17' per_consumer_limit: 1 daily_per_consumer_limit: redemptions_available: 10 redemptions_remaining: 9 redemptions_used: 1 offer_type: discount created_at: '2026-06-17T13:55:38.857Z' updated_at: '2026-06-17T13:55:38.857Z' featured: false vibrant_colors: image_content_height: required_products: - quantity: 1 product: retailer_identifier: 123ABC name: Hard Apple Cider upcs: - '123123123123' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider products: - retailer_identifier: 123ABC name: Hard Apple Cider upcs: - '123123123123' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider states: - abbreviation: OH name: Ohio - abbreviation: CA name: California - id: 298486374 name: Holiday sale on booze image_url: thing.jpg clip_limit: 5 clips_remaining: 5 budget_limit_cents: 2000 budget_limit_currency: USD budget_remaining_cents: 2000 budget_remaining_currency: USD discount_cents: 300 discount_currency: USD conditions: Offer open to residents of OH. Must be 21 years of age. details: Offer details start_date: '2017-10-27' end_date: '2026-07-17' per_consumer_limit: 1 daily_per_consumer_limit: redemptions_available: 10 redemptions_remaining: 10 redemptions_used: 0 offer_type: discount created_at: '2026-06-10T13:55:38.000Z' updated_at: '2026-06-10T13:55:38.000Z' featured: false vibrant_colors: image_content_height: required_products: - quantity: 1 product: retailer_identifier: 123ABC name: Hard Apple Cider upcs: - '123123123123' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider products: - retailer_identifier: 123ABC name: Hard Apple Cider upcs: - '123123123123' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider - quantity: 1 product: retailer_identifier: 123ABC name: Hard Apple Cider upcs: - '123123123123' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider products: - retailer_identifier: 123ABC name: Hard Apple Cider upcs: - '123123123123' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider - retailer_identifier: 123ABC name: Soft Apple Cider upcs: - '123123123123' - '989898989898' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png product_type: name: Cider states: - abbreviation: OH name: Ohio meta: count: 5 "/v1/offers/{id}": parameters: - name: id in: path description: offer_id required: true schema: type: string get: summary: get details for a single offer tags: - Offers security: - basic_auth: [] responses: '200': description: successful content: application/json: examples: test_example: value: offer: id: 980190962 name: Holiday sale on spirits image_url: thing.jpg clip_limit: 5 clips_remaining: -3 budget_limit_cents: 2000 budget_limit_currency: USD budget_remaining_cents: 1700 budget_remaining_currency: USD discount_cents: 300 discount_currency: USD conditions: Offer open to residents of KY. Must be 21 years of age. details: Offer details start_date: '2017-10-27' end_date: '2026-07-17' per_consumer_limit: 1 daily_per_consumer_limit: redemptions_available: 10 redemptions_remaining: 9 redemptions_used: 1 offer_type: discount created_at: '2026-06-17T13:55:38.857Z' updated_at: '2026-06-17T13:55:38.857Z' featured: false vibrant_colors: image_content_height: required_products: - quantity: 1 product: id: 980190962 name: Hard Apple Cider price_cents: 1200 price_currency: USD description: A delicious hard apple cider, brewed to perfection. origin_locale: California origin_country: USA upcs: - '123123123123' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png package_unit_quantity: 1 package_unit_volume: 12.0 package_unit_volume_unit: fl oz retailer_identifier: 123ABC manufacturer: id: 1039554827 name: AB InBev logo_image_url: https://s3.us-east-2.amazonaws.com/bybe-cdn/manufacturers/abinbev.png created_at: '2026-06-17T13:55:38.852Z' updated_at: '2026-06-17T13:55:38.852Z' product_type: id: 935439881 name: Cider created_at: '2026-06-17T13:55:38.895Z' updated_at: '2026-06-17T13:55:38.895Z' product_subtype: id: 924165175 name: Hard Cider created_at: '2026-06-17T13:55:38.851Z' updated_at: '2026-06-17T13:55:38.851Z' product_package_type: id: 591182547 name: Can created_at: '2026-06-17T13:55:38.931Z' updated_at: '2026-06-17T13:55:38.931Z' products: - id: 980190962 name: Hard Apple Cider price_cents: 1200 price_currency: USD description: A delicious hard apple cider, brewed to perfection. origin_locale: California origin_country: USA upcs: - '123123123123' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png package_unit_quantity: 1 package_unit_volume: 12.0 package_unit_volume_unit: fl oz retailer_identifier: 123ABC manufacturer: id: 1039554827 name: AB InBev logo_image_url: https://s3.us-east-2.amazonaws.com/bybe-cdn/manufacturers/abinbev.png created_at: '2026-06-17T13:55:38.852Z' updated_at: '2026-06-17T13:55:38.852Z' product_type: id: 935439881 name: Cider created_at: '2026-06-17T13:55:38.895Z' updated_at: '2026-06-17T13:55:38.895Z' product_subtype: id: 924165175 name: Hard Cider created_at: '2026-06-17T13:55:38.851Z' updated_at: '2026-06-17T13:55:38.851Z' product_package_type: id: 591182547 name: Can created_at: '2026-06-17T13:55:38.931Z' updated_at: '2026-06-17T13:55:38.931Z' states: - abbreviation: OH name: Ohio - abbreviation: CA name: California stores: - id: 298486374 name: LA Store retailer_identifier: LA address_line_1: 1 Capitol Square address_line_2: address_city: Los Angeles address_state: CA address_latitude: 39.961176 address_longitude: -82.998794 created_at: '2026-06-17T13:55:38.914Z' - id: 335794492 name: Always Valid Store retailer_identifier: 0000Valid address_line_1: 1 Capitol Square address_line_2: address_city: Columbus address_state: OH address_latitude: 39.961176 address_longitude: -82.998794 created_at: '2026-06-17T13:55:38.914Z' - id: 980190962 name: Columbus Store retailer_identifier: CBUS address_line_1: 1 Capitol Square address_line_2: Suite 100 address_city: Columbus address_state: OH address_latitude: 39.961176 address_longitude: -82.998794 created_at: '2026-06-17T13:55:38.914Z' "/v1/products": get: summary: list products tags: - Products security: - basic_auth: [] parameters: - name: page in: query required: false description: Page of results to return schema: type: integer - name: limit in: query required: false description: Number of products per page schema: type: integer - name: product_type_id in: query required: false schema: type: integer - name: product_subtype_id in: query required: false schema: type: integer - name: product_package_type_id in: query required: false schema: type: integer - name: manufacturer_id in: query required: false schema: type: integer responses: '200': description: successfully list products content: application/json: examples: list all products: value: products: - id: 281110143 name: 12 Pack of Beer price_cents: 1200 price_currency: USD description: 12 cans of beer origin_locale: California origin_country: USA upcs: - '767676767676' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png package_unit_quantity: 1 package_unit_volume: 12.0 package_unit_volume_unit: fl oz retailer_identifier: 123ABC manufacturer: id: 1039554827 name: AB InBev logo_image_url: https://s3.us-east-2.amazonaws.com/bybe-cdn/manufacturers/abinbev.png product_type: id: 418801326 name: Beer product_subtype: id: 698662446 name: Light Beer product_package_type: id: 591182547 name: Can - id: 980190962 name: Hard Apple Cider price_cents: 1200 price_currency: USD description: A delicious hard apple cider, brewed to perfection. origin_locale: California origin_country: USA upcs: - '123123123123' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png package_unit_quantity: 1 package_unit_volume: 12.0 package_unit_volume_unit: fl oz retailer_identifier: 123ABC manufacturer: id: 1039554827 name: AB InBev logo_image_url: https://s3.us-east-2.amazonaws.com/bybe-cdn/manufacturers/abinbev.png product_type: id: 935439881 name: Cider product_subtype: id: 924165175 name: Hard Cider product_package_type: id: 591182547 name: Can - id: 298486374 name: Soft Apple Cider price_cents: 1200 price_currency: USD description: A delicious hard apple cider, brewed to perfection. origin_locale: California origin_country: USA upcs: - '123123123123' - '989898989898' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png package_unit_quantity: 1 package_unit_volume: 12.0 package_unit_volume_unit: fl oz retailer_identifier: 123ABC manufacturer: id: 1039554827 name: AB InBev logo_image_url: https://s3.us-east-2.amazonaws.com/bybe-cdn/manufacturers/abinbev.png product_type: id: 935439881 name: Cider product_subtype: id: 924165175 name: Hard Cider product_package_type: id: 591182547 name: Can meta: current_page: 1 total_pages: 1 per_page_limit: 5000 total_records: 3 count: 3 filter products by type: value: products: - id: 281110143 name: 12 Pack of Beer price_cents: 1200 price_currency: USD description: 12 cans of beer origin_locale: California origin_country: USA upcs: - '767676767676' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png package_unit_quantity: 1 package_unit_volume: 12.0 package_unit_volume_unit: fl oz retailer_identifier: 123ABC manufacturer: id: 1039554827 name: AB InBev logo_image_url: https://s3.us-east-2.amazonaws.com/bybe-cdn/manufacturers/abinbev.png product_type: id: 418801326 name: Beer product_subtype: id: 698662446 name: Light Beer product_package_type: id: 591182547 name: Can meta: current_page: 1 total_pages: 1 per_page_limit: 5000 total_records: 1 count: 1 "/v1/products/{id}": parameters: - name: id in: path description: product_id required: true schema: type: string get: summary: show a single product tags: - Products security: - basic_auth: [] responses: '200': description: successful content: application/json: examples: test_example: value: product: id: 980190962 name: Hard Apple Cider price_cents: 1200 price_currency: USD description: A delicious hard apple cider, brewed to perfection. origin_locale: California origin_country: USA upcs: - '123123123123' image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png package_unit_quantity: 1 package_unit_volume: 12.0 package_unit_volume_unit: fl oz retailer_identifier: 123ABC manufacturer: id: 1039554827 name: AB InBev logo_image_url: https://s3.us-east-2.amazonaws.com/bybe-cdn/manufacturers/abinbev.png product_type: id: 935439881 name: Cider product_subtype: id: 924165175 name: Hard Cider product_package_type: id: 591182547 name: Can "/v1/redemption_disbursements": get: summary: list redemption disbursements tags: - Redemptions security: - basic_auth: [] description: This endpoint retrieves all redemption disbursements with the ability to filter by retailer consumer ID. parameters: - name: page in: query required: false description: Page of results to return schema: type: integer - name: limit in: query required: false description: Number of redemption disbursements per page schema: type: integer - name: consumer_retailer_identifier in: query required: false description: Filter by a retailer consumer ID. schema: type: string responses: '200': description: successfully list redemption disbursements content: application/json: examples: unfiltered list of redemption disbursements: value: redemption_disbursements: - id: 980190962 status: pending retailer_identifier: RETAILERREDEMPTIONID payment_method: closed_loop_card amount_cents: 300 amount_currency: USD email: email@example.com card_redemption_url: card_expiration: created_at: '2026-06-17T13:55:38.925Z' updated_at: '2026-06-17T13:55:38.925Z' consumer: id: 980190962 retailer_identifier: RETAILERCONSUMERID created_at: '2026-06-17T13:55:38.873Z' redemptions: - id: 980190962 status: accepted offer: id: 980190962 name: Holiday sale on spirits image_url: thing.jpg discount_cents: 300 payment_method: closed_loop_card redemptions_remaining: 0 meta: current_page: 1 total_pages: 1 per_page_limit: 5000 total_records: 1 count: 1 post: summary: create a redemption disbursement tags: - Redemptions description: This endpoint allows the creation of a new redemption disbursement for a consumer. BYBE will run the purchase data through its rules engine to determine whether the offers applied to the purchase line items are valid. Redemptions will be created for each valid offer and line item combination, and BYBE will disburse money totaling the value of only the valid redemptions. security: - basic_auth: [] parameters: - name: ignore_unknown_upcs in: query required: false description: Whether to ignore unknown UPCs during redemption processing. Default is false. schema: type: boolean responses: '201': description: Created a redemption disbursement, check the response for the status of each redemption created in this disbursement. content: application/json: examples: '201: Accepted: Creates a single redemption disbursement successfully': value: redemption_disbursement: id: 980190963 status: pending retailer_identifier: my_consumers_redeption_disbursement_1 payment_method: payout_flow amount_cents: 300 amount_currency: USD email: example_consumer@example.bybe.com redemptions: - id: 980190963 status: accepted payment_method: payout_flow redemptions_remaining: 0 per_consumer_limit_reached: true daily_redemptions_remaining: daily_limit_reached: false purchase: id: 980190963 retailer_identifier: my_purchase_identifier offer: id: 980190962 warnings: {} '201: Rejected: Rejects redemption when household limit is reached': value: redemption_disbursement: id: 980190965 status: failed_no_redemptions retailer_identifier: 27a54a63-70d8-4f74-8d72-eeaef672fbfe payment_method: payout_flow amount_cents: 0 amount_currency: USD email: example_consumer@example.bybe.com redemptions: - id: 980190965 status: rejected_household_limit payment_method: payout_flow redemptions_remaining: 0 per_consumer_limit_reached: true daily_redemptions_remaining: daily_limit_reached: false purchase: id: 980190965 retailer_identifier: BOUGHTTWOOFTWO offer: id: 36642025 warnings: {} '201: Accepted: Uses default payout_flow when payment method is missing': value: redemption_disbursement: id: 980190967 status: pending retailer_identifier: my_consumers_redemption_disbursement_3 payment_method: payout_flow amount_cents: 500 amount_currency: USD email: example_consumer@example.bybe.com redemptions: - id: 980190969 status: rejected_product_not_purchased payment_method: payout_flow redemptions_remaining: 1 per_consumer_limit_reached: false daily_redemptions_remaining: daily_limit_reached: false purchase: id: 980190967 retailer_identifier: my_purchase_identifier offer: id: 36642025 - id: 980190968 status: accepted payment_method: payout_flow redemptions_remaining: 1 per_consumer_limit_reached: false daily_redemptions_remaining: daily_limit_reached: false purchase: id: 980190967 retailer_identifier: my_purchase_identifier offer: id: 36642025 warnings: {} '201: Accepted: Forces payout_flow when override flag is set': value: redemption_disbursement: id: 980190969 status: pending retailer_identifier: my_consumers_redeption_disbursement_3 payment_method: payout_flow amount_cents: 500 amount_currency: USD email: example_consumer@example.bybe.com redemptions: - id: 980190973 status: rejected_product_not_purchased payment_method: payout_flow redemptions_remaining: 1 per_consumer_limit_reached: false daily_redemptions_remaining: daily_limit_reached: false purchase: id: 980190969 retailer_identifier: my_purchase_identifier offer: id: 36642025 - id: 980190972 status: accepted payment_method: payout_flow redemptions_remaining: 1 per_consumer_limit_reached: false daily_redemptions_remaining: daily_limit_reached: false purchase: id: 980190969 retailer_identifier: my_purchase_identifier offer: id: 36642025 warnings: {} '201: Accepted: Accepts two redemptions in a single request with separate line items': value: redemption_disbursement: id: 980190971 status: pending retailer_identifier: my_consumers_redeption_disbursement_3 payment_method: payout_flow amount_cents: 1000 amount_currency: USD email: example_consumer@example.bybe.com redemptions: - id: 980190976 status: accepted payment_method: payout_flow redemptions_remaining: 0 per_consumer_limit_reached: true daily_redemptions_remaining: daily_limit_reached: false purchase: id: 980190971 retailer_identifier: my_purchase_identifier offer: id: 36642025 - id: 980190977 status: accepted payment_method: payout_flow redemptions_remaining: 0 per_consumer_limit_reached: true daily_redemptions_remaining: daily_limit_reached: false purchase: id: 980190971 retailer_identifier: my_purchase_identifier offer: id: 36642025 warnings: {} '201: Accepted: Allows one redemption for a daily-limit offer': value: redemption_disbursement: id: 980190977 status: pending retailer_identifier: daily_limit_one_purchase payment_method: payout_flow amount_cents: 100 amount_currency: USD email: daily_limit@example.bybe.com redemptions: - id: 980190987 status: accepted payment_method: payout_flow redemptions_remaining: 3 per_consumer_limit_reached: false daily_redemptions_remaining: 0 daily_limit_reached: true purchase: id: 980190977 retailer_identifier: purchase_one offer: id: 545172206 warnings: {} '201: Accepted: Allows one redemption per day for daily-limit offer': value: redemption_disbursement: id: 980190979 status: pending retailer_identifier: daily_limit_disbursement payment_method: payout_flow amount_cents: 200 amount_currency: USD email: daily_limit@example.bybe.com redemptions: - id: 980190990 status: accepted payment_method: payout_flow redemptions_remaining: 2 per_consumer_limit_reached: false daily_redemptions_remaining: 0 daily_limit_reached: true purchase: id: 980190980 retailer_identifier: purchase_day1 offer: id: 545172206 - id: 980190991 status: accepted payment_method: payout_flow redemptions_remaining: 2 per_consumer_limit_reached: false daily_redemptions_remaining: 0 daily_limit_reached: true purchase: id: 980190981 retailer_identifier: purchase_day2 offer: id: 545172206 warnings: {} '201: Accepted: Defaults daily-limit calculation to current day when purchase date is missing': value: redemption_disbursement: id: 980190981 status: pending retailer_identifier: daily_limit_one_purchase payment_method: payout_flow amount_cents: 100 amount_currency: USD email: daily_limit@example.bybe.com redemptions: - id: 980190993 status: accepted payment_method: payout_flow redemptions_remaining: 3 per_consumer_limit_reached: false daily_redemptions_remaining: 0 daily_limit_reached: true purchase: id: 980190983 retailer_identifier: purchase_one offer: id: 545172206 warnings: {} '201: Accepted: Ignores unknown UPCs when configured to do so': value: redemption_disbursement: id: 980190991 status: pending retailer_identifier: my_consumers_redeption_disbursement_3 payment_method: payout_flow amount_cents: 500 amount_currency: USD email: example_consumer@example.bybe.com redemptions: - id: 980191007 status: accepted payment_method: payout_flow redemptions_remaining: 1 per_consumer_limit_reached: false daily_redemptions_remaining: daily_limit_reached: false purchase: id: 980190997 retailer_identifier: my_purchase_identifier offer: id: 36642025 warnings: unknown_upcs: - Unknown upcs 235252362363262, 34634634122352 '422': description: unprocessable entity content: application/json: examples: '422: Error: Returns a 422 for unknown UPCs when ignore_unknown_upcs is not passed or false': value: redemption_disbursement: errors: unknown_upcs: - Unknown upcs 929352935829352935 '422: Error: Always returns a 422 for unknown retailer identifiers': value: redemption_disbursement: errors: unknown_retailer_identifiers: - Unknown retailer identifiers 929352935829352935 '422: Error: Returns a error for both invalid purchase date format and unknown UPCs': value: redemption_disbursement: errors: purchase_date: - 'Purchase date Invalid purchase date format: not-a-date' unknown_upcs: - Unknown upcs 76767675457467676 '422: Error: Returns error if purchase_date is incorrectly formatted': value: redemption_disbursement: errors: purchase_date: - 'Purchase date Invalid purchase date format: not-a-date' '422: Error: Returns error if payment method is not valid': value: redemption_disbursement: errors: payment_method: - must exist - can't be blank - must be present purchases.store: - must exist - can't be blank requestBody: content: application/json: schema: type: object required: - redemption_disbursement properties: redemption_disbursement: type: object required: - retailer_identifier - consumer - purchases properties: payment_method: type: string description: The method by which the consumer wishes to receive their disbursement. The recommended value is 'payout_flow' (this is also the default when not provided), which allows the consumer to accrue a balance and choose their preferred payment method. Supported values may vary by retailer. Please contact your BYBE representative to confirm which values are enabled for your retailer. retailer_identifier: type: string description: Unique retailer ID for the redemption disbursement. email: type: string description: The email address to send the disbursement email to. If the consumer's email was already provided during consumer creation using the Consumers or Clips API, then it is not required to be sent again in this request. consumer: type: object required: - retailer_identifier properties: retailer_identifier: type: string purchases: type: array description: A list of Purchase objects from which redemptions will be generated for inclusion in this redemption disbursement. items: type: object properties: retailer_identifier: description: Unique retailer ID for the purchase. Typically this would be your internal purchase ID or transaction ID. type: string purchase_date: type: string description: The date of the purchase in ISO 8601 format, preferably in the timezone of the store (e.g., "2023-10-01T08:00:00-04:00"). This is optional and defaults to the current time if not provided. store: type: object description: Store information where the purchase was made. This must match to a store sent to BYBE previously and will be used for validating redemptions. properties: retailer_identifier: type: string redemptions: type: array description: A list of offers to attempt to redeem against this purchase. If wanting to redeem multiple times for the same offer most include multiple entries for the same offer ID. items: type: object properties: offer_id: type: integer line_items: type: array items: type: object properties: product: type: object description: Product information used for validating redemptions. One of `upc` or `retailer_identifier` is required. `upc` is the preferred identifier. If using `retailer_identifier`, you must provide your custom product codes (e.g., SKUs) to BYBE in advance. properties: upc: type: string description: Universal Product Code. Preferred identifier for products. retailer_identifier: type: string description: Custom product code (e.g., SKU). Must be pre-registered with BYBE. quantity: type: integer price_cents: type: integer examples: '201: Accepted: Creates a single redemption disbursement successfully': summary: '201: Accepted: Creates a single redemption disbursement successfully' value: redemption_disbursement: payment_method: payout_flow retailer_identifier: my_consumers_redeption_disbursement_1 email: example_consumer@example.bybe.com consumer: retailer_identifier: ANOTHER_RETAILER_CONSUMER purchases: - retailer_identifier: my_purchase_identifier store: retailer_identifier: CBUS redemptions: - offer_id: 980190962 line_items: - product: retailer_identifier: 123ABC quantity: 1 price_cents: 999 '201: Rejected: Rejects redemption when household limit is reached': summary: '201: Rejected: Rejects redemption when household limit is reached' value: redemption_disbursement: payment_method: payout_flow retailer_identifier: 27a54a63-70d8-4f74-8d72-eeaef672fbfe email: example_consumer@example.bybe.com consumer: retailer_identifier: ANOTHER_RETAILER_CONSUMER_TWO purchases: - retailer_identifier: BOUGHTTWOOFTWO store: retailer_identifier: CHI redemptions: - offer_id: 36642025 line_items: - product: retailer_identifier: 456DEF quantity: 1 price_cents: 999 '201: Accepted: Uses default payout_flow when payment method is missing': summary: '201: Accepted: Uses default payout_flow when payment method is missing' value: redemption_disbursement: payment_method: payout_flow retailer_identifier: my_consumers_redemption_disbursement_3 email: example_consumer@example.bybe.com consumer: retailer_identifier: ANOTHER_RETAILER_CONSUMER purchases: - retailer_identifier: my_purchase_identifier store: retailer_identifier: 0000Valid redemptions: - offer_id: 36642025 - offer_id: 36642025 line_items: - product: upc: '767676767676' quantity: 1 price_cents: 999 - product: upc: '767676767676' quantity: 1 price_cents: 999 '201: Accepted: Forces payout_flow when override flag is set': summary: '201: Accepted: Forces payout_flow when override flag is set' value: redemption_disbursement: payment_method: payout_flow retailer_identifier: my_consumers_redeption_disbursement_3 email: example_consumer@example.bybe.com consumer: retailer_identifier: ANOTHER_RETAILER_CONSUMER purchases: - retailer_identifier: my_purchase_identifier store: retailer_identifier: 0000Valid redemptions: - offer_id: 36642025 - offer_id: 36642025 line_items: - product: upc: '767676767676' quantity: 1 price_cents: 999 - product: upc: '767676767676' quantity: 1 price_cents: 999 '201: Accepted: Accepts two redemptions in a single request with separate line items': summary: '201: Accepted: Accepts two redemptions in a single request with separate line items' value: redemption_disbursement: payment_method: payout_flow retailer_identifier: my_consumers_redeption_disbursement_3 email: example_consumer@example.bybe.com consumer: retailer_identifier: ANOTHER_RETAILER_CONSUMER purchases: - retailer_identifier: my_purchase_identifier store: retailer_identifier: 0000Valid redemptions: - offer_id: 36642025 - offer_id: 36642025 line_items: - product: upc: '767676767676' quantity: 1 price_cents: 999 - product: upc: '989898989898' quantity: 3 price_cents: 999 '201: Accepted: Allows one redemption for a daily-limit offer': summary: '201: Accepted: Allows one redemption for a daily-limit offer' value: redemption_disbursement: payment_method: payout_flow retailer_identifier: daily_limit_one_purchase email: daily_limit@example.bybe.com consumer: retailer_identifier: ANOTHER_RETAILER_CONSUMER purchases: - retailer_identifier: purchase_one purchase_date: '2023-10-01T12:00:00-04:00' store: retailer_identifier: 0000Valid redemptions: - offer_id: 545172206 line_items: - product: upc: '767676767676' quantity: 1 '201: Accepted: Allows one redemption per day for daily-limit offer': summary: '201: Accepted: Allows one redemption per day for daily-limit offer' value: redemption_disbursement: payment_method: payout_flow retailer_identifier: daily_limit_disbursement email: daily_limit@example.bybe.com consumer: retailer_identifier: ANOTHER_RETAILER_CONSUMER purchases: - retailer_identifier: purchase_day1 purchase_date: '2023-10-01T10:00:00-04:00' store: retailer_identifier: 0000Valid redemptions: - offer_id: 545172206 line_items: - product: upc: '767676767676' quantity: 1 - retailer_identifier: purchase_day2 purchase_date: '2023-10-02T10:00:00-04:00' store: retailer_identifier: 0000Valid redemptions: - offer_id: 545172206 line_items: - product: upc: '767676767676' quantity: 1 '201: Accepted: Defaults daily-limit calculation to current day when purchase date is missing': summary: '201: Accepted: Defaults daily-limit calculation to current day when purchase date is missing' value: redemption_disbursement: payment_method: payout_flow retailer_identifier: daily_limit_one_purchase email: daily_limit@example.bybe.com consumer: retailer_identifier: ANOTHER_RETAILER_CONSUMER purchases: - retailer_identifier: purchase_one store: retailer_identifier: 0000Valid redemptions: - offer_id: 545172206 line_items: - product: upc: '767676767676' quantity: 1 '201: Accepted: Ignores unknown UPCs when configured to do so': summary: '201: Accepted: Ignores unknown UPCs when configured to do so' value: redemption_disbursement: payment_method: payout_flow retailer_identifier: my_consumers_redeption_disbursement_3 email: example_consumer@example.bybe.com consumer: retailer_identifier: ANOTHER_RETAILER_CONSUMER purchases: - retailer_identifier: my_purchase_identifier store: retailer_identifier: 0000Valid redemptions: - offer_id: 36642025 line_items: - product: upc: '767676767676' quantity: 3 price_cents: 999 - product: upc: '235252362363262' quantity: 3 price_cents: 999 - product: upc: '34634634122352' quantity: 3 price_cents: 999 '422: Error: Returns a 422 for unknown UPCs when ignore_unknown_upcs is not passed or false': summary: '422: Error: Returns a 422 for unknown UPCs when ignore_unknown_upcs is not passed or false' value: redemption_disbursement: payment_method: payout_flow retailer_identifier: 0f73ef1b-4ed0-4cc2-afe4-b51eadf9c79e email: example_consumer@example.bybe.com consumer: retailer_identifier: ANOTHER_RETAILER_CONSUMER_TWO purchases: - retailer_identifier: BOUGHTTWOOFTWO store: retailer_identifier: CHI redemptions: - offer_id: 36642025 line_items: - product: upc: '929352935829352935' quantity: 1 price_cents: 999 '422: Error: Always returns a 422 for unknown retailer identifiers': summary: '422: Error: Always returns a 422 for unknown retailer identifiers' value: redemption_disbursement: payment_method: payout_flow retailer_identifier: 9792fdc8-c7e4-4fd0-a3d8-be1800f55c7f email: example_consumer@example.bybe.com consumer: retailer_identifier: ANOTHER_RETAILER_CONSUMER_TWO purchases: - retailer_identifier: BOUGHTTWOOFTWO store: retailer_identifier: CHI redemptions: - offer_id: 36642025 line_items: - product: retailer_identifier: '929352935829352935' quantity: 1 price_cents: 999 '422: Error: Returns a error for both invalid purchase date format and unknown UPCs': summary: '422: Error: Returns a error for both invalid purchase date format and unknown UPCs' value: redemption_disbursement: payment_method: payout_flow retailer_identifier: bad_date_disbursement email: bad_date@example.bybe.com consumer: retailer_identifier: ANOTHER_RETAILER_CONSUMER purchases: - retailer_identifier: bad_date_purchase purchase_date: not-a-date store: retailer_identifier: 0000Valid redemptions: - offer_id: 36642025 line_items: - product: upc: '76767675457467676' quantity: 1 '422: Error: Returns error if purchase_date is incorrectly formatted': summary: '422: Error: Returns error if purchase_date is incorrectly formatted' value: redemption_disbursement: payment_method: payout_flow retailer_identifier: bad_date_disbursement email: bad_date@example.bybe.com consumer: retailer_identifier: ANOTHER_RETAILER_CONSUMER purchases: - retailer_identifier: bad_date_purchase purchase_date: not-a-date store: retailer_identifier: 0000Valid redemptions: - offer_id: 36642025 line_items: - product: upc: '767676767676' quantity: 1 '422: Error: Returns error if payment method is not valid': summary: '422: Error: Returns error if payment method is not valid' value: redemption_disbursement: payment_method: invalid_payment_method retailer_identifier: bad_payment_method_disbursement email: bad_payment_method@example.bybe.com consumer: retailer_identifier: ANOTHER_RETAILER_CONSUMER purchases: - retailer_identifier: bad_payment_method_purchase store: retailer_identifier: 0000Valid redemptions: - offer_id: 36642025 line_items: - product: upc: '767676767676' quantity: 1 required: true "/v1/redemption_disbursements/{id}": parameters: - name: id in: path description: redemption_disbursement_id required: true schema: type: string get: summary: show a redemption disbursement tags: - Redemptions security: - basic_auth: [] description: This endpoint retrieves a specific redemption disbursement. responses: '200': description: successful content: application/json: examples: test_example: value: redemption_disbursement: id: 980190962 status: pending retailer_identifier: RETAILERREDEMPTIONID payment_method: closed_loop_card amount_cents: 300 amount_currency: USD email: email@example.com card_redemption_url: card_expiration: created_at: '2026-06-17T13:55:38.925Z' updated_at: '2026-06-17T13:55:38.925Z' consumer: id: 980190962 retailer_identifier: RETAILERCONSUMERID created_at: '2026-06-17T13:55:38.873Z' redemptions: - id: 980190962 status: accepted offer: id: 980190962 name: Holiday sale on spirits image_url: thing.jpg discount_cents: 300 payment_method: closed_loop_card redemptions_remaining: 0 "/v1/stores": get: summary: list stores tags: - Stores security: - basic_auth: [] parameters: - name: state in: query schema: "$ref": "#/components/schemas/state_string_enum" required: false description: Filter stores by state (two letter abbreviation) responses: '200': description: successfully list stores content: application/json: examples: list all stores: value: stores: - id: 980190962 name: Columbus Store retailer_identifier: CBUS address_line_1: 1 Capitol Square address_line_2: Suite 100 address_city: Columbus address_state: OH address_latitude: 39.961176 address_longitude: -82.998794 created_at: '2026-06-17T13:55:38.914Z' - id: 298486374 name: LA Store retailer_identifier: LA address_line_1: 1 Capitol Square address_line_2: address_city: Los Angeles address_state: CA address_latitude: 39.961176 address_longitude: -82.998794 created_at: '2026-06-17T13:55:38.914Z' - id: 335794492 name: Always Valid Store retailer_identifier: 0000Valid address_line_1: 1 Capitol Square address_line_2: address_city: Columbus address_state: OH address_latitude: 39.961176 address_longitude: -82.998794 created_at: '2026-06-17T13:55:38.914Z' meta: current_page: 1 total_pages: 1 per_page_limit: 5000 total_records: 3 count: 3 filter stores by state: value: stores: - id: 980190962 name: Columbus Store retailer_identifier: CBUS address_line_1: 1 Capitol Square address_line_2: Suite 100 address_city: Columbus address_state: OH address_latitude: 39.961176 address_longitude: -82.998794 created_at: '2026-06-17T13:55:38.914Z' - id: 335794492 name: Always Valid Store retailer_identifier: 0000Valid address_line_1: 1 Capitol Square address_line_2: address_city: Columbus address_state: OH address_latitude: 39.961176 address_longitude: -82.998794 created_at: '2026-06-17T13:55:38.914Z' meta: current_page: 1 total_pages: 1 per_page_limit: 5000 total_records: 2 count: 2 "/v1/stores/{id}": parameters: - name: id in: path description: store_id required: true schema: type: string get: summary: show store details tags: - Stores security: - basic_auth: [] parameters: - name: page in: query required: false description: Page of results to return schema: type: integer - name: limit in: query required: false description: Number of stores per page schema: type: integer responses: '200': description: successful content: application/json: examples: test_example: value: store: id: 980190962 name: Columbus Store retailer_identifier: CBUS address_line_1: 1 Capitol Square address_line_2: Suite 100 address_city: Columbus address_state: OH address_latitude: 39.961176 address_longitude: -82.998794 created_at: '2026-06-17T13:55:38.914Z' tags: - name: Offers description: An offer is created and funded by a manufacturer (brand). - name: Clips description: A clip represents a consumer's intent to redeem an offer. - name: Redemptions description: Redemptions are created to disburse money to a consumer for their specific purchases. - name: Manufacturers description: A manufacturer represents a company or organization that produces alcoholic beverages. - name: Consumers description: A consumer purchases products and clips/redeems offers. - name: Stores description: A store represents a specific retail location of a retailer. - name: Products description: A product is produced by a manufacturer and is featured in offers. components: securitySchemes: basic_auth: type: http scheme: basic description: "\n Use your API key (token) and your API secret for username and password respectively.\n\n You can get these credentials, or generate new ones, on your developer page.\n\n You should encode your `Authorization:` header value in base64 as `api_key:api_secret`.\n (This will be shown as a curl request for you if you use the 'try it out' feature on this page while authorized.)\n " schemas: state_string_enum: type: string enum: - AL - AK - AS - AZ - AR - CA - CO - CT - DE - DC - FM - FL - GA - GU - HI - ID - IL - IN - IA - KS - KY - LA - ME - MH - MD - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - MP - OH - OK - OR - PW - PA - PR - RI - SC - SD - TN - TX - UT - VT - VI - VA - WA - WV - WI - WY