Skip to main content
POST
Get one payment intent

Authorizations

Authorization
string
header
required

Authorization: Bearer <api key>. The key resolves to your organization; every response is scoped to it. An organization field in the request body is optional, but if present it must match, or the request is rejected.

Body

application/json
id
string
required
organization
string

Optional. If present, must match the organization your API key resolves to, or the request is rejected with 400.

Response

One payment intent.

id
string
clinic_name
string
clinic_id
string
pet
string
subscription
string
wellnes_plan_name
string

Reproduced with the live endpoint's own spelling (one 's'). Composed as <plan name> <species> <clinic's plan header>.

payment_amount
number<double>
payment_split
object

The intent's amount, broken down by where each portion settles.

scheduled_date
string<date-time>
captured_date
string<date-time>
paid
boolean
isRefunded
boolean
IsTest
boolean
created_at
string<date-time>
updated_at
string<date-time>
isModifyCatchupPayment
boolean
payment_modifications
string[] | null

Null when the intent has no modifications, not an empty array.

stripe_payment_intent_id
string
attempt_number
integer
original_amount_received
number<double>
refunded_amount
number<double>