Lead Scrapers

Pay for a lead scraper

Charges for a lead scraper request for the authenticated client, or returns a checkout URL.

Behavior

  • Preview first with POST /api/v1/lead-scrapers/payment-preview
  • An active subscription with a card on file is charged once, at 50% off. charged_immediately is true
  • No active subscription pays the full price. Open checkout_url to pay
  • An active subscription that is not billed automatically still receives 50% off and a checkout URL
  • The lead scrape starts after payment is confirmed

Response

  • checkout_url: pay page when the saved card is not charged
  • charged_immediately: true when the saved card was charged
post/api/v1/lead-scrapers/payment

Request

  • Base URL: https://api.aerosend.io
  • URL: https://api.aerosend.io/api/v1/lead-scrapers/payment
  • Auth: API key in header X-API-Key

Request body

scraperIdstring

Scraper id from GET /api/v1/lead-scrapers

Example request

{
  "scraperId": "clutch"
}

Response

OK

successboolean

Success flag

timestampstring

Response timestamp

Example response

{
  "success": true,
  "data": {
    "scraperId": "google-ads",
    "currencyCode": "USD",
    "discountPercent": 50,
    "listAmount": 1,
    "amountDue": 0.5,
    "quantity": 1,
    "unitCount": 1,
    "checkoutUrl": "https://app.aerosend.io/payment?ptxn=txn_01"
  },
  "timestamp": "2025-12-14T10:30:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.