Renew Subscription

POST

merchant

subscription

renew

curl --request POST \
  --url https://api.unibee.top/merchant/subscription/renew \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "applyPromoCredit": true,
  "applyPromoCreditAmount": 123,
  "cancelUrl": "<string>",
  "discount": {
    "cycleLimit": 123,
    "discountAmount": 123,
    "discountPercentage": 123,
    "endTime": 123,
    "metadata": {},
    "recurring": true
  },
  "discountCode": "<string>",
  "gatewayId": 123,
  "gatewayPaymentType": "<string>",
  "manualPayment": true,
  "metadata": {},
  "productData": {
    "description": "<string>",
    "name": "<string>"
  },
  "productId": 123,
  "returnUrl": "<string>",
  "subscriptionId": "<string>",
  "taxPercentage": 123,
  "userId": 123
}'

{
  "code": 123,
  "data": {
    "link": "<string>",
    "paid": true,
    "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>"
    }
  },
  "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.

Body

application/json

renew an exist subscription

apply promo credit or not

apply promo credit amount, auto compute if not specified

cancelUrl

string

CancelUrl

discount

object

discountCode

string

DiscountCode, override subscription discount

gatewayId

integer

GatewayId, use subscription's gateway if not provide

gatewayPaymentType

string

Gateway Payment Type

manualPayment

boolean

ManualPayment

metadata

object

Metadata，Map

productData

object

productId

integer

default product will use if not specified

returnUrl

string

ReturnUrl

subscriptionId

string

SubscriptionId, id of subscription which addon will attached, either SubscriptionId or UserId needed, The only one active subscription or latest subscription will renew if userId provide instead of subscriptionId

taxPercentage

integer

TaxPercentage，1000 = 10%, override subscription taxPercentage if provide

userId

integer

UserId, either SubscriptionId or UserId needed, The only one active subscription or latest cancel|expire subscription will renew if userId provide instead of subscriptionId

Response

200 - application/json

code

integer

data

object

data.link

string

data.paid

boolean

data.subscription

object

data.subscription.addonData

string

plan addon json data

data.subscription.amount

integer

amount, cent

data.subscription.billingCycleAnchor

integer

billing_cycle_anchor

data.subscription.cancelAtPeriodEnd

integer

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

data.subscription.cancelOrExpireTime

integer

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

data.subscription.cancelReason

string

data.subscription.countryCode

string

data.subscription.createTime

integer

create utc time

data.subscription.currency

string

currency

data.subscription.currentPeriodEnd

integer

current_period_end, utc time

data.subscription.currentPeriodPaid

integer

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

data.subscription.currentPeriodStart

integer

current_period_start, utc time

data.subscription.defaultPaymentMethodId

string

data.subscription.dunningTime

integer

dunning_time, utc time

data.subscription.externalSubscriptionId

string

external_subscription_id

data.subscription.features

string

features

data.subscription.firstPaidTime

integer

first success payment time

data.subscription.gasPayer

string

who pay the gas, merchant|user

data.subscription.gatewayId

integer

gateway_id

data.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.subscription.id

integer

data.subscription.lastUpdateTime

integer

data.subscription.latestInvoiceId

string

latest_invoice_id

data.subscription.link

string

data.subscription.merchantId

integer

merchant id

data.subscription.metadata

object

data.subscription.originalPeriodEnd

integer

original_period_end, utc time

data.subscription.pendingUpdateId

string

data.subscription.planId

integer

plan id

data.subscription.productId

integer

product id

data.subscription.quantity

integer

quantity

data.subscription.returnUrl

string

data.subscription.status

integer

data.subscription.subscriptionId

string

subscription id

data.subscription.taskTime

string

task_time

data.subscription.taxPercentage

integer

TaxPercentage，1000 = 10%

data.subscription.testClock

integer

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

data.subscription.trialEnd

integer

trial_end, utc time

data.subscription.type

integer

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

data.subscription.userId

integer

userId

data.subscription.vatNumber

string

message

string

redirect

string

requestId

string

Get Subscription Pending Update List Update Subscription Preview

curl --request POST \
  --url https://api.unibee.top/merchant/subscription/renew \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "applyPromoCredit": true,
  "applyPromoCreditAmount": 123,
  "cancelUrl": "<string>",
  "discount": {
    "cycleLimit": 123,
    "discountAmount": 123,
    "discountPercentage": 123,
    "endTime": 123,
    "metadata": {},
    "recurring": true
  },
  "discountCode": "<string>",
  "gatewayId": 123,
  "gatewayPaymentType": "<string>",
  "manualPayment": true,
  "metadata": {},
  "productData": {
    "description": "<string>",
    "name": "<string>"
  },
  "productId": 123,
  "returnUrl": "<string>",
  "subscriptionId": "<string>",
  "taxPercentage": 123,
  "userId": 123
}'

{
  "code": 123,
  "data": {
    "link": "<string>",
    "paid": true,
    "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>"
    }
  },
  "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

Body

Response