Cancel a subscription

Balance

This resource represents your Glomo balance. You can retrieve it to see the current balance on your Glomo account in all currencies enabled for your account.

Operations

Balance Conversions

Balance Conversion resource represents the details of the balance conversion. The balance conversion is the conversion of the balance from one supported currency to another supported currency.

Operations

Payment Link

A payment link is a shareable URL that will take your customers to a Glomo-hosted payment page. The payment page can only be accessed by your customer after the completion of 1FA via their email.

Operations

Orders

This resource represents the order details. The order is the request to receive payment from your customer.

Operations

Customer

This resource represents a customer of your business. The customer can be an individual or a business from whom you will receive payments.

Operations

Document

Document resource represents the documents details uploaded. This document is used in payin, payout, etc.

Operations

Payment

This resource represents a payment attempt made by your customer. The payment can either be successfully completed or failed, depending on various factors.

Operations

Refund

This resource represents a refund transaction from your Glomo account to your customer. You can retrieve it to see the details of the refund transaction.

Operations

Price

This resource represents the pricing details of the payin or payout. The pricing details include the fees and the pricing type

Operations

Subscription

This resource represents a recurring billing agreement for a customer. Subscriptions allow businesses to automatically charge customers on a regular schedule according to a defined billing plan.

Operations

Resume a paused subscription

Request

Resumes a paused subscription. Once resumed, the subscription will continue processing payments according to its original schedule. Only subscriptions in 'paused' status can be resumed.

Security

JWT

Path

idstringrequired

Unique identifier of the subscription to resume

Example: sub_5JU9yv0lGSUP

curl -i -X PATCH \
  https://api.glomopay.com/api/v1/subscriptions/sub_5JU9yv0lGSUP/resume \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Subscription resumed successfully

Bodyapplication/json

idstringrequired

Unique identifier for the subscription.

Example: "sub_5JU9yv0lGSUP"

customer_idstringrequired

Unique identifier of the customer associated with this subscription.

Example: "cust_5JU9yv0lGSUP"

product_namestringrequired

Name of the product being subscribed to.

Example: "ShieldGuard Insurance"

product_descriptionstringrequired

Description of the product.

Example: "Flexible, monthly insurance for belongings, travel, and digital assets; easy to manage"

plan_namestring

Name of the subscription plan.

Example: "ShieldGuard Lite"

plan_descriptionstring

Description of the subscription plan.

Example: "Simple, monthly insurance plan that covers your basic belongings and key digital assets"

statusstringrequired

Current status of the subscription.

Enum"created""active""paused""expired""failed""halted""cancelled""completed"

Example: "active"

amountnumber(Amount)required

The amount in the smallest currency unit. For example, if the amount is $299.00, then 29900 is passed in this field. In the case of three decimal currencies, such as KWD, BHD and OMR, to represent an amount of 295.991, pass the value as 295990. And in the case of zero decimal currencies such as JPY, for amount ￥295, pass the value as 295.

currencystring(iso-4217)(Currency)required

The currency code in ISO 4217 format.

interval_typestring(IntervalType)required

Used in combination with interval_count to define the billing cycle frequency.

Enum"month""year"

interval_countinteger(IntervalCount)required

Number of intervals between a billing cycle, used in combination with interval_type. Valid combinations:

Monthly: interval_type='month', interval_count=1
Quarterly: interval_type='month', interval_count=3
Half-yearly: interval_type='month', interval_count=6
Yearly: interval_type='year', interval_count=1

Enum136

billing_cyclesintegerrequired

Total number of billing cycles for the subscription.

Example: 12

start_datestring(date)required

Start date of the subscription in UTC timezone and ISO 8601 format (YYYY-MM-DD).

Example: "2025-01-01"

end_datestring(date)required

The date on which the subscription ends in UTC timezone and ISO 8601 format (YYYY-MM-DD).

Example: "2025-12-01"

expires_atstring(date)required

Expiration date for the subscription payment link in UTC timezone and ISO 8601 format (YYYY-MM-DD).

Example: "2025-01-07"

next_payment_datestring or null(date)

Date of the next scheduled payment in UTC timezone and ISO 8601 format (YYYY-MM-DD).

Example: "2025-02-01"

subscription_link_urlstring(uri)required

URL for the subscription payment page. Your customer can use this URL to make the first payment and activate the subscription.

Example: "https://checkout.glomopay.com/subscription/sub_5JU9yv0lGSUP"

cancelled_atstring or null(date)

Date when the subscription was cancelled in UTC timezone and ISO 8601 format (YYYY-MM-DD). This field is null unless the subscription status is 'cancelled'.

Example: "2025-01-15"

Response

application/json

{
  "id": "sub_5JU9yv0lGSUP",
  "customer_id": "cust_5JU9yv0lGSUP",
  "product_name": "ShieldGuard Insurance",
  "product_description": "Flexible, monthly insurance for belongings, travel, and digital assets; easy to manage",
  "plan_name": "ShieldGuard Lite",
  "plan_description": "Simple, monthly insurance plan that covers your basic belongings and key digital assets",
  "status": "active",
  "amount": 1000,
  "currency": "USD",
  "interval_type": "month",
  "interval_count": 1,
  "billing_cycles": 12,
  "start_date": "2025-01-01",
  "end_date": "2025-12-01",
  "expires_at": "2025-01-07",
  "next_payment_date": "2025-02-01",
  "subscription_link_url": "https://checkout.glomopay.com/subscription/sub_5JU9yv0lGSUP",
  "cancelled_at": "2025-01-15"
}

Cancel a subscription

Request

Cancels a subscription. Once cancelled, the subscription will stop processing future payments. This action cannot be undone, but you can create a new subscription if needed.

Security

JWT

Path

idstringrequired

Unique identifier of the subscription to cancel

Example: sub_5JU9yv0lGSUP

curl -i -X PATCH \
  https://api.glomopay.com/api/v1/subscriptions/sub_5JU9yv0lGSUP/cancel \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Subscription cancelled successfully

Bodyapplication/json

idstringrequired

Unique identifier for the subscription.

Example: "sub_5JU9yv0lGSUP"

customer_idstringrequired

Unique identifier of the customer associated with this subscription.

Example: "cust_5JU9yv0lGSUP"

product_namestringrequired

Name of the product being subscribed to.

Example: "ShieldGuard Insurance"

product_descriptionstringrequired

Description of the product.

Example: "Flexible, monthly insurance for belongings, travel, and digital assets; easy to manage"

plan_namestring

Name of the subscription plan.

Example: "ShieldGuard Lite"

plan_descriptionstring

Description of the subscription plan.

Example: "Simple, monthly insurance plan that covers your basic belongings and key digital assets"

statusstringrequired

Current status of the subscription.

Enum"created""active""paused""expired""failed""halted""cancelled""completed"

Example: "cancelled"

amountnumber(Amount)required

The amount in the smallest currency unit. For example, if the amount is $299.00, then 29900 is passed in this field. In the case of three decimal currencies, such as KWD, BHD and OMR, to represent an amount of 295.991, pass the value as 295990. And in the case of zero decimal currencies such as JPY, for amount ￥295, pass the value as 295.

currencystring(iso-4217)(Currency)required

The currency code in ISO 4217 format.

interval_typestring(IntervalType)required

Used in combination with interval_count to define the billing cycle frequency.

Enum"month""year"

interval_countinteger(IntervalCount)required

Number of intervals between a billing cycle, used in combination with interval_type. Valid combinations:

Monthly: interval_type='month', interval_count=1
Quarterly: interval_type='month', interval_count=3
Half-yearly: interval_type='month', interval_count=6
Yearly: interval_type='year', interval_count=1

Enum136

billing_cyclesintegerrequired

Total number of billing cycles for the subscription.

Example: 12

start_datestring(date)required

Start date of the subscription in UTC timezone and ISO 8601 format (YYYY-MM-DD).

Example: "2025-01-01"

end_datestring(date)required

The date on which the subscription ends in UTC timezone and ISO 8601 format (YYYY-MM-DD).

Example: "2025-12-01"

expires_atstring(date)required

Expiration date for the subscription payment link in UTC timezone and ISO 8601 format (YYYY-MM-DD).

Example: "2025-01-07"

next_payment_datestring or null(date)

Date of the next scheduled payment in UTC timezone and ISO 8601 format (YYYY-MM-DD).

Example: null

subscription_link_urlstring(uri)required

URL for the subscription payment page. Your customer can use this URL to make the first payment and activate the subscription.

Example: "https://checkout.glomopay.com/subscription/sub_5JU9yv0lGSUP"

cancelled_atstring or null(date)

Date when the subscription was cancelled in UTC timezone and ISO 8601 format (YYYY-MM-DD). This field is null unless the subscription status is 'cancelled'.

Example: "2025-01-15"

Response

application/json

{
  "id": "sub_5JU9yv0lGSUP",
  "customer_id": "cust_5JU9yv0lGSUP",
  "product_name": "ShieldGuard Insurance",
  "product_description": "Flexible, monthly insurance for belongings, travel, and digital assets; easy to manage",
  "plan_name": "ShieldGuard Lite",
  "plan_description": "Simple, monthly insurance plan that covers your basic belongings and key digital assets",
  "status": "cancelled",
  "amount": 1000,
  "currency": "USD",
  "interval_type": "month",
  "interval_count": 1,
  "billing_cycles": 12,
  "start_date": "2025-01-01",
  "end_date": "2025-12-01",
  "expires_at": "2025-01-07",
  "next_payment_date": null,
  "subscription_link_url": "https://checkout.glomopay.com/subscription/sub_5JU9yv0lGSUP",
  "cancelled_at": "2025-01-15"
}

Payout

This resource represents the disbursement transactions from your Glomo account to your beneficiaries.

Operations

Beneficiary

This resource represents a payee of a payout initiated by your business. The beneficiary can be an individual or a business to whom you will send funds.

Operations

Bank Account Validation

Bank Account Validation resource represents the validation details of a bank account.

Operations

Withdrawal

This resource represents the withdrawal transaction from your Glomo account to your withdrawal account.

Operations

Withdrawal Account

This resource represents the withdrawal account details. The withdrawal account is the bank account where the withdrawal amount will be credited.

Operations

Settlement

This resource represents the settlement details. The settlement is the process of transferring funds from your Glomo account to your bank account.

Operations

API specification for Glomo (1.0.0)

Balance

Balance Conversions

Payment Link

Orders

Customer

Document

Payment

Refund

Price

Subscription

Resume a paused subscription

Request

Responses

Was this helpful?

Cancel a subscription

Request

Responses

Was this helpful?

Payout

Beneficiary

Bank Account Validation

Withdrawal

Withdrawal Account

Settlement