---
updatedAt: 2026-08-18T13:09:18.000Z
agentTools:
  projectIndex: https://docs.wistia.com/llms.txt
---

# Create Bulk Purchase

Submits either an `actions` array of up to 1000 orders or one `job` that can
resolve to up to 5000 media. Orders are placed asynchronously. Returns a
background job status whose Show endpoint reports aggregate progress and
per-order results.

Orders in the batch can incur charges, so a saved credit card is required.
Supported resource types are `captions` (Wistia-generated English captions),
`localization` (a dubbed, language-specific version of a media),
`extended_audio_description`, and `text_translation` (the media's transcript
translated into another language, audio untouched). Each order's `id` is the
hashed ID of the media to order for.

What an order costs depends on the account, not on this endpoint. Automated
captions are included at no cost on plans that provide them and billed at
the account's configured per-minute rate otherwise; human-reviewed captions
bill per minute at the account's standard or rush rate; localizations bill
per minute once the account's free-dub allowance is used up; text
translations bill as an overage once the account's included translation
minutes are used up. Check the account's plan and billing settings for its
actual rates.

Orders are priced and placed individually: failures -- an ineligible media,
a language that already has a localization, an account not entitled to buy
-- are reported per order and do not stop the rest of the batch. Pricing and
eligibility match the equivalent single-media endpoints exactly.

Use the Create Bulk Actions endpoint for create, update, and delete work; it
does not accept `purchase`, and this endpoint accepts nothing else.


## Requires api token with one of the following permissions
```
Read, update & delete anything
```

Tokens with the "Act with a team member's permissions" permission
(`all:delegate_to_contact_permissions` scope) can also be used. Requests
made with such a token are authorized using the permissions of the
contact assigned to the token.

[Expiring access tokens](https://docs.wistia.com/reference/post_expiring-token)
with authorizations cannot use this endpoint: each action is authorized
later, in a background job, as the persisted contact that submitted it,
and a token's authorizations are not carried into that job. Such requests
are forbidden.



# OpenAPI definition

````json
{
  "openapi": "3.1.1",
  "info": {
    "title": "Data API",
    "description": "Wistia Data API",
    "version": "2026.09.0"
  },
  "servers": [
    {
      "url": "https://api.wistia.com/modern"
    }
  ],
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "tags": [
    {
      "name": "Bulk Purchases"
    }
  ],
  "paths": {
    "/bulk/purchase": {
      "post": {
        "summary": "Create Bulk Purchase",
        "x-speakeasy-group": "bulk",
        "x-speakeasy-name-override": "purchase",
        "description": "Submits either an `actions` array of up to 1000 orders or one `job` that can\nresolve to up to 5000 media. Orders are placed asynchronously. Returns a\nbackground job status whose Show endpoint reports aggregate progress and\nper-order results.\n\nOrders in the batch can incur charges, so a saved credit card is required.\nSupported resource types are `captions` (Wistia-generated English captions),\n`localization` (a dubbed, language-specific version of a media),\n`extended_audio_description`, and `text_translation` (the media's transcript\ntranslated into another language, audio untouched). Each order's `id` is the\nhashed ID of the media to order for.\n\nWhat an order costs depends on the account, not on this endpoint. Automated\ncaptions are included at no cost on plans that provide them and billed at\nthe account's configured per-minute rate otherwise; human-reviewed captions\nbill per minute at the account's standard or rush rate; localizations bill\nper minute once the account's free-dub allowance is used up; text\ntranslations bill as an overage once the account's included translation\nminutes are used up. Check the account's plan and billing settings for its\nactual rates.\n\nOrders are priced and placed individually: failures -- an ineligible media,\na language that already has a localization, an account not entitled to buy\n-- are reported per order and do not stop the rest of the batch. Pricing and\neligibility match the equivalent single-media endpoints exactly.\n\nUse the Create Bulk Actions endpoint for create, update, and delete work; it\ndoes not accept `purchase`, and this endpoint accepts nothing else.\n\n\n## Requires api token with one of the following permissions\n```\nRead, update & delete anything\n```\n\nTokens with the \"Act with a team member's permissions\" permission\n(`all:delegate_to_contact_permissions` scope) can also be used. Requests\nmade with such a token are authorized using the permissions of the\ncontact assigned to the token.\n\n[Expiring access tokens](https://docs.wistia.com/reference/post_expiring-token)\nwith authorizations cannot use this endpoint: each action is authorized\nlater, in a background job, as the persisted contact that submitted it,\nand a token's authorizations are not carried into that job. Such requests\nare forbidden.\n\n",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "description": "A bulk purchase request, in one of two shapes.\n\nSend `actions` to name each media individually, and `job` to order for every\nmedia under a parent. Provide exactly one of them -- a request carrying both\nis rejected, and so is a request carrying neither.\n",
                "unevaluatedProperties": false,
                "properties": {
                  "actions": {
                    "type": "array",
                    "description": "The orders to place, one per media. Maximum 1000 per request, and the\nrequest body must stay under 2 MB -- whichever limit is reached first. An\noversized body is rejected with a `413` and no order in it is placed.\n\nEvery order is priced and placed independently: one failing (an\nineligible media, an account without a saved card, a language that\nalready has a localization) does not stop the rest of the batch.\n\nUse `job` instead to order for a whole folder, channel, or account.\n",
                    "minItems": 1,
                    "maxItems": 1000,
                    "items": {
                      "type": "object",
                      "description": "A single paid order within a bulk purchase request.",
                      "unevaluatedProperties": false,
                      "properties": {
                        "operation": {
                          "type": "string",
                          "description": "Always `purchase`. This endpoint places orders only; to create, update,\nor delete records in bulk use the Create Bulk Actions endpoint, which\ndoes not accept `purchase`.\n",
                          "enum": [
                            "purchase"
                          ]
                        },
                        "resource_type": {
                          "type": "string",
                          "description": "What to order for the media.\n\n`captions` orders Wistia-generated English captions -- computer-generated\nor human-reviewed. `localization` orders a dubbed, language-specific\nversion of the media. `extended_audio_description` orders an extended\naudio description track. `text_translation` translates the media's\nexisting transcript into another language, leaving the audio alone.\n",
                          "enum": [
                            "captions",
                            "localization",
                            "extended_audio_description",
                            "text_translation"
                          ]
                        },
                        "id": {
                          "type": "string",
                          "description": "The hashed ID of the media to order for. Always the media's own ID: what\nthe order produces does not exist yet.\n",
                          "examples": [
                            "abc123"
                          ]
                        },
                        "payload": {
                          "type": "object",
                          "description": "Order options. The accepted fields depend on the resource type and match\nthe corresponding single-media endpoint's request body. Omit it to take\nevery default.\n\n`captions` accepts `automated` (order computer-generated captions\ninstead of human-reviewed ones), `rush` (one business day turnaround\ninstead of four, human-reviewed only, at a higher per-minute rate), and\n`automatically_enable` (show the captions on the video as soon as they\nare ready). Each is treated as `false` when omitted or unrecognized.\nWhat each option costs depends on the account's plan and billing\nsettings.\n\n`localization` requires `output_language`, a 3-character IETF language\ncode, and accepts `auto_enable` (default `true`).\n\n`extended_audio_description` accepts `enabled` (default `true`),\n`ai_enabled` (default `true`), `ietf_language_tag` (default `eng`), and\n`order_instructions`.\n\n`text_translation` requires `target_language` and accepts\n`source_language` (which transcript to translate from, defaulting to the\nmedia's own language). Use the bibliographic ISO 639-2 form or a\nsupported regional or script IETF tag for either value.\n",
                          "unevaluatedProperties": true
                        }
                      },
                      "required": [
                        "operation",
                        "resource_type",
                        "id"
                      ]
                    }
                  },
                  "job": {
                    "type": "object",
                    "description": "One order placed for many media, named by a parent (`scope`) or listed\nexplicitly (`ids`), so ordering captions for a folder of 47 videos takes one\njob rather than 47 orders.\n\nA `scope` resolves to exactly what List Media returns for that parent,\nincluding media in the folder's subfolders and **archived** media, and to at\nmost 5000 media -- beyond that the job is rejected rather than truncated.\n\nThe job attempts one order for every media it resolves to. Ineligible media\nfail individually without placing an order; successful orders are metered\nand may incur charges according to the account's plan. Confirm the scope and\npotential cost with the customer before submitting. Not available to external\ncontacts.\n",
                    "unevaluatedProperties": false,
                    "properties": {
                      "operation": {
                        "type": "string",
                        "description": "Always `purchase`.",
                        "enum": [
                          "purchase"
                        ]
                      },
                      "resource_type": {
                        "type": "string",
                        "description": "What to order for the media.\n\n`captions` orders Wistia-generated English captions -- computer-generated\nor human-reviewed. `localization` orders a dubbed, language-specific\nversion of the media. `extended_audio_description` orders an extended\naudio description track. `text_translation` translates the media's\nexisting transcript into another language, leaving the audio alone.\n",
                        "enum": [
                          "captions",
                          "localization",
                          "extended_audio_description",
                          "text_translation"
                        ]
                      },
                      "scope": {
                        "type": "object",
                        "description": "The parent whose media the order applies to. An order always addresses the\nmedia, so the valid parent types are the same for every resource type here.\n",
                        "unevaluatedProperties": false,
                        "properties": {
                          "type": {
                            "type": "string",
                            "description": "The kind of parent `id` names. Required, because a hashed ID does not say\nwhat it belongs to -- the same value could name a folder or a channel.\nUse `account` to order for every media in the account.\n",
                            "enum": [
                              "account",
                              "folder",
                              "subfolder",
                              "channel"
                            ]
                          },
                          "id": {
                            "type": "string",
                            "description": "The parent's hashed ID. Required for every scope type except `account`.\n",
                            "examples": [
                              "abc123"
                            ]
                          }
                        },
                        "required": [
                          "type"
                        ]
                      },
                      "ids": {
                        "type": "array",
                        "description": "The media to order for, named explicitly. Use this instead of `scope`\nwhen the media do not share a parent. Give either `scope` or `ids`, never\nboth.\n",
                        "minItems": 1,
                        "maxItems": 1000,
                        "items": {
                          "type": "string"
                        },
                        "examples": [
                          [
                            "abc1234567",
                            "def8901234"
                          ]
                        ]
                      },
                      "payload": {
                        "type": "object",
                        "description": "Order options applied to every matching media, in the same shape a single\norder's payload takes for this resource type.\n",
                        "unevaluatedProperties": true
                      }
                    },
                    "required": [
                      "operation",
                      "resource_type"
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "Bulk purchase accepted and queued for processing",
            "content": {
              "application/json": {
                "schema": {
                  "unevaluatedProperties": false,
                  "allOf": [
                    {
                      "type": "object",
                      "properties": {
                        "message": {
                          "description": "A confirmation message that the background job has been queued.",
                          "type": "string"
                        },
                        "background_job_status": {
                          "unevaluatedProperties": false,
                          "allOf": [
                            {
                              "type": "object",
                              "description": "A background job keeps track of the progress of an asynchronous task, e.g\nbulk archiving media, translating media, etc.\n",
                              "properties": {
                                "id": {
                                  "description": "The ID of the background job that's been queued for the request.",
                                  "type": "integer"
                                },
                                "hashed_id": {
                                  "description": "The unguessable hashed ID of the background job. Prefer this over the numeric ID when polling for status.",
                                  "type": "string"
                                },
                                "status": {
                                  "description": "The status of the background job that's been queued for the request.",
                                  "type": "string",
                                  "enum": [
                                    "queued",
                                    "started",
                                    "finished",
                                    "failed"
                                  ]
                                }
                              },
                              "required": [
                                "id",
                                "hashed_id",
                                "status"
                              ]
                            }
                          ]
                        }
                      },
                      "required": [
                        "message",
                        "background_job_status"
                      ]
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "unevaluatedProperties": false,
                  "type": "object",
                  "properties": {
                    "error": {
                      "description": "Error message detailing the reason for the bad request.",
                      "type": "string",
                      "examples": [
                        "Bad request"
                      ]
                    },
                    "errors": {
                      "description": "Array of error messages detailing the reasons for the bad request.",
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized, invalid or missing token",
            "content": {
              "application/json": {
                "schema": {
                  "unevaluatedProperties": false,
                  "type": "object",
                  "properties": {
                    "code": {
                      "description": "A machine-readable identifier for the specific authorization failure.",
                      "type": "string",
                      "enum": [
                        "unauthorized_credentials",
                        "account_inactive",
                        "unauthorized_scope",
                        "unauthorized_params"
                      ]
                    },
                    "error": {
                      "type": "string",
                      "examples": [
                        "Invalid credentials."
                      ]
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Forbidden, token is valid but account does not have access to feature",
            "content": {
              "application/json": {
                "schema": {
                  "unevaluatedProperties": false,
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "examples": [
                        "Webinars are not available on your current plan"
                      ]
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error",
            "content": {
              "application/json": {
                "schema": {
                  "unevaluatedProperties": false,
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "examples": [
                        "Internal server error"
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Bulk Purchases"
        ],
        "parameters": [
          {
            "name": "X-Wistia-API-Version",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "default": "2026-09"
            }
          }
        ],
        "x-readme": {
          "code-samples": [
            {
              "name": "Typescript (SDK)",
              "language": "javascript",
              "code": "import { Wistia } from \"@wistia/wistia-api-client\";\n\nconst wistia = new Wistia({\n  bearerAuth: process.env[\"WISTIA_BEARER_AUTH\"] ?? \"\",\n});\n\nasync function run() {\n  const result = await wistia.bulk.purchase({\n    actions: [\n      {\n        operation: \"purchase\",\n        resourceType: \"extended_audio_description\",\n        id: \"abc123\",\n      },\n    ],\n    job: {\n      operation: \"purchase\",\n      resourceType: \"captions\",\n      scope: {\n        type: \"subfolder\",\n        id: \"abc123\",\n      },\n      ids: [\n        \"abc1234567\",\n        \"def8901234\",\n      ],\n    },\n  });\n\n  console.log(result);\n}\n\nrun();"
            }
          ]
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "x-readme": {
    "samples-languages": [
      "javascript",
      "shell",
      "node",
      "python",
      "ruby"
    ]
  }
}
````