> ## Documentation Index > Fetch the complete documentation index at: https://docs.whop.com/llms.txt > Use this file to discover all available pages before exploring further. # Pause ad > Pauses an ad. Required permissions: - `ad_campaign:update` - `ad_campaign:basic:read` ## OpenAPI ````yaml https://app.stainless.com/api/spec/documented/whopsdk/openapi.documented.yml post /ads/{id}/pause openapi: 3.1.0 info: title: Whop API description: >- The Whop REST API. Please see https://docs.whop.com/developer/api/getting-started for more details. termsOfService: https://whop.com/tos-developer-api/ version: 1.0.0 x-api-version-date: '2026-06-09' servers: - url: https://api.whop.com/api/v1 description: Production Whop API - url: https://sandbox-api.whop.com/api/v1 description: Sandbox Whop API security: [] tags: - name: Products description: Products - name: Payments description: Payments - name: Refunds description: Refunds - name: Disputes description: Disputes - name: Dispute alerts description: Dispute alerts - name: Resolution center cases description: Resolution center cases - name: Checkout configurations description: Checkout configurations - name: Setup intents description: Setup intents - name: Payment methods description: Payment methods - name: Invoices description: Invoices - name: Promo codes description: Promo codes - name: Card transactions description: Card transactions - name: Ledger accounts description: Ledger accounts - name: Transfers description: Transfers - name: Withdrawals description: Withdrawals - name: Payout methods description: Payout methods - name: Verifications description: Verifications - name: Identity profiles description: Identity profiles - name: Payout accounts description: Payout accounts - name: Topups description: Topups - name: Companies description: Companies - name: Authorized users description: Authorized users - name: Fee markups description: Fee markups - name: Members description: Members - name: Memberships description: Memberships - name: Leads description: Leads - name: Entries description: Entries - name: Shipments description: Shipments - name: Reviews description: Reviews - name: Company token transactions description: Company token transactions - name: Affiliates description: Affiliates - name: Experiences description: Experiences - name: Forums description: Forums - name: Forum posts description: Forum posts - name: Chat channels description: Chat channels - name: Support channels description: Support channels - name: Messages description: Messages - name: Reactions description: Reactions - name: Dm members description: Dm members - name: Dm channels description: Dm channels - name: Notifications description: Notifications - name: Courses description: Courses - name: Course chapters description: Course chapters - name: Course lessons description: Course lessons - name: Course students description: Course students - name: Course lesson interactions description: Course lesson interactions - name: Apps description: Apps - name: Webhooks description: Webhooks - name: App builds description: App builds - name: Access tokens description: Access tokens - name: Account links description: Account links - name: Files description: Files - name: Ai chats description: Ai chats - name: Bounties description: Bounties - name: Stats description: Stats - name: Ad campaigns description: Ad campaigns - name: Ad groups description: Ad groups - name: Ads description: Ads - name: Conversions description: Conversions - name: Ad reports description: Ad reports paths: /ads/{id}/pause: post: tags: - Ads summary: Pause ad description: |- Pauses an ad. Required permissions: - `ad_campaign:update` - `ad_campaign:basic:read` operationId: pauseAd parameters: - name: id in: path required: true description: The unique identifier of the ad to pause. schema: type: string example: ad_xxxxxxxxxxxxxxx responses: '200': description: A successful response content: application/json: schema: $ref: '#/components/schemas/Ad' '400': description: Bad request content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: invalid_request_error code: parameter_missing message: 'Missing required parameter: amount.' param: amount '401': description: Unauthorized content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: unauthorized message: Invalid or missing API key '403': description: Forbidden content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: forbidden message: You do not have permission to access this resource '404': description: Not found content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: not_found message: Resource not found '422': description: Verification required content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: null '500': description: Internal server error content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: internal_server_error message: An unexpected error occurred security: - bearerAuth: - ad_campaign:update - ad_campaign:basic:read x-codeSamples: - lang: JavaScript source: |- import Whop from '@whop/sdk'; const client = new Whop({ apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted }); const ad = await client.ads.pause('ad_xxxxxxxxxxxxxxx'); console.log(ad.id); - lang: Python source: |- import os from whop_sdk import Whop client = Whop( api_key=os.environ.get("WHOP_API_KEY"), # This is the default and can be omitted ) ad = client.ads.pause( "ad_xxxxxxxxxxxxxxx", ) print(ad.id) - lang: Ruby source: |- require "whop_sdk" whop = WhopSDK::Client.new(api_key: "My API Key") ad = whop.ads.pause("ad_xxxxxxxxxxxxxxx") puts(ad) components: schemas: Ad: type: object properties: id: type: string description: The unique identifier for this ad. example: ad_xxxxxxxxxxxxxxx title: type: - string - 'null' description: >- The display title of the ad. Falls back to the creative set caption when unset. status: $ref: '#/components/schemas/ExternalAdStatuses' description: Current delivery status of the ad. platform: $ref: '#/components/schemas/AdCampaignPlatforms' description: The external ad platform this ad is running on (e.g., meta, tiktok). created_at: type: string format: date-time description: When the ad was created. example: '2023-12-01T05:00:00.401Z' updated_at: type: string format: date-time description: When the ad was last updated. example: '2023-12-01T05:00:00.401Z' issues: type: array items: type: object properties: category: oneOf: - $ref: '#/components/schemas/AdPlatformIssueCategories' - type: 'null' description: >- Whop's canonical category for this issue. Null until classified. subtype: type: - string - 'null' description: >- Finer-grained sub-bucket within the category (e.g. the specific Meta policy for a rejection). resource_type: type: string description: >- The kind of ad object this issue is on: `ad`, `ad_group`, or `ad_campaign`. Pairs with `resourceId`. resource_id: type: - string - 'null' description: >- The Whop ID of the ad object this issue is on (the ad, ad group, or campaign). Null when the issue isn't tied to a local object. created_at: type: string format: date-time description: When the issue was first reported. example: '2023-12-01T05:00:00.401Z' resolution_status: $ref: '#/components/schemas/AdPlatformIssueResolutionStatuses' description: Current resolution status. required: - category - subtype - resource_type - resource_id - created_at - resolution_status description: >- A platform-reported issue on an ad object (rejection, policy flag, etc.). description: >- Open platform issues affecting this ad, deduplicated per object. Empty when there are none. spend: type: number description: Amount charged in dollars in the stats window. example: 6.9 spend_currency: oneOf: - $ref: '#/components/schemas/Currencies' - type: 'null' description: Currency of `spend` and the other monetary metric fields. impressions: type: integer description: Total impressions (views) on this ad in the stats window. example: 42 reach: type: integer description: >- Unique users reached in the stats window (deduplicated by the platform). example: 42 clicks: type: integer description: Total clicks on this ad in the stats window. example: 42 unique_clicks: type: integer description: Unique clicks (deduplicated by the platform) in the stats window. example: 42 frequency: type: - number - 'null' description: >- Average number of times each person saw an ad (impressions / reach), as reported by the platform. example: 6.9 click_through_rate: type: number description: >- Click-through rate as a fraction of impressions (clicks / impressions, 0–1). example: 6.9 unique_click_through_rate: type: - number - 'null' description: >- Unique click-through rate as a fraction of impressions (unique clicks / impressions, 0–1). example: 6.9 return_on_ad_spend: type: number description: >- Return on ad spend as a ratio (purchaseValue / spend) — 2.5 means $2.50 of attributed purchase value per $1 spent. 0 when there is no spend. example: 6.9 purchases: type: integer description: >- Number of Whop pixel-attributed purchases (last-click) in the stats window. example: 42 purchase_value: type: number description: >- Total USD value of Whop pixel-attributed purchases in the stats window. example: 6.9 leads: type: integer description: >- Number of Whop pixel-attributed leads (last-click) in the stats window. example: 42 cost_per_click: type: number description: >- Cost per click in dollars (spend / clicks). 0 when there are no clicks. example: 6.9 cost_per_mille: type: number description: >- Cost per 1,000 impressions in dollars (spend / impressions × 1000). 0 when there are no impressions. example: 6.9 cost_per_result: type: - number - 'null' description: >- Cost in dollars per optimization result (spend / results). 0 when a result is being optimized for but none happened yet; null when nothing is being optimized for. example: 6.9 cost_per_purchase: type: - number - 'null' description: >- Cost in dollars per Whop pixel-attributed purchase (spend / purchases). 0 when purchases are tracked but none happened yet; null when purchases are not a goal and none were attributed. example: 6.9 cost_per_lead: type: - number - 'null' description: >- Cost in dollars per Whop pixel-attributed lead (spend / leads). 0 when leads are tracked but none happened yet; null when leads are not a goal and none were attributed. example: 6.9 ad_group: type: object properties: id: type: string description: The unique identifier for this ad group. example: adgrp_xxxxxxxxxxxx required: - id description: The parent ad group this ad belongs to. ad_campaign: type: object properties: id: type: string description: The unique identifier for this ad campaign. example: adcamp_xxxxxxxxxxx required: - id description: The ad campaign this ad belongs to. required: - id - title - status - platform - created_at - updated_at - issues - spend - spend_currency - impressions - reach - clicks - unique_clicks - frequency - click_through_rate - unique_click_through_rate - return_on_ad_spend - purchases - purchase_value - leads - cost_per_click - cost_per_mille - cost_per_result - cost_per_purchase - cost_per_lead - ad_group - ad_campaign description: An ad belonging to an ad group. ExternalAdStatuses: type: string enum: - active - paused - inactive - in_review - rejected - flagged description: The status of an external ad. AdCampaignPlatforms: type: string enum: - meta - tiktok description: The platforms where an ad campaign can run. AdPlatformIssueCategories: type: string enum: - policy_rejection - creative_media - audience_targeting - ad_volume_limit description: Whop's canonical category that a raw platform issue is bucketed into. AdPlatformIssueResolutionStatuses: type: string enum: - open - resolved - acknowledged description: The resolution status of an ad platform issue. Currencies: type: string enum: - usd - sgd - inr - aud - brl - cad - dkk - eur - nok - gbp - sek - chf - hkd - huf - jpy - mxn - myr - pln - czk - nzd - aed - eth - ape - cop - ron - thb - bgn - idr - dop - php - try - krw - twd - vnd - pkr - clp - uyu - ars - zar - dzd - tnd - mad - kes - kwd - jod - all - xcd - amd - bsd - bhd - bob - bam - khr - crc - xof - egp - etb - gmd - ghs - gtq - gyd - ils - jmd - mop - mga - mur - mdl - mnt - nad - ngn - mkd - omr - pyg - pen - qar - rwf - sar - rsd - lkr - tzs - ttd - uzs - rub - btc - cny - usdt - kzt - awg - whop_usd - xau description: The available currencies on the platform securitySchemes: bearerAuth: type: http description: >- A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like `Bearer ***************************` scheme: bearer bearerFormat: auth-scheme ````