v2
latestOpenAPI 3.1.12026-08-078549932.4 MBSubscriptions
post/Subscriptions
Request body
clientIdstring
patientIdstring nullable
groupCodeIdstring
paymentTokenIdstring
startDatestring date
consentTextstring
Snapshot of the agreement text shown to the client at signup.
notesstring nullable
Response
Created
idstring
clientIdstring
clientNamestring nullable
patientIdstring nullable
patientNamestring nullable
groupCodeIdstring
groupCodeNamestring nullable
paymentTokenIdstring
paymentTokenLast4string nullable
paymentTokenBrandstring nullable
statusstring
"Active" | "Paused" | "PastDue" | "Cancelled" | "Completed".
frequencystring
"Weekly" | "BiWeekly" | "Monthly" | "Quarterly" | "Annually".
startDatestring date
nextBillingDatestring date
lastChargedAtstring date-time nullable
endDatestring date-time nullable
lastFailureReasonstring nullable
notesstring nullable
createdAtstring date-time
updatedAtstring date-time