Generate Viewable Coupon

Generates a prescription discount coupon optimized for on-screen display, returned as a PNG image URL.
Supports localization — pass a locale field for non-English coupons.

Note: The drug field is optional. The live request body in the collection omits it.

Differences from /marketplace/v1/coupon/print:

  • Accepts an optional locale field (BCP 47, e.g. "es-US" for Spanish)
  • Returns couponURL (not printCouponURL) — image sized for screen, not print

400 error variants:

  • Invalid/unknown pricingPartner"Failed to find Contact Source for partner <name>"
  • Missing or zero Quantity → structured errors object with UnitQty key
  • Missing or zero price → structured errors object with Price key
  • NDC not in Medispan → "Medispan drug not found for NDC: <value>"
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Pricing partner name. Use PBAClientName (V1) or PricingPartner (V2) from the selected price entry. Must match exactly.

integer
required

Drug quantity. Must be greater than 0.

string
required

11-digit National Drug Code.

double
required

Price in USD from the selected pricing partner. Must be greater than 0.

string

BCP 47 locale code for the coupon language. Omit for English (default). Example values — en-US (English), es-US (Spanish).

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json