v1

latestOpenAPI 3.0.12026-07-265331168.0 KB

Service

Edit Service

Allows a user to edit the details of an existing service. This can include changes in payment method, adjusting automatic collection, and marking for cancellation at the end of a period.

patch/public/user/service/edit/{service_id}

Path parameters

service_idstring required

ID of the Service to edit

Headers

Content-Typestring required

Content type for the request body as application/json.

Request body

cancel_commentstring

Comment regarding the cancellation.

cancel_feedbackstring

Feedback reasons for cancellation.

payment_method_idstring

New payment method ID.

service_is_automatic_collectionboolean

Flag to determine if service charge should be automatic.

service_is_pending_cancellationboolean

Indicates if the service should be canceled at the end of the period.

service_metadataobject

Arbitrary metadata object associated with the service. Constraints

Must be a valid, non-nested JSON object.
Maximum 30 keys.
Each value's string representation ≤ 300 characters.
Total size ≤ 32KB.

Response

Successfully edited the service.

editedstring[]

List of service IDs that were successfully edited.

messagestring

Success message.

Example response

{
  "edited": [
    "API-1234-5678"
  ],
  "message": "Service successfully edited."
}