Skip to main content
POST
Update Subscription Summary

Authorizations

x-api-key
string
header
required

Merchant API Key

x-signature
string
header
required

Generated request signature

Body

application/json
subscriptionId
string<MongoId>
required

Subscription Id of the subscription for which update is needed.

Example:

"65a1b2c3d4e5f67890123456"

items
object[]

Items the customer wants to buy.

billTo
object

Billing Details of the customer.

reAttemptConfig
object[]

To configure how the reattempt for failed invoices be processed.

Example:
meta
object

To update meta params in the subscription.

Example:
couponDetails
object

To apply a coupon on the update Subscription. Only applicable if the subscription requires a new mandate setup to activate.

Example:
frequency
enum<string>

To update the frequency of a subscription. Only prepaid subscriptions are allowed for frequency update.

Available options:
DAIL,
WEEK,
MNTH,
BIMN,
QURT,
MIAN,
YEAR,
ONDM
Example:

"MNTH"

maxUnpausedInvoiceDueCount
string

Maximum number of unpaid invoices count allowed after that the subscription is PAUSED by the system. For example, if a subscription has been paused due to 3 non-payment of invoices and this parameter is set to 2, then once the customer pays 1 invoice the subscription will be reactivated.

Example:

2

maxQuoteAmount
string

Amount that can be auto-debited from the customer using the existing mandate. Increasing this parameter might require a new mandate setup.

Example:

15000

Response

200 - application/json

Contains the updated subscription details.

status
string

The response from the API

sub_status
string

Used for internal purposes only

data
object

Contains the updated subscription details.