# BYBE

> BYBE, Inc. is a promotion platform for the beer, wine and spirits industry. It lets alcohol brands
> fund cash-back rebates and lets retailers embed those rebates in their own apps, sites and loyalty
> programs, with US state-by-state alcohol compliance handled by BYBE. The BYBE API v1 is a
> REST/JSON API over manufacturers, products, offers, clips, consumers, stores and redemption
> disbursements. BYBE was acquired by Swiftly in March 2024 and continues to operate under its own
> brand and domains.

Generated by API Evangelist on 2026-08-13. BYBE does not publish an llms.txt of its own
(https://bybe.com/llms.txt returns the site's single-page-app shell, not a document). This file is
assembled from BYBE's published OpenAPI and public pages.

## API

- [BYBE API v1 OpenAPI 3.0.1](https://api.bybe.io/v1/swagger.yaml): the published specification. 14 paths, 16 operations, 7 tags (Clips, Consumers, Manufacturers, Offers, Products, Redemptions, Stores). No servers[] block and no operationIds.
- [BYBE API reference (Swagger UI)](https://docs.bybe.io/): redirects to https://api.bybe.io/docs/index.html, with Try-it-out against production.
- [BYBE API v2-alpha1](https://api.bybe.io/v2/swagger.yaml): published but declares zero paths — "version 2 is under development, format stability is NOT yet guaranteed".
- Base URL: `https://api.bybe.io` — paths carry the `/v1` prefix. Staging: `https://api.bybestaging.io`.
- Auth: HTTP Basic, username = API key, password = API secret, issued at https://developer.bybe.io/.

## Operations

Manufacturers and products
- `GET /v1/manufacturers`, `GET /v1/manufacturers/{id}`
- `GET /v1/products`, `GET /v1/products/{id}` — filter by product_type_id, product_subtype_id, product_package_type_id, manufacturer_id

Offers
- `GET /v1/offers` — filter by `state` (two-letter US abbreviation); expand with show_stores, show_clips, show_details, prelive
- `GET /v1/offers/{id}`

Consumers and clips
- `POST /v1/consumers`, `GET /v1/consumers/{retailer_identifier}`
- `GET /v1/clips`, `POST /v1/clips`, `GET /v1/clips/{id}`

Stores
- `GET /v1/stores` — filter by `state`
- `GET /v1/stores/{id}`

Redemptions and payouts
- `GET /v1/redemption_disbursements`, `POST /v1/redemption_disbursements` (money-moving), `GET /v1/redemption_disbursements/{id}`

## Conventions

- Pagination: `page` + `limit` query parameters. No total count, no next-page field, no Link header.
- Idempotency: no `Idempotency-Key` header. The caller-supplied `retailer_identifier` is the dedupe key — `POST /v1/clips` returns 303 with a `location` on a duplicate offer/consumer pair and 409 when the key collides with a different clip.
- Errors: Rails-style envelope `{"<resource>": {"errors": {"<field>": ["<message>"]}}}`. Not RFC 9457, no error codes.
- Rate limits: none published. No X-RateLimit-*, no Retry-After, no 429 in the contract.
- Tracing: every response carries `x-request-id` and `x-runtime`.
- Geography: US only — the state enum covers the 50 states, DC and the US territories.

## Docs

- [Developers](https://bybe.com/developers): API overview plus the SFTP CSV batch alternative for post-purchase data.
- [Pricing](https://bybe.com/pricing): 25% + 25 cents per successful transaction, capped at $1.75; free for retailers; no setup, impression or clip fees.
- [Developer portal](https://developer.bybe.io/): API credential issuance (account login required).
- [Dashboard](https://dashboard.bybe.io/): brand and retailer offer management (account login required).
- [Status](https://status.bybe.com/)
- [Terms and conditions](https://bybe.com/terms-and-conditions.html)
- [Privacy policy](https://bybe.com/privacy-policy.html)
- [GitHub](https://github.com/BYBE-INC): 2 public repositories, neither an API client.

## Not published

BYBE publishes no SDK in any package registry, no CLI, no MCP server, no A2A agent card, no
webhooks or AsyncAPI, no `/.well-known/` documents, no security.txt, no trust center or named
certifications, no dated changelog, and no deprecation policy.

## Profile

- [API Evangelist profile](https://apis.io/provider/bybe/)
- [This repository](https://github.com/api-evangelist/bybe)