Buy a credit pack within the owner's limits: charge the saved card off-session when allowed, else hand a person a Checkout link (next_action). Requires Idempotency-Key; a replay answers 200 with replayed true and Idempotent-Replayed: true; refusals leave no purchase. 10 per key and 20 per account per hour, per livemode

post/v1/billing/purchases

Request

  • Base URL: https://api.roveapi.com
  • URL: https://api.roveapi.com/v1/billing/purchases
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

Scoped to the account; reuse it on every retry of the same purchase, use a new one for a new purchase.

Request body

item_idstring required

A current catalogue pack id, e.g. pack_1k (GET /v1/billing/catalogue).

payment'auto' | 'checkout' | 'saved_method'

auto (default): charge the saved card when the owner allowed it, else hand a person a Checkout link; checkout: always a link; saved_method: only the saved card (refused with suggested_payment auto when not eligible).

Response

Idempotency-Key replay: the purchase as it is now (reconciled with Stripe first when it was still created after 2 minutes)

idstring uuid required
object'purchase' required
status'created' | 'open' | 'requires_action' | 'processing' | 'paid' | 'refunded' | 'disputed' | 'reversed' | 'expired' | 'canceled' | 'failed' required
livemodeboolean required
actor'owner_web' | 'api_key' | 'auto_topup' | 'legacy_link' required
api_key_idstring uuid nullable required
api_key_namestring nullable required
replayedboolean required
channel'checkout' | 'off_session' required
amount_centsinteger required
currency'usd' required
creditsinteger required

Whole credits the pack grants.

amount_refunded_centsinteger required
millicredits_reversedinteger required
millicredits_heldinteger required
retry'same_key' | 'new_key' nullable required
failure_codestring nullable required
created_atstring date-time required
paid_atstring date-time nullable required

Changes

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