Manage payer entities representing the billing party for advertiser spend
Payers
Payers represent the entities responsible for billing — the party invoiced for advertiser spend. A payer may bill for one or more advertisers.
Overview
A Payer entity contains:
- Identification - Name, description
- Provider Mappings - Identifiers linking the payer to external systems (e.g. a billing/CRM system)
Query Payers
Basic Query
query GetPayers {
dream_adserver {
payers(limit: 10) {
edges {
payer_id
payer_name
payer_desc
}
total_count
}
}
}Filtered Query
query GetFilteredPayers($filter: JSON, $sort: JSON) {
dream_adserver {
payers(
filter: $filter
sort: $sort
limit: 25
offset: 0
) {
edges {
payer_id
payer_name
payer_desc
payer_ext_id
payer_ext_ids
payer_modification_date
payer_modification_user
}
total_count
}
}
}Variables:
{
"filter": {
"payer_name": {"like": "%Corp%"}
},
"sort": {
"payer_name": "asc"
}
}Available Fields
Breaking change:
payer_modification_timehas been renamed topayer_modification_date. Update any query that selectspayer_modification_timeonDASPayer— the old field name no longer exists in the schema.
| Field | Type | Description |
|---|---|---|
payer_id | Int! | Unique identifier |
payer_name | String! | Payer name |
payer_desc | String | Descriptive information about the payer |
payer_ext_id | String | Payer identifier in an external database |
payer_ext_ids | JSON | JSON string containing pairs of data sources and IDs |
payer_modification_date | String | Last modification time (format: yyyy-mm-ddThh:mm:ss.s+zzzzzz) |
payer_modification_user | String | Login of the user who last modified the payer data |
Mutations
Create/Update Payer
mutation SetPayer($payer: DASPayerInput!) {
dream_adserver {
set_payer(payer: $payer) {
status
hit {
payer_id
payer_name
}
}
}
}Variables (create, with provider mappings):
{
"payer": {
"payer_name": "Example Corp Billing",
"payer_desc": "Central billing entity",
"payer_provider_mappings": [
{ "provider_name": "CRM", "external_id": "PAY-9931" }
]
}
}Variables (edit an existing payer — pass payer_id):
{
"payer": {
"payer_id": 3301,
"payer_name": "Example Corp Billing",
"payer_provider_mappings": [
{ "provider_name": "CRM", "external_id": "PAY-9931" }
]
}
}Required field:
payer_name. Omitpayer_idto create a new payer, provide it to edit an existing one.payer_provider_mappingsis the full desired set of external-system mappings, reconciled on every call (add/update/remove) — an empty list clears all mappings, omitting the field leaves existing mappings untouched. The mutation returnshit(the savedDASPayer) alongsidestatus, kept for backward compatibility.
Legacy shape (still supported):
payer_external_id+payer_provider_name— a single external id, applied as an additive upsert rather than a full reconcile. Preferpayer_provider_mappingsfor new integrations.
Next Steps
- Reporting & Analytics - Generate campaign reports
- Advertisers - Manage advertiser entities
- Agencies - Manage agency entities
- Filtering - Master query filters
Related
- Delivery APIs Overview - Campaign hierarchy