Bearer authentication header of the form Bearer <token> , where <token> is your auth token.
Unique identifier for a credit purchase attempt.
The credit purchase attempt.
Unique identifier for this credit purchase attempt.
Current state of the purchase. Poll GET until it reaches a terminal state (succeeded or failed).
An asynchronous webhook records succeeded and actionRequired , and a periodic sweep backstops a lost webhook. A purchase can therefore stay pending until the next sweep runs, after the charge itself settles.
Amount purchased, in cents.
ISO 4217 currency code, lowercase.
When the purchase attempt was started.
When the purchased credits stop being usable.
Machine-readable decline reason. Set when status is failed, and also set to ambiguous_upstream while status is pending if a prior attempt's outcome could not be determined.
Human-readable decline detail, set only when status is failed.
Was this page helpful?