Subscription Plans

The subscription plan API allows you to manage the plans that you can subscribe customers to in your business.

Create Subscription Plan

post

This endpoint creates a new subscription plan. You can then create subscribe your customers to these plans and Asyncpay would automatically charge them at the next billing cycle; so you don't need to run any cronjobs or schedulers on your end.

We offer several flexible options for creating recurring charges for your customers. We offer different intervals such as daily, weekly, monthly, quarterly, biannually and annually.

You can also specify a custom trial period if you want customers subscribed in trial mode to have a different duration from the regular billing cycle period. You can set the number of days you want trials to run with the trial_period field.

You can also build on top of our intervals to create truly flexible interval periods with the interval_count field. We calculate your customer's billing cycle by multiplying the interval_count by the interval duration. e.g, if you want your customer's subscription to run every two months, instead of monthly, you can use an interval of monthly, and interval_count of 2. Asyncpay would calculate the billing cycle as 2 * 30, meaning we would charge this customer every 60 days.

Authorizations
Header parameters
AuthenticationstringRequiredExample: Bearer {{APITestSecretKey}}
Body
namestringRequired

The name of the subscription plan. Subscription plan names must be unique within the same business.

intervalstringRequired

How frequently we should charge subscribers to this plan. Supported values are daily, weekly, monthly, quarterly, biannually and annually

amountany ofRequired

The amount we should charge at every billing cycle.

stringOptional
or
numberOptional
currencystring | nullOptional

The currency of the amount we should charge. If this is not set, we would default to the business' base currency

trial_periodintegerRequired

The number of days you want a trial period of this plan to run. If this value is not set, then a trial subscription would run for the default interval period. e.g a monthly plan in trial mode will run in trial for 30 days.

initial_amountany ofOptional

The amount we should charge the customer the first time. After the first billing cycle, we would charge the value you set for the amount on all subsequent billing cycles. An example usecase for this can be domain name registration; where the first year is cheaper than subsequent years.

stringOptional
or
numberOptional
interval_countstringRequired

This field allows you to create very flexible subscription plans. When this field is set, we multiply this value by the interval period to get the next billing date. For instance, if you want to charge your customers every two months; you can set interval_count to 2, and interval to monthly. When we want to calculate the next billing date, we would multiply the interval_count by the interval period, resulting in 60 days. Meaning we would charge the customer every 60 days. The same rule applies to all the intervals.

meta_dataobjectRequired

An arbitrary object to store additional data for the payment request

Responses
201Success
application/json
post
POST /v1/subscription-plans HTTP/1.1
Host: 
Authentication: text
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "name": "Starter",
  "interval": "monthly",
  "amount": "10000",
  "currency": "NGN",
  "trial_period": 30
}
201Success
{
  "message": "Subscription plan created successfully",
  "status": "success",
  "data": {
    "subscription_plan": {
      "uuid": "82b02e0b-34aa-11f0-ac87-92433b0171f7",
      "env_mode": "live",
      "name": "One Piece",
      "tags": null,
      "send_subscription_mails": 1,
      "initial_amount": null,
      "initial_amount_to_usd": null,
      "trial_period": null,
      "amount": "200",
      "amount_to_usd": null,
      "currency": "NGN",
      "interval": "monthly",
      "interval_count": null,
      "link_id": "fv6CGsz6",
      "meta_data": null,
      "status": "active",
      "deleted_at": null,
      "created_at": "2025-05-19T12:12:19.000000Z",
      "updated_at": "2025-05-19T12:12:19.000000Z",
      "total_subscribers": 0,
      "total_subscription_payments": 0,
      "number_of_subscription_payments": 0
    }
  }
}

List Subscription Plans

get

This endpoint provides a paginated list of all the subscription plans that a business has.

Authorizations
Query parameters
pagestringOptional

Defines the page of the subscription plans to fetch

per_pagestringOptional

Defines the number of items to return on each page

Responses
200Success
application/json
get
GET /v1/subscription-plans HTTP/1.1
Host: 
Authentication: YOUR_API_KEY
Accept: */*
200Success
{
  "message": "Subscription plans fetched successfully",
  "status": "success",
  "data": {
    "subscription_plans": [
      {
        "uuid": "82b02e0b-34aa-11f0-ac87-92433b0171f7",
        "env_mode": "live",
        "name": "One Piece",
        "tags": null,
        "send_subscription_mails": 1,
        "initial_amount": null,
        "initial_amount_to_usd": "0.00",
        "trial_period": null,
        "amount": "200",
        "amount_to_usd": "0.12",
        "currency": "NGN",
        "interval": "monthly",
        "interval_count": null,
        "link_id": "fv6CGsz6",
        "meta_data": null,
        "status": "active",
        "deleted_at": null,
        "created_at": "2025-05-19T12:12:19.000000Z",
        "updated_at": "2025-05-19T12:15:05.000000Z",
        "total_subscribers": 0,
        "total_subscription_payments": 0,
        "number_of_subscription_payments": 0
      },
      {
        "uuid": "2897d5ba-34aa-11f0-ac87-92433b0171f7",
        "env_mode": "live",
        "name": "Premium Fniders",
        "tags": null,
        "send_subscription_mails": 1,
        "initial_amount": null,
        "initial_amount_to_usd": "0.00",
        "trial_period": null,
        "amount": "200",
        "amount_to_usd": "0.12",
        "currency": "NGN",
        "interval": "monthly",
        "interval_count": null,
        "link_id": "XU1ybzRX",
        "meta_data": null,
        "status": "active",
        "deleted_at": null,
        "created_at": "2025-05-19T12:09:47.000000Z",
        "updated_at": "2025-05-19T12:10:03.000000Z",
        "total_subscribers": 0,
        "total_subscription_payments": 0,
        "number_of_subscription_payments": 0
      },
      {
        "uuid": "2e09c3a3-b779-11ef-8d1a-621bbad79fdf",
        "env_mode": "live",
        "name": "Paystack Daily Savings",
        "tags": null,
        "send_subscription_mails": 1,
        "initial_amount": null,
        "initial_amount_to_usd": "0.00",
        "trial_period": null,
        "amount": "300",
        "amount_to_usd": "0.35",
        "currency": "NGN",
        "interval": "daily",
        "interval_count": 1,
        "link_id": "19kCgHKm",
        "meta_data": null,
        "status": "active",
        "deleted_at": null,
        "created_at": "2024-12-11T04:34:16.000000Z",
        "updated_at": "2025-05-19T12:21:42.000000Z",
        "total_subscribers": 2,
        "total_subscription_payments": 27000,
        "number_of_subscription_payments": 54
      }
    ]
  }
}

Fetch Subscription Plan

get

This endpoint fetches a single subscription plan from the subscription plan UUID

Authorizations
Path parameters
SubscriptionUUIDstringRequired

The UUID of the subscription plan you want to fetch

Responses
200Success
application/json
get
GET /v1/subscription-plans/{SubscriptionUUID} HTTP/1.1
Host: 
Authentication: YOUR_API_KEY
Accept: */*
200Success
{
  "message": "Subscription plan fetched successfully",
  "status": "success",
  "data": {
    "subscription_plan": {
      "uuid": "2e09c3a3-b779-11ef-8d1a-621bbad79fdf",
      "env_mode": "live",
      "name": "Paystack Daily Savings",
      "tags": null,
      "send_subscription_mails": 1,
      "initial_amount": null,
      "initial_amount_to_usd": "0.00",
      "trial_period": null,
      "amount": "500.00",
      "amount_to_usd": "0.35",
      "currency": "NGN",
      "interval": "daily",
      "interval_count": 1,
      "link_id": "19kCgHKm",
      "meta_data": null,
      "status": "active",
      "deleted_at": null,
      "created_at": "2024-12-11T04:34:16.000000Z",
      "updated_at": "2024-12-11T04:35:02.000000Z",
      "total_subscribers": 2,
      "total_subscription_payments": 27000,
      "number_of_subscription_payments": 54
    }
  }
}

Fetch Subscription Plan Subscriptions

get

This endpoint fetches a paginated list of all the subscriptions (or subscribers) that a subscription plan has.

Authorizations
Path parameters
SubscriptionUUIDstringRequired

The UUID of the subscription plan that you want to fetch the subscriptions for

Responses
200Success
application/json
get
GET /v1/subscription-plans/{SubscriptionUUID}/subscriptions HTTP/1.1
Host: 
Authentication: YOUR_API_KEY
Accept: */*
200Success
{
  "message": "Subscriptions fetched successfully",
  "status": "success",
  "data": {
    "subscriptions": [
      {
        "uuid": "edcb8e04-e2e9-11ef-8d1a-621bbad79fdf",
        "env_mode": "live",
        "status": "terminated",
        "cancelled_at": null,
        "cancellation_completed": 0,
        "cancellation_reason": null,
        "next_payment_at": "2025-02-06",
        "last_successful_payment_at": "2025-02-05 00:00:14",
        "deleted_at": null,
        "created_at": "2025-02-04T11:19:41.000000Z",
        "updated_at": "2025-02-07T00:00:08.000000Z",
        "last_termination_id": null,
        "payments_count": 6,
        "customer": {
          "customer_id": "LIV-7421541e6",
          "uuid": "53145bb4-b778-11ef-8d1a-621bbad79fdf",
          "env_mode": "live",
          "first_name": "Roronoa",
          "last_name": "Zoro",
          "name": null,
          "external_customer_ids": {
            "paystack": 215556634
          },
          "email": "[email protected]",
          "phone_code": "+234",
          "phone_number": "8246578707",
          "address_line_1": "The Going Merry",
          "address_line_2": "The Thousand Sunny",
          "city": "Lagos",
          "state": "Lagos",
          "zip": "101233",
          "country": "Nigeria",
          "meta_data": {
            "uid": "84734",
            "status": "Dignified"
          },
          "deleted_at": null,
          "created_at": "2024-12-11T04:28:08.000000Z",
          "updated_at": "2024-12-11T04:30:28.000000Z",
          "full_name": "Roronoa Zoro"
        }
      },
      {
        "uuid": "a9fbed33-b77a-11ef-8d1a-621bbad79fdf",
        "env_mode": "live",
        "status": "terminated",
        "cancelled_at": "2025-02-04 11:18:34",
        "cancellation_completed": 0,
        "cancellation_reason": "Terminated from endpoint",
        "next_payment_at": "2025-02-05",
        "last_successful_payment_at": "2025-02-04 00:00:11",
        "deleted_at": null,
        "created_at": "2024-12-11T04:44:53.000000Z",
        "updated_at": "2025-02-04T11:18:34.000000Z",
        "last_termination_id": null,
        "payments_count": 53,
        "customer": {
          "customer_id": "LIV-7421541e6",
          "uuid": "53145bb4-b778-11ef-8d1a-621bbad79fdf",
          "env_mode": "live",
          "first_name": null,
          "last_name": null,
          "name": "Monkey D. Luffy",
          "external_customer_ids": null,
          "email": "[email protected]",
          "phone_code": "+234",
          "phone_number": "8242598707",
          "address_line_1": "The Going Merry",
          "address_line_2": "The Thousand Sunny",
          "city": "Lagos",
          "state": "Lagos",
          "zip": "101233",
          "country": "Nigeria",
          "meta_data": null,
          "deleted_at": null,
          "created_at": "2024-12-11T04:28:08.000000Z",
          "updated_at": "2024-12-11T04:30:28.000000Z",
          "full_name": "Monkey D. Luffy"
        }
      }
    ]
  }
}

Activate subscription plan

patch

This endpoint activates a previously deactivated subscription plan.

You cannot subscribe your customers to an inactive subscription plan.

Authorizations
Path parameters
SubscriptionUUIDstringRequired

The UUID of the subscription plan you want to activate.

Responses
201Success
application/json
patch
PATCH /v1/subscription-plans/{SubscriptionUUID}/activate HTTP/1.1
Host: 
Authentication: YOUR_API_KEY
Accept: */*
201Success
{
  "message": "Subscription plan activated successfully",
  "status": "success",
  "data": {
    "subscription_plan": {
      "uuid": "2e09c3a3-b779-11ef-8d1a-621bbad79fdf",
      "env_mode": "live",
      "name": "Paystack Daily Savings",
      "tags": null,
      "send_subscription_mails": 1,
      "initial_amount": null,
      "initial_amount_to_usd": "0.00",
      "trial_period": null,
      "amount": "300",
      "amount_to_usd": "0.35",
      "currency": "NGN",
      "interval": "daily",
      "interval_count": 1,
      "link_id": "19kCgHKm",
      "meta_data": null,
      "status": "active",
      "deleted_at": null,
      "created_at": "2024-12-11T04:34:16.000000Z",
      "updated_at": "2025-05-23T00:25:55.000000Z",
      "total_subscribers": 2,
      "total_subscription_payments": 27000,
      "number_of_subscription_payments": 54,
      "active_subscriptions": []
    }
  }
}

Deactivate Subscription Plan

patch

This endpoint deactivates a subscription plan. When a subscription plan is inactive, you cannot subscribe a customer to the subscription plan.

Authorizations
Path parameters
SubscriptionUUIDstringRequired

The UUID of the subscription plan you want to deactivate

Responses
201Success
application/json
patch
PATCH /v1/subscription-plans/{SubscriptionUUID}/deactivate HTTP/1.1
Host: 
Authentication: YOUR_API_KEY
Accept: */*
201Success
{
  "message": "Subscription plan deactivated successfully",
  "status": "success",
  "data": {
    "subscription_plan": {
      "uuid": "82b02e0b-34aa-11f0-ac87-92433b0171f7",
      "env_mode": "live",
      "name": "One Piece",
      "tags": null,
      "send_subscription_mails": 1,
      "initial_amount": null,
      "initial_amount_to_usd": "0.00",
      "trial_period": null,
      "amount": "200",
      "amount_to_usd": "0.12",
      "currency": "NGN",
      "interval": "monthly",
      "interval_count": null,
      "link_id": "fv6CGsz6",
      "meta_data": null,
      "status": "inactive",
      "deleted_at": null,
      "created_at": "2025-05-19T12:12:19.000000Z",
      "updated_at": "2025-05-23T00:21:10.000000Z",
      "total_subscribers": 0,
      "total_subscription_payments": 0,
      "number_of_subscription_payments": 0,
      "active_subscriptions": []
    }
  }
}

Update Subscription Plan

put

This endpoint updates a subscription plan.

If a plan already has subscriptions attached to it, then updates such as amount, interval, etc, would only take effect on the next billing cycle of the subscribed customer.

N.B. This means that different customers can have the effect of this change at different times, since the change would only take effect when that particular customer's next billing cycle reaches.

Authorizations
Path parameters
SubscriptionUUIDstringRequiredExample: The UUID of the subscription plan you want to update
Header parameters
AuthenticationstringRequiredExample: Bearer {{APITestSecretKey}}
Body
namestring | nullOptional

The name of the subscription plan. Subscription plan names must be unique within the same business.

intervalstring | nullOptional

How frequently we should charge subscribers to this plan. Supported values are daily, weekly, monthly, quarterly, biannually and annually

amountany ofOptional

The amount we should charge at every billing cycle.

stringOptional
or
numberOptional
currencystring | nullOptional

The currency of the amount we should charge. If this is not set, we would default to the business' base currency

trial_periodinteger | nullOptional

The number of days you want a trial period of this plan to run. If this value is not set, then a trial subscription would run for the default interval period. e.g a monthly plan in trial mode will run in trial for 30 days.

initial_amountany ofOptional

The amount we should charge the customer the first time. After the first billing cycle, we would charge the value you set for the amount on all subsequent billing cycles. An example usecase for this can be domain name registration; where the first year is cheaper than subsequent years.

stringOptional
or
numberOptional
interval_countstring | nullOptional

This field allows you to create very flexible subscription plans. When this field is set, we multiply this value by the interval period to get the next billing date. For instance, if you want to charge your customers every two months; you can set interval_count to 2, and interval to monthly. When we want to calculate the next billing date, we would multiply the interval_count by the interval period, resulting in 60 days. Meaning we would charge the customer every 60 days. The same rule applies to all the intervals.

meta_dataobject | nullOptional

An arbitrary object to store additional data for the payment request

Responses
201Success
application/json
put
PUT /v1/subscription-plans/{SubscriptionUUID} HTTP/1.1
Host: 
Authentication: text
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "name": "Daily 2k",
  "interval": "daily",
  "amount": "2000"
}
201Success
{
  "message": "Subscription updated successfully. 2 subscription(s) were affected.",
  "status": "success",
  "data": {
    "subscription_plan": {
      "uuid": "2e09c3a3-b779-11ef-8d1a-621bbad79fdf",
      "env_mode": "live",
      "name": "Paystack Daily Savings",
      "tags": null,
      "send_subscription_mails": 1,
      "initial_amount": null,
      "initial_amount_to_usd": "0.00",
      "trial_period": null,
      "amount": "300",
      "amount_to_usd": "0.35",
      "currency": "NGN",
      "interval": "daily",
      "interval_count": 1,
      "link_id": "19kCgHKm",
      "meta_data": null,
      "status": "active",
      "deleted_at": null,
      "created_at": "2024-12-11T04:34:16.000000Z",
      "updated_at": "2025-05-19T12:21:42.000000Z",
      "total_subscribers": 2,
      "total_subscription_payments": 27000,
      "number_of_subscription_payments": 54
    }
  }
}

Cancel all subscriptions

post

This endpoint cancels all the subscriptions on a subscription plan.

When a subscription plan is cancelled, it is not immediately terminated. It just means that the subscriptions on this plan will be queued to be terminated when the current billing cycle ends for each subscription on this plan.

Authorizations
Path parameters
SubscriptionUUIDstringRequired

The UUID of the subscription plan whose subscritions you want to cancel

Responses
201Success
application/json
post
POST /v1/subscription-plans/{SubscriptionUUID}/cancel-all-subscriptions HTTP/1.1
Host: 
Authentication: YOUR_API_KEY
Accept: */*
201Success
{
  "message": "Subscriptions cancelled successfully. 11 subscriptions were affected.",
  "status": "success",
  "data": {
    "subscriptionPlan": {
      "uuid": "c6c6db15-446b-11ee-80c4-0242ac120006",
      "env_mode": "test",
      "name": "Daily 2k",
      "amount": "2000",
      "currency": "NGN",
      "interval": "daily",
      "collect_phone_numbers": 1,
      "link_id": "CZMWZwZS",
      "status": "active",
      "deleted_at": null,
      "created_at": "2023-08-26T23:53:38.000000Z",
      "updated_at": "2023-10-22T16:19:44.000000Z",
      "total_subscribers": 11,
      "total_subscription_payments": 55000,
      "number_of_subscription_payments": 11,
      "active_subscriptions": [
        {
          "uuid": "af7a93f5-618f-11ee-9875-0242ac140006",
          "env_mode": "test",
          "status": "active",
          "cancelled_at": "2023-10-22 22:12:42",
          "cancellation_completed": 0,
          "cancellation_reason": "Bulk cancellation from subscription plan by business",
          "next_payment_at": "2023-11-02",
          "last_successful_payment_at": "2023-10-03 01:53:44",
          "deleted_at": null,
          "created_at": "2023-10-03T01:53:44.000000Z",
          "updated_at": "2023-10-22T22:12:42.000000Z",
          "customer": {
            "customer_id": "ASY-518517716",
            "uuid": "c1f3f4d6-2d17-11ee-8a50-0242ac120006",
            "env_mode": "test",
            "first_name": "Eric",
            "last_name": "McWinNEr",
            "email": "[email protected]",
            "phone_code": null,
            "phone_number": null,
            "address_line_1": null,
            "address_line_2": null,
            "city": null,
            "state": null,
            "zip": null,
            "country": null,
            "meta_data": null,
            "deleted_at": null,
            "created_at": "2023-07-28T07:24:15.000000Z",
            "updated_at": "2023-10-03T01:49:08.000000Z"
          }
        },
        {
          "uuid": "57c5c131-625a-11ee-9f27-0242ac120006",
          "env_mode": "test",
          "status": "active",
          "cancelled_at": "2023-10-22 22:12:42",
          "cancellation_completed": 0,
          "cancellation_reason": "Bulk cancellation from subscription plan by business",
          "next_payment_at": "2023-11-03",
          "last_successful_payment_at": "2023-10-04 02:04:25",
          "deleted_at": null,
          "created_at": "2023-10-04T02:04:25.000000Z",
          "updated_at": "2023-10-22T22:12:42.000000Z",
          "customer": {
            "customer_id": "ASY-e3b225312",
            "uuid": "ec8adcea-e8f5-11ed-8e78-f23c93777063",
            "env_mode": "test",
            "first_name": null,
            "last_name": null,
            "email": "[email protected]",
            "phone_code": null,
            "phone_number": null,
            "address_line_1": null,
            "address_line_2": null,
            "city": null,
            "state": null,
            "zip": null,
            "country": null,
            "meta_data": null,
            "deleted_at": null,
            "created_at": "2023-05-02T14:30:45.000000Z",
            "updated_at": "2023-10-04T03:45:40.000000Z"
          }
        },
        {
          "uuid": "1c86273e-64a6-11ee-9cc1-0242ac120006",
          "env_mode": "test",
          "status": "active",
          "cancelled_at": "2023-10-22 22:12:42",
          "cancellation_completed": 0,
          "cancellation_reason": "Bulk cancellation from subscription plan by business",
          "next_payment_at": "2023-11-06",
          "last_successful_payment_at": "2023-10-07 00:11:50",
          "deleted_at": null,
          "created_at": "2023-10-07T00:11:50.000000Z",
          "updated_at": "2023-10-22T22:12:42.000000Z",
          "customer": {
            "customer_id": "ASY-8f48c5644",
            "uuid": "d6d8d578-f6ec-11ed-b348-f23c93777063",
            "env_mode": "test",
            "first_name": null,
            "last_name": null,
            "email": "[email protected]",
            "phone_code": null,
            "phone_number": null,
            "address_line_1": null,
            "address_line_2": null,
            "city": null,
            "state": null,
            "zip": null,
            "country": null,
            "meta_data": null,
            "deleted_at": null,
            "created_at": "2023-05-20T09:00:59.000000Z",
            "updated_at": "2023-10-07T00:11:24.000000Z"
          }
        },
        {
          "uuid": "f61314ac-6627-11ee-8cff-0242ac120006",
          "env_mode": "test",
          "status": "active",
          "cancelled_at": "2023-10-22 22:12:42",
          "cancellation_completed": 0,
          "cancellation_reason": "Bulk cancellation from subscription plan by business",
          "next_payment_at": "2023-11-07",
          "last_successful_payment_at": "2023-10-08 22:13:51",
          "deleted_at": null,
          "created_at": "2023-10-08T22:13:51.000000Z",
          "updated_at": "2023-10-22T22:12:42.000000Z",
          "customer": {
            "customer_id": "ASY-a7551158d",
            "uuid": "cfed6f17-e8e0-11ed-8e78-f23c93777063",
            "env_mode": "test",
            "first_name": null,
            "last_name": null,
            "email": "[email protected]",
            "phone_code": null,
            "phone_number": null,
            "address_line_1": null,
            "address_line_2": null,
            "city": null,
            "state": null,
            "zip": null,
            "country": null,
            "meta_data": null,
            "deleted_at": null,
            "created_at": "2023-05-02T11:59:37.000000Z",
            "updated_at": "2023-10-08T22:06:47.000000Z"
          }
        },
        {
          "uuid": "8b33c598-662a-11ee-8cff-0242ac120006",
          "env_mode": "test",
          "status": "active",
          "cancelled_at": "2023-10-22 22:12:42",
          "cancellation_completed": 0,
          "cancellation_reason": "Bulk cancellation from subscription plan by business",
          "next_payment_at": "2023-11-07",
          "last_successful_payment_at": "2023-10-08 22:32:20",
          "deleted_at": null,
          "created_at": "2023-10-08T22:32:20.000000Z",
          "updated_at": "2023-10-22T22:12:42.000000Z",
          "customer": {
            "customer_id": "ASY-3222c6242",
            "uuid": "6ed682c7-662a-11ee-8cff-0242ac120006",
            "env_mode": "test",
            "first_name": "Eric",
            "last_name": "McWinNEr",
            "email": "[email protected]",
            "phone_code": "+234",
            "phone_number": "8114546067",
            "address_line_1": "33 Old Earth Close",
            "address_line_2": "Hell's Gate Open",
            "city": "Lagos",
            "state": "Lagos",
            "zip": "101233",
            "country": "Nigeria",
            "meta_data": {
              "uid": "333483923-dkjfdfkj",
              "status": "Dignified"
            },
            "deleted_at": null,
            "created_at": "2023-10-08T22:31:32.000000Z",
            "updated_at": "2023-10-08T22:32:08.000000Z"
          }
        },
        {
          "uuid": "fa9eeaf5-662a-11ee-8cff-0242ac120006",
          "env_mode": "test",
          "status": "active",
          "cancelled_at": "2023-10-22 22:12:42",
          "cancellation_completed": 0,
          "cancellation_reason": "Bulk cancellation from subscription plan by business",
          "next_payment_at": "2023-11-07",
          "last_successful_payment_at": "2023-10-08 22:35:27",
          "deleted_at": null,
          "created_at": "2023-10-08T22:35:27.000000Z",
          "updated_at": "2023-10-22T22:12:42.000000Z",
          "customer": {
            "customer_id": "ASY-855864327",
            "uuid": "e1c44bfe-662a-11ee-8cff-0242ac120006",
            "env_mode": "test",
            "first_name": "Eric",
            "last_name": "McWinNEr",
            "email": "[email protected]",
            "phone_code": "+234",
            "phone_number": "8114546067",
            "address_line_1": "33 Old Earth Close",
            "address_line_2": "Hell's Gate Open",
            "city": "Lagos",
            "state": "Lagos",
            "zip": "101233",
            "country": "Nigeria",
            "meta_data": {
              "uid": "333483923-dkjfdfkj",
              "status": "Dignified"
            },
            "deleted_at": null,
            "created_at": "2023-10-08T22:34:45.000000Z",
            "updated_at": "2023-10-08T22:35:08.000000Z"
          }
        },
        {
          "uuid": "3d5eb327-662b-11ee-8cff-0242ac120006",
          "env_mode": "test",
          "status": "active",
          "cancelled_at": "2023-10-22 22:12:42",
          "cancellation_completed": 0,
          "cancellation_reason": "Bulk cancellation from subscription plan by business",
          "next_payment_at": "2023-11-07",
          "last_successful_payment_at": "2023-10-08 22:37:19",
          "deleted_at": null,
          "created_at": "2023-10-08T22:37:19.000000Z",
          "updated_at": "2023-10-22T22:12:42.000000Z",
          "customer": {
            "customer_id": "ASY-5632236b2",
            "uuid": "27f8c5c3-662b-11ee-8cff-0242ac120006",
            "env_mode": "test",
            "first_name": "Eric",
            "last_name": "McWinNEr",
            "email": "[email protected]",
            "phone_code": "+234",
            "phone_number": "8114546067",
            "address_line_1": "33 Old Earth Close",
            "address_line_2": "Hell's Gate Open",
            "city": "Lagos",
            "state": "Lagos",
            "zip": "101233",
            "country": "Nigeria",
            "meta_data": {
              "uid": "333483923-dkjfdfkj",
              "status": "Dignified"
            },
            "deleted_at": null,
            "created_at": "2023-10-08T22:36:43.000000Z",
            "updated_at": "2023-10-08T22:37:05.000000Z"
          }
        },
        {
          "uuid": "6bf7476c-662b-11ee-8cff-0242ac120006",
          "env_mode": "test",
          "status": "active",
          "cancelled_at": "2023-10-22 22:12:42",
          "cancellation_completed": 0,
          "cancellation_reason": "Bulk cancellation from subscription plan by business",
          "next_payment_at": "2023-11-07",
          "last_successful_payment_at": "2023-10-08 22:38:37",
          "deleted_at": null,
          "created_at": "2023-10-08T22:38:37.000000Z",
          "updated_at": "2023-10-22T22:12:42.000000Z",
          "customer": {
            "customer_id": "ASY-a2610a4af",
            "uuid": "57233834-662b-11ee-8cff-0242ac120006",
            "env_mode": "test",
            "first_name": "Eric",
            "last_name": "McWinNEr",
            "email": "[email protected]",
            "phone_code": "+234",
            "phone_number": "8114546067",
            "address_line_1": "33 Old Earth Close",
            "address_line_2": "Hell's Gate Open",
            "city": "Lagos",
            "state": "Lagos",
            "zip": "101233",
            "country": "Nigeria",
            "meta_data": {
              "uid": "333483923-dkjfdfkj",
              "status": "Dignified"
            },
            "deleted_at": null,
            "created_at": "2023-10-08T22:38:02.000000Z",
            "updated_at": "2023-10-08T22:38:25.000000Z"
          }
        },
        {
          "uuid": "0ea76929-662d-11ee-8cff-0242ac120006",
          "env_mode": "test",
          "status": "active",
          "cancelled_at": "2023-10-22 22:12:42",
          "cancellation_completed": 0,
          "cancellation_reason": "Bulk cancellation from subscription plan by business",
          "next_payment_at": "2023-11-07",
          "last_successful_payment_at": "2023-10-08 22:50:20",
          "deleted_at": null,
          "created_at": "2023-10-08T22:50:20.000000Z",
          "updated_at": "2023-10-22T22:12:42.000000Z",
          "customer": {
            "customer_id": "ASY-567842634",
            "uuid": "f3fd7d7f-662c-11ee-8cff-0242ac120006",
            "env_mode": "test",
            "first_name": "Eric",
            "last_name": "McWinNEr",
            "email": "[email protected]",
            "phone_code": "+234",
            "phone_number": "8114546067",
            "address_line_1": "33 Old Earth Close",
            "address_line_2": "Hell's Gate Open",
            "city": "Lagos",
            "state": "Lagos",
            "zip": "101233",
            "country": "Nigeria",
            "meta_data": {
              "uid": "333483923-dkjfdfkj",
              "status": "Dignified"
            },
            "deleted_at": null,
            "created_at": "2023-10-08T22:49:35.000000Z",
            "updated_at": "2023-10-08T22:50:08.000000Z"
          }
        },
        {
          "uuid": "2ac4a61d-662e-11ee-8cff-0242ac120006",
          "env_mode": "test",
          "status": "active",
          "cancelled_at": "2023-10-22 22:12:42",
          "cancellation_completed": 0,
          "cancellation_reason": "Bulk cancellation from subscription plan by business",
          "next_payment_at": "2023-11-07",
          "last_successful_payment_at": "2023-10-08 22:58:16",
          "deleted_at": null,
          "created_at": "2023-10-08T22:58:16.000000Z",
          "updated_at": "2023-10-22T22:12:42.000000Z",
          "customer": {
            "customer_id": "ASY-8123873b3",
            "uuid": "0ba3091c-662e-11ee-8cff-0242ac120006",
            "env_mode": "test",
            "first_name": "Eric",
            "last_name": "McWinNEr",
            "email": "[email protected]",
            "phone_code": "+234",
            "phone_number": "8114546067",
            "address_line_1": "33 Old Earth Close",
            "address_line_2": "Hell's Gate Open",
            "city": "Lagos",
            "state": "Lagos",
            "zip": "101233",
            "country": "Nigeria",
            "meta_data": {
              "uid": "333483923-dkjfdfkj",
              "status": "Dignified"
            },
            "deleted_at": null,
            "created_at": "2023-10-08T22:57:24.000000Z",
            "updated_at": "2023-10-08T22:58:05.000000Z"
          }
        },
        {
          "uuid": "b454f183-70c3-11ee-817e-0242ac120006",
          "env_mode": "test",
          "status": "active",
          "cancelled_at": "2023-10-22 22:12:42",
          "cancellation_completed": 0,
          "cancellation_reason": "Bulk cancellation from subscription plan by business",
          "next_payment_at": "2023-11-21",
          "last_successful_payment_at": "2023-10-22 10:13:54",
          "deleted_at": null,
          "created_at": "2023-10-22T10:13:54.000000Z",
          "updated_at": "2023-10-22T22:12:42.000000Z",
          "customer": {
            "customer_id": "ASY-264440423",
            "uuid": "be1358d6-e7c8-11ed-8e78-f23c93777063",
            "env_mode": "test",
            "first_name": "Eric",
            "last_name": "McWinNEr",
            "email": "[email protected]",
            "phone_code": null,
            "phone_number": null,
            "address_line_1": null,
            "address_line_2": null,
            "city": null,
            "state": null,
            "zip": null,
            "country": null,
            "meta_data": null,
            "deleted_at": null,
            "created_at": "2023-05-01T02:34:48.000000Z",
            "updated_at": "2023-10-22T10:11:56.000000Z"
          }
        }
      ]
    },
    "affected_subscriptions": [
      {
        "uuid": "af7a93f5-618f-11ee-9875-0242ac140006",
        "env_mode": "test",
        "status": "active",
        "cancelled_at": "2023-10-22 22:12:42",
        "cancellation_completed": 0,
        "cancellation_reason": "Bulk cancellation from subscription plan by business",
        "next_payment_at": "2023-11-02",
        "last_successful_payment_at": "2023-10-03 01:53:44",
        "deleted_at": null,
        "created_at": "2023-10-03T01:53:44.000000Z",
        "updated_at": "2023-10-22T22:12:42.000000Z",
        "customer": {
          "customer_id": "ASY-518517716",
          "uuid": "c1f3f4d6-2d17-11ee-8a50-0242ac120006",
          "env_mode": "test",
          "first_name": "Eric",
          "last_name": "McWinNEr",
          "email": "[email protected]",
          "phone_code": null,
          "phone_number": null,
          "address_line_1": null,
          "address_line_2": null,
          "city": null,
          "state": null,
          "zip": null,
          "country": null,
          "meta_data": null,
          "deleted_at": null,
          "created_at": "2023-07-28T07:24:15.000000Z",
          "updated_at": "2023-10-03T01:49:08.000000Z"
        }
      },
      {
        "uuid": "57c5c131-625a-11ee-9f27-0242ac120006",
        "env_mode": "test",
        "status": "active",
        "cancelled_at": "2023-10-22 22:12:42",
        "cancellation_completed": 0,
        "cancellation_reason": "Bulk cancellation from subscription plan by business",
        "next_payment_at": "2023-11-03",
        "last_successful_payment_at": "2023-10-04 02:04:25",
        "deleted_at": null,
        "created_at": "2023-10-04T02:04:25.000000Z",
        "updated_at": "2023-10-22T22:12:42.000000Z",
        "customer": {
          "customer_id": "ASY-e3b225312",
          "uuid": "ec8adcea-e8f5-11ed-8e78-f23c93777063",
          "env_mode": "test",
          "first_name": null,
          "last_name": null,
          "email": "[email protected]",
          "phone_code": null,
          "phone_number": null,
          "address_line_1": null,
          "address_line_2": null,
          "city": null,
          "state": null,
          "zip": null,
          "country": null,
          "meta_data": null,
          "deleted_at": null,
          "created_at": "2023-05-02T14:30:45.000000Z",
          "updated_at": "2023-10-04T03:45:40.000000Z"
        }
      },
      {
        "uuid": "1c86273e-64a6-11ee-9cc1-0242ac120006",
        "env_mode": "test",
        "status": "active",
        "cancelled_at": "2023-10-22 22:12:42",
        "cancellation_completed": 0,
        "cancellation_reason": "Bulk cancellation from subscription plan by business",
        "next_payment_at": "2023-11-06",
        "last_successful_payment_at": "2023-10-07 00:11:50",
        "deleted_at": null,
        "created_at": "2023-10-07T00:11:50.000000Z",
        "updated_at": "2023-10-22T22:12:42.000000Z",
        "customer": {
          "customer_id": "ASY-8f48c5644",
          "uuid": "d6d8d578-f6ec-11ed-b348-f23c93777063",
          "env_mode": "test",
          "first_name": null,
          "last_name": null,
          "email": "[email protected]",
          "phone_code": null,
          "phone_number": null,
          "address_line_1": null,
          "address_line_2": null,
          "city": null,
          "state": null,
          "zip": null,
          "country": null,
          "meta_data": null,
          "deleted_at": null,
          "created_at": "2023-05-20T09:00:59.000000Z",
          "updated_at": "2023-10-07T00:11:24.000000Z"
        }
      },
      {
        "uuid": "f61314ac-6627-11ee-8cff-0242ac120006",
        "env_mode": "test",
        "status": "active",
        "cancelled_at": "2023-10-22 22:12:42",
        "cancellation_completed": 0,
        "cancellation_reason": "Bulk cancellation from subscription plan by business",
        "next_payment_at": "2023-11-07",
        "last_successful_payment_at": "2023-10-08 22:13:51",
        "deleted_at": null,
        "created_at": "2023-10-08T22:13:51.000000Z",
        "updated_at": "2023-10-22T22:12:42.000000Z",
        "customer": {
          "customer_id": "ASY-a7551158d",
          "uuid": "cfed6f17-e8e0-11ed-8e78-f23c93777063",
          "env_mode": "test",
          "first_name": null,
          "last_name": null,
          "email": "[email protected]",
          "phone_code": null,
          "phone_number": null,
          "address_line_1": null,
          "address_line_2": null,
          "city": null,
          "state": null,
          "zip": null,
          "country": null,
          "meta_data": null,
          "deleted_at": null,
          "created_at": "2023-05-02T11:59:37.000000Z",
          "updated_at": "2023-10-08T22:06:47.000000Z"
        }
      },
      {
        "uuid": "8b33c598-662a-11ee-8cff-0242ac120006",
        "env_mode": "test",
        "status": "active",
        "cancelled_at": "2023-10-22 22:12:42",
        "cancellation_completed": 0,
        "cancellation_reason": "Bulk cancellation from subscription plan by business",
        "next_payment_at": "2023-11-07",
        "last_successful_payment_at": "2023-10-08 22:32:20",
        "deleted_at": null,
        "created_at": "2023-10-08T22:32:20.000000Z",
        "updated_at": "2023-10-22T22:12:42.000000Z",
        "customer": {
          "customer_id": "ASY-3222c6242",
          "uuid": "6ed682c7-662a-11ee-8cff-0242ac120006",
          "env_mode": "test",
          "first_name": "Eric",
          "last_name": "McWinNEr",
          "email": "[email protected]",
          "phone_code": "+234",
          "phone_number": "8114546067",
          "address_line_1": "33 Old Earth Close",
          "address_line_2": "Hell's Gate Open",
          "city": "Lagos",
          "state": "Lagos",
          "zip": "101233",
          "country": "Nigeria",
          "meta_data": {
            "uid": "333483923-dkjfdfkj",
            "status": "Dignified"
          },
          "deleted_at": null,
          "created_at": "2023-10-08T22:31:32.000000Z",
          "updated_at": "2023-10-08T22:32:08.000000Z"
        }
      },
      {
        "uuid": "fa9eeaf5-662a-11ee-8cff-0242ac120006",
        "env_mode": "test",
        "status": "active",
        "cancelled_at": "2023-10-22 22:12:42",
        "cancellation_completed": 0,
        "cancellation_reason": "Bulk cancellation from subscription plan by business",
        "next_payment_at": "2023-11-07",
        "last_successful_payment_at": "2023-10-08 22:35:27",
        "deleted_at": null,
        "created_at": "2023-10-08T22:35:27.000000Z",
        "updated_at": "2023-10-22T22:12:42.000000Z",
        "customer": {
          "customer_id": "ASY-855864327",
          "uuid": "e1c44bfe-662a-11ee-8cff-0242ac120006",
          "env_mode": "test",
          "first_name": "Eric",
          "last_name": "McWinNEr",
          "email": "[email protected]",
          "phone_code": "+234",
          "phone_number": "8114546067",
          "address_line_1": "33 Old Earth Close",
          "address_line_2": "Hell's Gate Open",
          "city": "Lagos",
          "state": "Lagos",
          "zip": "101233",
          "country": "Nigeria",
          "meta_data": {
            "uid": "333483923-dkjfdfkj",
            "status": "Dignified"
          },
          "deleted_at": null,
          "created_at": "2023-10-08T22:34:45.000000Z",
          "updated_at": "2023-10-08T22:35:08.000000Z"
        }
      },
      {
        "uuid": "3d5eb327-662b-11ee-8cff-0242ac120006",
        "env_mode": "test",
        "status": "active",
        "cancelled_at": "2023-10-22 22:12:42",
        "cancellation_completed": 0,
        "cancellation_reason": "Bulk cancellation from subscription plan by business",
        "next_payment_at": "2023-11-07",
        "last_successful_payment_at": "2023-10-08 22:37:19",
        "deleted_at": null,
        "created_at": "2023-10-08T22:37:19.000000Z",
        "updated_at": "2023-10-22T22:12:42.000000Z",
        "customer": {
          "customer_id": "ASY-5632236b2",
          "uuid": "27f8c5c3-662b-11ee-8cff-0242ac120006",
          "env_mode": "test",
          "first_name": "Eric",
          "last_name": "McWinNEr",
          "email": "[email protected]",
          "phone_code": "+234",
          "phone_number": "8114546067",
          "address_line_1": "33 Old Earth Close",
          "address_line_2": "Hell's Gate Open",
          "city": "Lagos",
          "state": "Lagos",
          "zip": "101233",
          "country": "Nigeria",
          "meta_data": {
            "uid": "333483923-dkjfdfkj",
            "status": "Dignified"
          },
          "deleted_at": null,
          "created_at": "2023-10-08T22:36:43.000000Z",
          "updated_at": "2023-10-08T22:37:05.000000Z"
        }
      },
      {
        "uuid": "6bf7476c-662b-11ee-8cff-0242ac120006",
        "env_mode": "test",
        "status": "active",
        "cancelled_at": "2023-10-22 22:12:42",
        "cancellation_completed": 0,
        "cancellation_reason": "Bulk cancellation from subscription plan by business",
        "next_payment_at": "2023-11-07",
        "last_successful_payment_at": "2023-10-08 22:38:37",
        "deleted_at": null,
        "created_at": "2023-10-08T22:38:37.000000Z",
        "updated_at": "2023-10-22T22:12:42.000000Z",
        "customer": {
          "customer_id": "ASY-a2610a4af",
          "uuid": "57233834-662b-11ee-8cff-0242ac120006",
          "env_mode": "test",
          "first_name": "Eric",
          "last_name": "McWinNEr",
          "email": "[email protected]",
          "phone_code": "+234",
          "phone_number": "8114546067",
          "address_line_1": "33 Old Earth Close",
          "address_line_2": "Hell's Gate Open",
          "city": "Lagos",
          "state": "Lagos",
          "zip": "101233",
          "country": "Nigeria",
          "meta_data": {
            "uid": "333483923-dkjfdfkj",
            "status": "Dignified"
          },
          "deleted_at": null,
          "created_at": "2023-10-08T22:38:02.000000Z",
          "updated_at": "2023-10-08T22:38:25.000000Z"
        }
      },
      {
        "uuid": "0ea76929-662d-11ee-8cff-0242ac120006",
        "env_mode": "test",
        "status": "active",
        "cancelled_at": "2023-10-22 22:12:42",
        "cancellation_completed": 0,
        "cancellation_reason": "Bulk cancellation from subscription plan by business",
        "next_payment_at": "2023-11-07",
        "last_successful_payment_at": "2023-10-08 22:50:20",
        "deleted_at": null,
        "created_at": "2023-10-08T22:50:20.000000Z",
        "updated_at": "2023-10-22T22:12:42.000000Z",
        "customer": {
          "customer_id": "ASY-567842634",
          "uuid": "f3fd7d7f-662c-11ee-8cff-0242ac120006",
          "env_mode": "test",
          "first_name": "Eric",
          "last_name": "McWinNEr",
          "email": "[email protected]",
          "phone_code": "+234",
          "phone_number": "8114546067",
          "address_line_1": "33 Old Earth Close",
          "address_line_2": "Hell's Gate Open",
          "city": "Lagos",
          "state": "Lagos",
          "zip": "101233",
          "country": "Nigeria",
          "meta_data": {
            "uid": "333483923-dkjfdfkj",
            "status": "Dignified"
          },
          "deleted_at": null,
          "created_at": "2023-10-08T22:49:35.000000Z",
          "updated_at": "2023-10-08T22:50:08.000000Z"
        }
      },
      {
        "uuid": "2ac4a61d-662e-11ee-8cff-0242ac120006",
        "env_mode": "test",
        "status": "active",
        "cancelled_at": "2023-10-22 22:12:42",
        "cancellation_completed": 0,
        "cancellation_reason": "Bulk cancellation from subscription plan by business",
        "next_payment_at": "2023-11-07",
        "last_successful_payment_at": "2023-10-08 22:58:16",
        "deleted_at": null,
        "created_at": "2023-10-08T22:58:16.000000Z",
        "updated_at": "2023-10-22T22:12:42.000000Z",
        "customer": {
          "customer_id": "ASY-8123873b3",
          "uuid": "0ba3091c-662e-11ee-8cff-0242ac120006",
          "env_mode": "test",
          "first_name": "Eric",
          "last_name": "McWinNEr",
          "email": "[email protected]",
          "phone_code": "+234",
          "phone_number": "8114546067",
          "address_line_1": "33 Old Earth Close",
          "address_line_2": "Hell's Gate Open",
          "city": "Lagos",
          "state": "Lagos",
          "zip": "101233",
          "country": "Nigeria",
          "meta_data": {
            "uid": "333483923-dkjfdfkj",
            "status": "Dignified"
          },
          "deleted_at": null,
          "created_at": "2023-10-08T22:57:24.000000Z",
          "updated_at": "2023-10-08T22:58:05.000000Z"
        }
      },
      {
        "uuid": "b454f183-70c3-11ee-817e-0242ac120006",
        "env_mode": "test",
        "status": "active",
        "cancelled_at": "2023-10-22 22:12:42",
        "cancellation_completed": 0,
        "cancellation_reason": "Bulk cancellation from subscription plan by business",
        "next_payment_at": "2023-11-21",
        "last_successful_payment_at": "2023-10-22 10:13:54",
        "deleted_at": null,
        "created_at": "2023-10-22T10:13:54.000000Z",
        "updated_at": "2023-10-22T22:12:42.000000Z",
        "customer": {
          "customer_id": "ASY-264440423",
          "uuid": "be1358d6-e7c8-11ed-8e78-f23c93777063",
          "env_mode": "test",
          "first_name": "Eric",
          "last_name": "McWinNEr",
          "email": "[email protected]",
          "phone_code": null,
          "phone_number": null,
          "address_line_1": null,
          "address_line_2": null,
          "city": null,
          "state": null,
          "zip": null,
          "country": null,
          "meta_data": null,
          "deleted_at": null,
          "created_at": "2023-05-01T02:34:48.000000Z",
          "updated_at": "2023-10-22T10:11:56.000000Z"
        }
      }
    ]
  }
}

Fetch Subscription Plan Payments

get

This endpoint fetches all the payments that have been made for a subscription plan.

Authorizations
Path parameters
SubscriptionUUIDstringRequired

The UUID of the subscription plan whose payments you want to fetch.

Responses
200Success
application/json
get
GET /v1/subscription-plans/{SubscriptionUUID}/payments HTTP/1.1
Host: 
Authentication: YOUR_API_KEY
Accept: */*
200Success
{
  "message": "Subscription payments fetched successfully",
  "status": "success",
  "data": {
    "payments": [
      {
        "uuid": "dffd220a-c0c0-11ef-8d1a-621bbad79fdf",
        "env_mode": "live",
        "amount_charged": "500.00",
        "amount_charged_to_usd": "0.35",
        "was_successful": true,
        "failure_message": null,
        "currency": "NGN",
        "created_at": "2024-12-23T00:00:09.000000Z",
        "updated_at": "2024-12-23T00:00:09.000000Z",
        "deleted_at": null,
        "subscription": {
          "uuid": "a9fbed33-b77a-11ef-8d1a-621bbad79fdf",
          "env_mode": "live",
          "status": "terminated",
          "cancelled_at": "2025-02-04 11:18:34",
          "cancellation_completed": 0,
          "cancellation_reason": "Terminated from endpoint",
          "next_payment_at": "2025-02-05",
          "last_successful_payment_at": "2025-02-04 00:00:11",
          "deleted_at": null,
          "created_at": "2024-12-11T04:44:53.000000Z",
          "updated_at": "2025-02-04T11:18:34.000000Z",
          "last_termination_id": null,
          "payments_count": 53,
          "customer": {
            "customer_id": "LIV-7421541e6",
            "uuid": "53145bb4-b778-11ef-8d1a-621bbad79fdf",
            "env_mode": "live",
            "first_name": "Roronoa",
            "last_name": "Zoro",
            "name": null,
            "external_customer_ids": {
              "paystack": 215556634
            },
            "email": "[email protected]",
            "phone_code": "+234",
            "phone_number": "8246578707",
            "address_line_1": "The Going Merry",
            "address_line_2": "The Thousand Sunny",
            "city": "Lagos",
            "state": "Lagos",
            "zip": "101233",
            "country": "Nigeria",
            "meta_data": {
              "uid": "84734",
              "status": "Dignified"
            },
            "deleted_at": null,
            "created_at": "2024-12-11T04:28:08.000000Z",
            "updated_at": "2024-12-11T04:30:28.000000Z",
            "full_name": "Roronoa Zoro"
          }
        }
      },
      {
        "uuid": "b821970f-bff7-11ef-8d1a-621bbad79fdf",
        "env_mode": "live",
        "amount_charged": "500.00",
        "amount_charged_to_usd": "0.35",
        "was_successful": true,
        "failure_message": null,
        "currency": "NGN",
        "created_at": "2024-12-22T00:00:13.000000Z",
        "updated_at": "2024-12-22T00:00:13.000000Z",
        "deleted_at": null,
        "subscription": {
          "uuid": "a9fbed33-b77a-11ef-8d1a-621bbad79fdf",
          "env_mode": "live",
          "status": "terminated",
          "cancelled_at": "2025-02-04 11:18:34",
          "cancellation_completed": 0,
          "cancellation_reason": "Terminated from endpoint",
          "next_payment_at": "2025-02-05",
          "last_successful_payment_at": "2025-02-04 00:00:11",
          "deleted_at": null,
          "created_at": "2024-12-11T04:44:53.000000Z",
          "updated_at": "2025-02-04T11:18:34.000000Z",
          "last_termination_id": null,
          "payments_count": 53,
          "customer": {
            "customer_id": "LIV-7421541e6",
            "uuid": "53145bb4-b778-11ef-8d1a-621bbad79fdf",
            "env_mode": "live",
            "first_name": null,
            "last_name": null,
            "name": "Monkey D. Luffy",
            "external_customer_ids": null,
            "email": "[email protected]",
            "phone_code": "+234",
            "phone_number": "8242598707",
            "address_line_1": "The Going Merry",
            "address_line_2": "The Thousand Sunny",
            "city": "Lagos",
            "state": "Lagos",
            "zip": "101233",
            "country": "Nigeria",
            "meta_data": null,
            "deleted_at": null,
            "created_at": "2024-12-11T04:28:08.000000Z",
            "updated_at": "2024-12-11T04:30:28.000000Z",
            "full_name": "Monkey D. Luffy"
          }
        }
      },
      {
        "uuid": "8cde0138-bf2e-11ef-8d1a-621bbad79fdf",
        "env_mode": "live",
        "amount_charged": "500.00",
        "amount_charged_to_usd": "0.35",
        "was_successful": true,
        "failure_message": null,
        "currency": "NGN",
        "created_at": "2024-12-21T00:00:12.000000Z",
        "updated_at": "2024-12-21T00:00:12.000000Z",
        "deleted_at": null,
        "subscription": {
          "uuid": "a9fbed33-b77a-11ef-8d1a-621bbad79fdf",
          "env_mode": "live",
          "status": "terminated",
          "cancelled_at": "2025-02-04 11:18:34",
          "cancellation_completed": 0,
          "cancellation_reason": "Terminated from endpoint",
          "next_payment_at": "2025-02-05",
          "last_successful_payment_at": "2025-02-04 00:00:11",
          "deleted_at": null,
          "created_at": "2024-12-11T04:44:53.000000Z",
          "updated_at": "2025-02-04T11:18:34.000000Z",
          "last_termination_id": null,
          "payments_count": 53,
          "customer": {
            "customer_id": "LIV-7421541e6",
            "uuid": "53145bb4-b778-11ef-8d1a-621bbad79fdf",
            "env_mode": "live",
            "first_name": "Roronoa",
            "last_name": "Zoro",
            "name": null,
            "external_customer_ids": {
              "paystack": 215556634
            },
            "email": "[email protected]",
            "phone_code": "+234",
            "phone_number": "8246578707",
            "address_line_1": "The Going Merry",
            "address_line_2": "The Thousand Sunny",
            "city": "Lagos",
            "state": "Lagos",
            "zip": "101233",
            "country": "Nigeria",
            "meta_data": {
              "uid": "84734",
              "status": "Dignified"
            },
            "deleted_at": null,
            "created_at": "2024-12-11T04:28:08.000000Z",
            "updated_at": "2024-12-11T04:30:28.000000Z",
            "full_name": "Roronoa Zoro"
          }
        }
      },
      {
        "uuid": "61c99052-be65-11ef-8d1a-621bbad79fdf",
        "env_mode": "live",
        "amount_charged": "500.00",
        "amount_charged_to_usd": "0.35",
        "was_successful": true,
        "failure_message": null,
        "currency": "NGN",
        "created_at": "2024-12-20T00:00:11.000000Z",
        "updated_at": "2024-12-20T00:00:11.000000Z",
        "deleted_at": null,
        "subscription": {
          "uuid": "a9fbed33-b77a-11ef-8d1a-621bbad79fdf",
          "env_mode": "live",
          "status": "terminated",
          "cancelled_at": "2025-02-04 11:18:34",
          "cancellation_completed": 0,
          "cancellation_reason": "Terminated from endpoint",
          "next_payment_at": "2025-02-05",
          "last_successful_payment_at": "2025-02-04 00:00:11",
          "deleted_at": null,
          "created_at": "2024-12-11T04:44:53.000000Z",
          "updated_at": "2025-02-04T11:18:34.000000Z",
          "last_termination_id": null,
          "payments_count": 53,
          "customer": {
            "customer_id": "LIV-7421541e6",
            "uuid": "53145bb4-b778-11ef-8d1a-621bbad79fdf",
            "env_mode": "live",
            "first_name": null,
            "last_name": null,
            "name": "Monkey D. Luffy",
            "external_customer_ids": null,
            "email": "[email protected]",
            "phone_code": "+234",
            "phone_number": "8242598707",
            "address_line_1": "The Going Merry",
            "address_line_2": "The Thousand Sunny",
            "city": "Lagos",
            "state": "Lagos",
            "zip": "101233",
            "country": "Nigeria",
            "meta_data": null,
            "deleted_at": null,
            "created_at": "2024-12-11T04:28:08.000000Z",
            "updated_at": "2024-12-11T04:30:28.000000Z",
            "full_name": "Monkey D. Luffy"
          }
        }
      }
    ]
  }
}

Last updated