Skip to main content
POST
Purchase or resume a Postal Mail balance pack

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Body

application/json

Validated request fields for this operation.

pack_key
string
required

A key returned by credits.available_packs; availability depends on configured billing packs.

Example:

"postal-mail-50"

idempotency_key
string | null

Idempotency key. Validation: nullable, string, max:191.

Maximum string length: 191
Example:

"Idempotency Key"

pending_purchase_reference
string | null

Opaque attempt_reference from credits.pending_balance_purchase; resumes that organization-owned pack purchase.

Maximum string length: 2048
Example:

"Pending Purchase Reference"

Response

Operation result.

data
object