Get Subscription

Get Invoice

GET /subscriptions/{subscription_number}

Resource URL

Test

https://api.sandbox.irembopay.com/payments/invoices/{invoice_reference}

Production

Headers

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

Body

Name	Type	Description
subscription_number	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	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 (BILLING_CANCELLED, etc.).
paymentStatus	enum	Yes	Payment status (NEW, PAID, etc.).
nextDueDate	datetime	Yes	Next invoice due date.
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	Items attached to the subscription.

---

Error codes

HTTP Status	Code/Key	Comment (Description)
400	VALIDATION_ERROR	Invalid identifier format.
401	UNAUTHORIZED	Missing or invalid authentication token.
403	FORBIDDEN	Insufficient permissions
404	NOT_FOUND	Subscription not found.
500	INTERNAL_SERVER_ERROR	Unexpected server error.

---