Account

Check a pay link

Status of a pay link this account asked for: pending, paid or expired. Poll every few seconds while a person is paying; paid means the credit is on the account.

get/v1/checkout/{checkout_id}

Request

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

Path parameters

checkout_idstring required

The id returned by POST /v1/checkout.

Response

The link and its status.

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.