Renew subscription

post

https://www.pelcro.com/api/v1/core/subscriptions/renew

Use this endpoint to create a new subscription.

Query Params

site_id

int32

required

The unique identifier of the site associated with your account.

user_id

int32

required

The unique identifier of the user.

Body Params

subscription_id

int32

required

The unique identifier of the subscription.

plan_id

int32

required

The unique identifier of the plan.

address_id

int32

The unique identifier of user's shipping address

source_id

int32

The unique identifier of user's payment source, required if collection_method is charge_automatically

auto_renew

boolean

A boolean that determines whether the subscription will auto-renew or not at the end of the last phase. (overrides the plan configuration when set)

campaign_key

string

The campaign associated to the subscription. If the key does not already exist, it will be created. The campaign key must be between 3 and 191 characters in length and include only letters, numbers, dashes and underscores without space.

collection_method

string

enum

Defaults to send_invoice

The payment collection method of subscription.

Allowed:

coupon_code

string

Coupon code

quantity

int32

required

Quantity

source

string

required

Subscription source ex(Web, phone, email)

replace_upcoming_phases

boolean

Defaults to false

A boolean flag that, when true, deletes all scheduled future phases before adding a new renewal phase. Used primarily for save offer flows during cancellation to replace existing renewals with a single discounted phase.

Headers

Authorization

string

required

Defaults to Bearer eyJ***

Responses

Language

Credentials

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success.

400Invalid request.

401Unauthenticated.