Get Subscription List

GET

merchant

subscription

list

curl --request GET \
  --url https://api.unibee.top/merchant/subscription/list \
  --header 'Authorization: Bearer <token>'

{
  "code": 123,
  "data": {
    "subscriptions": [
      {
        "addonParams": [
          {
            "addonPlanId": 123,
            "quantity": 123
          }
        ],
        "addons": [
          {
            "addonPlan": {
              "amount": 123,
              "bindingAddonIds": "<string>",
              "bindingOnetimeAddonIds": "<string>",
              "cancelAtTrialEnd": 123,
              "checkoutUrl": "<string>",
              "createTime": 123,
              "currency": "<string>",
              "description": "<string>",
              "disableAutoCharge": 123,
              "externalPlanId": "<string>",
              "extraMetricData": "<string>",
              "gasPayer": "<string>",
              "homeUrl": "<string>",
              "id": 123,
              "imageUrl": "<string>",
              "internalName": "<string>",
              "intervalCount": 123,
              "intervalUnit": "<string>",
              "merchantId": 123,
              "metadata": {},
              "metricLimits": [
                {
                  "metricId": 123,
                  "metricLimit": 123
                }
              ],
              "metricMeteredCharge": [
                {
                  "chargeType": 123,
                  "graduatedAmounts": [
                    {
                      "endValue": 123,
                      "flatAmount": 123,
                      "perAmount": 123,
                      "startValue": 123
                    }
                  ],
                  "metricId": 123,
                  "standardAmount": 123,
                  "standardStartValue": 123
                }
              ],
              "metricRecurringCharge": [
                {
                  "chargeType": 123,
                  "graduatedAmounts": [
                    {
                      "endValue": 123,
                      "flatAmount": 123,
                      "perAmount": 123,
                      "startValue": 123
                    }
                  ],
                  "metricId": 123,
                  "standardAmount": 123,
                  "standardStartValue": 123
                }
              ],
              "planName": "<string>",
              "productId": 123,
              "publishStatus": 123,
              "status": 123,
              "taxPercentage": 123,
              "trialAmount": 123,
              "trialDemand": "<string>",
              "trialDurationTime": 123,
              "type": 123
            },
            "quantity": 123
          }
        ],
        "dayLeft": 123,
        "discount": {
          "advance": true,
          "billingType": 123,
          "code": "<string>",
          "createTime": 123,
          "currency": "<string>",
          "cycleLimit": 123,
          "discountAmount": 123,
          "discountPercentage": 123,
          "discountType": 123,
          "endTime": 123,
          "id": 123,
          "isDeleted": 123,
          "merchantId": 123,
          "metadata": {},
          "name": "<string>",
          "planApplyType": 123,
          "planIds": [
            123
          ],
          "quantity": 123,
          "startTime": 123,
          "status": 123,
          "upgradeLongerOnly": true,
          "upgradeOnly": true,
          "userLimit": 123,
          "userScope": 123
        },
        "gateway": {
          "IsSetupFinished": true,
          "archive": true,
          "autoChargeEnabled": true,
          "bank": {
            "accountHolder": "<string>",
            "address": "<string>",
            "bic": "<string>",
            "iban": "<string>"
          },
          "countryConfig": {},
          "createTime": 123,
          "currency": "<string>",
          "currencyExchange": [
            {
              "exchange_rate": 123,
              "from_currency": "<string>",
              "to_currency": "<string>"
            }
          ],
          "currencyExchangeEnabled": true,
          "description": "<string>",
          "displayName": "<string>",
          "gatewayIcons": [
            "<string>"
          ],
          "gatewayId": 123,
          "gatewayKey": "<string>",
          "gatewayLogo": "<string>",
          "gatewayName": "<string>",
          "gatewayPaymentTypes": [
            {
              "autoCharge": true,
              "category": "<string>",
              "countryName": "<string>",
              "name": "<string>",
              "paymentType": "<string>"
            }
          ],
          "gatewaySecret": "<string>",
          "gatewayType": 123,
          "gatewayWebhookIntegrationLink": "<string>",
          "gatewayWebsiteLink": "<string>",
          "minimumAmount": 123,
          "name": "<string>",
          "privateSecretName": "<string>",
          "publicKeyName": "<string>",
          "setupGatewayPaymentTypes": [
            {
              "autoCharge": true,
              "category": "<string>",
              "countryName": "<string>",
              "name": "<string>",
              "paymentType": "<string>"
            }
          ],
          "sort": 123,
          "subGateway": "<string>",
          "subGatewayName": "<string>",
          "webhookEndpointUrl": "<string>",
          "webhookSecret": "<string>"
        },
        "latestInvoice": {
          "autoCharge": true,
          "billingCycleAnchor": 123,
          "bizType": 123,
          "countryCode": "<string>",
          "createFrom": "<string>",
          "creditAccount": {
            "amount": 123,
            "createTime": 123,
            "currency": "<string>",
            "currencyAmount": 123,
            "exchangeRate": 123,
            "id": 123,
            "payoutEnable": 123,
            "rechargeEnable": 123,
            "totalDecrementAmount": 123,
            "totalIncrementAmount": 123,
            "type": 123,
            "userId": 123
          },
          "creditPayout": {
            "creditAmount": 123,
            "currencyAmount": 123,
            "exchangeRate": 123
          },
          "cryptoAmount": 123,
          "cryptoCurrency": "<string>",
          "currency": "<string>",
          "data": "<string>",
          "dayUtilDue": 123,
          "discount": {
            "advance": true,
            "billingType": 123,
            "code": "<string>",
            "createTime": 123,
            "currency": "<string>",
            "cycleLimit": 123,
            "discountAmount": 123,
            "discountPercentage": 123,
            "discountType": 123,
            "endTime": 123,
            "id": 123,
            "isDeleted": 123,
            "merchantId": 123,
            "metadata": {},
            "name": "<string>",
            "planApplyType": 123,
            "planIds": [
              123
            ],
            "quantity": 123,
            "startTime": 123,
            "status": 123,
            "upgradeLongerOnly": true,
            "upgradeOnly": true,
            "userLimit": 123,
            "userScope": 123
          },
          "discountAmount": 123,
          "discountCode": "<string>",
          "finishTime": 123,
          "id": 123,
          "invoiceId": "<string>",
          "invoiceName": "<string>",
          "lines": [
            {
              "amount": 123,
              "amountExcludingTax": 123,
              "currency": "<string>",
              "description": "<string>",
              "discountAmount": 123,
              "metricCharge": {
                "CurrentUsedValue": 123,
                "chargePricing": {
                  "chargeType": 123,
                  "graduatedAmounts": [
                    {
                      "endValue": 123,
                      "flatAmount": 123,
                      "perAmount": 123,
                      "startValue": 123
                    }
                  ],
                  "metricId": 123,
                  "standardAmount": 123,
                  "standardStartValue": 123
                },
                "description": "<string>",
                "maxEventId": 123,
                "metricId": 123,
                "minEventId": 123,
                "name": "<string>",
                "totalChargeAmount": 123
              },
              "name": "<string>",
              "originAmount": 123,
              "originUnitAmountExcludeTax": 123,
              "pdfDescription": "<string>",
              "periodEnd": 123,
              "periodStart": 123,
              "plan": {
                "amount": 123,
                "bindingAddonIds": "<string>",
                "bindingOnetimeAddonIds": "<string>",
                "cancelAtTrialEnd": 123,
                "checkoutUrl": "<string>",
                "createTime": 123,
                "currency": "<string>",
                "description": "<string>",
                "disableAutoCharge": 123,
                "externalPlanId": "<string>",
                "extraMetricData": "<string>",
                "gasPayer": "<string>",
                "homeUrl": "<string>",
                "id": 123,
                "imageUrl": "<string>",
                "internalName": "<string>",
                "intervalCount": 123,
                "intervalUnit": "<string>",
                "merchantId": 123,
                "metadata": {},
                "metricLimits": [
                  {
                    "metricId": 123,
                    "metricLimit": 123
                  }
                ],
                "metricMeteredCharge": [
                  {
                    "chargeType": 123,
                    "graduatedAmounts": [
                      {
                        "endValue": 123,
                        "flatAmount": 123,
                        "perAmount": 123,
                        "startValue": 123
                      }
                    ],
                    "metricId": 123,
                    "standardAmount": 123,
                    "standardStartValue": 123
                  }
                ],
                "metricRecurringCharge": [
                  {
                    "chargeType": 123,
                    "graduatedAmounts": [
                      {
                        "endValue": 123,
                        "flatAmount": 123,
                        "perAmount": 123,
                        "startValue": 123
                      }
                    ],
                    "metricId": 123,
                    "standardAmount": 123,
                    "standardStartValue": 123
                  }
                ],
                "planName": "<string>",
                "productId": 123,
                "publishStatus": 123,
                "status": 123,
                "taxPercentage": 123,
                "trialAmount": 123,
                "trialDemand": "<string>",
                "trialDurationTime": 123,
                "type": 123
              },
              "proration": true,
              "quantity": 123,
              "tax": 123,
              "taxPercentage": 123,
              "unitAmountExcludingTax": 123
            }
          ],
          "link": "<string>",
          "metadata": {},
          "originAmount": 123,
          "partialCreditPaidAmount": 123,
          "paymentId": "<string>",
          "paymentLink": "<string>",
          "periodEnd": 123,
          "periodStart": 123,
          "productName": "<string>",
          "promoCreditAccount": {
            "amount": 123,
            "createTime": 123,
            "currency": "<string>",
            "currencyAmount": 123,
            "exchangeRate": 123,
            "id": 123,
            "payoutEnable": 123,
            "rechargeEnable": 123,
            "totalDecrementAmount": 123,
            "totalIncrementAmount": 123,
            "type": 123,
            "userId": 123
          },
          "promoCreditDiscountAmount": 123,
          "promoCreditPayout": {
            "creditAmount": 123,
            "currencyAmount": 123,
            "exchangeRate": 123
          },
          "promoCreditTransaction": {
            "accountType": 123,
            "bizId": "<string>",
            "by": "<string>",
            "createTime": 123,
            "creditAmountAfter": 123,
            "creditAmountBefore": 123,
            "creditId": 123,
            "currency": "<string>",
            "deltaAmount": 123,
            "deltaCurrencyAmount": 123,
            "description": "<string>",
            "exchangeRate": 123,
            "id": 123,
            "invoiceId": "<string>",
            "merchantId": 123,
            "name": "<string>",
            "transactionId": "<string>",
            "transactionType": 123,
            "userId": 123
          },
          "prorationDate": 123,
          "prorationScale": 123,
          "refundId": "<string>",
          "sendNote": "<string>",
          "sendStatus": 123,
          "status": 123,
          "subscriptionAmount": 123,
          "subscriptionAmountExcludingTax": 123,
          "subscriptionId": "<string>",
          "taxAmount": 123,
          "taxPercentage": 123,
          "totalAmount": 123,
          "totalAmountExcludingTax": 123,
          "trialEnd": 123,
          "userId": 123,
          "userMetricChargeForInvoice": {
            "meteredChargeStats": [
              {
                "CurrentUsedValue": 123,
                "chargePricing": {
                  "chargeType": 123,
                  "graduatedAmounts": [
                    {
                      "endValue": 123,
                      "flatAmount": 123,
                      "perAmount": 123,
                      "startValue": 123
                    }
                  ],
                  "metricId": 123,
                  "standardAmount": 123,
                  "standardStartValue": 123
                },
                "description": "<string>",
                "maxEventId": 123,
                "metricId": 123,
                "minEventId": 123,
                "name": "<string>",
                "totalChargeAmount": 123
              }
            ],
            "recurringChargeStats": [
              {
                "CurrentUsedValue": 123,
                "chargePricing": {
                  "chargeType": 123,
                  "graduatedAmounts": [
                    {
                      "endValue": 123,
                      "flatAmount": 123,
                      "perAmount": 123,
                      "startValue": 123
                    }
                  ],
                  "metricId": 123,
                  "standardAmount": 123,
                  "standardStartValue": 123
                },
                "description": "<string>",
                "maxEventId": 123,
                "metricId": 123,
                "minEventId": 123,
                "name": "<string>",
                "totalChargeAmount": 123
              }
            ]
          },
          "vatNumber": "<string>"
        },
        "plan": {
          "amount": 123,
          "bindingAddonIds": "<string>",
          "bindingOnetimeAddonIds": "<string>",
          "cancelAtTrialEnd": 123,
          "checkoutUrl": "<string>",
          "createTime": 123,
          "currency": "<string>",
          "description": "<string>",
          "disableAutoCharge": 123,
          "externalPlanId": "<string>",
          "extraMetricData": "<string>",
          "gasPayer": "<string>",
          "homeUrl": "<string>",
          "id": 123,
          "imageUrl": "<string>",
          "internalName": "<string>",
          "intervalCount": 123,
          "intervalUnit": "<string>",
          "merchantId": 123,
          "metadata": {},
          "metricLimits": [
            {
              "metricId": 123,
              "metricLimit": 123
            }
          ],
          "metricMeteredCharge": [
            {
              "chargeType": 123,
              "graduatedAmounts": [
                {
                  "endValue": 123,
                  "flatAmount": 123,
                  "perAmount": 123,
                  "startValue": 123
                }
              ],
              "metricId": 123,
              "standardAmount": 123,
              "standardStartValue": 123
            }
          ],
          "metricRecurringCharge": [
            {
              "chargeType": 123,
              "graduatedAmounts": [
                {
                  "endValue": 123,
                  "flatAmount": 123,
                  "perAmount": 123,
                  "startValue": 123
                }
              ],
              "metricId": 123,
              "standardAmount": 123,
              "standardStartValue": 123
            }
          ],
          "planName": "<string>",
          "productId": 123,
          "publishStatus": 123,
          "status": 123,
          "taxPercentage": 123,
          "trialAmount": 123,
          "trialDemand": "<string>",
          "trialDurationTime": 123,
          "type": 123
        },
        "subscription": {
          "addonData": "<string>",
          "amount": 123,
          "billingCycleAnchor": 123,
          "cancelAtPeriodEnd": 123,
          "cancelOrExpireTime": 123,
          "cancelReason": "<string>",
          "countryCode": "<string>",
          "createTime": 123,
          "currency": "<string>",
          "currentPeriodEnd": 123,
          "currentPeriodPaid": 123,
          "currentPeriodStart": 123,
          "defaultPaymentMethodId": "<string>",
          "dunningTime": 123,
          "externalSubscriptionId": "<string>",
          "features": "<string>",
          "firstPaidTime": 123,
          "gasPayer": "<string>",
          "gatewayId": 123,
          "gatewayStatus": "<string>",
          "id": 123,
          "lastUpdateTime": 123,
          "latestInvoiceId": "<string>",
          "link": "<string>",
          "merchantId": 123,
          "metadata": {},
          "originalPeriodEnd": 123,
          "pendingUpdateId": "<string>",
          "planId": 123,
          "productId": 123,
          "quantity": 123,
          "returnUrl": "<string>",
          "status": 123,
          "subscriptionId": "<string>",
          "taskTime": "<string>",
          "taxPercentage": 123,
          "testClock": 123,
          "trialEnd": 123,
          "type": 123,
          "userId": 123,
          "vatNumber": "<string>"
        },
        "unfinishedSubscriptionPendingUpdate": {
          "addonData": "<string>",
          "addons": [
            {
              "addonPlan": {
                "amount": 123,
                "bindingAddonIds": "<string>",
                "bindingOnetimeAddonIds": "<string>",
                "cancelAtTrialEnd": 123,
                "checkoutUrl": "<string>",
                "createTime": 123,
                "currency": "<string>",
                "description": "<string>",
                "disableAutoCharge": 123,
                "externalPlanId": "<string>",
                "extraMetricData": "<string>",
                "gasPayer": "<string>",
                "homeUrl": "<string>",
                "id": 123,
                "imageUrl": "<string>",
                "internalName": "<string>",
                "intervalCount": 123,
                "intervalUnit": "<string>",
                "merchantId": 123,
                "metadata": {},
                "metricLimits": [
                  {
                    "metricId": 123,
                    "metricLimit": 123
                  }
                ],
                "metricMeteredCharge": [
                  {
                    "chargeType": 123,
                    "graduatedAmounts": [
                      {
                        "endValue": 123,
                        "flatAmount": 123,
                        "perAmount": 123,
                        "startValue": 123
                      }
                    ],
                    "metricId": 123,
                    "standardAmount": 123,
                    "standardStartValue": 123
                  }
                ],
                "metricRecurringCharge": [
                  {
                    "chargeType": 123,
                    "graduatedAmounts": [
                      {
                        "endValue": 123,
                        "flatAmount": 123,
                        "perAmount": 123,
                        "startValue": 123
                      }
                    ],
                    "metricId": 123,
                    "standardAmount": 123,
                    "standardStartValue": 123
                  }
                ],
                "planName": "<string>",
                "productId": 123,
                "publishStatus": 123,
                "status": 123,
                "taxPercentage": 123,
                "trialAmount": 123,
                "trialDemand": "<string>",
                "trialDurationTime": 123,
                "type": 123
              },
              "quantity": 123
            }
          ],
          "amount": 123,
          "currency": "<string>",
          "effectImmediate": 123,
          "effectTime": 123,
          "gatewayId": 123,
          "gmtCreate": "<string>",
          "gmtModify": "<string>",
          "invoiceId": "<string>",
          "link": "<string>",
          "merchantId": 123,
          "merchantMember": {
            "MemberGroupPermission": {},
            "MemberRoles": [
              {
                "createTime": 123,
                "id": 123,
                "merchantId": 123,
                "permissions": [
                  {
                    "group": "<string>",
                    "permissions": [
                      "<string>"
                    ]
                  }
                ],
                "role": "<string>"
              }
            ],
            "createTime": 123,
            "email": "<string>",
            "firstName": "<string>",
            "id": 123,
            "isBlankPasswd": true,
            "isOwner": true,
            "lastName": "<string>",
            "merchantId": 123,
            "mobile": "<string>",
            "status": 123
          },
          "metadata": {},
          "note": "<string>",
          "paid": 123,
          "pendingUpdateId": "<string>",
          "plan": {
            "amount": 123,
            "bindingAddonIds": "<string>",
            "bindingOnetimeAddonIds": "<string>",
            "cancelAtTrialEnd": 123,
            "checkoutUrl": "<string>",
            "createTime": 123,
            "currency": "<string>",
            "description": "<string>",
            "disableAutoCharge": 123,
            "externalPlanId": "<string>",
            "extraMetricData": "<string>",
            "gasPayer": "<string>",
            "homeUrl": "<string>",
            "id": 123,
            "imageUrl": "<string>",
            "internalName": "<string>",
            "intervalCount": 123,
            "intervalUnit": "<string>",
            "merchantId": 123,
            "metadata": {},
            "metricLimits": [
              {
                "metricId": 123,
                "metricLimit": 123
              }
            ],
            "metricMeteredCharge": [
              {
                "chargeType": 123,
                "graduatedAmounts": [
                  {
                    "endValue": 123,
                    "flatAmount": 123,
                    "perAmount": 123,
                    "startValue": 123
                  }
                ],
                "metricId": 123,
                "standardAmount": 123,
                "standardStartValue": 123
              }
            ],
            "metricRecurringCharge": [
              {
                "chargeType": 123,
                "graduatedAmounts": [
                  {
                    "endValue": 123,
                    "flatAmount": 123,
                    "perAmount": 123,
                    "startValue": 123
                  }
                ],
                "metricId": 123,
                "standardAmount": 123,
                "standardStartValue": 123
              }
            ],
            "planName": "<string>",
            "productId": 123,
            "publishStatus": 123,
            "status": 123,
            "taxPercentage": 123,
            "trialAmount": 123,
            "trialDemand": "<string>",
            "trialDurationTime": 123,
            "type": 123
          },
          "planId": 123,
          "prorationAmount": 123,
          "quantity": 123,
          "status": 123,
          "subscriptionId": "<string>",
          "updateAddonData": "<string>",
          "updateAddons": [
            {
              "addonPlan": {
                "amount": 123,
                "bindingAddonIds": "<string>",
                "bindingOnetimeAddonIds": "<string>",
                "cancelAtTrialEnd": 123,
                "checkoutUrl": "<string>",
                "createTime": 123,
                "currency": "<string>",
                "description": "<string>",
                "disableAutoCharge": 123,
                "externalPlanId": "<string>",
                "extraMetricData": "<string>",
                "gasPayer": "<string>",
                "homeUrl": "<string>",
                "id": 123,
                "imageUrl": "<string>",
                "internalName": "<string>",
                "intervalCount": 123,
                "intervalUnit": "<string>",
                "merchantId": 123,
                "metadata": {},
                "metricLimits": [
                  {
                    "metricId": 123,
                    "metricLimit": 123
                  }
                ],
                "metricMeteredCharge": [
                  {
                    "chargeType": 123,
                    "graduatedAmounts": [
                      {
                        "endValue": 123,
                        "flatAmount": 123,
                        "perAmount": 123,
                        "startValue": 123
                      }
                    ],
                    "metricId": 123,
                    "standardAmount": 123,
                    "standardStartValue": 123
                  }
                ],
                "metricRecurringCharge": [
                  {
                    "chargeType": 123,
                    "graduatedAmounts": [
                      {
                        "endValue": 123,
                        "flatAmount": 123,
                        "perAmount": 123,
                        "startValue": 123
                      }
                    ],
                    "metricId": 123,
                    "standardAmount": 123,
                    "standardStartValue": 123
                  }
                ],
                "planName": "<string>",
                "productId": 123,
                "publishStatus": 123,
                "status": 123,
                "taxPercentage": 123,
                "trialAmount": 123,
                "trialDemand": "<string>",
                "trialDurationTime": 123,
                "type": 123
              },
              "quantity": 123
            }
          ],
          "updateAmount": 123,
          "updateCurrency": "<string>",
          "updatePlan": {
            "amount": 123,
            "bindingAddonIds": "<string>",
            "bindingOnetimeAddonIds": "<string>",
            "cancelAtTrialEnd": 123,
            "checkoutUrl": "<string>",
            "createTime": 123,
            "currency": "<string>",
            "description": "<string>",
            "disableAutoCharge": 123,
            "externalPlanId": "<string>",
            "extraMetricData": "<string>",
            "gasPayer": "<string>",
            "homeUrl": "<string>",
            "id": 123,
            "imageUrl": "<string>",
            "internalName": "<string>",
            "intervalCount": 123,
            "intervalUnit": "<string>",
            "merchantId": 123,
            "metadata": {},
            "metricLimits": [
              {
                "metricId": 123,
                "metricLimit": 123
              }
            ],
            "metricMeteredCharge": [
              {
                "chargeType": 123,
                "graduatedAmounts": [
                  {
                    "endValue": 123,
                    "flatAmount": 123,
                    "perAmount": 123,
                    "startValue": 123
                  }
                ],
                "metricId": 123,
                "standardAmount": 123,
                "standardStartValue": 123
              }
            ],
            "metricRecurringCharge": [
              {
                "chargeType": 123,
                "graduatedAmounts": [
                  {
                    "endValue": 123,
                    "flatAmount": 123,
                    "perAmount": 123,
                    "startValue": 123
                  }
                ],
                "metricId": 123,
                "standardAmount": 123,
                "standardStartValue": 123
              }
            ],
            "planName": "<string>",
            "productId": 123,
            "publishStatus": 123,
            "status": 123,
            "taxPercentage": 123,
            "trialAmount": 123,
            "trialDemand": "<string>",
            "trialDurationTime": 123,
            "type": 123
          },
          "updatePlanId": 123,
          "updateQuantity": 123,
          "userId": 123
        },
        "user": {
          "address": "<string>",
          "avatarUrl": "<string>",
          "billingType": 123,
          "birthday": "<string>",
          "city": "<string>",
          "companyName": "<string>",
          "countryCode": "<string>",
          "countryName": "<string>",
          "createTime": 123,
          "custom": "<string>",
          "email": "<string>",
          "externalUserId": "<string>",
          "facebook": "<string>",
          "firstName": "<string>",
          "gatewayId": 123,
          "gatewayPaymentType": "<string>",
          "gender": "<string>",
          "id": 123,
          "isRisk": 123,
          "isSpecial": 123,
          "language": "<string>",
          "lastLoginAt": 123,
          "lastName": "<string>",
          "linkedIn": "<string>",
          "merchantId": 123,
          "metadata": {},
          "mobile": "<string>",
          "otherSocialInfo": "<string>",
          "paymentMethod": "<string>",
          "phone": "<string>",
          "profession": "<string>",
          "recurringAmount": 123,
          "registrationNumber": "<string>",
          "school": "<string>",
          "status": 123,
          "subscriptionId": "<string>",
          "subscriptionName": "<string>",
          "subscriptionStatus": 123,
          "taxPercentage": 123,
          "telegram": "<string>",
          "tikTok": "<string>",
          "timeZone": "<string>",
          "type": 123,
          "userName": "<string>",
          "vATNumber": "<string>",
          "version": 123,
          "weChat": "<string>",
          "whatsAPP": "<string>",
          "zipCode": "<string>"
        }
      }
    ],
    "total": 123
  },
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

userId

integer

UserId

status

integer[]

currency

string

The currency of subscription

planIds

integer[]

The filter ids of plan

productIds

integer[]

The filter ids of product

amountStart

integer

The filter start amount of subscription

amountEnd

integer

The filter end amount of subscription

sortField

string

Sort Field，gmt_create|gmt_modify，Default gmt_modify

sortType

string

Sort Type，asc|desc，Default desc

page

integer

Page, Start With 0

count

integer

Count Of Page

createTimeStart

integer

CreateTimeStart

createTimeEnd

integer

CreateTimeEnd

Response

200 - application/json

code

integer

data

object

data.subscriptions

object[]

Subscriptions

data.subscriptions.addonParams

object[]

AddonParams

data.subscriptions.addons

object[]

Addon

data.subscriptions.addons.addonPlan

object

data.subscriptions.addons.addonPlan.amount

integer

amount, cent, without tax

data.subscriptions.addons.addonPlan.bindingAddonIds

string

binded recurring addon planIds，split with ,

data.subscriptions.addons.addonPlan.bindingOnetimeAddonIds

string

binded onetime addon planIds，split with ,

data.subscriptions.addons.addonPlan.cancelAtTrialEnd

integer

whether cancel at subscripiton first trial end，0-false | 1-true, will pass to cancelAtPeriodEnd of subscription

data.subscriptions.addons.addonPlan.checkoutUrl

string

CheckoutUrl

data.subscriptions.addons.addonPlan.createTime

integer

create utc time

data.subscriptions.addons.addonPlan.currency

string

currency

data.subscriptions.addons.addonPlan.description

string

description

data.subscriptions.addons.addonPlan.disableAutoCharge

integer

disable auto-charge, 0-false,1-true

data.subscriptions.addons.addonPlan.externalPlanId

string

external_user_id

data.subscriptions.addons.addonPlan.extraMetricData

string

data.subscriptions.addons.addonPlan.gasPayer

string

who pay the gas, merchant|user

data.subscriptions.addons.addonPlan.homeUrl

string

home_url

data.subscriptions.addons.addonPlan.id

integer

data.subscriptions.addons.addonPlan.imageUrl

string

image_url

data.subscriptions.addons.addonPlan.internalName

string

PlanInternalName

data.subscriptions.addons.addonPlan.intervalCount

integer

period unit count

data.subscriptions.addons.addonPlan.intervalUnit

string

period unit,day|month|year|week

data.subscriptions.addons.addonPlan.merchantId

integer

merchant id

data.subscriptions.addons.addonPlan.metadata

object

data.subscriptions.addons.addonPlan.metricLimits

object[]

Plan's MetricLimit List

data.subscriptions.addons.addonPlan.metricMeteredCharge

object[]

Plan's MetricMeteredCharge

data.subscriptions.addons.addonPlan.metricRecurringCharge

object[]

Plan's MetricRecurringCharge

data.subscriptions.addons.addonPlan.planName

string

PlanName

data.subscriptions.addons.addonPlan.productId

integer

product id

data.subscriptions.addons.addonPlan.publishStatus

integer

1-UnPublish,2-Publish, Use For Display Plan At UserPortal

data.subscriptions.addons.addonPlan.status

integer

status，1-editing，2-active，3-inactive，4-soft archive, 5-hard archive

data.subscriptions.addons.addonPlan.taxPercentage

integer

TaxPercentage 1000 = 10%

data.subscriptions.addons.addonPlan.trialAmount

integer

price of trial period

data.subscriptions.addons.addonPlan.trialDemand

string

data.subscriptions.addons.addonPlan.trialDurationTime

integer

duration of trial

data.subscriptions.addons.addonPlan.type

integer

type，1-main plan，2-addon plan

data.subscriptions.addons.quantity

integer

Quantity

data.subscriptions.dayLeft

integer

DayLeft util the period end, only available for webhook

data.subscriptions.discount

object

data.subscriptions.discount.advance

boolean

AdvanceConfig, 0-false,1-true, will enable all advance config if set true

data.subscriptions.discount.billingType

integer

billing_type, 1-one-time, 2-recurring

data.subscriptions.discount.code

string

code

data.subscriptions.discount.createTime

integer

create utc time

data.subscriptions.discount.currency

string

currency of discount, available when discount_type is fixed_amount

data.subscriptions.discount.cycleLimit

integer

the count limitation of subscription cycle , 0-no limit

data.subscriptions.discount.discountAmount

integer

amount of discount, available when discount_type is fixed_amount

data.subscriptions.discount.discountPercentage

integer

percentage of discount, 100=1%, available when discount_type is percentage

data.subscriptions.discount.discountType

integer

discount_type, 1-percentage, 2-fixed_amount

data.subscriptions.discount.endTime

integer

end of discount available utc time, 0-invalid

data.subscriptions.discount.id

integer

data.subscriptions.discount.isDeleted

integer

0-UnDeleted，> 0, Deleted, the deleted utc time

data.subscriptions.discount.merchantId

integer

merchantId

data.subscriptions.discount.metadata

object

data.subscriptions.discount.name

string

name

data.subscriptions.discount.planApplyType

integer

plan apply type, 0-apply for all, 1-apply for plans specified, 2-exclude for plans specified

data.subscriptions.discount.planIds

integer[]

Ids of plan which discount code can effect, default effect all plans if not set

data.subscriptions.discount.quantity

integer

quantity of code, 0-no limit

data.subscriptions.discount.startTime

integer

start of discount available utc time

data.subscriptions.discount.status

integer

status, 1-editable, 2-active, 3-deactivate, 4-expire, 10-archive

data.subscriptions.discount.upgradeLongerOnly

boolean

AdvanceConfig, 0-false,1-true, will forbid for all except upgrade to longer plan if set true

data.subscriptions.discount.upgradeOnly

boolean

AdvanceConfig, 0-false,1-true, will forbid for all except same interval upgrade action if set true

data.subscriptions.discount.userLimit

integer

AdvanceConfig, The limit of every customer can apply, the recurring apply not involved, 0-unlimited

data.subscriptions.discount.userScope

integer

AdvanceConfig, Apply user scope,0-for all, 1-for only new user, 2-for only renewals, renewals is upgrade&downgrade&renew

data.subscriptions.gateway

object

data.subscriptions.gateway.IsSetupFinished

boolean

Whether the gateway finished setup process

data.subscriptions.gateway.archive

boolean

data.subscriptions.gateway.autoChargeEnabled

boolean

data.subscriptions.gateway.bank

object

data.subscriptions.gateway.countryConfig

object

data.subscriptions.gateway.createTime

integer

create utc time

data.subscriptions.gateway.currency

string

The currency of wire transfer

data.subscriptions.gateway.currencyExchange

object[]

The currency exchange for gateway payment, effect at start of payment creation when currency matched

data.subscriptions.gateway.currencyExchangeEnabled

boolean

whether to enable currency exchange

data.subscriptions.gateway.description

string

The description of gateway

data.subscriptions.gateway.displayName

string

The gateway display name, used at user portal

data.subscriptions.gateway.gatewayIcons

string[]

The gateway display name, used at user portal

data.subscriptions.gateway.gatewayId

integer

data.subscriptions.gateway.gatewayKey

string

data.subscriptions.gateway.gatewayLogo

string

data.subscriptions.gateway.gatewayName

string

data.subscriptions.gateway.gatewayPaymentTypes

object[]

gatewayPaymentTypes

data.subscriptions.gateway.gatewaySecret

string

data.subscriptions.gateway.gatewayType

integer

gateway type，1-Bank Card ｜ 2-Crypto | 3 - Wire Transfer

data.subscriptions.gateway.gatewayWebhookIntegrationLink

string

The gateway webhook integration guide link, gateway webhook need setup if not blank

data.subscriptions.gateway.gatewayWebsiteLink

string

The gateway website link

data.subscriptions.gateway.minimumAmount

integer

The minimum amount of wire transfer

data.subscriptions.gateway.name

string

The name of gateway

data.subscriptions.gateway.privateSecretName

string

data.subscriptions.gateway.publicKeyName

string

data.subscriptions.gateway.setupGatewayPaymentTypes

object[]

The total list of gateway payment types, used for setup

data.subscriptions.gateway.sort

integer

The sort value of payment gateway, The higher the value, the lower the ranking

data.subscriptions.gateway.subGateway

string

data.subscriptions.gateway.subGatewayName

string

data.subscriptions.gateway.webhookEndpointUrl

string

The endpoint url of gateway webhook

data.subscriptions.gateway.webhookSecret

string

The secret of gateway webhook

data.subscriptions.latestInvoice

object

data.subscriptions.latestInvoice.autoCharge

boolean

data.subscriptions.latestInvoice.billingCycleAnchor

integer

billing_cycle_anchor

data.subscriptions.latestInvoice.bizType

integer

biz type from payment 1-onetime payment, 3-subscription

data.subscriptions.latestInvoice.countryCode

string

data.subscriptions.latestInvoice.createFrom

string

create from

data.subscriptions.latestInvoice.creditAccount

object

data.subscriptions.latestInvoice.creditPayout

object

data.subscriptions.latestInvoice.cryptoAmount

integer

crypto_amount, cent

data.subscriptions.latestInvoice.cryptoCurrency

string

crypto_currency

data.subscriptions.latestInvoice.currency

string

data.subscriptions.latestInvoice.data

string

data.subscriptions.latestInvoice.dayUtilDue

integer

day util due after finish

data.subscriptions.latestInvoice.discount

object

data.subscriptions.latestInvoice.discount.advance

boolean

AdvanceConfig, 0-false,1-true, will enable all advance config if set true

data.subscriptions.latestInvoice.discount.billingType

integer

billing_type, 1-one-time, 2-recurring

data.subscriptions.latestInvoice.discount.code

string

code

data.subscriptions.latestInvoice.discount.createTime

integer

create utc time

data.subscriptions.latestInvoice.discount.currency

string

currency of discount, available when discount_type is fixed_amount

data.subscriptions.latestInvoice.discount.cycleLimit

integer

the count limitation of subscription cycle , 0-no limit

data.subscriptions.latestInvoice.discount.discountAmount

integer

amount of discount, available when discount_type is fixed_amount

data.subscriptions.latestInvoice.discount.discountPercentage

integer

percentage of discount, 100=1%, available when discount_type is percentage

data.subscriptions.latestInvoice.discount.discountType

integer

discount_type, 1-percentage, 2-fixed_amount

data.subscriptions.latestInvoice.discount.endTime

integer

end of discount available utc time, 0-invalid

data.subscriptions.latestInvoice.discount.id

integer

data.subscriptions.latestInvoice.discount.isDeleted

integer

0-UnDeleted，> 0, Deleted, the deleted utc time

data.subscriptions.latestInvoice.discount.merchantId

integer

merchantId

data.subscriptions.latestInvoice.discount.metadata

object

data.subscriptions.latestInvoice.discount.name

string

name

data.subscriptions.latestInvoice.discount.planApplyType

integer

plan apply type, 0-apply for all, 1-apply for plans specified, 2-exclude for plans specified

data.subscriptions.latestInvoice.discount.planIds

integer[]

Ids of plan which discount code can effect, default effect all plans if not set

data.subscriptions.latestInvoice.discount.quantity

integer

quantity of code, 0-no limit

data.subscriptions.latestInvoice.discount.startTime

integer

start of discount available utc time

data.subscriptions.latestInvoice.discount.status

integer

status, 1-editable, 2-active, 3-deactivate, 4-expire, 10-archive

data.subscriptions.latestInvoice.discount.upgradeLongerOnly

boolean

AdvanceConfig, 0-false,1-true, will forbid for all except upgrade to longer plan if set true

data.subscriptions.latestInvoice.discount.upgradeOnly

boolean

AdvanceConfig, 0-false,1-true, will forbid for all except same interval upgrade action if set true

data.subscriptions.latestInvoice.discount.userLimit

integer

AdvanceConfig, The limit of every customer can apply, the recurring apply not involved, 0-unlimited

data.subscriptions.latestInvoice.discount.userScope

integer

AdvanceConfig, Apply user scope,0-for all, 1-for only new user, 2-for only renewals, renewals is upgrade&downgrade&renew

data.subscriptions.latestInvoice.discountAmount

integer

data.subscriptions.latestInvoice.discountCode

string

data.subscriptions.latestInvoice.finishTime

integer

data.subscriptions.latestInvoice.id

integer

data.subscriptions.latestInvoice.invoiceId

string

data.subscriptions.latestInvoice.invoiceName

string

data.subscriptions.latestInvoice.lines

object[]

data.subscriptions.latestInvoice.link

string

invoice link

data.subscriptions.latestInvoice.metadata

object

Metadata，Map

data.subscriptions.latestInvoice.originAmount

integer

data.subscriptions.latestInvoice.partialCreditPaidAmount

integer

partial credit paid amount

data.subscriptions.latestInvoice.paymentId

string

paymentId

data.subscriptions.latestInvoice.paymentLink

string

invoice payment link

data.subscriptions.latestInvoice.periodEnd

integer

data.subscriptions.latestInvoice.periodStart

integer

data.subscriptions.latestInvoice.productName

string

promo credit discount amount

type of credit account, 1-main recharge account, 2-promo credit account

business id

create utc time

the credit amount after transaction,cent

the credit amount before transaction,cent

id of credit account

currency

delta amount,cent

delta currency amount, in cent

recharge transaction description

ExchangeRate for transaction, keep two decimal places，multiply by 100 saved, 1 currency = 1 credit * (exchange_rate/100), main account fixed rate to 100

invoice_id

merchant id

recharge transaction title

unique id for timeline

transaction type。1-recharge income，2-payment out，3-refund income，4-withdraw out，5-withdraw failed income, 6-admin change，7-recharge refund out

user_id

data.subscriptions.latestInvoice.prorationDate

integer

data.subscriptions.latestInvoice.prorationScale

integer

data.subscriptions.latestInvoice.refundId

string

refundId

data.subscriptions.latestInvoice.sendNote

string

send_note

data.subscriptions.latestInvoice.sendStatus

integer

email send status，0-No | 1- YES| 2-Unnecessary

data.subscriptions.latestInvoice.status

integer

status，1-pending｜2-processing｜3-paid | 4-failed | 5-cancelled

data.subscriptions.latestInvoice.subscriptionAmount

integer

data.subscriptions.latestInvoice.subscriptionAmountExcludingTax

integer

data.subscriptions.latestInvoice.subscriptionId

string

subscription_id

data.subscriptions.latestInvoice.taxAmount

integer

data.subscriptions.latestInvoice.taxPercentage

integer

TaxPercentage，1000 = 10%

data.subscriptions.latestInvoice.totalAmount

integer

data.subscriptions.latestInvoice.totalAmountExcludingTax

integer

data.subscriptions.latestInvoice.trialEnd

integer

trial_end, utc time

data.subscriptions.latestInvoice.userId

integer

UserId

data.subscriptions.latestInvoice.userMetricChargeForInvoice

object

data.subscriptions.latestInvoice.vatNumber

string

data.subscriptions.plan

object

data.subscriptions.plan.amount

integer

amount, cent, without tax

data.subscriptions.plan.bindingAddonIds

string

binded recurring addon planIds，split with ,

data.subscriptions.plan.bindingOnetimeAddonIds

string

binded onetime addon planIds，split with ,

data.subscriptions.plan.cancelAtTrialEnd

integer

whether cancel at subscripiton first trial end，0-false | 1-true, will pass to cancelAtPeriodEnd of subscription

data.subscriptions.plan.checkoutUrl

string

CheckoutUrl

data.subscriptions.plan.createTime

integer

create utc time

data.subscriptions.plan.currency

string

currency

data.subscriptions.plan.description

string

description

data.subscriptions.plan.disableAutoCharge

integer

disable auto-charge, 0-false,1-true

data.subscriptions.plan.externalPlanId

string

external_user_id

data.subscriptions.plan.extraMetricData

string

data.subscriptions.plan.gasPayer

string

who pay the gas, merchant|user

data.subscriptions.plan.homeUrl

string

home_url

data.subscriptions.plan.id

integer

data.subscriptions.plan.imageUrl

string

image_url

data.subscriptions.plan.internalName

string

PlanInternalName

data.subscriptions.plan.intervalCount

integer

period unit count

data.subscriptions.plan.intervalUnit

string

period unit,day|month|year|week

data.subscriptions.plan.merchantId

integer

merchant id

data.subscriptions.plan.metadata

object

data.subscriptions.plan.metricLimits

object[]

Plan's MetricLimit List

data.subscriptions.plan.metricMeteredCharge

object[]

Plan's MetricMeteredCharge

data.subscriptions.plan.metricRecurringCharge

object[]

Plan's MetricRecurringCharge

data.subscriptions.plan.planName

string

PlanName

data.subscriptions.plan.productId

integer

product id

data.subscriptions.plan.publishStatus

integer

1-UnPublish,2-Publish, Use For Display Plan At UserPortal

data.subscriptions.plan.status

integer

status，1-editing，2-active，3-inactive，4-soft archive, 5-hard archive

data.subscriptions.plan.taxPercentage

integer

TaxPercentage 1000 = 10%

data.subscriptions.plan.trialAmount

integer

price of trial period

data.subscriptions.plan.trialDemand

string

data.subscriptions.plan.trialDurationTime

integer

duration of trial

data.subscriptions.plan.type

integer

type，1-main plan，2-addon plan

data.subscriptions.subscription

object

data.subscriptions.subscription.addonData

string

plan addon json data

data.subscriptions.subscription.amount

integer

amount, cent

data.subscriptions.subscription.billingCycleAnchor

integer

billing_cycle_anchor

data.subscriptions.subscription.cancelAtPeriodEnd

integer

whether cancel at period end，0-false | 1-true

data.subscriptions.subscription.cancelOrExpireTime

integer

the cancel or expire time, utc time, 0 if subscription not in cancelled or expired status

data.subscriptions.subscription.cancelReason

string

data.subscriptions.subscription.countryCode

string

data.subscriptions.subscription.createTime

integer

create utc time

data.subscriptions.subscription.currency

string

currency

data.subscriptions.subscription.currentPeriodEnd

integer

current_period_end, utc time

data.subscriptions.subscription.currentPeriodPaid

integer

current period paid or not, 1-paid, other-the utc time to expire

data.subscriptions.subscription.currentPeriodStart

integer

current_period_start, utc time

data.subscriptions.subscription.defaultPaymentMethodId

string

data.subscriptions.subscription.dunningTime

integer

dunning_time, utc time

data.subscriptions.subscription.externalSubscriptionId

string

external_subscription_id

data.subscriptions.subscription.features

string

features

data.subscriptions.subscription.firstPaidTime

integer

first success payment time

data.subscriptions.subscription.gasPayer

string

who pay the gas, merchant|user

data.subscriptions.subscription.gatewayId

integer

gateway_id

data.subscriptions.subscription.gatewayStatus

string

gateway status，Stripe：https://stripe.com/docs/billing/subscriptions/webhooks Paypal：https://developer.paypal.com/docs/api/subscriptions/v1/#subscriptions_get

data.subscriptions.subscription.id

integer

data.subscriptions.subscription.lastUpdateTime

integer

data.subscriptions.subscription.latestInvoiceId

string

latest_invoice_id

data.subscriptions.subscription.link

string

data.subscriptions.subscription.merchantId

integer

merchant id

data.subscriptions.subscription.metadata

object

data.subscriptions.subscription.originalPeriodEnd

integer

original_period_end, utc time

data.subscriptions.subscription.pendingUpdateId

string

data.subscriptions.subscription.planId

integer

plan id

data.subscriptions.subscription.productId

integer

product id

data.subscriptions.subscription.quantity

integer

quantity

data.subscriptions.subscription.returnUrl

string

data.subscriptions.subscription.status

integer

data.subscriptions.subscription.subscriptionId

string

subscription id

data.subscriptions.subscription.taskTime

string

task_time

data.subscriptions.subscription.taxPercentage

integer

TaxPercentage，1000 = 10%

data.subscriptions.subscription.testClock

integer

test_clock, simulator clock for subscription, if set , sub will out of cronjob controll

data.subscriptions.subscription.trialEnd

integer

trial_end, utc time

data.subscriptions.subscription.type

integer

sub type, 0-gateway sub, 1-unibee sub

data.subscriptions.subscription.userId

integer

userId

data.subscriptions.subscription.vatNumber

string

data.subscriptions.unfinishedSubscriptionPendingUpdate

object

data.subscriptions.unfinishedSubscriptionPendingUpdate.addonData

string

plan addon json data

data.subscriptions.unfinishedSubscriptionPendingUpdate.addons

object[]

Addons

data.subscriptions.unfinishedSubscriptionPendingUpdate.amount

integer

CaptureAmount, Cent

data.subscriptions.unfinishedSubscriptionPendingUpdate.currency

string

Currency

data.subscriptions.unfinishedSubscriptionPendingUpdate.effectImmediate

integer

EffectImmediate

data.subscriptions.unfinishedSubscriptionPendingUpdate.effectTime

integer

effect_immediate=0, EffectTime unit_time

data.subscriptions.unfinishedSubscriptionPendingUpdate.gatewayId

integer

data.subscriptions.unfinishedSubscriptionPendingUpdate.gmtCreate

string

GmtCreate

data.subscriptions.unfinishedSubscriptionPendingUpdate.gmtModify

string

GmtModify

data.subscriptions.unfinishedSubscriptionPendingUpdate.invoiceId

string

invoice id

data.subscriptions.unfinishedSubscriptionPendingUpdate.link

string

Link

data.subscriptions.unfinishedSubscriptionPendingUpdate.merchantId

integer

MerchantId

data.subscriptions.unfinishedSubscriptionPendingUpdate.merchantMember

object

data.subscriptions.unfinishedSubscriptionPendingUpdate.metadata

object

data.subscriptions.unfinishedSubscriptionPendingUpdate.note

string

Update Note

data.subscriptions.unfinishedSubscriptionPendingUpdate.paid

integer

Paid

data.subscriptions.unfinishedSubscriptionPendingUpdate.pendingUpdateId

string

PendingUpdateId

data.subscriptions.unfinishedSubscriptionPendingUpdate.plan

object

data.subscriptions.unfinishedSubscriptionPendingUpdate.plan.amount

integer

amount, cent, without tax

data.subscriptions.unfinishedSubscriptionPendingUpdate.plan.bindingAddonIds

string

binded recurring addon planIds，split with ,

data.subscriptions.unfinishedSubscriptionPendingUpdate.plan.bindingOnetimeAddonIds

string

binded onetime addon planIds，split with ,

data.subscriptions.unfinishedSubscriptionPendingUpdate.plan.cancelAtTrialEnd

integer

whether cancel at subscripiton first trial end，0-false | 1-true, will pass to cancelAtPeriodEnd of subscription

data.subscriptions.unfinishedSubscriptionPendingUpdate.plan.checkoutUrl

string

CheckoutUrl

data.subscriptions.unfinishedSubscriptionPendingUpdate.plan.createTime

integer

create utc time

data.subscriptions.unfinishedSubscriptionPendingUpdate.plan.currency

string

currency

data.subscriptions.unfinishedSubscriptionPendingUpdate.plan.description

string

description

data.subscriptions.unfinishedSubscriptionPendingUpdate.plan.disableAutoCharge

integer

disable auto-charge, 0-false,1-true

data.subscriptions.unfinishedSubscriptionPendingUpdate.plan.externalPlanId

string

external_user_id

data.subscriptions.unfinishedSubscriptionPendingUpdate.plan.extraMetricData

string

data.subscriptions.unfinishedSubscriptionPendingUpdate.plan.gasPayer

string

who pay the gas, merchant|user

data.subscriptions.unfinishedSubscriptionPendingUpdate.plan.homeUrl

string

home_url

data.subscriptions.unfinishedSubscriptionPendingUpdate.plan.id

integer

data.subscriptions.unfinishedSubscriptionPendingUpdate.plan.imageUrl

string

image_url

data.subscriptions.unfinishedSubscriptionPendingUpdate.plan.internalName

string

PlanInternalName

data.subscriptions.unfinishedSubscriptionPendingUpdate.plan.intervalCount

integer

period unit count

data.subscriptions.unfinishedSubscriptionPendingUpdate.plan.intervalUnit

string

period unit,day|month|year|week

data.subscriptions.unfinishedSubscriptionPendingUpdate.plan.merchantId

integer

merchant id

data.subscriptions.unfinishedSubscriptionPendingUpdate.plan.metadata

object

data.subscriptions.unfinishedSubscriptionPendingUpdate.plan.metricLimits

object[]

Plan's MetricLimit List

data.subscriptions.unfinishedSubscriptionPendingUpdate.plan.metricMeteredCharge

object[]

Plan's MetricMeteredCharge

data.subscriptions.unfinishedSubscriptionPendingUpdate.plan.metricRecurringCharge

object[]

Plan's MetricRecurringCharge

data.subscriptions.unfinishedSubscriptionPendingUpdate.plan.planName

string

PlanName

data.subscriptions.unfinishedSubscriptionPendingUpdate.plan.productId

integer

product id

data.subscriptions.unfinishedSubscriptionPendingUpdate.plan.publishStatus

integer

1-UnPublish,2-Publish, Use For Display Plan At UserPortal

data.subscriptions.unfinishedSubscriptionPendingUpdate.plan.status

integer

status，1-editing，2-active，3-inactive，4-soft archive, 5-hard archive

data.subscriptions.unfinishedSubscriptionPendingUpdate.plan.taxPercentage

integer

TaxPercentage 1000 = 10%

data.subscriptions.unfinishedSubscriptionPendingUpdate.plan.trialAmount

integer

price of trial period

data.subscriptions.unfinishedSubscriptionPendingUpdate.plan.trialDemand

string

data.subscriptions.unfinishedSubscriptionPendingUpdate.plan.trialDurationTime

integer

duration of trial

data.subscriptions.unfinishedSubscriptionPendingUpdate.plan.type

integer

type，1-main plan，2-addon plan

data.subscriptions.unfinishedSubscriptionPendingUpdate.planId

integer

PlanId

data.subscriptions.unfinishedSubscriptionPendingUpdate.prorationAmount

integer

ProrationAmount,Cents

data.subscriptions.unfinishedSubscriptionPendingUpdate.quantity

integer

quantity

data.subscriptions.unfinishedSubscriptionPendingUpdate.status

integer

Status，1-Pending｜2-Finished｜3-Cancelled

data.subscriptions.unfinishedSubscriptionPendingUpdate.subscriptionId

string

SubscriptionId

data.subscriptions.unfinishedSubscriptionPendingUpdate.updateAddonData

string

UpdateAddonData

data.subscriptions.unfinishedSubscriptionPendingUpdate.updateAddons

object[]

UpdateAddons

data.subscriptions.unfinishedSubscriptionPendingUpdate.updateAmount

integer

UpdateAmount, Cents

data.subscriptions.unfinishedSubscriptionPendingUpdate.updateCurrency

string

UpdateCurrency

data.subscriptions.unfinishedSubscriptionPendingUpdate.updatePlan

object

data.subscriptions.unfinishedSubscriptionPendingUpdate.updatePlan.amount

integer

amount, cent, without tax

data.subscriptions.unfinishedSubscriptionPendingUpdate.updatePlan.bindingAddonIds

string

binded recurring addon planIds，split with ,

data.subscriptions.unfinishedSubscriptionPendingUpdate.updatePlan.bindingOnetimeAddonIds

string

binded onetime addon planIds，split with ,

data.subscriptions.unfinishedSubscriptionPendingUpdate.updatePlan.cancelAtTrialEnd

integer

whether cancel at subscripiton first trial end，0-false | 1-true, will pass to cancelAtPeriodEnd of subscription

data.subscriptions.unfinishedSubscriptionPendingUpdate.updatePlan.checkoutUrl

string

CheckoutUrl

data.subscriptions.unfinishedSubscriptionPendingUpdate.updatePlan.createTime

integer

create utc time

data.subscriptions.unfinishedSubscriptionPendingUpdate.updatePlan.currency

string

currency

data.subscriptions.unfinishedSubscriptionPendingUpdate.updatePlan.description

string

description

data.subscriptions.unfinishedSubscriptionPendingUpdate.updatePlan.disableAutoCharge

integer

disable auto-charge, 0-false,1-true

data.subscriptions.unfinishedSubscriptionPendingUpdate.updatePlan.externalPlanId

string

external_user_id

data.subscriptions.unfinishedSubscriptionPendingUpdate.updatePlan.extraMetricData

string

data.subscriptions.unfinishedSubscriptionPendingUpdate.updatePlan.gasPayer

string

who pay the gas, merchant|user

data.subscriptions.unfinishedSubscriptionPendingUpdate.updatePlan.homeUrl

string

home_url

data.subscriptions.unfinishedSubscriptionPendingUpdate.updatePlan.id

integer

data.subscriptions.unfinishedSubscriptionPendingUpdate.updatePlan.imageUrl

string

image_url

data.subscriptions.unfinishedSubscriptionPendingUpdate.updatePlan.internalName

string

PlanInternalName

data.subscriptions.unfinishedSubscriptionPendingUpdate.updatePlan.intervalCount

integer

period unit count

data.subscriptions.unfinishedSubscriptionPendingUpdate.updatePlan.intervalUnit

string

period unit,day|month|year|week

data.subscriptions.unfinishedSubscriptionPendingUpdate.updatePlan.merchantId

integer

merchant id

data.subscriptions.unfinishedSubscriptionPendingUpdate.updatePlan.metadata

object

data.subscriptions.unfinishedSubscriptionPendingUpdate.updatePlan.metricLimits

object[]

Plan's MetricLimit List

data.subscriptions.unfinishedSubscriptionPendingUpdate.updatePlan.metricMeteredCharge

object[]

Plan's MetricMeteredCharge

data.subscriptions.unfinishedSubscriptionPendingUpdate.updatePlan.metricRecurringCharge

object[]

Plan's MetricRecurringCharge

data.subscriptions.unfinishedSubscriptionPendingUpdate.updatePlan.planName

string

PlanName

data.subscriptions.unfinishedSubscriptionPendingUpdate.updatePlan.productId

integer

product id

data.subscriptions.unfinishedSubscriptionPendingUpdate.updatePlan.publishStatus

integer

1-UnPublish,2-Publish, Use For Display Plan At UserPortal

data.subscriptions.unfinishedSubscriptionPendingUpdate.updatePlan.status

integer

status，1-editing，2-active，3-inactive，4-soft archive, 5-hard archive

data.subscriptions.unfinishedSubscriptionPendingUpdate.updatePlan.taxPercentage

integer

TaxPercentage 1000 = 10%

data.subscriptions.unfinishedSubscriptionPendingUpdate.updatePlan.trialAmount

integer

price of trial period

data.subscriptions.unfinishedSubscriptionPendingUpdate.updatePlan.trialDemand

string

data.subscriptions.unfinishedSubscriptionPendingUpdate.updatePlan.trialDurationTime

integer

duration of trial

data.subscriptions.unfinishedSubscriptionPendingUpdate.updatePlan.type

integer

type，1-main plan，2-addon plan

data.subscriptions.unfinishedSubscriptionPendingUpdate.updatePlanId

integer

UpdatePlanId

data.subscriptions.unfinishedSubscriptionPendingUpdate.updateQuantity

integer

UpdateQuantity

data.subscriptions.unfinishedSubscriptionPendingUpdate.userId

integer

UserId

data.subscriptions.user

object

data.subscriptions.user.address

string

address

data.subscriptions.user.avatarUrl

string

avator url

data.subscriptions.user.billingType

integer

1-recurring,2-one-time

data.subscriptions.user.birthday

string

brithday

data.subscriptions.user.city

string

city

data.subscriptions.user.companyName

string

company name

data.subscriptions.user.countryCode

string

country_code

data.subscriptions.user.countryName

string

country_name

data.subscriptions.user.createTime

integer

create utc time

data.subscriptions.user.custom

string

custom

data.subscriptions.user.email

string

data.subscriptions.user.externalUserId

string

external_user_id

data.subscriptions.user.facebook

string

facebook

data.subscriptions.user.firstName

string

first name

data.subscriptions.user.gatewayId

integer

gateway_id

data.subscriptions.user.gatewayPaymentType

string

data.subscriptions.user.gender

string

gender

data.subscriptions.user.id

integer

userId

data.subscriptions.user.isRisk

integer

is risk account (deperated)

data.subscriptions.user.isSpecial

integer

is special account（0.no，1.yes）- deperated

data.subscriptions.user.language

string

User Language, en|ru|cn|vi|bp

last login time, utc time

data.subscriptions.user.lastName

string

last name

data.subscriptions.user.linkedIn

string

data.subscriptions.user.merchantId

integer

merchant_id

data.subscriptions.user.metadata

object

data.subscriptions.user.mobile

string

mobile

data.subscriptions.user.paymentMethod

string

data.subscriptions.user.phone

string

phone

data.subscriptions.user.profession

string

profession

data.subscriptions.user.recurringAmount

integer

total recurring amount, cent

data.subscriptions.user.registrationNumber

string

RegistrationNumber

data.subscriptions.user.school

string

school

data.subscriptions.user.status

integer

0-Active, 2-Suspend

data.subscriptions.user.subscriptionId

string

subscription id

data.subscriptions.user.subscriptionName

string

subscription name

data.subscriptions.user.subscriptionStatus

integer

data.subscriptions.user.taxPercentage

integer

taxPercentage，1000 = 10%

data.subscriptions.user.telegram

string

data.subscriptions.user.tikTok

string

tictok

data.subscriptions.user.timeZone

string

data.subscriptions.user.type

integer

User type, 1-Individual|2-organization

data.subscriptions.user.userName

string

user name

data.subscriptions.user.vATNumber

string

vat number

data.subscriptions.user.version

integer

version

data.subscriptions.user.weChat

string

wechat

data.subscriptions.user.whatsAPP

string

whats app

data.subscriptions.user.zipCode

string

zip_code

data.total

integer

Total

message

string

redirect

string

requestId

string

Subscription Detail Get Subscription List

curl --request GET \
  --url https://api.unibee.top/merchant/subscription/list \
  --header 'Authorization: Bearer <token>'

{
  "code": 123,
  "data": {
    "subscriptions": [
      {
        "addonParams": [
          {
            "addonPlanId": 123,
            "quantity": 123
          }
        ],
        "addons": [
          {
            "addonPlan": {
              "amount": 123,
              "bindingAddonIds": "<string>",
              "bindingOnetimeAddonIds": "<string>",
              "cancelAtTrialEnd": 123,
              "checkoutUrl": "<string>",
              "createTime": 123,
              "currency": "<string>",
              "description": "<string>",
              "disableAutoCharge": 123,
              "externalPlanId": "<string>",
              "extraMetricData": "<string>",
              "gasPayer": "<string>",
              "homeUrl": "<string>",
              "id": 123,
              "imageUrl": "<string>",
              "internalName": "<string>",
              "intervalCount": 123,
              "intervalUnit": "<string>",
              "merchantId": 123,
              "metadata": {},
              "metricLimits": [
                {
                  "metricId": 123,
                  "metricLimit": 123
                }
              ],
              "metricMeteredCharge": [
                {
                  "chargeType": 123,
                  "graduatedAmounts": [
                    {
                      "endValue": 123,
                      "flatAmount": 123,
                      "perAmount": 123,
                      "startValue": 123
                    }
                  ],
                  "metricId": 123,
                  "standardAmount": 123,
                  "standardStartValue": 123
                }
              ],
              "metricRecurringCharge": [
                {
                  "chargeType": 123,
                  "graduatedAmounts": [
                    {
                      "endValue": 123,
                      "flatAmount": 123,
                      "perAmount": 123,
                      "startValue": 123
                    }
                  ],
                  "metricId": 123,
                  "standardAmount": 123,
                  "standardStartValue": 123
                }
              ],
              "planName": "<string>",
              "productId": 123,
              "publishStatus": 123,
              "status": 123,
              "taxPercentage": 123,
              "trialAmount": 123,
              "trialDemand": "<string>",
              "trialDurationTime": 123,
              "type": 123
            },
            "quantity": 123
          }
        ],
        "dayLeft": 123,
        "discount": {
          "advance": true,
          "billingType": 123,
          "code": "<string>",
          "createTime": 123,
          "currency": "<string>",
          "cycleLimit": 123,
          "discountAmount": 123,
          "discountPercentage": 123,
          "discountType": 123,
          "endTime": 123,
          "id": 123,
          "isDeleted": 123,
          "merchantId": 123,
          "metadata": {},
          "name": "<string>",
          "planApplyType": 123,
          "planIds": [
            123
          ],
          "quantity": 123,
          "startTime": 123,
          "status": 123,
          "upgradeLongerOnly": true,
          "upgradeOnly": true,
          "userLimit": 123,
          "userScope": 123
        },
        "gateway": {
          "IsSetupFinished": true,
          "archive": true,
          "autoChargeEnabled": true,
          "bank": {
            "accountHolder": "<string>",
            "address": "<string>",
            "bic": "<string>",
            "iban": "<string>"
          },
          "countryConfig": {},
          "createTime": 123,
          "currency": "<string>",
          "currencyExchange": [
            {
              "exchange_rate": 123,
              "from_currency": "<string>",
              "to_currency": "<string>"
            }
          ],
          "currencyExchangeEnabled": true,
          "description": "<string>",
          "displayName": "<string>",
          "gatewayIcons": [
            "<string>"
          ],
          "gatewayId": 123,
          "gatewayKey": "<string>",
          "gatewayLogo": "<string>",
          "gatewayName": "<string>",
          "gatewayPaymentTypes": [
            {
              "autoCharge": true,
              "category": "<string>",
              "countryName": "<string>",
              "name": "<string>",
              "paymentType": "<string>"
            }
          ],
          "gatewaySecret": "<string>",
          "gatewayType": 123,
          "gatewayWebhookIntegrationLink": "<string>",
          "gatewayWebsiteLink": "<string>",
          "minimumAmount": 123,
          "name": "<string>",
          "privateSecretName": "<string>",
          "publicKeyName": "<string>",
          "setupGatewayPaymentTypes": [
            {
              "autoCharge": true,
              "category": "<string>",
              "countryName": "<string>",
              "name": "<string>",
              "paymentType": "<string>"
            }
          ],
          "sort": 123,
          "subGateway": "<string>",
          "subGatewayName": "<string>",
          "webhookEndpointUrl": "<string>",
          "webhookSecret": "<string>"
        },
        "latestInvoice": {
          "autoCharge": true,
          "billingCycleAnchor": 123,
          "bizType": 123,
          "countryCode": "<string>",
          "createFrom": "<string>",
          "creditAccount": {
            "amount": 123,
            "createTime": 123,
            "currency": "<string>",
            "currencyAmount": 123,
            "exchangeRate": 123,
            "id": 123,
            "payoutEnable": 123,
            "rechargeEnable": 123,
            "totalDecrementAmount": 123,
            "totalIncrementAmount": 123,
            "type": 123,
            "userId": 123
          },
          "creditPayout": {
            "creditAmount": 123,
            "currencyAmount": 123,
            "exchangeRate": 123
          },
          "cryptoAmount": 123,
          "cryptoCurrency": "<string>",
          "currency": "<string>",
          "data": "<string>",
          "dayUtilDue": 123,
          "discount": {
            "advance": true,
            "billingType": 123,
            "code": "<string>",
            "createTime": 123,
            "currency": "<string>",
            "cycleLimit": 123,
            "discountAmount": 123,
            "discountPercentage": 123,
            "discountType": 123,
            "endTime": 123,
            "id": 123,
            "isDeleted": 123,
            "merchantId": 123,
            "metadata": {},
            "name": "<string>",
            "planApplyType": 123,
            "planIds": [
              123
            ],
            "quantity": 123,
            "startTime": 123,
            "status": 123,
            "upgradeLongerOnly": true,
            "upgradeOnly": true,
            "userLimit": 123,
            "userScope": 123
          },
          "discountAmount": 123,
          "discountCode": "<string>",
          "finishTime": 123,
          "id": 123,
          "invoiceId": "<string>",
          "invoiceName": "<string>",
          "lines": [
            {
              "amount": 123,
              "amountExcludingTax": 123,
              "currency": "<string>",
              "description": "<string>",
              "discountAmount": 123,
              "metricCharge": {
                "CurrentUsedValue": 123,
                "chargePricing": {
                  "chargeType": 123,
                  "graduatedAmounts": [
                    {
                      "endValue": 123,
                      "flatAmount": 123,
                      "perAmount": 123,
                      "startValue": 123
                    }
                  ],
                  "metricId": 123,
                  "standardAmount": 123,
                  "standardStartValue": 123
                },
                "description": "<string>",
                "maxEventId": 123,
                "metricId": 123,
                "minEventId": 123,
                "name": "<string>",
                "totalChargeAmount": 123
              },
              "name": "<string>",
              "originAmount": 123,
              "originUnitAmountExcludeTax": 123,
              "pdfDescription": "<string>",
              "periodEnd": 123,
              "periodStart": 123,
              "plan": {
                "amount": 123,
                "bindingAddonIds": "<string>",
                "bindingOnetimeAddonIds": "<string>",
                "cancelAtTrialEnd": 123,
                "checkoutUrl": "<string>",
                "createTime": 123,
                "currency": "<string>",
                "description": "<string>",
                "disableAutoCharge": 123,
                "externalPlanId": "<string>",
                "extraMetricData": "<string>",
                "gasPayer": "<string>",
                "homeUrl": "<string>",
                "id": 123,
                "imageUrl": "<string>",
                "internalName": "<string>",
                "intervalCount": 123,
                "intervalUnit": "<string>",
                "merchantId": 123,
                "metadata": {},
                "metricLimits": [
                  {
                    "metricId": 123,
                    "metricLimit": 123
                  }
                ],
                "metricMeteredCharge": [
                  {
                    "chargeType": 123,
                    "graduatedAmounts": [
                      {
                        "endValue": 123,
                        "flatAmount": 123,
                        "perAmount": 123,
                        "startValue": 123
                      }
                    ],
                    "metricId": 123,
                    "standardAmount": 123,
                    "standardStartValue": 123
                  }
                ],
                "metricRecurringCharge": [
                  {
                    "chargeType": 123,
                    "graduatedAmounts": [
                      {
                        "endValue": 123,
                        "flatAmount": 123,
                        "perAmount": 123,
                        "startValue": 123
                      }
                    ],
                    "metricId": 123,
                    "standardAmount": 123,
                    "standardStartValue": 123
                  }
                ],
                "planName": "<string>",
                "productId": 123,
                "publishStatus": 123,
                "status": 123,
                "taxPercentage": 123,
                "trialAmount": 123,
                "trialDemand": "<string>",
                "trialDurationTime": 123,
                "type": 123
              },
              "proration": true,
              "quantity": 123,
              "tax": 123,
              "taxPercentage": 123,
              "unitAmountExcludingTax": 123
            }
          ],
          "link": "<string>",
          "metadata": {},
          "originAmount": 123,
          "partialCreditPaidAmount": 123,
          "paymentId": "<string>",
          "paymentLink": "<string>",
          "periodEnd": 123,
          "periodStart": 123,
          "productName": "<string>",
          "promoCreditAccount": {
            "amount": 123,
            "createTime": 123,
            "currency": "<string>",
            "currencyAmount": 123,
            "exchangeRate": 123,
            "id": 123,
            "payoutEnable": 123,
            "rechargeEnable": 123,
            "totalDecrementAmount": 123,
            "totalIncrementAmount": 123,
            "type": 123,
            "userId": 123
          },
          "promoCreditDiscountAmount": 123,
          "promoCreditPayout": {
            "creditAmount": 123,
            "currencyAmount": 123,
            "exchangeRate": 123
          },
          "promoCreditTransaction": {
            "accountType": 123,
            "bizId": "<string>",
            "by": "<string>",
            "createTime": 123,
            "creditAmountAfter": 123,
            "creditAmountBefore": 123,
            "creditId": 123,
            "currency": "<string>",
            "deltaAmount": 123,
            "deltaCurrencyAmount": 123,
            "description": "<string>",
            "exchangeRate": 123,
            "id": 123,
            "invoiceId": "<string>",
            "merchantId": 123,
            "name": "<string>",
            "transactionId": "<string>",
            "transactionType": 123,
            "userId": 123
          },
          "prorationDate": 123,
          "prorationScale": 123,
          "refundId": "<string>",
          "sendNote": "<string>",
          "sendStatus": 123,
          "status": 123,
          "subscriptionAmount": 123,
          "subscriptionAmountExcludingTax": 123,
          "subscriptionId": "<string>",
          "taxAmount": 123,
          "taxPercentage": 123,
          "totalAmount": 123,
          "totalAmountExcludingTax": 123,
          "trialEnd": 123,
          "userId": 123,
          "userMetricChargeForInvoice": {
            "meteredChargeStats": [
              {
                "CurrentUsedValue": 123,
                "chargePricing": {
                  "chargeType": 123,
                  "graduatedAmounts": [
                    {
                      "endValue": 123,
                      "flatAmount": 123,
                      "perAmount": 123,
                      "startValue": 123
                    }
                  ],
                  "metricId": 123,
                  "standardAmount": 123,
                  "standardStartValue": 123
                },
                "description": "<string>",
                "maxEventId": 123,
                "metricId": 123,
                "minEventId": 123,
                "name": "<string>",
                "totalChargeAmount": 123
              }
            ],
            "recurringChargeStats": [
              {
                "CurrentUsedValue": 123,
                "chargePricing": {
                  "chargeType": 123,
                  "graduatedAmounts": [
                    {
                      "endValue": 123,
                      "flatAmount": 123,
                      "perAmount": 123,
                      "startValue": 123
                    }
                  ],
                  "metricId": 123,
                  "standardAmount": 123,
                  "standardStartValue": 123
                },
                "description": "<string>",
                "maxEventId": 123,
                "metricId": 123,
                "minEventId": 123,
                "name": "<string>",
                "totalChargeAmount": 123
              }
            ]
          },
          "vatNumber": "<string>"
        },
        "plan": {
          "amount": 123,
          "bindingAddonIds": "<string>",
          "bindingOnetimeAddonIds": "<string>",
          "cancelAtTrialEnd": 123,
          "checkoutUrl": "<string>",
          "createTime": 123,
          "currency": "<string>",
          "description": "<string>",
          "disableAutoCharge": 123,
          "externalPlanId": "<string>",
          "extraMetricData": "<string>",
          "gasPayer": "<string>",
          "homeUrl": "<string>",
          "id": 123,
          "imageUrl": "<string>",
          "internalName": "<string>",
          "intervalCount": 123,
          "intervalUnit": "<string>",
          "merchantId": 123,
          "metadata": {},
          "metricLimits": [
            {
              "metricId": 123,
              "metricLimit": 123
            }
          ],
          "metricMeteredCharge": [
            {
              "chargeType": 123,
              "graduatedAmounts": [
                {
                  "endValue": 123,
                  "flatAmount": 123,
                  "perAmount": 123,
                  "startValue": 123
                }
              ],
              "metricId": 123,
              "standardAmount": 123,
              "standardStartValue": 123
            }
          ],
          "metricRecurringCharge": [
            {
              "chargeType": 123,
              "graduatedAmounts": [
                {
                  "endValue": 123,
                  "flatAmount": 123,
                  "perAmount": 123,
                  "startValue": 123
                }
              ],
              "metricId": 123,
              "standardAmount": 123,
              "standardStartValue": 123
            }
          ],
          "planName": "<string>",
          "productId": 123,
          "publishStatus": 123,
          "status": 123,
          "taxPercentage": 123,
          "trialAmount": 123,
          "trialDemand": "<string>",
          "trialDurationTime": 123,
          "type": 123
        },
        "subscription": {
          "addonData": "<string>",
          "amount": 123,
          "billingCycleAnchor": 123,
          "cancelAtPeriodEnd": 123,
          "cancelOrExpireTime": 123,
          "cancelReason": "<string>",
          "countryCode": "<string>",
          "createTime": 123,
          "currency": "<string>",
          "currentPeriodEnd": 123,
          "currentPeriodPaid": 123,
          "currentPeriodStart": 123,
          "defaultPaymentMethodId": "<string>",
          "dunningTime": 123,
          "externalSubscriptionId": "<string>",
          "features": "<string>",
          "firstPaidTime": 123,
          "gasPayer": "<string>",
          "gatewayId": 123,
          "gatewayStatus": "<string>",
          "id": 123,
          "lastUpdateTime": 123,
          "latestInvoiceId": "<string>",
          "link": "<string>",
          "merchantId": 123,
          "metadata": {},
          "originalPeriodEnd": 123,
          "pendingUpdateId": "<string>",
          "planId": 123,
          "productId": 123,
          "quantity": 123,
          "returnUrl": "<string>",
          "status": 123,
          "subscriptionId": "<string>",
          "taskTime": "<string>",
          "taxPercentage": 123,
          "testClock": 123,
          "trialEnd": 123,
          "type": 123,
          "userId": 123,
          "vatNumber": "<string>"
        },
        "unfinishedSubscriptionPendingUpdate": {
          "addonData": "<string>",
          "addons": [
            {
              "addonPlan": {
                "amount": 123,
                "bindingAddonIds": "<string>",
                "bindingOnetimeAddonIds": "<string>",
                "cancelAtTrialEnd": 123,
                "checkoutUrl": "<string>",
                "createTime": 123,
                "currency": "<string>",
                "description": "<string>",
                "disableAutoCharge": 123,
                "externalPlanId": "<string>",
                "extraMetricData": "<string>",
                "gasPayer": "<string>",
                "homeUrl": "<string>",
                "id": 123,
                "imageUrl": "<string>",
                "internalName": "<string>",
                "intervalCount": 123,
                "intervalUnit": "<string>",
                "merchantId": 123,
                "metadata": {},
                "metricLimits": [
                  {
                    "metricId": 123,
                    "metricLimit": 123
                  }
                ],
                "metricMeteredCharge": [
                  {
                    "chargeType": 123,
                    "graduatedAmounts": [
                      {
                        "endValue": 123,
                        "flatAmount": 123,
                        "perAmount": 123,
                        "startValue": 123
                      }
                    ],
                    "metricId": 123,
                    "standardAmount": 123,
                    "standardStartValue": 123
                  }
                ],
                "metricRecurringCharge": [
                  {
                    "chargeType": 123,
                    "graduatedAmounts": [
                      {
                        "endValue": 123,
                        "flatAmount": 123,
                        "perAmount": 123,
                        "startValue": 123
                      }
                    ],
                    "metricId": 123,
                    "standardAmount": 123,
                    "standardStartValue": 123
                  }
                ],
                "planName": "<string>",
                "productId": 123,
                "publishStatus": 123,
                "status": 123,
                "taxPercentage": 123,
                "trialAmount": 123,
                "trialDemand": "<string>",
                "trialDurationTime": 123,
                "type": 123
              },
              "quantity": 123
            }
          ],
          "amount": 123,
          "currency": "<string>",
          "effectImmediate": 123,
          "effectTime": 123,
          "gatewayId": 123,
          "gmtCreate": "<string>",
          "gmtModify": "<string>",
          "invoiceId": "<string>",
          "link": "<string>",
          "merchantId": 123,
          "merchantMember": {
            "MemberGroupPermission": {},
            "MemberRoles": [
              {
                "createTime": 123,
                "id": 123,
                "merchantId": 123,
                "permissions": [
                  {
                    "group": "<string>",
                    "permissions": [
                      "<string>"
                    ]
                  }
                ],
                "role": "<string>"
              }
            ],
            "createTime": 123,
            "email": "<string>",
            "firstName": "<string>",
            "id": 123,
            "isBlankPasswd": true,
            "isOwner": true,
            "lastName": "<string>",
            "merchantId": 123,
            "mobile": "<string>",
            "status": 123
          },
          "metadata": {},
          "note": "<string>",
          "paid": 123,
          "pendingUpdateId": "<string>",
          "plan": {
            "amount": 123,
            "bindingAddonIds": "<string>",
            "bindingOnetimeAddonIds": "<string>",
            "cancelAtTrialEnd": 123,
            "checkoutUrl": "<string>",
            "createTime": 123,
            "currency": "<string>",
            "description": "<string>",
            "disableAutoCharge": 123,
            "externalPlanId": "<string>",
            "extraMetricData": "<string>",
            "gasPayer": "<string>",
            "homeUrl": "<string>",
            "id": 123,
            "imageUrl": "<string>",
            "internalName": "<string>",
            "intervalCount": 123,
            "intervalUnit": "<string>",
            "merchantId": 123,
            "metadata": {},
            "metricLimits": [
              {
                "metricId": 123,
                "metricLimit": 123
              }
            ],
            "metricMeteredCharge": [
              {
                "chargeType": 123,
                "graduatedAmounts": [
                  {
                    "endValue": 123,
                    "flatAmount": 123,
                    "perAmount": 123,
                    "startValue": 123
                  }
                ],
                "metricId": 123,
                "standardAmount": 123,
                "standardStartValue": 123
              }
            ],
            "metricRecurringCharge": [
              {
                "chargeType": 123,
                "graduatedAmounts": [
                  {
                    "endValue": 123,
                    "flatAmount": 123,
                    "perAmount": 123,
                    "startValue": 123
                  }
                ],
                "metricId": 123,
                "standardAmount": 123,
                "standardStartValue": 123
              }
            ],
            "planName": "<string>",
            "productId": 123,
            "publishStatus": 123,
            "status": 123,
            "taxPercentage": 123,
            "trialAmount": 123,
            "trialDemand": "<string>",
            "trialDurationTime": 123,
            "type": 123
          },
          "planId": 123,
          "prorationAmount": 123,
          "quantity": 123,
          "status": 123,
          "subscriptionId": "<string>",
          "updateAddonData": "<string>",
          "updateAddons": [
            {
              "addonPlan": {
                "amount": 123,
                "bindingAddonIds": "<string>",
                "bindingOnetimeAddonIds": "<string>",
                "cancelAtTrialEnd": 123,
                "checkoutUrl": "<string>",
                "createTime": 123,
                "currency": "<string>",
                "description": "<string>",
                "disableAutoCharge": 123,
                "externalPlanId": "<string>",
                "extraMetricData": "<string>",
                "gasPayer": "<string>",
                "homeUrl": "<string>",
                "id": 123,
                "imageUrl": "<string>",
                "internalName": "<string>",
                "intervalCount": 123,
                "intervalUnit": "<string>",
                "merchantId": 123,
                "metadata": {},
                "metricLimits": [
                  {
                    "metricId": 123,
                    "metricLimit": 123
                  }
                ],
                "metricMeteredCharge": [
                  {
                    "chargeType": 123,
                    "graduatedAmounts": [
                      {
                        "endValue": 123,
                        "flatAmount": 123,
                        "perAmount": 123,
                        "startValue": 123
                      }
                    ],
                    "metricId": 123,
                    "standardAmount": 123,
                    "standardStartValue": 123
                  }
                ],
                "metricRecurringCharge": [
                  {
                    "chargeType": 123,
                    "graduatedAmounts": [
                      {
                        "endValue": 123,
                        "flatAmount": 123,
                        "perAmount": 123,
                        "startValue": 123
                      }
                    ],
                    "metricId": 123,
                    "standardAmount": 123,
                    "standardStartValue": 123
                  }
                ],
                "planName": "<string>",
                "productId": 123,
                "publishStatus": 123,
                "status": 123,
                "taxPercentage": 123,
                "trialAmount": 123,
                "trialDemand": "<string>",
                "trialDurationTime": 123,
                "type": 123
              },
              "quantity": 123
            }
          ],
          "updateAmount": 123,
          "updateCurrency": "<string>",
          "updatePlan": {
            "amount": 123,
            "bindingAddonIds": "<string>",
            "bindingOnetimeAddonIds": "<string>",
            "cancelAtTrialEnd": 123,
            "checkoutUrl": "<string>",
            "createTime": 123,
            "currency": "<string>",
            "description": "<string>",
            "disableAutoCharge": 123,
            "externalPlanId": "<string>",
            "extraMetricData": "<string>",
            "gasPayer": "<string>",
            "homeUrl": "<string>",
            "id": 123,
            "imageUrl": "<string>",
            "internalName": "<string>",
            "intervalCount": 123,
            "intervalUnit": "<string>",
            "merchantId": 123,
            "metadata": {},
            "metricLimits": [
              {
                "metricId": 123,
                "metricLimit": 123
              }
            ],
            "metricMeteredCharge": [
              {
                "chargeType": 123,
                "graduatedAmounts": [
                  {
                    "endValue": 123,
                    "flatAmount": 123,
                    "perAmount": 123,
                    "startValue": 123
                  }
                ],
                "metricId": 123,
                "standardAmount": 123,
                "standardStartValue": 123
              }
            ],
            "metricRecurringCharge": [
              {
                "chargeType": 123,
                "graduatedAmounts": [
                  {
                    "endValue": 123,
                    "flatAmount": 123,
                    "perAmount": 123,
                    "startValue": 123
                  }
                ],
                "metricId": 123,
                "standardAmount": 123,
                "standardStartValue": 123
              }
            ],
            "planName": "<string>",
            "productId": 123,
            "publishStatus": 123,
            "status": 123,
            "taxPercentage": 123,
            "trialAmount": 123,
            "trialDemand": "<string>",
            "trialDurationTime": 123,
            "type": 123
          },
          "updatePlanId": 123,
          "updateQuantity": 123,
          "userId": 123
        },
        "user": {
          "address": "<string>",
          "avatarUrl": "<string>",
          "billingType": 123,
          "birthday": "<string>",
          "city": "<string>",
          "companyName": "<string>",
          "countryCode": "<string>",
          "countryName": "<string>",
          "createTime": 123,
          "custom": "<string>",
          "email": "<string>",
          "externalUserId": "<string>",
          "facebook": "<string>",
          "firstName": "<string>",
          "gatewayId": 123,
          "gatewayPaymentType": "<string>",
          "gender": "<string>",
          "id": 123,
          "isRisk": 123,
          "isSpecial": 123,
          "language": "<string>",
          "lastLoginAt": 123,
          "lastName": "<string>",
          "linkedIn": "<string>",
          "merchantId": 123,
          "metadata": {},
          "mobile": "<string>",
          "otherSocialInfo": "<string>",
          "paymentMethod": "<string>",
          "phone": "<string>",
          "profession": "<string>",
          "recurringAmount": 123,
          "registrationNumber": "<string>",
          "school": "<string>",
          "status": 123,
          "subscriptionId": "<string>",
          "subscriptionName": "<string>",
          "subscriptionStatus": 123,
          "taxPercentage": 123,
          "telegram": "<string>",
          "tikTok": "<string>",
          "timeZone": "<string>",
          "type": 123,
          "userName": "<string>",
          "vATNumber": "<string>",
          "version": 123,
          "weChat": "<string>",
          "whatsAPP": "<string>",
          "zipCode": "<string>"
        }
      }
    ],
    "total": 123
  },
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

Member Authentication

Merchant

Credit

Promo Credit

Discount

User Discount

Email Template

Email

Gateway

Invoice

Admin Member

Metric

Metric Event

User Metric

Payment

Plan

Product

Admin Role

Search

Session

Subscription Update

Subscription

Subscription Note

Subscription Config

Subscription Payment

Subscription Timeline

User

Vat Gateway

Webhook

Authorizations

Query Parameters

Response