Cancel Subscription

Updates an existing subscription. All fields are optional; only provided fields will be updated.

Business Rules

• Subscription must exist and be active (not already cancelled).

• Cancellation is immediate; no future invoices will be generated.

• Existing unpaid invoices remain active and can still be paid.

• Subscription status changes to BILLING_CANCELLED.

• Customer receives cancellation notification.

Update an invoice

PUT /payments/subscriptions/{SubscriptionIdentifier}/cancel

Resource URL:

Test

https://api.sandbox.irembopay.com/subscriptions/{subscription_identifier}/cancel

Production

Headers

Name	Value
Content-Type	application/json
irembopay-secretKey	secretKey
X-API-Version	2

Request path parameters

Name	Type	Mandatory?	Comment
subscriptionIdentifier	string	Yes	Subscription identifier (e.g., SU-ABC12345).

Response body payload

For this endpoint, the "data" payload in the response will have the fields below:

Field	Type	Mandatory	Comment (Description)
id	uuid	Yes	Subscription identifier (UUID).
identifier	string	Yes	Human-friendly subscription code (SU-...).
merchantAccountId	uuid	Yes	Merchant account UUID.
customerId	uuid	Yes	Customer UUID.
customerName	string	Yes	Customer full name.
customerEmail	string	No	Customer email.
customerPhoneNumber	string	No	Customer phone.
notificationPreference	enum	Yes	ALL, EMAIL, SMS.
startDate	datetime	Yes	Start datetime.
endDate	datetime	No	End datetime.
frequency	enum	Yes	Billing frequency.
amount	number	Yes	Subscription amount.
currency	enum	Yes	Currency code.
status	enum	Yes	Subscription status.
paymentStatus	enum	Yes	Payment status.
nextDueDate	datetime	Yes	Next invoice due date (recalculated if frequency changed).
subscriptionLinkUrl	string	Yes	Link to subscription checkout/manage page.
remindAfter	number	Yes	Reminder days setting.
createdAt	datetime	Yes	Creation timestamp.
updatedAt	datetime	Yes	Last update timestamp.
subscriptionItems	array	Yes	Updated items attached to the subscription.

---

Open API Sample

Cancel subscription (v2)

post

Cancels an active subscription. Future invoices will not be generated, but existing unpaid invoices remain active. Cancellation is immediate.

Authorizations

apiKeyAuth

X-IREMBOPAY-AUTHORIZATIONstringRequired

Path parameters

identifierstringRequired

Subscription identifier (e.g., SU-ABC12345)

Header parameters

X-API-VersionstringRequired

API version number (e.g., 2)

Default: 2

Body

application/json

reasonstringOptional

Cancellation reason (optional)

Example: Customer requested cancellation

Responses

200

Subscription cancelled successfully

application/json

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Internal server error

application/json

post

/subscriptions/{identifier}/cancel

JSONJavaJavaScriptPython

{
  "reason": "Customer requested cancellation"
}

{
  "message": "Subscription cancelled successfully",
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "identifier": "SU-ABC12345",
    "status": "CANCELLED",
    "cancelledAt": "2024-09-15T14:30:00Z",
    "cancelledBy": "770e8400-e29b-41d4-a716-446655440000",
    "cancellationReason": "Customer requested cancellation",
    "updatedAt": "2024-09-15T14:30:00Z"
  }
}