Skip to main content
POST
List Cancellation Payment Intents

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
organization
string
required
limit
integer<int32>
required
offset
integer<int32>
required
id
string
subscription_id
string
pet_id
string
created_at_since
string<date-time>
updated_at_since
string<date-time>
created_before
string<date-time>
updated_before
string<date-time>

Response

200 - application/json

A list of cancellation payment intents

id
string
clinic_name
string
clinic_id
string
date
string<date-time>
discounted
boolean
discounted_amount
number<double>
new_price
number<double>
percent_discount
number<double>
pet
string
subscription
string
wellnes_plan_name
string

Wellness plan name. Note: field is spelled with a single 's' (wellnes_plan_name) in the API response.

payments
number<double>
payment_amount
number<double>
payment_or_refund
string
Example:

"Payment to cancel"

paymentIntent_or_refund_id
string | null
total_benefits_consumed_at_retail_price
number<double> | null
total_benefits_consumed_at_discounted_price
number<double> | null
reason
string
early_cancellation_fee
number<double>
refund_ids
string[]
isSucceeded
boolean
IsTest
boolean
created_at
string<date-time>
updated_at
string<date-time>