Sign in

v1

latestOpenAPI 3.0.32026-07-2618073.2 KB
Purchases

Get bulk purchase status

Returns the status of a bulk purchase, including details and link to download archive.

get/v1/purchases/bulk/{purchase_id}

Path parameters

purchase_idstring required

Response

Response for status 200

bulk_purchase_idinteger required

Unique ID of the bulk purchase request

country_codestring required

ISO 3166-1 alpha-2 country code.

quantityinteger required

Number of accounts in this purchase

status'PENDING' | 'SUCCESS' | 'ERROR' | 'REFUND' required

Current status of bulk purchase

created_atstring required

Bulk purchase creation timestamp

updated_atstring required

Last update timestamp

Example response

{
  "bulk_purchase_id": 123,
  "total_price": {
    "amount": "1.50",
    "currency_code": "USD"
  },
  "price_per_account": {
    "amount": "1.50",
    "currency_code": "USD"
  },
  "item": {
    "export_id": "550e8400-e29b-41d4-a716-446655440000",
    "archive_url": "/v1/purchases/bulk/123/download",
    "quantity": 10,
    "created_at": "2024-11-19T08:15:00.000Z"
  }
}