> ## Documentation Index > Fetch the complete documentation index at: https://help.awin.com/llms.txt > Use this file to discover all available pages before exploring further. # List advertiser terms > Returns programme terms and conditions (T&C) for the advertisers named in `advertiserId`. Use it to check an advertiser's commission, paid search, partner-type and deduplication rules before or after joining their programme; a partnership is not required. The caller needs any role on the publisher account `{publisherId}`. Results are ordered numerically by `advertiserId`, ascending. Read-only; no side effects. ## OpenAPI ````json GET /v1/publishers/{publisherId}/advertiser-terms { "openapi": "3.0.3", "info": { "title": "Awin Public API", "version": "0.1.0" }, "servers": [ { "url": "https://api.awin.com/public", "description": "Production" } ], "tags": [ { "name": "Advertisers", "description": "Endpoints for advertiser accounts." }, { "name": "Advertisers > Partnerships", "description": "Advertiser partnerships with publishers." }, { "name": "Advertisers > Tracking links", "description": "Advertiser tracking links." }, { "name": "Advertisers > Billing", "description": "Advertiser billing and prepayments." }, { "name": "Publishers", "description": "Endpoints for publisher accounts." }, { "name": "Publishers > Partnerships", "description": "Publisher partnerships with advertisers." }, { "name": "Publishers > Transactions", "description": "Publisher transactions." }, { "name": "Publishers > Payments", "description": "Publisher payments and payment details." } ], "paths": { "/v1/publishers/{publisherId}/advertiser-terms": { "x-awin-owner": "hqteampenguin", "get": { "tags": [ "Publishers > Partnerships" ], "operationId": "listAdvertiserTerms", "x-awin-audience": "public", "summary": "List advertiser terms", "description": "Returns programme terms and conditions (T&C) for the advertisers named in `advertiserId`. Use it to check an advertiser's commission, paid search, partner-type and deduplication rules before or after joining their programme; a partnership is not required. The caller needs any role on the publisher account `{publisherId}`. Results are ordered numerically by `advertiserId`, ascending. Read-only; no side effects.", "x-awin-public-api-authorization": { "accountType": "publisher" }, "parameters": [ { "$ref": "#/components/parameters/PublisherId" }, { "name": "advertiserId", "in": "query", "required": true, "description": "Advertisers to return terms for; supply one id or several comma-separated, for example `advertiserId=1001,1002`. At most 50. Partnership is not required. An id that does not identify an existing advertiser, or identifies an advertiser with no stored terms, is omitted from `results`. Each id may appear only once.", "style": "form", "explode": false, "schema": { "type": "array", "minItems": 1, "maxItems": 50, "uniqueItems": true, "items": { "$ref": "#/components/schemas/AdvertiserId" } }, "example": [ "1001", "1002" ] } ], "responses": { "200": { "description": "Programme terms for the selected advertisers.", "content": { "application/json": { "schema": { "type": "object", "required": [ "results" ], "properties": { "results": { "type": "array", "maxItems": 50, "description": "Programme terms for the requested advertisers that exist and have stored terms, ordered numerically by advertiserId, ascending.", "items": { "$ref": "#/components/schemas/AdvertiserProgrammeTermsListItem" } } } }, "example": { "results": [ { "advertiserId": "1001", "updatedAt": "2026-01-21T09:44:06Z", "term": { "commission": { "transactionIncludeVat": false, "transactionIncludeDeliveryCharges": true, "transactionIncludeCreditCardsFees": false, "transactionIncludeGiftWrapping": false, "productCategoriesExcluded": true, "productCategoriesExcludedList": [ "Category 1" ], "declineCommissionReasons": [ "ORDER_CANCELED", "ORDER_RETURNED" ] }, "searchEnginePromo": { "fullCommissionOnPaidSearch": true, "fullCommissionOnDirectLinks": false, "fullCommissionOnBrandNameUrl": false, "fullCommissionOnBrandNamePaidSearch": false, "fullCommissionOnBrandNameInNegativeKeywords": false, "fullCommissionOnDisplayAdsWithBrandVariation": false, "fullCommissionOnDisplayAdsWithMisspelling": false, "fullCommissionOnDisplayAdsWithBrandAndOtherKeywords": false, "fullCommissionOnPlaceShoppingAdsWithDirectLink": true, "allowToEarnCommissionsOnSpecificGroups": false, "commissionOnPaidSearchActivitySearchEngines": [ "YAHOO" ], "commissionOnPaidSearchHasIneligibleKeywords": false, "activityOnComparisonShoppingServiceInSeparateAccount": false }, "preferredPartnerTypes": { "allowedPartnerTypes": [ "MEDIA_BROKERS" ], "promoTypesRestriction": false }, "deduplication": { "isDeduplicationOnAdvertiserChannels": true, "deduplicationChannels": [ "PPC_BRAND" ] }, "additionalTerms": "

Additional programme terms (HTML).

", "brandingTerms": "

Branding terms (HTML).

" } }, { "advertiserId": "1002", "updatedAt": "2025-11-02T14:10:00Z", "term": { "commission": { "transactionIncludeVat": true, "transactionIncludeDeliveryCharges": false, "transactionIncludeCreditCardsFees": false, "transactionIncludeGiftWrapping": false, "productCategoriesExcluded": false, "declineCommissionReasons": [ "NOT_ELIGIBLE" ] }, "searchEnginePromo": { "fullCommissionOnPaidSearch": false, "allowToEarnCommissionsOnSpecificGroups": false, "commissionOnPaidSearchHasIneligibleKeywords": false, "activityOnComparisonShoppingServiceInSeparateAccount": false }, "preferredPartnerTypes": { "allowedPartnerTypes": [], "promoTypesRestriction": false }, "deduplication": { "isDeduplicationOnAdvertiserChannels": false, "deduplicationChannels": [] }, "additionalTerms": "

Short programme terms.

" } } ] } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "description": "Invalid request: a non-numeric `publisherId`, or an invalid `advertiserId` query (missing, non-numeric, duplicated, or more than 50 ids).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblem" }, "example": { "type": "https://help.awin.com/apis/error", "title": "Bad Request", "status": 400, "detail": "The advertiserId query parameter is invalid.", "code": "VALIDATION_FAILED", "errors": [ { "pointer": "/advertiserId", "detail": "must contain between 1 and 50 numeric advertiser ids" } ] } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "$ref": "#/components/responses/UnexpectedError" } }, "security": [ { "patBearer": [] } ] } } }, "components": { "parameters": { "PublisherId": { "name": "publisherId", "in": "path", "required": true, "description": "Identifier of the publisher account.", "schema": { "type": "string", "pattern": "^[0-9]+$", "example": "45678" } } }, "schemas": { "AdvertiserId": { "type": "string", "pattern": "^[0-9]+$", "description": "Identifier of the advertiser account.", "example": "1001" }, "AdvertiserProgrammeTermsListItem": { "type": "object", "description": "Programme terms for one requested advertiser.", "required": [ "advertiserId", "updatedAt", "term" ], "properties": { "advertiserId": { "description": "Advertiser account identifier.", "allOf": [ { "$ref": "#/components/schemas/AdvertiserId" } ] }, "updatedAt": { "type": "string", "format": "date-time", "description": "UTC timestamp when these programme terms were last updated.", "example": "2026-01-21T09:44:06Z" }, "term": { "$ref": "#/components/schemas/Term" } } }, "ValidationProblem": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "type": "object", "description": "A problem detail carrying the RFC 9457 extension member `errors`, used where a request fails validation on one or more specific fields.", "properties": { "errors": { "type": "array", "description": "One entry per field that failed validation.", "items": { "type": "object", "required": [ "pointer", "detail" ], "properties": { "pointer": { "type": "string", "description": "An [RFC 6901](https://www.rfc-editor.org/rfc/rfc6901) JSON Pointer to the offending field in the request.", "example": "/name" }, "detail": { "type": "string", "description": "A human-readable explanation of this field's failure.", "example": "must be 100 characters or fewer" } } } } } } ] }, "Term": { "type": "object", "description": "Advertiser programme terms and conditions (T&C).", "required": [ "commission", "searchEnginePromo", "preferredPartnerTypes", "deduplication" ], "properties": { "commission": { "description": "Commission calculation and decline rules.", "allOf": [ { "$ref": "#/components/schemas/Commission" } ] }, "searchEnginePromo": { "description": "Paid search and promotional activity rules.", "allOf": [ { "$ref": "#/components/schemas/SearchEnginePromo" } ] }, "preferredPartnerTypes": { "description": "Allowed partner types and promo restrictions.", "allOf": [ { "$ref": "#/components/schemas/PreferredPartnerTypes" } ] }, "deduplication": { "description": "Deduplication settings across advertiser channels.", "allOf": [ { "$ref": "#/components/schemas/Deduplication" } ] }, "additionalTerms": { "type": "string", "minLength": 1, "description": "Additional programme terms written by the advertiser, as an HTML fragment. Omitted when the advertiser has not written any. Consumers must sanitise the HTML before rendering.", "example": "

Additional programme terms (HTML).

" }, "brandingTerms": { "type": "string", "description": "Branding terms written by the advertiser, as an HTML fragment. Omitted when the advertiser has not written any. Consumers must sanitise the HTML before rendering.", "example": "

Branding terms (HTML).

" } } }, "Problem": { "type": "object", "description": "Problem details for an HTTP API error, as defined by [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457). Served as `application/problem+json`.", "required": [ "title", "status", "detail", "code" ], "properties": { "type": { "type": "string", "format": "uri-reference", "default": "https://help.awin.com/apis/error", "description": "A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.", "example": "https://help.awin.com/apis/error" }, "title": { "type": "string", "description": "A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.", "example": "Not Found" }, "status": { "type": "integer", "description": "The HTTP status code, repeated here for convenience.", "example": 404 }, "detail": { "type": "string", "description": "A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.", "example": "Resource not found with that ID" }, "instance": { "type": "string", "format": "uri-reference", "description": "A URI reference identifying this specific occurrence, typically the request path.", "example": "/v1/advertisers/12345/prepayments" }, "code": { "type": "string", "description": "A stable, machine-readable error code. It does not change when `detail` is reworded, so clients branch on `code`, never on `detail`.", "enum": [ "VALIDATION_FAILED", "INVALID_SORT", "UNAUTHORIZED", "MISSING_TOKEN", "INVALID_TOKEN", "FORBIDDEN", "ACCESS_DENIED", "CLIENT_NOT_CONFIGURED", "NOT_FOUND", "METHOD_NOT_ALLOWED", "NOT_ACCEPTABLE", "CONFLICT", "CONTENT_TOO_LARGE", "UNSUPPORTED_MEDIA_TYPE", "BUSINESS_RULE_VIOLATION", "TOO_MANY_REQUESTS", "USER_RATE_LIMIT_EXCEEDED", "ROUTE_RATE_LIMIT_EXCEEDED", "LINK_SHORTENER_QUOTA_EXCEEDED", "INTERNAL_ERROR", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "DEPENDENCY_UNAVAILABLE", "GATEWAY_TIMEOUT", "FEATURE_NOT_ENABLED", "ACCOUNT_IN_DEBT", "DUPLICATE_ENQUIRY_ID", "TRANSACTION_QUERY_NOT_PENDING", "MEMBERSHIP_INACTIVE", "ORDER_REF_ALREADY_TRACKED", "ORDER_REF_ALREADY_QUERIED", "TRANSACTION_DATE_BEFORE_ADVERTISER_LIVE_DATE", "CURRENCY_NOT_SUPPORTED", "CURRENCY_MISMATCH", "TRANSACTION_DATE_IN_FUTURE", "TRANSACTION_DATE_TOO_OLD", "OVERRIDE_NOT_ALLOWED" ], "example": "NOT_FOUND" } } }, "Commission": { "type": "object", "description": "Commission calculation and decline rules. Always present in programme terms. Unset properties are omitted, never null. When `productCategoriesExcluded` is true, `productCategoriesExcludedList` is present and not empty. When `declineCommissionReasons` contains `OTHER`, `declineCommissionOtherReasonsNotes` is present and not blank.", "required": [ "transactionIncludeVat", "transactionIncludeDeliveryCharges", "transactionIncludeCreditCardsFees", "transactionIncludeGiftWrapping", "productCategoriesExcluded", "declineCommissionReasons" ], "properties": { "transactionIncludeVat": { "type": "boolean", "description": "Whether commission is calculated on the transaction amount including VAT.", "example": false }, "transactionIncludeDeliveryCharges": { "type": "boolean", "description": "Whether commission is calculated on the transaction amount including delivery charges.", "example": true }, "transactionIncludeCreditCardsFees": { "type": "boolean", "description": "Whether commission is calculated on the transaction amount including credit card fees.", "example": false }, "transactionIncludeGiftWrapping": { "type": "boolean", "description": "Whether commission is calculated on the transaction amount including gift-wrapping charges.", "example": false }, "productCategoriesExcluded": { "type": "boolean", "description": "Whether some product categories are excluded from commission. When true, `productCategoriesExcludedList` names those categories.", "example": true }, "productCategoriesExcludedList": { "type": "array", "items": { "type": "string" }, "description": "Product categories excluded from commission. Not empty when `productCategoriesExcluded` is true.", "example": [ "Category 1" ] }, "declineCommissionReasons": { "type": "array", "items": { "type": "string", "enum": [ "ORDER_CANCELED", "ORDER_RETURNED", "ORDER_PARTIALLY_RETURNED", "NOT_ELIGIBLE", "MIN_ORDER_VALUE", "COUPON_NOT_ALLOWED", "NOT_VALID_CUSTOMER", "NOT_VALID_ORDER", "ORDER_NOT_FULFILLED", "CREDIT_FAILED", "PPC_TERMS_NOT_MET", "QUERY_WINDOW_PASSED", "COMMISSION_ALREADY_PAID", "ORDER_REF_NOT_FOUND", "ORDER_NOT_FOUND", "CONVERSION_DIFFERENT_CHANNEL", "CONVERSION_DIFFERENT_PARTNER", "PROGRAMME_NOT_ACTIVE", "BUSINESS_CLOSED", "OTHER" ] }, "uniqueItems": true, "description": "Reasons the advertiser may decline a commission. May be empty when no decline reasons are configured.", "example": [ "ORDER_CANCELED", "ORDER_RETURNED" ] }, "declineCommissionOtherReasonsNotes": { "type": "string", "description": "Free-text explanation used when `declineCommissionReasons` contains `OTHER`, in which case it is not blank.", "example": "Commission declined for a reason agreed in the programme terms." } } }, "SearchEnginePromo": { "type": "object", "description": "Paid search and brand-bidding rules. Always present in programme terms. Unset properties are omitted, never null. A `true` flag that has a companion text or list requires that companion to be present and not blank or empty.", "required": [ "fullCommissionOnPaidSearch", "allowToEarnCommissionsOnSpecificGroups", "commissionOnPaidSearchHasIneligibleKeywords", "activityOnComparisonShoppingServiceInSeparateAccount" ], "properties": { "fullCommissionOnPaidSearch": { "type": "boolean", "description": "Whether the publisher earns full commission on paid-search traffic.", "example": true }, "fullCommissionOnDirectLinks": { "type": "boolean", "description": "Whether the publisher earns full commission on traffic from direct links. Omitted when `fullCommissionOnPaidSearch` is false.", "example": false }, "fullCommissionOnBrandNameUrl": { "type": "boolean", "description": "Whether the publisher earns full commission when the brand name appears in the destination URL. Omitted when `fullCommissionOnPaidSearch` is false.", "example": false }, "fullCommissionOnBrandNamePaidSearch": { "type": "boolean", "description": "Whether the publisher earns full commission on paid search that bids on the brand name. Omitted when `fullCommissionOnPaidSearch` is false.", "example": false }, "fullCommissionOnBrandNameInNegativeKeywords": { "type": "boolean", "description": "Whether the publisher still earns full commission when the brand name is present only as a negative keyword (the campaign excludes the brand rather than bidding on it). Omitted when `fullCommissionOnPaidSearch` is false.", "example": false }, "fullCommissionOnDisplayAdsWithBrandVariation": { "type": "boolean", "description": "Whether the publisher earns full commission on display ads that use a variation of the brand name. Omitted when `fullCommissionOnPaidSearch` is false.", "example": false }, "fullCommissionOnDisplayAdsWithMisspelling": { "type": "boolean", "description": "Whether the publisher earns full commission on display ads that use a misspelling of the brand name. Omitted when `fullCommissionOnPaidSearch` is false.", "example": false }, "fullCommissionOnDisplayAdsWithBrandAndOtherKeywords": { "type": "boolean", "description": "Whether the publisher earns full commission on display ads that combine the brand name with other keywords. Omitted when `fullCommissionOnPaidSearch` is false.", "example": false }, "fullCommissionOnPlaceShoppingAdsWithDirectLink": { "type": "boolean", "description": "Whether the publisher earns full commission on shopping ads that use a direct link to the advertiser. Omitted when `fullCommissionOnPaidSearch` is false.", "example": true }, "allowToEarnCommissionsOnSpecificGroups": { "type": "boolean", "description": "Whether commission on paid search is limited to specific publisher groups. When true, `allowToEarnCommissionsOnSpecificGroupsDetails` describes those groups.", "example": false }, "allowToEarnCommissionsOnSpecificGroupsDetails": { "type": "string", "description": "Which publisher groups may earn commission on paid search, as plain text. Present and not blank when `allowToEarnCommissionsOnSpecificGroups` is true; else omitted.", "example": "Approved brand-bidding partners only." }, "commissionOnPaidSearchActivitySearchEngines": { "type": "array", "items": { "type": "string", "enum": [ "GOOGLE", "YAHOO", "BING", "OTHER" ] }, "uniqueItems": true, "description": "Search engines on which paid-search activity is allowed. At least one search engine is present when `fullCommissionOnPaidSearch` is true; omitted when it is false.", "example": [ "YAHOO" ] }, "commissionOnPaidSearchActivitySearchOtherNotes": { "type": "string", "description": "Notes for search engines other than the listed ones, as plain text. Present when `commissionOnPaidSearchActivitySearchEngines` contains `OTHER`.", "example": "Regional search engines agreed with the advertiser." }, "commissionOnPaidSearchHasIneligibleKeywords": { "type": "boolean", "description": "Whether some keywords are ineligible for paid-search commission. When true, `commissionOnPaidSearchIneligibleKeywords` lists them.", "example": false }, "commissionOnPaidSearchIneligibleKeywords": { "type": "array", "items": { "type": "string" }, "description": "Keywords that do not earn paid-search commission. Not empty, with no blank entries, when `commissionOnPaidSearchHasIneligibleKeywords` is true.", "example": [ "competitor-brand" ] }, "activityOnComparisonShoppingServiceInSeparateAccount": { "type": "boolean", "description": "Whether comparison-shopping activity must run in an account separate from the publisher's other paid-search activity.", "example": false } } }, "PreferredPartnerTypes": { "type": "object", "description": "Allowed publisher types and promotional restrictions. Always present in programme terms. Unset properties are omitted, never null. When `promoTypesRestriction` is true, `promoTypesRestrictionDetails` is present and not empty.", "required": [ "allowedPartnerTypes", "promoTypesRestriction" ], "properties": { "allowedPartnerTypes": { "type": "array", "items": { "type": "string", "enum": [ "CSS", "COMMUNITIES_UGC", "COMPARISON_ENGINE", "EDITORIAL_CONTENT", "MEDIA_CONTENT", "LEAD_GENERATION_CONTENT", "SHOPPING_DIRECTORY", "CONTENT_CREATORS_AND_INFLUENCERS", "RETARGETING_DISPLAY", "CONTEXTUAL_TARGETING", "DIRECT_TRAFFIC", "MEDIA_BROKERS", "MOBILE_TRAFFIC", "SOCIAL_TRAFFIC", "AD_NETWORKS", "LEAD_GENERATION_EMAIL", "NEWSLETTERS", "RETARGETING_EMAIL", "CASHBACK", "DISCOUNT_CODE", "LOYALTY", "VIRTUAL_INCENTIVES", "DIRECT_LINKING", "DOMAIN_PARKING", "LINKING_VIA_LANDING_PAGES", "MOBILE_SEARCH", "SOCIAL_SEARCH", "SUB_NETWORKS" ] }, "uniqueItems": true, "description": "Publisher types the advertiser allows to promote the programme. Must contain at least one type.", "example": [ "MEDIA_BROKERS" ] }, "promoTypesRestriction": { "type": "boolean", "description": "Whether the advertiser restricts promotional methods beyond `allowedPartnerTypes`. When true, `promoTypesRestrictionDetails` describes the restriction.", "example": false }, "promoTypesRestrictionDetails": { "type": "string", "description": "Description of the promotional-method restriction. Present and not empty when `promoTypesRestriction` is true.", "example": "No incentivised traffic." } } }, "Deduplication": { "type": "object", "description": "Channel deduplication settings. Always present in programme terms. Unset properties are omitted, never null. When `isDeduplicationOnAdvertiserChannels` is true, `deduplicationChannels` lists the channels the advertiser deduplicates against and is not empty.", "required": [ "isDeduplicationOnAdvertiserChannels", "deduplicationChannels" ], "properties": { "isDeduplicationOnAdvertiserChannels": { "type": "boolean", "description": "Whether the advertiser deduplicates publisher conversions against its own channels (for example paid search or email).", "example": true }, "deduplicationChannels": { "type": "array", "items": { "type": "string", "enum": [ "PPC_BRAND", "PPC_GENERIC", "EMAIL_ADVERTISING", "DISPLAY_ADVERTISING", "DIRECT_PARTNERSHIPS", "PRICE_COMPARISON", "IN_HOUSE_PROGRAMME", "OTHER_NETWORKS" ] }, "uniqueItems": true, "description": "Advertiser channels that take priority over the publisher when deduplication is on, in which case it is not empty.", "example": [ "PPC_BRAND" ] } } } }, "headers": { "RateLimitLimit": { "description": "Maximum number of requests you can make in a burst under your own rate limit. Absent when the request did not count against your own limit.", "schema": { "type": "integer", "minimum": 1, "example": 5 } }, "RateLimitRemaining": { "description": "Number of requests you have left under your own rate limit. Absent when the request did not count against your own limit.", "schema": { "type": "integer", "minimum": 0, "example": 0 } }, "RateLimitReset": { "description": "Number of seconds until your own rate limit is fully restored. Absent when the request did not count against your own limit.", "schema": { "type": "integer", "minimum": 0, "example": 1 } }, "RetryAfter": { "description": "Number of seconds to wait before retrying the request.", "required": true, "schema": { "type": "integer", "minimum": 0, "example": 1 } } }, "responses": { "Unauthorized": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://help.awin.com/apis/error", "title": "Unauthorized", "status": 401, "detail": "No valid credentials were supplied with the request", "code": "UNAUTHORIZED" } } } }, "Forbidden": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://help.awin.com/apis/error", "title": "Forbidden", "status": 403, "detail": "You do not have the correct privileges to access this resource", "code": "FORBIDDEN" } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "TooManyRequests": { "description": "Too Many Requests", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "userRateLimitExceeded": { "value": { "type": "https://help.awin.com/apis/error", "title": "User rate limit exceeded", "status": 429, "detail": "You have exceeded your rate limit across the public API. Retry after the number of seconds in the Retry-After header", "code": "USER_RATE_LIMIT_EXCEEDED" } }, "routeRateLimitExceeded": { "value": { "type": "https://help.awin.com/apis/error", "title": "Route rate limit exceeded", "status": 429, "detail": "This endpoint is receiving more requests than it can accept right now. Retry after the number of seconds in the Retry-After header", "code": "ROUTE_RATE_LIMIT_EXCEEDED" } }, "tooManyRequests": { "value": { "type": "https://help.awin.com/apis/error", "title": "Too Many Requests", "status": 429, "detail": "Rate limit exceeded", "code": "TOO_MANY_REQUESTS" } } } } } }, "ServiceUnavailable": { "description": "Service Unavailable", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://help.awin.com/apis/error", "title": "Service Unavailable", "status": 503, "detail": "The service is temporarily unavailable", "code": "SERVICE_UNAVAILABLE" } } } }, "UnexpectedError": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://help.awin.com/apis/error", "title": "Internal Server Error", "status": 500, "detail": "An unexpected error occurred", "code": "INTERNAL_ERROR" } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } } }, "securitySchemes": { "patBearer": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Personal Access Token, sent as `Authorization: Bearer `." } } } } ````