Skip to main content
POST
/
merchant
/
subscription
/
config
/
update
Update Merchant Subscription Config
curl --request POST \
  --url https://api.unibee.dev/merchant/subscription/config/update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "downgradeEffectImmediately": true,
  "gatewayVATRule": [
    {
      "gatewayNames": "<string>",
      "ignoreVatNumber": true,
      "taxPercentage": 123,
      "validCountryCodes": "<string>"
    }
  ],
  "incompleteExpireTime": 123,
  "invoiceEmail": true,
  "showZeroInvoice": true,
  "tryAutomaticPaymentBeforePeriodEnd": 123,
  "upgradeProration": true
}
'
{
  "code": 123,
  "data": {
    "config": {
      "downgradeEffectImmediately": true,
      "fiatExchangeApiKey": "<string>",
      "gatewayVATRule": "<string>",
      "incompleteExpireTime": 123,
      "invoiceEmail": true,
      "invoicePdfGenerate": true,
      "showZeroInvoice": true,
      "tryAutomaticPaymentBeforePeriodEnd": 123,
      "upgradeProration": true
    }
  },
  "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
downgradeEffectImmediately
boolean<*bool>

DowngradeEffectImmediately, Immediate Downgrade (by default, the downgrades takes effect at the end of the period )

gatewayVATRule
object[]
incompleteExpireTime
integer<*int64>

IncompleteExpireTime, seconds, Incomplete Status Duration(The period during which subscription remains in “incomplete”)

invoiceEmail
boolean<*bool>

InvoiceEmail, Enable Invoice Email (Toggle to send invoice email to customers)

showZeroInvoice
boolean<*bool>

ShowZeroInvoice, Display Invoices With Zero Amount (Invoice With Zero Amount will hidden in list by default)

tryAutomaticPaymentBeforePeriodEnd
integer<*int64>

TryAutomaticPaymentBeforePeriodEnd, Auto-charge Start Before Period End (Time Difference for Auto-Payment Activation Before Period End)

upgradeProration
boolean<*bool>

UpgradeProration, Prorated Upgrade Invoices(Upgrades will generate prorated invoice by default)

Response

200 - application/json
code
integer<int>
data
object
message
string<string>
redirect
string<string>
requestId
string<string>