New to Corsair? See API access, authentication, and error handling.
Company
get
company.get
Read the company of the authenticated user
Risk: read
data full type
data full type
stats
company.stats
Read the payment stats of the last 30 days with comparisons
Risk: read
Customers
get
customers.get
Read one customer with their subscriptions and payment history
Risk: read
The answer embeds the customer’s subscriptions and payment history.
Output
data full type
data full type
list
customers.list
List customers, most recent first, paged
Risk: read
Ordered chronologically, most recent first; meta.next_page is the next page number or null on the last page.
Output
data full type
data full type
meta full type
meta full type
Payments
list
payments.list
List payments, most recent first, paged
Risk: read
Output
data full type
data full type
meta full type
meta full type
Plans
list
plans.list
List the payment plans, paged
Risk: read
Output
data full type
data full type
meta full type
meta full type
Refunds
create
refunds.create
Refund a payment fully or partially; money leaves the account and the refund cannot be undone
Risk: destructive · Irreversible
Answers 204 with no body. The reason must be one of requested_by_customer, duplicate or fraudulent; the amount uses the payment currency.
Output
Subscriptions
list
subscriptions.list
List subscriptions, most recent payment first, paged
Risk: read
Output
data full type
data full type
meta full type
meta full type
User
get
user.get
Read the authenticated Payhere user
Risk: read
data full type
data full type