Authorizations
Use your Straddle API Key in the Authorization header as Bearer <token> to authorize API requests.
Headers
For use by platforms to specify an account id and set scope of a request.
Optional client generated identifier to trace and debug a request.
Optional client generated identifier to trace and debug a series of requests.
Optional client generated value to use for idempotent requests.
10 - 40
Path Parameters
Body
An arbitrary description for the charge.
"Monthly subscription fee"
The amount of the charge in cents.
10000
The desired date on which the payment should be occur. For charges, this means the date you want the customer to be debited on.
Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the charge in a structured format.
Response
OK
Metadata about the API request, including an identifier and timestamp.
Indicates the structure of the returned content.
- "object" means the
data
field contains a single JSON object. - "array" means the
data
field contains an array of objects. - "error" means the
data
field contains an error object with details of the issue. - "none" means no data is returned.
object
, array
, error
, none