API Reference

Purchase a Plan

post
https://api.wingspan.app/v3/platform/purchases

Creates one Purchase and Subscription atomically. No payment is taken by this request. Prices are resolved from the Plan catalog and cannot be supplied by the caller.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 1 and 64
string
length between 1 and 64
fulfillmentData
object

Reserved for Plans with fulfillment requirements; no plan accepts it today.

consents
array of objects
required
length between 1 and 20
consents*
string
required
length between 1 and 255
string
required
length between 1 and 64
string
required
^[a-f0-9]{64}$
date-time
required
string

Reserved for server-derived migration and succession flows; buyer requests are rejected.

Headers
string
required
length between 1 and 255
^[\x21-\x7e]{1,255}$

REQUIRED idempotency token for money-moving requests (e.g. transfers). The token is used by the API so a retry after a 5xx/timeout replays the original result instead of moving funds twice. Reuse the same key to retry safely; use a NEW key to issue a genuinely new transfer. Use 1-255 printable ASCII characters.

string
^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 4 months ago

Did this page help you?