> ## 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 prepayment link status changes > Returns the historical record of status changes for an advertiser's prepayments payment link, including the status and available balance at each recorded change. Use this endpoint when you need to review the timeline of link availability for auditing, troubleshooting, or reporting. Results are ordered by `statusChangedAt` descending (newest first); changes recorded at the same instant are ordered by an internal unique sequence, so the order is stable across pages. This operation is read-only and has no side effects; it does not modify the advertiser account, payment link, or financial state. The caller must belong to the advertiser account and hold the Viewer role or higher on it; otherwise the request is rejected with `403`. No product entitlement is required. An advertiser account that has no prepayments account returns `404` with code `NOT_FOUND`. ## OpenAPI ````json GET /v1/advertisers/{advertiserId}/prepayments/link-status-changes { "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/advertisers/{advertiserId}/prepayments/link-status-changes": { "x-awin-owner": "hqteamartemis", "parameters": [ { "$ref": "#/components/parameters/AdvertiserId" } ], "get": { "tags": [ "Advertisers > Billing" ], "operationId": "listAdvertiserPrepaymentsLinkStatusChanges", "summary": "List prepayment link status changes", "description": "Returns the historical record of status changes for an advertiser's\nprepayments payment link, including the status and available balance at\neach recorded change. Use this endpoint when you need to review the\ntimeline of link availability for auditing, troubleshooting, or reporting.\n\nResults are ordered by `statusChangedAt` descending (newest first);\nchanges recorded at the same instant are ordered by an internal unique\nsequence, so the order is stable across pages.\n\nThis operation is read-only and has no side effects; it does not modify\nthe advertiser account, payment link, or financial state.\n\nThe caller must belong to the advertiser account and hold the Viewer\nrole or higher on it; otherwise the request is rejected with `403`.\nNo product entitlement is required. An advertiser account that has no\nprepayments account returns `404` with code `NOT_FOUND`.\n", "x-awin-audience": "public", "x-awin-public-api-authorization": { "accountType": "advertiser", "minRole": "userViewer" }, "parameters": [ { "name": "status", "in": "query", "required": false, "description": "Filter the history by link status.", "example": "ONLINE", "schema": { "$ref": "#/components/schemas/AdvertiserPrepaymentsLinkStatusValue" } }, { "name": "statusChangedAtGte", "in": "query", "required": false, "description": "Return only changes at or after this time (`statusChangedAt` greater than or equal to the value).", "example": "2026-09-20T00:00:00Z", "schema": { "type": "string", "format": "date-time", "example": "2026-09-20T00:00:00Z" } }, { "name": "statusChangedAtLt", "in": "query", "required": false, "description": "Return only changes before this time (`statusChangedAt` less than the value). Use the start of the next period, so consecutive ranges neither overlap nor leave a gap.", "example": "2026-10-01T00:00:00Z", "schema": { "type": "string", "format": "date-time", "example": "2026-10-01T00:00:00Z" } }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/PageToken" }, { "name": "availableBalanceAmountGte", "in": "query", "required": false, "description": "Return only changes where `availableBalance.amount` is greater than or equal to the value. Compared in the advertiser's own currency.", "example": "980.50", "schema": { "$ref": "#/components/schemas/amount" } }, { "name": "availableBalanceAmountLte", "in": "query", "required": false, "description": "Return only changes where `availableBalance.amount` is less than or equal to the value. Compared in the advertiser's own currency.", "example": "1250.75", "schema": { "$ref": "#/components/schemas/amount" } } ], "responses": { "200": { "description": "The advertiser's link status history for the requested time range.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CursorPaginatedResult" }, { "type": "object", "properties": { "results": { "type": "array", "description": "Historical link status entries for this page.", "items": { "allOf": [ { "$ref": "#/components/schemas/AdvertiserPrepaymentsLinkStatus" }, { "type": "object", "required": [ "statusChangedAt", "availableBalance" ], "properties": { "availableBalance": { "allOf": [ { "$ref": "#/components/schemas/Money" } ], "description": "Amount available to the advertiser at the time this link status change was recorded." } } } ] } } } } ] }, "examples": { "linkStatusHistory": { "summary": "Link status history", "value": { "nextPageToken": "next-page-token", "results": [ { "status": "ONLINE", "statusChangedAt": "2026-09-28T10:45:00Z", "availableBalance": { "amount": "1250.75", "currency": "USD" } }, { "status": "OFFLINE", "statusChangedAt": "2026-09-20T08:15:00Z", "availableBalance": { "amount": "980.50", "currency": "USD" } } ] } } } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/UnexpectedError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "patBearer": [] } ] } } }, "components": { "parameters": { "AdvertiserId": { "name": "advertiserId", "in": "path", "required": true, "description": "Identifier of the advertiser account.", "schema": { "type": "string", "pattern": "^[0-9]+$", "example": "1001" } }, "Limit": { "name": "limit", "in": "query", "required": false, "description": "Maximum number of results to return.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25, "example": 25 } }, "PageToken": { "name": "pageToken", "in": "query", "required": false, "description": "Opaque cursor token returned as `nextPageToken` by a previous response, used to retrieve the next page of results. Omit it to retrieve the first page.", "schema": { "type": "string" } } }, "schemas": { "AdvertiserPrepaymentsLinkStatusValue": { "type": "string", "description": "Status of an advertiser prepayments payment link.", "enum": [ "ONLINE", "OFFLINE" ], "example": "ONLINE" }, "amount": { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$", "description": "Decimal string amount. Transported as a string, not a number, since floating point cannot represent decimal currency values exactly.", "example": "125.50" }, "CursorPaginatedResult": { "type": "object", "description": "Envelope for a cursor-paginated collection.", "required": [ "results" ], "properties": { "nextPageToken": { "type": "string", "description": "Opaque token for the next page. Omitted on the last page.", "example": "next-page-token" }, "results": { "type": "array", "description": "The results in this page.", "items": {} } } }, "AdvertiserPrepaymentsLinkStatus": { "type": "object", "description": "Link status for an advertiser prepayments account. Includes link availability and time of last status change.", "required": [ "status" ], "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/AdvertiserPrepaymentsLinkStatusValue" } ], "description": "Status of the advertiser payment link at the time represented by this record." }, "statusChangedAt": { "type": "string", "format": "date-time", "description": "Date and time at which this link status took effect. Omitted when the link status has never changed, meaning the link has been `ONLINE` since the advertiser joined prepayments.", "example": "2026-09-28T10:45:00Z" } } }, "Money": { "type": "object", "description": "A monetary value: a decimal amount paired with its currency. MUST NOT carry any other property; a resource with several monetary values holds one `Money` per role, named by the role.", "additionalProperties": false, "required": [ "amount", "currency" ], "properties": { "amount": { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$", "description": "Decimal string amount. Transported as a string, not a number, since floating point cannot represent decimal currency values exactly.", "example": "125.50" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "ISO 4217 currency code, uppercase.", "example": "GBP" } } }, "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" } } } } } } ] }, "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" } } } }, "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": { "BadRequest": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblem" }, "example": { "type": "https://help.awin.com/apis/error", "title": "Bad Request", "status": 400, "detail": "Required parameters are missing from the request", "code": "VALIDATION_FAILED", "errors": [ { "pointer": "/name", "detail": "must be 100 characters or fewer" } ] } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "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" } } }, "NotFound": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://help.awin.com/apis/error", "title": "Not Found", "status": 404, "detail": "Resource not found with that ID", "code": "NOT_FOUND" } } }, "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" } } } } } }, "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" } } }, "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" } } } } }, "securitySchemes": { "patBearer": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Personal Access Token, sent as `Authorization: Bearer `." } } } } ````