Skip to main content

Pause subscription

METHODURL
POST/subscriptions/{subscriptionId}/pause
EXAMPLEhttps://test.api.macropay.com/v2/subscriptions/{subscriptionId}/pause

Endpoint to pause a subscription.


SUCCESS RESPONSES - PAUSE SUBSCRIPTION

HTTP CODEDESCRIPTION
200Subscription has been paused and the response is in the body in JSON format.

SUCCESS RESPONSE EXAMPLE - PAUSE SUBSCRIPTION

{
"id": "0195146b-fb77-73b4-bb92-ba8bc2180433",
"merchantId": "74d52e64-e807-4d77-bfe2-76f5274febf1",
"planId": "4aa7c1e4-cf8c-4d1c-a6ad-451dd07411ee",
"status": "paused",
"cycle": 1,
"createdAt": "2025-02-17T15:00:12.491953Z",
"modifiedAt": "2025-02-17T15:07:14.095555Z"
}

ERROR RESPONSES - PAUSE SUBSCRIPTION

HTTP CODEERROR CODEERROR MESSAGEDESCRIPTION
5000900Internal Server ErrorThe server experienced an unexpected error.
4040020Subscription not foundSubscription %s not found