Bearer authentication header of the form Bearer <token> , where <token> is your auth token.
Optional key that makes retries safe. Reusing the same key returns the existing purchase instead of starting a second charge.
Keys are scoped to the account and this operation, can be up to 255 characters, and should be treated as permanently used. If the header is missing or empty, replay protection is disabled.
Amount in cents to purchase. Must be a positive integer, and cannot exceed the credit balance cap.
The purchase attempt that was started.
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?