Program Term API — Advertiser Reference

This page covers all advertiser-defined data structures returned by the Program Terms API — the contract, program terms, action terms, commission rules, and supporting objects that describe how an advertiser's program is structured.

Object: `Contract`

A contract between a publisher and an advertiser, including the applicable program terms.

Field	Type	Description
`advertiserId`	`ID!`	Company ID for the advertiser associated with this contract.
`endTime`	`ISODateTime`	Date the contract ends. `null` if the contract has no end date.
`programTerms`	`ProgramTerms!`	The conditions agreed upon for this contract.
`startTime`	`ISODateTime`	Date the contract starts.
`status`	`ContractStatus!`	Current status of the contract. See `ContractStatus` enum.

Object: `ProgramTerms`

The conditions agreed upon for a contract, including all action terms and commission rates.

Field	Type	Description
`actionTerms`	`[ActionTerm!]!`	List of action terms that define commission rates for each action tracker.
`id`	`ID!`	Program Terms ID.
`isDefault`	`Boolean!`	`true` if these are the default program terms, automatically assigned when entering a relationship with the advertiser.
`name`	`String!`	Program Terms name.
`specialTerms`	`SpecialTerms`	Any special terms and conditions set by the advertiser outside of the standard program term rules.

Object: `ActionTerm`

Information about the limits an advertiser has set up and the commission rates that apply for a specific action tracker.

Field	Type	Description
`actionTracker`	`ActionTracker!`	The action tracker this term applies to.
`commissions`	`[Commission!]!`	The commission rates and conditions that can apply for this action term.
`id`	`ID!`	Action Term ID.
`lockingMethod`	`LockingMethod!`	Determines how actions tracked under this term will be locked.
`performanceIncentives`	`[PerformanceIncentive!]!`	Performance-based commission adjustments that apply when certain thresholds are met.
`referralOccurrences`	`Long`	Number of referrals.
`referralPeriod`	`Long!`	Referral period in days.

Object: `ActionTracker`

Describes an advertiser's integration point with CJ — the action tracker that fires when a commissionable event occurs.

Field	Type	Description
`description`	`String`	Action Tracker description.
`id`	`ID!`	Action Tracker ID.
`name`	`String!`	Action Tracker name.
`type`	`ActionTrackerType!`	Action Tracker type. See `ActionTrackerType` enum.

Object: `Commission`

A specific commission rate and the conditions under which it applies for an action term.

Field	Type	Description
`isViewThrough`	`Boolean!`	`true` if this commission applies to view-through attribution (transaction attributed to an ad view rather than a click).
`itemList`	`ItemList`	The item list this commission rate applies to, if any.
`promotionalProperties`	`[PromotionalProperty!]!`	The promotional properties (PIDs) to which this commission rate applies. Empty if this rate applies to all properties.
`rank`	`Long!`	Commission rank. Higher rank = higher priority. When multiple commissions match, the highest-ranked one applies.
`rate`	`CommissionRate!`	The rate paid when all conditions match.
`situation`	`CommissionSituation`	The situation condition that must be met for this rate to apply, if any.

Object: `CommissionRate`

The rate that will be paid when all conditions for a commission are met.

Field	Type	Description
`currency`	`String`	Currency for fixed commission types. `null` for percent-based commissions.
`type`	`CommissionRateType!`	Commission type. See `CommissionRateType` enum.
`value`	`BigDecimal!`	Commission value. Represents a percentage (e.g. `5` = 5%) for `PERCENT` type, or a fixed amount for `FIXED` and `FIXED_PER_ORDER` types.

Object: `CommissionSituation`

A situation condition that an advertiser has set up to pay different commission rates based on certain conditions.

Field	Type	Description
`id`	`ID!`	Situation ID.
`name`	`String!`	Situation name.

Object: `ItemList`

A named group of items to which an advertiser has applied a specific commission rate.

Field	Type	Description
`id`	`ID!`	Item List ID.
`name`	`String!`	Item List name.

Object: `LockingMethod`

Determines how and when actions will be locked for payment.

Field	Type	Description
`durationInDays`	`Long`	Number of days before locking for `FIXED_DURATION` type. `null` for all other types.
`type`	`LockingMethodType!`	Locking method type. See `LockingMethodType` enum.

Object: `PerformanceIncentive`

A performance-based commission adjustment that applies once a defined threshold is exceeded.

Field	Type	Description
`currency`	`String!`	Currency for fixed incentives and thresholds based on commission or sales amounts.
`reward`	`PerformanceIncentiveReward!`	The reward applied once the threshold is exceeded.
`threshold`	`PerformanceIncentiveThreshold!`	The threshold that must be met for the incentive to apply.

Object: `PerformanceIncentiveReward`

The reward applied once a performance incentive threshold is exceeded.

Field	Type	Description
`commissionType`	`PerformanceIncentiveRewardCommissionType!`	Whether the adjusted commission is expressed as a fixed amount or a percent. See `PerformanceIncentiveRewardCommissionType` enum.
`type`	`PerformanceIncentiveRewardType!`	Type of reward — one-time bonus or a new commission rate. See `PerformanceIncentiveRewardType` enum.
`value`	`BigDecimal!`	Reward value.

Object: `PerformanceIncentiveThreshold`

The threshold from which a performance incentive becomes applicable.

Field	Type	Description
`type`	`PerformanceIncentiveThresholdType!`	The basis for the threshold — number of actions, sales amount, or commissions amount. See `PerformanceIncentiveThresholdType` enum.
`value`	`BigDecimal!`	Threshold value.

Object: `PromotionalProperty`

A promotional property (PID) to which a specific commission rate applies.

Field	Type	Description
`id`	`ID!`	Promotional property ID.
`name`	`String!`	Promotional property name.

Object: `SpecialTerms`

Special terms and conditions specified by the advertiser that apply outside of the standard program term rules.

Field	Type	Description
`body`	`String`	Body text of the special terms.
`name`	`String`	Name of the special terms.

Program Term API — Advertiser Reference

Object: Contract

Object: ProgramTerms

Object: ActionTerm

Object: ActionTracker

Object: Commission

Object: CommissionRate

Object: CommissionSituation

Object: ItemList

Object: LockingMethod

Object: PerformanceIncentive

Object: PerformanceIncentiveReward

Object: PerformanceIncentiveThreshold

Object: PromotionalProperty

Object: SpecialTerms