Update frequency

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

Rate limit - Global pool (i.e. 50 requests per second per domain)

Path param explained :

  • subscriptionId Id of the subscription. This can be passed in the following format :
    • {id} - where id is the Loop internal id of the subscription contract. This is the default path param format.
    • loop-{id} - where id is the Loop internal id of the subscription contract.
    • shopify-${id} - Where id is the shopifySubscriptionId of the subscription contract.
Path Params
int32
required

ID of the subscription

Body Params
billingPolicy
object
required
deliveryPolicy
object
int64

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

string
enum
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.

Allowed:
int32

The sellingPlanGroupId which has to be applied on the lines.

boolean

Pass this key to apply a custom selling plan.

customDiscount
object

To be passed when discountType is set as 'CUSTOM'

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json