Sign in
Subscriptions

post/Subscriptions/{id}/pause

Path parameters

idstring required

Request body

reasonstring nullable

Response

OK

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

Changes

No recorded changes to this endpoint across all 5 revisions of this API.