Checkouts List
Checkouts List
Query Parameters
q Q
order Order
state CheckoutState
Possible values: [OPEN
, CLOSED
]
An enumeration.
create_date_from date
create_date_to date
update_date_from date
update_date_to date
limit Limit
Possible values: >= 1
Default value: 100
offset Offset
Responses
- 200
OK
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
items object[]
id Id required
create_date date-time required
update_date date-time required
campaign object
id Id required
create_date date-time required
update_date date-time required
title Title required
code Code
type Type required
tags string[] required
supporter object
id Id required
create_date date-time required
image Image
business_name Business Name
first_name First Name
last_name Last Name
email Email
phone Phone
mobile Mobile
job Job
sex Sex
Possible values: [MALE
, FEMALE
]
An enumeration.
date_of_birth date
place_of_birth Place Of Birth
ssn Ssn
vat Vat
address Address
address2 Address2
city City
locality Locality
country Country
postal_code Postal Code
certification_url Certification Url
privacy Privacy
email_marketing Email Marketing
phone_marketing Phone Marketing
sms_marketing Sms Marketing
postal_marketing Postal Marketing
profilation_marketing Profilation Marketing
tags string[] required
note Note
donation object
id Id required
supporter_id Supporter Id required
campaign_id Campaign Id required
code Code required
state DonationState required
Possible values: [draft
, pending
, active
, past_due
, done
, revoked
]
An enumeration.
amount Amount required
frequency Frequency
Possible values: [0
, 12
, 1
]
An enumeration.
note Note
completed_date date-time
create_date date-time required
update_date date-time required
tags string[] required
payment object
id Id required
donation_id Donation Id required
state PaymentState required
Possible values: [PENDING
, PAID
, REFUNDED
, FAILED
]
An enumeration.
amount Amount required
payment_date date-time
payment_method object
id Id required
create_date date-time required
update_date date-time required
processor Processor required
label Label required
stripe_intent_id Stripe Intent Id
create_date date-time required
update_date date-time required
state CheckoutState required
Possible values: [OPEN
, CLOSED
]
An enumeration.
amount Amount
completed_date date-time
frequency Frequency
Possible values: [0
, 12
, 1
]
An enumeration.
payment_method_processor Payment Method Processor
payment_method_label Payment Method Label
payment_method_id Payment Method Id
count Count required
{
"items": [
{
"id": 0,
"create_date": "2024-10-10T15:54:20.335Z",
"update_date": "2024-10-10T15:54:20.335Z",
"campaign": {
"id": 0,
"create_date": "2024-10-10T15:54:20.335Z",
"update_date": "2024-10-10T15:54:20.335Z",
"title": "string",
"code": "string",
"type": "string",
"tags": [
"string"
]
},
"supporter": {
"id": 0,
"create_date": "2024-10-10T15:54:20.335Z",
"image": "string",
"business_name": "string",
"first_name": "string",
"last_name": "string",
"email": "string",
"phone": "string",
"mobile": "string",
"job": "string",
"sex": "MALE",
"date_of_birth": "2024-10-10",
"place_of_birth": "string",
"ssn": "string",
"vat": "string",
"address": "string",
"address2": "string",
"city": "string",
"locality": "string",
"country": "string",
"postal_code": "string",
"certification_url": "string",
"privacy": true,
"email_marketing": true,
"phone_marketing": true,
"sms_marketing": true,
"postal_marketing": true,
"profilation_marketing": true,
"tags": [
"string"
],
"note": "string"
},
"donation": {
"id": 0,
"supporter_id": 0,
"campaign_id": 0,
"code": "string",
"state": "draft",
"amount": 0,
"frequency": 0,
"note": "string",
"completed_date": "2024-10-10T15:54:20.335Z",
"create_date": "2024-10-10T15:54:20.335Z",
"update_date": "2024-10-10T15:54:20.335Z",
"tags": [
"string"
]
},
"payment": {
"id": 0,
"donation_id": 0,
"state": "PENDING",
"amount": 0,
"payment_date": "2024-10-10T15:54:20.335Z",
"payment_method": {
"id": 0,
"create_date": "2024-10-10T15:54:20.335Z",
"update_date": "2024-10-10T15:54:20.335Z",
"processor": "string",
"label": "string"
},
"stripe_intent_id": "string",
"create_date": "2024-10-10T15:54:20.335Z",
"update_date": "2024-10-10T15:54:20.335Z"
},
"state": "OPEN",
"amount": 0,
"completed_date": "2024-10-10T15:54:20.335Z",
"frequency": 0,
"payment_method_processor": "string",
"payment_method_label": "string",
"payment_method_id": 0
}
],
"count": 0
}
Loading...