Section

REST API

Note
Please use SWAGGER to get detailed information of parameters. Your URL looks like, i.e. rest/v1/subscriptions https://subscribenow.m2.demo.magedelight.com/swagger

Panel

Customer Balance

Panel

/ewallet/customer

Sample Data: {
"wallet":"",
"customer":"2"
}

Get Subscription Details

Panel
/subscription/{subscriptionId}

Note
Please use searchCriteria params to retrieve records.

Create Subscriptions

Panel

/subscription/create

Sample Data

Expand

{
 "productSubscribers": {
      "profile_id": "API_1",
      "customer_id": "2",
      "product_id": "1",
      "subscriber_name": "John Doe",
      "subscriber_email": "sample@magedelight.com",
      "store_id": "1",
      "payment_method_code": "cashondelivery",
      "subscription_start_date": "2019-05-10",
      "billing_period_label": "Daily",
      "billing_period": "1",
      "billing_frequency": "2",
      "period_max_cycles": "5",
      "billing_amount": "50",
      "trial_period_label": null,
      "trial_period_unit": null,
      "trial_period_frequency": 0,
      "trial_period_max_cycles": 0,
      "trial_billing_amount": null,
      "currency_code": "USD",
      "shipping_amount": "2",
      "tax_amount": "2",
      "initial_amount": "2",
      "discount_amount": "12",
      "order_item_info": {
           "options": {
                "_1": "subscription"
            },
           "subscription_start_date": "2019-05-10",
           "qty": "1"
     },
     "additional_info": {
          "product_sku": "24-MB01",
          "shipping_title": "Flat Rate - Fixed"
     },
     "subscription_status": "1",
     "next_occurrence_date": "2019-05-12",
     "last_bill_date": "2019-05-10",
     "payment_token": "",
     "base_currency_code": "USD",
     "base_billing_amount": "39",
     "base_trial_billing_amount": "3",
     "base_shipping_amount": "2",
     "base_tax_amount": "1",
     "base_initial_amount": "2",
     "base_discount_amount": "12",
     "billing_address_id": "1",
     "shipping_address_id": "1",
     "is_trial": "0",
     "shipping_method_code": "flatrate_flatrate",
     "product_name": "joust",
     "payment_title": "Cash on delivery"
     }
}

Create Subscription from Order

Panel
/subscription/create-by-order/{orderId}

Skip Subscription

Panel
/subscription/skip

Pause Subscription

Panel
/subscription/pause

Resume Subscription

Panel
/subscription/resume

Cancel Subscription

Panel
/subscription/cancel

Update Subscription

Panel

/subscription/update

Sample Data

Expand

{
      "subscriptionId": 101,
      "modifiedby": 0,
      "subscription": {
           "qty": "1",
           "subscription_start_date": "2019-12-25",
           "md_savecard": "paymentToken",
           "md_billing_address": "1",
           "md_shipping_address": "1"
      }
}

Product Details Page

Panel

You will get subscription details from Magento's default product API /products/{sku} get subscription data from "custom_attributes" node.

While posting data, you have to pass below subscription parameters from product details page,

Subscription Product Type: options[_1] with value "nosubscription" or "subscription"
billing_period
subscription_start_date

Section

GraphQL

Get Subscriptions

Panel

Request

Expand

{
getSubscriptions(subscriptionId: 1) {
subscription_id
profile_id
customer_id
product_id
product_sku
subscriber_name
subscriber_email
store_id
payment_method_code
subscription_start_date
suspension_threshold
billing_period_label
billing_period
billing_frequency
period_max_cycles
billing_amount
trial_period_label
trial_period_unit
trial_period_frequency
trial_period_max_cycles
trial_billing_amount
currency_code
shipping_amount
tax_amount
initial_amount
discount_amount
subscription_status
subscription_item_info
created_at
updated_at
next_occurrence_date
last_bill_date
trial_count
payment_token
total_bill_count
base_currency_code
base_billing_amount
base_trial_billing_amount
base_shipping_amount
base_tax_amount
base_initial_amount
base_discount_amount
initial_order_id
billing_address_id
shipping_address_id
is_trial
shipping_method_code
product_name
payment_title
billing_frequency_cycle
is_update_billing_frequency
order_item_info
additional_info
order_info
}
}

Response

Expand

{
"data": {
"getSubscriptions": {
"subscription_id": 1,
"profile_id": 100000001,
"customer_id": 1,
"product_id": 2041,
"product_sku": "KT Channel Subscription",
"subscriber_name": "Veronica Costello",
"subscriber_email": "roni_cost@example.com",
"store_id": 1,
"payment_method_code": "adyen_cc",
"subscription_start_date": "2022-04-22 11:09:30",
"suspension_threshold": 0,
"billing_period_label": "15 Days",
"billing_period": 1,
"billing_frequency": 15,
"period_max_cycles": 50,
"billing_amount": 1490,
"trial_period_label": "",
"trial_period_unit": "0",
"trial_period_frequency": 0,
"trial_period_max_cycles": null,
"trial_billing_amount": "0.0000",
"currency_code": "USD",
"shipping_amount": "5.0000",
"tax_amount": "98.3400",
"initial_amount": "100.0000",
"discount_amount": "10.0000",
"subscription_status": "1",
"subscription_item_info": "[]",
"created_at": "2022-04-22 11:09:30",
"updated_at": "2022-04-22 11:09:30",
"next_occurrence_date": "2022-05-07 11:09:30",
"last_bill_date": "2022-04-22 11:09:30",
"trial_count": 0,
"payment_token": "0:3:jQuL+UX1Ptf",
"total_bill_count": 1,
"base_currency_code": "USD",
"base_billing_amount": "1490.0000",
"base_trial_billing_amount": "0.0000",
"base_shipping_amount": "5.0000",
"base_tax_amount": "98.3400",
"base_initial_amount": "100.0000",
"base_discount_amount": "10.0000",
"initial_order_id": "000000004",
"billing_address_id": "1",
"shipping_address_id": "1",
"is_trial": "0",
"shipping_method_code": "flatrate_flatrate",
"product_name": "KT Channel Subscription",
"payment_title": "Credit Card",
"billing_frequency_cycle": "_1650610816454_454",
"is_update_billing_frequency": "0",
"order_item_info": "{\"uenc\":\"aHR0cDovL21hZ2VudGcuaHRtbA,,\",\"product\":\"2041\",\"qty\":1,\"options\":{\"_1\":\"subscription\"},\"subscription_start_date\":\"2022-04-22\",\"original_qty\":1}",
"additional_info": "{\"shipping_title\":\"Flat Rate - Fixed\",\"product_options\":[]}",
"order_info": "[]"
}
}
}

Get Subscriptions By Customer ID

Panel

Request

Expand

{
getSubscriptionsByCustomerId(
currentPage: 1
pageSize: 1
){
total_count
items{
subscription_id
profile_id
customer_id
product_id
product_sku
subscriber_name
subscriber_email
store_id
payment_method_code
subscription_start_date
suspension_threshold
billing_period_label
billing_period
billing_frequency
period_max_cycles
billing_amount
trial_period_label
trial_period_unit
trial_period_frequency
trial_period_max_cycles
trial_billing_amount
currency_code
shipping_amount
tax_amount
initial_amount
discount_amount
subscription_status
subscription_item_info
created_at
updated_at
next_occurrence_date
last_bill_date
trial_count
payment_token
total_bill_count
base_currency_code
base_billing_amount
base_trial_billing_amount
base_shipping_amount
base_tax_amount
base_initial_amount
base_discount_amount
initial_order_id
billing_address_id
shipping_address_id
is_trial
shipping_method_code
product_name
payment_title
billing_frequency_cycle
is_update_billing_frequency
order_item_info
additional_info
order_info
}
}
}

Response

Expand

{
"data": {
"getSubscriptionsByCustomerId": {
"total_count": 2,
"items": [
{
"subscription_id": 1,
"profile_id": 100000001,
"customer_id": 1,
"product_id": 2041,
"product_sku": "KT Channel Subscription",
"subscriber_name": "Veronica Costello",
"subscriber_email": "roni_cost@example.com",
"store_id": 1,
"payment_method_code": "adyen_cc",
"subscription_start_date": "2022-04-22 11:09:30",
"suspension_threshold": 0,
"billing_period_label": "15 Days",
"billing_period": 1,
"billing_frequency": 15,
"period_max_cycles": 50,
"billing_amount": 1490,
"trial_period_label": "",
"trial_period_unit": "0",
"trial_period_frequency": 0,
"trial_period_max_cycles": null,
"trial_billing_amount": "0.0000",
"currency_code": "USD",
"shipping_amount": "5.0000",
"tax_amount": "98.3400",
"initial_amount": "100.0000",
"discount_amount": "10.0000",
"subscription_status": "1",
"subscription_item_info": "null",
"created_at": "2022-04-22 11:09:30",
"updated_at": "2022-04-22 11:09:30",
"next_occurrence_date": "2022-05-07 11:09:30",
"last_bill_date": "2022-04-22 11:09:30",
"trial_count": 0,
"payment_token": "0:3:jQuL+UX1PtfGVxscLFAeyatIJb4WE=",
"total_bill_count": 1,
"base_currency_code": "USD",
"base_billing_amount": "1490.0000",
"base_trial_billing_amount": "0.0000",
"base_shipping_amount": "5.0000",
"base_tax_amount": "98.3400",
"base_initial_amount": "100.0000",
"base_discount_amount": "10.0000",
"initial_order_id": "000000004",
"billing_address_id": "1",
"shipping_address_id": "1",
"is_trial": "0",
"shipping_method_code": "flatrate_flatrate",
"product_name": "KT Channel Subscription",
"payment_title": "Credit Card",
"billing_frequency_cycle": "_1650610816454_454",
"is_update_billing_frequency": "0",
"order_item_info": "{\"uenc\":\"aHR0cDovL21hZ2HRtbA,,\",\"product\":\"2041\",\"qty\":1,\"options\":{\"_1\":\"subscription\"},\"subscription_start_date\":\"2022-04-22\",\"original_qty\":1}",
"additional_info": "{\"shipping_title\":\"Flat Rate - Fixed\",\"product_options\":[]}",
"order_info": "null"
}
]
}
}
}

Pause Subscription

Panel

Request

Expand
mutation { pauseSubscription( subscriptionId: 1 ) { success message } }

Response

Expand
{ "data": { "pauseSubscription": { "success": true, "message": "Subscription successfully paused" } } }

Section

Migration Steps

Warning
Subscribe now v. 100.x.x is now deprecated and we have launched new upgraded version v.200.x.x hence we do not provide support for deprecated versions.

Panel
Step 1: Take a full backup of your site with database

Panel
Step 2: Remove/Delete old Subscribe Now extension source code (i.e. app/code/Magedelight/Subscribenow).

Panel
Step 3: Extract new Subscribe Now extension to the same directory where you were having older one (i.e. app/code/Magedelight/Subscribenow).

Panel

Step 4: Run below commands,

php -f bin/magento setup:upgrade

php -f bin/magento setup:di:compile

php -f bin/magento setup:static-content:deploy

Panel

Step 5: Run migration command to make your old extension version compatible with our new extension version,

php bin/magento md:subscribenow:upgrade

...

Space shortcuts

Page tree

Versions Compared

Old Version 81

New Version Current

Key

REST API

Customer Balance

Get Subscription Details

Create Subscriptions

Create Subscription from Order

Skip Subscription

Pause Subscription

Resume Subscription

Cancel Subscription

Update Subscription

Product Details Page

GraphQL

Migration Steps

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 81

New Version Current

Key

REST API

Customer Balance

Get Subscription Details

Create Subscriptions

Create Subscription from Order

Skip Subscription

Pause Subscription

Resume Subscription

Cancel Subscription

Update Subscription

Product Details Page

GraphQL

Migration Steps