Sign in

v1

latestOpenAPI 3.0.02026-07-144010.1 KB
Subscriptions

Fetch Subscription Payments

Fetches all subscription payments made against a Subscription item. Developers should use the customer's email address to filter out payments made by a single customer. The creation date can be used to decide whether a customer should be kept on the same plan or downgraded to a lower / free one.

get/subscriptions/{subscriptionId}/payments

Path parameters

subscriptionIdstring required

Subscription ID

Headers

Content-Typestring
Authorizationstring

Response

Successful response

amountnumber

The amount paid by the customer

business_namestring

The name of the business (recipient) the payment was made for

customer_emailstring

The email address of the customer making the payment (subscriber). This is the email address collected by Mamo at checkout

customer_namestring

Customer's full name

customer_first_namestring

Customer's first name

customer_last_namestring

Customer's last name

currency'AED' | 'USD' | 'EUR'

The currency the payment was made in

customer_phonestring

Customer's phone number including the country code

identifierstring

Unique identifier for a payment

payment_purposestring

The reason behind the payment

payment_urlstring

The Subscription url that the subscription was created on

status'confirmation_required' | 'captured' | 'refund_initiated' | 'processing' | 'failed' | 'refunded'

The status of the payment. Captured indicates that the payment was completed successfully and that the funds have been received.

created_atstring

The date the payment was made on

Example response

[
  {
    "amount": 3453,
    "business_name": "Integration Test Business",
    "customer_email": "johns@gmails.com",
    "customer_name": "Johns Sullivan",
    "customer_first_name": "Johns",
    "customer_last_name": "Sullivan",
    "currency": "AED",
    "customer_phone": "+971581234567",
    "gateway_response_code": null,
    "identifier": "MPB-CHRG-894558D35C",
    "payment_purpose": "",
    "payment_url": "https://staging.business.mamopay.com/pay/mybusiness",
    "status": "captured",
    "created_at": "2022-08-17-13-51-42"
  }
]
All 4 operations