AffiliateBase · Schema
CampaignWrite
Software-as-a-ServiceAffiliate MarketingStripePaymentsMarketing Automation
Properties
| Name | Type | Description |
|---|---|---|
| name | string | |
| slug | string | |
| url | string | |
| attribution_model | string | |
| private | boolean | |
| private_tokens | string | |
| reward_type | string | |
| commission_percent | number | |
| commission_amount_cents | integer | |
| commission_amount_currency | string | |
| minimum_payout_cents | integer | |
| minimum_payout_currency | string | |
| max_commission_period_months | integer | |
| reward_conditions | array | Ordered reward conditions. Currently one subscription-duration condition pays an introductory commission percent for the first N months of each referred customer. |
| introductory_commission_percent | number | Write-only input. Introductory percent for the first introductory_commission_months months. |
| introductory_commission_months | integer | Write-only input. Length of the introductory period in months. |
| max_commissions | integer | |
| days_before_referrals_expire | integer | |
| days_until_commissions_are_due | integer | |
| affiliate_dashboard_text | string | |
| custom_reward_description | string | |
| welcome_text | string | |
| customers_visible_to_affiliates | boolean | |
| sale_description_visible_to_affiliates | boolean | |
| parameter_type | string | |
| stripe_coupon_id | string | |
| promo_code_provisioning | string | Controls future automatic code generation. Defaults to automatic; individual uses explicitly created or imported codes. Existing codes are not renamed or retired. |
| default | boolean |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/affiliatebase-io/json-schema/affiliatebase-io-campaign-write-schema.json",
"title": "CampaignWrite",
"x-generated": "2026-11-01",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/affiliatebase-io-openapi.yml#/components/schemas/CampaignWrite",
"type": "object",
"properties": {
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"url": {
"type": "string"
},
"attribution_model": {
"type": "string",
"enum": [
"last_click",
"first_click"
],
"default": "last_click"
},
"private": {
"type": "boolean"
},
"private_tokens": {
"type": "string"
},
"reward_type": {
"type": "string"
},
"commission_percent": {
"type": "number"
},
"commission_amount_cents": {
"type": "integer"
},
"commission_amount_currency": {
"type": "string"
},
"minimum_payout_cents": {
"type": "integer"
},
"minimum_payout_currency": {
"type": "string"
},
"max_commission_period_months": {
"type": "integer"
},
"reward_conditions": {
"type": "array",
"description": "Ordered reward conditions. Currently one subscription-duration condition pays an introductory commission percent for the first N months of each referred customer.",
"items": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"enum": [
"subscription_duration_months"
]
},
"operator": {
"type": "string",
"enum": [
"lt"
]
},
"value": {
"type": "integer"
},
"commission_percent": {
"type": "string"
}
}
}
},
"introductory_commission_percent": {
"type": "number",
"description": "Write-only input. Introductory percent for the first introductory_commission_months months."
},
"introductory_commission_months": {
"type": "integer",
"description": "Write-only input. Length of the introductory period in months."
},
"max_commissions": {
"type": "integer"
},
"days_before_referrals_expire": {
"type": "integer"
},
"days_until_commissions_are_due": {
"type": "integer"
},
"affiliate_dashboard_text": {
"type": "string"
},
"custom_reward_description": {
"type": "string"
},
"welcome_text": {
"type": "string"
},
"customers_visible_to_affiliates": {
"type": "boolean"
},
"sale_description_visible_to_affiliates": {
"type": "boolean"
},
"parameter_type": {
"type": "string"
},
"stripe_coupon_id": {
"type": "string"
},
"promo_code_provisioning": {
"type": "string",
"enum": [
"automatic",
"individual"
],
"description": "Controls future automatic code generation. Defaults to automatic; individual uses explicitly created or imported codes. Existing codes are not renamed or retired."
},
"default": {
"type": "boolean"
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/affiliatebase-io-campaign-write"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.