Account

Get a pay link

Returns a card checkout link for one pack or plan, tied to the account behind the API key. A script or agent never handles card details: it hands the link to a person, then polls GET /v1/checkout/{checkout_id} until status is paid. Whoever pays, the credit is added to the account that asked. Asking again for the same sku while a link is still open returns the same link. Links expire after 48 hours.

post/v1/checkout

Request

  • Base URL: https://whipscribe.com/api
  • URL: https://whipscribe.com/api/v1/checkout
  • Auth: API key in header X-API-Key

Request body

skustring required

What to buy: mini-4 (500 minutes, $6), basic-8 (1,000 minutes, $8), pro-monthly (2,000 minutes, $12), team-monthly (5,000 minutes, $24, includes API access) or workspace-monthly (Workspace plan, $19/month, includes API access). The packs are one-time purchases. An unknown value returns the current list.

Example request

{
  "sku": "team-monthly"
}

Response

Pay link created, or the account's still-open link for this sku returned again.

idstring

Checkout id; pass it to GET /v1/checkout/{checkout_id}.

status'pending' | 'paid' | 'expired'

pending until the payment has been credited to the account, then paid. expired after 48 hours unpaid; ask for a new link.

checkout_urlstring nullable

Card checkout page for this account. Give it to the person who pays; whoever pays, the credit lands on the account that asked for the link. null once the link is paid or expired.

skustring
amount_usdnumber

List price in US dollars. Checkout may show the buyer's local currency and tax.

minutesinteger

Transcription minutes the purchase adds (0 for the Workspace plan).

expires_atnumber

Unix time after which the link stops working.

Example response

{
  "id": "txn_01k0example",
  "status": "pending",
  "checkout_url": "https://whipscribe.com/pricing?_ptxn=txn_01k0example",
  "sku": "team-monthly",
  "amount_usd": 24,
  "minutes": 5000,
  "expires_at": 1791346190
}

Changes

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