Sign in
Paywalls V2

Retrieve Paywall Preview Images

Returns the capture session and generated images for the paywall's current document URL, starting or retrying the capture when needed. Use force=true to discard a completed capture and render it again. Requires paywalls:read scope.

get/v2/paywalls/{id}/preview-images

Path parameters

idstring required

Query parameters

countrystring

Two-letter country override (for example GB) for user/device conditions. Does not convert catalog prices into another currency.

localestring

Language or language-region for browser/device locale and price formatting, for example en-GB. Defaults to en-COUNTRY when country is specified. Does not supply translated paywall copy.

intro'eligible' | 'ineligible'

Override introductory-offer eligibility. Omit to retain the existing preview default.

force'true' | 'false'

Re-capture the current paywall document even when stored images already exist

Response

Success

branch_dimensionsstring[]

Dimensions referenced by document conditions. Null means unavailable (pending or code-first runtime without condition metadata); an empty array means no supported dimensions were found. Request only the contexts you need; combinations are not generated automatically.

object'paywall_preview_session' required
idstring required

Stable capture session ID

paywall_idstring required
urlstring required

Immutable paywall document URL being captured

status'pending' | 'running' | 'ready' | 'failed' required
stage'queued' | 'fetching_paywall' | 'launching_browser' | 'awaiting_ping' | 'capturing_pages' | 'uploading' | 'done' required
page_countnumber nullable required
attemptsnumber required
created_atstring required
updated_atstring required
diagnosticsstring[] required

Changes

Changed in 3 of the 14 revisions of this API.21160

  • a01b836998038See the full diff
    • ○

      added the new optional query request parameter country

      new-optional-request-parameter

    • ○

      added the new optional query request parameter intro

      new-optional-request-parameter

    • ○

      added the new optional query request parameter locale

      new-optional-request-parameter

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 217c96dc9a2921151See the full diff
    • ▲

      the response's property type changed from string to no type for status

      response-property-type-changed

    • ▲

      the response's property type changed from string to no type for status

      response-property-type-changed

    • ▲

      the response's property type changed from string to no type for status

      response-property-type-changed

    • ▲

      the response's property type changed from string to no type for status

      response-property-type-changed

    • ▲

      the response's property type changed from string to no type for status

      response-property-type-changed

    • ▲

      the response's property type changed from string to no type for status

      response-property-type-changed

    • ▲

      the response's property type changed from string to no type for status

      response-property-type-changed

    • ▲

      the response's property type changed from string to no type for status

      response-property-type-changed

    • ▲

      the response's property type changed from string to no type for status

      response-property-type-changed

    • ▲

      the response's property type changed from string to no type for status

      response-property-type-changed

    • ▲

      the response's property type changed from string to no type for status

      response-property-type-changed

    • ▲

      the response's property type changed from string to no type for status

      response-property-type-changed

    • ▲

      the response's property type changed from string to no type for status

      response-property-type-changed

    • ▲

      the response's property type changed from string to no type for status

      response-property-type-changed

    • ▲

      the response's property type changed from string to no type for status

      response-property-type-changed

    • ▲

      the response's property type changed from number to no type for status

      response-property-type-changed

    • ▲

      the response's property type changed from string to no type for status

      response-property-type-changed

    • ▲

      the response's property type changed from string to no type for status

      response-property-type-changed

    • ▲

      the response's property type changed from string to no type for status

      response-property-type-changed

    • ▲

      the response's property type changed from string to no type for status

      response-property-type-changed

    • ▲

      the response's property type changed from string to no type for status

      response-property-type-changed

    • ○

      added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 to the response body anyOf list for the response status

      response-body-any-of-added

    • ○

      added subschema #2 to the response body anyOf list for the response status

      response-body-any-of-added

    • ○

      removed subschema #1: Missing API Key subschema #2: Invalid API Key Format subschema #3: Invalid API Key subschema #4: Authentication Failed subschema #5: Invalid Session from the response body anyOf list for the response status

      response-body-any-of-removed

    • ○

      removed subschema #2: Bad Request from the response body anyOf list for the response status

      response-body-any-of-removed

    • ○

      added subschema #1 to the response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #1 to the response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #1 to the response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #1 to the response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #1 to the response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #1 to the response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #1 to the response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #1 to the response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #1 to the response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #1 to the response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #1 to the response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #1 to the response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #1 to the response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #1 to the response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #1 to the response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #1 to the response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #1 to the response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #1 to the response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #1 to the response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #1 to the response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #1 to the response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #1 to the response property anyOf list for the response status

      response-property-any-of-added

    • ○

      removed the api_error enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the api_error enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the api_error enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the api_error enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the api_error enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the authentication_error enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the authentication_error enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the authentication_error enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the authentication_error enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the authentication_error enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the authentication_failed enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the authentication_failed enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the authentication_failed enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the authentication_failed enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the authentication_failed enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the idempotency_key_in_use enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the idempotency_key_in_use enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the idempotency_key_in_use enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the idempotency_key_in_use enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the idempotency_key_in_use enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the insufficient_permissions enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the insufficient_permissions enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the insufficient_permissions enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the insufficient_permissions enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the insufficient_permissions enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the internal_error enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the internal_error enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the internal_error enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the internal_error enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the internal_error enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the invalid_api_key enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the invalid_api_key enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the invalid_api_key enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the invalid_api_key enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the invalid_api_key enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the invalid_api_key_format enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the invalid_api_key_format enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the invalid_api_key_format enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the invalid_api_key_format enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the invalid_api_key_format enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the invalid_reference enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the invalid_reference enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the invalid_reference enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the invalid_reference enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the invalid_reference enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the invalid_request_error enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the invalid_request_error enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the invalid_request_error enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the invalid_request_error enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the invalid_request_error enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the invalid_session enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the invalid_session enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the invalid_session enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the invalid_session enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the invalid_session enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the missing_api_key enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the missing_api_key enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the missing_api_key enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the missing_api_key enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the missing_api_key enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the organization_required enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the organization_required enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the organization_required enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the organization_required enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the organization_required enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the parameter_invalid enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the parameter_invalid enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the parameter_invalid enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the parameter_invalid enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the parameter_invalid enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the parameter_missing enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the parameter_missing enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the parameter_missing enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the parameter_missing enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the parameter_missing enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the parameter_unknown enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the parameter_unknown enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the parameter_unknown enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the parameter_unknown enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the parameter_unknown enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the permission_error enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the permission_error enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the permission_error enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the permission_error enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the permission_error enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the rate_limit_error enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the rate_limit_error enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the rate_limit_error enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the rate_limit_error enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the rate_limit_error enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the rate_limit_exceeded enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the rate_limit_exceeded enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the rate_limit_exceeded enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the rate_limit_exceeded enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the rate_limit_exceeded enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the resource_already_exists enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the resource_already_exists enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the resource_already_exists enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the resource_already_exists enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the resource_already_exists enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the resource_archived enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the resource_archived enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the resource_archived enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the resource_archived enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the resource_archived enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the resource_missing enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the resource_missing enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the resource_missing enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the resource_missing enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the resource_missing enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the side_effect_failed enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the side_effect_failed enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the side_effect_failed enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the side_effect_failed enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the side_effect_failed enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the unsupported_operation enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the unsupported_operation enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the unsupported_operation enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the unsupported_operation enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the unsupported_operation enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the upstream_service_error enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the upstream_service_error enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the upstream_service_error enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the upstream_service_error enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the upstream_service_error enum value from the response property for the response status

      response-property-enum-value-removed

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

    This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 7dbbee8e03051See the full diff
    • ○

      endpoint added

      endpoint-added