API Reference
  1. PartnerBee REST API
  2. Conversions

Record a conversion

post
https://api.partnerbee.app/api/conversions

Records a sale or recurring charge. Attribute it by a fresh click (click_id or cookie_id) or, for recurring revenue, by an existing customer_id. Idempotent on external_id: a re-sent event returns the existing conversion (deduped: true) instead of creating a duplicate.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
number
required

Order amount (gross sale). Must be positive.

string

Your unique reference for this sale. Enables idempotency.

string

The click id returned by POST /api/clicks.

string

The tracked click. Read it from the ba_aff cookie set by the JavaScript snippet, or use the cookie_id returned by POST /api/clicks. A link slug (?ref) is also accepted here.

string

Provider customer id, for recurring attribution.

string

Human-readable customer label (name or email).

string

ISO currency. Defaults to the program currency.

string
metadata
object
Responses

Updated about 3 hours ago

Did this page help you?
Language
Credentials
Bearer
beeaff-key
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 3 hours ago

Did this page help you?