Skip to main content
POST
Generate advertiser invoice

Authorizations

X-API-Key
string
header
required

Preferred authentication method. Pass the API key in the X-API-Key HTTP request header. The user account must have api_status enabled.

Body

advertiser_id
integer
required

Advertiser to generate invoice for.

currency
string
required

3-letter currency code (e.g. USD). Converted to uppercase.

Maximum string length: 3
amount
number

Invoice amount. If omitted, calculated automatically from balance.

Required range: x >= 0
start_date
string<date>

Period start date (YYYY-MM-DD).

end_date
string<date>

Period end date (YYYY-MM-DD). Must be >= start_date.

status
string

Invoice status: unpaid, paid, draft, etc.

invoice_memo
string

Memo text visible to advertiser.

internal_notes
string

Internal notes (not visible to advertiser).

offers
string

Comma-separated offer IDs to include.

Response

Invoice generated.

status
string
Example:

"success"

code
integer
Example:

200

name
string
Example:

"OK"

message
string
info
object

Generated invoice — invoice_id and invoice_number.