Skip to main content

API R30

· 2 min read
Craig Herrington

Release 30 of the API includes 2 new endpoints and changes to 5 existing endpoints.

Release Date

The UAT API will be updated on 19-May-2026.

The Live API release date is 26-May-2026.

Times may change without notice, no downtime of the API is expected.

Payment terms fields

The new payment term fields on accounts (payment-term-uuid, payment-term-name, and the optional payment-term-uuid on create and update) relate to new functionality that will ship in an upcoming PIMS release and further API releases.

View Account Spec

Account Management​

CHANGE GET /v1/api/accounts & /v1/api/accounts/:account-uuid

  • The response for each account now includes payment-term-uuid and payment-term-name where payment terms apply.

CHANGE POST /v1/api/accounts

  • Optional field payment-term-uuid added. When omitted, the default payment term from the client category may be applied; when supplied, it must reference an existing active payment term.
  • Creating an account when the contact is deactivated now returns HTTP 422 with message Contact is deactivated.
  • Creating an account when an account already exists for that contact (including when the contact is deactivated) now returns HTTP 422 with message An account already exists for contact instead of overwriting the existing account.

CHANGE PATCH /v1/api/accounts/:account-uuid

  • Optional field payment-term-uuid added. When supplied, it must be an active payment term.
View Billing Spec

Billing​

NEW POST /v1/api/subscriptions/end

  • Ends an active pet health care plan subscription for a patient on an account. Where money is still owed on the plan, write-off details can be supplied to close out the balance.

NEW POST /v1/api/subscriptions/suspend

  • Suspends or resumes a pet health care plan subscription.

CHANGE GET /v1/api/subscriptions

  • Optional query parameter include-balance added (default false). Set it true to include pet-plan-balance on each subscription where applicable for pet health care plans.

If you have any questions please contact us.