v1

latestOpenAPI 3.1.02026-07-241120379.1 KB

Update frequency

This endpoint allows you to update the billing frequency of a subscription contract.

put/2023-10/subscription/{subscriptionId}/frequency

Path parameters

subscriptionIdinteger required

Request body

nextBillingDateEpochinteger

If not passed, the next order date for the subscription will remain the same.

discountType'OLD' | 'NEW' | 'CUSTOM' required

Use new discounts as per the new frequency or continue with existing discounts or pass discountType as CUSTOM only if isCustom key is sent as true.

sellingPlanGroupIdinteger

The sellingPlanGroupId which has to be applied on the lines.

isCustomboolean

Pass this key to apply a custom selling plan.

Response

200

successboolean

messagestring

{"stackTrail":"paths:/2023-10/subscription/{subscriptionId}/frequency:put:responses:200:content:application/json:schema:properties:data","oasType":"schema","type":"unknown"}

codestring

{"stackTrail":"paths:/2023-10/subscription/{subscriptionId}/frequency:put:responses:200:content:application/json:schema:properties:pageInfo","oasType":"schema","type":"unknown"}

Example response

{
  "success": true,
  "message": "Frequency updated successfully",
  "code": "SUCCESS"
}